vendor/symfony/messenger/Command/FailedMessagesShowCommand.php line 87

  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\Attribute\AsCommand;
  15. use Symfony\Component\Console\Exception\RuntimeException;
  16. use Symfony\Component\Console\Input\InputArgument;
  17. use Symfony\Component\Console\Input\InputInterface;
  18. use Symfony\Component\Console\Input\InputOption;
  19. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  20. use Symfony\Component\Console\Output\OutputInterface;
  21. use Symfony\Component\Console\Style\SymfonyStyle;
  22. use Symfony\Component\Messenger\Stamp\ErrorDetailsStamp;
  23. use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
  24. use Symfony\Component\Messenger\Transport\Receiver\ListableReceiverInterface;
  26. /**
  27.  * @author Ryan Weaver <ryan@symfonycasts.com>
  28.  */
  29. #[AsCommand(name: 'messenger:failed:show', description: 'Show one or more messages from the failure transport')]
  30. class FailedMessagesShowCommand extends AbstractFailedMessagesCommand
  31. {
  32.     protected function configure(): void
  33.     {
  34.         $this
  35.             ->setDefinition([
  36.                 new InputArgument('id', InputArgument::OPTIONAL, 'Specific message id to show'),
  37.                 new InputOption('max', null, InputOption::VALUE_REQUIRED, 'Maximum number of messages to list', 50),
  38.                 new InputOption('transport', null, InputOption::VALUE_OPTIONAL, 'Use a specific failure transport', self::DEFAULT_TRANSPORT_OPTION),
  39.                 new InputOption('stats', null, InputOption::VALUE_NONE, 'Display the message count by class'),
  40.                 new InputOption('class-filter', null, InputOption::VALUE_REQUIRED, 'Filter by a specific class name'),
  41.             ])
  42.             ->setHelp(<<<'EOF'
  43. The <info>%command.name%</info> shows message that are pending in the failure transport.
  45.     <info>php %command.full_name%</info>
  47. Or look at a specific message by its id:
  49.     <info>php %command.full_name% {id}</info>
  50. EOF
  51.             )
  52.         ;
  53.     }
  55.     protected function execute(InputInterface $input, OutputInterface $output): int
  56.     {
  57.         $io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output);
  59.         $failureTransportName = $input->getOption('transport');
  60.         if (self::DEFAULT_TRANSPORT_OPTION === $failureTransportName) {
  61.             $this->printWarningAvailableFailureTransports($io, $this->getGlobalFailureReceiverName());
  62.         }
  63.         if ('' === $failureTransportName || null === $failureTransportName) {
  64.             $failureTransportName = $this->interactiveChooseFailureTransport($io);
  65.         }
  66.         $failureTransportName = self::DEFAULT_TRANSPORT_OPTION === $failureTransportName ? $this->getGlobalFailureReceiverName() : $failureTransportName;
  68.         $receiver = $this->getReceiver($failureTransportName);
  70.         $this->printPendingMessagesMessage($receiver, $io);
  72.         if (!$receiver instanceof ListableReceiverInterface) {
  73.             throw new RuntimeException(sprintf('The "%s" receiver does not support listing or showing specific messages.', $failureTransportName));
  74.         }
  76.         if ($input->getOption('stats')) {
  77.             $this->listMessagesPerClass($failureTransportName, $io, $input->getOption('max'));
  78.         } elseif (null === $id = $input->getArgument('id')) {
  79.             $this->listMessages($failureTransportName, $io, $input->getOption('max'), $input->getOption('class-filter'));
  80.         } else {
  81.             $this->showMessage($failureTransportName, $id, $io);
  82.         }
  84.         return 0;
  85.     }
  87.     private function listMessages(?string $failedTransportName, SymfonyStyle $io, int $max, string $classFilter = null)
  88.     {
  89.         /** @var ListableReceiverInterface $receiver */
  90.         $receiver = $this->getReceiver($failedTransportName);
  91.         $envelopes = $receiver->all($max);
  93.         $rows = [];
  95.         if ($classFilter) {
  96.             $io->comment(sprintf('Displaying only \'%s\' messages', $classFilter));
  97.         }
  99.         $this->phpSerializer?->acceptPhpIncompleteClass();
  100.         try {
  101.             foreach ($envelopes as $envelope) {
  102.                 $currentClassName = \get_class($envelope->getMessage());
  104.                 if ($classFilter && $classFilter !== $currentClassName) {
  105.                     continue;
  106.                 }
  108.                 /** @var RedeliveryStamp|null $lastRedeliveryStamp */
  109.                 $lastRedeliveryStamp = $envelope->last(RedeliveryStamp::class);
  110.                 /** @var ErrorDetailsStamp|null $lastErrorDetailsStamp */
  111.                 $lastErrorDetailsStamp = $envelope->last(ErrorDetailsStamp::class);
  113.                 $rows[] = [
  114.                     $this->getMessageId($envelope),
  115.                     $currentClassName,
  116.                     null === $lastRedeliveryStamp ? '' : $lastRedeliveryStamp->getRedeliveredAt()->format('Y-m-d H:i:s'),
  117.                     $lastErrorDetailsStamp?->getExceptionMessage() ?? '',
  118.                 ];
  119.             }
  120.         } finally {
  121.             $this->phpSerializer?->rejectPhpIncompleteClass();
  122.         }
  124.         $rowsCount = \count($rows);
  126.         if (0 === $rowsCount) {
  127.             $io->success('No failed messages were found.');
  129.             return;
  130.         }
  132.         $io->table(['Id', 'Class', 'Failed at', 'Error'], $rows);
  134.         if ($rowsCount === $max) {
  135.             $io->comment(sprintf('Showing first %d messages.', $max));
  136.         } elseif ($classFilter) {
  137.             $io->comment(sprintf('Showing %d message(s).', $rowsCount));
  138.         }
  140.         $io->comment(sprintf('Run <comment>messenger:failed:show {id} --transport=%s -vv</comment> to see message details.', $failedTransportName));
  141.     }
  143.     private function listMessagesPerClass(?string $failedTransportName, SymfonyStyle $io, int $max)
  144.     {
  145.         /** @var ListableReceiverInterface $receiver */
  146.         $receiver = $this->getReceiver($failedTransportName);
  147.         $envelopes = $receiver->all($max);
  149.         $countPerClass = [];
  151.         $this->phpSerializer?->acceptPhpIncompleteClass();
  152.         try {
  153.             foreach ($envelopes as $envelope) {
  154.                 $c = \get_class($envelope->getMessage());
  156.                 if (!isset($countPerClass[$c])) {
  157.                     $countPerClass[$c] = [$c, 0];
  158.                 }
  160.                 ++$countPerClass[$c][1];
  161.             }
  162.         } finally {
  163.             $this->phpSerializer?->rejectPhpIncompleteClass();
  164.         }
  166.         if (0 === \count($countPerClass)) {
  167.             $io->success('No failed messages were found.');
  169.             return;
  170.         }
  172.         $io->table(['Class', 'Count'], $countPerClass);
  173.     }
  175.     private function showMessage(?string $failedTransportName, string $id, SymfonyStyle $io)
  176.     {
  177.         /** @var ListableReceiverInterface $receiver */
  178.         $receiver = $this->getReceiver($failedTransportName);
  179.         $this->phpSerializer?->acceptPhpIncompleteClass();
  180.         try {
  181.             $envelope = $receiver->find($id);
  182.         } finally {
  183.             $this->phpSerializer?->rejectPhpIncompleteClass();
  184.         }
  185.         if (null === $envelope) {
  186.             throw new RuntimeException(sprintf('The message "%s" was not found.', $id));
  187.         }
  189.         $this->displaySingleMessage($envelope, $io);
  191.         $io->writeln([
  192.             '',
  193.             sprintf(' Run <comment>messenger:failed:retry %s --transport=%s</comment> to retry this message.', $id, $failedTransportName),
  194.             sprintf(' Run <comment>messenger:failed:remove %s --transport=%s</comment> to delete it.', $id, $failedTransportName),
  195.         ]);
  196.     }
  197. }