Enable cache only on prod by default

src/DependencyInjection/Configuration.php

@@ -98,6 +98,15 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
+                ->arrayNode('metadata')
+                    ->addDefaultsIfNotSet()
+                    ->children()
+                        ->booleanNode('cache')
+                            ->info('Whether or not to cache the metadata')
+                            ->defaultValue(!'%kernel.debug%')
+                        ->end()
+                    ->end()
+                ->end()
                 ->arrayNode('search')
                     ->canBeEnabled()
                     ->info('Configures your site search (and autocomplete) experience')

src/DependencyInjection/SetonoSyliusMeilisearchExtension.php

@@ -9,6 +9,9 @@
 use Setono\SyliusMeilisearchPlugin\DataMapper\DataMapperInterface;
 use Setono\SyliusMeilisearchPlugin\DataProvider\IndexableDataProviderInterface;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\CachedMetadataFactory;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactory;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
 use Setono\SyliusMeilisearchPlugin\EventSubscriber\IndexableDataFilter\ChannelsAwareFilter;
 use Setono\SyliusMeilisearchPlugin\EventSubscriber\IndexableDataFilter\EnabledFilter;
 use Setono\SyliusMeilisearchPlugin\EventSubscriber\IndexableDataFilter\StockAvailableFilter;
@@ -44,6 +47,7 @@ public function load(array $configs, ContainerBuilder $container): void
          * @var array{
          *      indexes: array<string, array{document: class-string<Document>, entities: list<class-string>, data_provider: class-string, indexer: class-string|null, prefix: string|null, default_filters: array<string, bool>}>,
          *      server: array{ host: string, master_key: string, search_key: string },
+         *      metadata: array{ cache: bool },
          *      search: array{ enabled: bool, path: string, index: string, hits_per_page: int },
          *      autocomplete: array{ enabled: bool, indexes: list<string>, container: string, placeholder: string },
          *      resources: array,
@@ -59,6 +63,13 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('setono_sylius_meilisearch.server.master_key', $config['server']['master_key']);
         $container->setParameter('setono_sylius_meilisearch.server.search_key', $config['server']['search_key']);
 
+        // cache
+        $metadataCacheEnabled = $config['metadata']['cache'];
+        $container->setParameter('setono_sylius_meilisearch.cache', $metadataCacheEnabled);
+        if ($metadataCacheEnabled) {
+            $this->registerCachedMetadataFactory($container);
+        }
+
         $loader->load('services.xml');
 
         // auto configuration
@@ -450,4 +461,18 @@ private static function registerStockAvailableFilter(ContainerBuilder $container
             ->addTag('kernel.event_subscriber')
         ;
     }
+
+    private function registerCachedMetadataFactory(ContainerBuilder $container): void
+    {
+        $container
+            ->register(CachedMetadataFactory::class)
+            ->setDecoratedService(MetadataFactory::class)
+            ->setArguments([
+                new Reference(CachedMetadataFactory::class . '.inner'),
+                new Reference('setono_sylius_meilisearch.cache.metadata'),
+            ])
+        ;
+
+        $container->setAlias(MetadataFactoryInterface::class, CachedMetadataFactory::class);
+    }
 }

src/Document/Metadata/CachedMetadataFactory.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Document\Metadata;
+
+use Psr\Cache\CacheItemPoolInterface;
+use Setono\SyliusMeilisearchPlugin\Document\Document;
+use Webmozart\Assert\Assert;
+
+final class CachedMetadataFactory implements MetadataFactoryInterface
+{
+    /**
+     * The loaded metadata, indexed by class name
+     *
+     * @var array<class-string<Document>, MetadataInterface>
+     */
+    private array $loadedClasses = [];
+
+    public function __construct(
+        private readonly MetadataFactoryInterface $baseMetadataFactory,
+        private readonly CacheItemPoolInterface $cache,
+    ) {
+    }
+
+    public function getMetadataFor(string|Document $document): MetadataInterface
+    {
+        if ($document instanceof Document) {
+            $document = $document::class;
+        }
+
+        if (isset($this->loadedClasses[$document])) {
+            return $this->loadedClasses[$document];
+        }
+
+        $cacheItem = $this->cache->getItem($this->escapeClassName($document));
+        if ($cacheItem->isHit()) {
+            $metadata = $cacheItem->get();
+            Assert::isInstanceOf($metadata, MetadataInterface::class);
+
+            $this->loadedClasses[$document] = $metadata;
+
+            return $this->loadedClasses[$document];
+        }
+
+        $metadata = $this->baseMetadataFactory->getMetadataFor($document);
+
+        $this->cache->save($cacheItem->set($metadata));
+
+        return $this->loadedClasses[$document] = $metadata;
+    }
+
+    private function escapeClassName(string $class): string
+    {
+        if (str_contains($class, '@')) {
+            // anonymous class: replace all PSR6-reserved characters
+            return str_replace(["\0", '\\', '/', '@', ':', '{', '}', '(', ')'], '.', $class);
+        }
+
+        return str_replace('\\', '.', $class);
+    }
+}

