IBX-11826: Cleaned up http-cache ResponseTagger deprecations

composer.json

@@ -20,6 +20,7 @@
         "ibexa/rest": "~6.0.x-dev",
         "php-http/curl-client": "^2.1",
         "psr/http-client": "^1.0",
+        "psr/log": "^3.0",
         "symfony/config": "^7.4",
         "symfony/dependency-injection": "^7.4",
         "symfony/event-dispatcher": "^7.4",

phpstan-baseline.neon

@@ -6,30 +6,6 @@ parameters:
 			count: 1
 			path: spec/EventSubscriber/HiddenLocationExceptionSubscriberSpec.php
 
-		-
-			message: '#^Call to an undefined method Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\ContentInfo\:\:willReturn\(\)\.$#'
-			identifier: method.notFound
-			count: 1
-			path: spec/EventSubscriber/HiddenLocationExceptionSubscriberSpec.php
-
-		-
-			message: '#^Call to an undefined method Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\:\:shouldHaveBeenCalled\(\)\.$#'
-			identifier: method.notFound
-			count: 1
-			path: spec/EventSubscriber/HiddenLocationExceptionSubscriberSpec.php
-
-		-
-			message: '#^Call to an undefined method Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Location\:\:willReturn\(\)\.$#'
-			identifier: method.notFound
-			count: 1
-			path: spec/EventSubscriber/HiddenLocationExceptionSubscriberSpec.php
-
-		-
-			message: '#^Call to an undefined method Ibexa\\Core\\MVC\\Exception\\HiddenLocationException\:\:getWrappedObject\(\)\.$#'
-			identifier: method.notFound
-			count: 1
-			path: spec/EventSubscriber/HiddenLocationExceptionSubscriberSpec.php
-
 		-
 			message: '#^Call to an undefined method Symfony\\Component\\HttpFoundation\\Request\:\:getWrappedObject\(\)\.$#'
 			identifier: method.notFound

spec/EventSubscriber/HiddenLocationExceptionSubscriberSpec.php

@@ -7,71 +7,89 @@
 
 namespace spec\Ibexa\HttpCache\EventSubscriber;
 
-use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo;
-use Ibexa\Contracts\Core\Repository\Values\Content\Location;
+use FOS\HttpCache\ResponseTagger as FosResponseTagger;
 use Ibexa\Core\MVC\Exception\HiddenLocationException;
+use Ibexa\Core\Repository\Values\Content\Location;
+use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo;
 use Ibexa\HttpCache\ResponseTagger\Value\ContentInfoTagger;
 use Ibexa\HttpCache\ResponseTagger\Value\LocationTagger;
+use PhpSpec\Exception\Example\FailureException;
 use PhpSpec\ObjectBehavior;
