bug #60772 [Mailer] [Transport] Send clone of RawMessage instance in RoundRobinTransport (jnoordsij)

fabpot · fabpot · commit cdedbab1dc2a · 2025-06-20T12:40:32.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Mailer] [Transport] Send clone of `RawMessage` instance in `RoundRobinTransport` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | N/A | License | MIT When using an implementation of the `TransportInterface`, a common pattern (especially for mass bulk mailing services) is to use headers to communicate various pieces of metadata or settings to the receiving server for processing. Such options or headers might be very specific to the type of service used. Real world examples of such applications are https://github.com/symfony/mailgun-mailer/blob/7.2/Transport/MailgunApiTransport.php#L89 or https://www.reddit.com/r/symfony/comments/1cn32jx/add_header_based_on_transport/?rdt=36882. However, when using such a transport as one of the transports in the `RoundRobinTransport` (or by extension the `FailoverTransport`), this may result in certain headers intended for transport service A to also be sent to transport service B if the former fails. Although this will likely be harmless in most cases, it may cause issues as the one described in laravel/framework#51872 (and https://stackoverflow.com/questions/78660310/why-the-failover-first-driver-fails-and-inline-attachment-image-path-is-wrong-in). To prevent alterations to the message that happen within the scope of a specific transport to leak to another, this PR proposes to use a clone of the `RawMessage` instance whenever attempting a new transport service. This should ensure that any transport-specific manipulations should not leak to a next transport. Note this is mostly a behavioral change, which I don't think should break any existing use case, but may considered to be noteworthy enough to list it somewhere. It may also even be considered a bug fix; if so, and it is better to target `7.3` or `6.4` instead, please let me know. Commits ------- 0972774 [Mailer] [Transport] Send clone of `RawMessage` instance in `RoundRobinTransport`
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php
@@ -16,6 +16,8 @@
 use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
 use Symfony\Component\Mailer\Transport\RoundRobinTransport;
 use Symfony\Component\Mailer\Transport\TransportInterface;
+use Symfony\Component\Mime\Header\Headers;
+use Symfony\Component\Mime\Message;
 use Symfony\Component\Mime\RawMessage;
 
 /**
@@ -143,6 +145,27 @@ public function testSendOneDeadAndRecoveryWithinRetryPeriod()
         $this->assertTransports($t, 1, []);
     }
 
+    public function testSendOneDeadMessageAlterationsDoNotPersist()
+    {
+        $t1 = $this->createMock(TransportInterface::class);
+        $t1->expects($this->once())->method('send')
+            ->willReturnCallback(function (Message $message) {
+                $message->getHeaders()->addTextHeader('X-Transport-1', 'value');
+                throw new TransportException();
+            });
+        $t2 = $this->createMock(TransportInterface::class);
+        $t2->expects($this->once())->method('send');
+        $t = new RoundRobinTransport([$t1, $t2]);
+        $p = new \ReflectionProperty($t, 'cursor');
+        $p->setValue($t, 0);
+        $headers = new Headers();
+        $headers->addTextHeader('X-Shared', 'value');
+        $message = new Message($headers);
+        $t->send($message);
+        $this->assertSame($message->getHeaders()->get('X-Shared')->getBody(), 'value');
+        $this->assertFalse($message->getHeaders()->has('X-Transport-1'));
+    }
+
     public function testFailureDebugInformation()
     {
         $t1 = $this->createMock(TransportInterface::class);
diff --git a/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php b/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php
@@ -52,7 +52,7 @@ public function send(RawMessage $message, ?Envelope $envelope = null): ?SentMess
 
         while ($transport = $this->getNextTransport()) {
             try {
-                return $transport->send($message, $envelope);
+                return $transport->send(clone $message, $envelope);
             } catch (TransportExceptionInterface $e) {
                 $exception ??= new TransportException('All transports failed.');
                 $exception->appendDebug(sprintf("Transport \"%s\": %s\n", $transport, $e->getDebug()));
