Skip to content

[HttpKernel] Make #[Cache] respect all explicit cache directives set in controller #62488

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

Merged
nicolas-grekas merged 1 commit into from
Dec 5, 2025
+45 −7
Merged

[HttpKernel] Make #[Cache] respect all explicit cache directives set in controller #62488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 21 additions & 7 deletions src/Symfony/Component/HttpKernel/EventListener/CacheAttributeListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\HttpFoundation\HeaderBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\Cache;
Expand Down Expand Up @@ -126,29 +127,40 @@ public function onKernelResponse(ResponseEvent $event)
// Check if the response has a Vary header that should be considered, ignoring cases where
// it's only 'Accept-Language' and the request has the '_vary_by_language' attribute
$hasVary = ['Accept-Language'] === $response->getVary() ? !$request->attributes->get('_vary_by_language') : $response->hasVary();
//Check if cache-control directive was set manually in cacheControl (not auto computed)
$hasCacheControlDirective = new class($response->headers) extends HeaderBag {
public function __construct(private parent $headerBag)
{
}

public function __invoke(string $key): bool
{
return \array_key_exists($key, $this->headerBag->cacheControl);
}
};

foreach (array_reverse($attributes) as $cache) {
if (null !== $cache->smaxage && !$response->headers->hasCacheControlDirective('s-maxage')) {
if (null !== $cache->smaxage && !$hasCacheControlDirective('s-maxage')) {
$response->setSharedMaxAge($this->toSeconds($cache->smaxage));
}

if ($cache->mustRevalidate) {
$response->headers->addCacheControlDirective('must-revalidate');
}

if (null !== $cache->maxage && !$response->headers->hasCacheControlDirective('max-age')) {
if (null !== $cache->maxage && !$hasCacheControlDirective('max-age')) {
$response->setMaxAge($this->toSeconds($cache->maxage));
}

if (null !== $cache->maxStale && !$response->headers->hasCacheControlDirective('max-stale')) {
if (null !== $cache->maxStale && !$hasCacheControlDirective('max-stale')) {
$response->headers->addCacheControlDirective('max-stale', $this->toSeconds($cache->maxStale));
}

if (null !== $cache->staleWhileRevalidate && !$response->headers->hasCacheControlDirective('stale-while-revalidate')) {
if (null !== $cache->staleWhileRevalidate && !$hasCacheControlDirective('stale-while-revalidate')) {
$response->headers->addCacheControlDirective('stale-while-revalidate', $this->toSeconds($cache->staleWhileRevalidate));
}

if (null !== $cache->staleIfError && !$response->headers->hasCacheControlDirective('stale-if-error')) {
if (null !== $cache->staleIfError && !$hasCacheControlDirective('stale-if-error')) {
$response->headers->addCacheControlDirective('stale-if-error', $this->toSeconds($cache->staleIfError));
}

Expand All @@ -161,12 +173,14 @@ public function onKernelResponse(ResponseEvent $event)
}
}

$hasPublicOrPrivateCacheControlDirective = $hasCacheControlDirective('public') || $hasCacheControlDirective('private');

foreach ($attributes as $cache) {
if (true === $cache->public) {
if (true === $cache->public && !$hasPublicOrPrivateCacheControlDirective) {
$response->setPublic();
}

if (false === $cache->public) {
if (false === $cache->public && !$hasPublicOrPrivateCacheControlDirective) {
$response->setPrivate();
}
}
Expand Down
24 changes: 24 additions & 0 deletions src/Symfony/Component/HttpKernel/Tests/EventListener/CacheAttributeListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,30 @@ public function testHasRelevantVaryHeaderBehavior(array $responseVary, array $ca
$this->assertSame($expectedVary, $response->getVary());
}

public function testAttributeRespectsExplicitPrivateFromController()
{
$request = $this->createRequest(new Cache(public: true));
$response = new Response();
$response->setPrivate();

$this->listener->onKernelResponse($this->createEventMock($request, $response));

$this->assertTrue($response->headers->hasCacheControlDirective('private'));
$this->assertFalse($response->headers->hasCacheControlDirective('public'));
}

public function testAttributeRespectsExplicitPublicFromController()
{
$request = $this->createRequest(new Cache(public: false));
$response = new Response();
$response->setPublic();

$this->listener->onKernelResponse($this->createEventMock($request, $response));

$this->assertTrue($response->headers->hasCacheControlDirective('public'));
$this->assertFalse($response->headers->hasCacheControlDirective('private'));
}

public static function provideVaryHeaderScenarios(): \Traversable
{
yield 'no vary headers at all' => [
Expand Down
Loading