minor #38303 [Messenger] Fix misleading comment about time-limit (sylfabre)

fabpot · fabpot · commit 013bbcc23e12 · 2020-09-26T07:30:40.000+02:00
This PR was merged into the 5.2-dev branch. Discussion ---------- [Messenger] Fix misleading comment about time-limit | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a The current explanation of the time-limit option of the `messenger:consume` command is misleading as it lets you think that this is an enforced hard limit. For instance, you may think that a command started with `--time-limit=10` will stop once 10 seconds are elapsed, no matter what. Actually, two things happen: - Once 10 seconds have elapsed, then the worker won't receive and handle any other message - The worker will keep running until the currently handled message is fully handled so it can last way longer than 10 seconds, then it will stop. I'm not sure this is behavior is actually a bug or not, but the current documentation does not describe the current behavior Commits ------- 2117664 [Messenger] Fix misleading comment about time-limit
diff --git a/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php b/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php
@@ -67,7 +67,7 @@ protected function configure(): void
                 new InputOption('limit', 'l', InputOption::VALUE_REQUIRED, 'Limit the number of received messages'),
                 new InputOption('failure-limit', 'f', InputOption::VALUE_REQUIRED, 'The number of failed messages the worker can consume'),
                 new InputOption('memory-limit', 'm', InputOption::VALUE_REQUIRED, 'The memory limit the worker can consume'),
-                new InputOption('time-limit', 't', InputOption::VALUE_REQUIRED, 'The time limit in seconds the worker can run'),
+                new InputOption('time-limit', 't', InputOption::VALUE_REQUIRED, 'The time limit in seconds the worker can handle new messages'),
                 new InputOption('sleep', null, InputOption::VALUE_REQUIRED, 'Seconds to sleep before asking for new messages after no messages were found', 1),
                 new InputOption('bus', 'b', InputOption::VALUE_REQUIRED, 'Name of the bus to which received messages should be dispatched (if not passed, bus is determined automatically)'),
             ])
@@ -93,7 +93,7 @@ protected function configure(): void
 
     <info>php %command.full_name% <receiver-name> --memory-limit=128M</info>
 
-Use the --time-limit option to stop the worker when the given time limit (in seconds) is reached:
+Use the --time-limit option to stop the worker when the given time limit (in seconds) is reached (if a message is being handled, the worker will stop after the processing finished):
 
     <info>php %command.full_name% <receiver-name> --time-limit=3600</info>
 
