[Console] Dispatch ConsoleTerminateEvent when exiting on signal

HeahDude · HeahDude · commit a73762c54da1 · 2023-10-13T11:39:15.000+02:00
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);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -1046,7 +1046,10 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI`
`1046`	`1046`	`}`
`1047`	`1047`
`1048`	`1048`	`if (false !== $exitCode) {`
`1049`		`- exit($exitCode);`
	`1049`	`+ $event = new ConsoleTerminateEvent($command, $event->getInput(), $event->getOutput(), $exitCode, $signal);`
	`1050`	`+ $this->dispatcher->dispatch($event, ConsoleEvents::TERMINATE);`
	`1051`	`+`
	`1052`	`+ exit($event->getExitCode());`
`1050`	`1053`	`}`
`1051`	`1054`	`});`
`1052`	`1055`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,16 +19,18 @@`
`19`	`19`	`* Allows to manipulate the exit code of a command after its execution.`
`20`	`20`	`*`
`21`	`21`	`* @author Francesco Levorato <git@flevour.net>`
	`22`	`+ * @author Jules Pietri <jules@heahprod.com>`
`22`	`23`	`*/`
`23`	`24`	`final class ConsoleTerminateEvent extends ConsoleEvent`
`24`	`25`	`{`
`25`		`- private int $exitCode;`
`26`		`-`
`27`		`- public function __construct(Command $command, InputInterface $input, OutputInterface $output, int $exitCode)`
`28`		`- {`
	`26`	`+ public function __construct(`
	`27`	`+ Command $command,`
	`28`	`+ InputInterface $input,`
	`29`	`+ OutputInterface $output,`
	`30`	`+ private int $exitCode,`
	`31`	`+ private readonly ?int $interruptingSignal = null,`
	`32`	`+ ) {`
`29`	`33`	`parent::__construct($command, $input, $output);`
`30`		`-`
`31`		`- $this->setExitCode($exitCode);`
`32`	`34`	`}`
`33`	`35`
`34`	`36`	`public function setExitCode(int $exitCode): void`
`@@ -40,4 +42,9 @@ public function getExitCode(): int`
`40`	`42`	`{`
`41`	`43`	`return $this->exitCode;`
`42`	`44`	`}`
	`45`	`+`
	`46`	`+ public function getInterruptingSignal(): ?int`
	`47`	`+ {`
	`48`	`+ return $this->interruptingSignal;`
	`49`	`+ }`
`43`	`50`	`}`