feature #50572 [Scheduler] Allow setting cron expression next run date timezone (danielburger1337)

nicolas-grekas · nicolas-grekas · commit be9ea533be97 · 2023-06-09T01:00:16.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Scheduler] Allow setting cron expression next run date timezone | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | Allow setting the timezone for the next run date derived from a cron expression. This is my first contribution to an experimental component and therefor I am not familiar with the exact contribution guidelines. As this component is experimental, I think it is ok to submit this PR against branch 6.3, right? Im also not sure about the CHANGELOG.md entry I should make. Would I add this under the 6.3.1 section or where? Commits ------- 35756c1 [Scheduler] Allow setting cron expression next run date timezone
diff --git a/src/Symfony/Component/Scheduler/CHANGELOG.md b/src/Symfony/Component/Scheduler/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+ * Allow setting timezone of next run date in CronExpressionTrigger
+
 6.3
 ---
 
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -48,17 +48,17 @@ public static function every(string|int|\DateInterval $frequency, object $messag
         return new self(new PeriodicalTrigger($frequency, $from, $until), $message);
     }
 
-    public static function cron(string $expression, object $message): self
+    public static function cron(string $expression, object $message, \DateTimeZone|string $timezone = null): self
     {
         if (!str_contains($expression, '#')) {
-            return new self(CronExpressionTrigger::fromSpec($expression), $message);
+            return new self(CronExpressionTrigger::fromSpec($expression, null, $timezone), $message);
         }
 
         if (!$message instanceof \Stringable) {
             throw new InvalidArgumentException('A message must be stringable to use "hashed" cron expressions.');
         }
 
-        return new self(CronExpressionTrigger::fromSpec($expression, (string) $message), $message);
+        return new self(CronExpressionTrigger::fromSpec($expression, (string) $message, $timezone), $message);
     }
 
     public static function trigger(TriggerInterface $trigger, object $message): self
diff --git a/src/Symfony/Component/Scheduler/Tests/Trigger/CronExpressionTriggerTest.php b/src/Symfony/Component/Scheduler/Tests/Trigger/CronExpressionTriggerTest.php
@@ -96,4 +96,19 @@ public function testFromHashWithStandardExpression()
         $this->assertSame('56 20 1 9 0', (string) CronExpressionTrigger::fromSpec('56 20 1 9 0', 'some context'));
         $this->assertSame('0 0 * * *', (string) CronExpressionTrigger::fromSpec('@daily'));
     }
+
+    public function testDefaultTimezone()
+    {
+        $now = new \DateTimeImmutable('Europe/Paris');
+        $trigger = CronExpressionTrigger::fromSpec('0 12 * * *');
+        $this->assertSame('Europe/Paris', $trigger->getNextRunDate($now)->getTimezone()->getName());
+    }
+
+    public function testTimezoneIsUsed()
+    {
+        $now = new \DateTimeImmutable('Europe/Paris');
+        $timezone = new \DateTimeZone('UTC');
+        $trigger = CronExpressionTrigger::fromSpec('0 12 * * *', null, $timezone);
+        $this->assertSame('UTC', $trigger->getNextRunDate($now)->getTimezone()->getName());
+    }
 }
diff --git a/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php b/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php
@@ -46,36 +46,40 @@ final class CronExpressionTrigger implements TriggerInterface
         [0, 6],
     ];
 
+    private readonly ?string $timezone;
+
     public function __construct(
         private readonly CronExpression $expression = new CronExpression('* * * * *'),
+        \DateTimeZone|string $timezone = null,
     ) {
+        $this->timezone = $timezone instanceof \DateTimeZone ? $timezone->getName() : $timezone;
     }
 
     public function __toString(): string
     {
         return $this->expression->getExpression();
     }
 
-    public static function fromSpec(string $expression = '* * * * *', string $context = null): self
+    public static function fromSpec(string $expression = '* * * * *', string $context = null, \DateTimeZone|string $timezone = null): self
     {
         if (!class_exists(CronExpression::class)) {
             throw new LogicException(sprintf('You cannot use "%s" as the "cron expression" package is not installed. Try running "composer require dragonmantank/cron-expression".', __CLASS__));
         }
 
         if (!str_contains($expression, '#')) {
-            return new self(new CronExpression($expression));
+            return new self(new CronExpression($expression), $timezone);
         }
 
         if (null === $context) {
             throw new LogicException('A context must be provided to use "hashed" cron expressions.');
         }
 
-        return new self(new CronExpression(self::parseHashed($expression, $context)));
+        return new self(new CronExpression(self::parseHashed($expression, $context)), $timezone);
     }
 
     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
     {
-        return \DateTimeImmutable::createFromInterface($this->expression->getNextRunDate($run));
+        return \DateTimeImmutable::createFromInterface($this->expression->getNextRunDate($run, timeZone: $this->timezone));
     }
 
     private static function parseHashed(string $expression, string $context): string