-use Prophecy\Argument;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
 class HiddenLocationExceptionSubscriberSpec extends ObjectBehavior
 {
-    public function let(
-        LocationTagger $locationTagger,
-        ContentInfoTagger $contentInfoTagger
-    ): void {
-        $this->beConstructedWith($locationTagger, $contentInfoTagger);
-    }
-
     public function it_tags_on_hidden_location_exception(
         HttpKernelInterface $kernel,
-        Request $request,
-        LocationTagger $locationTagger,
-        ContentInfoTagger $contentInfoTagger,
-        Location $location,
-        ContentInfo $contentInfo,
-        HiddenLocationException $exception
+        Request $request
     ): void {
-        $exception->getLocation()->willReturn($location);
-        $location->getContentInfo()->willReturn($contentInfo);
-        $locationTagger->tag($location)->willReturn($locationTagger);
-        $contentInfoTagger->tag($contentInfo)->willReturn($contentInfoTagger);
+        $locationResponseTagger = new FosResponseTagger();
+        $contentInfoResponseTagger = new FosResponseTagger();
+        $this->beConstructedWith(
+            new LocationTagger($locationResponseTagger),
+            new ContentInfoTagger($contentInfoResponseTagger)
+        );
+
+        $contentInfo = new ContentInfo([
+            'id' => 321,
+            'contentTypeId' => 987,
+            'mainLocationId' => null,
+        ]);
+        $location = new Location([
+            'id' => 123,
+            'parentLocationId' => 2,
+            'pathString' => '/1/2/123/',
+            'contentInfo' => $contentInfo,
+        ]);
+        $exception = new HiddenLocationException($location);
 
         $event = new ExceptionEvent(
             $kernel->getWrappedObject(),
             $request->getWrappedObject(),
             HttpKernelInterface::MAIN_REQUEST,
-            $exception->getWrappedObject()
+            $exception
         );
 
         $this->tagHiddenLocationExceptionResponse($event);
 
-        $exception->getLocation()->shouldHaveBeenCalled();
-        $locationTagger->tag(Argument::type(Location::class))->shouldHaveBeenCalled();
-        $contentInfoTagger->tag(Argument::type(ContentInfo::class))->shouldHaveBeenCalled();
+        if (!$locationResponseTagger->hasTags()) {
+            throw new FailureException('LocationTagger did not add any tags.');
+        }
+
+        if (!$contentInfoResponseTagger->hasTags()) {
+            throw new FailureException('ContentInfoTagger did not add any tags.');
+        }
     }
 
     public function it_does_not_tag_on_other_exceptions(
         HttpKernelInterface $kernel,
         Request $request,
-        LocationTagger $locationTagger,
-        ContentInfoTagger $contentInfoTagger,
         \Exception $exception
     ): void {
+        $locationResponseTagger = new FosResponseTagger();
+        $contentInfoResponseTagger = new FosResponseTagger();
+        $this->beConstructedWith(
+            new LocationTagger($locationResponseTagger),
+            new ContentInfoTagger($contentInfoResponseTagger)
+        );
+
         $event = new ExceptionEvent(
             $kernel->getWrappedObject(),
             $request->getWrappedObject(),
             HttpKernelInterface::MAIN_REQUEST,
             $exception->getWrappedObject()
         );
 
-        $locationTagger->tag(Argument::type(Location::class))->shouldNotBeCalled();
-        $contentInfoTagger->tag(Argument::type(ContentInfo::class))->shouldNotBeCalled();
-
         $this->tagHiddenLocationExceptionResponse($event);
+
+        if ($locationResponseTagger->hasTags()) {
+            throw new FailureException('LocationTagger should not add tags for unrelated exceptions.');
+        }
+
+        if ($contentInfoResponseTagger->hasTags()) {
+            throw new FailureException('ContentInfoTagger should not add tags for unrelated exceptions.');
+        }
     }
 }

src/bundle/Resources/config/view_cache.yml

@@ -58,6 +58,8 @@ services:
         # Taggers are added by a compiler pass
         arguments:
             - []
+            - '@logger'
+            - '%kernel.debug%'
 
     # Alias for ResponseTagger interface => DispatcherTagger
     Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger: '@Ibexa\HttpCache\ResponseTagger\Delegator\DispatcherTagger'

src/contracts/ResponseTagger/ResponseTagger.php

