[Messenger] Messenger: add `--duration` option to `messenger:stop-workers` command #60517

dwalck · 2025-05-22T18:50:16Z

Q	A
Branch?	7.4
Bug fix?	no
New feature?	yes
Deprecations?	no
License	MIT

Hi!

My proposal is to add a --duration option to the messenger:stop-workers command, which would allow to "pause" the workers for the amount of time specified in this option.

For example, if we pass --duration=10, then for the next 10 seconds, running messenger:consume will return a message indicating how many seconds are left until the "pause" ends.

I think this option would be helpful during deployments (we're using it this way in my company).

carsonbot · 2025-05-22T18:50:22Z

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

Always add tests
Keep backward compatibility (see https://symfony.com/bc).
Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
Features and deprecations must be submitted against the 7.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

OskarStark · 2025-05-23T04:40:23Z

Please add a line in the changelog. Please use 7.4 there, as 7.3 is already in feature freeze 🥶

It looks that your committer email is not associated with your GitHub account, you might want to check this.

alexandre-daubois · 2025-05-23T06:44:53Z

src/Symfony/Component/Messenger/CHANGELOG.md

+7.4
+---
+
+* Add `--duration` option to `messenger:stop-workers` command to keep workers in paused state.


Suggested change

* Add `--duration` option to `messenger:stop-workers` command to keep workers in paused state.

* Add `--duration` option to `messenger:stop-workers` command to keep workers in paused state

fabpot · 2025-05-30T06:32:24Z

src/Symfony/Component/Messenger/Command/StopWorkersCommand.php

@@ -44,6 +48,11 @@ protected function configure(): void
 Each worker command will finish the message they are currently processing
 and then exit. Worker commands are *not* automatically restarted: that
 should be handled by a process control system.
+
+Use the --duration option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).


Suggested change

Use the --duration option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).

Use the <comment>--duration</comment> option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).

fabpot · 2025-05-30T06:34:21Z

src/Symfony/Component/Messenger/Command/StopWorkersCommand.php

