feat(config): Make etag in cdn configurable (#102)

Author: silasjoisten

src/Controller/CdnController.php

@@ -37,6 +37,7 @@ public function __construct(
         private ?int $maxAge,
         private ?int $smaxAge,
         private ?bool $public,
+        private ?bool $etag = null,
     ) {
     }
 
@@ -79,7 +80,7 @@ public function __invoke(Request $request, string $id, string $filename, string
             $response->headers->set('Content-Type', $metadata->contentType);
         }
 
-        if (null !== $metadata->etag) {
+        if (true === $this->etag && null !== $metadata->etag) {
             $response->setEtag($metadata->etag);
         }
 

src/DependencyInjection/Configuration.php

@@ -140,6 +140,9 @@ public function getConfigTreeBuilder(): TreeBuilder
                                 ->booleanNode('public')
                                     ->defaultNull()
                                 ->end()
+                                ->booleanNode('etag')
+                                    ->defaultNull()
+                                ->end()
                                 ->integerNode('max_age')
                                     ->defaultNull()
                                 ->end()

src/DependencyInjection/StoryblokExtension.php

@@ -176,6 +176,7 @@ private static function configureCdn(ContainerBuilder $container, array $config)
         $cdnController->setArgument('$public', $config['cdn']['cache']['public']);
         $cdnController->setArgument('$maxAge', $config['cdn']['cache']['max_age']);
         $cdnController->setArgument('$smaxAge', $config['cdn']['cache']['smax_age']);
+        $cdnController->setArgument('$etag', $config['cdn']['cache']['etag']);
 
         if ('filesystem' === $config['cdn']['storage']['type']) {
             // Configure filesystem storage with the provided path

tests/Unit/Controller/CdnControllerTest.php

@@ -221,7 +221,7 @@ public function setsContentTypeHeader(): void
     }
 
     #[Test]
-    public function setsEtagHeader(): void
+    public function setsEtagHeaderWhenConfigured(): void
     {
         $tempFile = $this->createTempFile('content');
         $file = new File($tempFile);
@@ -240,13 +240,40 @@ public function setsEtagHeader(): void
 
         $downloader = self::createMock(FileDownloaderInterface::class);
 
-        $controller = new CdnController($storage, $downloader, null, null, null);
+        $controller = new CdnController($storage, $downloader, null, null, null, true);
 
         $response = $controller->__invoke(new Request(), 'ef7436441c4defbf', 'image', 'jpg');
 
         self::assertSame('"etag-value-123"', $response->getEtag());
     }
 
+    #[Test]
+    public function doesNotSetEtagHeaderWhenNotConfigured(): void
+    {
+        $tempFile = $this->createTempFile('content');
+        $file = new File($tempFile);
+
+        $metadata = new CdnFileMetadata(
+            originalUrl: 'https://a.storyblok.com/f/12345/image.jpg',
+            contentType: 'image/jpeg',
+            etag: '"etag-value-123"',
+            expiresAt: new DateTimeImmutable('+1 day'),
+        );
+
+        $storage = self::createMock(CdnStorageInterface::class);
+        $storage->method('getMetadata')->willReturn($metadata);
+        $storage->method('hasFile')->willReturn(true);
+        $storage->method('getFile')->willReturn($file);
+
+        $downloader = self::createMock(FileDownloaderInterface::class);
+
+        $controller = new CdnController($storage, $downloader, null, null, null, null);
+
+        $response = $controller->__invoke(new Request(), 'ef7436441c4defbf', 'image', 'jpg');
+
+        self::assertNull($response->getEtag());
+    }
+
     #[Test]
     public function setsMaxAgeWhenConfigured(): void
     {
@@ -400,7 +427,7 @@ public function returns304WhenEtagMatches(): void
 
         $downloader = self::createMock(FileDownloaderInterface::class);
 
-        $controller = new CdnController($storage, $downloader, null, null, null);
+        $controller = new CdnController($storage, $downloader, null, null, null, true);
 
         $request = new Request();
         $request->headers->set('If-None-Match', '"etag-value-123"');

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -99,6 +99,7 @@ public function values(): void
                 ],
                 'cache' => [
                     'public' => $cdnPublic,
+                    'etag' => null,
                     'max_age' => $cdnMaxAge,
                     'smax_age' => $cdnSmaxAge,
                 ],
@@ -142,6 +143,7 @@ public function defaults(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => null,
                 ],
@@ -186,6 +188,7 @@ public function cdnCanBeExplicitlyDisabled(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => null,
                 ],
@@ -230,6 +233,7 @@ public function cdnCacheCanBeCustomized(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => 3600,
                     'smax_age' => null,
                 ],
@@ -274,6 +278,7 @@ public function cdnStorageTypeCanBeCustom(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => null,
                 ],
@@ -335,6 +340,7 @@ public function cdnNullMeansEnabledWithDefaults(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => null,
                 ],
@@ -379,6 +385,7 @@ public function cdnTrueMeansEnabledWithDefaults(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => null,
                 ],
@@ -423,6 +430,7 @@ public function cdnFalseMeansDisabled(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => null,
                 ],
@@ -493,6 +501,7 @@ public function controllerCacheSmaxAgeWithPrivateTriggersDeprecation(): void
                 ],
                 'cache' => [
                     'public' => null,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => null,
                 ],
@@ -539,6 +548,7 @@ public function cdnCacheSmaxAgeWithPrivateTriggersDeprecation(): void
                 ],
                 'cache' => [
                     'public' => false,
+                    'etag' => null,
                     'max_age' => null,
                     'smax_age' => 3600,
                 ],