Adding DoctrineClearEntityManagerWorkerSubscriber to reset entity manager in worker

weaverryan · weaverryan · commit 9eda8d7f3a1d · 2019-10-28T13:12:53.000-04:00
diff --git a/src/Symfony/Bridge/Doctrine/Messenger/DoctrineClearEntityManagerWorkerSubscriber.php b/src/Symfony/Bridge/Doctrine/Messenger/DoctrineClearEntityManagerWorkerSubscriber.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Messenger;
+
+use Doctrine\Common\Persistence\ManagerRegistry;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
+use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
+
+/**
+ * Clears entity managers between messages being handled to avoid outdated data.
+ *
+ * @author Ryan Weaver <ryan@symfonycasts.com>
+ */
+class DoctrineClearEntityManagerWorkerSubscriber implements EventSubscriberInterface
+{
+    private $managerRegistry;
+
+    public function __construct(ManagerRegistry $managerRegistry)
+    {
+        $this->managerRegistry = $managerRegistry;
+    }
+
+    public function onWorkerMessageHandled()
+    {
+        $this->clearEntityManagers();
+    }
+
+    public function onWorkerMessageFailed()
+    {
+        $this->clearEntityManagers();
+    }
+
+    public static function getSubscribedEvents()
+    {
+        yield WorkerMessageHandledEvent::class => 'onWorkerMessageHandled';
+        yield WorkerMessageFailedEvent::class => 'onWorkerMessageFailed';
+    }
+
+    private function clearEntityManagers()
+    {
+        foreach ($this->managerRegistry->getManagerNames() as $managerName) {
+            $this->managerRegistry->getManager($managerName)->clear();
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Messenger/DoctrineClearEntityManagerWorkerSubscriberTest.php b/src/Symfony/Bridge/Doctrine/Tests/Messenger/DoctrineClearEntityManagerWorkerSubscriberTest.php
@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Tests\Messenger;
+
+use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\ORM\EntityManagerInterface;
+use Symfony\Bridge\Doctrine\Messenger\DoctrineClearEntityManagerWorkerSubscriber;
+use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
+
+class DoctrineClearEntityManagerWorkerSubscriberTest extends MiddlewareTestCase
+{
+    public function testMiddlewareClearEntityManager()
+    {
+        $entityManager1 = $this->createMock(EntityManagerInterface::class);
+        $entityManager1->expects($this->once())
+            ->method('clear');
+
+        $entityManager2 = $this->createMock(EntityManagerInterface::class);
+        $entityManager2->expects($this->once())
+            ->method('clear');
+
+        $managerRegistry = $this->createMock(ManagerRegistry::class);
+        $managerRegistry
+            ->method('getManagerNames')
+            ->with()
+            ->willReturn(['first', 'second']);
+
+        $managerRegistry
+            ->expects($this->exactly(2))
+            ->method('getManager')
+            ->willReturnMap([
+                ['first', $entityManager1],
+                ['second', $entityManager2],
+            ]);
+
+        $subscriber = new DoctrineClearEntityManagerWorkerSubscriber($managerRegistry);
+        $subscriber->onWorkerMessageHandled();
+    }
+}
