Rollback all workaround from #23 and go all-in with SignalableCommandInterface

Author: Jean85

phpunit.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
-         bootstrap="tests/bootstrap.php"
+         bootstrap="vendor/autoload.php"
          executionOrder="depends,defects"
          cacheResult="false"
          colors="true"

psalm.xml

@@ -10,7 +10,6 @@
         <directory name="src" />
         <ignoreFiles>
             <directory name="vendor" />
-            <file name="src/AbstractTerminableCommandAfterSymfony7_3.php" />
         </ignoreFiles>
     </projectFiles>
 </psalm>

src/AbstractTerminableCommand.php

@@ -9,113 +9,102 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-if (
-    PHP_VERSION_ID >= 8_02_00
-    && interface_exists(SignalableCommandInterface::class)
-    && in_array(
-        SignalableCommandInterface::class,
-        class_implements(Command::class),
-        true
-    )
-) {
-    require_once __DIR__ . '/AbstractTerminableCommandAfterSymfony7_3.php';
-} else {
-    abstract class AbstractTerminableCommand extends Command
-    {
-        private const REQUEST_TO_TERMINATE = 143;
-
-        /** @var int */
-        private $sleepDuration;
-
-        /** @var bool */
-        private $signalShutdownRequested;
+abstract class AbstractTerminableCommand extends Command implements SignalableCommandInterface
+{
+    private const REQUEST_TO_TERMINATE = 143;
 
-        public function __construct(?string $name = null)
-        {
-            $this->sleepDuration = 0;
-            $this->signalShutdownRequested = false;
+    /** @var int */
+    private $sleepDuration;
 
-            parent::__construct($name);
-        }
+    /** @var bool */
+    private $signalShutdownRequested;
 
-        final protected function execute(InputInterface $input, OutputInterface $output): int
-        {
-            $this->trapSignals();
+    public function __construct(?string $name = null)
+    {
+        $this->sleepDuration = 0;
+        $this->signalShutdownRequested = false;
 
-            $output->writeln('Starting ' . ($this->getName() ?? static::class), OutputInterface::VERBOSITY_VERBOSE);
+        parent::__construct($name);
+    }
 
-            if ($this->signalShutdownRequested) {
-                $output->writeln('Signal received, skipping execution', OutputInterface::VERBOSITY_NORMAL);
+    final protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $output->writeln('Starting ' . ($this->getName() ?? static::class), OutputInterface::VERBOSITY_VERBOSE);
 
-                return self::REQUEST_TO_TERMINATE;
-            }
+        if ($this->signalShutdownRequested) {
+            $output->writeln('Signal received, skipping execution', OutputInterface::VERBOSITY_NORMAL);
 
-            $exitCode = $this->commandBody($input, $output);
+            return self::REQUEST_TO_TERMINATE;
+        }
 
-            $this->sleep($output);
+        $exitCode = $this->commandBody($input, $output);
 
-            /** @psalm-suppress DocblockTypeContradiction */
-            if ($this->signalShutdownRequested) {
-                $output->writeln('Signal received, terminating with exit code ' . self::REQUEST_TO_TERMINATE, OutputInterface::VERBOSITY_NORMAL);
+        $this->sleep($output);
 
-                return self::REQUEST_TO_TERMINATE;
-            }
+        /** @psalm-suppress DocblockTypeContradiction */
+        if ($this->signalShutdownRequested) {
+            $output->writeln('Signal received, terminating with exit code ' . self::REQUEST_TO_TERMINATE, OutputInterface::VERBOSITY_NORMAL);
 
-            return $exitCode;
+            return self::REQUEST_TO_TERMINATE;
         }
 
-        abstract protected function commandBody(InputInterface $input, OutputInterface $output): int;
-
-        public function handleSignal(int $signal): void
-        {
-            switch ($signal) {
-                // Shutdown signals
-                case SIGTERM:
-                case SIGINT:
-                    $this->signalShutdownRequested = true;
-                    break;
-            }
-        }
+        return $exitCode;
+    }
 
-        private function trapSignals(): void
-        {
-            pcntl_async_signals(true);
+    abstract protected function commandBody(InputInterface $input, OutputInterface $output): int;
 
-            // Add the signal handler
-            pcntl_signal(SIGTERM, [$this, 'handleSignal']);
-            pcntl_signal(SIGINT, [$this, 'handleSignal']);
+    public function handleSignal(int $signal, int|false $previousExitCode = 0): false
+    {
+        switch ($signal) {
+            // Shutdown signals
+            case SIGTERM:
+            case SIGINT:
+                $this->signalShutdownRequested = true;
         }
 
-        protected function getSleepDuration(): int
-        {
-            return $this->sleepDuration;
-        }
+        return false;
+    }
+
+    /**
+     * @return list<int>
+     */
+    public function getSubscribedSignals(): array
+    {
+        return [
+            SIGTERM,
+            SIGINT,
+        ];
+    }
 
-        protected function setSleepDuration(int $sleepDuration): void
-        {
-            if ($sleepDuration < 0) {
-                throw new \InvalidArgumentException('Invalid timeout provided to ' . __METHOD__);
-            }
+    protected function getSleepDuration(): int
+    {
+        return $this->sleepDuration;
+    }
 
-            $this->sleepDuration = $sleepDuration;
+    protected function setSleepDuration(int $sleepDuration): void
+    {
+        if ($sleepDuration < 0) {
+            throw new \InvalidArgumentException('Invalid timeout provided to ' . __METHOD__);
         }
 
-        private function sleep(OutputInterface $output): void
-        {
-            if (0 === $this->sleepDuration) {
-                return;
-            }
+        $this->sleepDuration = $sleepDuration;
+    }
 
-            $sleepCountDown = $this->sleepDuration;
+    private function sleep(OutputInterface $output): void
+    {
+        if (0 === $this->sleepDuration) {
+            return;
+        }
 
-            while (! $this->signalShutdownRequested && --$sleepCountDown) {
-                sleep(1);
-            }
+        $sleepCountDown = $this->sleepDuration;
 
-            $output->writeln(
-                sprintf('Slept %d second(s)', $this->sleepDuration - $sleepCountDown),
-                OutputInterface::VERBOSITY_DEBUG
-            );
+        while (! $this->signalShutdownRequested && --$sleepCountDown) {
+            sleep(1);
         }
+
+        $output->writeln(
+            sprintf('Slept %d second(s)', $this->sleepDuration - $sleepCountDown),
+            OutputInterface::VERBOSITY_DEBUG
+        );
     }
 }

src/AbstractTerminableCommandAfterSymfony7_3.php

@@ -9,7 +9,6 @@
 use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Symfony\Bridge\PhpUnit\ClockMock;
-use Symfony\Component\Console\Command\SignalableCommandInterface;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -141,10 +140,6 @@ public function testGetSubscribedSignals(int $signal): void
     {
         $stubCommand = $this->createStubTerminableCommand();
 
-        if (! interface_exists(SignalableCommandInterface::class) || ! $stubCommand instanceof SignalableCommandInterface) {
-            $this->markTestSkipped('This test requires the Symfony 7.3+ implementation');
-        }
-
         $this->assertContains($signal, $stubCommand->getSubscribedSignals(), 'Signal not subscribed to');
     }