Introduce SelfStampableInterface

VincentLanglet · VincentLanglet · commit 1227309b0ab2 · 2025-02-07T10:28:32.000+01:00
diff --git a/src/Symfony/Component/Messenger/Message/SelfStampableInterface.php b/src/Symfony/Component/Messenger/Message/SelfStampableInterface.php
@@ -0,0 +1,22 @@
+<?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\Message;
+
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+interface SelfStampableInterface
+{
+    /**
+     * @return array<StampInterface>
+     */
+    public function getStamps(): array;
+}
diff --git a/src/Symfony/Component/Messenger/MessageBus.php b/src/Symfony/Component/Messenger/MessageBus.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Messenger;
 
+use Symfony\Component\Messenger\Message\SelfStampableInterface;
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 use Symfony\Component\Messenger\Middleware\StackMiddleware;
 
@@ -53,6 +54,10 @@ public function getIterator(): \Traversable
 
     public function dispatch(object $message, array $stamps = []): Envelope
     {
+        if ($message instanceof SelfStampableInterface) {
+            $stamps = array_merge($message->getStamps(), $stamps);
+        }
+
         $envelope = Envelope::wrap($message, $stamps);
         $middlewareIterator = $this->middlewareAggregate->getIterator();
 
diff --git a/src/Symfony/Component/Messenger/Tests/Fixtures/SelfStampableDummyMessage.php b/src/Symfony/Component/Messenger/Tests/Fixtures/SelfStampableDummyMessage.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Symfony\Component\Messenger\Tests\Fixtures;
+
+use Symfony\Component\Messenger\Message\SelfStampableInterface;
+use Symfony\Component\Messenger\Stamp\DelayStamp;
+
+class SelfStampableDummyMessage implements DummyMessageInterface, SelfStampableInterface
+{
+    public function __construct(private string $message)
+    {
+    }
+
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+
+    public function getStamps(): array
+    {
+        return [new DelayStamp(1)];
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Tests/MessageBusTest.php b/src/Symfony/Component/Messenger/Tests/MessageBusTest.php
@@ -22,6 +22,7 @@
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Tests\Fixtures\AnEnvelopeStamp;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
+use Symfony\Component\Messenger\Tests\Fixtures\SelfStampableDummyMessage;
 
 class MessageBusTest extends TestCase
 {
@@ -133,6 +134,14 @@ public function testItAddsTheStampsToEnvelope()
         $this->assertCount(2, $finalEnvelope->all());
     }
 
+    public function testSelfStampableMessage()
+    {
+        $finalEnvelope = (new MessageBus())->dispatch(new SelfStampableDummyMessage(''), [new DelayStamp(5), new BusNameStamp('bar')]);
+        $this->assertCount(2, $finalEnvelope->all());
+        $this->assertCount(2, $finalEnvelope->all()[DelayStamp::class]);
+        $this->assertSame(5, $finalEnvelope->last(DelayStamp::class)->getDelay());
+    }
+
     public static function provideConstructorDataStucture(): iterable
     {
         yield 'iterator' => [new \ArrayObject([
