[Messenger] Passing to WorkerMessageRetriedEvent envelope with actual stamps after sent

daffoxdev · daffoxdev · commit 52c7322c91a2 · 2024-02-26T08:22:46.000+02:00
Signed-off-by: j.apsitis &lt;yury.apsitis.dev@gmail.com&gt;
diff --git a/src/Symfony/Component/Messenger/EventListener/SendFailedMessageForRetryListener.php b/src/Symfony/Component/Messenger/EventListener/SendFailedMessageForRetryListener.php
@@ -77,10 +77,10 @@ public function onMessageFailed(WorkerMessageFailedEvent $event)
             $retryEnvelope = $this->withLimitedHistory($envelope, new DelayStamp($delay), new RedeliveryStamp($retryCount));
 
             // re-send the message for retry
-            $this->getSenderForTransport($event->getReceiverName())->send($retryEnvelope);
+            $retriedEnvelope = $this->getSenderForTransport($event->getReceiverName())->send($retryEnvelope);
 
             if (null !== $this->eventDispatcher) {
-                $this->eventDispatcher->dispatch(new WorkerMessageRetriedEvent($retryEnvelope, $event->getReceiverName()));
+                $this->eventDispatcher->dispatch(new WorkerMessageRetriedEvent($retriedEnvelope, $event->getReceiverName()));
             }
         } else {
             if (null !== $this->logger) {
diff --git a/src/Symfony/Component/Messenger/Tests/EventListener/SendFailedMessageForRetryListenerTest.php b/src/Symfony/Component/Messenger/Tests/EventListener/SendFailedMessageForRetryListenerTest.php
@@ -15,11 +15,13 @@
 use Psr\Container\ContainerInterface;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
+use Symfony\Component\Messenger\Event\WorkerMessageRetriedEvent;
 use Symfony\Component\Messenger\EventListener\SendFailedMessageForRetryListener;
 use Symfony\Component\Messenger\Exception\RecoverableMessageHandlingException;
 use Symfony\Component\Messenger\Retry\RetryStrategyInterface;
 use Symfony\Component\Messenger\Stamp\DelayStamp;
 use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
+use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
 use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
@@ -190,4 +192,49 @@ public function testEnvelopeKeepOnlyTheLast10Stamps()
 
         $listener->onMessageFailed($event);
     }
+
+    public function testRetriedEnvelopePassesToRetriedEvent()
+    {
+        $exception = new \Exception('no!');
+        $envelope = new Envelope(new \stdClass());
+
+        $sender = $this->createMock(SenderInterface::class);
+        $sender->expects($this->once())->method('send')->willReturnCallback(function (Envelope $envelope) {
+            return $envelope->with(new TransportMessageIdStamp(123));
+        });
+
+        $eventDispatcher = $this->createMock(EventDispatcherInterface::class);
+        $eventDispatcher->expects($this->once())->method('dispatch')->willReturnCallback(
+            function (WorkerMessageRetriedEvent $retriedEvent) {
+                $envelope = $retriedEvent->getEnvelope();
+
+                $transportIdStamp = $envelope->last(TransportMessageIdStamp::class);
+                $this->assertNotNull($transportIdStamp);
+
+                return $retriedEvent;
+            });
+
+        $senderLocator = $this->createMock(ContainerInterface::class);
+        $senderLocator->expects($this->once())->method('has')->willReturn(true);
+        $senderLocator->expects($this->once())->method('get')->willReturn($sender);
+
+        $retryStrategy = $this->createMock(RetryStrategyInterface::class);
+        $retryStrategy->expects($this->once())->method('isRetryable')->willReturn(true);
+        $retryStrategy->expects($this->once())->method('getWaitingTime')->willReturn(1000);
+
+        $retryStrategyLocator = $this->createMock(ContainerInterface::class);
+        $retryStrategyLocator->expects($this->once())->method('has')->willReturn(true);
+        $retryStrategyLocator->expects($this->once())->method('get')->willReturn($retryStrategy);
+
+        $listener = new SendFailedMessageForRetryListener(
+            $senderLocator,
+            $retryStrategyLocator,
+            null,
+            $eventDispatcher
+        );
+
+        $event = new WorkerMessageFailedEvent($envelope, 'my_receiver', $exception);
+
+        $listener->onMessageFailed($event);
+    }
 }
