Fixes #43866 configurable stop signals for messenger #44305

Warxcell · 2021-11-27T12:20:43Z

Q	A
Branch?	6.1
Bug fix?	yes
New feature?	yes
Deprecations?	yes
Tickets	Fix #43866
License	MIT
Doc PR	symfony/symfony-docs# TODO

carsonbot · 2021-11-28T08:22:13Z

Hey!

I think @ruudk has recently worked with this code. Maybe they can help review this?

Cheers!

Carsonbot

ruudk

Looks great, added a few comments.

ruudk · 2021-11-28T08:27:03Z

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger.yml

@@ -1,5 +1,6 @@
 framework:
    messenger:
+        stop_signals: SIGTERM


Why does this have to be plural (a list of signals) instead of just 1 signal?

Suggested change

stop_signals: SIGTERM

stop_signal: SIGTERM

in case project is used in several envs (docker FPM alpine environment, and classical VMs/bare-metal with supervisor) where signals could be different.

Then configure the correct signal for that env. Doesn't make sense (to me) to just fire all the signals.

Agreed with @Warxcell. we should allow multiple signals.

ruudk · 2021-11-28T08:31:00Z

src/Symfony/Component/Messenger/EventListener/StopWorkerOnSignalListener.php

+    private function strsignal(int $signal): string
+    {
+        foreach (get_defined_constants(true)['pcntl'] as $name => $num) {
+            // the _ is to ignore SIG_IGN and SIG_DFL and SIG_ERR and SIG_BLOCK and SIG_UNBLOCK and SIG_SETMARK, and maybe more, who knows
+            if ($num === $signal && 'SIG' === substr($name, 0, 3) && '_' !== $name[3]) {
+                return $name;
+            }
+        }
+
+        throw new \InvalidArgumentException(sprintf('The signal "%d" is not valid.', $signal));
+    }


I would move this responsibility to the compilation/configuration step and just always have the signal int injected via the constructor.

this is the case, but for logger, we need the name of the signal - so I need to reverse the logic - get the signal name by its id (int)

jderusse

for 6.1 as it's a new feature

