Respect the Cache Lifetime from the Resource Type configuration and u…

…se "lifetime" in names
cundd · Feb 7, 2019 · 68b0099 · 68b0099
1 parent 9a2bc3c
commit 68b0099
Show file tree

Hide file tree

Showing 13 changed files with 227 additions and 132 deletions.
diff --git a/Classes/Cache/Cache.php b/Classes/Cache/Cache.php
@@ -30,14 +30,14 @@ class Cache implements CacheInterface
      *
      * @var integer
      */
-    private $cacheLifeTime = 0;
+    private $cacheLifetime;
 
     /**
      * Life time defined in the expires header
      *
      * @var integer
      */
-    private $expiresHeaderLifeTime = 0;
+    private $expiresHeaderLifetime;
 
     /**
      * @var ResponseFactory
@@ -56,13 +56,13 @@ public function __construct(ResponseFactoryInterface $responseFactory)
 
     public function getCachedValueForRequest(RestRequestInterface $request): ?ResponseInterface
     {
-        $cacheLifeTime = $this->getCacheLifeTime();
+        $cacheLifetime = $this->getCacheLifetime();
 
         /*
          * Use caching if the cache life time configuration is not -1, an API
          * path is given and the request is a read request
          */
-        $useCaching = ($cacheLifeTime !== -1) && $request->getPath();
+        $useCaching = ($cacheLifetime !== -1) && $request->getPath();
         if (!$useCaching) {
             return null;
         }
@@ -85,29 +85,26 @@ public function getCachedValueForRequest(RestRequestInterface $request): ?Respon
         return $response
             ->withHeader(Header::CONTENT_TYPE, $responseData[Header::CONTENT_TYPE])
             ->withHeader(Header::LAST_MODIFIED, $responseData[Header::LAST_MODIFIED])
-            ->withHeader(Header::EXPIRES, $this->getHttpDate(time() + $this->getExpiresHeaderLifeTime()))
+            ->withHeader(Header::EXPIRES, $this->getHttpDate(time() + $this->getExpiresHeaderLifetime()))
             ->withHeader(Header::CUNDD_REST_CACHED, 'true');
     }
 
     public function setCachedValueForRequest(
         RestRequestInterface $request,
         ResponseInterface $response,
         ResourceConfiguration $resourceConfiguration
-    ) {
+    ): void {
         if (false === $this->canBeCached($request, $response)) {
             return;
         }
 
-        $cacheLifeTime = $resourceConfiguration->getCacheLifetime();
-        if ($cacheLifeTime < 0) {
-            $cacheLifeTime = $this->getCacheLifeTime();
-        }
+        $cacheLifetime = $this->getCacheLifetime();
 
         /*
          * Use caching if the cache life time configuration is not -1, an API
          * path is given and the request is a read request
          */
-        $useCaching = ($cacheLifeTime !== -1) && $request->getPath();
+        $useCaching = ($cacheLifetime !== -1) && $request->getPath();
         if (!$useCaching) {
             return;
         }
@@ -123,7 +120,7 @@ public function setCachedValueForRequest(
                 Header::LAST_MODIFIED => $this->getHttpDate(time()),
             ],
             $this->getTags($request),
-            $cacheLifeTime
+            $cacheLifetime
         );
     }
 
@@ -147,12 +144,12 @@ public function getCacheKeyForRequest(RestRequestInterface $request): string
     /**
      * Sets the cache life time
      *
-     * @param int $cacheLifeTime
+     * @param int $cacheLifetime
      * @return $this
      */
-    public function setCacheLifeTime(int $cacheLifeTime): CacheInterface
+    public function setCacheLifetime(int $cacheLifetime): CacheInterface
     {
-        $this->cacheLifeTime = $cacheLifeTime;
+        $this->cacheLifetime = $cacheLifetime;
 
         return $this;
     }
@@ -162,20 +159,20 @@ public function setCacheLifeTime(int $cacheLifeTime): CacheInterface
      *
      * @return int
      */
-    public function getCacheLifeTime(): int
+    public function getCacheLifetime(): int
     {
-        return $this->cacheLifeTime;
+        return $this->cacheLifetime;
     }
 
     /**
      * Sets the life time defined in the expires header
      *
-     * @param int $expiresHeaderLifeTime
+     * @param int $expiresHeaderLifetime
      * @return $this
      */
-    public function setExpiresHeaderLifeTime(int $expiresHeaderLifeTime): CacheInterface
+    public function setExpiresHeaderLifetime(int $expiresHeaderLifetime): CacheInterface
     {
-        $this->expiresHeaderLifeTime = $expiresHeaderLifeTime;
+        $this->expiresHeaderLifetime = $expiresHeaderLifetime;
 
         return $this;
     }
@@ -185,9 +182,20 @@ public function setExpiresHeaderLifeTime(int $expiresHeaderLifeTime): CacheInter
      *
      * @return int
      */
