[Console] Dispatch ConsoleTerminateEvent when exiting on signal

symfony · Oct 13, 2023 · a73762c · a73762c
1 parent 3e9cabf
commit a73762c
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 7 deletions.
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -1046,7 +1046,10 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI
                         }
 
                         if (false !== $exitCode) {
-                            exit($exitCode);
+                            $event = new ConsoleTerminateEvent($command, $event->getInput(), $event->getOutput(), $exitCode, $signal);
+                            $this->dispatcher->dispatch($event, ConsoleEvents::TERMINATE);
+
+                            exit($event->getExitCode());
                         }
                     });
                 }

diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * Multi-line text in vertical tables is aligned properly
  * The application can also catch errors with `Application::setCatchErrors(true)`
  * Add `RunCommandMessage` and `RunCommandMessageHandler`
+ * Dispatch `ConsoleTerminateEvent` after an exit on signal handling and add `ConsoleTerminateEvent::getInterruptingSignal()`
 
 6.3
 ---

diff --git a/src/Symfony/Component/Console/Event/ConsoleTerminateEvent.php b/src/Symfony/Component/Console/Event/ConsoleTerminateEvent.php
@@ -19,16 +19,18 @@
  * Allows to manipulate the exit code of a command after its execution.
  *
  * @author Francesco Levorato <git@flevour.net>
+ * @author Jules Pietri <jules@heahprod.com>
  */
 final class ConsoleTerminateEvent extends ConsoleEvent
 {
-    private int $exitCode;
-
-    public function __construct(Command $command, InputInterface $input, OutputInterface $output, int $exitCode)
-    {
+    public function __construct(
+        Command $command,
+        InputInterface $input,
+        OutputInterface $output,
+        private int $exitCode,
+        private readonly ?int $interruptingSignal = null,
+    ) {
         parent::__construct($command, $input, $output);
-
-        $this->setExitCode($exitCode);
     }
 
     public function setExitCode(int $exitCode): void
@@ -40,4 +42,9 @@ public function getExitCode(): int
     {
         return $this->exitCode;
     }
+
+    public function getInterruptingSignal(): ?int
+    {
+        return $this->interruptingSignal;
+    }
 }
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -2151,8 +2151,12 @@ public function testSignalableWithEventCommandDoesNotInterruptedOnTermSignals()
 
         $command = new TerminatableWithEventCommand();
 
+        $terminateEventDispatched = false;
         $dispatcher = new EventDispatcher();
         $dispatcher->addSubscriber($command);
+        $dispatcher->addListener('console.terminate', function () use (&$terminateEventDispatched) {
+            $terminateEventDispatched = true;
+        });
         $application = new Application();
         $application->setAutoExit(false);
         $application->setDispatcher($dispatcher);
@@ -2167,6 +2171,7 @@ public function testSignalableWithEventCommandDoesNotInterruptedOnTermSignals()
 
             EOTXT;
         $this->assertSame($expected, $tester->getDisplay(true));
+        $this->assertTrue($terminateEventDispatched);
     }
 
     /**