[Mailer] Enhance debugging when all transports fail

mithredate · mithredate · commit d555d90254b9 · 2022-11-06T20:50:18.000+03:30
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Exception\TransportException;
+use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
 use Symfony\Component\Mailer\Transport\RoundRobinTransport;
 use Symfony\Component\Mailer\Transport\TransportInterface;
 use Symfony\Component\Mime\RawMessage;
@@ -61,6 +62,7 @@ public function testSendAllDead()
         $t2->expects($this->once())->method('send')->will($this->throwException(new TransportException()));
         $t = new RoundRobinTransport([$t1, $t2]);
         $p = new \ReflectionProperty($t, 'cursor');
+        $p->setAccessible(true);
         $p->setValue($t, 0);
 
         try {
@@ -137,6 +139,30 @@ public function testSendOneDeadAndRecoveryWithinRetryPeriod()
         $this->assertTransports($t, 1, []);
     }
 
+    public function testFailureDebugInformation()
+    {
+        $t1 = $this->createMock(TransportInterface::class);
+        $e1 = new TransportException();
+        $e1->appendDebug('Debug message 1');
+        $t1->expects($this->once())->method('send')->will($this->throwException($e1));
+        $t2 = $this->createMock(TransportInterface::class);
+        $e2 = new TransportException();
+        $e2->appendDebug('Debug message 2');
+        $t2->expects($this->once())->method('send')->will($this->throwException($e2));
+        $t = new RoundRobinTransport([$t1, $t2]);
+
+        try {
+            $t->send(new RawMessage(''));
+        } catch (TransportExceptionInterface $e) {
+            $this->assertStringContainsString($e1->getDebug(), $e->getDebug());
+            $this->assertStringContainsString($e2->getDebug(), $e->getDebug());
+
+            return;
+        }
+
+        $this->fail('Expected exception was not thrown!');
+    }
+
     private function assertTransports(RoundRobinTransport $transport, int $cursor, array $deadTransports)
     {
         $p = new \ReflectionProperty($transport, 'cursor');
diff --git a/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php b/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php
@@ -48,15 +48,18 @@ public function __construct(array $transports, int $retryPeriod = 60)
 
     public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage
     {
+        $exception = new TransportException('All transports failed.');
+
         while ($transport = $this->getNextTransport()) {
             try {
                 return $transport->send($message, $envelope);
             } catch (TransportExceptionInterface $e) {
+                $exception->appendDebug($this->formatException($transport, $e));
                 $this->deadTransports[$transport] = microtime(true);
             }
         }
 
-        throw new TransportException('All transports failed.');
+        throw $exception;
     }
 
     public function __toString(): string
@@ -118,4 +121,9 @@ private function moveCursor(int $cursor): int
     {
         return ++$cursor >= \count($this->transports) ? 0 : $cursor;
     }
+
+    private function formatException(TransportInterface $transport, TransportExceptionInterface $exception): string
+    {
+        return sprintf('Transport %s: %s', $transport, $exception->getDebug());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -48,15 +48,18 @@ public function __construct(array $transports, int $retryPeriod = 60)`
`48`	`48`
`49`	`49`	`public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage`
`50`	`50`	`{`
	`51`	`+ $exception = new TransportException('All transports failed.');`
	`52`	`+`
`51`	`53`	`while ($transport = $this->getNextTransport()) {`
`52`	`54`	`try {`
`53`	`55`	`return $transport->send($message, $envelope);`
`54`	`56`	`} catch (TransportExceptionInterface $e) {`
	`57`	`+ $exception->appendDebug($this->formatException($transport, $e));`
`55`	`58`	`$this->deadTransports[$transport] = microtime(true);`
`56`	`59`	`}`
`57`	`60`	`}`
`58`	`61`
`59`		`- throw new TransportException('All transports failed.');`
	`62`	`+ throw $exception;`
`60`	`63`	`}`
`61`	`64`
`62`	`65`	`public function __toString(): string`
`@@ -118,4 +121,9 @@ private function moveCursor(int $cursor): int`
`118`	`121`	`{`
`119`	`122`	`return ++$cursor >= \count($this->transports) ? 0 : $cursor;`
`120`	`123`	`}`
	`124`	`+`
	`125`	`+ private function formatException(TransportInterface $transport, TransportExceptionInterface $exception): string`
	`126`	`+ {`
	`127`	`+ return sprintf('Transport %s: %s', $transport, $exception->getDebug());`
	`128`	`+ }`
`121`	`129`	`}`