Added random delay to allows delaying cron trigger startups by random amount of seconds

vtsykun · vtsykun · commit 2bb84c239de8 · 2023-03-26T23:40:14.000+02:00
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -41,9 +41,9 @@ public static function every(string $frequency, object $message, string|\DateTim
         return new self(new DateIntervalTrigger($interval, $from, $until), $message);
     }
 
-    public static function cron(string $expression, object $message): self
+    public static function cron(string $expression, object $message, int $randomDelay = 0): self
     {
-        return new self(CronExpressionTrigger::fromSpec($expression), $message);
+        return new self(CronExpressionTrigger::fromSpec($expression, $randomDelay), $message);
     }
 
     public static function trigger(TriggerInterface $trigger, object $message): self
diff --git a/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php b/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php
@@ -25,6 +25,7 @@ final class CronExpressionTrigger implements TriggerInterface, \Stringable
 {
     public function __construct(
         private readonly CronExpression $expression = new CronExpression('* * * * *'),
+        private readonly int $randomDelay = 0
     ) {
     }
 
@@ -33,17 +34,22 @@ public function __toString(): string
         return "cron: {$this->expression->getExpression()}";
     }
 
-    public static function fromSpec(string $expression = '* * * * *'): self
+    public static function fromSpec(string $expression = '* * * * *', int $randomDelay = 0): 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__));
         }
 
-        return new self(new CronExpression($expression));
+        return new self(new CronExpression($expression), $randomDelay);
     }
 
     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
     {
-        return \DateTimeImmutable::createFromMutable($this->expression->getNextRunDate($run));
+        $nextRun = $this->expression->getNextRunDate($run);
+        if ($this->randomDelay > 0) {
+            $nextRun->sub(new \DateInterval('PT'.random_int(0, $this->randomDelay).'S'));
+        }
+
+        return \DateTimeImmutable::createFromMutable($nextRun);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -41,9 +41,9 @@ public static function every(string $frequency, object $message, string\|\DateTim`
`41`	`41`	`return new self(new DateIntervalTrigger($interval, $from, $until), $message);`
`42`	`42`	`}`
`43`	`43`
`44`		`- public static function cron(string $expression, object $message): self`
	`44`	`+ public static function cron(string $expression, object $message, int $randomDelay = 0): self`
`45`	`45`	`{`
`46`		`- return new self(CronExpressionTrigger::fromSpec($expression), $message);`
	`46`	`+ return new self(CronExpressionTrigger::fromSpec($expression, $randomDelay), $message);`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`public static function trigger(TriggerInterface $trigger, object $message): self`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ final class CronExpressionTrigger implements TriggerInterface, \Stringable`
`25`	`25`	`{`
`26`	`26`	`public function __construct(`
`27`	`27`	`private readonly CronExpression $expression = new CronExpression('* * * * *'),`
	`28`	`+ private readonly int $randomDelay = 0`
`28`	`29`	`) {`
`29`	`30`	`}`
`30`	`31`
`@@ -33,17 +34,22 @@ public function __toString(): string`
`33`	`34`	`return "cron: {$this->expression->getExpression()}";`
`34`	`35`	`}`
`35`	`36`
`36`		`- public static function fromSpec(string $expression = '* * * * *'): self`
	`37`	`+ public static function fromSpec(string $expression = '* * * * *', int $randomDelay = 0): self`
`37`	`38`	`{`
`38`	`39`	`if (!class_exists(CronExpression::class)) {`
`39`	`40`	`throw new LogicException(sprintf('You cannot use "%s" as the "cron expression" package is not installed; try running "composer require dragonmantank/cron-expression".', __CLASS__));`
`40`	`41`	`}`
`41`	`42`
`42`		`- return new self(new CronExpression($expression));`
	`43`	`+ return new self(new CronExpression($expression), $randomDelay);`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable`
`46`	`47`	`{`
`47`		`- return \DateTimeImmutable::createFromMutable($this->expression->getNextRunDate($run));`
	`48`	`+ $nextRun = $this->expression->getNextRunDate($run);`
	`49`	`+ if ($this->randomDelay > 0) {`
	`50`	`+ $nextRun->sub(new \DateInterval('PT'.random_int(0, $this->randomDelay).'S'));`
	`51`	`+ }`
	`52`	`+`
	`53`	`+ return \DateTimeImmutable::createFromMutable($nextRun);`
`48`	`54`	`}`
`49`	`55`	`}`