Merge pull request #1908 from bendavies/cache-trait

teohhanhui · web-flow · commit dcdea86a5dfe · 2018-04-30T17:56:41.000+02:00
RFC: Cache trait
diff --git a/src/Bridge/Symfony/Routing/CachedRouteNameResolver.php b/src/Bridge/Symfony/Routing/CachedRouteNameResolver.php
@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Core\Bridge\Symfony\Routing;
 
-use Psr\Cache\CacheException;
+use ApiPlatform\Core\Cache\CachedTrait;
 use Psr\Cache\CacheItemPoolInterface;
 
 /**
@@ -23,11 +23,11 @@
  */
 final class CachedRouteNameResolver implements RouteNameResolverInterface
 {
+    use CachedTrait;
+
     const CACHE_KEY_PREFIX = 'route_name_';
 
-    private $cacheItemPool;
     private $decorated;
-    private $localCache = [];
 
     public function __construct(CacheItemPoolInterface $cacheItemPool, RouteNameResolverInterface $decorated)
     {
@@ -43,33 +43,8 @@ public function getRouteName(string $resourceClass, $operationType /**, array $c
         $context = \func_num_args() > 2 ? func_get_arg(2) : [];
         $cacheKey = self::CACHE_KEY_PREFIX.md5(serialize([$resourceClass, $operationType, $context['subresource_resources'] ?? null]));
 
-        if (isset($this->localCache[$cacheKey])) {
-            return $this->localCache[$cacheKey];
-        }
-
-        try {
-            $cacheItem = $this->cacheItemPool->getItem($cacheKey);
-
-            if ($cacheItem->isHit()) {
-                return $this->localCache[$cacheKey] = $cacheItem->get();
-            }
-        } catch (CacheException $e) {
-            //do nothing
-        }
-
-        $routeName = $this->decorated->getRouteName($resourceClass, $operationType, $context);
-
-        if (!isset($cacheItem)) {
-            return $this->localCache[$cacheKey] = $routeName;
-        }
-
-        try {
-            $cacheItem->set($routeName);
-            $this->cacheItemPool->save($cacheItem);
-        } catch (CacheException $e) {
-            // do nothing
-        }
-
-        return $this->localCache[$cacheKey] = $routeName;
+        return $this->getCached($cacheKey, function () use ($resourceClass, $operationType, $context) {
+            return $this->decorated->getRouteName($resourceClass, $operationType, $context);
+        });
     }
 }
diff --git a/src/Cache/CachedTrait.php b/src/Cache/CachedTrait.php
@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Cache;
+
+use Psr\Cache\CacheException;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ * @internal
+ */
+trait CachedTrait
+{
+    /** @var CacheItemPoolInterface */
+    private $cacheItemPool;
+    private $localCache = [];
+
+    private function getCached(string $cacheKey, callable $getValue)
+    {
+        if (array_key_exists($cacheKey, $this->localCache)) {
+            return $this->localCache[$cacheKey];
+        }
+
+        try {
+            $cacheItem = $this->cacheItemPool->getItem($cacheKey);
+
+            if ($cacheItem->isHit()) {
+                return $this->localCache[$cacheKey] = $cacheItem->get();
+            }
+        } catch (CacheException $e) {
+            //do nothing
+        }
+
+        $value = $getValue();
+
+        if (!isset($cacheItem)) {
+            return $this->localCache[$cacheKey] = $value;
+        }
+
+        try {
+            $cacheItem->set($value);
+            $this->cacheItemPool->save($cacheItem);
+        } catch (CacheException $e) {
+            // do nothing
+        }
+
+        return $this->localCache[$cacheKey] = $value;
+    }
+}
diff --git a/src/Metadata/Property/Factory/CachedPropertyMetadataFactory.php b/src/Metadata/Property/Factory/CachedPropertyMetadataFactory.php
@@ -13,8 +13,8 @@
 
 namespace ApiPlatform\Core\Metadata\Property\Factory;
 
+use ApiPlatform\Core\Cache\CachedTrait;
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
-use Psr\Cache\CacheException;
 use Psr\Cache\CacheItemPoolInterface;
 
 /**
@@ -24,11 +24,11 @@
  */
 final class CachedPropertyMetadataFactory implements PropertyMetadataFactoryInterface
 {
+    use CachedTrait;
+
     const CACHE_KEY_PREFIX = 'property_metadata_';
 
-    private $cacheItemPool;
     private $decorated;
-    private $localCache = [];
 
     public function __construct(CacheItemPoolInterface $cacheItemPool, PropertyMetadataFactoryInterface $decorated)
     {
@@ -41,28 +41,10 @@ public function __construct(CacheItemPoolInterface $cacheItemPool, PropertyMetad
      */
     public function create(string $resourceClass, string $property, array $options = []): PropertyMetadata
     {
-        $localCacheKey = serialize([$resourceClass, $property, $options]);
-        if (isset($this->localCache[$localCacheKey])) {
-            return $this->localCache[$localCacheKey];
-        }
-
-        $cacheKey = self::CACHE_KEY_PREFIX.md5($localCacheKey);
-
-        try {
-            $cacheItem = $this->cacheItemPool->getItem($cacheKey);
-        } catch (CacheException $e) {
-            return $this->localCache[$localCacheKey] = $this->decorated->create($resourceClass, $property, $options);
-        }
-
-        if ($cacheItem->isHit()) {
-            return $this->localCache[$localCacheKey] = $cacheItem->get();
-        }
-
-        $propertyMetadata = $this->decorated->create($resourceClass, $property, $options);
-
-        $cacheItem->set($propertyMetadata);
-        $this->cacheItemPool->save($cacheItem);
+        $cacheKey = self::CACHE_KEY_PREFIX.md5(serialize([$resourceClass, $property, $options]));
 
-        return $this->localCache[$localCacheKey] = $propertyMetadata;
+        return $this->getCached($cacheKey, function () use ($resourceClass, $property, $options) {
+            return $this->decorated->create($resourceClass, $property, $options);
+        });
     }
 }
diff --git a/src/Metadata/Property/Factory/CachedPropertyNameCollectionFactory.php b/src/Metadata/Property/Factory/CachedPropertyNameCollectionFactory.php
@@ -13,8 +13,8 @@
 
 namespace ApiPlatform\Core\Metadata\Property\Factory;
 
+use ApiPlatform\Core\Cache\CachedTrait;
 use ApiPlatform\Core\Metadata\Property\PropertyNameCollection;
-use Psr\Cache\CacheException;
 use Psr\Cache\CacheItemPoolInterface;
 
 /**
@@ -24,11 +24,11 @@
  */
 final class CachedPropertyNameCollectionFactory implements PropertyNameCollectionFactoryInterface
 {
+    use CachedTrait;
+
     const CACHE_KEY_PREFIX = 'property_name_collection_';
 
-    private $cacheItemPool;
     private $decorated;
-    private $localCache = [];
 
     public function __construct(CacheItemPoolInterface $cacheItemPool, PropertyNameCollectionFactoryInterface $decorated)
     {
@@ -41,28 +41,10 @@ public function __construct(CacheItemPoolInterface $cacheItemPool, PropertyNameC
      */
     public function create(string $resourceClass, array $options = []): PropertyNameCollection
     {
-        $localCacheKey = serialize([$resourceClass, $options]);
-        if (isset($this->localCache[$localCacheKey])) {
-            return $this->localCache[$localCacheKey];
-        }
-
-        $cacheKey = self::CACHE_KEY_PREFIX.md5($localCacheKey);
-
-        try {
-            $cacheItem = $this->cacheItemPool->getItem($cacheKey);
-        } catch (CacheException $e) {
-            return $this->localCache[$localCacheKey] = $this->decorated->create($resourceClass, $options);
-        }
-
-        if ($cacheItem->isHit()) {
-            return $this->localCache[$localCacheKey] = $cacheItem->get();
-        }
-
-        $propertyNameCollection = $this->decorated->create($resourceClass, $options);
-
-        $cacheItem->set($propertyNameCollection);
-        $this->cacheItemPool->save($cacheItem);
+        $cacheKey = self::CACHE_KEY_PREFIX.md5(serialize([$resourceClass, $options]));
 
-        return $this->localCache[$localCacheKey] = $propertyNameCollection;
+        return $this->getCached($cacheKey, function () use ($resourceClass, $options) {
+            return $this->decorated->create($resourceClass, $options);
+        });
     }
 }
diff --git a/src/Metadata/Resource/Factory/CachedResourceMetadataFactory.php b/src/Metadata/Resource/Factory/CachedResourceMetadataFactory.php
@@ -13,8 +13,8 @@
 
 namespace ApiPlatform\Core\Metadata\Resource\Factory;
 
+use ApiPlatform\Core\Cache\CachedTrait;
 use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
-use Psr\Cache\CacheException;
 use Psr\Cache\CacheItemPoolInterface;
 
 /**
@@ -24,11 +24,11 @@
  */
 final class CachedResourceMetadataFactory implements ResourceMetadataFactoryInterface
 {
+    use CachedTrait;
+
     const CACHE_KEY_PREFIX = 'resource_metadata_';
 
-    private $cacheItemPool;
     private $decorated;
-    private $localCache = [];
 
     public function __construct(CacheItemPoolInterface $cacheItemPool, ResourceMetadataFactoryInterface $decorated)
     {
@@ -41,27 +41,10 @@ public function __construct(CacheItemPoolInterface $cacheItemPool, ResourceMetad
      */
     public function create(string $resourceClass): ResourceMetadata
     {
-        if (isset($this->localCache[$resourceClass])) {
-            return $this->localCache[$resourceClass];
-        }
-
         $cacheKey = self::CACHE_KEY_PREFIX.md5($resourceClass);
 
-        try {
-            $cacheItem = $this->cacheItemPool->getItem($cacheKey);
-        } catch (CacheException $e) {
-            return $this->localCache[$resourceClass] = $this->decorated->create($resourceClass);
-        }
-
-        if ($cacheItem->isHit()) {
-            return $this->localCache[$resourceClass] = $cacheItem->get();
-        }
-
-        $resourceMetadata = $this->decorated->create($resourceClass);
-
-        $cacheItem->set($resourceMetadata);
-        $this->cacheItemPool->save($cacheItem);
-
-        return $this->localCache[$resourceClass] = $resourceMetadata;
+        return $this->getCached($cacheKey, function () use ($resourceClass) {
+            return $this->decorated->create($resourceClass);
+        });
     }
 }
diff --git a/src/Metadata/Resource/Factory/CachedResourceNameCollectionFactory.php b/src/Metadata/Resource/Factory/CachedResourceNameCollectionFactory.php
@@ -13,8 +13,8 @@
 
 namespace ApiPlatform\Core\Metadata\Resource\Factory;
 
+use ApiPlatform\Core\Cache\CachedTrait;
 use ApiPlatform\Core\Metadata\Resource\ResourceNameCollection;
-use Psr\Cache\CacheException;
 use Psr\Cache\CacheItemPoolInterface;
 
 /**
@@ -24,11 +24,11 @@
  */
 final class CachedResourceNameCollectionFactory implements ResourceNameCollectionFactoryInterface
 {
+    use CachedTrait;
+
     const CACHE_KEY = 'resource_name_collection';
 
-    private $cacheItemPool;
     private $decorated;
-    private $localCache;
 
     public function __construct(CacheItemPoolInterface $cacheItemPool, ResourceNameCollectionFactoryInterface $decorated)
     {
@@ -41,25 +41,8 @@ public function __construct(CacheItemPoolInterface $cacheItemPool, ResourceNameC
      */
     public function create(): ResourceNameCollection
     {
-        if (null !== $this->localCache) {
-            return $this->localCache;
-        }
-
-        try {
-            $cacheItem = $this->cacheItemPool->getItem(self::CACHE_KEY);
-        } catch (CacheException $e) {
-            return $this->localCache = $this->decorated->create();
-        }
-
-        if ($cacheItem->isHit()) {
-            return $this->localCache = $cacheItem->get();
-        }
-
-        $resourceNameCollection = $this->decorated->create();
-
-        $cacheItem->set($resourceNameCollection);
-        $this->cacheItemPool->save($cacheItem);
-
-        return $this->localCache = $resourceNameCollection;
+        return $this->getCached(self::CACHE_KEY, function () {
+            return $this->decorated->create();
+        });
     }
 }
diff --git a/src/Operation/Factory/CachedSubresourceOperationFactory.php b/src/Operation/Factory/CachedSubresourceOperationFactory.php
