Merge pull request #134 from jingu/save-donut-headers

koriym · web-flow · commit de00720d894a · 2024-03-27T00:04:14.000+09:00
Add ResourceDonut header to save headers
diff --git a/src/ResourceDonut.php b/src/ResourceDonut.php
@@ -22,8 +22,10 @@ final class ResourceDonut
 
     private const URI_REGEX = '/\[le:(.+)]/';
 
+    /** @param array<string, string> $headers */
     public function __construct(
         private string $template,
+        private array $headers,
         /** @readonly */
         public int|null $ttl,
         /** @readonly */
@@ -45,8 +47,9 @@ public function refresh(ResourceInterface $resource, ResourceObject $ro): Resour
             return (string) $ro->view;
         }, $this->template);
 
-        $etags->setSurrogateHeader($ro);
+        $ro->headers = $this->headers;
         $ro->view = $refreshView;
+        $etags->setSurrogateHeader($ro);
 
         return $ro;
     }
@@ -72,6 +75,6 @@ public static function create(ResourceObject $ro, DonutRendererInterface $storag
         unset($maybeRequest);
         $donutTemplate = (string) $ro;
 
-        return new self($donutTemplate, $ttl, $isCacheble);
+        return new self($donutTemplate, $ro->headers, $ttl, $isCacheble);
     }
 }
diff --git a/src/ResourceStorageSaver.php b/src/ResourceStorageSaver.php
@@ -19,7 +19,7 @@ public function __invoke(string $key, mixed $value, CacheItemPoolInterface $pool
         assert($cacheItem instanceof CacheItem);
         $cacheItem->tag($tags);
 
-        if ($ttl) {
+        if ($ttl !== null && $ttl > 0) {
             $cacheItem->expiresAfter($ttl);
         }
 
diff --git a/tests/DonutCacheTest.php b/tests/DonutCacheTest.php
@@ -30,10 +30,12 @@ protected function setUp(): void
 
     public function testGetState(): void
     {
-        $donut = new ResourceDonut('cmt=[le:page://self/html/comment]', null, true);
+        $headers = ['Content-Type' => 'application/xml;'];
+        $donut = new ResourceDonut('cmt=[le:page://self/html/comment]', $headers, null, true);
         $blog = $this->resource->get('page://self/html/blog-posting');
         $ro = $donut->refresh($this->resource, $blog);
         $this->assertInstanceOf(ResourceObject::class, $ro);
         $this->assertSame('cmt=comment01', $ro->view);
+        $this->assertSame($headers['Content-Type'], $ro->headers['Content-Type']);
     }
 }
diff --git a/tests/DonutRepositoryTest.php b/tests/DonutRepositoryTest.php
@@ -116,6 +116,7 @@ public function testRefresh(): void
         assert($queryRepository->purge(new Uri('page://self/html/comment')));
         $donutRo = $resource->get('page://self/html/blog-posting');
         $this->assertSame('r', $donutRo->headers[Header::ETAG][-1]);
+        $this->assertStringContainsString('blog-posting-page', $donutRo->headers[Header::SURROGATE_KEY]);
     }
 
     public function testInvalidateTags(): void

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public function __invoke(string $key, mixed $value, CacheItemPoolInterface $pool`
`19`	`19`	`assert($cacheItem instanceof CacheItem);`
`20`	`20`	`$cacheItem->tag($tags);`
`21`	`21`
`22`		`- if ($ttl) {`
	`22`	`+ if ($ttl !== null && $ttl > 0) {`
`23`	`23`	`$cacheItem->expiresAfter($ttl);`
`24`	`24`	`}`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -30,10 +30,12 @@ protected function setUp(): void`
`30`	`30`
`31`	`31`	`public function testGetState(): void`
`32`	`32`	`{`
`33`		`- $donut = new ResourceDonut('cmt=[le:page://self/html/comment]', null, true);`
	`33`	`+ $headers = ['Content-Type' => 'application/xml;'];`
	`34`	`+ $donut = new ResourceDonut('cmt=[le:page://self/html/comment]', $headers, null, true);`
`34`	`35`	`$blog = $this->resource->get('page://self/html/blog-posting');`
`35`	`36`	`$ro = $donut->refresh($this->resource, $blog);`
`36`	`37`	`$this->assertInstanceOf(ResourceObject::class, $ro);`
`37`	`38`	`$this->assertSame('cmt=comment01', $ro->view);`
	`39`	`+ $this->assertSame($headers['Content-Type'], $ro->headers['Content-Type']);`
`38`	`40`	`}`
`39`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,7 @@ public function testRefresh(): void`
`116`	`116`	`assert($queryRepository->purge(new Uri('page://self/html/comment')));`
`117`	`117`	`$donutRo = $resource->get('page://self/html/blog-posting');`
`118`	`118`	`$this->assertSame('r', $donutRo->headers[Header::ETAG][-1]);`
	`119`	`+ $this->assertStringContainsString('blog-posting-page', $donutRo->headers[Header::SURROGATE_KEY]);`
`119`	`120`	`}`
`120`	`121`
`121`	`122`	`public function testInvalidateTags(): void`