[Scheduler] add CronExpressionTrigger::jitter()

kbond · vtsykun · kbond · commit 79aa0a4cf128 · 2023-05-08T18:08:44.000-04:00
Co-authored-by: Uladzimir Tsykun &lt;tsykun314@gmail.com&gt;
diff --git a/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php b/src/Symfony/Component/Scheduler/Trigger/CronExpressionTrigger.php
@@ -14,6 +14,7 @@
 use Cron\CronExpression;
 use Random\Engine\Xoshiro256StarStar;
 use Random\Randomizer;
+use Symfony\Component\Scheduler\Exception\InvalidArgumentException;
 use Symfony\Component\Scheduler\Exception\LogicException;
 
 /**
@@ -46,6 +47,8 @@ final class CronExpressionTrigger implements TriggerInterface
         [0, 6],
     ];
 
+    private int $jitter = 0;
+
     public function __construct(
         private readonly CronExpression $expression = new CronExpression('* * * * *'),
     ) {
@@ -73,9 +76,26 @@ public static function fromSpec(string $expression = '* * * * *', string $contex
         return new self(new CronExpression(self::parseHashed($expression, $context)));
     }
 
+    public function jitter(int $value = 60): self
+    {
+        if ($value < 0 || $value > 60) {
+            throw new InvalidArgumentException('The jitter value must be between 0 and 60.');
+        }
+
+        $this->jitter = $value;
+
+        return $this;
+    }
+
     public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
     {
-        return \DateTimeImmutable::createFromMutable($this->expression->getNextRunDate($run));
+        $nextRun = \DateTimeImmutable::createFromMutable($this->expression->getNextRunDate($run));
+
+        if ($this->jitter > 0) {
+            $nextRun = $nextRun->add(new \DateInterval(sprintf('PT%sS', random_int(0, $this->jitter))));
+        }
+
+        return $nextRun;
     }
 
     private static function parseHashed(string $expression, string $context): string
