[Console][FrameworkBundle] Simplify using invokable commands when the component is used standalone #60394

HypeMC · 2025-05-09T21:07:38Z

Q	A
Branch?	7.4
Bug fix?	no
New feature?	yes
Deprecations?	yes
Issues	-
License	MIT

Inspired by #60389 (comment) .

This PR enables using invokable command when the component is used standalone:

#[AsCommand(name: 'app:example')]
class ExampleCommand implements SignalableCommandInterface
{
    public function __invoke(InputInterface $input, OutputInterface $output): int
    {
        // ...

        return Command::SUCCESS;
    }

    public function getSubscribedSignals(): array
    {
        return [\SIGINT, \SIGTERM];
    }

    public function handleSignal(int $signal, int|false $previousExitCode = 0): int|false
    {
        // handle signal

        return 0;
    }
}

$application = new Application();
$application->addCommand(new ExampleCommand());
$application->run();

OskarStark · 2025-05-10T06:57:33Z

So we really need the extra method addInvokable() or could we handle this automatically?

xabbuh · 2025-05-10T07:05:54Z

We cannot widen the argument type in add() as that would be a BC break for child classes overriding the method.

src/Symfony/Component/Console/Application.php

src/Symfony/Component/Console/Tests/ApplicationTest.php

OskarStark · 2025-05-10T16:07:18Z

We could remove it and handle it internally, couldn't we?

Do we need to adjust addCommands() method as well?

chalasr · 2025-05-11T13:54:11Z

Cool, thanks for working on this.

We could remove it and handle it internally, couldn't we?

@OskarStark If you mean removing the type declaration then it's a BC break too unfortunately, see https://3v4l.org/5dhmc.

I'd prefer the invokable concept not to leak into public API though. What about adding Application::addCommand(callable|Command $command): Command instead? It would be great if that new method could provide a way to make the command lazy also.

HypeMC · 2025-05-13T23:29:02Z

I'd prefer the invokable concept not to leak into public API though. What about adding Application::addCommand(callable|Command $command): Command instead? It would be great if that new method could provide a way to make the command lazy also.

@chalasr I've made the changes you requested, please let me know what you think.

weitzman

LGTM. This PR would be helpful for the Drush project (the main CLI for Drupal).

src/Symfony/Component/Console/Application.php

yceruto · 2025-06-05T15:32:53Z

Wondering now that a new method is being added with support for both types of commands, shouldn’t we deprecate the Application::add() in favor of Application::addCommand() method to improve the API in version 8.0?

weitzman · 2025-06-05T15:44:30Z

src/Symfony/Component/Console/Tests/ApplicationTest.php

@@ -2514,6 +2570,22 @@ public function isEnabled(): bool
    }
 }

+#[AsCommand(name: 'invokable')]


Suggested change

#[AsCommand(name: 'invokable')]

#[AsCommand(name: 'invokable', aliases: 'invk')]

I did some testing on Drush and I am seeing the PR fail when an invokable command uses an alias. If you accept my suggestion above, hopefully the tests fail.

The problem is that $attribute->name is a pipe delimited string consisting of the name, followed by the aliases. See \Symfony\Component\Console\Attribute\AsCommand::__construct.

The code below helped me get past this bug. Not sure if there are better ways to solve it

$aliases = explode('|', $attribute->name); $name = array_shift($aliases); $commandHandler = (new Command($name)) ->setAliases($aliases) ...

chalasr · 2025-06-05T18:35:35Z

@yceruto 👍 for deprecating add(), that's what I had in mind.

HypeMC · 2025-06-07T23:32:39Z

@yceruto @chalasr I've deprecated the add() method.

yceruto · 2025-06-08T14:02:29Z

@HypeMC it seems high-deps failures are related https://github.com/symfony/symfony/actions/runs/15518654102/job/43689003684?pr=60394, right?

yceruto

@HypeMC it seems high-deps failures are related https://github.com/symfony/symfony/actions/runs/15518654102/job/43689003684?pr=60394, right?

Nevermind, it might be related to the 8.0 branch and should be resolved once this PR is merged into it.

src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePoolDeleteCommandTest.php

…d standalone

chalasr · 2025-06-11T16:43:10Z

Thank you @HypeMC.

Symfony Console deprecate `add()` method and instead calls `addCommand()` method from `addCommands()`. This cause the application not to have the correct instance of `$laravel` property. PR: <symfony/symfony#60394> Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>

This PR was merged into the 6.4 branch. Discussion ---------- [Runtime] fix compatibility with Symfony 7.4 | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | | License | MIT Since #60394 using `add()` is deprecated. This means that our tests can trigger deprecations on older branches when the high deps job is run. This usually is not an issue as we silence them with the `SYMFONY_DEPRECATIONS_HELPER` env var. However, phpt tests are run in a child process where the deprecation error handler of the PHPUnit bridge doesn't step in. Thus, for them deprecations are not silenced leading to failures. We did something similar before in #60376. Commits ------- d39a7ac fix compatibility with Symfony 7.4

