symfony · Jeroeny · Sep 14, 2022
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -32,6 +32,7 @@ CHANGELOG
  * Add `WrappedExceptionsInterface` interface for exceptions that hold multiple individual exceptions
  * Deprecate `HandlerFailedException::getNestedExceptions()`, `HandlerFailedException::getNestedExceptionsOfClass()`
    and `DelayedMessageHandlingException::getExceptions()` which are replaced by a new `getWrappedExceptions()` method
+ * Separate `WorkerRunningEvent` into `WorkerBusyEvent` and `WorkerIdleEvent`
 
 6.3
 ---

diff --git a/src/Symfony/Component/Messenger/Event/WorkerBusyEvent.php b/src/Symfony/Component/Messenger/Event/WorkerBusyEvent.php
@@ -0,0 +1,27 @@
+<?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\Component\Messenger\Event;
+
+use Symfony\Component\Messenger\Worker;
+
+/**
+ * Dispatched after the worker processed a message.
+ *
+ * @author Jeroen Spee <https://github.com/Jeroeny>
+ */
+final class WorkerBusyEvent extends WorkerRunningEvent
+{
+    public function __construct(Worker $worker)
+    {
+        parent::__construct($worker, false);
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Event/WorkerIdleEvent.php b/src/Symfony/Component/Messenger/Event/WorkerIdleEvent.php
@@ -0,0 +1,27 @@
+<?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\Component\Messenger\Event;
+
+use Symfony\Component\Messenger\Worker;
+
+/**
+ * Dispatched after the worker didn't receive any message from its receivers.
+ *
+ * @author Jeroen Spee <https://github.com/Jeroeny>
+ */
+final class WorkerIdleEvent extends WorkerRunningEvent
+{
+    public function __construct(Worker $worker)
+    {
+        parent::__construct($worker, true);
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Event/WorkerRunningEvent.php b/src/Symfony/Component/Messenger/Event/WorkerRunningEvent.php
@@ -14,11 +14,11 @@
 use Symfony\Component\Messenger\Worker;
 
 /**
- * Dispatched after the worker processed a message or didn't receive a message at all.
+ * Events that are dispatched after the worker processed a message or didn't receive a message at all.
  *
  * @author Tobias Schultze <http://tobion.de>
  */
-final class WorkerRunningEvent
+class WorkerRunningEvent
 {
     private Worker $worker;
     private bool $isWorkerIdle;

diff --git a/src/Symfony/Component/Messenger/EventListener/ResetServicesListener.php b/src/Symfony/Component/Messenger/EventListener/ResetServicesListener.php
@@ -13,7 +13,7 @@
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\DependencyInjection\ServicesResetter;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\Event\WorkerStoppedEvent;
 
 /**
@@ -28,11 +28,9 @@ public function __construct(ServicesResetter $servicesResetter)
         $this->servicesResetter = $servicesResetter;
     }
 
-    public function resetServices(WorkerRunningEvent $event): void
+    public function resetServices(WorkerBusyEvent $event): void
     {
-        if (!$event->isWorkerIdle()) {
-            $this->servicesResetter->reset();
-        }
+        $this->servicesResetter->reset();
     }
 
     public function resetServicesAtStop(WorkerStoppedEvent $event): void
@@ -43,7 +41,7 @@ public function resetServicesAtStop(WorkerStoppedEvent $event): void
     public static function getSubscribedEvents(): array
     {
         return [
-            WorkerRunningEvent::class => ['resetServices', -1024],
+            WorkerBusyEvent::class => ['resetServices', -1024],
             WorkerStoppedEvent::class => ['resetServicesAtStop', -1024],
         ];
     }

diff --git a/src/Symfony/Component/Messenger/EventListener/StopWorkerOnFailureLimitListener.php b/src/Symfony/Component/Messenger/EventListener/StopWorkerOnFailureLimitListener.php
@@ -13,8 +13,8 @@
 
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
 use Symfony\Component\Messenger\Exception\InvalidArgumentException;
 
 /**
@@ -41,9 +41,9 @@ public function onMessageFailed(WorkerMessageFailedEvent $event): void
         ++$this->failedMessages;
     }
 
-    public function onWorkerRunning(WorkerRunningEvent $event): void
+    public function onWorkerBusy(WorkerBusyEvent $event): void
     {
-        if (!$event->isWorkerIdle() && $this->failedMessages >= $this->maximumNumberOfFailures) {
+        if ($this->failedMessages >= $this->maximumNumberOfFailures) {
             $this->failedMessages = 0;
             $event->getWorker()->stop();
 
@@ -55,7 +55,7 @@ public static function getSubscribedEvents(): array
     {
         return [
             WorkerMessageFailedEvent::class => 'onMessageFailed',
-            WorkerRunningEvent::class => 'onWorkerRunning',
+            WorkerBusyEvent::class => 'onWorkerBusy',
         ];
     }
 }
diff --git a/src/Symfony/Component/Messenger/EventListener/StopWorkerOnMessageLimitListener.php b/src/Symfony/Component/Messenger/EventListener/StopWorkerOnMessageLimitListener.php
@@ -13,7 +13,7 @@
 
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\Exception\InvalidArgumentException;
 
 /**
@@ -36,9 +36,9 @@ public function __construct(int $maximumNumberOfMessages, LoggerInterface $logge
         }
     }
 
-    public function onWorkerRunning(WorkerRunningEvent $event): void
+    public function onWorkerBusy(WorkerBusyEvent $event): void
     {
-        if (!$event->isWorkerIdle() && ++$this->receivedMessages >= $this->maximumNumberOfMessages) {
+        if (++$this->receivedMessages >= $this->maximumNumberOfMessages) {
             $this->receivedMessages = 0;
             $event->getWorker()->stop();
 
@@ -49,7 +49,7 @@ public function onWorkerRunning(WorkerRunningEvent $event): void
     public static function getSubscribedEvents(): array
     {
         return [
-            WorkerRunningEvent::class => 'onWorkerRunning',
+            WorkerBusyEvent::class => 'onWorkerBusy',
         ];
     }
 }
diff --git a/...y/Component/Messenger/Tests/EventListener/StopWorkerOnCustomStopExceptionListenerTest.php b/...y/Component/Messenger/Tests/EventListener/StopWorkerOnCustomStopExceptionListenerTest.php
@@ -13,8 +13,8 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
 use Symfony\Component\Messenger\EventListener\StopWorkerOnCustomStopExceptionListener;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Exception\StopWorkerException;
@@ -50,7 +50,7 @@ public function test(\Throwable $throwable, bool $shouldStop)
 
         $worker = $this->createMock(Worker::class);
         $worker->expects($shouldStop ? $this->once() : $this->never())->method('stop');
-        $runningEvent = new WorkerRunningEvent($worker, false);
+        $runningEvent = new WorkerBusyEvent($worker);
 
         $listener->onWorkerRunning($runningEvent);
     }

diff --git a/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnFailureLimitListenerTest.php b/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnFailureLimitListenerTest.php
@@ -14,8 +14,8 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
 use Symfony\Component\Messenger\EventListener\StopWorkerOnFailureLimitListener;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Worker;
@@ -31,17 +31,17 @@ public function testWorkerStopsWhenMaximumCountReached(int $max, bool $shouldSto
         $worker->expects($shouldStop ? $this->atLeastOnce() : $this->never())->method('stop');
 
         $failedEvent = $this->createFailedEvent();
-        $runningEvent = new WorkerRunningEvent($worker, false);
+        $runningEvent = new WorkerBusyEvent($worker);
 
         $failureLimitListener = new StopWorkerOnFailureLimitListener($max);
         // simulate three messages (of which 2 failed)
         $failureLimitListener->onMessageFailed($failedEvent);
-        $failureLimitListener->onWorkerRunning($runningEvent);
+        $failureLimitListener->onWorkerBusy($runningEvent);
 
-        $failureLimitListener->onWorkerRunning($runningEvent);
+        $failureLimitListener->onWorkerBusy($runningEvent);
 
         $failureLimitListener->onMessageFailed($failedEvent);
-        $failureLimitListener->onWorkerRunning($runningEvent);
+        $failureLimitListener->onWorkerBusy($runningEvent);
     }
 
     public static function countProvider(): iterable
@@ -62,11 +62,11 @@ public function testWorkerLogsMaximumCountReachedWhenLoggerIsGiven()
             );
 
         $worker = $this->createMock(Worker::class);
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $failureLimitListener = new StopWorkerOnFailureLimitListener(1, $logger);
         $failureLimitListener->onMessageFailed($this->createFailedEvent());
-        $failureLimitListener->onWorkerRunning($event);
+        $failureLimitListener->onWorkerBusy($event);
     }
 
     private function createFailedEvent(): WorkerMessageFailedEvent

diff --git a/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnMemoryLimitListenerTest.php b/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnMemoryLimitListenerTest.php
@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\EventListener\StopWorkerOnMemoryLimitListener;
 use Symfony\Component\Messenger\Worker;
 
@@ -28,7 +28,7 @@ public function testWorkerStopsWhenMemoryLimitExceeded(int $memoryUsage, int $me
 
         $worker = $this->createMock(Worker::class);
         $worker->expects($shouldStop ? $this->once() : $this->never())->method('stop');
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $memoryLimitListener = new StopWorkerOnMemoryLimitListener($memoryLimit, null, $memoryResolver);
         $memoryLimitListener->onWorkerRunning($event);
@@ -50,7 +50,7 @@ public function testWorkerLogsMemoryExceededWhenLoggerIsGiven()
         $memoryResolver = fn () => 70;
 
         $worker = $this->createMock(Worker::class);
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $memoryLimitListener = new StopWorkerOnMemoryLimitListener(64, $logger, $memoryResolver);
         $memoryLimitListener->onWorkerRunning($event);

diff --git a/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnMessageLimitListenerTest.php b/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnMessageLimitListenerTest.php
@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\EventListener\StopWorkerOnMessageLimitListener;
 use Symfony\Component\Messenger\Worker;
 
@@ -26,13 +26,13 @@ public function testWorkerStopsWhenMaximumCountExceeded(int $max, bool $shouldSt
     {
         $worker = $this->createMock(Worker::class);
         $worker->expects($shouldStop ? $this->atLeastOnce() : $this->never())->method('stop');
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $maximumCountListener = new StopWorkerOnMessageLimitListener($max);
         // simulate three messages processed
-        $maximumCountListener->onWorkerRunning($event);
-        $maximumCountListener->onWorkerRunning($event);
-        $maximumCountListener->onWorkerRunning($event);
+        $maximumCountListener->onWorkerBusy($event);
+        $maximumCountListener->onWorkerBusy($event);
+        $maximumCountListener->onWorkerBusy($event);
     }
 
     public static function countProvider(): iterable
@@ -53,9 +53,9 @@ public function testWorkerLogsMaximumCountExceededWhenLoggerIsGiven()
             );
 
         $worker = $this->createMock(Worker::class);
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $maximumCountListener = new StopWorkerOnMessageLimitListener(1, $logger);
-        $maximumCountListener->onWorkerRunning($event);
+        $maximumCountListener->onWorkerBusy($event);
     }
 }
diff --git a/...Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnRestartSignalListenerTest.php b/...Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnRestartSignalListenerTest.php
@@ -14,7 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\EventListener\StopWorkerOnRestartSignalListener;
 use Symfony\Component\Messenger\Worker;
 
@@ -36,7 +36,7 @@ public function testWorkerStopsWhenMemoryLimitExceeded(?int $lastRestartTimeOffs
 
         $worker = $this->createMock(Worker::class);
         $worker->expects($shouldStop ? $this->once() : $this->never())->method('stop');
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $stopOnSignalListener = new StopWorkerOnRestartSignalListener($cachePool);
         $stopOnSignalListener->onWorkerStarted();
@@ -60,7 +60,7 @@ public function testWorkerDoesNotStopIfRestartNotInCache()
 
         $worker = $this->createMock(Worker::class);
         $worker->expects($this->never())->method('stop');
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $stopOnSignalListener = new StopWorkerOnRestartSignalListener($cachePool);
         $stopOnSignalListener->onWorkerStarted();

diff --git a/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnTimeLimitListenerTest.php b/src/Symfony/Component/Messenger/Tests/EventListener/StopWorkerOnTimeLimitListenerTest.php
@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
-use Symfony\Component\Messenger\Event\WorkerRunningEvent;
+use Symfony\Component\Messenger\Event\WorkerBusyEvent;
 use Symfony\Component\Messenger\EventListener\StopWorkerOnTimeLimitListener;
 use Symfony\Component\Messenger\Worker;
 
@@ -30,7 +30,7 @@ public function testWorkerStopsWhenTimeLimitIsReached()
 
         $worker = $this->createMock(Worker::class);
         $worker->expects($this->once())->method('stop');
-        $event = new WorkerRunningEvent($worker, false);
+        $event = new WorkerBusyEvent($worker);
 
         $timeoutListener = new StopWorkerOnTimeLimitListener(1, $logger);
         $timeoutListener->onWorkerStarted();