Skip to content

Commit 7995f55

Browse files
dbudbu
authored
Merge pull request #638 from 94noni/ttl-header-cache-control
feat: allow to configure header name for reverse_proxy_ttl specific value
2 parents cfb93c3 + 8c3ee8b commit 7995f55

File tree

20 files changed

+76
-7
lines changed

20 files changed

+76
-7
lines changed

Diff for: ‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ Changelog
44
3.x
55
===
66

7+
3.1.0
8+
-----
9+
10+
### Added
11+
12+
* New Feature: allow configuring the TTL header name for the special `reverse_proxy_ttl` config value. #638
13+
714
3.0.2
815
-----
916

Diff for: ‎Resources/doc/reference/configuration/headers.rst

+23
Original file line numberDiff line numberDiff line change
@@ -345,3 +345,26 @@ section:
345345
s_maxage: 60
346346
347347
This example adds the header ``X-Reverse-Proxy-TTL: 3600`` to your responses.
348+
349+
``ttl_header``
350+
--------------
351+
352+
**type**: ``string`` default `X-Reverse-Proxy-TTL`
353+
354+
Change the name for the header for reverse proxy.
355+
356+
.. code-block:: yaml
357+
358+
# app/config/config.yml
359+
fos_http_cache:
360+
cache_control:
361+
ttl_header: X-My-Cache-Control
362+
rules:
363+
-
364+
headers:
365+
reverse_proxy_ttl: 3600
366+
cache_control:
367+
public: true
368+
s_maxage: 60
369+
370+
This example adds the header ``X-My-Cache-Control: 3600`` to your responses.

Diff for: ‎src/DependencyInjection/Configuration.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,10 @@ private function addCacheControlSection(ArrayNodeDefinition $rootNode): void
277277
->end()
278278
->end()
279279
->end()
280+
->scalarNode('ttl_header')
281+
->defaultValue('X-Reverse-Proxy-TTL')
282+
->info('Specify the header name to use with the cache_control.reverse_proxy_ttl setting')
283+
->end()
280284
->arrayNode('rules')
281285
->prototype('array')
282286
->children();
@@ -330,7 +334,7 @@ private function addCacheControlSection(ArrayNodeDefinition $rootNode): void
330334
->end()
331335
->scalarNode('reverse_proxy_ttl')
332336
->defaultNull()
333-
->info('Specify an X-Reverse-Proxy-TTL header with a time in seconds for a caching proxy under your control.')
337+
->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.')
334338
->end()
335339
->arrayNode('vary')
336340
->beforeNormalization()->ifString()->then(function ($v) {

Diff for: ‎src/DependencyInjection/FOSHttpCacheExtension.php

+2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ public function load(array $configs, ContainerBuilder $container): void
4848

4949
if ($config['debug']['enabled'] || (!empty($config['cache_control']))) {
5050
$debugHeader = $config['debug']['enabled'] ? $config['debug']['header'] : false;
51+
$ttlHeader = $config['cache_control']['ttl_header'];
5152
$container->setParameter('fos_http_cache.debug_header', $debugHeader);
53+
$container->setParameter('fos_http_cache.ttl_header', $ttlHeader);
5254
$loader->load('cache_control_listener.xml');
5355
}
5456

Diff for: ‎src/EventListener/CacheControlListener.php

+3-2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public function __construct(
5656
* @var string|false Name of the header or false to add no header
5757
*/
5858
private readonly string|false $debugHeader = false,
59+
private readonly string $ttlHeader = 'X-Reverse-Proxy-TTL',
5960
) {
6061
}
6162

@@ -115,9 +116,9 @@ public function onKernelResponse(ResponseEvent $event): void
115116

116117
if (array_key_exists('reverse_proxy_ttl', $options)
117118
&& null !== $options['reverse_proxy_ttl']
118-
&& !$response->headers->has('X-Reverse-Proxy-TTL')
119+
&& !$response->headers->has($this->ttlHeader)
119120
) {
120-
$response->headers->set('X-Reverse-Proxy-TTL', $options['reverse_proxy_ttl'], false);
121+
$response->headers->set($this->ttlHeader, $options['reverse_proxy_ttl'], false);
121122
}
122123

123124
if (!empty($options['vary'])) {

Diff for: ‎src/Resources/config/cache_control_listener.xml

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
class="FOS\HttpCacheBundle\EventListener\CacheControlListener"
1010
public="true">
1111
<argument>%fos_http_cache.debug_header%</argument>
12+
<argument>%fos_http_cache.ttl_header%</argument>
1213
<tag name="kernel.event_subscriber" />
1314
</service>
1415
<service id="FOS\HttpCacheBundle\EventListener\CacheControlListener" alias="fos_http_cache.event_listener.cache_control" public="true"/>

Diff for: ‎tests/Resources/Fixtures/config/etag_true.php

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
],
2222
],
2323
],
24+
'ttl_header' => 'X-Reverse-Proxy-TTL',
2425
],
2526
]
2627
);

Diff for: ‎tests/Resources/Fixtures/config/etag_true.xml

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
<headers etag="true">
1010
</headers>
1111
</rule>
12+
<ttl-header>X-Reverse-Proxy-TTL</ttl-header>
1213
</cache-control>
1314
</config>
1415

Diff for: ‎tests/Resources/Fixtures/config/etag_true.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ fos_http_cache:
55
match:
66
path: null
77
headers:
8-
etag: true
8+
etag: true
9+
ttl_header: X-Reverse-Proxy-TTL

