-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Scheduler] Add debug:scheduler command
#49802
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
149 changes: 149 additions & 0 deletions
149
src/Symfony/Bundle/FrameworkBundle/Command/SchedulerDebugCommand.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| <?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\Bundle\FrameworkBundle\Command; | ||
|
|
||
| use Symfony\Component\Console\Attribute\AsCommand; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\ConsoleOutputInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Console\Style\SymfonyStyle; | ||
| use Symfony\Component\DependencyInjection\ServiceLocator; | ||
| use Symfony\Component\Scheduler\Schedule; | ||
|
|
||
| /** | ||
| * A console command for retrieving information about schedulers. | ||
| * | ||
| * @author Baptiste Leduc <baptiste.leduc@gmail.com> | ||
| * | ||
| * @final | ||
| */ | ||
| #[AsCommand(name: 'debug:scheduler', description: 'Display current schedules for an application')] | ||
| class SchedulerDebugCommand extends Command | ||
| { | ||
| public function __construct( | ||
| private readonly ServiceLocator $scheduleProviders | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void | ||
| { | ||
| $this | ||
| ->setDefinition([ | ||
| new InputArgument('name', InputArgument::OPTIONAL, 'A scheduler name (uses `default` if none provided)', 'default'), | ||
| new InputArgument('message', InputArgument::OPTIONAL, 'A class name to filter on'), | ||
| new InputOption('from', null, InputOption::VALUE_REQUIRED, 'When the next run date will be calculated from (use \DateTime::ATOM format)', 'now'), | ||
| new InputOption('from-format', null, InputOption::VALUE_REQUIRED, 'Format to use for the from option', \DateTimeInterface::ATOM), | ||
| new InputOption('from-timezone', null, InputOption::VALUE_REQUIRED, 'Timezone to use in combination with the from option', 'UTC'), | ||
| new InputOption('show-lock', null, InputOption::VALUE_NONE, 'Show used lock'), | ||
| new InputOption('show-state', null, InputOption::VALUE_NONE, 'Show used state'), | ||
| ]) | ||
| ->setHelp(<<<'EOF' | ||
| The <info>%command.name%</info> displays the configured schedules: | ||
|
|
||
| <info>php %command.full_name%</info> | ||
|
|
||
| EOF | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int | ||
| { | ||
| $io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output); | ||
| $errorIo = $io->getErrorStyle(); | ||
| $dateTimeZone = new \DateTimeZone($input->getOption('from-timezone')); | ||
| $dateFrom = 'now' === $input->getOption('from') | ||
| ? new \DateTimeImmutable(timezone: $dateTimeZone) | ||
| : \DateTimeImmutable::createFromFormat($input->getOption('from-format'), $input->getOption('from'), $dateTimeZone); | ||
|
|
||
| $askedScheduler = $input->getArgument('name'); | ||
| /** @var string[] $availableSchedulers */ | ||
| $availableSchedulers = array_keys($this->scheduleProviders->getProvidedServices()); | ||
|
|
||
| if (!\in_array($askedScheduler, $availableSchedulers)) { | ||
| $errorIo->error(sprintf('The "%s" scheduler could not be found. Available schedulers: %s.', $askedScheduler, implode(', ', $availableSchedulers))); | ||
|
|
||
| return Command::INVALID; | ||
| } | ||
|
|
||
| $scheduler = $this->scheduleProviders->get($askedScheduler); | ||
| /** @var Schedule $schedule */ | ||
| $schedule = $scheduler->getSchedule(); | ||
|
|
||
| $io->title(sprintf('Information for Scheduler "<info>%s</info>"', $askedScheduler)); | ||
|
|
||
| if ($input->getOption('show-lock')) { | ||
| $this->showLock($io, $schedule); | ||
| } elseif ($input->getOption('show-state')) { | ||
| $this->showState($io, $schedule); | ||
| } else { | ||
| $this->showMessages($io, $schedule, $dateFrom, $dateTimeZone, $input->getArgument('message')); | ||
| } | ||
|
|
||
| return Command::SUCCESS; | ||
| } | ||
|
|
||
| private function showMessages(SymfonyStyle $io, Schedule $schedule, \DateTimeImmutable $dateFrom, \DateTimeZone $dateTimeZone, string $classFilter = null): void | ||
| { | ||
| if ($filtered = \is_string($classFilter)) { | ||
| $io->comment(sprintf('Displaying only \'%s\' messages', $classFilter)); | ||
| } | ||
|
|
||
| $messages = []; | ||
| foreach ($schedule->getRecurringMessages() as $recurringMessage) { | ||
| if ($filtered && !str_contains($recurringMessage->getMessage()::class, $classFilter)) { | ||
| continue; | ||
| } | ||
|
|
||
| $nextRunDate = $recurringMessage->getTrigger()->getNextRunDate($dateFrom); | ||
| $nextRunDate = $nextRunDate->setTimezone($dateTimeZone); | ||
|
|
||
| $messages[] = [ | ||
| $recurringMessage->getMessage()::class, | ||
| $recurringMessage->getTrigger()::class, | ||
| $nextRunDate->format(\DateTimeInterface::ATOM), | ||
| ]; | ||
| } | ||
|
|
||
| $io->table(['Message', 'Trigger type', 'Next run date'], $messages); | ||
| } | ||
|
|
||
| private function showLock(SymfonyStyle $io, Schedule $schedule): void | ||
| { | ||
| $io->comment('Displaying only Scheduler Lock information'); | ||
|
|
||
| if (null === $schedule->getLock()) { | ||
| $io->note('No lock found on given Scheduler'); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $io->text(sprintf('Using "<info>%s</info>" lock', $schedule->getLock()::class)); | ||
| } | ||
|
|
||
| private function showState(SymfonyStyle $io, Schedule $schedule): void | ||
| { | ||
| $io->comment('Displaying only Scheduler Cache information'); | ||
|
|
||
| if (null === $schedule->getState()) { | ||
| $io->note('No state found on given Scheduler'); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| $io->text(sprintf('Using "<info>%s</info>" cache adapter', $schedule->getState()::class)); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Messenger/DefaultSchedule.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <?php | ||
|
|
||
| namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger; | ||
|
|
||
| use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\BarMessage; | ||
| use Symfony\Component\Cache\Adapter\ArrayAdapter; | ||
| use Symfony\Component\Lock\Key; | ||
| use Symfony\Component\Lock\Lock; | ||
| use Symfony\Component\Lock\Store\InMemoryStore; | ||
| use Symfony\Component\Scheduler\Attribute\AsSchedule; | ||
| use Symfony\Component\Scheduler\RecurringMessage; | ||
| use Symfony\Component\Scheduler\Schedule; | ||
| use Symfony\Component\Scheduler\ScheduleProviderInterface; | ||
|
|
||
| #[AsSchedule] | ||
| class DefaultSchedule implements ScheduleProviderInterface | ||
| { | ||
| public function getSchedule(): Schedule | ||
| { | ||
| return (new Schedule()) | ||
| ->add(RecurringMessage::every('1 month', new BarMessage())) | ||
| ->add(RecurringMessage::every('2 minutes', new FooMessage())) | ||
| ->stateful(new ArrayAdapter()) | ||
| ->lock(new Lock(new Key('dummy'), new InMemoryStore())) | ||
| ; | ||
| } | ||
| } |
105 changes: 105 additions & 0 deletions
105
src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SchedulerDebugCommandTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| <?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\Bundle\FrameworkBundle\Tests\Functional; | ||
|
|
||
| use Symfony\Bundle\FrameworkBundle\Console\Application; | ||
| use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\BarMessage; | ||
| use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Tester\CommandTester; | ||
|
|
||
| /** | ||
| * @group functional | ||
| */ | ||
| class SchedulerDebugCommandTest extends AbstractWebTestCase | ||
| { | ||
| private $application; | ||
|
|
||
| protected function setUp(): void | ||
| { | ||
| $kernel = static::createKernel(['test_case' => 'SchedulerDebug', 'root_config' => 'config.yml']); | ||
| $this->application = new Application($kernel); | ||
| } | ||
|
|
||
| public function testRunWithNoArguments() | ||
| { | ||
| $tester = $this->createCommandTester(); | ||
| $ret = $tester->execute([]); | ||
|
|
||
| $this->assertSame(Command::SUCCESS, $ret, 'Returns 0 in case of success'); | ||
| $this->assertStringContainsString('Information for Scheduler "default"', $tester->getDisplay()); | ||
| $this->assertStringContainsString(BarMessage::class, $tester->getDisplay()); | ||
| $this->assertStringContainsString(FooMessage::class, $tester->getDisplay()); | ||
| } | ||
|
|
||
| public function testRunWithNameArgument() | ||
| { | ||
| $tester = $this->createCommandTester(); | ||
| $ret = $tester->execute(['name' => 'default']); | ||
|
|
||
| $this->assertSame(Command::SUCCESS, $ret, 'Returns 0 in case of success'); | ||
| $this->assertStringContainsString('Information for Scheduler "default"', $tester->getDisplay()); | ||
| $this->assertStringContainsString(BarMessage::class, $tester->getDisplay()); | ||
| $this->assertStringContainsString(FooMessage::class, $tester->getDisplay()); | ||
| } | ||
|
|
||
| public function testRunWithWrongNameArgument() | ||
| { | ||
| $tester = $this->createCommandTester(); | ||
| $ret = $tester->execute(['name' => 'foo']); | ||
|
|
||
| $this->assertSame(Command::INVALID, $ret, 'Returns 2 in case of invalid input'); | ||
| $this->assertStringContainsString('Available schedulers: default', $tester->getDisplay()); | ||
| } | ||
|
|
||
| public function testRunWithNameAndMessageArgument() | ||
| { | ||
| $tester = $this->createCommandTester(); | ||
| $ret = $tester->execute(['name' => 'default', 'message' => 'FooMessage']); | ||
|
|
||
| $this->assertSame(Command::SUCCESS, $ret, 'Returns 0 in case of success'); | ||
| $this->assertStringContainsString('Information for Scheduler "default"', $tester->getDisplay()); | ||
| $this->assertStringNotContainsString(BarMessage::class, $tester->getDisplay()); | ||
| $this->assertStringContainsString(FooMessage::class, $tester->getDisplay()); | ||
| } | ||
|
|
||
| public function testRunWithShowLockOption() | ||
| { | ||
| $tester = $this->createCommandTester(); | ||
| $ret = $tester->execute(['--show-lock' => true]); | ||
|
|
||
| $this->assertSame(Command::SUCCESS, $ret, 'Returns 0 in case of success'); | ||
| $this->assertStringContainsString('Information for Scheduler "default"', $tester->getDisplay()); | ||
| $this->assertStringContainsString('Displaying only Scheduler Lock information', $tester->getDisplay()); | ||
| $this->assertStringNotContainsString(BarMessage::class, $tester->getDisplay()); | ||
| $this->assertStringNotContainsString(FooMessage::class, $tester->getDisplay()); | ||
| } | ||
|
|
||
| public function testRunWithShowStateOption() | ||
| { | ||
| $tester = $this->createCommandTester(); | ||
| $ret = $tester->execute(['--show-state' => true]); | ||
|
|
||
| $this->assertSame(Command::SUCCESS, $ret, 'Returns 0 in case of success'); | ||
| $this->assertStringContainsString('Information for Scheduler "default"', $tester->getDisplay()); | ||
| $this->assertStringContainsString('Displaying only Scheduler Cache information', $tester->getDisplay()); | ||
| $this->assertStringNotContainsString(BarMessage::class, $tester->getDisplay()); | ||
| $this->assertStringNotContainsString(FooMessage::class, $tester->getDisplay()); | ||
| } | ||
|
|
||
| private function createCommandTester(): CommandTester | ||
| { | ||
| $command = $this->application->find('debug:scheduler'); | ||
|
|
||
| return new CommandTester($command); | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/SchedulerDebug/bundles.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <?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. | ||
| */ | ||
|
|
||
| use Symfony\Bundle\FrameworkBundle\FrameworkBundle; | ||
|
|
||
| return [ | ||
| new FrameworkBundle(), | ||
| ]; |
11 changes: 11 additions & 0 deletions
11
src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/SchedulerDebug/config.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| imports: | ||
| - { resource: ../config/default.yml } | ||
|
|
||
| framework: | ||
| lock: ~ | ||
| scheduler: ~ | ||
| messenger: ~ | ||
|
|
||
| services: | ||
| Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DefaultSchedule: | ||
| autoconfigure: true |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps it would be better to move this code into the scheduler component?