[FrameworkBundle] Make StopWorkerOnSignalsListener configurable via messenger's config

Rokas Mikalkėnas · nicolas-grekas · commit 245d75df943d · 2023-03-20T14:16:09.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -20,6 +20,7 @@ CHANGELOG
  * Add `AbstractController::sendEarlyHints()` to send HTTP Early Hints
  * Add autowiring aliases for `Http\Client\HttpAsyncClient`
  * Deprecate the `Http\Client\HttpClient` service, use `Psr\Http\Client\ClientInterface` instead
+ * Add `stop_worker_on_signals` configuration option to `messenger` to define signals which would stop a worker
 
 6.2
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -1528,6 +1528,11 @@ function ($a) {
                                 ->thenInvalid('The "framework.messenger.reset_on_message" configuration option can be set to "true" only. To prevent services resetting after each message you can set the "--no-reset" option in "messenger:consume" command.')
                             ->end()
                         ->end()
+                        ->arrayNode('stop_worker_on_signals')
+                            ->defaultValue([])
+                            ->info('A list of signals that should stop the worker; defaults to SIGTERM and SIGINT.')
+                            ->integerPrototype()->end()
+                        ->end()
                         ->scalarNode('default_bus')->defaultNull()->end()
                         ->arrayNode('buses')
                             ->defaultValue(['messenger.bus.default' => ['default_middleware' => ['enabled' => true, 'allow_no_handlers' => false, 'allow_no_senders' => true], 'middleware' => []]])
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -2050,6 +2050,10 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
             $container->getDefinition('messenger.transport.beanstalkd.factory')->addTag('messenger.transport_factory');
         }
 
+        if ($config['stop_worker_on_signals']) {
+            $container->getDefinition('messenger.listener.stop_worker_signals_listener')->replaceArgument(0, $config['stop_worker_on_signals']);
+        }
+
         if (null === $config['default_bus'] && 1 === \count($config['buses'])) {
             $config['default_bus'] = key($config['buses']);
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -639,6 +639,7 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 'default_bus' => null,
                 'buses' => ['messenger.bus.default' => ['default_middleware' => ['enabled' => true, 'allow_no_handlers' => false, 'allow_no_senders' => true], 'middleware' => []]],
                 'reset_on_message' => true,
+                'stop_worker_on_signals' => [],
             ],
             'disallow_search_engine_index' => true,
             'http_client' => [

Original file line number	Diff line number	Diff line change
`@@ -2050,6 +2050,10 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder`
`2050`	`2050`	`$container->getDefinition('messenger.transport.beanstalkd.factory')->addTag('messenger.transport_factory');`
`2051`	`2051`	`}`
`2052`	`2052`
	`2053`	`+ if ($config['stop_worker_on_signals']) {`
	`2054`	`+ $container->getDefinition('messenger.listener.stop_worker_signals_listener')->replaceArgument(0, $config['stop_worker_on_signals']);`
	`2055`	`+ }`
	`2056`	`+`
`2053`	`2057`	`if (null === $config['default_bus'] && 1 === \count($config['buses'])) {`
`2054`	`2058`	`$config['default_bus'] = key($config['buses']);`
`2055`	`2059`	`}`