Diff for: ‎tests/Resources/Fixtures/config/etag_weak.php

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
],
2222
],
2323
],
24+
'ttl_header' => 'X-Reverse-Proxy-TTL',
2425
],
2526
]
2627
);

Diff for: ‎tests/Resources/Fixtures/config/etag_weak.xml

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
<headers etag="weak">
1010
</headers>
1111
</rule>
12+
<ttl-header>X-Reverse-Proxy-TTL</ttl-header>
1213
</cache-control>
1314
</config>
1415

Diff for: ‎tests/Resources/Fixtures/config/etag_weak.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ fos_http_cache:
55
match:
66
path: null
77
headers:
8-
etag: "weak"
8+
etag: "weak"
9+
ttl_header: X-Reverse-Proxy-TTL

Diff for: ‎tests/Resources/Fixtures/config/full.php

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
],
5252
],
5353
],
54+
'ttl_header' => 'X-Reverse-Proxy-TTL',
5455
],
5556
'proxy_client' => [
5657
'varnish' => [

Diff for: ‎tests/Resources/Fixtures/config/full.xml

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343
<vary>Authorization</vary>
4444
</headers>
4545
</rule>
46+
<ttl-header>X-Reverse-Proxy-TTL</ttl-header>
4647
</cache-control>
4748
<proxy-client>
4849
<varnish tags-header="My-Cache-Tags" header-length="1234">

Diff for: ‎tests/Resources/Fixtures/config/full.yml

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ fos_http_cache:
4343
vary:
4444
- Cookie
4545
- Authorization
46+
ttl_header: X-Reverse-Proxy-TTL
4647
proxy_client:
4748
varnish:
4849
tags_header: My-Cache-Tags

Diff for: ‎tests/Resources/Fixtures/config/split.php

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
$container->loadFromExtension('fos_http_cache', [
1313
'cache_control' => [
14+
'ttl_header' => 'X-My-Header',
1415
'rules' => [
1516
[
1617
'match' => [

Diff for: ‎tests/Resources/Fixtures/config/split.xml

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
<config xmlns="http://example.org/schema/dic/fos_http_cache">
55
<cache-control>
6+
<ttl-header>X-My-Header</ttl-header>
67
<rule>
78
<match>
89
<methods>GET,POST</methods>

Diff for: ‎tests/Resources/Fixtures/config/split.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
fos_http_cache:
22

33
cache_control:
4+
ttl_header: X-My-Header
45
rules:
56
-
67
match:

Diff for: ‎tests/Unit/DependencyInjection/ConfigurationTest.php

+4
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ public function testSupportsAllConfigFormats(): void
9696
],
9797
],
9898
],
99+
'ttl_header' => 'X-Reverse-Proxy-TTL',
99100
],
100101
'proxy_client' => [
101102
'varnish' => [
@@ -474,6 +475,7 @@ public function testSplitOptions(): void
474475
{
475476
$expectedConfiguration = $this->getEmptyConfig();
476477
$expectedConfiguration['cache_control'] = [
478+
'ttl_header' => 'X-My-Header',
477479
'rules' => [
478480
[
479481
'match' => [
@@ -637,6 +639,7 @@ public function testWeakETags(): void
637639
],
638640
],
639641
],
642+
'ttl_header' => 'X-Reverse-Proxy-TTL',
640643
'defaults' => [
641644
'overwrite' => false,
642645
],
@@ -679,6 +682,7 @@ public function testStrongETags(): void
679682
],
680683
],
681684
],
685+
'ttl_header' => 'X-Reverse-Proxy-TTL',
682686
'defaults' => [
683687
'overwrite' => false,
684688
],

Diff for: ‎tests/Unit/EventListener/CacheControlListenerTest.php

+17-2
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,21 @@ public function testReverseProxyTtl(): void
334334
$this->assertEquals(600, $newHeaders['x-reverse-proxy-ttl'][0]);
335335
}
336336

337+
public function testReverseProxyTtlHeader(): void
338+
{
339+
$event = $this->buildEvent();
340+
$headers = [
341+
'reverse_proxy_ttl' => 700,
342+
];
343+
$listener = $this->getCacheControl($headers, 'X-My-Header');
344+
345+
$listener->onKernelResponse($event);
346+
$newHeaders = $event->getResponse()->headers->all();
347+
348+
$this->assertTrue(isset($newHeaders['x-my-header']), implode(',', array_keys($newHeaders)));
349+
$this->assertEquals(700, $newHeaders['x-my-header'][0]);
350+
}
351+
337352
public function testDebugHeader(): void
338353
{
339354
$listener = new CacheControlListener('X-Cache-Debug');
@@ -426,9 +441,9 @@ protected function buildEvent(string $method = 'GET'): ResponseEvent
426441
*
427442
* @param array $headers The headers to return from the matcher
428443
*/
429-
protected function getCacheControl(array $headers): CacheControlListener|MockObject
444+
protected function getCacheControl(array $headers, string $ttlHeader = 'X-Reverse-Proxy-TTL'): CacheControlListener|MockObject
430445
{
431-
$listener = new CacheControlListener();
446+
$listener = new CacheControlListener(false, $ttlHeader);
432447

433448
$matcher = \Mockery::mock(RuleMatcherInterface::class)
434449
->shouldReceive(['matches' => true])

0 commit comments

Comments
 (0)