|
| 1 | +<?php |
| 2 | + |
| 3 | +/* |
| 4 | + * This file is part of the Symfony package. |
| 5 | + * |
| 6 | + * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | + * |
| 8 | + * For the full copyright and license information, please view the LICENSE |
| 9 | + * file that was distributed with this source code. |
| 10 | + */ |
| 11 | + |
| 12 | +namespace Symfony\Component\Messenger\Tests\Middleware; |
| 13 | + |
| 14 | +use PHPUnit\Framework\MockObject\MockObject; |
| 15 | +use PHPUnit\Framework\TestCase; |
| 16 | +use Symfony\Component\Messenger\Envelope; |
| 17 | +use Symfony\Component\Messenger\Exception\QueuedMessageHandlingException; |
| 18 | +use Symfony\Component\Messenger\MessageBus; |
| 19 | +use Symfony\Component\Messenger\MessageBusInterface; |
| 20 | +use Symfony\Component\Messenger\Middleware\HandleMessageInNewTransactionMiddleware; |
| 21 | +use Symfony\Component\Messenger\Middleware\MiddlewareInterface; |
| 22 | +use Symfony\Component\Messenger\Middleware\StackInterface; |
| 23 | +use Symfony\Component\Messenger\Stamp\Transaction; |
| 24 | +use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage; |
| 25 | + |
| 26 | +class HandleMessageInNewTransactionMiddlewareTest extends TestCase |
| 27 | +{ |
| 28 | + public function testEventsInNewTransactionAreHandledAfterMainMessage() |
| 29 | + { |
| 30 | + $message = new DummyMessage('Hello'); |
| 31 | + |
| 32 | + $firstEvent = new DummyEvent('First event'); |
| 33 | + $secondEvent = new DummyEvent('Second event'); |
| 34 | + $thirdEvent = new DummyEvent('Third event'); |
| 35 | + |
| 36 | + $transactionMiddleware = new HandleMessageInNewTransactionMiddleware(); |
| 37 | + $handlingMiddleware = $this->createMock(MiddlewareInterface::class); |
| 38 | + |
| 39 | + $eventBus = new MessageBus(array( |
| 40 | + $transactionMiddleware, |
| 41 | + $handlingMiddleware, |
| 42 | + )); |
| 43 | + |
| 44 | + $messageBus = new MessageBus(array( |
| 45 | + $transactionMiddleware, |
| 46 | + new DispatchingMiddleware($eventBus, array( |
| 47 | + new Envelope($firstEvent, new Transaction()), |
| 48 | + new Envelope($secondEvent, new Transaction()), |
| 49 | + $thirdEvent, // Not in a new transaction |
| 50 | + )), |
| 51 | + $handlingMiddleware, |
| 52 | + )); |
| 53 | + |
| 54 | + // Third event is dispatch within main dispatch, but before its handling: |
| 55 | + $this->expectHandledMessage($handlingMiddleware, 0, $thirdEvent); |
| 56 | + // Then expect main dispatched message to be handled first: |
| 57 | + $this->expectHandledMessage($handlingMiddleware, 1, $message); |
| 58 | + // Then, expect events in new transaction to be handled next, in dispatched order: |
| 59 | + $this->expectHandledMessage($handlingMiddleware, 2, $firstEvent); |
| 60 | + $this->expectHandledMessage($handlingMiddleware, 3, $secondEvent); |
| 61 | + |
| 62 | + $messageBus->dispatch($message); |
| 63 | + } |
| 64 | + |
| 65 | + public function testThrowingEventsHandlingWontStopExecution() |
| 66 | + { |
| 67 | + $message = new DummyMessage('Hello'); |
| 68 | + |
| 69 | + $firstEvent = new DummyEvent('First event'); |
| 70 | + $secondEvent = new DummyEvent('Second event'); |
| 71 | + |
| 72 | + $transactionMiddleware = new HandleMessageInNewTransactionMiddleware(); |
| 73 | + $handlingMiddleware = $this->createMock(MiddlewareInterface::class); |
| 74 | + |
| 75 | + $eventBus = new MessageBus(array( |
| 76 | + $transactionMiddleware, |
| 77 | + $handlingMiddleware, |
| 78 | + )); |
| 79 | + |
| 80 | + $messageBus = new MessageBus(array( |
| 81 | + $transactionMiddleware, |
| 82 | + new DispatchingMiddleware($eventBus, array( |
| 83 | + new Envelope($firstEvent, new Transaction()), |
| 84 | + new Envelope($secondEvent, new Transaction()), |
| 85 | + )), |
| 86 | + $handlingMiddleware, |
| 87 | + )); |
| 88 | + |
| 89 | + // Expect main dispatched message to be handled first: |
| 90 | + $this->expectHandledMessage($handlingMiddleware, 0, $message); |
| 91 | + // Then, expect events in new transaction to be handled next, in dispatched order: |
| 92 | + $this->expectThrowingHandling($handlingMiddleware, 1, $firstEvent, new \RuntimeException('Some exception while handling first event')); |
| 93 | + // Next event is still handled despite the previous exception: |
| 94 | + $this->expectHandledMessage($handlingMiddleware, 2, $secondEvent); |
| 95 | + |
| 96 | + $this->expectException(QueuedMessageHandlingException::class); |
| 97 | + $this->expectExceptionMessage('RuntimeException: Some exception while handling first event'); |
| 98 | + |
| 99 | + $messageBus->dispatch($message); |
| 100 | + } |
| 101 | + |
| 102 | + /** |
| 103 | + * @param MiddlewareInterface|MockObject $handlingMiddleware |
| 104 | + */ |
| 105 | + private function expectHandledMessage(MiddlewareInterface $handlingMiddleware, int $at, $message): void |
| 106 | + { |
| 107 | + $handlingMiddleware->expects($this->at($at))->method('handle')->with($this->callback(function (Envelope $envelope) use ($message) { |
| 108 | + return $envelope->getMessage() === $message; |
| 109 | + }))->willReturnCallback(function($envelope, StackInterface $stack) { |
| 110 | + return $stack->next()->handle($envelope, $stack); |
| 111 | + }); |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * @param MiddlewareInterface|MockObject $handlingMiddleware |
| 116 | + */ |
| 117 | + private function expectThrowingHandling(MiddlewareInterface $handlingMiddleware, int $at, $message, \Throwable $throwable): void |
| 118 | + { |
| 119 | + $handlingMiddleware->expects($this->at($at))->method('handle')->with($this->callback(function (Envelope $envelope) use ($message) { |
| 120 | + return $envelope->getMessage() === $message; |
| 121 | + }))->willReturnCallback(function() use ($throwable) { |
| 122 | + throw $throwable; |
| 123 | + }); |
| 124 | + } |
| 125 | +} |
| 126 | + |
| 127 | +class DummyEvent |
| 128 | +{ |
| 129 | + private $message; |
| 130 | + |
| 131 | + public function __construct(string $message) |
| 132 | + { |
| 133 | + $this->message = $message; |
| 134 | + } |
| 135 | + |
| 136 | + public function getMessage(): string |
| 137 | + { |
| 138 | + return $this->message; |
| 139 | + } |
| 140 | +} |
| 141 | + |
| 142 | +class DispatchingMiddleware implements MiddlewareInterface |
| 143 | +{ |
| 144 | + private $bus; |
| 145 | + private $messages; |
| 146 | + |
| 147 | + public function __construct(MessageBusInterface $bus, array $messages) |
| 148 | + { |
| 149 | + $this->bus = $bus; |
| 150 | + $this->messages = $messages; |
| 151 | + } |
| 152 | + |
| 153 | + public function handle(Envelope $envelope, StackInterface $stack): Envelope |
| 154 | + { |
| 155 | + foreach ($this->messages as $event) { |
| 156 | + $this->bus->dispatch($event); |
| 157 | + } |
| 158 | + |
| 159 | + return $stack->next()->handle($envelope, $stack); |
| 160 | + } |
| 161 | +} |
0 commit comments