jderusse · 2021-11-28T11:45:38Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -1306,6 +1311,18 @@ private function addMessengerSection(ArrayNodeDefinition $rootNode, callable $en
                        ->then(static function (array $v): void { throw new InvalidConfigurationException(sprintf('The specified default bus "%s" is not configured. Available buses are "%s".', $v['default_bus'], implode('", "', array_keys($v['buses'])))); })
                    ->end()
                    ->children()
+                        ->arrayNode('stop_signals')
+                            ->beforeNormalization()
+                                ->ifString()->then(static fn (string $value): int => constant($value))


shouldn't we check of the constant exists and is a supported signal?

if constant doesn't exists - it will return null, and will be caught at validate. About supported signal, it's checked inside the Listeners itself.

jderusse · 2021-11-28T11:48:11Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -1306,6 +1311,18 @@ private function addMessengerSection(ArrayNodeDefinition $rootNode, callable $en
                        ->then(static function (array $v): void { throw new InvalidConfigurationException(sprintf('The specified default bus "%s" is not configured. Available buses are "%s".', $v['default_bus'], implode('", "', array_keys($v['buses'])))); })
                    ->end()
                    ->children()
+                        ->arrayNode('stop_signals')


For lists, you should add fixXmlConfig

jderusse · 2021-11-28T11:49:43Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -41,6 +41,11 @@
 use Symfony\Component\WebLink\HttpHeaderSerializer;
 use Symfony\Component\Workflow\WorkflowEvents;

+use function array_keys;
+use function constant;


do not import functions please.

jderusse · 2021-11-28T11:50:36Z

src/Symfony/Bundle/FrameworkBundle/Resources/config/messenger.php

@@ -192,8 +193,9 @@
            ->tag('kernel.event_subscriber')
            ->tag('monolog.logger', ['channel' => 'messenger'])

-        ->set('messenger.listener.stop_worker_on_sigterm_signal_listener', StopWorkerOnSigtermSignalListener::class)


is it a BC break? 🤔

isn't that internal service used by framework itself? how can it be BC-break?

jderusse · 2021-11-28T11:53:19Z

src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/messenger.yml

@@ -1,5 +1,6 @@
 framework:
    messenger:
+        stop_signals: SIGTERM


Agreed with @Warxcell. we should allow multiple signals.

magnetik · 2022-02-22T08:31:11Z

@Warxcell hi, sorry for the direct ping :)
Are you willing to continue this PR or can someone take this over?

Warxcell · 2022-02-28T07:43:36Z

Yes, sorry. Will try to finish till the end of the week.

Warxcell · 2022-03-15T08:43:49Z

Need a little help - one test needs PCNTL extension, and the other don't need it - is this achievable?

fabpot · 2024-04-08T11:07:13Z

Closing in favor of #54510

carsonbot added Status: Needs Review Bug Deprecation Feature labels Nov 27, 2021

carsonbot added this to the 6.0 milestone Nov 27, 2021

Warxcell marked this pull request as draft November 27, 2021 14:23

ruudk reviewed Nov 28, 2021

View reviewed changes

jderusse modified the milestones: 6.0, 6.1 Nov 28, 2021

jderusse reviewed Nov 28, 2021

View reviewed changes

Warxcell force-pushed the configurable_stop_signal branch 2 times, most recently from 33341f9 to 8aaa16d Compare March 15, 2022 07:28

Warxcell changed the base branch from 6.0 to 6.1 March 15, 2022 07:30

Warxcell force-pushed the configurable_stop_signal branch 2 times, most recently from 58cd5d6 to dac1bd8 Compare March 15, 2022 07:39

Fixes symfony#43866 configurable stop signals for messenger

2aef839

Warxcell force-pushed the configurable_stop_signal branch from dac1bd8 to 2aef839 Compare March 15, 2022 08:43

fabpot modified the milestones: 6.1, 6.2 May 20, 2022

nicolas-grekas modified the milestones: 6.2, 6.3 Nov 5, 2022

nicolas-grekas modified the milestones: 6.3, 6.4 May 23, 2023

nicolas-grekas modified the milestones: 6.4, 7.1 Nov 15, 2023

nicolas-grekas added this to the 6.4 milestone Nov 15, 2023

fabpot closed this Apr 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #43866 configurable stop signals for messenger #44305

Fixes #43866 configurable stop signals for messenger #44305

Warxcell commented Nov 27, 2021 •

edited

Loading

carsonbot commented Nov 28, 2021

ruudk left a comment

ruudk Nov 28, 2021

Warxcell Nov 28, 2021 •

edited

Loading

ruudk Nov 28, 2021

jderusse Nov 28, 2021

ruudk Nov 28, 2021

Warxcell Nov 28, 2021

jderusse left a comment

jderusse Nov 28, 2021

Warxcell Nov 29, 2021

jderusse Nov 28, 2021

jderusse Nov 28, 2021

jderusse Nov 28, 2021

Warxcell Nov 29, 2021

jderusse Nov 28, 2021

magnetik commented Feb 22, 2022

Warxcell commented Feb 28, 2022

Warxcell commented Mar 15, 2022

fabpot commented Apr 8, 2024

Fixes #43866 configurable stop signals for messenger #44305

Fixes #43866 configurable stop signals for messenger #44305

Conversation

Warxcell commented Nov 27, 2021 • edited Loading

carsonbot commented Nov 28, 2021

ruudk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Warxcell Nov 28, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jderusse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magnetik commented Feb 22, 2022

Warxcell commented Feb 28, 2022

Warxcell commented Mar 15, 2022

fabpot commented Apr 8, 2024

Warxcell commented Nov 27, 2021 •

edited

Loading

Warxcell Nov 28, 2021 •

edited

Loading