Merge branch '5.4' into 6.0

* 5.4:
  [Notifier] fix firebase error handling so the transports doesn't try setting the success message, that doesn't exists.
  Remove wrong dep
  [Translation] Fix message key handling for the Localise provider
  [Serializer] Deprecate support for returning empty, iterable, countable, raw object when normalizing
  Fix ProgressBar to correctly clear multi-line formats
  [Mailer] Consume a PSR-14 event dispatcher
  Ignoring X-Transport header while signing email with DKIM
  Remove polyfills from ExpressionLanguage
  Update validators.tr.xlf
  [Form] fix typo in Danish translation
  [HttpKernel] Fix timestamp_rfc3339 in LoggerDataCollector
  Remove broken test case
  [PropertyInfo] Support for the never return type
  Show nice CLI output in Psalm action
  add more explicit error

Signed-off-by: Alexander M. Turek <me@derrabus.de>

Author: derrabus

CHANGELOG.md

@@ -6,6 +6,11 @@ CHANGELOG
 
  * The `HttpTransportException` class takes a string at first argument
 
+5.4
+---
+
+ * Enable the mailer to operate on any PSR-14-compatible event dispatcher
+
 5.3
 ---
 

Mailer.php

@@ -11,12 +11,12 @@
 
 namespace Symfony\Component\Mailer;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\Messenger\SendEmailMessage;
 use Symfony\Component\Mailer\Transport\TransportInterface;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Mime\RawMessage;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>

Tests/EventListener/MessageListenerTest.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Mailer\Tests;
+namespace Symfony\Component\Mailer\Tests\EventListener;
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Envelope;

Tests/MailerTest.php

@@ -12,12 +12,16 @@
 namespace Symfony\Component\Mailer\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Psr\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\Exception\LogicException;
 use Symfony\Component\Mailer\Mailer;
+use Symfony\Component\Mailer\Transport\NullTransport;
 use Symfony\Component\Mailer\Transport\TransportInterface;
+use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Mime\Email;
 use Symfony\Component\Mime\RawMessage;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 class MailerTest extends TestCase
 {
@@ -28,4 +32,41 @@ public function testSendingRawMessages()
         $transport = new Mailer($this->createMock(TransportInterface::class), $this->createMock(MessageBusInterface::class), $this->createMock(EventDispatcherInterface::class));
         $transport->send(new RawMessage('Some raw email message'));
     }
+
+    public function testSendMessageToBus()
+    {
+        $bus = new class() implements MessageBusInterface {
+            public $messages = [];
+
+            public function dispatch($message, array $stamps = []): Envelope
+            {
+                $this->messages[] = $message;
+
+                return new Envelope($message, $stamps);
+            }
+        };
+
+        $dispatcher = $this->createMock(EventDispatcherInterface::class);
+        $dispatcher->expects($this->once())
+            ->method('dispatch')
+            ->with(self::callback(static function (MessageEvent $event) {
+                return 'Time for Symfony Mailer!' === $event->getMessage()->getSubject();
+            }))
+            ->willReturnArgument(0)
+        ;
+
+        $mailer = new Mailer(new NullTransport($dispatcher), $bus, $dispatcher);
+
+        $email = (new Email())
+            ->from('hello@example.com')
+            ->to('you@example.com')
+            ->subject('Time for Symfony Mailer!')
+            ->text('Sending emails is fun again!')
+            ->html('<p>See Twig integration for better HTML integration!</p>');
+
+        $mailer->send($email);
+
+        self::assertCount(1, $bus->messages);
+        self::assertSame($email, $bus->messages[0]->getMessage());
+    }
 }

Transport.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Mailer;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\Bridge\Amazon\Transport\SesTransportFactory;
 use Symfony\Component\Mailer\Bridge\Google\Transport\GmailTransportFactory;
@@ -32,12 +33,13 @@
 use Symfony\Component\Mailer\Transport\TransportFactoryInterface;
 use Symfony\Component\Mailer\Transport\TransportInterface;
 use Symfony\Component\Mailer\Transport\Transports;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Konstantin Myakshin <molodchick@gmail.com>
