[Console] Add support for SignalableCommandInterface with invokable commands

HypeMC · HypeMC · commit b2deac69abb9 · 2025-05-09T06:58:40.000+02:00
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -14,6 +14,7 @@ CHANGELOG
  * Add support for `LockableTrait` in invokable commands
  * Deprecate returning a non-integer value from a `\Closure` function set via `Command::setCode()`
  * Mark `#[AsCommand]` attribute as `@final`
+ * Add support for `SignalableCommandInterface` with invokable commands
 
 7.2
 ---
diff --git a/src/Symfony/Component/Console/Command/SignalableCommand.php b/src/Symfony/Component/Console/Command/SignalableCommand.php
@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Command;
+
+use Symfony\Component\Console\Exception\InvalidArgumentException;
+use Symfony\Component\Console\Exception\LogicException;
+
+/**
+ * @internal
+ */
+class SignalableCommand extends Command implements SignalableCommandInterface
+{
+    private ?SignalableCommandInterface $code = null;
+
+    public function setCode(callable $code): static
+    {
+        if (!$code instanceof SignalableCommandInterface) {
+            throw new InvalidArgumentException(\sprintf('The callable must be an object that implements the "%s" interface.', SignalableCommandInterface::class));
+        }
+
+        $this->code = $code;
+
+        return parent::setCode($code);
+    }
+
+    public function getSubscribedSignals(): array
+    {
+        if (null === $this->code) {
+            throw new LogicException('A callable must be set using the setCode() method.');
+        }
+
+        return $this->code->getSubscribedSignals();
+    }
+
+    public function handleSignal(int $signal, false|int $previousExitCode = 0): int|false
+    {
+        if (null === $this->code) {
+            throw new LogicException('A callable must be set using the setCode() method.');
+        }
+
+        return $this->code->handleSignal($signal, $previousExitCode);
+    }
+}
diff --git a/src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php b/src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php
@@ -14,6 +14,8 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\LazyCommand;
+use Symfony\Component\Console\Command\SignalableCommand;
+use Symfony\Component\Console\Command\SignalableCommandInterface;
 use Symfony\Component\Console\CommandLoader\ContainerCommandLoader;
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -51,7 +53,7 @@ public function process(ContainerBuilder $container): void
                 }
 
                 $invokableRef = new Reference($id);
-                $definition = $container->register($id .= '.command', $class = Command::class)
+                $definition = $container->register($id .= '.command', $class = $r->implementsInterface(SignalableCommandInterface::class) ? SignalableCommand::class : Command::class)
                     ->addMethodCall('setCode', [$invokableRef]);
             } else {
                 $invokableRef = null;
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -17,6 +17,7 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\HelpCommand;
 use Symfony\Component\Console\Command\LazyCommand;
+use Symfony\Component\Console\Command\SignalableCommand;
 use Symfony\Component\Console\Command\SignalableCommandInterface;
 use Symfony\Component\Console\CommandLoader\CommandLoaderInterface;
 use Symfony\Component\Console\CommandLoader\FactoryCommandLoader;
@@ -2255,6 +2256,47 @@ public function testSignalableRestoresStty()
         $this->assertSame($previousSttyMode, $sttyMode);
     }
 
+    public function testSignalableInvokableCommand()
+    {
+        $command = new SignalableCommand();
+        $command->setName('signal-invokable');
+        $command->setCode($invokable = new class implements SignalableCommandInterface {
+            public bool $signaled = false;
+
+            public function __invoke(): int
+            {
+                posix_kill(posix_getpid(), \SIGUSR1);
+
+                for ($i = 0; $i < 1000; ++$i) {
+                    usleep(100);
+                    if ($this->signaled) {
+                        return 1;
+                    }
+                }
+
+                return 0;
+            }
+
+            public function getSubscribedSignals(): array
+            {
+                return SignalRegistry::isSupported() ? [\SIGUSR1] : [];
+            }
+
+            public function handleSignal(int $signal, int|false $previousExitCode = 0): int|false
+            {
+                $this->signaled = true;
+
+                return false;
+            }
+        });
+
+        $application = $this->createSignalableApplication($command, null);
+        $application->setSignalsToDispatchEvent(\SIGUSR1);
+
+        $this->assertSame(1, $application->run(new ArrayInput(['signal-invokable'])));
+        $this->assertTrue($invokable->signaled);
+    }
+
     /**
      * @requires extension pcntl
      */
diff --git a/src/Symfony/Component/Console/Tests/DependencyInjection/AddConsoleCommandPassTest.php b/src/Symfony/Component/Console/Tests/DependencyInjection/AddConsoleCommandPassTest.php
@@ -15,6 +15,8 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\LazyCommand;
+use Symfony\Component\Console\Command\SignalableCommand;
+use Symfony\Component\Console\Command\SignalableCommandInterface;
 use Symfony\Component\Console\CommandLoader\ContainerCommandLoader;
 use Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass;
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
@@ -322,6 +324,29 @@ public function testProcessInvokableCommand()
         $command = $container->get('console.command_loader')->get('invokable');
 
         self::assertTrue($container->has('invokable_command.command'));
+        self::assertSame(Command::class, $container->getDefinition('invokable_command.command')->getClass());
+        self::assertSame('The command description', $command->getDescription());
+        self::assertSame('The %command.name% command help content.', $command->getHelp());
+    }
+
+    public function testProcessInvokableSignalableCommand()
+    {
+        $container = new ContainerBuilder();
+        $container->addCompilerPass(new AddConsoleCommandPass(), PassConfig::TYPE_BEFORE_REMOVING);
+
+        $definition = new Definition(InvokableSignalableCommand::class);
+        $definition->addTag('console.command', [
+            'command' => 'invokable-signalable',
+            'description' => 'The command description',
+            'help' => 'The %command.name% command help content.',
+        ]);
+        $container->setDefinition('invokable_signalable_command', $definition);
+
+        $container->compile();
+        $command = $container->get('console.command_loader')->get('invokable-signalable');
+
+        self::assertTrue($container->has('invokable_signalable_command.command'));
+        self::assertSame(SignalableCommand::class, $container->getDefinition('invokable_signalable_command.command')->getClass());
         self::assertSame('The command description', $command->getDescription());
         self::assertSame('The %command.name% command help content.', $command->getHelp());
     }
@@ -361,3 +386,21 @@ public function __invoke(): void
     {
     }
 }
+
+#[AsCommand(name: 'invokable-signalable', description: 'Just testing', help: 'The %command.name% help content.')]
+class InvokableSignalableCommand implements SignalableCommandInterface
+{
+    public function __invoke(): void
+    {
+    }
+
+    public function getSubscribedSignals(): array
+    {
+        return [];
+    }
+
+    public function handleSignal(int $signal, false|int $previousExitCode = 0): int|false
+    {
+        return false;
+    }
+}