Original file line number	Diff line number	Diff line change
`@@ -48,17 +48,17 @@ public static function every(string\|int\|\DateInterval $frequency, object $messag`
`48`	`48`	`return new self(new PeriodicalTrigger($frequency, $from, $until), $message);`
`49`	`49`	`}`
`50`	`50`
`51`		`- public static function cron(string $expression, object $message): self`
	`51`	`+ public static function cron(string $expression, object $message, \DateTimeZone\|string $timezone = null): self`
`52`	`52`	`{`
`53`	`53`	`if (!str_contains($expression, '#')) {`
`54`		`- return new self(CronExpressionTrigger::fromSpec($expression), $message);`
	`54`	`+ return new self(CronExpressionTrigger::fromSpec($expression, null, $timezone), $message);`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`if (!$message instanceof \Stringable) {`
`58`	`58`	`throw new InvalidArgumentException('A message must be stringable to use "hashed" cron expressions.');`
`59`	`59`	`}`
`60`	`60`
`61`		`- return new self(CronExpressionTrigger::fromSpec($expression, (string) $message), $message);`
	`61`	`+ return new self(CronExpressionTrigger::fromSpec($expression, (string) $message, $timezone), $message);`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`public static function trigger(TriggerInterface $trigger, object $message): self`
Original file line number	Diff line number	Diff line change
`@@ -46,36 +46,40 @@ final class CronExpressionTrigger implements TriggerInterface`
`46`	`46`	`[0, 6],`
`47`	`47`	`];`
`48`	`48`
	`49`	`+ private readonly ?string $timezone;`
	`50`	`+`
`49`	`51`	`public function __construct(`
`50`	`52`	`private readonly CronExpression $expression = new CronExpression('* * * * *'),`
	`53`	`+ \DateTimeZone\|string $timezone = null,`
`51`	`54`	`) {`
	`55`	`+ $this->timezone = $timezone instanceof \DateTimeZone ? $timezone->getName() : $timezone;`
`52`	`56`	`}`
`53`	`57`
`54`	`58`	`public function __toString(): string`
`55`	`59`	`{`
`56`	`60`	`return $this->expression->getExpression();`
`57`	`61`	`}`
`58`	`62`
`59`		`- public static function fromSpec(string $expression = '* * * * *', string $context = null): self`
	`63`	`+ public static function fromSpec(string $expression = '* * * * *', string $context = null, \DateTimeZone\|string $timezone = null): self`
`60`	`64`	`{`
`61`	`65`	`if (!class_exists(CronExpression::class)) {`
`62`	`66`	`throw new LogicException(sprintf('You cannot use "%s" as the "cron expression" package is not installed. Try running "composer require dragonmantank/cron-expression".', __CLASS__));`
`63`	`67`	`}`
`64`	`68`
`65`	`69`	`if (!str_contains($expression, '#')) {`
`66`		`- return new self(new CronExpression($expression));`
	`70`	`+ return new self(new CronExpression($expression), $timezone);`
`67`	`71`	`}`
`68`	`72`
`69`	`73`	`if (null === $context) {`
`70`	`74`	`throw new LogicException('A context must be provided to use "hashed" cron expressions.');`
`71`	`75`	`}`
`72`	`76`
`73`		`- return new self(new CronExpression(self::parseHashed($expression, $context)));`
	`77`	`+ return new self(new CronExpression(self::parseHashed($expression, $context)), $timezone);`
`74`	`78`	`}`
`75`	`79`
`76`	`80`	`public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable`
`77`	`81`	`{`
`78`		`- return \DateTimeImmutable::createFromInterface($this->expression->getNextRunDate($run));`
	`82`	`+ return \DateTimeImmutable::createFromInterface($this->expression->getNextRunDate($run, timeZone: $this->timezone));`
`79`	`83`	`}`
`80`	`84`
`81`	`85`	`private static function parseHashed(string $expression, string $context): string`