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

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     <!-- see https://symfony.com/bc -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tests pass?   | yes    <!-- please add some, will be required by reviewers -->
| 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
-------

2412dfe71f [Mailer] added a name to the transport

Author: fabpot

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).
      */

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');

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');

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`.

FailoverTransport.php

@@ -28,4 +28,9 @@ protected function getNextTransport(): ?TransportInterface
 
         return $this->currentTransport;
     }
+
+    protected function getNameSymbol(): string
+    {
+        return '||';
+    }
 }

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);

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, [

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();

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));

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([