IBX-11553: Made response taggers more verbose instead of silently failing

Author: konradoboza

phpstan-baseline.neon

@@ -1152,6 +1152,12 @@ parameters:
 			count: 1
 			path: src/lib/ResponseTagger/Value/ContentInfoTagger.php
 
+		-
+			message: '#^Variable \$logger on left side of \?\? always exists and is not nullable\.$#'
+			identifier: nullCoalesce.variable
+			count: 1
+			path: src/lib/ResponseTagger/Value/ContentInfoTagger.php
+
 		-
 			message: '#^Method Ibexa\\HttpCache\\ResponseTagger\\Value\\LocationTagger\:\:tag\(\) has no return type specified\.$#'
 			identifier: missingType.return

src/bundle/Resources/config/view_cache.yml

@@ -83,12 +83,16 @@ services:
     Ibexa\HttpCache\ResponseTagger\Value\ContentInfoTagger:
         class: Ibexa\HttpCache\ResponseTagger\Value\ContentInfoTagger
         parent: ibexa.http_cache.view_cache.response_tagger.abstract_value
+        arguments:
+            $debug: '%kernel.debug%'
         tags:
             - {name: ibexa.cache.http.response.tagger}
 
     Ibexa\HttpCache\ResponseTagger\Value\LocationTagger:
         class: Ibexa\HttpCache\ResponseTagger\Value\LocationTagger
         parent: ibexa.http_cache.view_cache.response_tagger.abstract_value
+        arguments:
+            $debug: '%kernel.debug%'
         tags:
             - {name: ibexa.cache.http.response.tagger}
 

src/lib/ResponseTagger/Value/ContentInfoTagger.php

@@ -4,27 +4,57 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 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 Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use RuntimeException;
 
 class ContentInfoTagger extends AbstractValueTagger
 {
+    public function __construct(
+        FosResponseTagger $responseTagger,
+        private LoggerInterface $logger = new NullLogger(),
+        private readonly bool $debug = false
+    ) {
+        parent::__construct($responseTagger);
+
+        $this->logger = $logger ?? new NullLogger();
+    }
+
     public function tag($value)
     {
         if (!$value instanceof ContentInfo) {
+            $message = sprintf(
+                '%s expects value of type %s, got %s.',
+                self::class,
+                ContentInfo::class,
+                get_debug_type($value),
+            );
+
+            if ($this->debug) {
+                throw new RuntimeException($message);
+            }
+
+            $this->logger->warning($message);
+
             return $this;
         }
 
         $this->responseTagger->addTags([
-            ContentTagInterface::CONTENT_PREFIX . $value->id,
+            ContentTagInterface::CONTENT_PREFIX . $value->getId(),
             ContentTagInterface::CONTENT_TYPE_PREFIX . $value->contentTypeId,
         ]);
 
         if ($value->mainLocationId) {
-            $this->responseTagger->addTags([ContentTagInterface::LOCATION_PREFIX . $value->mainLocationId]);
+            $this->responseTagger->addTags([
+                ContentTagInterface::LOCATION_PREFIX . $value->getMainLocationId(),
+            ]);
         }
     }
 }

src/lib/ResponseTagger/Value/LocationTagger.php

@@ -4,31 +4,57 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 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 Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use RuntimeException;
 
 class LocationTagger extends AbstractValueTagger
 {
+    public function __construct(
+        FosResponseTagger $responseTagger,
+        private LoggerInterface $logger = new NullLogger(),
+        private readonly bool $debug = false
+    ) {
+        parent::__construct($responseTagger);
+    }
+
     public function tag($value)
     {
         if (!$value instanceof Location) {
+            $message = sprintf(
+                '%s expects value of type %s, got %s.',
+                self::class,
+                Location::class,
+                get_debug_type($value),
+            );
+
+            if ($this->debug) {
+                throw new RuntimeException($message);
+            }
+
+            $this->logger->warning($message);
+
             return $this;
         }
 
-        if ($value->id !== $value->contentInfo->mainLocationId) {
-            $this->responseTagger->addTags([ContentTagInterface::LOCATION_PREFIX . $value->id]);
+        if ($value->id !== $value->getContentInfo()->getMainLocationId()) {
+            $this->responseTagger->addTags([ContentTagInterface::LOCATION_PREFIX . $value->getId()]);
         }
 
         $this->responseTagger->addTags([ContentTagInterface::PARENT_LOCATION_PREFIX . $value->parentLocationId]);
         $this->responseTagger->addTags(
             array_map(
-                static function (string $pathItem): string {
+                static function ($pathItem): string {
                     return ContentTagInterface::PATH_PREFIX . $pathItem;
                 },
-                $value->path
+                $value->getPath()
             )
         );
     }