vendor/symfony/messenger/Command/AbstractFailedMessagesCommand.php line 53

  1. <?php
  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.  */
  12. namespace Symfony\Component\Messenger\Command;
  14. use Symfony\Component\Console\Command\Command;
  15. use Symfony\Component\Console\Completion\CompletionInput;
  16. use Symfony\Component\Console\Completion\CompletionSuggestions;
  17. use Symfony\Component\Console\Helper\Dumper;
  18. use Symfony\Component\Console\Question\ChoiceQuestion;
  19. use Symfony\Component\Console\Style\SymfonyStyle;
  20. use Symfony\Component\ErrorHandler\Exception\FlattenException;
  21. use Symfony\Component\Messenger\Envelope;
  22. use Symfony\Component\Messenger\Exception\InvalidArgumentException;
  23. use Symfony\Component\Messenger\Stamp\ErrorDetailsStamp;
  24. use Symfony\Component\Messenger\Stamp\MessageDecodingFailedStamp;
  25. use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
  26. use Symfony\Component\Messenger\Stamp\SentToFailureTransportStamp;
  27. use Symfony\Component\Messenger\Stamp\TransportMessageIdStamp;
  28. use Symfony\Component\Messenger\Transport\Receiver\ListableReceiverInterface;
  29. use Symfony\Component\Messenger\Transport\Receiver\MessageCountAwareInterface;
  30. use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
  31. use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
  32. use Symfony\Component\VarDumper\Caster\Caster;
  33. use Symfony\Component\VarDumper\Caster\TraceStub;
  34. use Symfony\Component\VarDumper\Cloner\ClonerInterface;
  35. use Symfony\Component\VarDumper\Cloner\Stub;
  36. use Symfony\Component\VarDumper\Cloner\VarCloner;
  37. use Symfony\Contracts\Service\ServiceProviderInterface;
  39. /**
  40.  * @author Ryan Weaver <ryan@symfonycasts.com>
  41.  *
  42.  * @internal
  43.  */
  44. abstract class AbstractFailedMessagesCommand extends Command
  45. {
  46.     protected const DEFAULT_TRANSPORT_OPTION = 'choose';
  48.     protected $failureTransports;
  49.     protected ?PhpSerializer $phpSerializer;
  51.     private ?string $globalFailureReceiverName;
  53.     public function __construct(?string $globalFailureReceiverName, ServiceProviderInterface $failureTransports, PhpSerializer $phpSerializer = null)
  54.     {
  55.         $this->failureTransports = $failureTransports;
  56.         $this->globalFailureReceiverName = $globalFailureReceiverName;
  57.         $this->phpSerializer = $phpSerializer;
  59.         parent::__construct();
  60.     }
  62.     protected function getGlobalFailureReceiverName(): ?string
  63.     {
  64.         return $this->globalFailureReceiverName;
  65.     }
  67.     protected function getMessageId(Envelope $envelope): mixed
  68.     {
  69.         /** @var TransportMessageIdStamp $stamp */
  70.         $stamp = $envelope->last(TransportMessageIdStamp::class);
  72.         return $stamp?->getId();
  73.     }
  75.     protected function displaySingleMessage(Envelope $envelope, SymfonyStyle $io)
  76.     {
  77.         $io->title('Failed Message Details');
  79.         /** @var SentToFailureTransportStamp|null $sentToFailureTransportStamp */
  80.         $sentToFailureTransportStamp = $envelope->last(SentToFailureTransportStamp::class);
  81.         /** @var RedeliveryStamp|null $lastRedeliveryStamp */
  82.         $lastRedeliveryStamp = $envelope->last(RedeliveryStamp::class);
  83.         /** @var ErrorDetailsStamp|null $lastErrorDetailsStamp */
  84.         $lastErrorDetailsStamp = $envelope->last(ErrorDetailsStamp::class);
  85.         /** @var MessageDecodingFailedStamp|null $lastMessageDecodingFailedStamp */
  86.         $lastMessageDecodingFailedStamp = $envelope->last(MessageDecodingFailedStamp::class);
  88.         $rows = [
  89.             ['Class', \get_class($envelope->getMessage())],
  90.         ];
  92.         if (null !== $id = $this->getMessageId($envelope)) {
  93.             $rows[] = ['Message Id', $id];
  94.         }
  96.         if (null === $sentToFailureTransportStamp) {
  97.             $io->warning('Message does not appear to have been sent to this transport after failing');
  98.         } else {
  99.             $failedAt = '';
  100.             $errorMessage = '';
  101.             $errorCode = '';
  102.             $errorClass = '(unknown)';
  104.             if (null !== $lastRedeliveryStamp) {
  105.                 $failedAt = $lastRedeliveryStamp->getRedeliveredAt()->format('Y-m-d H:i:s');
  106.             }
  108.             if (null !== $lastErrorDetailsStamp) {
  109.                 $errorMessage = $lastErrorDetailsStamp->getExceptionMessage();
  110.                 $errorCode = $lastErrorDetailsStamp->getExceptionCode();
  111.                 $errorClass = $lastErrorDetailsStamp->getExceptionClass();
  112.             }
  114.             $rows = array_merge($rows, [
  115.                 ['Failed at', $failedAt],
  116.                 ['Error', $errorMessage],
  117.                 ['Error Code', $errorCode],
  118.                 ['Error Class', $errorClass],
  119.                 ['Transport', $sentToFailureTransportStamp->getOriginalReceiverName()],
  120.             ]);
  121.         }
  123.         $io->table([], $rows);
  125.         /** @var RedeliveryStamp[] $redeliveryStamps */
  126.         $redeliveryStamps = $envelope->all(RedeliveryStamp::class);
  127.         $io->writeln(' Message history:');
  128.         foreach ($redeliveryStamps as $redeliveryStamp) {
  129.             $io->writeln(sprintf('  * Message failed at <info>%s</info> and was redelivered', $redeliveryStamp->getRedeliveredAt()->format('Y-m-d H:i:s')));
  130.         }
  131.         $io->newLine();
  133.         if ($io->isVeryVerbose()) {
  134.             $io->title('Message:');
  135.             if (null !== $lastMessageDecodingFailedStamp) {
  136.                 $io->error('The message could not be decoded. See below an APPROXIMATIVE representation of the class.');
  137.             }
  138.             $dump = new Dumper($io, null, $this->createCloner());
  139.             $io->writeln($dump($envelope->getMessage()));
  140.             $io->title('Exception:');
  141.             $flattenException = $lastErrorDetailsStamp?->getFlattenException();
  142.             $io->writeln(null === $flattenException ? '(no data)' : $dump($flattenException));
  143.         } else {
  144.             if (null !== $lastMessageDecodingFailedStamp) {
  145.                 $io->error('The message could not be decoded.');
  146.             }
  147.             $io->writeln(' Re-run command with <info>-vv</info> to see more message & error details.');
  148.         }
  149.     }
  151.     protected function printPendingMessagesMessage(ReceiverInterface $receiver, SymfonyStyle $io)
  152.     {
  153.         if ($receiver instanceof MessageCountAwareInterface) {
  154.             if (1 === $receiver->getMessageCount()) {
  155.                 $io->writeln('There is <comment>1</comment> message pending in the failure transport.');
  156.             } else {
  157.                 $io->writeln(sprintf('There are <comment>%d</comment> messages pending in the failure transport.', $receiver->getMessageCount()));
  158.             }
  159.         }
  160.     }
  162.     protected function getReceiver(string $name = null): ReceiverInterface
  163.     {
  164.         if (null === $name ??= $this->globalFailureReceiverName) {
  165.             throw new InvalidArgumentException(sprintf('No default failure transport is defined. Available transports are: "%s".', implode('", "', array_keys($this->failureTransports->getProvidedServices()))));
  166.         }
  168.         if (!$this->failureTransports->has($name)) {
  169.             throw new InvalidArgumentException(sprintf('The "%s" failure transport was not found. Available transports are: "%s".', $name, implode('", "', array_keys($this->failureTransports->getProvidedServices()))));
  170.         }
  172.         return $this->failureTransports->get($name);
  173.     }
  175.     private function createCloner(): ?ClonerInterface
  176.     {
  177.         if (!class_exists(VarCloner::class)) {
  178.             return null;
  179.         }
  181.         $cloner = new VarCloner();
  182.         $cloner->addCasters([FlattenException::class => function (FlattenException $flattenException, array $a, Stub $stub): array {
  183.             $stub->class = $flattenException->getClass();
  185.             return [
  186.                 Caster::PREFIX_VIRTUAL.'message' => $flattenException->getMessage(),
  187.                 Caster::PREFIX_VIRTUAL.'code' => $flattenException->getCode(),
  188.                 Caster::PREFIX_VIRTUAL.'file' => $flattenException->getFile(),
  189.                 Caster::PREFIX_VIRTUAL.'line' => $flattenException->getLine(),
  190.                 Caster::PREFIX_VIRTUAL.'trace' => new TraceStub($flattenException->getTrace()),
  191.             ];
  192.         }]);
  194.         return $cloner;
  195.     }
  197.     protected function printWarningAvailableFailureTransports(SymfonyStyle $io, ?string $failureTransportName): void
  198.     {
  199.         $failureTransports = array_keys($this->failureTransports->getProvidedServices());
  200.         $failureTransportsCount = \count($failureTransports);
  201.         if ($failureTransportsCount > 1) {
  202.             $io->writeln([
  203.                 sprintf('> Loading messages from the <comment>global</comment> failure transport <comment>%s</comment>.', $failureTransportName),
  204.                 '> To use a different failure transport, pass <comment>--transport=</comment>.',
  205.                 sprintf('> Available failure transports are: <comment>%s</comment>', implode(', ', $failureTransports)),
  206.                 "\n",
  207.             ]);
  208.         }
  209.     }
  211.     protected function interactiveChooseFailureTransport(SymfonyStyle $io)
  212.     {
  213.         $failedTransports = array_keys($this->failureTransports->getProvidedServices());
  214.         $question = new ChoiceQuestion('Select failed transport:', $failedTransports, 0);
  215.         $question->setMultiselect(false);
  217.         return $io->askQuestion($question);
  218.     }
  220.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  221.     {
  222.         if ($input->mustSuggestOptionValuesFor('transport')) {
  223.             $suggestions->suggestValues(array_keys($this->failureTransports->getProvidedServices()));
  225.             return;
  226.         }
  228.         if ($input->mustSuggestArgumentValuesFor('id')) {
  229.             $transport = $input->getOption('transport');
  230.             $transport = self::DEFAULT_TRANSPORT_OPTION === $transport ? $this->getGlobalFailureReceiverName() : $transport;
  231.             $receiver = $this->getReceiver($transport);
  233.             if (!$receiver instanceof ListableReceiverInterface) {
  234.                 return;
  235.             }
  237.             $ids = [];
  238.             foreach ($receiver->all(50) as $envelope) {
  239.                 $ids[] = $this->getMessageId($envelope);
  240.             }
  241.             $suggestions->suggestValues($ids);
  243.             return;
  244.         }
  245.     }
  246. }