Merge pull request shlinkio#95 from acelaya-forks/feature/cache-defau…

…lt-lifetime

Feature/cache default lifetime

CHANGELOG.md

@@ -4,9 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
-## [Unreleased]
+## [4.3.0] - 2022-01-07
 ### Added
-* Added support in paginator utils to provide a custom data prop name
+* Added support in paginator utils to provide a custom data prop name.
+* Added support to define a default lifetime in cache adapters.
 
 ### Changed
 * *Nothing*

Dockerfile

@@ -1,6 +1,6 @@
 FROM composer:2
 
-ENV APCU_VERSION 5.1.20
+ENV APCU_VERSION 5.1.21
 
 RUN apk add --no-cache libpng-dev libpng libjpeg-turbo-dev libwebp-dev zlib-dev libxpm-dev
 RUN docker-php-ext-install gd

README.md

@@ -24,13 +24,15 @@ Install this library using composer:
 A [symfony/cache](https://symfony.com/doc/current/components/cache.html) adapter is registered, under the `Psr\Cache\CacheItemPoolInterface` service key (as all adapters implement it).
 
 The concrete implementation it returns is different depending on your configuration:
-
- * An `ArrayAdapter` instance when the `debug` config is set to true or when the APUc extension is not installed and the `cache.redis` config is not defined.
- * An `ApcuAdapter`instance when no `cache.redis` is defined and the APCu extension is installed.
- * A `RedisAdapter` instance when the `cache.redis` config is defined.
-
- The last two adapters will use the namespace defined in `cache.namespace` config entry.
-
+
+* An `ArrayAdapter` instance when the `debug` config is set to true or when the APUc extension is not installed and the `cache.redis` config is not defined.
+* An `ApcuAdapter`instance when no `cache.redis` is defined and the APCu extension is installed.
+* A `RedisAdapter` instance when the `cache.redis` config is defined.
+
+The last two adapters will use the namespace defined in `cache.namespace` config entry.
+
+The three of them will allow setting a default lifetime for those entries which do not explicitly define one, picking it up from `cache.default_lifetime`.
+
  ```php
 <?php
 
@@ -42,7 +44,8 @@ return [
 
     'cache' => [
         'namespace' => 'my_namespace',
-
+        'default_lifetime' => 86400, // Optional. Defaults to "never expire"
+
         'redis' => [
             'servers' => [
                 'tcp://1.1.1.1:6379',

composer.json

@@ -104,6 +104,10 @@
         "infect:test": "<fg=blue;options=bold>Alias for \"test:ci\" and \"infect:show:ci\"</>"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "infection/extension-installer": true
+        }
     }
 }

src/Cache/CacheFactory.php

@@ -23,21 +23,22 @@ public function __construct(?callable $apcuEnabled = null)
 
     public function __invoke(ContainerInterface $container): CacheItemPoolInterface
     {
+        $apcuEnabled = ($this->apcuEnabled)();
         $config = $container->get('config');
         $isDebug = (bool) ($config['debug'] ?? false);
         $redisConfig = $config['cache']['redis'] ?? null;
-        $apcuEnabled = ($this->apcuEnabled)();
+        $lifetime = (int) ($config['cache']['default_lifetime'] ?? 0);
 
         if ($isDebug || (! $apcuEnabled && $redisConfig === null)) {
-            return new Adapter\ArrayAdapter();
+            return new Adapter\ArrayAdapter($lifetime);
         }
 
         $namespace = $config['cache']['namespace'] ?? '';
         if ($redisConfig === null) {
-            return new Adapter\ApcuAdapter($namespace);
+            return new Adapter\ApcuAdapter($namespace, $lifetime);
         }
 
         $predis = $container->get(PredisClient::class);
-        return new Adapter\RedisAdapter($predis, $namespace);
+        return new Adapter\RedisAdapter($predis, $namespace, $lifetime);
     }
 }

src/Doctrine/EntityManagerFactory.php

@@ -5,20 +5,14 @@
 namespace Shlinkio\Shlink\Common\Doctrine;
 
 use Doctrine\Common\Cache\Cache;
-use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Types\Type;
 use Doctrine\ORM\EntityManager;
-use Doctrine\ORM\ORMException;
 use Doctrine\ORM\Tools\Setup;
 use Psr\Container\ContainerInterface;
 use Shlinkio\Shlink\Common\Doctrine\Mapping\EnhancedPHPDriver;
 
 class EntityManagerFactory
 {
-    /**
-     * @throws ORMException
-     * @throws Exception
-     */
     public function __invoke(ContainerInterface $container): EntityManager
     {
         $globalConfig = $container->get('config');
@@ -48,9 +42,6 @@ public function __invoke(ContainerInterface $container): EntityManager
         return $em;
     }
 
-    /**
-     * @throws Exception
-     */
     private function registerTypes(array $ormConfig): void
     {
         $types = $ormConfig['types'] ?? [];