[Mailer] Fix BC breaking event name change

Author: chalasr

src/Symfony/Component/Mailer/Event/MessageEvent.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\Mailer\Event;
 
 use Symfony\Component\Mailer\Envelope;
+use Symfony\Component\Messenger\Stamp\StampInterface;
 use Symfony\Component\Mime\RawMessage;
 use Symfony\Contracts\EventDispatcher\Event;
 
@@ -20,13 +21,16 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class MessageEvent extends Event
+final class MessageEvent extends Event
 {
     private RawMessage $message;
     private Envelope $envelope;
     private string $transport;
     private bool $queued;
 
+    /** @var StampInterface[] */
+    private array $stamps = [];
+
     public function __construct(RawMessage $message, Envelope $envelope, string $transport, bool $queued = false)
     {
         $this->message = $message;
@@ -64,4 +68,17 @@ public function isQueued(): bool
     {
         return $this->queued;
     }
+
+    public function addStamp(StampInterface $stamp): void
+    {
+        $this->stamps[] = $stamp;
+    }
+
+    /**
+     * @return StampInterface[]
+     */
+    public function getStamps(): array
+    {
+        return $this->stamps;
+    }
 }

src/Symfony/Component/Mailer/Event/QueuingMessageEvent.php

@@ -14,7 +14,6 @@
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\Event\MessageEvents;
-use Symfony\Component\Mailer\Event\QueuingMessageEvent;
 use Symfony\Contracts\Service\ResetInterface;
 
 /**
@@ -50,7 +49,7 @@ public static function getSubscribedEvents(): array
     {
         return [
             MessageEvent::class => ['onMessage', -255],
-            QueuingMessageEvent::class => ['onMessage', -255],
+            MessageEvent::class => ['onMessage', -255],
         ];
     }
 }

src/Symfony/Component/Mailer/EventListener/MessageLoggerListener.php

@@ -12,7 +12,7 @@
 namespace Symfony\Component\Mailer\EventListener;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\Mailer\Event\QueuingMessageEvent;
+use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Messenger\Stamp\TransportNamesStamp;
 use Symfony\Component\Mime\Message;
 
@@ -23,7 +23,7 @@
  */
 final class MessengerTransportListener implements EventSubscriberInterface
 {
-    public function onMessage(QueuingMessageEvent $event): void
+    public function onMessage(MessageEvent $event): void
     {
         $message = $event->getMessage();
         if (!$message instanceof Message || !$message->getHeaders()->has('X-Bus-Transport')) {
@@ -39,7 +39,7 @@ public function onMessage(QueuingMessageEvent $event): void
     public static function getSubscribedEvents(): array
     {
         return [
-            QueuingMessageEvent::class => 'onMessage',
+            MessageEvent::class => 'onMessage',
         ];
     }
 }

src/Symfony/Component/Mailer/EventListener/MessengerTransportListener.php

@@ -13,7 +13,6 @@
 
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Mailer\Event\MessageEvent;
-use Symfony\Component\Mailer\Event\QueuingMessageEvent;
 use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
 use Symfony\Component\Mailer\Messenger\SendEmailMessage;
 use Symfony\Component\Mailer\Transport\TransportInterface;
@@ -54,7 +53,7 @@ public function send(RawMessage $message, Envelope $envelope = null): void
             // Listeners should act depending on the `$queued` argument of the `MessageEvent` instance.
             $clonedMessage = clone $message;
             $clonedEnvelope = null !== $envelope ? clone $envelope : Envelope::create($clonedMessage);
-            $event = new QueuingMessageEvent($clonedMessage, $clonedEnvelope, (string) $this->transport);
+            $event = new MessageEvent($clonedMessage, $clonedEnvelope, (string) $this->transport);
             $this->dispatcher->dispatch($event);
             $stamps = $event->getStamps();
         }

src/Symfony/Component/Mailer/Mailer.php

@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Mailer\Envelope;
-use Symfony\Component\Mailer\Event\QueuingMessageEvent;
+use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\EventListener\MessengerTransportListener;
 use Symfony\Component\Messenger\Stamp\TransportNamesStamp;
 use Symfony\Component\Mime\Address;
@@ -27,7 +27,7 @@ public function testNoMessengerTransportStampsByDefault()
         $l = new MessengerTransportListener();
         $envelope = new Envelope(new Address('sender@example.com'), [new Address('recipient@example.com')]);
         $message = new Message(new Headers());
-        $event = new QueuingMessageEvent($message, $envelope, 'smtp');
+        $event = new MessageEvent($message, $envelope, 'smtp');
         $l->onMessage($event);
         $this->assertEmpty($event->getStamps());
     }
@@ -38,7 +38,7 @@ public function testMessengerTransportStampViaHeader()
         $envelope = new Envelope(new Address('sender@example.com'), [new Address('recipient@example.com')]);
         $headers = (new Headers())->addTextHeader('X-Bus-Transport', 'async');
         $message = new Message($headers);
-        $event = new QueuingMessageEvent($message, $envelope, 'smtp');
+        $event = new MessageEvent($message, $envelope, 'smtp', true);
         $l->onMessage($event);
         $this->assertCount(1, $event->getStamps());
         /* @var TransportNamesStamp $stamp */
@@ -54,7 +54,7 @@ public function testMessengerTransportStampsViaHeader()
         $name = 'söme_very_long_and_weïrd transport name-for-messenger!';
         $headers = (new Headers())->addTextHeader('X-Bus-Transport', ' async , async1,'.$name);
         $message = new Message($headers);
-        $event = new QueuingMessageEvent($message, $envelope, 'smtp');
+        $event = new MessageEvent($message, $envelope, 'smtp', true);
         $l->onMessage($event);
         $this->assertCount(1, $event->getStamps());
         /* @var TransportNamesStamp $stamp */

src/Symfony/Component/Mailer/Tests/EventListener/MessengerTransportListenerTest.php

@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\Mailer\Event\QueuingMessageEvent;
+use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\Exception\LogicException;
 use Symfony\Component\Mailer\Mailer;
 use Symfony\Component\Mailer\Transport\NullTransport;
@@ -54,7 +54,7 @@ public function dispatch($message, array $stamps = []): Envelope
         $dispatcher = $this->createMock(EventDispatcherInterface::class);
         $dispatcher->expects($this->once())
             ->method('dispatch')
-            ->with(self::callback(static function (QueuingMessageEvent $event) use ($stamp) {
+            ->with(self::callback(static function (MessageEvent $event) use ($stamp) {
                 $event->addStamp($stamp);
 
                 return 'Time for Symfony Mailer!' === $event->getMessage()->getSubject();