Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow a resource Cache-Control HTTP header to be private #3543

Merged
merged 2 commits into from
Jul 10, 2020
Merged

Allow a resource Cache-Control HTTP header to be private #3543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
063cc87
Allow a resoure's cache to be marked private
renaudclosset May 4, 2020
8ce3916
Fixed scenario where an undefined public/private setting would ignore…
renaudclosset May 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/HttpCache/EventListener/AddHeadersListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,15 @@ public function onKernelResponse(ResponseEvent $event): void
$response->setVary(array_diff($this->vary, $response->getVary()), false);
}

if (null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {
$response->setSharedMaxAge($sharedMaxAge);
// if the public-property is defined and not yet set; apply it to the response
$public = ($resourceCacheHeaders['public'] ?? $this->public);
if (null !== $public && !$response->headers->hasCacheControlDirective('public')) {
$public ? $response->setPublic() : $response->setPrivate();
}

if (null !== $this->public && !$response->headers->hasCacheControlDirective('public')) {
$this->public ? $response->setPublic() : $response->setPrivate();
// Cache-Control "s-maxage" is only relevant is resource is not marked as "private"
if ($public !== false && null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {
$response->setSharedMaxAge($sharedMaxAge);
}
}
}
104 changes: 104 additions & 0 deletions tests/HttpCache/EventListener/AddHeadersListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,108 @@ public function testSetHeadersFromResourceMetadata()
$this->assertSame('max-age=123, public, s-maxage=456', $response->headers->get('Cache-Control'));
$this->assertSame(['Vary-1', 'Vary-2'], $response->getVary());
}

public function testSetHeadersFromResourceMetadataMarkedAsPrivate()
{
$request = new Request([], [], ['_api_resource_class' => Dummy::class, '_api_item_operation_name' => 'get']);
$response = new Response('some content', 200);

$event = $this->prophesize(ResponseEvent::class);
$event->getRequest()->willReturn($request)->shouldBeCalled();
$event->getResponse()->willReturn($response)->shouldBeCalled();

$metadata = new ResourceMetadata(null, null, null, null, null, [
'cache_headers' => [
'max_age' => 123,
'public' => false,
'shared_max_age' => 456
]
]);
$factory = $this->prophesize(ResourceMetadataFactoryInterface::class);
$factory->create(Dummy::class)->willReturn($metadata)->shouldBeCalled();

$listener = new AddHeadersListener(true, 100, 200, [], true, $factory->reveal());
$listener->onKernelResponse($event->reveal());

$this->assertSame('max-age=123, private', $response->headers->get('Cache-Control'));

// resource's cache marked as private must not contain s-maxage
$this->assertStringNotContainsString("s-maxage", $response->headers->get('Cache-Control'));
}

public function testSetHeadersFromResourceMetadataMarkedAsPublic()
{
$request = new Request([], [], ['_api_resource_class' => Dummy::class, '_api_item_operation_name' => 'get']);
$response = new Response('some content', 200);

$event = $this->prophesize(ResponseEvent::class);
$event->getRequest()->willReturn($request)->shouldBeCalled();
$event->getResponse()->willReturn($response)->shouldBeCalled();

$metadata = new ResourceMetadata(null, null, null, null, null, [
'cache_headers' => [
'max_age' => 123,
'public' => true,
'shared_max_age' => 456
]
]);
$factory = $this->prophesize(ResourceMetadataFactoryInterface::class);
$factory->create(Dummy::class)->willReturn($metadata)->shouldBeCalled();

$listener = new AddHeadersListener(true, 100, 200, [], true, $factory->reveal());
$listener->onKernelResponse($event->reveal());

$this->assertSame('max-age=123, public, s-maxage=456', $response->headers->get('Cache-Control'));
}

public function testSetHeadersFromResourceMetadataWithNoPrivacy()
{
$request = new Request([], [], ['_api_resource_class' => Dummy::class, '_api_item_operation_name' => 'get']);
$response = new Response('some content', 200);

$event = $this->prophesize(ResponseEvent::class);
$event->getRequest()->willReturn($request)->shouldBeCalled();
$event->getResponse()->willReturn($response)->shouldBeCalled();

$metadata = new ResourceMetadata(null, null, null, null, null, [
'cache_headers' => [
'max_age' => 123,
'shared_max_age' => 456
]
]);
$factory = $this->prophesize(ResourceMetadataFactoryInterface::class);
$factory->create(Dummy::class)->willReturn($metadata)->shouldBeCalled();

$listener = new AddHeadersListener(true, 100, 200, [], true, $factory->reveal());
$listener->onKernelResponse($event->reveal());

$this->assertSame('max-age=123, public, s-maxage=456', $response->headers->get('Cache-Control'));
}

public function testSetHeadersFromResourceMetadataWithNoPrivacyDefaultsPrivate()
{
$request = new Request([], [], ['_api_resource_class' => Dummy::class, '_api_item_operation_name' => 'get']);
$response = new Response('some content', 200);

$event = $this->prophesize(ResponseEvent::class);
$event->getRequest()->willReturn($request)->shouldBeCalled();
$event->getResponse()->willReturn($response)->shouldBeCalled();

$metadata = new ResourceMetadata(null, null, null, null, null, [
'cache_headers' => [
'max_age' => 123,
'shared_max_age' => 456
]
]);
$factory = $this->prophesize(ResourceMetadataFactoryInterface::class);
$factory->create(Dummy::class)->willReturn($metadata)->shouldBeCalled();

$listener = new AddHeadersListener(true, 100, 200, ['Accept', 'Accept-Encoding'], false, $factory->reveal());
$listener->onKernelResponse($event->reveal());

$this->assertSame('max-age=123, private', $response->headers->get('Cache-Control'));

// resource's cache marked as private must not contain s-maxage
$this->assertStringNotContainsString("s-maxage", $response->headers->get('Cache-Control'));
}
}