Transactional Messages: Handle New Messages After Handling is Done ¶

A message handler can dispatch new messages while handling others, to either the same or a different bus (if the application has multiple buses). Any errors or exceptions that occur during this process can have unintended consequences, such as:

メッセージハンドラーは、他のメッセージを処理しながら、新しいメッセージを同じバスまたは別のバス (アプリケーションに複数のバスがある場合) にディスパッチできます。このプロセス中にエラーや例外が発生すると、次のような予期しない結果が生じる可能性があります。

If using the DoctrineTransactionMiddleware and a dispatched message throws an exception, then any database transactions in the original handler will be rolled back.
DoctrineTransactionMiddleware を使用し、ディスパッチされたメッセージが例外をスローする場合、元のハンドラーのデータベーストランザクションはすべてロールバックされます。
If the message is dispatched to a different bus, then the dispatched message will be handled even if some code later in the current handler throws an exception.
メッセージが別のバスにディスパッチされた場合、現在のハンドラーの後のコードが例外をスローしたとしても、ディスパッチされたメッセージは処理されます。

An Example `RegisterUser` Process ¶

Let's take the example of an application with both a command and an event bus. The application dispatches a command named RegisterUser to the command bus. The command is handled by the RegisterUserHandler which creates a User object, stores that object to a database and dispatches a UserRegistered message to the event bus.

コマンドとイベントバスの両方を持つアプリケーションの例を見てみましょう。アプリケーションは、RegisterUser という名前のコマンドをコマンドバスにディスパッチします。このコマンドは、User オブジェクトを作成し、そのオブジェクトをデータベースに格納し、UserRegistered メッセージをイベントバスにディスパッチする RegisterUserHandler によって処理されます。

There are many handlers to the UserRegistered message, one handler may send a welcome email to the new user. We are using the DoctrineTransactionMiddleware to wrap all database queries in one database transaction.

UserRegistered メッセージには多くのハンドラーがあり、1 つのハンドラーが新しいユーザーにウェルカムメールを送信する場合があります。 DoctrineTransactionMiddleware を使用して、すべてのデータベースクエリを 1 つのデータベーストランザクションにラップします。

Problem 1: If an exception is thrown when sending the welcome email, then the user will not be created because the DoctrineTransactionMiddleware will rollback the Doctrine transaction, in which the user has been created.

問題 1: ウェルカムメールの送信時に例外がスローされた場合、DoctrineTransactionMiddleware がユーザーが作成された Doctrine トランザクションをロールバックするため、ユーザーは作成されません。

Problem 2: If an exception is thrown when saving the user to the database, the welcome email is still sent because it is handled asynchronously.

問題 2: ユーザーをデータベースに保存するときに例外がスローされた場合でも、ウェルカムメールは非同期で処理されるため送信されます。

DispatchAfterCurrentBusMiddleware Middleware ¶

For many applications, the desired behavior is to only handle messages that are dispatched by a handler once that handler has fully finished. This can be done by using the DispatchAfterCurrentBusMiddleware and adding a DispatchAfterCurrentBusStamp stamp to the message Envelope:

多くのアプリケーションでは、ハンドラーが完全に終了した後にハンドラーによってディスパッチされたメッセージのみを処理することが望ましい動作です。これは、DispatchAfterCurrentBusMiddleware を使用し、DispatchAfterCurrentBusStamp スタンプをメッセージエンベロープに追加することで実行できます。

    
        
                
                
                        // src/Messenger/CommandHandler/RegisterUserHandler.php
namespace App\Messenger\CommandHandler;

use App\Entity\User;
use App\Messenger\Command\RegisterUser;
use App\Messenger\Event\UserRegistered;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Messenger\Envelope;
use Symfony\Component\Messenger\MessageBusInterface;
use Symfony\Component\Messenger\Stamp\DispatchAfterCurrentBusStamp;

class RegisterUserHandler
{
    private $eventBus;
    private $em;

    public function __construct(MessageBusInterface $eventBus, EntityManagerInterface $em)
    {
        $this->eventBus = $eventBus;
        $this->em = $em;
    }

    public function __invoke(RegisterUser $command)
    {
        $user = new User($command->getUuid(), $command->getName(), $command->getEmail());
        $this->em->persist($user);

        // The DispatchAfterCurrentBusStamp marks the event message to be handled
        // only if this handler does not throw an exception.

        $event = new UserRegistered($command->getUuid());
        $this->eventBus->dispatch(
            (new Envelope($event))
                ->with(new DispatchAfterCurrentBusStamp())
        );

        // ...
    }
}
                    

            

    

    
        
                
                
                        // src/Messenger/EventSubscriber/WhenUserRegisteredThenSendWelcomeEmail.php
namespace App\Messenger\EventSubscriber;

use App\Entity\User;
use App\Messenger\Event\UserRegistered;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mime\RawMessage;

class WhenUserRegisteredThenSendWelcomeEmail
{
    private $mailer;
    private $em;

    public function __construct(MailerInterface $mailer, EntityManagerInterface $em)
    {
        $this->mailer = $mailer;
        $this->em = $em;
    }

    public function __invoke(UserRegistered $event)
    {
        $user = $this->em->getRepository(User::class)->find($event->getUuid());

        $this->mailer->send(new RawMessage('Welcome '.$user->getFirstName()));
    }
}
                    

            

    

This means that the UserRegistered message would not be handled until after the RegisterUserHandler had completed and the new User was persisted to the database. If the RegisterUserHandler encounters an exception, the UserRegistered event will never be handled. And if an exception is thrown while sending the welcome email, the Doctrine transaction will not be rolled back.

これは、UserRegistered メッセージは、RegisterUserHandler が完了し、新しいユーザーがデータベースに保持されるまで処理されないことを意味します。 RegisterUserHandler で例外が発生した場合、UserRegistered イベントは処理されません。また、ようこそメールの送信中に例外がスローされた場合、Doctrine トランザクションはロールバックされません。

Note

ノート

If WhenUserRegisteredThenSendWelcomeEmail throws an exception, that exception will be wrapped into a DelayedMessageHandlingException. Using DelayedMessageHandlingException::getExceptions will give you all exceptions that are thrown while handling a message with the DispatchAfterCurrentBusStamp.

WhenUserRegisteredThenSendWelcomeEmail が例外をスローした場合、その例外は DelayedMessageHandlingException にラップされます。 DelayedMessageHandlingException::getExceptions を使用すると、DispatchAfterCurrentBusStamp でメッセージを処理しているときにスローされるすべての例外が返されます。

The dispatch_after_current_bus middleware is enabled by default. If you're configuring your middleware manually, be sure to register dispatch_after_current_bus before doctrine_transaction in the middleware chain. Also, the dispatch_after_current_bus middleware must be loaded for all of the buses being used.

dispatch_after_current_bus ミドルウェアはデフォルトで有効になっています。ミドルウェアを手動で再構成する場合は、必ずミドルウェアチェーンの doctrine_transaction の前にdispatch_after_current_bus を登録してください。また、dispatch_after_current_bus ミドルウェアは、使用されているすべてのバスに対してロードする必要があります。

Transactional Messages: Handle New Messages After Handling is Done ¶

An Example RegisterUser Process ¶

DispatchAfterCurrentBusMiddleware Middleware ¶

An Example `RegisterUser` Process ¶