feature #51263 [Scheduler] Add --all to debug:schedule (fabpot)

fabpot · fabpot · commit bee1b9d087e7 · 2023-08-04T11:22:42.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Scheduler] Add --all to debug:schedule | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no  | Deprecations? | no  | Tickets | n/a | License | MIT | Doc PR | n/a If you have many terminated recurring messages, it pollutes the output. As this command displays the future next date run, I propose to remove terminated messages from the output. The `--all` option allows you to display them all. Commits ------- a120c04 [Scheduler] Add --all to debug:schedule
diff --git a/src/Symfony/Component/Scheduler/CHANGELOG.md b/src/Symfony/Component/Scheduler/CHANGELOG.md
@@ -5,7 +5,7 @@ CHANGELOG
 ---
 
  * Mark the component as non experimental
- * Add `--date` to `schedule:debug`
+ * Add `--date` and `--all` options to the `schedule:debug` command
  * Allow setting timezone of next run date in CronExpressionTrigger
  * Add `AbstractTriggerDecorator`
  * Make `ScheduledStamp` "send-able"
diff --git a/src/Symfony/Component/Scheduler/Command/DebugCommand.php b/src/Symfony/Component/Scheduler/Command/DebugCommand.php
@@ -15,15 +15,14 @@
 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\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Scheduler\RecurringMessage;
 use Symfony\Component\Scheduler\ScheduleProviderInterface;
 use Symfony\Contracts\Service\ServiceProviderInterface;
 
-use function Symfony\Component\Clock\now;
-
 /**
  * Command to list/debug schedules.
  *
@@ -45,7 +44,8 @@ protected function configure(): void
     {
         $this
             ->addArgument('schedule', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, sprintf('The schedule name (one of "%s")', implode('", "', $this->scheduleNames)), null, $this->scheduleNames)
-            ->addOption('date', null, InputArgument::OPTIONAL, 'The date to use for the next run date', 'now')
+            ->addOption('date', null, InputOption::VALUE_REQUIRED, 'The date to use for the next run date', 'now')
+            ->addOption('all', null, InputOption::VALUE_NONE, 'Display all recurring messages, including the terminated ones')
             ->setHelp(<<<'EOF'
                 The <info>%command.name%</info> lists schedules and their recurring messages:
 
@@ -59,6 +59,10 @@ protected function configure(): void
 
                   <info>php %command.full_name% --date=2025-10-18</info>
 
+                To also display the terminated recurring messages, use the <info>--all</info> option:
+
+                  <info>php %command.full_name% --all</info>
+
                 EOF
             )
         ;
@@ -92,17 +96,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
             $io->table(
                 ['Message', 'Trigger', 'Next Run'],
-                array_map(self::renderRecurringMessage(...), $messages, array_fill(0, count($messages), $date)),
+                array_filter(array_map(self::renderRecurringMessage(...), $messages, array_fill(0, count($messages), $date), array_fill(0, count($messages), $input->getOption('all')))),
             );
         }
 
         return 0;
     }
 
     /**
-     * @return array{0:string,1:string,2:string}
+     * @return array{0:string,1:string,2:string}|null
      */
-    private static function renderRecurringMessage(RecurringMessage $recurringMessage, \DateTimeImmutable $date): array
+    private static function renderRecurringMessage(RecurringMessage $recurringMessage, \DateTimeImmutable $date, bool $all): ?array
     {
         $message = $recurringMessage->getMessage();
         $trigger = $recurringMessage->getTrigger();
@@ -111,10 +115,12 @@ private static function renderRecurringMessage(RecurringMessage $recurringMessag
             $message = $message->getMessage();
         }
 
-        return [
-            $message instanceof \Stringable ? (string) $message : (new \ReflectionClass($message))->getShortName(),
-            (string) $trigger,
-            $trigger->getNextRunDate($date)?->format('r') ?? '-',
-        ];
+        $next = $trigger->getNextRunDate($date)?->format('r') ?? '-';
+        if ('-' === $next && !$all) {
+            return null;
+        }
+        $name = $message instanceof \Stringable ? (string) $message : (new \ReflectionClass($message))->getShortName();
+
+        return [$name, (string) $trigger, $next];
     }
 }
