vendor/symfony/messenger/EventListener/SendFailedMessageForRetryListener.php line 42

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  11. namespace Symfony\Component\Messenger\EventListener;
  13. use Psr\Container\ContainerInterface;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\Messenger\Envelope;
  17. use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
  18. use Symfony\Component\Messenger\Exception\HandlerFailedException;
  19. use Symfony\Component\Messenger\Exception\RuntimeException;
  20. use Symfony\Component\Messenger\Exception\UnrecoverableExceptionInterface;
  21. use Symfony\Component\Messenger\Retry\RetryStrategyInterface;
  22. use Symfony\Component\Messenger\Stamp\DelayStamp;
  23. use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
  24. use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
  26. /**
  27.  * @author Tobias Schultze <http://tobion.de>
  28.  */
  29. class SendFailedMessageForRetryListener implements EventSubscriberInterface
  30. {
  31.     private $sendersLocator;
  32.     private $retryStrategyLocator;
  33.     private $logger;
  35.     public function __construct(ContainerInterface $sendersLocator, ContainerInterface $retryStrategyLocator, LoggerInterface $logger = null)
  36.     {
  37.         $this->sendersLocator = $sendersLocator;
  38.         $this->retryStrategyLocator = $retryStrategyLocator;
  39.         $this->logger = $logger;
  40.     }
  42.     public function onMessageFailed(WorkerMessageFailedEvent $event)
  43.     {
  44.         $retryStrategy = $this->getRetryStrategyForTransport($event->getReceiverName());
  45.         $envelope = $event->getEnvelope();
  46.         $throwable = $event->getThrowable();
  48.         $message = $envelope->getMessage();
  49.         $context = [
  50.             'message' => $message,
  51.             'class' => \get_class($message),
  52.         ];
  54.         $shouldRetry = $retryStrategy && $this->shouldRetry($throwable, $envelope, $retryStrategy);
  56.         $retryCount = RedeliveryStamp::getRetryCountFromEnvelope($envelope);
  57.         if ($shouldRetry) {
  58.             $event->setForRetry();
  60.             ++$retryCount;
  61.             $delay = $retryStrategy->getWaitingTime($envelope);
  62.             if (null !== $this->logger) {
  63.                 $this->logger->error('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]);
  64.             }
  66.             // add the delay and retry stamp info
  67.             $retryEnvelope = $envelope->with(new DelayStamp($delay), new RedeliveryStamp($retryCount));
  69.             // re-send the message for retry
  70.             $this->getSenderForTransport($event->getReceiverName())->send($retryEnvelope);
  71.         } else {
  72.             if (null !== $this->logger) {
  73.                 $this->logger->critical('Error thrown while handling message {class}. Removing from transport after {retryCount} retries. Error: "{error}"', $context + ['retryCount' => $retryCount, 'error' => $throwable->getMessage(), 'exception' => $throwable]);
  74.             }
  75.         }
  76.     }
  78.     public static function getSubscribedEvents()
  79.     {
  80.         return [
  81.             // must have higher priority than SendFailedMessageToFailureTransportListener
  82.             WorkerMessageFailedEvent::class => ['onMessageFailed', 100],
  83.         ];
  84.     }
  86.     private function shouldRetry(\Throwable $e, Envelope $envelope, RetryStrategyInterface $retryStrategy): bool
  87.     {
  88.         // if ALL nested Exceptions are an instance of UnrecoverableExceptionInterface we should not retry
  89.         if ($e instanceof HandlerFailedException) {
  90.             $shouldNotRetry = true;
  91.             foreach ($e->getNestedExceptions() as $nestedException) {
  92.                 if (!$nestedException instanceof UnrecoverableExceptionInterface) {
  93.                     $shouldNotRetry = false;
  94.                     break;
  95.                 }
  96.             }
  97.             if ($shouldNotRetry) {
  98.                 return false;
  99.             }
  100.         }
  102.         if ($e instanceof UnrecoverableExceptionInterface) {
  103.             return false;
  104.         }
  106.         return $retryStrategy->isRetryable($envelope);
  107.     }
  109.     private function getRetryStrategyForTransport(string $alias): ?RetryStrategyInterface
  110.     {
  111.         if ($this->retryStrategyLocator->has($alias)) {
  112.             return $this->retryStrategyLocator->get($alias);
  113.         }
  115.         return null;
  116.     }
  118.     private function getSenderForTransport(string $alias): SenderInterface
  119.     {
  120.         if ($this->sendersLocator->has($alias)) {
  121.             return $this->sendersLocator->get($alias);
  122.         }
  124.         throw new RuntimeException(sprintf('Could not find sender "%s" based on the same receiver to send the failed message to for retry.', $alias));
  125.     }
  126. }