Skip to content

[Messenger ] Extract retry delay from nested RecoverableExceptionInterface #59513

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.

Sign up for GitHub

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
fabpot merged 1 commit into from
Jan 25, 2025
Merged

[Messenger ] Extract retry delay from nested RecoverableExceptionInterface #59513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 25 additions & 6 deletions src/Symfony/Component/Messenger/EventListener/SendFailedMessageForRetryListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,7 @@ public function onMessageFailed(WorkerMessageFailedEvent $event): void

++$retryCount;

$delay = null;
if ($throwable instanceof RecoverableExceptionInterface && method_exists($throwable, 'getRetryDelay')) {
$delay = $throwable->getRetryDelay();
}

$delay ??= $retryStrategy->getWaitingTime($envelope, $throwable);
$delay = $this->getWaitingTime($envelope, $throwable, $retryStrategy);

$this->logger?->warning('Error thrown while handling message {class}. Sending for retry #{retryCount} using {delay} ms delay. Error: "{error}"', $context + ['retryCount' => $retryCount, 'delay' => $delay, 'error' => $throwable->getMessage(), 'exception' => $throwable]);

Expand Down Expand Up @@ -148,6 +143,30 @@ private function shouldRetry(\Throwable $e, Envelope $envelope, RetryStrategyInt
return $retryStrategy->isRetryable($envelope, $e);
}

private function getWaitingTime(Envelope $envelope, \Throwable $throwable, RetryStrategyInterface $retryStrategy): int
{
$delay = null;
if ($throwable instanceof RecoverableExceptionInterface && method_exists($throwable, 'getRetryDelay')) {
$delay = $throwable->getRetryDelay();
}

if ($throwable instanceof HandlerFailedException) {
foreach ($throwable->getWrappedExceptions() as $nestedException) {
if (!$nestedException instanceof RecoverableExceptionInterface
|| !method_exists($nestedException, 'getRetryDelay')
|| 0 > $retryDelay = $nestedException->getRetryDelay() ?? -1
) {
continue;
}
if ($retryDelay < ($delay ?? \PHP_INT_MAX)) {
$delay = $retryDelay;
}
}
}

return $delay ?? $retryStrategy->getWaitingTime($envelope, $throwable);
}

private function getRetryStrategyForTransport(string $alias): ?RetryStrategyInterface
{
if ($this->retryStrategyLocator->has($alias)) {
Expand Down
57 changes: 57 additions & 0 deletions ...Symfony/Component/Messenger/Tests/EventListener/SendFailedMessageForRetryListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
use Symfony\Component\Messenger\Event\WorkerMessageRetriedEvent;
use Symfony\Component\Messenger\EventListener\SendFailedMessageForRetryListener;
use Symfony\Component\Messenger\Exception\HandlerFailedException;
use Symfony\Component\Messenger\Exception\RecoverableMessageHandlingException;
use Symfony\Component\Messenger\Retry\RetryStrategyInterface;
use Symfony\Component\Messenger\Stamp\DelayStamp;
Expand Down Expand Up @@ -108,6 +109,62 @@ public function testRecoverableExceptionRetryDelayOverridesStrategy()
$listener->onMessageFailed($event);
}

/**
* @dataProvider provideRetryDelays
*/
public function testWrappedRecoverableExceptionRetryDelayOverridesStrategy(array $retries, int $expectedDelay)
{
$sender = $this->createMock(SenderInterface::class);
$sender->expects($this->once())->method('send')->willReturnCallback(function (Envelope $envelope) use ($expectedDelay) {
$delayStamp = $envelope->last(DelayStamp::class);
$redeliveryStamp = $envelope->last(RedeliveryStamp::class);

$this->assertInstanceOf(DelayStamp::class, $delayStamp);
$this->assertSame($expectedDelay, $delayStamp->getDelay());

$this->assertInstanceOf(RedeliveryStamp::class, $redeliveryStamp);
$this->assertSame(1, $redeliveryStamp->getRetryCount());

return $envelope;
});
$senderLocator = new Container();
$senderLocator->set('my_receiver', $sender);
$retryStrategy = $this->createMock(RetryStrategyInterface::class);
$retryStrategy->expects($this->never())->method('isRetryable');
$retryStrategy->expects($this->never())->method('getWaitingTime');
$retryStrategyLocator = new Container();
$retryStrategyLocator->set('my_receiver', $retryStrategy);

$listener = new SendFailedMessageForRetryListener($senderLocator, $retryStrategyLocator);

$envelope = new Envelope(new \stdClass());
$exception = new HandlerFailedException(
$envelope,
array_map(fn (int $retry) => new RecoverableMessageHandlingException('retry', retryDelay: $retry), $retries)
);
$event = new WorkerMessageFailedEvent($envelope, 'my_receiver', $exception);

$listener->onMessageFailed($event);
}

public static function provideRetryDelays(): iterable
{
yield 'one_exception' => [
[1235],
1235,
];

yield 'multiple_exceptions' => [
[1235, 2000, 1000],
1000,
];

yield 'zero_delay' => [
[0, 2000, 1000],
0,
];
}

public function testEnvelopeIsSentToTransportOnRetry()
{
$exception = new \Exception('no!');
Expand Down
Loading