Data collection for profiler (#26)

Co-authored-by: Jacob Dreesen <[email protected]>

Author: jan888adams

config/services.php

@@ -12,14 +12,17 @@
 use Neusta\Pimcore\HttpCacheBundle\Cache\CacheTagChecker\ElementCacheTagChecker;
 use Neusta\Pimcore\HttpCacheBundle\Cache\CacheTagChecker\StaticCacheTagChecker;
 use Neusta\Pimcore\HttpCacheBundle\Cache\ResponseTagger;
+use Neusta\Pimcore\HttpCacheBundle\Cache\ResponseTagger\CacheTagCollectionResponseTagger;
 use Neusta\Pimcore\HttpCacheBundle\Cache\ResponseTagger\OnlyWhenActiveResponseTagger;
 use Neusta\Pimcore\HttpCacheBundle\Cache\ResponseTagger\RemoveDisabledTagsResponseTagger;
 use Neusta\Pimcore\HttpCacheBundle\CacheActivator;
+use Neusta\Pimcore\HttpCacheBundle\DataCollector;
 use Neusta\Pimcore\HttpCacheBundle\Element\ElementRepository;
 use Neusta\Pimcore\HttpCacheBundle\Element\InvalidateElementListener;
 use Neusta\Pimcore\HttpCacheBundle\Element\TagElementListener;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\abstract_arg;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
 
 return static function (ContainerConfigurator $configurator) {
@@ -52,6 +55,10 @@
         ->decorate('neusta_pimcore_http_cache.response_tagger', null, -100)
         ->args([service('.inner'), service('neusta_pimcore_http_cache.cache_activator')]);
 
+    $services->set('.neusta_pimcore_http_cache.collect_tags_response_tagger', CacheTagCollectionResponseTagger::class)
+        ->decorate('neusta_pimcore_http_cache.response_tagger', null, 1)
+        ->args([service('.inner')]);
+
     $services->alias(ResponseTagger::class, 'neusta_pimcore_http_cache.response_tagger');
 
     $services->set('neusta_pimcore_http_cache.cache_tag_checker', StaticCacheTagChecker::class)
@@ -85,4 +92,13 @@
     $services->set('neusta_pimcore_http_cache.element.invalidate_listener', InvalidateElementListener::class)
         ->arg('$cacheInvalidator', service('neusta_pimcore_http_cache.cache_invalidator'))
         ->arg('$dispatcher', service('event_dispatcher'));
+
+    $services->set('neusta_pimcore_http_cache.data_collector', DataCollector::class)
+        ->arg('$cacheTagCollector', service('.neusta_pimcore_http_cache.collect_tags_response_tagger'))
+        ->arg('$configuration', param('neusta_pimcore_http_cache.config'))
+        ->tag('data_collector', [
+            'template' => '@NeustaPimcoreHttpCache/profiler.html.twig',
+            'id' => 'pimcore_http_cache',
+            'priority' => 255,
+        ]);
 };

src/Cache/CacheTags.php

@@ -10,7 +10,7 @@
 final class CacheTags implements \IteratorAggregate
 {
     /**
-     * @var list<CacheTag>
+     * @var array<string, CacheTag>
      */
     private readonly array $tags;
 
@@ -19,7 +19,12 @@ final class CacheTags implements \IteratorAggregate
      */
     public function __construct(CacheTag ...$tags)
     {
-        $this->tags = $tags;
+        $indexedTags = [];
+        foreach ($tags as $tag) {
+            $indexedTags[$tag->toString()] = $tag;
+        }
+
+        $this->tags = $indexedTags;
     }
 
     public static function fromString(string $tag, ?CacheType $type = null): self
@@ -53,12 +58,12 @@ public static function fromElements(array $elements): self
      */
     public function getIterator(): \ArrayIterator
     {
-        return new \ArrayIterator($this->tags);
+        return new \ArrayIterator(array_values($this->tags));
     }
 
     public function with(CacheTag|self ...$tags): self
     {
-        $newTags = $this->tags;
+        $newTags = array_values($this->tags);
         foreach ($tags as $tag) {
             if ($tag instanceof self) {
                 $newTags = [...$newTags, ...$tag->tags];
@@ -80,7 +85,10 @@ public function withoutDisabled(CacheTagChecker $checker): self
      */
     public function toArray(): array
     {
-        $tags = array_map(static fn (CacheTag $tag): string => $tag->toString(), $this->tags);
+        $tags = array_map(
+            static fn (CacheTag $tag): string => $tag->toString(), array_values($this->tags),
+        );
+
         natsort($tags);
 
         return $tags;

src/Cache/CacheType.php

@@ -9,4 +9,6 @@ public function applyTo(string $tag): string;
     public function toString(): string;
 
     public function isEmpty(): bool;
+
+    public function identifier(): string;
 }

src/Cache/CacheType/CustomCacheType.php

@@ -29,4 +29,9 @@ public function isEmpty(): bool
     {
         return false;
     }
+
+    public function identifier(): string
+    {
+        return $this->type;
+    }
 }

src/Cache/CacheType/ElementCacheType.php

@@ -37,4 +37,9 @@ public function isEmpty(): bool
     {
         return false;
     }
+
+    public function identifier(): string
+    {
+        return $this->type->value;
+    }
 }

src/Cache/CacheType/EmptyCacheType.php

@@ -20,4 +20,9 @@ public function isEmpty(): bool
     {
         return true;
     }
+
+    public function identifier(): string
+    {
+        return 'empty';
+    }
 }

src/Cache/ResponseTagger/CacheTagCollectionResponseTagger.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\HttpCacheBundle\Cache\ResponseTagger;
+
+use Neusta\Pimcore\HttpCacheBundle\Cache\CacheTags;
+use Neusta\Pimcore\HttpCacheBundle\Cache\ResponseTagger;
+use Symfony\Contracts\Service\ResetInterface;
+
+final class CacheTagCollectionResponseTagger implements ResponseTagger, ResetInterface
+{
+    public CacheTags $collectedTags;
+
+    public function __construct(
+        private readonly ResponseTagger $inner,
+    ) {
+        $this->collectedTags = new CacheTags();
+    }
+
+    public function tag(CacheTags $tags): void
+    {
+        $this->collectedTags = $this->collectedTags->with($tags);
+        $this->inner->tag($tags);
+    }
+
+    public function reset(): void
+    {
+        $this->collectedTags = new CacheTags();
+    }
+}

src/DataCollector.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+
+namespace Neusta\Pimcore\HttpCacheBundle;
+
+use Neusta\Pimcore\HttpCacheBundle\Cache\ResponseTagger\CacheTagCollectionResponseTagger;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\DataCollector\DataCollector as BaseDataCollector;
+use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
+
+final class DataCollector extends BaseDataCollector implements LateDataCollectorInterface
+{
+    /**
+     * @param array<string, mixed> $configuration
+     */
+    public function __construct(
+        private readonly CacheTagCollectionResponseTagger $cacheTagCollector,
+        array $configuration = [],
+    ) {
+        $this->data['configuration'] = $configuration;
+    }
+
+    public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
+    {
+        // no action needed here, as tags are collected in lateCollect
+    }
+
+    public function lateCollect(): void
+    {
+        foreach ($this->cacheTagCollector->collectedTags as $tag) {
+            $this->data['tags'][] = [
+                'tag' => $tag->toString(), 'type' => $tag->type->identifier(),
+            ];
+        }
+    }
+
+    /**
+     * @return array<array{tag: string, type: string}>
+     */
+    public function getTags(): array
+    {
+        return $this->data['tags'] ?? [];
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function getConfiguration(): array
+    {
+        return $this->data['configuration'] ?? [];
+    }
+
+    public function getName(): string
+    {
+        return 'pimcore_http_cache';
+    }
+
+    public function reset(): void
+    {
+        $this->data['tags'] = [];
+    }
+}

src/DependencyInjection/CompilerPass/DisableDataCollectorPass.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace Neusta\Pimcore\HttpCacheBundle\DependencyInjection\CompilerPass;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+final class DisableDataCollectorPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        if (!$container->hasDefinition('profiler')) {
+            $container->removeDefinition('.neusta_pimcore_http_cache.collect_tags_response_tagger');
+            $container->removeDefinition('neusta_pimcore_http_cache.data_collector');
+        }
+    }
+}

src/DependencyInjection/NeustaPimcoreHttpCacheExtension.php

@@ -70,5 +70,7 @@ private function registerElements(ContainerBuilder $container, array $config): v
                 ->addTag('kernel.event_listener', ['event' => DataObjectEvents::POST_UPDATE, 'method' => 'onUpdate'])
                 ->addTag('kernel.event_listener', ['event' => DataObjectEvents::PRE_DELETE, 'method' => 'onDelete']);
         }
+
+        $container->setParameter('neusta_pimcore_http_cache.config', $config);
     }
 }