[Messenger][Amqp] Fix wrong routing key when use failure queue

Fabien Perroquin · Fabien Perroquin · commit 908a9f3300d1 · 2023-10-19T10:47:23.000+02:00
diff --git a/src/Symfony/Component/Messenger/Bridge/Amqp/Tests/Transport/ConnectionTest.php b/src/Symfony/Component/Messenger/Bridge/Amqp/Tests/Transport/ConnectionTest.php
@@ -804,6 +804,23 @@ private function createDelayOrRetryConnection(\AMQPExchange $delayExchange, stri
 
         return Connection::fromDsn('amqp://localhost', [], $factory);
     }
+
+    public function testForcePublishWithDefaultRoutingKey()
+    {
+        $factory = new TestAmqpFactory(
+            $amqpConnection = $this->createMock(\AMQPConnection::class),
+            $amqpChannel = $this->createMock(\AMQPChannel::class),
+            $amqpQueue = $this->createMock(\AMQPQueue::class),
+            $amqpExchange = $this->createMock(\AMQPExchange::class)
+        );
+
+        $amqpExchange->expects($this->once())->method('publish')->with('body', 'default_routing_key');
+        $amqpEnvelope = $this->createMock(\AMQPEnvelope::class);
+        $amqpStamp = AmqpStamp::createFromAmqpEnvelope($amqpEnvelope, null, '', true);
+
+        $connection = Connection::fromDsn('amqp://localhost?exchange[default_publish_routing_key]=default_routing_key', [], $factory);
+        $connection->publish('body', [], 0, $amqpStamp);
+    }
 }
 
 class TestAmqpFactory extends AmqpFactory
diff --git a/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/AmqpSender.php b/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/AmqpSender.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Exception\TransportException;
 use Symfony\Component\Messenger\Stamp\DelayStamp;
 use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
+use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
 use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
 use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
 use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
@@ -59,7 +60,8 @@ public function send(Envelope $envelope): Envelope
             $amqpStamp = AmqpStamp::createFromAmqpEnvelope(
                 $amqpReceivedStamp->getAmqpEnvelope(),
                 $amqpStamp,
-                $envelope->last(RedeliveryStamp::class) ? $amqpReceivedStamp->getQueueName() : null
+                $envelope->last(RedeliveryStamp::class) ? $amqpReceivedStamp->getQueueName() : null,
+                $envelope->last(SentToFailureTransportStamp::class) ? true : false
             );
         }
 
diff --git a/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/AmqpStamp.php b/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/AmqpStamp.php
@@ -23,6 +23,7 @@ final class AmqpStamp implements NonSendableStampInterface
     private int $flags;
     private array $attributes;
     private bool $isRetryAttempt = false;
+    private bool $forceDefaultRoutingKey = false;
 
     public function __construct(string $routingKey = null, int $flags = \AMQP_NOPARAM, array $attributes = [])
     {
@@ -46,7 +47,7 @@ public function getAttributes(): array
         return $this->attributes;
     }
 
-    public static function createFromAmqpEnvelope(\AMQPEnvelope $amqpEnvelope, self $previousStamp = null, string $retryRoutingKey = null): self
+    public static function createFromAmqpEnvelope(\AMQPEnvelope $amqpEnvelope, self $previousStamp = null, string $retryRoutingKey = null, bool $forceDefaultRoutingKey = false): self
     {
         $attr = $previousStamp->attributes ?? [];
 
@@ -71,6 +72,8 @@ public static function createFromAmqpEnvelope(\AMQPEnvelope $amqpEnvelope, self
             $stamp->isRetryAttempt = true;
         }
 
+        $stamp->forceDefaultRoutingKey = $forceDefaultRoutingKey;
+
         return $stamp;
     }
 
@@ -87,4 +90,9 @@ public static function createWithAttributes(array $attributes, self $previousSta
             array_merge($previousStamp->attributes ?? [], $attributes)
         );
     }
+
+    public function isForceDefaultRoutingKey(): bool
+    {
+        return $this->forceDefaultRoutingKey;
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/Connection.php b/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/Connection.php
@@ -563,6 +563,10 @@ public function purgeQueues(): void
 
     private function getRoutingKeyForMessage(?AmqpStamp $amqpStamp): ?string
     {
+        if($amqpStamp?->isForceDefaultRoutingKey()) {
+            return $this->getDefaultPublishRoutingKey();
+        }
+
         return $amqpStamp?->getRoutingKey() ?? $this->getDefaultPublishRoutingKey();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ final class AmqpStamp implements NonSendableStampInterface`
`23`	`23`	`private int $flags;`
`24`	`24`	`private array $attributes;`
`25`	`25`	`private bool $isRetryAttempt = false;`
	`26`	`+ private bool $forceDefaultRoutingKey = false;`
`26`	`27`
`27`	`28`	`public function __construct(string $routingKey = null, int $flags = \AMQP_NOPARAM, array $attributes = [])`
`28`	`29`	`{`
`@@ -46,7 +47,7 @@ public function getAttributes(): array`
`46`	`47`	`return $this->attributes;`
`47`	`48`	`}`
`48`	`49`
`49`		`- public static function createFromAmqpEnvelope(\AMQPEnvelope $amqpEnvelope, self $previousStamp = null, string $retryRoutingKey = null): self`
	`50`	`+ public static function createFromAmqpEnvelope(\AMQPEnvelope $amqpEnvelope, self $previousStamp = null, string $retryRoutingKey = null, bool $forceDefaultRoutingKey = false): self`
`50`	`51`	`{`
`51`	`52`	`$attr = $previousStamp->attributes ?? [];`
`52`	`53`
`@@ -71,6 +72,8 @@ public static function createFromAmqpEnvelope(\AMQPEnvelope $amqpEnvelope, self`
`71`	`72`	`$stamp->isRetryAttempt = true;`
`72`	`73`	`}`
`73`	`74`
	`75`	`+ $stamp->forceDefaultRoutingKey = $forceDefaultRoutingKey;`
	`76`	`+`
`74`	`77`	`return $stamp;`
`75`	`78`	`}`
`76`	`79`
`@@ -87,4 +90,9 @@ public static function createWithAttributes(array $attributes, self $previousSta`
`87`	`90`	`array_merge($previousStamp->attributes ?? [], $attributes)`
`88`	`91`	`);`
`89`	`92`	`}`
	`93`	`+`
	`94`	`+ public function isForceDefaultRoutingKey(): bool`
	`95`	`+ {`
	`96`	`+ return $this->forceDefaultRoutingKey;`
	`97`	`+ }`
`90`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -563,6 +563,10 @@ public function purgeQueues(): void`
`563`	`563`
`564`	`564`	`private function getRoutingKeyForMessage(?AmqpStamp $amqpStamp): ?string`
`565`	`565`	`{`
	`566`	`+ if($amqpStamp?->isForceDefaultRoutingKey()) {`
	`567`	`+ return $this->getDefaultPublishRoutingKey();`
	`568`	`+ }`
	`569`	`+`
`566`	`570`	`return $amqpStamp?->getRoutingKey() ?? $this->getDefaultPublishRoutingKey();`
`567`	`571`	`}`
`568`	`572`	`}`