bug #49480 [FrameworkBundle] Add framework.http_cache.skip_response_headers option (alexandre-daubois)

nicolas-grekas · nicolas-grekas · commit fa374925b481 · 2023-02-22T11:35:22.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [FrameworkBundle] Add `framework.http_cache.skip_response_headers` option | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Followup of #49318 | License | MIT | Doc PR | symfony/symfony-docs#17951 While thinking about where to add documentation for symfony/symfony-docs#17941, I realized that all HTTP Cache options are available under `framework.http_cache` config. By adding this option as well, we'll be able to write documentation about it, in the framework configuration reference. Commits ------- 010aa39 [FrameworkBundle] Add `framework.http_cache.skip_response_headers` option
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -15,6 +15,7 @@ CHANGELOG
  * Register alias for argument for workflow services with workflow name only
  * Configure the `ErrorHandler` on `FrameworkBundle::boot()`
  * Allow setting `debug.container.dump` to `false` to disable dumping the container to XML
+ * Add `framework.http_cache.skip_response_headers` option
 
 6.2
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -263,6 +263,10 @@ private function addHttpCacheSection(ArrayNodeDefinition $rootNode): void
                             ->performNoDeepMerging()
                             ->scalarPrototype()->end()
                         ->end()
+                        ->arrayNode('skip_response_headers')
+                            ->performNoDeepMerging()
+                            ->scalarPrototype()->end()
+                        ->end()
                         ->booleanNode('allow_reload')->end()
                         ->booleanNode('allow_revalidate')->end()
                         ->integerNode('stale_while_revalidate')->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -762,6 +762,10 @@ private function registerHttpCacheConfiguration(array $config, ContainerBuilder
             unset($options['private_headers']);
         }
 
+        if (!$options['skip_response_headers']) {
+            unset($options['skip_response_headers']);
+        }
+
         $container->getDefinition('http_cache')
             ->setPublic($config['enabled'])
             ->replaceArgument(3, $options);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -671,6 +671,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 'enabled' => false,
                 'debug' => '%kernel.debug%',
                 'private_headers' => [],
+                'skip_response_headers' => [],
             ],
             'rate_limiter' => [
                 'enabled' => !class_exists(FullStack::class) && class_exists(TokenBucketLimiter::class),
diff --git a/src/Symfony/Component/HttpClient/CachingHttpClient.php b/src/Symfony/Component/HttpClient/CachingHttpClient.php
@@ -52,6 +52,7 @@ public function __construct(HttpClientInterface $client, StoreInterface $store,
         unset($defaultOptions['debug']);
         unset($defaultOptions['default_ttl']);
         unset($defaultOptions['private_headers']);
+        unset($defaultOptions['skip_response_headers']);
         unset($defaultOptions['allow_reload']);
         unset($defaultOptions['allow_revalidate']);
         unset($defaultOptions['stale_while_revalidate']);
