[Scheduler] add RecurringMessage::getId() and prevent duplicates

kbond · kbond · commit ee23cba48c23 · 2023-03-29T15:44:22.000-04:00
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -21,6 +21,8 @@
  */
 final class RecurringMessage
 {
+    private string $id;
+
     private function __construct(
         private readonly TriggerInterface $trigger,
         private readonly object $message,
@@ -51,6 +53,23 @@ public static function trigger(TriggerInterface $trigger, object $message): self
         return new self($trigger, $message);
     }
 
+    /**
+     * Unique identifier for this message's context.
+     */
+    public function getId(): string
+    {
+        if (isset($this->id)) {
+            return $this->id;
+        }
+
+        return $this->id = hash('crc32c', implode('', [
+            $this->message::class,
+            $this->message instanceof \Stringable ? (string) $this->message : '',
+            $this->trigger::class,
+            $this->trigger instanceof \Stringable ? (string) $this->trigger : '',
+        ]));
+    }
+
     public function getMessage(): object
     {
         return $this->message;
diff --git a/src/Symfony/Component/Scheduler/Schedule.php b/src/Symfony/Component/Scheduler/Schedule.php
@@ -12,14 +12,15 @@
 namespace Symfony\Component\Scheduler;
 
 use Symfony\Component\Lock\LockInterface;
+use Symfony\Component\Scheduler\Exception\LogicException;
 use Symfony\Contracts\Cache\CacheInterface;
 
 /**
  * @experimental
  */
 final class Schedule implements ScheduleProviderInterface
 {
-    /** @var array<RecurringMessage> */
+    /** @var array<string,RecurringMessage> */
     private array $messages = [];
     private ?LockInterface $lock = null;
     private ?CacheInterface $state = null;
@@ -29,8 +30,13 @@ final class Schedule implements ScheduleProviderInterface
      */
     public function add(RecurringMessage $message, RecurringMessage ...$messages): static
     {
-        $this->messages[] = $message;
-        $this->messages = array_merge($this->messages, $messages);
+        foreach ([$message, ...$messages] as $m) {
+            if (isset($this->messages[$m->getId()])) {
+                throw new LogicException('Duplicated schedule message.');
+            }
+
+            $this->messages[$m->getId()] = $m;
+        }
 
         return $this;
     }
@@ -66,7 +72,7 @@ public function getState(): ?CacheInterface
     }
 
     /**
-     * @return array<RecurringMessage>
+     * @return array<string,RecurringMessage>
      */
     public function getRecurringMessages(): array
     {
diff --git a/src/Symfony/Component/Scheduler/Tests/RecurringMessageTest.php b/src/Symfony/Component/Scheduler/Tests/RecurringMessageTest.php
@@ -0,0 +1,27 @@
+<?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\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Scheduler\RecurringMessage;
+
+final class RecurringMessageTest extends TestCase
+{
+    public function testUniqueId()
+    {
+        $message1 = RecurringMessage::cron('* * * * *', new \stdClass());
+        $message2 = RecurringMessage::cron('* 5 * * *', new \stdClass());
+
+        $this->assertSame($message1->getId(), (clone $message1)->getId());
+        $this->assertNotSame($message1->getId(), $message2->getId());
+    }
+}
diff --git a/src/Symfony/Component/Scheduler/Tests/ScheduleTest.php b/src/Symfony/Component/Scheduler/Tests/ScheduleTest.php
@@ -0,0 +1,30 @@
+<?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\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Scheduler\Exception\LogicException;
+use Symfony\Component\Scheduler\RecurringMessage;
+use Symfony\Component\Scheduler\Schedule;
+
+class ScheduleTest extends TestCase
+{
+    public function testCannotAddDuplicateMessage()
+    {
+        $schedule = new Schedule();
+        $schedule->add(RecurringMessage::cron('* * * * *', new \stdClass()));
+
+        $this->expectException(LogicException::class);
+
+        $schedule->add(RecurringMessage::cron('* * * * *', new \stdClass()));
+    }
+}
