Improve AbstractCacheProvider (#40)

* **BREAKING CHANGES** - Rename interfaces to have the Interface suffix **OTHER CHANGES** - Add pre-projection callables to `AbstractCachedProvider::getAndCacheData` to allow to perform additional operations after fetching data when there is a cache miss - Add `invalidateCacheItemByKey` to `AbstractCachedProvider` to allow invalidation of individual cache items - Fix tests - Add new test cases for the new methods - Update documention * Rework logic of pre-projection callables Fix tests Update Documentation
kununu · Jan 16, 2023 · 4fc1e44 · 4fc1e44
1 parent 0f0431d
commit 4fc1e44
Show file tree

Hide file tree

Showing 45 changed files with 521 additions and 330 deletions.
diff --git a/README.md b/README.md
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
     "symfony/browser-kit": "^4.4",
     "symfony/cache": "^4.4",
     "jms/serializer-bundle": "^3.8",
-    "kununu/testing-bundle": "^15.0",
+    "kununu/testing-bundle": "^16.0",
     "kununu/scripts": "*"
   },
   "suggest": {
@@ -30,5 +30,18 @@
     "psr-4": {
       "Kununu\\Projections\\Tests\\": "tests/"
     }
+  },
+  "scripts": {
+    "test": "phpunit --no-coverage tests",
+    "test-coverage": "phpunit --coverage-clover tests/.results/coverage.xml --coverage-html tests/.results/html/ tests"
+  },
+  "scripts-descriptions": {
+    "test": "Run all tests",
+    "test-coverage": "Run all tests with coverage report"
+  },
+  "config": {
+    "allow-plugins": {
+      "kununu/scripts": true
+    }
   }
 }
diff --git a/src/CacheCleaner/AbstractCacheCleanerByTags.php b/src/CacheCleaner/AbstractCacheCleanerByTags.php
@@ -3,16 +3,16 @@
 
 namespace Kununu\Projections\CacheCleaner;
 
-use Kununu\Projections\ProjectionRepository;
+use Kununu\Projections\ProjectionRepositoryInterface;
 use Kununu\Projections\Tag\Tags;
 use Psr\Log\LoggerInterface;
 
