feat: allow to configure header name for reverse_proxy_ttl specific v…

…alue

CHANGELOG.md

@@ -4,6 +4,13 @@ Changelog
 3.x
 ===
 
+3.1.0
+-----
+
+### Added
+
+* New Feature: allow configuring the TTL header name for the special `reverse_proxy_ttl` config value. #638
+
 3.0.2
 -----
 

Resources/doc/features/headers.rst

@@ -69,5 +69,25 @@ This is an example configuration. For more, see the
                         cache_control: { public: true, max_age: 15, s_maxage: 30 }
                         etag: "strong"
 
+This is an example with the special `` and `` configurations.
+
+.. code-block:: yaml
+
+    # app/config/config.yml
+    fos_http_cache:
+        cache_control:
+            ttl_header: X-My-Cache-Control
+            defaults:
+                overwrite: true
+            rules:
+                # match everything to set defaults
+                -
+                    match:
+                        path: ^/
+                    headers:
+                        overwrite: false
+                        cache_control: { public: true, max_age: 15, s_maxage: 30, reverse_proxy_ttl: 60 }
+                        etag: "strong"
+
 .. _manually setting cache headers: https://symfony.com/doc/current/http_cache.html#the-cache-control-header
 .. _setting caching headers through attributes: https://symfony.com/doc/current/http_cache.html#making-your-responses-http-cacheable

src/DependencyInjection/Configuration.php

@@ -277,6 +277,10 @@ private function addCacheControlSection(ArrayNodeDefinition $rootNode): void
                                 ->end()
                             ->end()
                         ->end()
+                        ->scalarNode('ttl_header')
+                            ->defaultValue('X-Reverse-Proxy-TTL')
+                            ->info('Specify the header name to use with the cache_control.reverse_proxy_ttl setting')
+                        ->end()
                         ->arrayNode('rules')
                             ->prototype('array')
                                 ->children();
@@ -330,7 +334,7 @@ private function addCacheControlSection(ArrayNodeDefinition $rootNode): void
                     ->end()
                     ->scalarNode('reverse_proxy_ttl')
                         ->defaultNull()
-                        ->info('Specify an X-Reverse-Proxy-TTL header with a time in seconds for a caching proxy under your control.')
+                        ->info('Specify a custom time to live in seconds for your caching proxy. This value is sent in the custom header configured in cache_control.ttl_header.')
                     ->end()
                     ->arrayNode('vary')
                         ->beforeNormalization()->ifString()->then(function ($v) {

src/DependencyInjection/FOSHttpCacheExtension.php

@@ -48,7 +48,9 @@ public function load(array $configs, ContainerBuilder $container): void
 
         if ($config['debug']['enabled'] || (!empty($config['cache_control']))) {
             $debugHeader = $config['debug']['enabled'] ? $config['debug']['header'] : false;
+            $ttlHeader = $config['cache_control']['ttl_header'] ?? '';
             $container->setParameter('fos_http_cache.debug_header', $debugHeader);
+            $container->setParameter('fos_http_cache.ttl_header', $ttlHeader);
             $loader->load('cache_control_listener.xml');
         }
 

src/EventListener/CacheControlListener.php

@@ -56,6 +56,7 @@ public function __construct(
          * @var string|false Name of the header or false to add no header
          */
         private readonly string|false $debugHeader = false,
+        private readonly string $ttlHeader = 'X-Reverse-Proxy-TTL',
     ) {
     }
 
@@ -115,9 +116,9 @@ public function onKernelResponse(ResponseEvent $event): void
 
         if (array_key_exists('reverse_proxy_ttl', $options)
             && null !== $options['reverse_proxy_ttl']
-            && !$response->headers->has('X-Reverse-Proxy-TTL')
+            && !$response->headers->has($this->ttlHeader)
         ) {
-            $response->headers->set('X-Reverse-Proxy-TTL', $options['reverse_proxy_ttl'], false);
+            $response->headers->set($this->ttlHeader, $options['reverse_proxy_ttl'], false);
         }
 
         if (!empty($options['vary'])) {

src/Resources/config/cache_control_listener.xml

@@ -9,6 +9,7 @@
                  class="FOS\HttpCacheBundle\EventListener\CacheControlListener"
                  public="true">
             <argument>%fos_http_cache.debug_header%</argument>
+            <argument>%fos_http_cache.ttl_header%</argument>
             <tag name="kernel.event_subscriber" />
         </service>
         <service id="FOS\HttpCacheBundle\EventListener\CacheControlListener" alias="fos_http_cache.event_listener.cache_control" public="true"/>

tests/Resources/Fixtures/config/etag_true.php

@@ -21,6 +21,7 @@
                     ],
                 ],
             ],
+            'ttl_header' => 'X-Reverse-Proxy-TTL',
         ],
     ]
 );

tests/Resources/Fixtures/config/etag_true.xml

@@ -9,6 +9,7 @@
                 <headers etag="true">
                 </headers>
             </rule>
+            <ttl-header>X-Reverse-Proxy-TTL</ttl-header>
         </cache-control>
     </config>
 

tests/Resources/Fixtures/config/etag_true.yml

@@ -5,4 +5,5 @@ fos_http_cache:
                 match:
                     path: null
                 headers:
