bug #52080 [Messenger] Fix graceful exit (HypeMC)

fabpot · fabpot · commit 8a1fba8da4ad · 2023-10-16T22:26:39.000+02:00
This PR was merged into the 6.3 branch. Discussion ---------- [Messenger] Fix graceful exit | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #52077 | License | MIT My previous PR #50787 accidentally broke the behavior of the `messenger:consume` command. It no longer waits for the handler to finish, instead it exists immediately. Commits ------- b270382 [Messenger] Fix graceful exit
diff --git a/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php b/src/Symfony/Component/Messenger/Command/ConsumeMessagesCommand.php
@@ -271,7 +271,7 @@ public function handleSignal(int $signal, int|false $previousExitCode = 0): int|
 
         $this->worker->stop();
 
-        return 0;
+        return false;
     }
 
     private function convertToBytes(string $memoryLimit): int
diff --git a/src/Symfony/Component/Messenger/Command/FailedMessagesRetryCommand.php b/src/Symfony/Component/Messenger/Command/FailedMessagesRetryCommand.php
@@ -43,6 +43,8 @@ class FailedMessagesRetryCommand extends AbstractFailedMessagesCommand implement
     private MessageBusInterface $messageBus;
     private ?LoggerInterface $logger;
     private ?array $signals;
+    private bool $shouldStop = false;
+    private bool $forceExit = false;
     private ?Worker $worker = null;
 
     public function __construct(?string $globalReceiverName, ServiceProviderInterface $failureTransports, MessageBusInterface $messageBus, EventDispatcherInterface $eventDispatcher, LoggerInterface $logger = null, PhpSerializer $phpSerializer = null, array $signals = null)
@@ -141,8 +143,9 @@ public function handleSignal(int $signal, int|false $previousExitCode = 0): int|
         $this->logger?->info('Received signal {signal}.', ['signal' => $signal, 'transport_names' => $this->worker->getMetadata()->getTransportNames()]);
 
         $this->worker->stop();
+        $this->shouldStop = true;
 
-        return 0;
+        return $this->forceExit ? 0 : false;
     }
 
     private function runInteractive(string $failureTransportName, SymfonyStyle $io, bool $shouldForce): void
@@ -156,6 +159,10 @@ private function runInteractive(string $failureTransportName, SymfonyStyle $io,
             // to be temporarily "acked", even if the user aborts
             // handling the message
             while (true) {
+                if ($this->shouldStop) {
+                    break;
+                }
+
                 $envelopes = [];
                 $this->phpSerializer?->acceptPhpIncompleteClass();
                 try {
@@ -180,7 +187,7 @@ private function runInteractive(string $failureTransportName, SymfonyStyle $io,
         }
 
         // avoid success message if nothing was processed
-        if (1 <= $count) {
+        if (1 <= $count && !$this->shouldStop) {
             $io->success('All failed messages have been handled or removed!');
         }
     }
@@ -198,7 +205,12 @@ private function runWorker(string $failureTransportName, ReceiverInterface $rece
                 throw new \RuntimeException(sprintf('The message with id "%s" could not decoded, it can only be shown or removed.', $this->getMessageId($envelope) ?? '?'));
             }
 
-            $shouldHandle = $shouldForce || 'retry' === $io->choice('Please select an action', ['retry', 'delete'], 'retry');
+            $this->forceExit = true;
+            try {
+                $shouldHandle = $shouldForce || 'retry' === $io->choice('Please select an action', ['retry', 'delete'], 'retry');
+            } finally {
+                $this->forceExit = false;
+            }
 
             if ($shouldHandle) {
                 return;
@@ -257,6 +269,10 @@ private function retrySpecificEnvelopes(array $envelopes, string $failureTranspo
         foreach ($envelopes as $envelope) {
             $singleReceiver = new SingleMessageReceiver($receiver, $envelope);
             $this->runWorker($failureTransportName, $singleReceiver, $io, $shouldForce);
+
+            if ($this->shouldStop) {
+                break;
+            }
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -271,7 +271,7 @@ public function handleSignal(int $signal, int\|false $previousExitCode = 0): int\|`
`271`	`271`
`272`	`272`	`$this->worker->stop();`
`273`	`273`
`274`		`- return 0;`
	`274`	`+ return false;`
`275`	`275`	`}`
`276`	`276`
`277`	`277`	`private function convertToBytes(string $memoryLimit): int`