|
| 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 | +namespaceSymfony\Component\Messenger\Bridge\Amqp\Tests\Transport; |
| 13 | + |
| 14 | +usePHPUnit\Framework\TestCase; |
| 15 | +usePsr\Container\ContainerInterface; |
| 16 | +useSymfony\Component\DependencyInjection\ServiceLocator; |
| 17 | +useSymfony\Component\EventDispatcher\EventDispatcher; |
| 18 | +useSymfony\Component\Messenger\Bridge\Amqp\Tests\Fixtures\DummyMessage; |
| 19 | +useSymfony\Component\Messenger\Bridge\Amqp\Transport\AmqpTransport; |
| 20 | +useSymfony\Component\Messenger\Bridge\Amqp\Transport\Connection; |
| 21 | +useSymfony\Component\Messenger\Envelope; |
| 22 | +useSymfony\Component\Messenger\EventListener\SendFailedMessageForRetryListener; |
| 23 | +useSymfony\Component\Messenger\EventListener\SendFailedMessageToFailureTransportListener; |
| 24 | +useSymfony\Component\Messenger\EventListener\StopWorkerOnMessageLimitListener; |
| 25 | +useSymfony\Component\Messenger\EventListener\StopWorkerOnTimeLimitListener; |
| 26 | +useSymfony\Component\Messenger\Handler\HandlerDescriptor; |
| 27 | +useSymfony\Component\Messenger\Handler\HandlersLocator; |
| 28 | +useSymfony\Component\Messenger\MessageBus; |
| 29 | +useSymfony\Component\Messenger\Middleware\FailedMessageProcessingMiddleware; |
| 30 | +useSymfony\Component\Messenger\Middleware\HandleMessageMiddleware; |
| 31 | +useSymfony\Component\Messenger\Middleware\SendMessageMiddleware; |
| 32 | +useSymfony\Component\Messenger\Retry\MultiplierRetryStrategy; |
| 33 | +useSymfony\Component\Messenger\Stamp\DelayStamp; |
| 34 | +useSymfony\Component\Messenger\Stamp\RedeliveryStamp; |
| 35 | +useSymfony\Component\Messenger\Stamp\SentToFailureTransportStamp; |
| 36 | +useSymfony\Component\Messenger\Transport\Sender\SendersLocator; |
| 37 | +useSymfony\Component\Messenger\Worker; |
| 38 | + |
| 39 | +/** |
| 40 | + * @requires extension amqp |
| 41 | + * |
| 42 | + * @group integration |
| 43 | + */ |
| 44 | +class FailureTransportIntegrationTestextends TestCase |
| 45 | +{ |
| 46 | +protectedfunctionsetUp():void |
| 47 | + { |
| 48 | +parent::setUp(); |
| 49 | + |
| 50 | +if (!getenv('MESSENGER_AMQP_DSN')) { |
| 51 | +$this->markTestSkipped('The "MESSENGER_AMQP_DSN" environment variable is required.'); |
| 52 | + } |
| 53 | + } |
| 54 | + |
| 55 | +publicfunctiontestItDoesNotLoseMessagesFromTheFailedTransport() |
| 56 | + { |
| 57 | +$connection = Connection::fromDsn(getenv('MESSENGER_AMQP_DSN')); |
| 58 | +$connection->setup(); |
| 59 | +$connection->purgeQueues(); |
| 60 | + |
| 61 | +$failureConnection = Connection::fromDsn(getenv('MESSENGER_AMQP_DSN'), |
| 62 | + ['exchange' => [ |
| 63 | +'name' =>'failed', |
| 64 | +'type' =>'fanout', |
| 65 | + ],'queues' => ['failed' => []]] |
| 66 | + ); |
| 67 | +$failureConnection->setup(); |
| 68 | +$failureConnection->purgeQueues(); |
| 69 | + |
| 70 | +$originalTransport =newAmqpTransport($connection); |
| 71 | +$failureTransport =newAmqpTransport($failureConnection); |
| 72 | + |
| 73 | +$retryStrategy =newMultiplierRetryStrategy(1,100,2); |
| 74 | +$retryStrategyLocator =$this->createStub(ContainerInterface::class); |
| 75 | +$retryStrategyLocator->method('has')->willReturn(true); |
| 76 | +$retryStrategyLocator->method('get')->willReturn($retryStrategy); |
| 77 | + |
| 78 | +$sendersLocatorFailureTransport =newServiceLocator([ |
| 79 | +'original' =>staticfn () =>$failureTransport, |
| 80 | + ]); |
| 81 | + |
| 82 | +$transports = [ |
| 83 | +'original' =>$originalTransport, |
| 84 | +'failed' =>$failureTransport, |
| 85 | + ]; |
| 86 | + |
| 87 | +$locator =$this->createStub(ContainerInterface::class); |
| 88 | +$locator->method('has')->willReturn(true); |
| 89 | +$locator->method('get')->willReturnCallback(staticfn ($transportName) =>$transports[$transportName]); |
| 90 | +$senderLocator =newSendersLocator( |
| 91 | + [DummyMessage::class => ['original']], |
| 92 | +$locator |
| 93 | + ); |
| 94 | + |
| 95 | +$timesHandled =0; |
| 96 | + |
| 97 | +$handler =staticfunction ()use (&$timesHandled) { |
| 98 | + ++$timesHandled; |
| 99 | +thrownew \Exception('Handler failed'); |
| 100 | + }; |
| 101 | + |
| 102 | +$handlerLocator =newHandlersLocator([ |
| 103 | + DummyMessage::class => [newHandlerDescriptor($handler, ['from_transport' =>'original'])], |
| 104 | + ]); |
| 105 | + |
| 106 | +$bus =newMessageBus([ |
| 107 | +newFailedMessageProcessingMiddleware(), |
| 108 | +newSendMessageMiddleware($senderLocator), |
| 109 | +newHandleMessageMiddleware($handlerLocator), |
| 110 | + ]); |
| 111 | + |
| 112 | +$dispatcher =newEventDispatcher(); |
| 113 | +$dispatcher->addSubscriber(newSendFailedMessageForRetryListener($locator,$retryStrategyLocator)); |
| 114 | +$dispatcher->addSubscriber(newSendFailedMessageToFailureTransportListener( |
| 115 | +$sendersLocatorFailureTransport, |
| 116 | +$retryStrategyLocator, |
| 117 | + )); |
| 118 | +$dispatcher->addSubscriber(newStopWorkerOnMessageLimitListener(1)); |
| 119 | +$dispatcher->addSubscriber(newStopWorkerOnTimeLimitListener(2)); |
| 120 | + |
| 121 | +$originalTransport->send(Envelope::wrap(newDummyMessage('dummy'))); |
| 122 | + |
| 123 | +$runWorker =staticfunction (string$transportName)use ($bus,$dispatcher,$transports):void { |
| 124 | + (newWorker( |
| 125 | + [$transportName =>$transports[$transportName]], |
| 126 | +$bus, |
| 127 | +$dispatcher, |
| 128 | + ))->run(); |
| 129 | + }; |
| 130 | + |
| 131 | +$runWorker('original'); |
| 132 | +$runWorker('original'); |
| 133 | +$runWorker('failed'); |
| 134 | +$runWorker('failed'); |
| 135 | + |
| 136 | +$this->assertSame(4,$timesHandled); |
| 137 | +$failedMessage =$this->waitForFailedMessage($failureTransport,2); |
| 138 | +// 100 delay * 2 multiplier ^ 3 retries = 800 expected delay |
| 139 | +$this->assertSame(800,$failedMessage->last(DelayStamp::class)->getDelay()); |
| 140 | +$this->assertSame(0,$failedMessage->last(RedeliveryStamp::class)->getRetryCount()); |
| 141 | +$this->assertCount(4,$failedMessage->all(RedeliveryStamp::class)); |
| 142 | +$this->assertCount(2,$failedMessage->all(SentToFailureTransportStamp::class)); |
| 143 | +foreach ($failedMessage->all(SentToFailureTransportStamp::class)as$stamp) { |
| 144 | +$this->assertSame('original',$stamp->getOriginalReceiverName()); |
| 145 | + } |
| 146 | + } |
| 147 | + |
| 148 | +privatefunctionwaitForFailedMessage(AmqpTransport$failureTransport,int$timeOutInS):Envelope |
| 149 | + { |
| 150 | +$start =microtime(true); |
| 151 | +while (microtime(true) -$start <$timeOutInS) { |
| 152 | +$envelopes =iterator_to_array($failureTransport->get()); |
| 153 | +if (\count($envelopes) >0) { |
| 154 | +foreach ($envelopesas$envelope) { |
| 155 | +$failureTransport->reject($envelope); |
| 156 | + } |
| 157 | + |
| 158 | +return$envelopes[0]; |
| 159 | + } |
| 160 | +usleep(100 *1000); |
| 161 | + } |
| 162 | +thrownew \RuntimeException('Message was not received from failure transport within expected timeframe.'); |
| 163 | + } |
| 164 | +} |