feature #32916 [Mailer] Add a name to the transports (fabpot)

fabpot · fabpot · commit 37265de54d3c · 2019-08-04T07:00:35.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Mailer] Add a name to the transports | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | n/a | License | MIT | Doc PR | n/a Having a name for Transports helps identify them (useful for instance in the profiler when one uses several mailers). Commits ------- 2412dfe [Mailer] added a name to the transport
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php
@@ -42,6 +42,11 @@ public function __construct(EventDispatcherInterface $eventDispatcher, LoggerInt
                 $this->onDoSend = $onDoSend;
             }
 
+            public function getName(): string
+            {
+                return 'dummy://local';
+            }
+
             protected function doSend(SentMessage $message): void
             {
                 $onDoSend = $this->onDoSend;
diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -74,6 +74,7 @@
         "symfony/dom-crawler": "<4.3",
         "symfony/form": "<4.3",
         "symfony/lock": "<4.4",
+        "symfony/mailer": "<4.4",
         "symfony/messenger": "<4.3",
         "symfony/property-info": "<3.4",
         "symfony/serializer": "<4.2",
diff --git a/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesApiTransport.php
@@ -43,6 +43,11 @@ public function __construct(string $accessKey, string $secretKey, string $region
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('api://%s@ses?region=%s', $this->accessKey, $this->region);
+    }
+
     protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
     {
         $date = gmdate('D, d M Y H:i:s e');
diff --git a/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesHttpTransport.php
@@ -42,6 +42,11 @@ public function __construct(string $accessKey, string $secretKey, string $region
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('http://%s@ses?region=%s', $this->accessKey, $this->region);
+    }
+
     protected function doSendHttp(SentMessage $message): ResponseInterface
     {
         $date = gmdate('D, d M Y H:i:s e');
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillApiTransport.php
@@ -36,6 +36,11 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('api://mandrill');
+    }
+
     protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
     {
         $response = $this->client->request('POST', self::ENDPOINT, [
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillHttpTransport.php
@@ -34,6 +34,11 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('http://mandrill');
+    }
+
     protected function doSendHttp(SentMessage $message): ResponseInterface
     {
         $envelope = $message->getEnvelope();
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php
@@ -41,6 +41,11 @@ public function __construct(string $key, string $domain, string $region = null,
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('api://%s@mailgun?region=%s', $this->domain, $this->region);
+    }
+
     protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
     {
         $body = new FormDataPart($this->getPayload($email, $envelope));
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunHttpTransport.php
@@ -40,6 +40,11 @@ public function __construct(string $key, string $domain, string $region = null,
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('http://%s@mailgun?region=%s', $this->domain, $this->region);
+    }
+
     protected function doSendHttp(SentMessage $message): ResponseInterface
     {
         $body = new FormDataPart([
diff --git a/src/Symfony/Component/Mailer/Bridge/Postmark/Transport/PostmarkApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Postmark/Transport/PostmarkApiTransport.php
@@ -36,6 +36,11 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('api://postmark');
+    }
+
     protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
     {
         $response = $this->client->request('POST', self::ENDPOINT, [
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php
@@ -37,6 +37,11 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve
         parent::__construct($client, $dispatcher, $logger);
     }
 
+    public function getName(): string
+    {
+        return sprintf('api://sendgrid');
+    }
+
     protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
     {
         $response = $this->client->request('POST', self::ENDPOINT, [
diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 4.4.0
 -----
 
+ * [BC BREAK] `TransportInterface` has a new `getName()` method
  * [BC BREAK] Classes `AbstractApiTransport` and `AbstractHttpTransport` moved under `Transport` sub-namespace.
  * [BC BREAK] Transports depend on `Symfony\Contracts\EventDispatcher\EventDispatcherInterface`
    instead of `Symfony\Component\EventDispatcher\EventDispatcherInterface`.
diff --git a/src/Symfony/Component/Mailer/Test/TransportFactoryTestCase.php b/src/Symfony/Component/Mailer/Test/TransportFactoryTestCase.php
@@ -69,6 +69,9 @@ public function testCreate(Dsn $dsn, TransportInterface $transport): void
         $factory = $this->getFactory();
 
         $this->assertEquals($transport, $factory->create($dsn));
+        if ('smtp' !== $dsn->getScheme()) {
+            $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', $transport->getName());
+        }
     }
 
     /**
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/FailoverTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/FailoverTransportTest.php
@@ -29,6 +29,16 @@ public function testSendNoTransports()
         new FailoverTransport([]);
     }
 
+    public function testGetName()
+    {
+        $t1 = $this->createMock(TransportInterface::class);
+        $t1->expects($this->once())->method('getName')->willReturn('t1://local');
+        $t2 = $this->createMock(TransportInterface::class);
+        $t2->expects($this->once())->method('getName')->willReturn('t2://local');
+        $t = new FailoverTransport([$t1, $t2]);
+        $this->assertEquals('t1://local || t2://local', $t->getName());
+    }
+
     public function testSendFirstWork()
     {
         $t1 = $this->createMock(TransportInterface::class);
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/NullTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/NullTransportTest.php
@@ -0,0 +1,24 @@
+<?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\Mailer\Tests\Transport;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mailer\Transport\NullTransport;
+
+class NullTransportTest extends TestCase
+{
+    public function testName()
+    {
+        $t = new NullTransport();
+        $this->assertEquals('smtp://null', $t->getName());
+    }
+}
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php
@@ -28,6 +28,16 @@ public function testSendNoTransports()
         new RoundRobinTransport([]);
     }
 
+    public function testGetName()
+    {
+        $t1 = $this->createMock(TransportInterface::class);
+        $t1->expects($this->once())->method('getName')->willReturn('t1://local');
+        $t2 = $this->createMock(TransportInterface::class);
+        $t2->expects($this->once())->method('getName')->willReturn('t2://local');
+        $t = new RoundRobinTransport([$t1, $t2]);
+        $this->assertEquals('t1://local && t2://local', $t->getName());
+    }
+
     public function testSendAlternate()
     {
         $t1 = $this->createMock(TransportInterface::class);
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/SendmailTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/SendmailTransportTest.php
@@ -0,0 +1,24 @@
+<?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\Mailer\Tests\Transport;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mailer\Transport\SendmailTransport;
+
+class SendmailTransportTest extends TestCase
+{
+    public function testName()
+    {
+        $t = new SendmailTransport();
+        $this->assertEquals('smtp://sendmail', $t->getName());
+    }
+}
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/Smtp/SmtpTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/Smtp/SmtpTransportTest.php
@@ -0,0 +1,28 @@
+<?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\Mailer\Tests\Transport\Smtp;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Mailer\Transport\Smtp\SmtpTransport;
+use Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream;
+
+class SmtpTransportTest extends TestCase
+{
+    public function testName()
+    {
+        $t = new SmtpTransport();
+        $this->assertEquals('smtp://localhost:25', $t->getName());
+
+        $t = new SmtpTransport((new SocketStream())->setHost('127.0.0.1')->setPort(2525));
+        $this->assertEquals('smtp://127.0.0.1:2525', $t->getName());
+    }
+}
diff --git a/src/Symfony/Component/Mailer/Tests/TransportTest.php b/src/Symfony/Component/Mailer/Tests/TransportTest.php
@@ -68,6 +68,11 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
     {
         throw new \BadMethodCallException('This method newer should be called.');
     }
+
+    public function getName(): string
+    {
+        return sprintf('dummy://local');
+    }
 }
 
 class DummyTransportFactory implements Transport\TransportFactoryInterface
diff --git a/src/Symfony/Component/Mailer/Transport/AbstractTransport.php b/src/Symfony/Component/Mailer/Transport/AbstractTransport.php
@@ -39,6 +39,8 @@ public function __construct(EventDispatcherInterface $dispatcher = null, LoggerI
         $this->logger = $logger ?: new NullLogger();
     }
 
+    abstract public function getName(): string;
+
     /**
      * Sets the maximum number of messages to send per second (0 to disable).
      */
diff --git a/src/Symfony/Component/Mailer/Transport/FailoverTransport.php b/src/Symfony/Component/Mailer/Transport/FailoverTransport.php
@@ -28,4 +28,9 @@ protected function getNextTransport(): ?TransportInterface
 
         return $this->currentTransport;
     }
+
+    protected function getNameSymbol(): string
+    {
+        return '||';
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Transport/NullTransport.php b/src/Symfony/Component/Mailer/Transport/NullTransport.php
@@ -23,4 +23,9 @@ final class NullTransport extends AbstractTransport
     protected function doSend(SentMessage $message): void
     {
     }
+
+    public function getName(): string
+    {
+        return 'smtp://null';
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php b/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php
@@ -56,6 +56,13 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         throw new TransportException('All transports failed.');
     }
 
+    public function getName(): string
+    {
+        return implode(' '.$this->getNameSymbol().' ', array_map(function (TransportInterface $transport) {
+            return $transport->getName();
+        }, $this->transports));
+    }
+
     /**
      * Rotates the transport list around and returns the first instance.
      */
@@ -90,6 +97,11 @@ protected function isTransportDead(TransportInterface $transport): bool
         return $this->deadTransports->contains($transport);
     }
 
+    protected function getNameSymbol(): string
+    {
+        return '&&';
+    }
+
     private function moveCursor(int $cursor): int
     {
         return ++$cursor >= \count($this->transports) ? 0 : $cursor;
diff --git a/src/Symfony/Component/Mailer/Transport/SendmailTransport.php b/src/Symfony/Component/Mailer/Transport/SendmailTransport.php
@@ -73,6 +73,11 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         return parent::send($message, $envelope);
     }
 
+    public function getName(): string
+    {
+        return $this->transport->getName();
+    }
+
     protected function doSend(SentMessage $message): void
     {
         $this->getLogger()->debug(sprintf('Email transport "%s" starting', __CLASS__));
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php b/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php
@@ -126,6 +126,15 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         return $message;
     }
 
+    public function getName(): string
+    {
+        if ($this->stream instanceof SocketStream) {
+            return sprintf('smtp://%s:%d', $this->stream->getHost(), $this->stream->getPort());
+        }
+
+        return sprintf('smtp://sendmail');
+    }
+
     /**
      * Runs a command against the stream, expecting the given response codes.
      *
diff --git a/src/Symfony/Component/Mailer/Transport/TransportInterface.php b/src/Symfony/Component/Mailer/Transport/TransportInterface.php
@@ -30,4 +30,6 @@ interface TransportInterface
      * @throws TransportExceptionInterface
      */
     public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentMessage;
+
+    public function getName(): string;
 }

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,11 @@ public function __construct(EventDispatcherInterface $eventDispatcher, LoggerInt`
`42`	`42`	`$this->onDoSend = $onDoSend;`
`43`	`43`	`}`
`44`	`44`
	`45`	`+ public function getName(): string`
	`46`	`+ {`
	`47`	`+ return 'dummy://local';`
	`48`	`+ }`
	`49`	`+`
`45`	`50`	`protected function doSend(SentMessage $message): void`
`46`	`51`	`{`
`47`	`52`	`$onDoSend = $this->onDoSend;`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@ public function __construct(string $accessKey, string $secretKey, string $region`
`43`	`43`	`parent::__construct($client, $dispatcher, $logger);`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ public function getName(): string`
	`47`	`+ {`
	`48`	`+ return sprintf('api://%s@ses?region=%s', $this->accessKey, $this->region);`
	`49`	`+ }`
	`50`	`+`
`46`	`51`	`protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface`
`47`	`52`	`{`
`48`	`53`	`$date = gmdate('D, d M Y H:i:s e');`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,11 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve`
`36`	`36`	`parent::__construct($client, $dispatcher, $logger);`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ public function getName(): string`
	`40`	`+ {`
	`41`	`+ return sprintf('api://mandrill');`
	`42`	`+ }`
	`43`	`+`
`39`	`44`	`protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface`
`40`	`45`	`{`
`41`	`46`	`$response = $this->client->request('POST', self::ENDPOINT, [`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,11 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve`
`34`	`34`	`parent::__construct($client, $dispatcher, $logger);`
`35`	`35`	`}`
`36`	`36`
	`37`	`+ public function getName(): string`
	`38`	`+ {`
	`39`	`+ return sprintf('http://mandrill');`
	`40`	`+ }`
	`41`	`+`
`37`	`42`	`protected function doSendHttp(SentMessage $message): ResponseInterface`
`38`	`43`	`{`
`39`	`44`	`$envelope = $message->getEnvelope();`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,11 @@ public function __construct(string $key, string $domain, string $region = null,`
`41`	`41`	`parent::__construct($client, $dispatcher, $logger);`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ public function getName(): string`
	`45`	`+ {`
	`46`	`+ return sprintf('api://%s@mailgun?region=%s', $this->domain, $this->region);`
	`47`	`+ }`
	`48`	`+`
`44`	`49`	`protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface`
`45`	`50`	`{`
`46`	`51`	`$body = new FormDataPart($this->getPayload($email, $envelope));`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,11 @@ public function __construct(string $key, string $domain, string $region = null,`
`40`	`40`	`parent::__construct($client, $dispatcher, $logger);`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ public function getName(): string`
	`44`	`+ {`
	`45`	`+ return sprintf('http://%s@mailgun?region=%s', $this->domain, $this->region);`
	`46`	`+ }`
	`47`	`+`
`43`	`48`	`protected function doSendHttp(SentMessage $message): ResponseInterface`
`44`	`49`	`{`
`45`	`50`	`$body = new FormDataPart([`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,11 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve`
`37`	`37`	`parent::__construct($client, $dispatcher, $logger);`
`38`	`38`	`}`
`39`	`39`
	`40`	`+ public function getName(): string`
	`41`	`+ {`
	`42`	`+ return sprintf('api://sendgrid');`
	`43`	`+ }`
	`44`	`+`
`40`	`45`	`protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface`
`41`	`46`	`{`
`42`	`47`	`$response = $this->client->request('POST', self::ENDPOINT, [`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,9 @@ public function testCreate(Dsn $dsn, TransportInterface $transport): void`
`69`	`69`	`$factory = $this->getFactory();`
`70`	`70`
`71`	`71`	`$this->assertEquals($transport, $factory->create($dsn));`
	`72`	`+ if ('smtp' !== $dsn->getScheme()) {`
	`73`	`+ $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', $transport->getName());`
	`74`	`+ }`
`72`	`75`	`}`
`73`	`76`
`74`	`77`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,11 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM`
`68`	`68`	`{`
`69`	`69`	`throw new \BadMethodCallException('This method newer should be called.');`
`70`	`70`	`}`
	`71`	`+`
	`72`	`+ public function getName(): string`
	`73`	`+ {`
	`74`	`+ return sprintf('dummy://local');`
	`75`	`+ }`
`71`	`76`	`}`
`72`	`77`
`73`	`78`	`class DummyTransportFactory implements Transport\TransportFactoryInterface`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ public function __construct(EventDispatcherInterface $dispatcher = null, LoggerI`
`39`	`39`	`$this->logger = $logger ?: new NullLogger();`
`40`	`40`	`}`
`41`	`41`
	`42`	`+ abstract public function getName(): string;`
	`43`	`+`
`42`	`44`	`/**`
`43`	`45`	`* Sets the maximum number of messages to send per second (0 to disable).`
`44`	`46`	`*/`