-    public function getExpiresHeaderLifeTime(): int
+    public function getExpiresHeaderLifetime(): int
+    {
+        return $this->expiresHeaderLifetime;
+    }
+
+    /**
+     * Sets the concrete Cache instance
+     *
+     * @param \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend $cacheInstance
+     * @internal
+     */
+    public function setCacheInstance($cacheInstance)
     {
-        return $this->expiresHeaderLifeTime;
+        $this->cacheInstance = $cacheInstance;
     }
 
     /**
@@ -217,17 +225,6 @@ private function getCacheInstance()
         return $this->cacheInstance;
     }
 
-    /**
-     * Sets the concrete Cache instance
-     *
-     * @param \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend $cacheInstance
-     * @internal
-     */
-    public function setCacheInstance($cacheInstance)
-    {
-        $this->cacheInstance = $cacheInstance;
-    }
-
     /**
      * Clears the cache for the current request
      *

diff --git a/Classes/Cache/CacheFactory.php b/Classes/Cache/CacheFactory.php
@@ -4,38 +4,45 @@
 namespace Cundd\Rest\Cache;
 
 use Cundd\Rest\Configuration\ConfigurationProviderInterface;
+use Cundd\Rest\Domain\Model\ResourceType;
 use Cundd\Rest\ObjectManager;
 
 class CacheFactory
 {
     /**
+     * Return a Cache instance for the Resource Type
+     *
+     * @param ResourceType                   $resourceType
      * @param ConfigurationProviderInterface $configurationProvider
      * @param ObjectManager                  $objectManager
      * @return CacheInterface
      */
     public function buildCache(
+        ResourceType $resourceType,
         ConfigurationProviderInterface $configurationProvider,
         ObjectManager $objectManager
     ): CacheInterface {
         $cacheInstance = $this->getCacheInstance($configurationProvider, $objectManager);
 
-        if ($cacheInstance instanceof CacheInterface) {
-            $cacheInstance->setCacheLifeTime($this->getCacheLifeTime($configurationProvider));
-            $cacheInstance->setExpiresHeaderLifeTime($this->getExpiresHeaderLifeTime($configurationProvider));
-        }
+        $cacheInstance->setCacheLifetime(
+            $this->getCacheLifetime($configurationProvider, $resourceType)
+        );
+        $cacheInstance->setExpiresHeaderLifetime(
+            $this->getExpiresHeaderLifetime($configurationProvider, $resourceType)
+        );
 
         return $cacheInstance;
     }
 
     /**
      * @param ConfigurationProviderInterface $configurationProvider
      * @param ObjectManager                  $objectManager
-     * @return mixed
+     * @return CacheInterface
      */
     private function getCacheInstance(
         ConfigurationProviderInterface $configurationProvider,
         ObjectManager $objectManager
-    ) {
+    ): CacheInterface {
         $cacheImplementation = $configurationProvider->getSetting('cacheClass');
         if ($cacheImplementation && $objectManager->isRegistered($cacheImplementation)) {
             return $objectManager->get($cacheImplementation);
@@ -46,28 +53,49 @@ private function getCacheInstance(
 
     /**
      * @param ConfigurationProviderInterface $configurationProvider
-     * @return int|mixed
+     * @param ResourceType                   $resourceType
+     * @return int
      */
-    private function getCacheLifeTime(ConfigurationProviderInterface $configurationProvider): int
+    private function getCacheLifetime(ConfigurationProviderInterface $configurationProvider, ResourceType $resourceType)
     {
-        $readCacheLifeTime = $configurationProvider->getSetting('cacheLifeTime');
-        if ($readCacheLifeTime === null) {
-            $readCacheLifeTime = -1;
+        $resourceConfiguration = $configurationProvider->getResourceConfiguration($resourceType);
+        $cacheLifetime = $resourceConfiguration->getCacheLifetime();
+        if ($cacheLifetime > -1) {
+            return $cacheLifetime;
+        }
+
+        $cacheLifetime = $configurationProvider->getSetting('cacheLifeTime');
+        if ($cacheLifetime !== null) {
+            return (int)$cacheLifetime;
+        }
+
+        $cacheLifetime = $configurationProvider->getSetting('cacheLifetime');
+        if ($cacheLifetime !== null) {
+            return (int)$cacheLifetime;
         }
 
-        return (int)$readCacheLifeTime;
+        return -1;
     }
 
     /**
      * @param ConfigurationProviderInterface $configurationProvider
-     * @return int|mixed
+     * @param ResourceType                   $resourceType
+     * @return int
      */
-    private function getExpiresHeaderLifeTime(ConfigurationProviderInterface $configurationProvider): int
-    {
-        $expiresHeaderLifeTime = $configurationProvider->getSetting('expiresHeaderLifeTime');
+    private function getExpiresHeaderLifetime(
+        ConfigurationProviderInterface $configurationProvider,
+        ResourceType $resourceType
+    ) {
+        $expiresHeaderLifetime = $configurationProvider->getSetting('expiresHeaderLifetime');
+        if ($expiresHeaderLifetime !== null) {
+            return (int)$expiresHeaderLifetime;
+        }
+
+        $expiresHeaderLifetime = $configurationProvider->getSetting('expiresHeaderLifeTime');
+        if ($expiresHeaderLifetime !== null) {
+            return (int)$expiresHeaderLifetime;
+        }
 
-        return ($expiresHeaderLifeTime !== null)
-            ? intval($expiresHeaderLifeTime)
-            : $this->getCacheLifeTime($configurationProvider);
+        return $this->getCacheLifetime($configurationProvider, $resourceType);
     }
 }
diff --git a/Classes/Cache/CacheInterface.php b/Classes/Cache/CacheInterface.php
@@ -14,15 +14,15 @@
 interface CacheInterface
 {
     /**
-     * Returns the cached value for the given request or NULL if it is not defined
+     * Return the cached value for the given request or NULL if it is not defined
      *
      * @param RestRequestInterface $request
      * @return ResponseInterface|null
      */
     public function getCachedValueForRequest(RestRequestInterface $request): ?ResponseInterface;
 
     /**
-     * Sets the cache value for the given request
+     * Set the cache value for the given request
      *
      * @param RestRequestInterface  $request
      * @param ResponseInterface     $response
@@ -33,43 +33,43 @@ public function setCachedValueForRequest(
         RestRequestInterface $request,
         ResponseInterface $response,
         ResourceConfiguration $resourceConfiguration
-    );
+    ): void;
 
     /**
-     * Returns the cache key for the given request
+     * Return the cache key for the given request
      *
      * @param RestRequestInterface $request
      * @return string
      */
     public function getCacheKeyForRequest(RestRequestInterface $request): string;
 
     /**
-     * Sets the cache life time
+     * Set the cache lifetime
      *
-     * @param int $cacheLifeTime
+     * @param int $cacheLifetime
      * @return $this
      */
-    public function setCacheLifeTime(int $cacheLifeTime): self;
+    public function setCacheLifetime(int $cacheLifetime): self;
 
     /**
-     * Returns the cache life time
+     * Return the cache lifetime
      *
      * @return int
      */
-    public function getCacheLifeTime(): int;
+    public function getCacheLifetime();
 
     /**
-     * Sets the life time defined in the expires header
+     * Set the lifetime defined in the expires header
      *
-     * @param int $expiresHeaderLifeTime
+     * @param int $expiresHeaderLifetime
      * @return $this
      */
-    public function setExpiresHeaderLifeTime(int $expiresHeaderLifeTime): self;
+    public function setExpiresHeaderLifetime(int $expiresHeaderLifetime): self;
 
     /**
-     * Returns the life time defined in the expires header
+     * Return the lifetime defined in the expires header
      *
      * @return int
      */
-    public function getExpiresHeaderLifeTime(): int;
+    public function getExpiresHeaderLifetime();
 }
diff --git a/Classes/Configuration/AbstractConfigurationProvider.php b/Classes/Configuration/AbstractConfigurationProvider.php
@@ -140,11 +140,13 @@ public function getConfiguredResources(): array
             }
 
             $resourceType = new ResourceType($normalizeResourceType);
+            $cacheLifetime = $this->detectCacheLifetimeConfiguration($configuration);
+
             $configurationCollection[$normalizeResourceType] = new ResourceConfiguration(
                 $resourceType,
                 $readAccess,
                 $writeAccess,
-                isset($configuration['cacheLifeTime']) ? intval($configuration['cacheLifeTime']) : -1,
+                $cacheLifetime,
                 isset($configuration['handlerClass']) ? $configuration['handlerClass'] : '',
                 $this->getAliasesForResourceType($resourceType)
             );
@@ -221,4 +223,20 @@ private function preparePath(array $configuration, $path)
 
         return [$configuration, $normalizeResourceType];
     }
+
+    /**
+     * @param array $configuration
+     * @return int
+     */
+    private function detectCacheLifetimeConfiguration(array $configuration): int
+    {
+        if (isset($configuration['cacheLifeTime']) && is_numeric($configuration['cacheLifeTime'])) {
+            return (int)$configuration['cacheLifeTime'];
+        }
+        if (isset($configuration['cacheLifetime']) && is_numeric($configuration['cacheLifetime'])) {
+            return (int)$configuration['cacheLifetime'];
+        }
+
+        return -1;
+    }
 }
diff --git a/Classes/Dispatcher.php b/Classes/Dispatcher.php
@@ -116,7 +116,7 @@ private function getCachedResponseOrCallHandler(
         /** @noinspection PhpUnusedParameterInspection */
         ResponseInterface $response
     ) {
-        $cache = $this->objectManager->getCache();
+        $cache = $this->objectManager->getCache($request->getResourceType());
         $cachedResponse = $cache->getCachedValueForRequest($request);
 
         // If a cached response exists return it