Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Scheduler] Fix #[AsCronTask] not passing arguments to command#60741

Merged
nicolas-grekas merged 1 commit into
symfony:7.3from
jan-pintr:fix-ascrontask-no-passing-arguments
Jul 9, 2025
Merged

[Scheduler] Fix #[AsCronTask] not passing arguments to command#60741
nicolas-grekas merged 1 commit into
symfony:7.3from
jan-pintr:fix-ascrontask-no-passing-arguments

Conversation

@jan-pintr
Copy link
Copy Markdown
Contributor

@jan-pintr jan-pintr commented Jun 7, 2025

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

This MR fixes passing AsCronTask arguments to Command. Reproduced can be by following command. It wont receive --all option or any other argument specified in AsCronTask when executed by Scheduler.

#[AsCommand(name: 'debug:as-cron-task')]
#[AsCronTask('* * * * *', arguments: '--all')]
class SampleCommand extends Command
{
    protected function configure(): void
    {
        $this->addOption('all', null, InputOption::VALUE_NONE);
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        dump($input->getOption('all'));

        return Command::SUCCESS;
    }
}

Fix description: When command name was found in AsCommand attribute then attributes were not appended to message definition due to missing brackets.

@jan-pintr jan-pintr requested a review from kbond as a code owner June 7, 2025 18:56
@carsonbot carsonbot added this to the 7.3 milestone Jun 7, 2025
kbond
kbond reviewed Jun 9, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@kbond kbond left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for finding/fixing this! Can you target 6.4?

Do you think you'd be up for adding some tests here to prevent a regression?

@jan-pintr jan-pintr changed the base branch from 7.3 to 6.4 June 9, 2025 15:54
@jan-pintr jan-pintr changed the base branch from 6.4 to 7.4 June 9, 2025 15:54
@jan-pintr jan-pintr changed the base branch from 7.4 to 7.3 June 9, 2025 17:24
@jan-pintr
Copy link
Copy Markdown
Contributor Author

jan-pintr commented Jun 9, 2025

Test added. But branch was reverted to 7.3, because the problem was introduced in 7.3 (here #59711) Is it ok?

@kbond
Copy link
Copy Markdown
Member

kbond commented Jun 9, 2025

because the problem was introduced in 7.3

Oh, my bad - so the problem doesn't exist < 7.3?

@jan-pintr
Copy link
Copy Markdown
Contributor Author

jan-pintr commented Jun 9, 2025

Yes, it did not exist in <7.3

kbond
kbond requested changes Jun 9, 2025
View reviewed changes
Comment thread src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Messenger/DummyCommand.php Outdated
@lyrixx lyrixx removed their request for review June 10, 2025 08:28
kbond
kbond approved these changes Jun 10, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@kbond kbond left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good! I'm not 100% sure of the issue with the one CI failure.

@jan-pintr
Copy link
Copy Markdown
Contributor Author

jan-pintr commented Jun 10, 2025

Not sure either. Before test fails there is log Installing symfony/scheduler (7.4.x-dev ac9f564): Extracting archive.

I suppose that the reason is that the high-deps is runned against 7.4.x-dev in which it is not fixed yet? Could that be the reason?

@kbond
Copy link
Copy Markdown
Member

kbond commented Jun 10, 2025 •
edited
Loading

Could that be the reason?

Yeah, that's what I'm thinking but I would have expected this issue with "low-deps" (oh, I forgot this wasn't an issue in 6.4 so that makes sense).

It should be fixed once merged though.

fabpot
fabpot requested changes Jun 20, 2025
View reviewed changes
Comment thread src/Symfony/Component/Scheduler/DependencyInjection/AddScheduleMessengerPass.php Outdated
@OskarStark OskarStark changed the title [Scheduler] Fix AsCronTask not passing arguments to command [Scheduler] Fix #[AsCronTask] not passing arguments to command Jun 20, 2025
@jan-pintr
Copy link
Copy Markdown
Contributor Author

jan-pintr commented Jun 20, 2025

Suggestion applied, thank you.

@OskarStark OskarStark requested a review from fabpot June 23, 2025 15:58
@nicolas-grekas nicolas-grekas force-pushed the fix-ascrontask-no-passing-arguments branch from cf6c25d to b57a815 Compare July 9, 2025 09:46
@nicolas-grekas
Copy link
Copy Markdown
Member

nicolas-grekas commented Jul 9, 2025

Thank you @jan-pintr.

@nicolas-grekas nicolas-grekas merged commit 7095ee9 into symfony:7.3 Jul 9, 2025
9 of 11 checks passed
@fabpot fabpot mentioned this pull request Jul 31, 2025
Merged
@johndodev
Copy link
Copy Markdown

johndodev commented Aug 1, 2025

Hello,

thanks,

Idk if this is a real problem or something supported, but as there is no nullsafe check on $tagAttributes['arguments'] here, this is breaking a tag on my use case, which is a "scheduler.task" tag added in a LoadExtension bundle I'm currently developping.

I'm notifying because every others attributes seems optionnals :

$myService->tag('scheduler.task', [
    'frequency' => 15,
    'schedule' => $config['schedule'],
    'trigger' => 'every',
    'arguments' => null, // <- had to add this line to avoid a Warning: Undefined array key "arguments"
]);

@jan-pintr jan-pintr mentioned this pull request Aug 2, 2025
Merged
@jan-pintr
Copy link
Copy Markdown
Contributor Author

jan-pintr commented Aug 2, 2025

@johndodev Please look at #61307.

Even at least trigger and then frequency (for trigger: every) or expression (for trigger: cron) parameters are also mandatory then requiring specify arguments => null seems not intended.

nicolas-grekas added a commit that referenced this pull request Aug 5, 2025
@nicolas-grekas
bug #61307 [Scheduler] Fix scheduler.task tag arguments optionality…
d46d595 
… (Jan Pintr)

This PR was squashed before being merged into the 7.3 branch.

Discussion
----------

[Scheduler] Fix `scheduler.task` tag arguments optionality

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

According to [this comment](#60741 (comment)) there is a change in behaviour after #60741 which causes requiring specify `arguments` parameter when tagging `scheduler.task` manually. This pull request makes `arguments` parameter back optional.

```
$myService->tag('scheduler.task', [
    'trigger' => 'every',
    'frequency' => 15,
    'arguments' => null, // <- had to add this line to avoid a Warning: Undefined array key "arguments"
]);
```

Commits
-------

ad08041 [Scheduler] Fix `scheduler.task` tag arguments optionality
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kbond kbond kbond approved these changes

@OskarStark OskarStark OskarStark approved these changes

@yceruto yceruto Awaiting requested review from yceruto

@chalasr chalasr Awaiting requested review from chalasr

@dunglas dunglas Awaiting requested review from dunglas

@jderusse jderusse Awaiting requested review from jderusse

@xabbuh xabbuh Awaiting requested review from xabbuh

@fabpot fabpot Awaiting requested review from fabpot

Assignees

No one assigned

Labels

Bug Scheduler Status: Needs Review

Projects

None yet

Milestone

7.3

Development

Successfully merging this pull request may close these issues.

7 participants

@jan-pintr @kbond @nicolas-grekas @johndodev @fabpot @OskarStark @carsonbot