-                    etag: true
+                    etag: true
+        ttl_header: X-Reverse-Proxy-TTL

tests/Resources/Fixtures/config/etag_weak.php

@@ -21,6 +21,7 @@
                     ],
                 ],
             ],
+            'ttl_header' => 'X-Reverse-Proxy-TTL',
         ],
     ]
 );

tests/Resources/Fixtures/config/etag_weak.xml

@@ -9,6 +9,7 @@
                 <headers etag="weak">
                 </headers>
             </rule>
+            <ttl-header>X-Reverse-Proxy-TTL</ttl-header>
         </cache-control>
     </config>
 

tests/Resources/Fixtures/config/etag_weak.yml

@@ -5,4 +5,5 @@ fos_http_cache:
                 match:
                     path: null
                 headers:
-                    etag: "weak"
+                    etag: "weak"
+        ttl_header: X-Reverse-Proxy-TTL

tests/Resources/Fixtures/config/full.php

@@ -51,6 +51,7 @@
                 ],
             ],
         ],
+        'ttl_header' => 'X-Reverse-Proxy-TTL',
     ],
     'proxy_client' => [
         'varnish' => [

tests/Resources/Fixtures/config/full.xml

@@ -43,6 +43,7 @@
                     <vary>Authorization</vary>
                 </headers>
             </rule>
+            <ttl-header>X-Reverse-Proxy-TTL</ttl-header>
         </cache-control>
         <proxy-client>
             <varnish tags-header="My-Cache-Tags" header-length="1234">

tests/Resources/Fixtures/config/full.yml

@@ -43,6 +43,7 @@ fos_http_cache:
                     vary:
                         - Cookie
                         - Authorization
+        ttl_header: X-Reverse-Proxy-TTL
     proxy_client:
         varnish:
             tags_header: My-Cache-Tags

tests/Resources/Fixtures/config/split.php

@@ -11,6 +11,7 @@
 
 $container->loadFromExtension('fos_http_cache', [
     'cache_control' => [
+        'ttl_header' => 'X-My-Header',
         'rules' => [
             [
                 'match' => [

tests/Resources/Fixtures/config/split.xml

@@ -3,6 +3,7 @@
 
     <config xmlns="http://example.org/schema/dic/fos_http_cache">
         <cache-control>
+            <ttl-header>X-My-Header</ttl-header>
             <rule>
                 <match>
                     <methods>GET,POST</methods>

tests/Resources/Fixtures/config/split.yml

@@ -1,6 +1,7 @@
 fos_http_cache:
 
     cache_control:
+        ttl_header: X-My-Header
         rules:
             -
                 match:

tests/Unit/DependencyInjection/ConfigurationTest.php

@@ -96,6 +96,7 @@ public function testSupportsAllConfigFormats(): void
                         ],
                     ],
                 ],
+                'ttl_header' => 'X-Reverse-Proxy-TTL',
             ],
             'proxy_client' => [
                 'varnish' => [
@@ -474,6 +475,7 @@ public function testSplitOptions(): void
     {
         $expectedConfiguration = $this->getEmptyConfig();
         $expectedConfiguration['cache_control'] = [
+            'ttl_header' => 'X-My-Header',
             'rules' => [
                 [
                     'match' => [
@@ -637,6 +639,7 @@ public function testWeakETags(): void
                     ],
                 ],
             ],
+            'ttl_header' => 'X-Reverse-Proxy-TTL',
             'defaults' => [
                 'overwrite' => false,
             ],
@@ -679,6 +682,7 @@ public function testStrongETags(): void
                     ],
                 ],
             ],
+            'ttl_header' => 'X-Reverse-Proxy-TTL',
             'defaults' => [
                 'overwrite' => false,
             ],

tests/Unit/EventListener/CacheControlListenerTest.php

@@ -334,6 +334,21 @@ public function testReverseProxyTtl(): void
         $this->assertEquals(600, $newHeaders['x-reverse-proxy-ttl'][0]);
     }
 
+    public function testReverseProxyTtlHeader(): void
+    {
+        $event = $this->buildEvent();
+        $headers = [
+            'reverse_proxy_ttl' => 700,
+        ];
+        $listener = $this->getCacheControl($headers, 'X-My-Header');
+
+        $listener->onKernelResponse($event);
+        $newHeaders = $event->getResponse()->headers->all();
+
+        $this->assertTrue(isset($newHeaders['x-my-header']), implode(',', array_keys($newHeaders)));
+        $this->assertEquals(700, $newHeaders['x-my-header'][0]);
+    }
+
     public function testDebugHeader(): void
     {
         $listener = new CacheControlListener('X-Cache-Debug');
@@ -426,9 +441,9 @@ protected function buildEvent(string $method = 'GET'): ResponseEvent
      *
      * @param array $headers The headers to return from the matcher
      */
-    protected function getCacheControl(array $headers): CacheControlListener|MockObject
+    protected function getCacheControl(array $headers, string $ttlHeader = 'X-Reverse-Proxy-TTL'): CacheControlListener|MockObject
     {
-        $listener = new CacheControlListener();
+        $listener = new CacheControlListener(false, $ttlHeader);
 
         $matcher = \Mockery::mock(RuleMatcherInterface::class)
             ->shouldReceive(['matches' => true])