-abstract class AbstractCacheCleanerByTags implements CacheCleaner
+abstract class AbstractCacheCleanerByTags implements CacheCleanerInterface
 {
     private $projectionRepository;
     private $logger;
 
-    public function __construct(ProjectionRepository $projectionRepository, LoggerInterface $logger)
+    public function __construct(ProjectionRepositoryInterface $projectionRepository, LoggerInterface $logger)
     {
         $this->projectionRepository = $projectionRepository;
         $this->logger = $logger;

diff --git a/src/CacheCleaner/CacheCleanerChain.php b/src/CacheCleaner/CacheCleanerChain.php
@@ -3,11 +3,11 @@
 
 namespace Kununu\Projections\CacheCleaner;
 
-final class CacheCleanerChain implements CacheCleaner
+final class CacheCleanerChain implements CacheCleanerInterface
 {
     private $cacheCleaners;
 
-    public function __construct(CacheCleaner ...$cacheCleaners)
+    public function __construct(CacheCleanerInterface ...$cacheCleaners)
     {
         $this->cacheCleaners = $cacheCleaners;
     }

diff --git a/src/CacheCleaner/CacheCleaner.php → src/CacheCleaner/CacheCleanerInterface.php b/src/CacheCleaner/CacheCleaner.php → src/CacheCleaner/CacheCleanerInterface.php
@@ -3,7 +3,7 @@
 
 namespace Kununu\Projections\CacheCleaner;
 
-interface CacheCleaner
+interface CacheCleanerInterface
 {
     public function clear(): void;
 }
diff --git a/src/Exception/ProjectionException.php b/src/Exception/ProjectionException.php
@@ -1,4 +1,5 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Kununu\Projections\Exception;
 

diff --git a/src/ProjectionItem.php → src/ProjectionItemInterface.php b/src/ProjectionItem.php → src/ProjectionItemInterface.php
@@ -1,10 +1,11 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Kununu\Projections;
 
 use Kununu\Projections\Tag\Tags;
 
-interface ProjectionItem
+interface ProjectionItemInterface
 {
     public function getKey(): string;
 

diff --git a/src/ProjectionItemIterable.php → src/ProjectionItemIterableInterface.php b/src/ProjectionItemIterable.php → src/ProjectionItemIterableInterface.php
@@ -1,10 +1,11 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Kununu\Projections;
 
-interface ProjectionItemIterable extends ProjectionItem
+interface ProjectionItemIterableInterface extends ProjectionItemInterface
 {
-    public function storeData(iterable $data): ProjectionItemIterable;
+    public function storeData(iterable $data): ProjectionItemIterableInterface;
 
     public function data(): iterable;
 }
diff --git a/src/ProjectionItemIterableTrait.php b/src/ProjectionItemIterableTrait.php
@@ -1,4 +1,5 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Kununu\Projections;
 
@@ -9,9 +10,9 @@ trait ProjectionItemIterableTrait
     /** @var array */
     private $data;
 
-    public function storeData(iterable $data): ProjectionItemIterable
+    public function storeData(iterable $data): ProjectionItemIterableInterface
     {
-        if ($this instanceof ProjectionItemIterable) {
+        if ($this instanceof ProjectionItemIterableInterface) {
             if (is_array($data)) {
                 $this->data = $data;
             } else {
@@ -23,9 +24,7 @@ public function storeData(iterable $data): ProjectionItemIterable
             return $this;
         }
 
-        throw new BadMethodCallException(
-            sprintf('Class using this trait must be a %s', ProjectionItemIterable::class)
-        );
+        throw new BadMethodCallException(sprintf('Class using this trait must be a %s', ProjectionItemIterableInterface::class));
     }
 
     public function data(): iterable

diff --git a/src/ProjectionRepository.php b/src/ProjectionRepository.php
diff --git a/src/ProjectionRepositoryInterface.php b/src/ProjectionRepositoryInterface.php
@@ -0,0 +1,21 @@
+<?php
+declare(strict_types=1);
+
+namespace Kununu\Projections;
+
+use Kununu\Projections\Tag\Tags;
+
+interface ProjectionRepositoryInterface
+{
+    public function add(ProjectionItemInterface $item): void;
+
+    public function addDeferred(ProjectionItemInterface $item): void;
+
+    public function flush(): void;
+
+    public function get(ProjectionItemInterface $item): ?ProjectionItemInterface;
+
+    public function delete(ProjectionItemInterface $item): void;
+
+    public function deleteByTags(Tags $tags): void;
+}
diff --git a/src/Provider/AbstractCachedProvider.php b/src/Provider/AbstractCachedProvider.php
@@ -3,8 +3,8 @@
 
 namespace Kununu\Projections\Provider;
 
-use Kununu\Projections\ProjectionItemIterable;
-use Kununu\Projections\ProjectionRepository;
+use Kununu\Projections\ProjectionItemIterableInterface;
+use Kununu\Projections\ProjectionRepositoryInterface;
 use Psr\Log\LoggerInterface;
 
 abstract class AbstractCachedProvider
@@ -15,18 +15,21 @@ abstract class AbstractCachedProvider
     private $projectionRepository;
     private $logger;
 
-    public function __construct(ProjectionRepository $projectionRepository, LoggerInterface $logger)
+    public function __construct(ProjectionRepositoryInterface $projectionRepository, LoggerInterface $logger)
     {
         $this->projectionRepository = $projectionRepository;
         $this->logger = $logger;
     }
 
-    protected function getAndCacheData(ProjectionItemIterable $item, callable $dataGetter): ?iterable
-    {
+    protected function getAndCacheData(
+        ProjectionItemIterableInterface $item,
+        callable $dataGetter,
+        callable ...$preProjections
+    ): ?iterable {
         $this->logger->info('Getting data from cache', [self::CACHE_KEY => $item->getKey()]);
 
         $projectedItem = $this->projectionRepository->get($item);
-        if ($projectedItem instanceof ProjectionItemIterable) {
+        if ($projectedItem instanceof ProjectionItemIterableInterface) {
             $this->logger->info(
                 'Item hit! Returning data from the cache',
                 [
@@ -39,16 +42,43 @@ protected function getAndCacheData(ProjectionItemIterable $item, callable $dataG
         }
 
         $this->logger->info('Item not hit! Fetching data...', [self::CACHE_KEY => $item->getKey()]);
+
         $data = $dataGetter();
+
         if (is_iterable($data)) {
-            $this->projectionRepository->add($item->storeData($data));
-            $this->logger->info('Item saved into cache and returned', [self::CACHE_KEY => $item->getKey(), self::DATA => $data]);
+            // Manipulate data before projection if callers are defined
+            foreach ($preProjections as $preProjection) {
+                $data = $preProjection($item, $data);
+                // If pre-projection callable returns null means we do not have relevant information.
+                // We will not store the item in the cache and will break the pre-projection chain
+                if (null === $data) {
+                    $this->logger->info('Item not stored in the cache!', [self::DATA => $data]);
+                    $data = null;
+
+                    break;
+                }
+            }
 
-            return $data;
+            if (null !== $data) {
+                $this->projectionRepository->add($item->storeData($data));
+                $this->logger->info(
+                    'Item saved into cache and returned',
+                    [self::CACHE_KEY => $item->getKey(), self::DATA => $data]
+                );
+            }
+        } else {
+            $this->logger->info('No data fetched and stored into cache!', [self::CACHE_KEY => $item->getKey()]);
+            $data = null;
         }
 
-        $this->logger->info('No data fetched and stored into cache!', [self::CACHE_KEY => $item->getKey()]);
+        return $data;
+    }
+
+    protected function invalidateCacheItemByKey(ProjectionItemIterableInterface $projectionItem): self
+    {
+        $this->logger->info('Deleting cache item', ['cache_key' => $projectionItem->getKey()]);
+        $this->projectionRepository->delete($projectionItem);
 
-        return null;
+        return $this;
     }
 }
diff --git a/src/Repository/CachePoolProjectionRepository.php b/src/Repository/CachePoolProjectionRepository.php
@@ -1,16 +1,17 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Kununu\Projections\Repository;
 
+use JMS\Serializer\SerializerInterface;
 use Kununu\Projections\Exception\ProjectionException;
-use Kununu\Projections\ProjectionItem;
-use Kununu\Projections\ProjectionRepository;
+use Kununu\Projections\ProjectionItemInterface;
+use Kununu\Projections\ProjectionRepositoryInterface;
 use Kununu\Projections\Tag\Tags;
-use JMS\Serializer\SerializerInterface;
 use Psr\Cache\CacheItemInterface;
 use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
 
-final class CachePoolProjectionRepository implements ProjectionRepository
+final class CachePoolProjectionRepository implements ProjectionRepositoryInterface
 {
     private const JMS_SERIALIZER_FORMAT = 'json';
 
@@ -19,11 +20,11 @@ final class CachePoolProjectionRepository implements ProjectionRepository
 
     public function __construct(TagAwareAdapterInterface $cachePool, SerializerInterface $serializer)
     {
-        $this->cachePool  = $cachePool;
+        $this->cachePool = $cachePool;
         $this->serializer = $serializer;
     }
 
-    public function add(ProjectionItem $item): void
+    public function add(ProjectionItemInterface $item): void
     {
         $cacheItem = $this->createCacheItem($item);
 
@@ -32,7 +33,7 @@ public function add(ProjectionItem $item): void
         }
     }
 
-    public function addDeferred(ProjectionItem $item): void
+    public function addDeferred(ProjectionItemInterface $item): void
     {
         $cacheItem = $this->createCacheItem($item);
 
@@ -48,7 +49,7 @@ public function flush(): void
         }
     }
 
-    public function get(ProjectionItem $item): ?ProjectionItem
+    public function get(ProjectionItemInterface $item): ?ProjectionItemInterface
     {
         $cacheItem = $this->cachePool->getItem($item->getKey());
 
@@ -59,7 +60,7 @@ public function get(ProjectionItem $item): ?ProjectionItem
         return $this->serializer->deserialize($cacheItem->get(), get_class($item), self::JMS_SERIALIZER_FORMAT);
     }
 
-    public function delete(ProjectionItem $item): void
+    public function delete(ProjectionItemInterface $item): void
     {
         if (!$this->cachePool->deleteItem($item->getKey())) {
             throw new ProjectionException('Not possible to delete projection item on cache pool');
@@ -73,7 +74,7 @@ public function deleteByTags(Tags $tags): void
         }
     }
 
-    private function createCacheItem(ProjectionItem $item): CacheItemInterface
+    private function createCacheItem(ProjectionItemInterface $item): CacheItemInterface
     {
         $cacheItem = $this->cachePool->getItem($item->getKey());
         $cacheItem->set($this->serializer->serialize($item, self::JMS_SERIALIZER_FORMAT));

diff --git a/src/Tag/ProjectionTagGenerator.php b/src/Tag/ProjectionTagGenerator.php
@@ -1,17 +1,19 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Kununu\Projections\Tag;
 
 trait ProjectionTagGenerator
 {
-    private static function createTagsFromArray(string ...$tagsAsStrings): Tags
+    private static function createTagsFromArray(string ...$tags): Tags
     {
-        $tags = [];
-
-        foreach ($tagsAsStrings as $tag) {
-            $tags[] = new Tag($tag);
-        }
-
-        return new Tags(...$tags);
+        return new Tags(
+            ...array_map(
+                function(string $tag): Tag {
+                    return new Tag($tag);
+                },
+                $tags
+            )
+        );
     }
 }
diff --git a/src/Tag/Tag.php b/src/Tag/Tag.php
@@ -1,4 +1,5 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Kununu\Projections\Tag;