Skip to content

[Mailer] Fix BC breaking event name change #47992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion src/Symfony/Component/Mailer/Event/MessageEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
namespace Symfony\Component\Mailer\Event;

use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Exception\LogicException;
use Symfony\Component\Messenger\Stamp\StampInterface;
use Symfony\Component\Mime\RawMessage;
use Symfony\Contracts\EventDispatcher\Event;

Expand All @@ -20,13 +22,16 @@
*
* @author Fabien Potencier <[email protected]>
*/
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;
Expand Down Expand Up @@ -64,4 +69,25 @@ public function isQueued(): bool
{
return $this->queued;
}

public function addStamp(StampInterface $stamp): void
{
if (!$this->queued) {
throw new LogicException(sprintf('Cannot call "%s()" on a message that is not meant to be queued', __METHOD__));
}

$this->stamps[] = $stamp;
}

/**
* @return StampInterface[]
*/
public function getStamps(): array
{
if (!$this->queued) {
throw new LogicException(sprintf('Cannot call "%s()" on a message that is not meant to be queued.', __METHOD__));
}

return $this->stamps;
}
}
45 changes: 0 additions & 45 deletions src/Symfony/Component/Mailer/Event/QueuingMessageEvent.php

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand Down Expand Up @@ -50,7 +49,6 @@ public static function getSubscribedEvents(): array
{
return [
MessageEvent::class => ['onMessage', -255],
QueuingMessageEvent::class => ['onMessage', -255],
];
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -23,8 +23,12 @@
*/
final class MessengerTransportListener implements EventSubscriberInterface
{
public function onMessage(QueuingMessageEvent $event): void
public function onMessage(MessageEvent $event): void
{
if (!$event->isQueued()) {
return;
}

$message = $event->getMessage();
if (!$message instanceof Message || !$message->getHeaders()->has('X-Bus-Transport')) {
return;
Expand All @@ -39,7 +43,7 @@ public function onMessage(QueuingMessageEvent $event): void
public static function getSubscribedEvents(): array
{
return [
QueuingMessageEvent::class => 'onMessage',
MessageEvent::class => 'onMessage',
];
}
}
3 changes: 1 addition & 2 deletions src/Symfony/Component/Mailer/Mailer.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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, true);
$this->dispatcher->dispatch($event);
$stamps = $event->getStamps();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -27,7 +27,7 @@ public function testNoMessengerTransportStampsByDefault()
$l = new MessengerTransportListener();
$envelope = new Envelope(new Address('[email protected]'), [new Address('[email protected]')]);
$message = new Message(new Headers());
$event = new QueuingMessageEvent($message, $envelope, 'smtp');
$event = new MessageEvent($message, $envelope, 'smtp', true);
$l->onMessage($event);
$this->assertEmpty($event->getStamps());
}
Expand All @@ -38,7 +38,7 @@ public function testMessengerTransportStampViaHeader()
$envelope = new Envelope(new Address('[email protected]'), [new Address('[email protected]')]);
$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 */
Expand All @@ -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 */
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Mailer/Tests/MailerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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();
Expand Down