HypeMC requested a review from chalasr as a code owner May 9, 2025 21:07

carsonbot added Status: Needs Review Console Feature labels May 9, 2025

carsonbot added this to the 7.3 milestone May 9, 2025

nicolas-grekas reviewed May 10, 2025

View reviewed changes

src/Symfony/Component/Console/Application.php Outdated Show resolved Hide resolved

nicolas-grekas reviewed May 10, 2025

View reviewed changes

src/Symfony/Component/Console/Tests/ApplicationTest.php Show resolved Hide resolved

HypeMC force-pushed the simplify-invokable-commands-when-standalone branch from e07ce18 to 5cf2a0d Compare May 10, 2025 08:33

HypeMC force-pushed the simplify-invokable-commands-when-standalone branch 2 times, most recently from 758b85e to 2a19b9b Compare May 13, 2025 23:18

fabpot modified the milestones: 7.3, 7.4 May 26, 2025

weitzman reviewed Jun 5, 2025

View reviewed changes

yceruto requested changes Jun 5, 2025

View reviewed changes

src/Symfony/Component/Console/Application.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 5, 2025

weitzman reviewed Jun 5, 2025

View reviewed changes

HypeMC mentioned this pull request Jun 7, 2025

[Console] Allow setting aliases & hidden via command name passed to the constructor #60739

Merged

HypeMC force-pushed the simplify-invokable-commands-when-standalone branch from 2a19b9b to f2722a2 Compare June 7, 2025 22:31

HypeMC requested review from xabbuh and welcoMattic as code owners June 7, 2025 22:31

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jun 7, 2025

carsonbot added the Status: Needs Review label Jun 7, 2025

HypeMC added Deprecation FrameworkBundle labels Jun 7, 2025

carsonbot changed the title ~~[Console] Simplify using invokable commands when the component is used standalone~~ [Console][FrameworkBundle] Simplify using invokable commands when the component is used standalone Jun 7, 2025

nicolas-grekas closed this in f24ffa0 Jun 8, 2025

HypeMC reopened this Jun 8, 2025

HypeMC force-pushed the simplify-invokable-commands-when-standalone branch from f2722a2 to c3f55f3 Compare June 8, 2025 12:53

yceruto approved these changes Jun 8, 2025

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jun 8, 2025

stof reviewed Jun 9, 2025

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePoolDeleteCommandTest.php Outdated Show resolved Hide resolved

[Console] Simplify using invokable commands when the component is use…

1886c10

…d standalone

HypeMC force-pushed the simplify-invokable-commands-when-standalone branch from c3f55f3 to 1886c10 Compare June 9, 2025 15:40

chalasr approved these changes Jun 9, 2025

View reviewed changes

OskarStark approved these changes Jun 10, 2025

View reviewed changes

chalasr merged commit e9ad816 into symfony:7.4 Jun 11, 2025
8 of 11 checks passed

chalasr mentioned this pull request Jun 11, 2025

[Console][FrameworkBundle] Simplify using invokable commands when the c… symfony/symfony-docs#21074

Open

HypeMC deleted the simplify-invokable-commands-when-standalone branch June 11, 2025 22:45

crynobone mentioned this pull request Jun 12, 2025

[11.x] Fix symfony/console:7.4 compatibility laravel/framework#56015

Merged

xabbuh mentioned this pull request Jun 12, 2025

[Runtime] fix compatibility with Symfony 7.4 #60771

Merged

chalasr mentioned this pull request Jun 12, 2025

Add forward compatibility layer for symfony/console >7.4 composer/composer#12445

Open

	#[AsCommand(name: 'invokable')]
	#[AsCommand(name: 'invokable', aliases: 'invk')]

Uh oh!

[Console][FrameworkBundle] Simplify using invokable commands when the component is used standalone #60394

[Console][FrameworkBundle] Simplify using invokable commands when the component is used standalone #60394

Conversation

HypeMC commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OskarStark commented May 10, 2025

Uh oh!

xabbuh commented May 10, 2025

Uh oh!

Uh oh!

Uh oh!

OskarStark commented May 10, 2025

Uh oh!

chalasr commented May 11, 2025

Uh oh!

HypeMC commented May 13, 2025

Uh oh!

weitzman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yceruto commented Jun 5, 2025

Uh oh!

weitzman Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

HypeMC Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

chalasr commented Jun 5, 2025

Uh oh!

HypeMC commented Jun 7, 2025

Uh oh!

yceruto commented Jun 8, 2025

Uh oh!

yceruto left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

chalasr commented Jun 11, 2025

Uh oh!

Uh oh!

Uh oh!

HypeMC commented May 9, 2025 •

edited

Loading