php-amqplib / RabbitMqBundle

Command/BatchConsumerCommand.php

<?php

namespace OldSound\RabbitMqBundle\Command;

use OldSound\RabbitMqBundle\RabbitMq\BatchConsumer;
use PhpAmqpLib\Exception\AMQPTimeoutException;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

final class BatchConsumerCommand extends BaseRabbitMqCommand
{
    /**
     * @var BatchConsumer
     */
    protected $consumer;

    public function stopConsumer()
    {
        if ($this->consumer instanceof BatchConsumer) {

$this->consumer is always a sub-type of OldSound\RabbitMqBundle\RabbitMq\BatchConsumer.

            // Process current message, then halt consumer
            $this->consumer->forceStopConsumer();

            // Halt consumer if waiting for a new message from the queue
            try {
                $this->consumer->stopConsuming();
            } catch (AMQPTimeoutException $e) {

Consider adding a comment why this CATCH block is empty.

            }
        }
    }

    protected function configure(): void
    {
        parent::configure();

        $this
            ->setName('rabbitmq:batch:consumer')
            ->addArgument('name', InputArgument::REQUIRED, 'Consumer Name')
            ->addOption('batches', 'b', InputOption::VALUE_OPTIONAL, 'Number of batches to consume', '0')
            ->addOption('route', 'r', InputOption::VALUE_OPTIONAL, 'Routing Key', '')
            ->addOption('memory-limit', 'l', InputOption::VALUE_OPTIONAL, 'Allowed memory for this process')
            ->addOption('debug', 'd', InputOption::VALUE_NONE, 'Enable Debugging')
            ->addOption('without-signals', 'w', InputOption::VALUE_NONE, 'Disable catching of system signals')
            ->setDescription('Executes a Batch Consumer');
    }

    /**
     * Executes the current command.
     *
     * @param   InputInterface      $input      An InputInterface instance
     * @param   OutputInterface     $output     An OutputInterface instance
     *
     * @return  integer                         0 if everything went fine, or an error code
     *
     * @throws  \InvalidArgumentException       When the number of batches to consume is less than 0
     * @throws  \BadFunctionCallException       When the pcntl is not installed and option -s is true
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        if (defined('AMQP_WITHOUT_SIGNALS') === false) {
            define('AMQP_WITHOUT_SIGNALS', $input->getOption('without-signals'));
        }

        if (!AMQP_WITHOUT_SIGNALS && extension_loaded('pcntl')) {
            if (!function_exists('pcntl_signal')) {
                throw new \BadFunctionCallException("Function 'pcntl_signal' is referenced in the php.ini 'disable_functions' and can't be called.");
            }

            pcntl_signal(SIGTERM, [&$this, 'stopConsumer']);
            pcntl_signal(SIGINT, [&$this, 'stopConsumer']);
        }

        if (defined('AMQP_DEBUG') === false) {
            define('AMQP_DEBUG', (bool) $input->getOption('debug'));
        }

        $batchAmountTarget = (int)$input->getOption('batches');
        if (0 > $batchAmountTarget) {
            throw new \InvalidArgumentException("The -b option should be greater than 0");
        }

        $this->initConsumer($input);

        return $this->consumer->consume($batchAmountTarget);

The method consume() does not exist on null.

    }

    /**
     * @param   InputInterface  $input
     */
    protected function initConsumer(InputInterface $input)
    {
        $this->consumer = $this->getContainer()
            ->get(sprintf($this->getConsumerService(), $input->getArgument('name')));

        if (null !== $input->getOption('memory-limit') &&
            ctype_digit((string) $input->getOption('memory-limit')) &&
            (int) $input->getOption('memory-limit') > 0
        ) {
            $this->consumer->setMemoryLimit($input->getOption('memory-limit'));
        }
        $this->consumer->setRoutingKey($input->getOption('route'));
    }

    /**
     * @return  string
     */
    protected function getConsumerService()
    {
        return 'old_sound_rabbit_mq.%s_batch';
    }
}