* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Messenger\Command; use Psr\Container\ContainerInterface; use Psr\Log\LoggerInterface; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Command\SignalableCommandInterface; use Symfony\Component\Console\Completion\CompletionInput; use Symfony\Component\Console\Completion\CompletionSuggestions; use Symfony\Component\Console\Exception\InvalidOptionException; use Symfony\Component\Console\Exception\RuntimeException; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\ConsoleOutputInterface; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Question\ChoiceQuestion; use Symfony\Component\Console\Style\SymfonyStyle; use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Symfony\Component\Messenger\EventListener\ResetServicesListener; use Symfony\Component\Messenger\EventListener\StopWorkerOnFailureLimitListener; use Symfony\Component\Messenger\EventListener\StopWorkerOnMemoryLimitListener; use Symfony\Component\Messenger\EventListener\StopWorkerOnMessageLimitListener; use Symfony\Component\Messenger\EventListener\StopWorkerOnTimeLimitListener; use Symfony\Component\Messenger\RoutableMessageBus; use Symfony\Component\Messenger\Transport\Sync\SyncTransport; use Symfony\Component\Messenger\Worker; /** * @author Samuel Roze */ #[AsCommand(name: 'messenger:consume', description: 'Consume messages')] class ConsumeMessagesCommand extends Command implements SignalableCommandInterface { private ?Worker $worker = null; public function __construct( private RoutableMessageBus $routableBus, private ContainerInterface $receiverLocator, private EventDispatcherInterface $eventDispatcher, private ?LoggerInterface $logger = null, private array $receiverNames = [], private ?ResetServicesListener $resetServicesListener = null, private array $busIds = [], private ?ContainerInterface $rateLimiterLocator = null, private ?array $signals = null, ) { parent::__construct(); } protected function configure(): void { $defaultReceiverName = 1 === \count($this->receiverNames) ? current($this->receiverNames) : null; $this ->setDefinition([ new InputArgument('receivers', InputArgument::IS_ARRAY, 'Names of the receivers/transports to consume in order of priority', $defaultReceiverName ? [$defaultReceiverName] : []), new InputOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Limit the number of received messages'), new InputOption('failure-limit', 'f', InputOption::VALUE_REQUIRED, 'The number of failed messages the worker can consume'), new InputOption('memory-limit', 'm', InputOption::VALUE_REQUIRED, 'The memory limit the worker can consume'), new InputOption('time-limit', 't', InputOption::VALUE_REQUIRED, 'The time limit in seconds the worker can handle new messages'), new InputOption('sleep', null, InputOption::VALUE_REQUIRED, 'Seconds to sleep before asking for new messages after no messages were found', 1), new InputOption('bus', 'b', InputOption::VALUE_REQUIRED, 'Name of the bus to which received messages should be dispatched (if not passed, bus is determined automatically)'), new InputOption('queues', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Limit receivers to only consume from the specified queues'), new InputOption('no-reset', null, InputOption::VALUE_NONE, 'Do not reset container services after each message'), new InputOption('all', null, InputOption::VALUE_NONE, 'Consume messages from all receivers'), ]) ->setHelp(<<<'EOF' The %command.name% command consumes messages and dispatches them to the message bus. php %command.full_name% To receive from multiple transports, pass each name: php %command.full_name% receiver1 receiver2 Use the --limit option to limit the number of messages received: php %command.full_name% --limit=10 Use the --failure-limit option to stop the worker when the given number of failed messages is reached: php %command.full_name% --failure-limit=2 Use the --memory-limit option to stop the worker if it exceeds a given memory usage limit. You can use shorthand byte values [K, M or G]: php %command.full_name% --memory-limit=128M Use the --time-limit option to stop the worker when the given time limit (in seconds) is reached. If a message is being handled, the worker will stop after the processing is finished: php %command.full_name% --time-limit=3600 Use the --bus option to specify the message bus to dispatch received messages to instead of trying to determine it automatically. This is required if the messages didn't originate from Messenger: php %command.full_name% --bus=event_bus Use the --queues option to limit a receiver to only certain queues (only supported by some receivers): php %command.full_name% --queues=fasttrack Use the --no-reset option to prevent services resetting after each message (may lead to leaking services' state between messages): php %command.full_name% --no-reset Use the --all option to consume from all receivers: php %command.full_name% --all EOF ) ; } protected function interact(InputInterface $input, OutputInterface $output): void { $io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output); if ($input->getOption('all')) { return; } if ($this->receiverNames && !$input->getArgument('receivers')) { $io->block('Which transports/receivers do you want to consume?', null, 'fg=white;bg=blue', ' ', true); $io->writeln('Choose which receivers you want to consume messages from in order of priority.'); if (\count($this->receiverNames) > 1) { $io->writeln(sprintf('Hint: to consume from multiple, use a list of their names, e.g. %s', implode(', ', $this->receiverNames))); } $question = new ChoiceQuestion('Select receivers to consume:', $this->receiverNames, 0); $question->setMultiselect(true); $input->setArgument('receivers', $io->askQuestion($question)); } if (!$input->getArgument('receivers')) { throw new RuntimeException('Please pass at least one receiver.'); } } protected function execute(InputInterface $input, OutputInterface $output): int { $receivers = []; $rateLimiters = []; $receiverNames = $input->getOption('all') ? $this->receiverNames : $input->getArgument('receivers'); foreach ($receiverNames as $receiverName) { if (!$this->receiverLocator->has($receiverName)) { $message = sprintf('The receiver "%s" does not exist.', $receiverName); if ($this->receiverNames) { $message .= sprintf(' Valid receivers are: %s.', implode(', ', $this->receiverNames)); } throw new RuntimeException($message); } $receiver = $this->receiverLocator->get($receiverName); if ($receiver instanceof SyncTransport) { $idx = array_search($receiverName, $receiverNames); unset($receiverNames[$idx]); continue; } $receivers[$receiverName] = $receiver; if ($this->rateLimiterLocator?->has($receiverName)) { $rateLimiters[$receiverName] = $this->rateLimiterLocator->get($receiverName); } } if (null !== $this->resetServicesListener && !$input->getOption('no-reset')) { $this->eventDispatcher->addSubscriber($this->resetServicesListener); } $stopsWhen = []; if (null !== $limit = $input->getOption('limit')) { if (!is_numeric($limit) || 0 >= $limit) { throw new InvalidOptionException(sprintf('Option "limit" must be a positive integer, "%s" passed.', $limit)); } $stopsWhen[] = "processed {$limit} messages"; $this->eventDispatcher->addSubscriber(new StopWorkerOnMessageLimitListener($limit, $this->logger)); } if ($failureLimit = $input->getOption('failure-limit')) { $stopsWhen[] = "reached {$failureLimit} failed messages"; $this->eventDispatcher->addSubscriber(new StopWorkerOnFailureLimitListener($failureLimit, $this->logger)); } if ($memoryLimit = $input->getOption('memory-limit')) { $stopsWhen[] = "exceeded {$memoryLimit} of memory"; $this->eventDispatcher->addSubscriber(new StopWorkerOnMemoryLimitListener($this->convertToBytes($memoryLimit), $this->logger)); } if (null !== $timeLimit = $input->getOption('time-limit')) { if (!is_numeric($timeLimit) || 0 >= $timeLimit) { throw new InvalidOptionException(sprintf('Option "time-limit" must be a positive integer, "%s" passed.', $timeLimit)); } $stopsWhen[] = "been running for {$timeLimit}s"; $this->eventDispatcher->addSubscriber(new StopWorkerOnTimeLimitListener($timeLimit, $this->logger)); } $stopsWhen[] = 'received a stop signal via the messenger:stop-workers command'; $io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output); $io->success(sprintf('Consuming messages from transport%s "%s".', \count($receivers) > 1 ? 's' : '', implode(', ', $receiverNames))); if ($stopsWhen) { $last = array_pop($stopsWhen); $stopsWhen = ($stopsWhen ? implode(', ', $stopsWhen).' or ' : '').$last; $io->comment("The worker will automatically exit once it has {$stopsWhen}."); } $io->comment('Quit the worker with CONTROL-C.'); if (OutputInterface::VERBOSITY_VERBOSE > $output->getVerbosity()) { $io->comment('Re-run the command with a -vv option to see logs about consumed messages.'); } $bus = $input->getOption('bus') ? $this->routableBus->getMessageBus($input->getOption('bus')) : $this->routableBus; $this->worker = new Worker($receivers, $bus, $this->eventDispatcher, $this->logger, $rateLimiters); $options = [ 'sleep' => $input->getOption('sleep') * 1000000, ]; if ($queues = $input->getOption('queues')) { $options['queues'] = $queues; } try { $this->worker->run($options); } finally { $this->worker = null; } return 0; } public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void { if ($input->mustSuggestArgumentValuesFor('receivers')) { $suggestions->suggestValues(array_diff($this->receiverNames, array_diff($input->getArgument('receivers'), [$input->getCompletionValue()]))); return; } if ($input->mustSuggestOptionValuesFor('bus')) { $suggestions->suggestValues($this->busIds); } } public function getSubscribedSignals(): array { return $this->signals ?? (\extension_loaded('pcntl') ? [\SIGTERM, \SIGINT, \SIGQUIT] : []); } public function handleSignal(int $signal, int|false $previousExitCode = 0): int|false { if (!$this->worker) { return false; } $this->logger?->info('Received signal {signal}.', ['signal' => $signal, 'transport_names' => $this->worker->getMetadata()->getTransportNames()]); $this->worker->stop(); return false; } private function convertToBytes(string $memoryLimit): int { $memoryLimit = strtolower($memoryLimit); $max = ltrim($memoryLimit, '+'); if (str_starts_with($max, '0x')) { $max = \intval($max, 16); } elseif (str_starts_with($max, '0')) { $max = \intval($max, 8); } else { $max = (int) $max; } switch (substr(rtrim($memoryLimit, 'b'), -1)) { case 't': $max *= 1024; // no break case 'g': $max *= 1024; // no break case 'm': $max *= 1024; // no break case 'k': $max *= 1024; } return $max; } }