Make index dispatches failure-safe

Every save of an indexable entity dispatches on the plugin's command bus,
which (with no transport routing) runs synchronously inside the Doctrine
flush. If Meilisearch was slow or down, saving/deleting a product failed.

EntityListener now wraps every dispatch in try/catch and logs the error at
error level (dedicated setono_sylius_meilisearch monolog channel), so a
search-index hiccup — or a transport outage on an async setup — can never
break catalog management.

All plugin command messages already share the CommandInterface marker, so a
single framework.messenger.routing entry can route everything to an async
transport (documented separately in the operational-model docs).

Closes #124

Author: loevgaard

src/EventListener/Doctrine/EntityListener.php

@@ -5,6 +5,8 @@
 namespace Setono\SyliusMeilisearchPlugin\EventListener\Doctrine;
 
 use Doctrine\Persistence\Event\LifecycleEventArgs;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use Setono\SyliusMeilisearchPlugin\Message\Command\IndexEntity;
 use Setono\SyliusMeilisearchPlugin\Message\Command\RemoveEntity;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
@@ -19,6 +21,7 @@ final class EntityListener
 
     public function __construct(
         private readonly MessageBusInterface $commandBus,
+        private readonly LoggerInterface $logger = new NullLogger(),
     ) {
         $this->removeIndexableStorage = new SplObjectStorage();
     }
@@ -73,8 +76,20 @@ private function dispatch(LifecycleEventArgs $eventArgs, callable $message): voi
     {
         $indexable = self::extractIndexableFromEvent($eventArgs);
 
-        if (null !== $indexable) {
+        if (null === $indexable) {
+            return;
+        }
+
+        try {
             $this->commandBus->dispatch($message($indexable));
+        } catch (\Throwable $e) {
+            // A search-index update (or its transport being unavailable) must never break the
+            // entity save it is reacting to. Swallow and log instead.
+            $this->logger->error('Failed to dispatch a Meilisearch indexing command for an entity change: {message}', [
+                'message' => $e->getMessage(),
+                'entity' => $indexable::class,
+                'exception' => $e,
+            ]);
         }
     }
 

src/Resources/config/services/event_listener.xml

@@ -5,11 +5,13 @@
         <!-- Doctrine specific event subscribers -->
         <service id="Setono\SyliusMeilisearchPlugin\EventListener\Doctrine\EntityListener">
             <argument type="service" id="setono_sylius_meilisearch.command_bus"/>
+            <argument type="service" id="logger"/>
 
             <tag name="doctrine.event_listener" event="postPersist"/>
             <tag name="doctrine.event_listener" event="postUpdate"/>
             <tag name="doctrine.event_listener" event="preRemove"/>
             <tag name="doctrine.event_listener" event="postRemove"/>
+            <tag name="monolog.logger" channel="setono_sylius_meilisearch"/>
         </service>
 
         <service id="Setono\SyliusMeilisearchPlugin\EventListener\Doctrine\SynonymListener">

tests/Unit/EventListener/Doctrine/EntityListenerTest.php

@@ -12,6 +12,7 @@
 use Setono\SyliusMeilisearchPlugin\EventListener\Doctrine\EntityListener;
 use Setono\SyliusMeilisearchPlugin\Message\Command\RemoveEntity;
 use Setono\SyliusMeilisearchPlugin\Model\IndexableInterface;
+use Setono\SyliusMeilisearchPlugin\Tests\Unit\Indexer\SpyLogger;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -48,4 +49,27 @@ public function it_dispatches_a_remove_command_and_does_not_leak_storage_entries
         self::assertInstanceOf(\Countable::class, $storage);
         self::assertCount(0, $storage, 'The SplObjectStorage must not retain the entity after postRemove');
     }
+
+    /**
+     * @test
+     */
+    public function it_swallows_and_logs_a_failing_dispatch_so_the_entity_save_still_succeeds(): void
+    {
+        $entity = $this->prophesize(IndexableInterface::class);
+        $entity->getId()->willReturn(7);
+
+        $eventArgs = new LifecycleEventArgs($entity->reveal(), $this->prophesize(ObjectManager::class)->reveal());
+
+        $commandBus = $this->prophesize(MessageBusInterface::class);
+        $commandBus->dispatch(Argument::any())->willThrow(new \RuntimeException('Meilisearch is down'));
+
+        $logger = new SpyLogger();
+        $listener = new EntityListener($commandBus->reveal(), $logger);
+
+        // Must not throw, even though the dispatch fails
+        $listener->postPersist($eventArgs);
+
+        $error = $logger->firstOfLevel('error');
+        self::assertNotNull($error);
+    }
 }