Skip to content

Commit

Permalink
Read attributes as provided by the event object, and pass on attribut…
Browse files Browse the repository at this point in the history
…es to other event handlers (#53)

This PR uses the new API introduced in
symfony/symfony#46001 to read controller
attributes through the `ControllerEvent`, and to make them available to
other event handlers when replacing the controller.

This is necessary when using the ´Send304IfNotModified` attribute in
combination with `\Symfony\Component\HttpKernel\Attribute\Cache`.
Without this change,
`\Symfony\Component\HttpKernel\EventListener\CacheAttributeListener`
will not set `Cache` headers accordingly. The result is that you may get
`304 Not Modified` responses on conditional requests with
`If-Modified-Since`, but these are treated as `stale/cache` only in the
HttpCache and have a `Cache-Control: must-revalidate, private` header.
  • Loading branch information
mpdude authored Oct 28, 2024
1 parent 60bfdaf commit fcabc29
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 27 deletions.
1 change: 0 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ jobs:
matrix:
include:
- { php-version: 8.1, symfony-locked-version: none, dependency-version: prefer-lowest }
- { php-version: 8.2, symfony-locked-version: 5.4.*, dependency-version: prefer-stable }
- { php-version: 8.2, symfony-locked-version: 6.4.*, dependency-version: prefer-stable }
- { php-version: 8.3, symfony-locked-version: none, dependency-version: prefer-stable }
name: PHPUnit (PHP ${{matrix.php-version}}, Symfony Version Lock ${{ matrix.symfony-locked-version }}, ${{ matrix.dependency-version }})
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"symfony/filesystem": "^5.4|^6.4|^7.0",
"symfony/finder": "^5.4|^6.4|^7.0",
"symfony/http-foundation": "^5.4|^6.4|^7.0",
"symfony/http-kernel": "^5.4|^6.4|^7.0",
"symfony/http-kernel": "^6.4|^7.0",
"symfony/lock": "^5.4|^6.4|^7.0",
"symfony/twig-bundle": "^5.4|^6.4|^7.0",
"twig/twig": "^2.0|^3.0"
Expand Down
30 changes: 5 additions & 25 deletions src/Caching/EventListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

namespace Webfactory\Bundle\WfdMetaBundle\Caching;

use ReflectionObject;
use SplObjectStorage;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\ControllerEvent;
Expand Down Expand Up @@ -38,21 +37,19 @@ public function __construct(MetaQueryFactory $metaQueryFactory, $debug)

public function onKernelController(ControllerEvent $event)
{
$controller = $event->getController();
$request = $event->getRequest();

$attribute = $this->findAttribute($controller);
$attributes = $event->getAttributes(Send304IfNotModified::class);

if (!$attribute) {
if (!$attributes) {
return;
}

$lastTouched = $attribute->calculateLastModified($this->metaQueryFactory);
$lastTouched = $attributes[0]->calculateLastModified($this->metaQueryFactory);

if (!$lastTouched) {
return;
}

$request = $event->getRequest();
$this->lastTouchedResults[$request] = $lastTouched;

/*
Expand All @@ -73,7 +70,7 @@ public function onKernelController(ControllerEvent $event)
if ($response->isNotModified($request)) {
$event->setController(function () use ($response) {
return $response;
});
}, $event->getAttributes());
}
}

Expand All @@ -86,21 +83,4 @@ public function onKernelResponse(ResponseEvent $event)
$response->setLastModified($this->lastTouchedResults[$request]);
}
}

/**
* @param $callback array A PHP callback (array) pointing to the method to reflect on.
*/
protected function findAttribute($callback): ?Send304IfNotModified
{
if (!\is_array($callback)) {
return null;
}

$object = new ReflectionObject($callback[0]);
$method = $object->getMethod($callback[1]);

$attributes = $method->getAttributes(Send304IfNotModified::class);

return $attributes ? $attributes[0]->newInstance() : null;
}
}

0 comments on commit fcabc29

Please sign in to comment.