+ *
+ * @final since Symfony 5.4
  */
 class Transport
 {
@@ -54,15 +56,33 @@ class Transport
 
     private $factories;
 
-    public static function fromDsn(string $dsn, EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null): TransportInterface
+    /**
+     * @param EventDispatcherInterface|null $dispatcher
+     * @param HttpClientInterface|null      $client
+     * @param LoggerInterface|null          $logger
+     */
+    public static function fromDsn(string $dsn/*, EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null*/): TransportInterface
     {
+        $dispatcher = 2 <= \func_num_args() ? func_get_arg(1) : null;
+        $client = 3 <= \func_num_args() ? func_get_arg(2) : null;
+        $logger = 4 <= \func_num_args() ? func_get_arg(3) : null;
+
         $factory = new self(iterator_to_array(self::getDefaultFactories($dispatcher, $client, $logger)));
 
         return $factory->fromString($dsn);
     }
 
-    public static function fromDsns(array $dsns, EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null): TransportInterface
+    /**
+     * @param EventDispatcherInterface|null $dispatcher
+     * @param HttpClientInterface|null      $client
+     * @param LoggerInterface|null          $logger
+     */
+    public static function fromDsns(array $dsns/*, EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null*/): TransportInterface
     {
+        $dispatcher = 2 <= \func_num_args() ? func_get_arg(1) : null;
+        $client = 3 <= \func_num_args() ? func_get_arg(2) : null;
+        $logger = 4 <= \func_num_args() ? func_get_arg(3) : null;
+
         $factory = new self(iterator_to_array(self::getDefaultFactories($dispatcher, $client, $logger)));
 
         return $factory->fromStrings($dsns);
@@ -154,8 +174,19 @@ public function fromDsnObject(Dsn $dsn): TransportInterface
         throw new UnsupportedSchemeException($dsn);
     }
 
-    public static function getDefaultFactories(EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null): iterable
+    /**
+     * @param EventDispatcherInterface|null $dispatcher
+     * @param HttpClientInterface|null      $client
+     * @param LoggerInterface|null          $logger
+     *
+     * @return \Traversable<int, TransportFactoryInterface>
+     */
+    public static function getDefaultFactories(/*EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null*/): iterable
     {
+        $dispatcher = 1 <= \func_num_args() ? func_get_arg(0) : null;
+        $client = 2 <= \func_num_args() ? func_get_arg(1) : null;
+        $logger = 3 <= \func_num_args() ? func_get_arg(2) : null;
+
         foreach (self::FACTORY_CLASSES as $factoryClass) {
             if (class_exists($factoryClass)) {
                 yield new $factoryClass($dispatcher, $client, $logger);

Transport/AbstractHttpTransport.php

@@ -11,11 +11,11 @@
 
 namespace Symfony\Component\Mailer\Transport;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\Mailer\Exception\HttpTransportException;
 use Symfony\Component\Mailer\SentMessage;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 

Transport/AbstractTransport.php

@@ -11,14 +11,14 @@
 
 namespace Symfony\Component\Mailer\Transport;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\SentMessage;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\RawMessage;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>

Transport/AbstractTransportFactory.php

@@ -11,9 +11,9 @@
 
 namespace Symfony\Component\Mailer\Transport;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\Exception\IncompleteDsnException;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**

Transport/SendmailTransport.php

@@ -11,14 +11,14 @@
 
 namespace Symfony\Component\Mailer\Transport;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mailer\SentMessage;
 use Symfony\Component\Mailer\Transport\Smtp\SmtpTransport;
 use Symfony\Component\Mailer\Transport\Smtp\Stream\AbstractStream;
 use Symfony\Component\Mailer\Transport\Smtp\Stream\ProcessStream;
 use Symfony\Component\Mime\RawMessage;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * SendmailTransport for sending mail through a Sendmail/Postfix (etc..) binary.

Transport/Smtp/EsmtpTransport.php

@@ -11,12 +11,12 @@
 
 namespace Symfony\Component\Mailer\Transport\Smtp;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\Exception\TransportException;
 use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
 use Symfony\Component\Mailer\Transport\Smtp\Auth\AuthenticatorInterface;
 use Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
  * Sends Emails over SMTP with ESMTP support.