Merge pull request #118 from koriym/spike

Added surrogate key to Donut view
bearsunday · Jul 13, 2022 · 434f1d3 · 434f1d3
2 parents d9db550 + 0110dbb
commit 434f1d3
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 9 deletions.
diff --git a/src/DonutRepository.php b/src/DonutRepository.php
@@ -9,6 +9,7 @@
 use BEAR\Resource\ResourceObject;
 
 use function assert;
+use function explode;
 
 final class DonutRepository implements DonutRepositoryInterface
 {
@@ -60,14 +61,15 @@ public function putStatic(ResourceObject $ro, ?int $ttl = null, ?int $sMaxAge =
     {
         $this->logger->log('put-donut: uri:%s ttl:%s s-maxage:%d', (string) $ro->uri, $sMaxAge, $ttl);
         $keys = new SurrogateKeys($ro->uri);
+        $headerKeys = $this->getHeaderKeys($ro);
         $donut = ResourceDonut::create($ro, $this->renderer, $keys, $sMaxAge, true);
         $donut->render($ro, $this->renderer);
         $this->setHeaders($keys, $ro, $sMaxAge);
         // delete
         $this->resourceStorage->invalidateTags([(new UriTag())($ro->uri)]);
         // save content cache and donut
         $this->saveView($ro, $sMaxAge);
-        $this->resourceStorage->saveDonut($ro->uri, $donut, $ttl);
+        $this->resourceStorage->saveDonut($ro->uri, $donut, $ttl, $headerKeys);
 
         return $ro;
     }
@@ -79,13 +81,14 @@ public function putDonut(ResourceObject $ro, ?int $donutTtl): ResourceObject
     {
         $this->logger->log('put-donut: uri:%s ttl:%s', (string) $ro->uri, $donutTtl);
         $keys = new SurrogateKeys($ro->uri);
+        $keyArrays = $this->getHeaderKeys($ro);
         $donut = ResourceDonut::create($ro, $this->renderer, $keys, $donutTtl, false);
         $donut->render($ro, $this->renderer);
         $keys->setSurrogateHeader($ro);
         // delete
         $this->resourceStorage->invalidateTags([(new UriTag())($ro->uri)]);
         // save donut
-        $this->resourceStorage->saveDonut($ro->uri, $donut, $donutTtl);
+        $this->resourceStorage->saveDonut($ro->uri, $donut, $donutTtl, $keyArrays);
 
         return $ro;
     }
@@ -145,4 +148,12 @@ private function setHeaders(SurrogateKeys $keys, ResourceObject $ro, ?int $sMaxA
         ($this->cdnCacheControlHeaderSetter)($ro, $sMaxAge);
         ($this->headerSetter)($ro, 0, null);
     }
+
+    /**
+     * @return list<string>
+     */
+    public function getHeaderKeys(ResourceObject $ro): array
+    {
+        return isset($ro->headers[Header::SURROGATE_KEY]) ? explode(' ', $ro->headers[Header::SURROGATE_KEY]) : [];
+    }
 }
diff --git a/src/Exception/ResourceStorageUnserializeException.php b/src/Exception/ResourceStorageUnserializeException.php
@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BEAR\QueryRepository\Exception;
+
+class ResourceStorageUnserializeException extends RuntimeException
+{
+}
diff --git a/src/ResourceStorage.php b/src/ResourceStorage.php
@@ -191,12 +191,14 @@ public function saveView(ResourceObject $ro, int $ttl)
         return $this->saver->__invoke($key, $value, $this->roPool, $tags, $ttl);
     }
 
-    public function saveDonut(AbstractUri $uri, ResourceDonut $donut, ?int $sMaxAge): void
+    /**
+     * {@inheritDoc}
+     */
+    public function saveDonut(AbstractUri $uri, ResourceDonut $donut, ?int $sMaxAge, array $headerKeys): void
     {
         $key = $this->getUriKey($uri, self::KEY_DONUT);
         $this->logger->log('save-donut uri:%s s-maxage:%s', $uri, $sMaxAge);
-
-        $this->saver->__invoke($key, $donut, $this->roPool, [], $sMaxAge);
+        $this->saver->__invoke($key, $donut, $this->roPool, $headerKeys, $sMaxAge);
     }
 
     public function saveDonutView(ResourceObject $ro, ?int $ttl): bool