@@ -13,6 +13,8 @@
  */
 interface ResponseTagger
 {
+    public function supports(mixed $value): bool;
+
     /**
      * Extracts tags from a value.
      *

src/lib/ResponseTagger/Delegator/ContentValueViewTagger.php

@@ -11,9 +11,8 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Content;
 use Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger;
 use Ibexa\Core\MVC\Symfony\View\ContentValueView;
-use Ibexa\HttpCache\ResponseTagger\Value\AbstractValueTagger;
 
-class ContentValueViewTagger extends AbstractValueTagger
+final readonly class ContentValueViewTagger implements ResponseTagger
 {
     public function __construct(private readonly ResponseTagger $contentInfoTagger)
     {

src/lib/ResponseTagger/Delegator/DispatcherTagger.php

@@ -8,6 +8,8 @@
 namespace Ibexa\HttpCache\ResponseTagger\Delegator;
 
 use Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 
 /**
  * Dispatches a value to all registered ResponseTaggers.
@@ -17,27 +19,31 @@
     /**
      * @param iterable<\Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger> $taggers
      */
-    public function __construct(private iterable $taggers = [])
+    public function __construct(
+        private iterable $taggers = [],
+        private LoggerInterface $logger = new NullLogger(),
+        private bool $debug = false,
+    ) {
+    }
+
+    public function supports(mixed $value): bool
     {
+        return true;
     }
 
     public function tag(mixed $value): void
     {
+        $handled = false;
         foreach ($this->taggers as $tagger) {
-            if (method_exists($tagger, 'supports')) {
-                if ($tagger->supports($value)) {
-                    $tagger->tag($value);
-                }
-            } else {
-                trigger_deprecation(
-                    'ibexa/http-cache',
-                    '5.0.7',
-                    '%s does not implement supports(). This will be required in 6.0, supports() will be a part of ResponseTagger interface',
-                    get_debug_type($tagger),
-                );
+            if ($tagger->supports($value)) {
                 $tagger->tag($value);
+                $handled = true;
             }
         }
+
+        if (!$handled) {
+            $this->handleUnsupportedValue($value);
+        }
     }
 
     public function __toString(): string
@@ -52,4 +58,18 @@ public function __toString(): string
 
         return sprintf('Available response taggers are: %s', $taggers);
     }
+
+    private function handleUnsupportedValue(mixed $value): void
+    {
+        $message = sprintf(
+            'No response tagger supports value of type "%s"; no cache tags were added.',
+            get_debug_type($value),
+        );
+
+        if ($this->debug) {
+            throw new \InvalidArgumentException($message);
+        }
+
+        $this->logger->warning($message, ['taggers' => (string)$this]);
+    }
 }

src/lib/ResponseTagger/Delegator/LocationValueViewTagger.php

@@ -11,9 +11,8 @@
 use Ibexa\Contracts\Core\Repository\Values\Content\Location;
 use Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger;
 use Ibexa\Core\MVC\Symfony\View\LocationValueView;
-use Ibexa\HttpCache\ResponseTagger\Value\AbstractValueTagger;
 
-class LocationValueViewTagger extends AbstractValueTagger
+final readonly class LocationValueViewTagger implements ResponseTagger
 {
     public function __construct(private readonly ResponseTagger $locationTagger)
     {

src/lib/ResponseTagger/Value/ContentInfoTagger.php

@@ -8,14 +8,17 @@
 
 namespace Ibexa\HttpCache\ResponseTagger\Value;
 
+use FOS\HttpCache\ResponseTagger as FosResponseTagger;
 use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo;
 use Ibexa\Contracts\HttpCache\Handler\ContentTagInterface;
+use Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger;
 
-/**
- * @final
- */
-class ContentInfoTagger extends AbstractValueTagger
+final readonly class ContentInfoTagger implements ResponseTagger
 {
+    public function __construct(private readonly FosResponseTagger $responseTagger)
+    {
+    }
+
     public function supports(mixed $value): bool
     {
         return $value instanceof ContentInfo;

src/lib/ResponseTagger/Value/LocationTagger.php

@@ -8,14 +8,17 @@
 
 namespace Ibexa\HttpCache\ResponseTagger\Value;
 
+use FOS\HttpCache\ResponseTagger as FosResponseTagger;
 use Ibexa\Contracts\Core\Repository\Values\Content\Location;
 use Ibexa\Contracts\HttpCache\Handler\ContentTagInterface;
+use Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger;
 
-/**
- * @final
- */
-class LocationTagger extends AbstractValueTagger
+final readonly class LocationTagger implements ResponseTagger
 {
+    public function __construct(private readonly FosResponseTagger $responseTagger)
+    {
+    }
+
     public function supports(mixed $value): bool
     {
         return $value instanceof Location;