Reset loggers on workers

l-vo · l-vo · commit 34ad0d85f8db · 2021-04-10T16:55:54.000+02:00
diff --git a/src/Symfony/Bridge/Monolog/CHANGELOG.md b/src/Symfony/Bridge/Monolog/CHANGELOG.md
@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+5.4.0
+-----
+ * Added `ResetLoggersWorkerSubscriber` to reset buffered logs in messenger workers
+
 5.1.0
 -----
  * Added `MailerHandler`
diff --git a/src/Symfony/Bridge/Monolog/Messenger/ResetLoggersWorkerSubscriber.php b/src/Symfony/Bridge/Monolog/Messenger/ResetLoggersWorkerSubscriber.php
@@ -0,0 +1,59 @@
+<?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\Monolog\Messenger;
+
+use Monolog\ResettableInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
+use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
+
+/**
+ * Reset loggers between messages being handled to release buffered handler logs.
+ *
+ * @author Laurent VOULLEMIER <laurent.voullemier@gmail.com>
+ */
+class ResetLoggersWorkerSubscriber implements EventSubscriberInterface
+{
+    private $loggers;
+
+    public function __construct(iterable $loggers)
+    {
+        $this->loggers = $loggers;
+    }
+
+    public function onWorkerMessageHandled(): void
+    {
+        $this->resetLoggers();
+    }
+
+    public function onWorkerMessageFailed(): void
+    {
+        $this->resetLoggers();
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            WorkerMessageHandledEvent::class => 'onWorkerMessageHandled',
+            WorkerMessageFailedEvent::class => 'onWorkerMessageFailed',
+        ];
+    }
+
+    private function resetLoggers(): void
+    {
+        foreach ($this->loggers as $logger) {
+            if ($logger instanceof ResettableInterface) {
+                $logger->reset();
+            }
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/Tests/Messenger/ResetLoggersWorkerTest.php b/src/Symfony/Bridge/Monolog/Tests/Messenger/ResetLoggersWorkerTest.php
@@ -0,0 +1,85 @@
+<?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\Monolog\Tests\Messenger;
+
+use Monolog\Handler\BufferHandler;
+use Monolog\Handler\TestHandler;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Monolog\Logger;
+use Symfony\Bridge\Monolog\Messenger\ResetLoggersWorkerSubscriber;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\WorkerRunningEvent;
+use Symfony\Component\Messenger\Handler\HandlersLocator;
+use Symfony\Component\Messenger\MessageBus;
+use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;
+use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
+use Symfony\Component\Messenger\Worker;
+
+class ResetLoggersWorkerTest extends TestCase
+{
+    public function testLogsAreFlushed()
+    {
+        $loggerTestHandler = new TestHandler();
+        $loggerTestHandler->setSkipReset(true);
+
+        $logger = new Logger('', [new BufferHandler($loggerTestHandler)]);
+
+        $message = new class() {
+        };
+
+        $handler = static function (object $message) use ($logger): void {
+            $logger->info('Message of class {class} is being handled', ['class' => \get_class($message)]);
+        };
+
+        $handlersMiddleware = new HandleMessageMiddleware(new HandlersLocator([
+            \get_class($message) => [$handler],
+        ]));
+
+        $eventDispatcher = new EventDispatcher();
+        $eventDispatcher->addSubscriber(new ResetLoggersWorkerSubscriber([$logger]));
+        $eventDispatcher->addListener(WorkerRunningEvent::class, static function (WorkerRunningEvent $event): void {
+            $event->getWorker()->stop();  // Limit the worker to one loop
+        });
+
+        $bus = new MessageBus([$handlersMiddleware]);
+        $worker = new Worker([$this->createReceiver($message)], $bus, $eventDispatcher);
+        $worker->run();
+
+        $this->assertCount(1, $loggerTestHandler->getRecords());
+    }
+
+    private function createReceiver(object $message): ReceiverInterface
+    {
+        return new class($message) implements ReceiverInterface {
+            private $message;
+
+            public function __construct(object $message)
+            {
+                $this->message = $message;
+            }
+
+            public function get(): iterable
+            {
+                return [new Envelope($this->message)];
+            }
+
+            public function ack(Envelope $envelope): void
+            {
+            }
+
+            public function reject(Envelope $envelope): void
+            {
+            }
+        };
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/composer.json b/src/Symfony/Bridge/Monolog/composer.json
@@ -27,7 +27,8 @@
         "symfony/security-core": "^4.4|^5.0",
         "symfony/var-dumper": "^4.4|^5.0",
         "symfony/mailer": "^4.4|^5.0",
-        "symfony/mime": "^4.4|^5.0"
+        "symfony/mime": "^4.4|^5.0",
+        "symfony/messenger": "^4.4|^5.0"
     },
     "conflict": {
         "symfony/console": "<4.4",