src/Document/Metadata/MetadataFactory.php

@@ -4,57 +4,12 @@
 
 namespace Setono\SyliusMeilisearchPlugin\Document\Metadata;
 
-use Psr\Cache\CacheItemPoolInterface;
 use Setono\SyliusMeilisearchPlugin\Document\Document;
-use Webmozart\Assert\Assert;
 
 final class MetadataFactory implements MetadataFactoryInterface
 {
-    /**
-     * The loaded metadata, indexed by class name
-     *
-     * @var array<class-string<Document>, MetadataInterface>
-     */
-    private array $loadedClasses = [];
-
-    public function __construct(private readonly CacheItemPoolInterface $cache)
-    {
-    }
-
     public function getMetadataFor(string|Document $document): MetadataInterface
     {
-        if ($document instanceof Document) {
-            $document = $document::class;
-        }
-
-        if (isset($this->loadedClasses[$document])) {
-            return $this->loadedClasses[$document];
-        }
-
-        $cacheItem = $this->cache->getItem($this->escapeClassName($document));
-        if ($cacheItem->isHit()) {
-            $metadata = $cacheItem->get();
-            Assert::isInstanceOf($metadata, MetadataInterface::class);
-
-            $this->loadedClasses[$document] = $metadata;
-
-            return $this->loadedClasses[$document];
-        }
-
-        $metadata = new Metadata($document);
-
-        $this->cache->save($cacheItem->set($metadata));
-
-        return $this->loadedClasses[$document] = $metadata;
-    }
-
-    private function escapeClassName(string $class): string
-    {
-        if (str_contains($class, '@')) {
-            // anonymous class: replace all PSR6-reserved characters
-            return str_replace(["\0", '\\', '/', '@', ':', '{', '}', '(', ')'], '.', $class);
-        }
-
-        return str_replace('\\', '.', $class);
+        return new Metadata($document);
     }
 }

src/Resources/config/services/document.xml

@@ -2,11 +2,11 @@
 <container xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://symfony.com/schema/dic/services"
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
     <services>
-        <service id="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface"
-                 alias="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactory"/>
+        <service
+            id="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface"
+            alias="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactory"
+        />
 
-        <service id="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactory">
-            <argument type="service" id="setono_sylius_meilisearch.cache.metadata"/>
-        </service>
+        <service id="Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactory" />
     </services>
 </container>

tests/Application/config/packages/setono_sylius_meilisearch.yaml

@@ -16,3 +16,8 @@ setono_sylius_meilisearch:
     autocomplete:
         indexes:
             - products
+
+when@prod:
+    setono_sylius_meilisearch:
+        metadata:
+            cache: true