diff --git a/src/ResourceStorageCacheableTrait.php b/src/ResourceStorageCacheableTrait.php
@@ -4,9 +4,12 @@
 
 namespace BEAR\QueryRepository;
 
+use BEAR\QueryRepository\Exception\ResourceStorageUnserializeException;
 use BEAR\RepositoryModule\Annotation\EtagPool;
+use Error;
 use Psr\Cache\CacheItemPoolInterface;
 use Ray\Di\Di\Inject;
+use Ray\Di\Exception\Unbound;
 use Ray\Di\InjectorInterface;
 use Ray\PsrCacheModule\Annotation\Shared;
 use Symfony\Component\Cache\Adapter\AdapterInterface;
@@ -52,13 +55,34 @@ final public function __serialize(): array
      * @param array{logger: RepositoryLoggerInterface, purger: PurgerInterface, uriTag: UriTagInterface, saver: ResourceStorageSaver, knownTagTtl: float, injector: InjectorInterface} $data
      */
     final public function __unserialize(array $data): void
+    {
+        try {
+            $this->unserialize($data);
+            // @codeCoverageIgnoreStart
+        } catch (Error $e) {
+            throw new ResourceStorageUnserializeException($e->getMessage());
+            // @codeCoverageIgnoreEnd
+        }
+    }
+
+    /**
+     * @param array{logger: RepositoryLoggerInterface, purger: PurgerInterface, uriTag: UriTagInterface, saver: ResourceStorageSaver, knownTagTtl: float, injector: InjectorInterface} $data
+     */
+    private function unserialize(array $data): void
     {
         $this->logger = $data['logger'];
         $this->purger = $data['purger'];
         $this->uriTag = $data['uriTag'];
         $this->saver = $data['saver'];
         $pool = $data['injector']->getInstance(CacheItemPoolInterface::class, Shared::class);
-        $maybeEtagPool = $data['injector']->getInstance(CacheItemPoolInterface::class, EtagPool::class);
+        try {
+            $maybeEtagPool = $data['injector']->getInstance(CacheItemPoolInterface::class, EtagPool::class);
+            // @codeCoverageIgnoreStart
+        } catch (Unbound $e) {
+            $maybeEtagPool = null;
+            // @codeCoverageIgnoreEnd
+        }
+
         assert($pool instanceof AdapterInterface);
         /** @psalm-suppress all */
         $etagPool = $maybeEtagPool instanceof AdapterInterface ? $maybeEtagPool : $pool;

diff --git a/src/ResourceStorageInterface.php b/src/ResourceStorageInterface.php
@@ -52,8 +52,10 @@ public function getDonut(AbstractUri $uri): ?ResourceDonut;
 
     /**
      * Save donut-cacheable page
+     *
+     * @param list<string> $headerKeys
      */
-    public function saveDonut(AbstractUri $uri, ResourceDonut $donut, ?int $sMaxAge): void;
+    public function saveDonut(AbstractUri $uri, ResourceDonut $donut, ?int $sMaxAge, array $headerKeys): void;
 
     /**
      * Save donut-cache state

diff --git a/src/SurrogateKeys.php b/src/SurrogateKeys.php
@@ -18,7 +18,7 @@
 
 final class SurrogateKeys
 {
-    /** @var array<string> */
+    /** @var list<string> */
     private array $surrogateKeys;
     private UriTagInterface $uriTag;
 

diff --git a/tests/ResourceStorageTest.php b/tests/ResourceStorageTest.php
@@ -30,7 +30,7 @@ protected function setUp(): void
     public function testSaveGetStatic(): void
     {
         $donut = ResourceDonut::create($this->ro, new DonutRenderer(), new SurrogateKeys(new Uri('app://self/')), null, false);
-        $this->storage->saveDonut($this->ro->uri, $donut, null);
+        $this->storage->saveDonut($this->ro->uri, $donut, null, []);
         $donut = $this->storage->getDonut($this->ro->uri);
         $this->assertInstanceOf(ResourceDonut::class, $donut);
     }