[Messenger][Amqp] Added missing rpc_timeout option

lyrixx · nicolas-grekas · commit 02c879c1cf92 · 2022-12-13T18:34:41.000+01:00
Without this option, it's not possible to set a timeout on the connection. It
means, if the network between RabbitMQ and the application goes down, the code
in `Connection::get()` will hand forever. And at some point it will cause more
troubles. For example:

* many connection/channel opened (because the consumer is not killed) ;
* or, when the connexion gets back, RabbitMQ have killed the consumer anyway =&gt;
  Another Exception.

With this patch, and with the following configuration, exception are clear on
what occurs.

```
framework:
    messenger:
        transports:
            rabbitmq:
                dsn: ....
                options:
                    read_timeout: 5
                    write_timeout: 5
                    connect_timeout: 5
                    confirm_timeout: 5
                    rpc_timeout: 5
                    [...]
```

Example of exception:

```
In AmqpReceiver.php line 56:

  [Symfony\Component\Messenger\Exception\TransportException]
  Library error: request timed out

Exception trace:
  at /app/vendor/symfony/amqp-messenger/Transport/AmqpReceiver.php:56
 Symfony\Component\Messenger\Bridge\Amqp\Transport\AmqpReceiver-&gt;getEnvelope() at /app/vendor/symfony/amqp-messenger/Transport/AmqpReceiver.php:47
 Symfony\Component\Messenger\Bridge\Amqp\Transport\AmqpReceiver-&gt;getFromQueues() at /app/vendor/symfony/amqp-messenger/Transport/AmqpReceiver.php:41
 Symfony\Component\Messenger\Bridge\Amqp\Transport\AmqpReceiver-&gt;get() at /app/vendor/symfony/symfony/src/Symfony/Component/Messenger/Worker.php:106
 Symfony\Component\Messenger\Worker-&gt;run() at /app/vendor/symfony/symfony/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php:229
 Symfony\Component\Messenger\Command\ConsumeMessagesCommand-&gt;execute() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Command/Command.php:312
 Symfony\Component\Console\Command\Command-&gt;run() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Application.php:1038
 Symfony\Component\Console\Application-&gt;doRunCommand() at /app/vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Console/Application.php:88
 Symfony\Bundle\FrameworkBundle\Console\Application-&gt;doRunCommand() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Application.php:312
 Symfony\Component\Console\Application-&gt;doRun() at /app/vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Console/Application.php:77
 Symfony\Bundle\FrameworkBundle\Console\Application-&gt;doRun() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Application.php:168
 Symfony\Component\Console\Application-&gt;run() at /app/bin/console:29

In Connection.php line 432:

  [AMQPException]
  Library error: request timed out

Exception trace:
  at /app/vendor/symfony/amqp-messenger/Transport/Connection.php:432
 AMQPQueue-&gt;get() at /app/vendor/symfony/amqp-messenger/Transport/Connection.php:432
 Symfony\Component\Messenger\Bridge\Amqp\Transport\Connection-&gt;get() at /app/vendor/symfony/amqp-messenger/Transport/AmqpReceiver.php:54
 Symfony\Component\Messenger\Bridge\Amqp\Transport\AmqpReceiver-&gt;getEnvelope() at /app/vendor/symfony/amqp-messenger/Transport/AmqpReceiver.php:47
 Symfony\Component\Messenger\Bridge\Amqp\Transport\AmqpReceiver-&gt;getFromQueues() at /app/vendor/symfony/amqp-messenger/Transport/AmqpReceiver.php:41
 Symfony\Component\Messenger\Bridge\Amqp\Transport\AmqpReceiver-&gt;get() at /app/vendor/symfony/symfony/src/Symfony/Component/Messenger/Worker.php:106
 Symfony\Component\Messenger\Worker-&gt;run() at /app/vendor/symfony/symfony/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php:229
 Symfony\Component\Messenger\Command\ConsumeMessagesCommand-&gt;execute() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Command/Command.php:312
 Symfony\Component\Console\Command\Command-&gt;run() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Application.php:1038
 Symfony\Component\Console\Application-&gt;doRunCommand() at /app/vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Console/Application.php:88
 Symfony\Bundle\FrameworkBundle\Console\Application-&gt;doRunCommand() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Application.php:312
 Symfony\Component\Console\Application-&gt;doRun() at /app/vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Console/Application.php:77
 Symfony\Bundle\FrameworkBundle\Console\Application-&gt;doRun() at /app/vendor/symfony/symfony/src/Symfony/Component/Console/Application.php:168
 Symfony\Component\Console\Application-&gt;run() at /app/bin/console:29

messenger:consume [-l|--limit LIMIT] [-f|--failure-limit FAILURE-LIMIT] [-m|--memory-limit MEMORY-LIMIT] [-t|--time-limit TIME-LIMIT] [--sleep SLEEP] [-b|--bus BUS] [--queues QUEUES] [--no-reset] [--] [&lt;receivers&gt;...]

```
diff --git a/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/Connection.php b/src/Symfony/Component/Messenger/Bridge/Amqp/Transport/Connection.php
@@ -32,6 +32,9 @@ class Connection
         'x-message-ttl',
     ];
 
+    /**
+     * @see https://github.com/php-amqp/php-amqp/blob/master/amqp_connection_resource.h
+     */
     private const AVAILABLE_OPTIONS = [
         'host',
         'port',
@@ -53,6 +56,7 @@ class Connection
         'write_timeout',
         'confirm_timeout',
         'connect_timeout',
+        'rpc_timeout',
         'cacert',
         'cert',
         'key',
