Add an option to limit the number of received messages

Author: sroze

src/Symfony/Bundle/FrameworkBundle/Command/MessageConsumeCommand.php

@@ -18,6 +18,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\Message\MessageBusInterface;
+use Symfony\Component\Message\Transport\Enhancers\MaximumCountReceiver;
 use Symfony\Component\Message\Transport\ReceiverInterface;
 use Symfony\Component\Message\Worker;
 
@@ -37,6 +38,7 @@ protected function configure()
             ->setDefinition(array(
                 new InputArgument('receiver', InputArgument::REQUIRED, 'Name of the receiver'),
                 new InputOption('bus', 'b', InputOption::VALUE_REQUIRED, 'Name of the bus to dispatch the messages to', 'message_bus'),
+                new InputOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Limit the number of received messages'),
             ))
             ->setDescription('Consumes a message')
             ->setHelp(<<<'EOF'
@@ -72,6 +74,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
             throw new \RuntimeException(sprintf('Bus "%s" is not a valid message bus. It must implement the "%s" interface.', $busName, MessageBusInterface::class));
         }
 
+        if ($limit = $input->getOption('limit')) {
+            $receiver = new MaximumCountReceiver($receiver, $limit);
+        }
+
         $worker = new Worker($receiver, $messageBus);
         $worker->run();
     }

src/Symfony/Component/Message/Transport/Enhancers/MaximumCountReceiver.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Message\Transport\Enhancers;
+
+use Symfony\Component\Message\Transport\ReceiverInterface;
+
+class MaximumCountReceiver implements ReceiverInterface
+{
+    private $decoratedReceiver;
+    private $maximumNumberOfMessages;
+
+    public function __construct(ReceiverInterface $decoratedReceiver, int $maximumNumberOfMessages)
+    {
+        $this->decoratedReceiver = $decoratedReceiver;
+        $this->maximumNumberOfMessages = $maximumNumberOfMessages;
+    }
+
+    public function receive(): iterable
+    {
+        $receivedMessages = 0;
+
+        foreach ($this->decoratedReceiver->receive() as $message) {
+            yield $message;
+
+            if (++$receivedMessages > $this->maximumNumberOfMessages) {
+                break;
+            }
+        }
+    }
+}