@@ -35,7 +37,9 @@ public function __construct(
    protected function configure(): void
    {
        $this
-            ->setDefinition([])
+            ->setDefinition([
+                new InputOption('duration', 'd', InputOption::VALUE_REQUIRED, 'Duration in seconds to keep the workers stopped'),


Suggested change

new InputOption('duration', 'd', InputOption::VALUE_REQUIRED, 'Duration in seconds to keep the workers stopped'),

new InputOption('duration', 'd', InputOption::VALUE_REQUIRED, 'Duration in seconds during which workers are paused (not processing messages)'),

fabpot · 2025-05-30T06:35:28Z

src/Symfony/Component/Messenger/Command/StopWorkersCommand.php

        $this->restartSignalCachePool->save($cacheItem);

        $io->success('Signal successfully sent to stop any running workers.');
+        if ($duration > 0) {
+            $io->info(sprintf('Workers will be stopped for next %s seconds.', $duration));


Suggested change

$io->info(sprintf('Workers will be stopped for next %s seconds.', $duration));

$io->info(sprintf('Workers will be paused for %s seconds.', $duration));

fabpot · 2025-05-30T06:36:59Z

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

+        if ($this->shouldRestart()) {
+            $event->getWorker()->stop();
+            $remainingStopSeconds = ceil($this->getEndOfStopTime()) - time();
+            $this->logger?->info(sprintf('Worker is stopped and message processing is paused for the next %d seconds.', $remainingStopSeconds));


Suggested change

$this->logger?->info(sprintf('Worker is stopped and message processing is paused for the next %d seconds.', $remainingStopSeconds));

$this->logger?->info(sprintf('The worker is paused and message processing will resume in %d seconds.', $remainingStopSeconds));

dwalck · 2025-06-01T11:21:27Z

@fabpot done

update: Rebased due to some failing tests ([Windows / x86 / minimal-exts)) 😸

fabpot · 2025-08-17T16:57:35Z

src/Symfony/Component/Messenger/Command/StopWorkersCommand.php

@@ -44,6 +48,11 @@ protected function configure(): void
 Each worker command will finish the message they are currently processing
 and then exit. Worker commands are *not* automatically restarted: that
 should be handled by a process control system.
+
+Use the <comment>--duration</comment> option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).


Suggested change

Use the <comment>--duration</comment> option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).

Use the <info>--duration</info> option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).

fabpot · 2025-08-17T16:59:02Z

src/Symfony/Component/Messenger/Command/StopWorkersCommand.php

+        if (null !== $duration = $input->getOption('duration')) {
+            if (!is_numeric($duration) || 0 >= $duration) {
+                throw new InvalidOptionException(\sprintf('Option "duration" must be a positive integer, "%s" passed.', $duration));
+            }
+        }


Suggested change

if (null !== $duration = $input->getOption('duration')) {

if (!is_numeric($duration) || 0 >= $duration) {

throw new InvalidOptionException(\sprintf('Option "duration" must be a positive integer, "%s" passed.', $duration));

}

}

$duration = (int) $input->getOption('duration')

fabpot · 2025-08-17T16:59:43Z

src/Symfony/Component/Messenger/Command/StopWorkersCommand.php

        $this->restartSignalCachePool->save($cacheItem);

        $io->success('Signal successfully sent to stop any running workers.');
+        if ($duration > 0) {
+            $io->info(sprintf('Workers will be paused for %s seconds.', $duration));


Suggested change

$io->info(sprintf('Workers will be paused for %s seconds.', $duration));

$io->info(\sprintf('Workers will be paused for %s seconds.', $duration));

fabpot · 2025-08-17T16:59:59Z

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

+        if ($this->shouldRestart()) {
+            $event->getWorker()->stop();
+            $remainingStopSeconds = ceil($this->getEndOfStopTime()) - time();
+            $this->logger?->info(sprintf('The worker is paused and message processing will resume in %d seconds.', $remainingStopSeconds));


Suggested change

$this->logger?->info(sprintf('The worker is paused and message processing will resume in %d seconds.', $remainingStopSeconds));

$this->logger?->info(\sprintf('The worker is paused and message processing will resume in %d seconds.', $remainingStopSeconds));

dwalck · 2025-08-18T23:17:27Z

Done.

I think Fabbot is mistaken in this case 😄

OskarStark · 2025-08-19T05:25:57Z

Maybe I miss something here, but calling a stop command with a duration, which does not stop anything sounds weird. Why not a dedicated "pause" command?

dwalck · 2025-08-19T07:55:02Z

@OskarStark using this option does not change the default behavior of the command. I’m open to suggestions regarding creating a new command, but from my perspective this functionality extends the existing behavior of stopping workers, so I added it as an option to the existing command.

carsonbot added Status: Needs Review Feature labels May 22, 2025

carsonbot added this to the 7.3 milestone May 22, 2025

OskarStark added the Messenger label May 23, 2025

carsonbot changed the title ~~Messenger: add --duration option to messenger:stop-workers command~~ [Messenger] Messenger: add --duration option to messenger:stop-workers command May 23, 2025

dwalck force-pushed the feature/messenger-stop-workers-duration branch 2 times, most recently from 3c603a7 to 779fcb2 Compare May 23, 2025 06:19

alexandre-daubois reviewed May 23, 2025

View reviewed changes

OskarStark changed the title ~~[Messenger] Messenger: add --duration option to messenger:stop-workers command~~ [Messenger] Messenger: add --duration option to messenger:stop-workers command May 23, 2025

dwalck force-pushed the feature/messenger-stop-workers-duration branch 2 times, most recently from b604d41 to 60b0c31 Compare May 25, 2025 17:18

fabpot modified the milestones: 7.3, 7.4 May 26, 2025

fabpot requested changes May 30, 2025

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels May 30, 2025

dwalck force-pushed the feature/messenger-stop-workers-duration branch from 9e94973 to a75bc99 Compare June 1, 2025 11:36

fabpot requested changes Aug 17, 2025

View reviewed changes

dwalck added 8 commits August 18, 2025 23:03

Messenger: add duration option to messenger:stop-workers command

671836d

Fix psalm

e012589

undo already existing test change

db8175c

Messenger: add duration option to messenger:stop-workers command

52c3e93

Add changelog

5ec272f

Remove with() from modified test

b234afe

Update changelog after review

e69ff31

Changes after fabpot review

9c32d93

dwalck force-pushed the feature/messenger-stop-workers-duration branch from a75bc99 to 9c32d93 Compare August 18, 2025 22:45

dwalck added 3 commits August 19, 2025 00:54

CR fixes

d3b3b66

tests & cs fixes

48382b4

remove useless use

61120c9

dwalck requested a review from fabpot August 18, 2025 23:15

carsonbot added Status: Needs Review and removed Status: Needs Work labels Aug 18, 2025

	* Add `--duration` option to `messenger:stop-workers` command to keep workers in paused state.
	* Add `--duration` option to `messenger:stop-workers` command to keep workers in paused state

	Use the --duration option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).
	Use the <comment>--duration</comment> option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).

	new InputOption('duration', 'd', InputOption::VALUE_REQUIRED, 'Duration in seconds to keep the workers stopped'),
	new InputOption('duration', 'd', InputOption::VALUE_REQUIRED, 'Duration in seconds during which workers are paused (not processing messages)'),

	$io->info(sprintf('Workers will be stopped for next %s seconds.', $duration));
	$io->info(sprintf('Workers will be paused for %s seconds.', $duration));

	$this->logger?->info(sprintf('Worker is stopped and message processing is paused for the next %d seconds.', $remainingStopSeconds));
	$this->logger?->info(sprintf('The worker is paused and message processing will resume in %d seconds.', $remainingStopSeconds));

	Use the <comment>--duration</comment> option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).
	Use the <info>--duration</info> option to keep the workers in a paused state (not processing messages) for the given duration (in seconds).

	$io->info(sprintf('Workers will be paused for %s seconds.', $duration));
	$io->info(\sprintf('Workers will be paused for %s seconds.', $duration));

	$this->logger?->info(sprintf('The worker is paused and message processing will resume in %d seconds.', $remainingStopSeconds));
	$this->logger?->info(\sprintf('The worker is paused and message processing will resume in %d seconds.', $remainingStopSeconds));

Uh oh!

[Messenger] Messenger: add --duration option to messenger:stop-workers command #60517

Are you sure you want to change the base?

[Messenger] Messenger: add --duration option to messenger:stop-workers command #60517

Uh oh!

Conversation

dwalck commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

carsonbot commented May 22, 2025

Uh oh!

OskarStark commented May 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dwalck commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dwalck commented Aug 18, 2025

Uh oh!

OskarStark commented Aug 19, 2025

Uh oh!

dwalck commented Aug 19, 2025

Uh oh!

Uh oh!

[Messenger] Messenger: add `--duration` option to `messenger:stop-workers` command #60517

[Messenger] Messenger: add `--duration` option to `messenger:stop-workers` command #60517

dwalck commented May 22, 2025 •

edited

Loading

dwalck commented Jun 1, 2025 •

edited

Loading