[Messenger] Add WorkerStoppedEvent

Robin Chalas · Robin Chalas · commit 4733c2256061 · 2019-04-27T14:51:25.000+02:00
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 4.3.0
 -----
 
+ * Added `WorkerStoppedEvent` dispatched when a worker is stopped.
  * Added optional `MessageCountAwareInterface` that receivers can implement
    to give information about how many messages are waiting to be processed.
  * [BC BREAK] The `Envelope::__construct()` signature changed:
diff --git a/src/Symfony/Component/Messenger/Event/WorkerStoppedEvent.php b/src/Symfony/Component/Messenger/Event/WorkerStoppedEvent.php
@@ -0,0 +1,23 @@
+<?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;
+
+/**
+ * Dispatched when a worker has been stopped.
+ *
+ * @author Robin Chalas <robin.chalas@gmail.com>
+ *
+ * @experimental in 4.3
+ */
+class WorkerStoppedEvent
+{
+}
diff --git a/src/Symfony/Component/Messenger/Tests/WorkerTest.php b/src/Symfony/Component/Messenger/Tests/WorkerTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
+use Symfony\Component\Messenger\Event\WorkerStoppedEvent;
 use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Messenger\Retry\RetryStrategyInterface;
@@ -187,11 +188,12 @@ public function testWorkerDispatchesEventsOnSuccess()
 
         $eventDispatcher = $this->getMockBuilder(EventDispatcherInterface::class)->getMock();
 
-        $eventDispatcher->expects($this->exactly(2))
+        $eventDispatcher->expects($this->exactly(3))
             ->method('dispatch')
             ->withConsecutive(
                 [$this->isInstanceOf(WorkerMessageReceivedEvent::class)],
-                [$this->isInstanceOf(WorkerMessageHandledEvent::class)]
+                [$this->isInstanceOf(WorkerMessageHandledEvent::class)],
+                [$this->isInstanceOf(WorkerStoppedEvent::class)]
             );
 
         $worker = new Worker([$receiver], $bus, [], $eventDispatcher);
@@ -214,11 +216,12 @@ public function testWorkerDispatchesEventsOnError()
 
         $eventDispatcher = $this->getMockBuilder(EventDispatcherInterface::class)->getMock();
 
-        $eventDispatcher->expects($this->exactly(2))
+        $eventDispatcher->expects($this->exactly(3))
             ->method('dispatch')
             ->withConsecutive(
                 [$this->isInstanceOf(WorkerMessageReceivedEvent::class)],
-                [$this->isInstanceOf(WorkerMessageFailedEvent::class)]
+                [$this->isInstanceOf(WorkerMessageFailedEvent::class)],
+                [$this->isInstanceOf(WorkerStoppedEvent::class)]
             );
 
         $worker = new Worker([$receiver], $bus, [], $eventDispatcher);
diff --git a/src/Symfony/Component/Messenger/Worker.php b/src/Symfony/Component/Messenger/Worker.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
+use Symfony\Component\Messenger\Event\WorkerStoppedEvent;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Exception\LogicException;
 use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
@@ -174,6 +175,8 @@ private function handleMessage(Envelope $envelope, ReceiverInterface $receiver,
 
     public function stop(): void
     {
+        $this->dispatchEvent(new WorkerStoppedEvent());
+
         $this->shouldStop = true;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;`
`16`	`16`	`use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;`
`17`	`17`	`use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;`
	`18`	`+use Symfony\Component\Messenger\Event\WorkerStoppedEvent;`
`18`	`19`	`use Symfony\Component\Messenger\Exception\HandlerFailedException;`
`19`	`20`	`use Symfony\Component\Messenger\Exception\LogicException;`
`20`	`21`	`use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;`
`@@ -174,6 +175,8 @@ private function handleMessage(Envelope $envelope, ReceiverInterface $receiver,`
`174`	`175`
`175`	`176`	`public function stop(): void`
`176`	`177`	`{`
	`178`	`+ $this->dispatchEvent(new WorkerStoppedEvent());`
	`179`	`+`
`177`	`180`	`$this->shouldStop = true;`
`178`	`181`	`}`
`179`	`182`