[FrameworkBundle] Make StopWorkerOnSignalsListener configurable via messenger's config

alexandre-daubois · alexandre-daubois · commit ab061f9f1e50 · 2023-03-22T15:20:29.000+01:00
diff --git a/messenger.rst b/messenger.rst
@@ -768,6 +768,60 @@ configuration option.
 
     The ``framework.messenger.stop_worker_on_signals`` option was introduced in Symfony 6.3.
 
+You can configure the signals for which the worker will stop if received:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # config/packages/messenger.yaml
+        framework:
+            messenger:
+                stop_worker_on_signals:
+                    - SIGINT
+                    - SIGTERM
+                    - SIGUSR1
+
+            # ...
+
+    .. code-block:: xml
+
+        <!-- config/packages/messenger.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xmlns:framework="http://symfony.com/schema/dic/symfony"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                https://symfony.com/schema/dic/services/services-1.0.xsd
+                http://symfony.com/schema/dic/symfony
+                https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+            <framework:config>
+                <framework:messenger>
+                    <!-- ... -->
+
+                    <framework:stop-worker-on-signals signal="SIGINT"/>
+                    <framework:stop-worker-on-signals signal="SIGTERM"/>
+                    <framework:stop-worker-on-signals signal="SIGUSR1"/>
+                </framework:messenger>
+            </framework:config>
+        </container>
+
+    .. code-block:: php
+
+        use Symfony\Config\FrameworkConfig;
+
+        return static function (FrameworkConfig $framework) {
+            $messenger = $framework->messenger();
+
+            // ...
+
+            $messenger
+                ->stopWorkerOnSignals([\SIGINT, \SIGTERM, \SIGUSR1])
+                // ...
+            ;
+        };
+
 In some cases the ``SIGTERM`` signal is sent by Supervisor itself (e.g. stopping
 a Docker container having Supervisor as its entrypoint). In these cases you
 need to add a ``stopwaitsecs`` key to the program configuration (with a value