tests/Unit/Document/Metadata/CachedMetadataFactoryTest.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Document\Metadata;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\CachedMetadataFactory;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Metadata;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactoryInterface;
+
+final class CachedMetadataFactoryTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testItCreatesNewMetadataAndSavesItInCache(): void
+    {
+        $cacheItemPool = $this->prophesize(CacheItemPoolInterface::class);
+        $baseFactory = $this->prophesize(MetadataFactoryInterface::class);
+        $factory = new CachedMetadataFactory($baseFactory->reveal(), $cacheItemPool->reveal());
+
+        $cacheItem = $this->prophesize(CacheItemInterface::class);
+        $cacheItemPool
+            ->getItem('Setono.SyliusMeilisearchPlugin.Tests.Unit.Document.Metadata.Document')
+            ->willReturn($cacheItem)
+        ;
+        $cacheItem->isHit()->willReturn(false);
+        $metadata = new Metadata(Document::class);
+        $baseFactory->getMetadataFor(Document::class)->willReturn($metadata);
+        $cacheItem->set($metadata)->shouldBeCalled()->willReturn($cacheItem);
+        $cacheItemPool->save($cacheItem->reveal())->shouldBeCalled();
+
+        self::assertEquals(
+            new Metadata(Document::class),
+            $factory->getMetadataFor(Document::class),
+        );
+    }
+
+    public function testItFetchesMetadataFromCache(): void
+    {
+        $cacheItemPool = $this->prophesize(CacheItemPoolInterface::class);
+        $baseFactory = $this->prophesize(MetadataFactoryInterface::class);
+        $factory = new CachedMetadataFactory($baseFactory->reveal(), $cacheItemPool->reveal());
+
+        $cacheItem = $this->prophesize(CacheItemInterface::class);
+        $cacheItemPool
+            ->getItem('Setono.SyliusMeilisearchPlugin.Tests.Unit.Document.Metadata.Document')
+            ->willReturn($cacheItem)
+        ;
+        $cacheItem->isHit()->willReturn(true);
+        $metadata = new Metadata(Document::class);
+        $cacheItem->get()->willReturn($metadata);
+
+        self::assertEquals(
+            $metadata,
+            $factory->getMetadataFor(Document::class),
+        );
+    }
+}

tests/Unit/Document/Metadata/Document.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Document\Metadata;
+
+use Setono\SyliusMeilisearchPlugin\Document\Attribute\Facet;
+use Setono\SyliusMeilisearchPlugin\Document\Attribute\Filterable;
+use Setono\SyliusMeilisearchPlugin\Document\Attribute\Searchable;
+use Setono\SyliusMeilisearchPlugin\Document\Attribute\Sortable;
+use Setono\SyliusMeilisearchPlugin\Document\Document as BaseDocument;
+
+final class Document extends BaseDocument
+{
+    #[Searchable]
+    public ?string $name = null;
+
+    #[Facet]
+    public ?string $size = null;
+
+    #[Facet]
+    #[Sortable]
+    public ?int $price = null;
+
+    #[Filterable]
+    public array $taxons = [];
+}

tests/Unit/Document/Metadata/MetadataFactoryTest.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Document\Metadata;
+
+use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\Metadata;
+use Setono\SyliusMeilisearchPlugin\Document\Metadata\MetadataFactory;
+
+final class MetadataFactoryTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testItCreatesMetadataWithDocument(): void
+    {
+        $factory = new MetadataFactory();
+
+        self::assertEquals(new Metadata(Document::class), $factory->getMetadataFor(Document::class));
+    }
+}

tests/Unit/Document/Metadata/MetadataTest.php

@@ -5,19 +5,11 @@
 namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Document\Metadata;
 
 use PHPUnit\Framework\TestCase;
-use Setono\SyliusMeilisearchPlugin\Document\Attribute\Facet;
-use Setono\SyliusMeilisearchPlugin\Document\Attribute\Filterable;
-use Setono\SyliusMeilisearchPlugin\Document\Attribute\Searchable;
-use Setono\SyliusMeilisearchPlugin\Document\Attribute\Sortable;
-use Setono\SyliusMeilisearchPlugin\Document\Document as BaseDocument;
 use Setono\SyliusMeilisearchPlugin\Document\Metadata\Metadata;
 
 final class MetadataTest extends TestCase
 {
-    /**
-     * @test
-     */
-    public function it_resolves_attributes(): void
+    public function testItResolvesAttributes(): void
     {
         $metadata = new Metadata(Document::class);
 
@@ -37,19 +29,3 @@ public function it_resolves_attributes(): void
         self::assertArrayHasKey('price', $metadata->getSortableAttributes());
     }
 }
-
-final class Document extends BaseDocument
-{
-    #[Searchable]
-    public ?string $name = null;
-
-    #[Facet]
-    public ?string $size = null;
-
-    #[Facet]
-    #[Sortable]
-    public ?int $price = null;
-
-    #[Filterable]
-    public array $taxons = [];
-}