Add support for single action controllers, with __invoke method

Author: pawel-kowalczyk-alpy

src/EventListener/AttributesListener.php

@@ -27,12 +27,23 @@ public function onKernelRequest(RequestEvent $event): void
         $request = $event->getRequest();
         $controller = $this->controllerResolver->getController($request);
 
-        if (!is_array($controller) || 2 !== count($controller)) {
+        if (false === $controller) {
             return;
         }
 
-        $class = new \ReflectionClass($controller[0]);
-        $method = $class->getMethod($controller[1]);
+        $class = null;
+        $method = null;
+
+        if (true === \is_object($controller)) {
+            $class = new \ReflectionClass($controller);
+            $method = $class->getMethod('__invoke');
+        }
+
+        if (true === \is_array($controller)) {
+            $class = new \ReflectionClass($controller[0]);
+            $method = $class->getMethod($controller[1]);
+        }
+
         $attributes = [];
         $addAttributes = static function ($instance) use (&$attributes) {
             if ($key = match (get_class($instance)) {
@@ -45,10 +56,10 @@ public function onKernelRequest(RequestEvent $event): void
             }
         };
 
-        foreach ($class->getAttributes() as $classAttribute) {
+        foreach ($class?->getAttributes() as $classAttribute) {
             $addAttributes($classAttribute->newInstance());
         }
-        foreach ($method->getAttributes() as $methodAttribute) {
+        foreach ($method?->getAttributes() as $methodAttribute) {
             $addAttributes($methodAttribute->newInstance());
         }
 

tests/Resources/Fixtures/InvokableController.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FOS\HttpCacheBundle\Tests\Resources\Fixtures;
+
+use FOS\HttpCacheBundle\Configuration\Tag;
+
+final class InvokableController
+{
+    #[Tag('invoke-tag')]
+    public function __invoke(): void
+    {
+    }
+}

tests/Resources/Fixtures/MethodController.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FOS\HttpCacheBundle\Tests\Resources\Fixtures;
+
+use FOS\HttpCacheBundle\Configuration\Tag;
+
+final class MethodController
+{
+    #[Tag('method-tag')]
+    public function showAction(): void
+    {
+    }
+}

tests/Resources/TestCase/StubControllerResolver.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FOS\HttpCacheBundle\Tests\Resources\TestCase;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
+
+final class StubControllerResolver implements ControllerResolverInterface
+{
+    /** @param callable|false $controller */
+    public function __construct(private readonly object|array|false $controller)
+    {
+    }
+
+    public function getController(Request $request): callable|false
+    {
+        return $this->controller;
+    }
+}

tests/Unit/EventListener/AttributesListenerTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FOS\HttpCacheBundle\Tests\Unit\EventListener;
+
+use FOS\HttpCacheBundle\Configuration\Tag;
+use FOS\HttpCacheBundle\EventListener\AttributesListener;
+use FOS\HttpCacheBundle\Tests\Resources\Fixtures\InvokableController;
+use FOS\HttpCacheBundle\Tests\Resources\Fixtures\MethodController;
+use FOS\HttpCacheBundle\Tests\Resources\TestCase\StubControllerResolver;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+
+final class AttributesListenerTest extends TestCase
+{
+    /** @param string[] $expectedTags */
+    #[DataProvider('supportedControllersProvider')]
+    public function testSupportedControllers(callable|false $controller, array $expectedTags): void
+    {
+        $controllerResolver = new StubControllerResolver($controller);
+        $listener = new AttributesListener($controllerResolver);
+        $request = Request::create('/');
+        $requestEvent = new RequestEvent(
+            $this->createStub(HttpKernelInterface::class),
+            $request,
+            HttpKernelInterface::MAIN_REQUEST,
+        );
+
+        $listener->onKernelRequest($requestEvent);
+
+        $this->assertRequestTags($request, $expectedTags);
+    }
+
+    /** @return iterable<string, array{callable|false, string[]}> */
+    public static function supportedControllersProvider(): iterable
+    {
+        yield 'false' => [
+            false,
+            [],
+        ];
+
+        yield 'invoke' => [
+            new InvokableController(),
+            ['invoke-tag'],
+        ];
+
+        yield 'methode' => [
+            [new MethodController(), 'showAction'],
+            ['method-tag'],
+        ];
+    }
+
+    /** @param string[] $expectedTags */
+    private function assertRequestTags(Request $request, array $expectedTags): void
+    {
+        $this->assertSame(
+            $expectedTags,
+            \array_map(
+                static fn (Tag $tag): string => \implode($tag->getTags()),
+                $request->attributes->get('_tag', []),
+            ),
+        );
+    }
+}