-
Notifications
You must be signed in to change notification settings - Fork 0
/
HandleMessageInNewTransactionMiddleware.php
127 lines (109 loc) · 3.98 KB
/
HandleMessageInNewTransactionMiddleware.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Lib\Messenger\Middleware;
use Symfony\Component\Messenger\Envelope;
use App\Lib\Messenger\Exception\QueuedMessageHandlingException;
use App\Lib\Messenger\Stamp\Transaction;
use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
use Symfony\Component\Messenger\Middleware\StackInterface;
/**
* Allow to configure messages to be handled in a new transaction.
* I.e, messages dispatched from a handler with a Transaction stamp will actually be handled
* once the current message being dispatched is fully handled or sent.
*
* For instance, using this middleware before the DoctrineTransactionMiddleware
* means sub-dispatched messages with a Transaction item would be handled after
* the Doctrine transaction has been committed.
*
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
*/
class HandleMessageInNewTransactionMiddleware implements MiddlewareInterface
{
/**
* @var QueuedEnvelope[] A queue of messages and next middleware
*/
private $queue = [];
/**
* @var bool Indicates if we are running the middleware or not. I.e, are we called during a dispatch?
*/
private $isRunning = false;
public function handle(Envelope $envelope, StackInterface $stack): Envelope
{
if (null !== $envelope->last(Transaction::class)) {
if (!$this->isRunning) {
throw new \LogicException(sprintf('You can only use a "%s" stamp to define a new transaction in the context of a message handling.', Transaction::class));
}
$this->queue[] = new QueuedEnvelope($envelope, $stack);
return $envelope;
}
if ($this->isRunning) {
/*
* If come inside a second dispatch, just continue as normal.
* We should not run the stored messages until first call is finished.
*/
return $stack->next()->handle($envelope, $stack);
}
// First time we get here, mark as inside a root dispatch call:
$this->isRunning = true;
try {
// Execute the whole middleware stack & message handling for main dispatch:
$returnedEnvelope = $stack->next()->handle($envelope, $stack);
} catch (\Throwable $exception) {
/*
* Whenever an exception occurs while handling a message that has
* queued other messages, we drop the queued ones.
* This is intentional since the queued commands were likely dependent
* on the preceding command.
*/
$this->queue = [];
$this->isRunning = false;
throw $exception;
}
// Root dispatch call is finished, dispatch stored ones for real:
$exceptions = [];
while (null !== $queueItem = array_shift($this->queue)) {
try {
// Execute the stored messages
$queueItem->getStack()->next()->handle($queueItem->getEnvelope(), $queueItem->getStack());
} catch (\Throwable $exception) {
// Gather all exceptions
$exceptions[] = $exception;
}
}
$this->isRunning = false;
if (\count($exceptions) > 0) {
throw new QueuedMessageHandlingException($exceptions);
}
return $returnedEnvelope;
}
}
/**
* @internal
*/
final class QueuedEnvelope
{
/** @var Envelope */
private $envelope;
/** @var StackInterface */
private $stack;
public function __construct(Envelope $envelope, StackInterface $stack)
{
$this->envelope = $envelope;
$this->stack = $stack;
}
public function getEnvelope(): Envelope
{
return $this->envelope;
}
public function getStack(): StackInterface
{
return $this->stack;
}
}