feature #48299 [Console] #47809 remove exit() call in last SignalHandler (akuzia)

fabpot · fabpot · commit ed1e8be65099 · 2022-12-09T08:39:33.000+01:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [Console] #47809 remove exit() call in last SignalHandler | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | BC? | yes | New feature? | no | Deprecations? | not sure | Tickets | Fix #47809 | License | MIT This PR possibly introduces some breaking changes. Remove last SignalHandler `exit()` call in `Application:doRunCommand` introduced in df57119. For more context see #47809 Commits ------- bb7779d [Console] #47809 remove exit() call in last SignalHandler
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -998,15 +998,8 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI
                 foreach ($this->signalsToDispatchEvent as $signal) {
                     $event = new ConsoleSignalEvent($command, $input, $output, $signal);
 
-                    $this->signalRegistry->register($signal, function ($signal, $hasNext) use ($event) {
+                    $this->signalRegistry->register($signal, function () use ($event) {
                         $this->dispatcher->dispatch($event, ConsoleEvents::SIGNAL);
-
-                        // No more handlers, we try to simulate PHP default behavior
-                        if (!$hasNext) {
-                            if (!\in_array($signal, [\SIGUSR1, \SIGUSR2], true)) {
-                                exit(0);
-                            }
-                        }
                     });
                 }
             }
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.3
+---
+
+ * Remove `exit` call in `Application` signal handlers. Commands will no longer be automatically interrupted after receiving signal other than `SIGUSR1` or `SIGUSR2`
+
 6.2
 ---
 
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -2014,6 +2014,19 @@ public function testSignalableCommandHandlerCalledAfterEventListener()
         $this->assertSame([SignalEventSubscriber::class, SignableCommand::class], $command->signalHandlers);
     }
 
+    public function testSignalableCommandDoesNotInterruptedOnTermSignals()
+    {
+        $command = new TerminatableCommand(true, \SIGINT);
+        $command->exitCode = 129;
+
+        $dispatcher = new EventDispatcher();
+        $application = new Application();
+        $application->setAutoExit(false);
+        $application->setDispatcher($dispatcher);
+        $application->add($command);
+        $this->assertSame(129, $application->run(new ArrayInput(['signal'])));
+    }
+
     /**
      * @group tty
      */
@@ -2113,26 +2126,31 @@ public function isEnabled(): bool
 class BaseSignableCommand extends Command
 {
     public $signaled = false;
+    public $exitCode = 1;
     public $signalHandlers = [];
     public $loop = 1000;
     private $emitsSignal;
+    private $signal;
 
-    public function __construct(bool $emitsSignal = true)
+    protected static $defaultName = 'signal';
+
+    public function __construct(bool $emitsSignal = true, int $signal = \SIGUSR1)
     {
         parent::__construct();
         $this->emitsSignal = $emitsSignal;
+        $this->signal = $signal;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         if ($this->emitsSignal) {
-            posix_kill(posix_getpid(), \SIGUSR1);
+            posix_kill(posix_getpid(), $this->signal);
         }
 
         for ($i = 0; $i < $this->loop; ++$i) {
             usleep(100);
             if ($this->signaled) {
-                return 1;
+                return $this->exitCode;
             }
         }
 
@@ -2155,6 +2173,22 @@ public function handleSignal(int $signal): void
     }
 }
 
+class TerminatableCommand extends BaseSignableCommand implements SignalableCommandInterface
+{
+    protected static $defaultName = 'signal';
+
+    public function getSubscribedSignals(): array
+    {
+        return SignalRegistry::isSupported() ? [\SIGINT] : [];
+    }
+
+    public function handleSignal(int $signal): void
+    {
+        $this->signaled = true;
+        $this->signalHandlers[] = __CLASS__;
+    }
+}
+
 class SignalEventSubscriber implements EventSubscriberInterface
 {
     public $signaled = false;
