feature #37976 [Messenger] Don't prevent dispatch out of another bus (ogizanagi)

fabpot · fabpot · commit 0aae1b491ce1 · 2020-09-10T19:13:48.000+02:00
This PR was merged into the 5.2-dev branch. Discussion ---------- [Messenger] Don't prevent dispatch out of another bus | Q | A | ------------- | --- | Branch? | master  | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | #35814 (comment)  | License | MIT | Doc PR | N/A Commits ------- 1e8ae43 [Messenger] Don't prevent dispatch out of another bus
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
 * Added `FlattenExceptionNormalizer` to give more information about the exception on Messenger background processes. The `FlattenExceptionNormalizer` has a higher priority than `ProblemNormalizer` and it is only used when the Messenger serialization context is set.
 * Added factory methods to `DelayStamp`.
+* Removed the exception when dispatching a message with a `DispatchAfterCurrentBusStamp` and not in a context of another dispatch call
 
 5.1.0
 -----
diff --git a/src/Symfony/Component/Messenger/Middleware/DispatchAfterCurrentBusMiddleware.php b/src/Symfony/Component/Messenger/Middleware/DispatchAfterCurrentBusMiddleware.php
@@ -44,12 +44,13 @@ class DispatchAfterCurrentBusMiddleware implements MiddlewareInterface
     public function handle(Envelope $envelope, StackInterface $stack): Envelope
     {
         if (null !== $envelope->last(DispatchAfterCurrentBusStamp::class)) {
-            if (!$this->isRootDispatchCallRunning) {
-                throw new \LogicException(sprintf('You can only use a "%s" stamp in the context of a message handler.', DispatchAfterCurrentBusStamp::class));
+            if ($this->isRootDispatchCallRunning) {
+                $this->queue[] = new QueuedEnvelope($envelope, $stack);
+
+                return $envelope;
             }
-            $this->queue[] = new QueuedEnvelope($envelope, $stack);
 
-            return $envelope;
+            $envelope = $envelope->withoutAll(DispatchAfterCurrentBusStamp::class);
         }
 
         if ($this->isRootDispatchCallRunning) {
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/DispatchAfterCurrentBusMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/DispatchAfterCurrentBusMiddlewareTest.php
@@ -256,6 +256,28 @@ public function testHandleDelayedEventFromQueue()
         $messageBus->dispatch($message);
     }
 
+    public function testDispatchOutOfAnotherHandlerDispatchesAndRemoveStamp()
+    {
+        $event = new DummyEvent('First event');
+
+        $middleware = new DispatchAfterCurrentBusMiddleware();
+        $handlingMiddleware = $this->createMock(MiddlewareInterface::class);
+
+        $handlingMiddleware
+            ->method('handle')
+            ->with($this->expectHandledMessage($event))
+            ->will($this->willHandleMessage());
+
+        $eventBus = new MessageBus([
+            $middleware,
+            $handlingMiddleware,
+        ]);
+
+        $enveloppe = $eventBus->dispatch($event, [new DispatchAfterCurrentBusStamp()]);
+
+        self::assertNull($enveloppe->last(DispatchAfterCurrentBusStamp::class));
+    }
+
     private function expectHandledMessage($message): Callback
     {
         return $this->callback(function (Envelope $envelope) use ($message) {

Original file line number	Diff line number	Diff line change
`@@ -44,12 +44,13 @@ class DispatchAfterCurrentBusMiddleware implements MiddlewareInterface`
`44`	`44`	`public function handle(Envelope $envelope, StackInterface $stack): Envelope`
`45`	`45`	`{`
`46`	`46`	`if (null !== $envelope->last(DispatchAfterCurrentBusStamp::class)) {`
`47`		`- if (!$this->isRootDispatchCallRunning) {`
`48`		`- throw new \LogicException(sprintf('You can only use a "%s" stamp in the context of a message handler.', DispatchAfterCurrentBusStamp::class));`
	`47`	`+ if ($this->isRootDispatchCallRunning) {`
	`48`	`+ $this->queue[] = new QueuedEnvelope($envelope, $stack);`
	`49`	`+`
	`50`	`+ return $envelope;`
`49`	`51`	`}`
`50`		`- $this->queue[] = new QueuedEnvelope($envelope, $stack);`
`51`	`52`
`52`		`- return $envelope;`
	`53`	`+ $envelope = $envelope->withoutAll(DispatchAfterCurrentBusStamp::class);`
`53`	`54`	`}`
`54`	`55`
`55`	`56`	`if ($this->isRootDispatchCallRunning) {`