bug #46154 [Mailer] Restore X-Transport after failure (zenas1210)

fabpot · fabpot · commit 7f4c304bb3f0 · 2022-04-27T19:03:39.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Mailer] Restore X-Transport after failure | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #44741 | License | MIT | Doc PR | Restores X-Transport header for retries after failure. Commits ------- 635e995 [Mailer] Restore X-Transport after failure
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/TransportsTest.php b/src/Symfony/Component/Mailer/Tests/Transport/TransportsTest.php
@@ -64,4 +64,28 @@ public function testTransportDoesNotExist()
         $this->expectExceptionMessage('The "foobar" transport does not exist (available transports: "foo", "bar").');
         $transport->send($email);
     }
+
+    public function testTransportRestoredAfterFailure()
+    {
+        $exception = new \Exception();
+
+        $fooTransport = $this->createMock(TransportInterface::class);
+        $fooTransport->method('send')
+            ->willThrowException($exception);
+
+        $transport = new Transports([
+            'foo' => $fooTransport,
+        ]);
+
+        $headers = (new Headers())->addTextHeader('X-Transport', 'foo');
+        $email = new Message($headers, new TextPart('...'));
+
+        $this->expectExceptionObject($exception);
+
+        try {
+            $transport->send($email);
+        } finally {
+            $this->assertSame('foo', $email->getHeaders()->getHeaderBody('X-Transport'));
+        }
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Transport/Transports.php b/src/Symfony/Component/Mailer/Transport/Transports.php
@@ -59,7 +59,13 @@ public function send(RawMessage $message, Envelope $envelope = null): ?SentMessa
             throw new InvalidArgumentException(sprintf('The "%s" transport does not exist (available transports: "%s").', $transport, implode('", "', array_keys($this->transports))));
         }
 
-        return $this->transports[$transport]->send($message, $envelope);
+        try {
+            return $this->transports[$transport]->send($message, $envelope);
+        } catch (\Throwable $e) {
+            $headers->addTextHeader('X-Transport', $transport);
+
+            throw $e;
+        }
     }
 
     public function __toString(): string

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,13 @@ public function send(RawMessage $message, Envelope $envelope = null): ?SentMessa`
`59`	`59`	`throw new InvalidArgumentException(sprintf('The "%s" transport does not exist (available transports: "%s").', $transport, implode('", "', array_keys($this->transports))));`
`60`	`60`	`}`
`61`	`61`
`62`		`- return $this->transports[$transport]->send($message, $envelope);`
	`62`	`+ try {`
	`63`	`+ return $this->transports[$transport]->send($message, $envelope);`
	`64`	`+ } catch (\Throwable $e) {`
	`65`	`+ $headers->addTextHeader('X-Transport', $transport);`
	`66`	`+`
	`67`	`+ throw $e;`
	`68`	`+ }`
`63`	`69`	`}`
`64`	`70`
`65`	`71`	`public function __toString(): string`