[Scheduler] add JitterTrigger

kbond · vtsykun · kbond · commit ae996e878a7e · 2023-05-09T11:22:14.000-04:00
Co-authored-by: Uladzimir Tsykun &lt;tsykun314@gmail.com&gt;
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -14,6 +14,7 @@
 use Symfony\Component\Scheduler\Exception\InvalidArgumentException;
 use Symfony\Component\Scheduler\Trigger\CronExpressionTrigger;
 use Symfony\Component\Scheduler\Trigger\DateIntervalTrigger;
+use Symfony\Component\Scheduler\Trigger\JitterTrigger;
 use Symfony\Component\Scheduler\Trigger\TriggerInterface;
 
 /**
@@ -59,6 +60,11 @@ public static function trigger(TriggerInterface $trigger, object $message): self
         return new self($trigger, $message);
     }
 
+    public function withJitter(int $value = 60): self
+    {
+        return new self(new JitterTrigger($this->trigger, $value), $this->message);
+    }
+
     public function getMessage(): object
     {
         return $this->message;
diff --git a/src/Symfony/Component/Scheduler/Trigger/JitterTrigger.php b/src/Symfony/Component/Scheduler/Trigger/JitterTrigger.php
@@ -0,0 +1,39 @@
+<?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\Component\Scheduler\Trigger;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class JitterTrigger implements TriggerInterface
+{
+    /**
+     * @param positive-int $value
+     */
+    public function __construct(private readonly TriggerInterface $trigger, private readonly int $value = 60)
+    {
+    }
+
+    public function __toString(): string
+    {
+        return sprintf('%s with 0-%d second jitter', $this->trigger, $this->value);
+    }
+
+    public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
+    {
+        if (!$nextRun = $this->trigger->getNextRunDate($run)) {
+            return null;
+        }
+
+        return $nextRun->add(new \DateInterval(sprintf('PT%sS', random_int(0, $this->value))));
+    }
+}
