[Console][Messenger] Fix: Allow UnrecoverableExceptionInterface to bypass retry in RunCommandMessageHandler

santysisi · kbond · santysisi · commit c726fc0f87b8 · 2025-05-21T23:28:39.000-03:00
Co-authored-by: Kevin Bond &lt;kevinbond@gmail.com&gt;
diff --git a/src/Symfony/Component/Console/Messenger/RunCommandMessageHandler.php b/src/Symfony/Component/Console/Messenger/RunCommandMessageHandler.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Console\Exception\RunCommandFailedException;
 use Symfony\Component\Console\Input\StringInput;
 use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\Messenger\Exception\UnrecoverableExceptionInterface;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
@@ -35,6 +36,8 @@ public function __invoke(RunCommandMessage $message): RunCommandContext
 
         try {
             $exitCode = $this->application->run($input, $output);
+        } catch (UnrecoverableExceptionInterface $e) {
+            throw $e;
         } catch (\Throwable $e) {
             throw new RunCommandFailedException($e, new RunCommandContext($message, Command::FAILURE, $output->fetch()));
         }
diff --git a/src/Symfony/Component/Console/Tests/Messenger/RunCommandMessageHandlerTest.php b/src/Symfony/Component/Console/Tests/Messenger/RunCommandMessageHandlerTest.php
@@ -20,6 +20,8 @@
 use Symfony\Component\Console\Messenger\RunCommandMessage;
 use Symfony\Component\Console\Messenger\RunCommandMessageHandler;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Messenger\Exception\UnrecoverableExceptionInterface;
+use Symfony\Component\Messenger\Exception\UnrecoverableMessageHandlingException;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
@@ -81,6 +83,22 @@ public function testThrowOnNonSuccess()
         $this->fail('Exception not thrown.');
     }
 
+    public function testExecutesCommandThatThrownUnrecoverableException()
+    {
+        $handler = new RunCommandMessageHandler($this->createApplicationWithCommand());
+
+        try {
+            $handler(new RunCommandMessage('test:command --throw-unrecoverable'));
+        } catch (UnrecoverableExceptionInterface $e) {
+            $this->assertSame('unrecoverable exception message', $e->getMessage());
+            $this->assertNull($e->getPrevious());
+
+            return;
+        }
+
+        $this->fail('Exception not thrown.');
+    }
+
     private function createApplicationWithCommand(): Application
     {
         $application = new Application();
@@ -92,6 +110,7 @@ public function configure(): void
                     $this
                         ->setName('test:command')
                         ->addOption('throw')
+                        ->addOption('throw-unrecoverable')
                         ->addOption('exit', null, InputOption::VALUE_REQUIRED, 0)
                     ;
                 }
@@ -100,6 +119,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 {
                     $output->write('some message');
 
+                    if ($input->getOption('throw-unrecoverable')) {
+                        throw new UnrecoverableMessageHandlingException('unrecoverable exception message');
+                    }
+
                     if ($input->getOption('throw')) {
                         throw new \RuntimeException('exception message');
                     }
