[Scheduler] allow MessageGenerator's to return RecurringMessage[]

kbond · kbond · commit cede63f33a25 · 2023-03-29T17:54:01.000-04:00
- Add `RecurringMessage` to `ScheduledStamp`.
diff --git a/src/Symfony/Component/Scheduler/Generator/MessageGenerator.php b/src/Symfony/Component/Scheduler/Generator/MessageGenerator.php
@@ -13,6 +13,7 @@
 
 use Psr\Clock\ClockInterface;
 use Symfony\Component\Clock\Clock;
+use Symfony\Component\Scheduler\RecurringMessage;
 use Symfony\Component\Scheduler\Schedule;
 use Symfony\Component\Scheduler\Trigger\TriggerInterface;
 
@@ -37,6 +38,9 @@ public function __construct(
         $this->checkpoint = $checkpoint;
     }
 
+    /**
+     * @return \Generator<RecurringMessage>
+     */
     public function getMessages(): \Generator
     {
         if (!$this->waitUntil
@@ -54,8 +58,8 @@ public function getMessages(): \Generator
             /** @var TriggerInterface $trigger */
             /** @var int $index */
             /** @var \DateTimeImmutable $time */
-            /** @var object $message */
-            [$time, $index, $trigger, $message] = $heap->extract();
+            /** @var object $recurringMessage */
+            [$time, $index, $trigger, $recurringMessage] = $heap->extract();
             $yield = true;
 
             if ($time < $lastTime) {
@@ -66,11 +70,11 @@ public function getMessages(): \Generator
             }
 
             if ($nextTime = $trigger->getNextRunDate($time)) {
-                $heap->insert([$nextTime, $index, $trigger, $message]);
+                $heap->insert([$nextTime, $index, $trigger, $recurringMessage]);
             }
 
             if ($yield) {
-                yield $message;
+                yield $recurringMessage;
                 $this->checkpoint->save($time, $index);
             }
         }
@@ -93,7 +97,7 @@ private function heap(\DateTimeImmutable $time): TriggerHeap
                 continue;
             }
 
-            $heap->insert([$nextTime, $index, $recurringMessage->getTrigger(), $recurringMessage->getMessage()]);
+            $heap->insert([$nextTime, $index, $recurringMessage->getTrigger(), $recurringMessage]);
         }
 
         return $this->triggerHeap = $heap;
diff --git a/src/Symfony/Component/Scheduler/Generator/MessageGeneratorInterface.php b/src/Symfony/Component/Scheduler/Generator/MessageGeneratorInterface.php
@@ -11,13 +11,15 @@
 
 namespace Symfony\Component\Scheduler\Generator;
 
+use Symfony\Component\Scheduler\RecurringMessage;
+
 /**
  * @experimental
  */
 interface MessageGeneratorInterface
 {
     /**
-     * @return iterable<object>
+     * @return iterable<object|RecurringMessage>
      */
     public function getMessages(): iterable;
 }
diff --git a/src/Symfony/Component/Scheduler/Messenger/ScheduledStamp.php b/src/Symfony/Component/Scheduler/Messenger/ScheduledStamp.php
@@ -12,10 +12,14 @@
 namespace Symfony\Component\Scheduler\Messenger;
 
 use Symfony\Component\Messenger\Stamp\NonSendableStampInterface;
+use Symfony\Component\Scheduler\RecurringMessage;
 
 /**
  * @experimental
  */
 final class ScheduledStamp implements NonSendableStampInterface
 {
+    public function __construct(public readonly RecurringMessage $recurringMessage)
+    {
+    }
 }
diff --git a/src/Symfony/Component/Scheduler/Messenger/SchedulerTransport.php b/src/Symfony/Component/Scheduler/Messenger/SchedulerTransport.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Transport\TransportInterface;
 use Symfony\Component\Scheduler\Exception\LogicException;
 use Symfony\Component\Scheduler\Generator\MessageGeneratorInterface;
+use Symfony\Component\Scheduler\RecurringMessage;
 
 /**
  * @experimental
@@ -29,7 +30,11 @@ public function __construct(
     public function get(): iterable
     {
         foreach ($this->messageGenerator->getMessages() as $message) {
-            yield Envelope::wrap($message, [new ScheduledStamp()]);
+            if (!$message instanceof RecurringMessage) {
+                throw new LogicException(sprintf('Messages from "%s" must be instances of "%s". Got "%s".', __CLASS__, RecurringMessage::class, get_debug_type($message)));
+            }
+
+            yield Envelope::wrap($message->getMessage(), [new ScheduledStamp($message)]);
         }
     }
 
diff --git a/src/Symfony/Component/Scheduler/Scheduler.php b/src/Symfony/Component/Scheduler/Scheduler.php
@@ -66,6 +66,10 @@ public function run(array $options = []): void
             $ran = false;
             foreach ($this->generators as $generator) {
                 foreach ($generator->getMessages() as $message) {
+                    if ($message instanceof RecurringMessage) {
+                        $message = $message->getMessage();
+                    }
+
                     $this->handlers[$message::class]($message);
                     $ran = true;
                 }
diff --git a/src/Symfony/Component/Scheduler/Tests/Generator/MessageGeneratorTest.php b/src/Symfony/Component/Scheduler/Tests/Generator/MessageGeneratorTest.php
@@ -47,7 +47,8 @@ public function testGetMessages(string $startTime, array $runs, array $schedule)
 
         foreach ($runs as $time => $expected) {
             $now = self::makeDateTime($time);
-            $this->assertSame($expected, iterator_to_array($scheduler->getMessages()));
+            $messages = array_map(fn (RecurringMessage $m) => $m->getMessage(), iterator_to_array($scheduler->getMessages()));
+            $this->assertSame($expected, $messages);
         }
     }
 
diff --git a/src/Symfony/Component/Scheduler/Tests/Messenger/SchedulerTransportTest.php b/src/Symfony/Component/Scheduler/Tests/Messenger/SchedulerTransportTest.php
@@ -17,24 +17,28 @@
 use Symfony\Component\Scheduler\Generator\MessageGeneratorInterface;
 use Symfony\Component\Scheduler\Messenger\ScheduledStamp;
 use Symfony\Component\Scheduler\Messenger\SchedulerTransport;
+use Symfony\Component\Scheduler\RecurringMessage;
 
 class SchedulerTransportTest extends TestCase
 {
     public function testGetFromIterator()
     {
         $messages = [
-            (object) ['id' => 'first'],
-            (object) ['id' => 'second'],
+            RecurringMessage::cron('* * * * *', (object) ['id' => 'first']),
+            RecurringMessage::cron('* * * * *', (object) ['id' => 'second']),
         ];
         $generator = $this->createConfiguredMock(MessageGeneratorInterface::class, [
             'getMessages' => $messages,
         ]);
         $transport = new SchedulerTransport($generator);
 
         foreach ($transport->get() as $envelope) {
+            $message = array_shift($messages);
+
             $this->assertInstanceOf(Envelope::class, $envelope);
-            $this->assertNotNull($envelope->last(ScheduledStamp::class));
-            $this->assertSame(array_shift($messages), $envelope->getMessage());
+            $this->assertEquals($message, $envelope->last(ScheduledStamp::class)?->recurringMessage);
+            $this->assertSame($message->getMessage(), $envelope->getMessage());
+            $this->assertSame($message->getMessage(), $envelope->getMessage());
         }
 
         $this->assertEmpty($messages);

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Psr\Clock\ClockInterface;`
`15`	`15`	`use Symfony\Component\Clock\Clock;`
	`16`	`+use Symfony\Component\Scheduler\RecurringMessage;`
`16`	`17`	`use Symfony\Component\Scheduler\Schedule;`
`17`	`18`	`use Symfony\Component\Scheduler\Trigger\TriggerInterface;`
`18`	`19`
`@@ -37,6 +38,9 @@ public function __construct(`
`37`	`38`	`$this->checkpoint = $checkpoint;`
`38`	`39`	`}`
`39`	`40`
	`41`	`+ /**`
	`42`	`+ * @return \Generator<RecurringMessage>`
	`43`	`+ */`
`40`	`44`	`public function getMessages(): \Generator`
`41`	`45`	`{`
`42`	`46`	`if (!$this->waitUntil`
`@@ -54,8 +58,8 @@ public function getMessages(): \Generator`
`54`	`58`	`/** @var TriggerInterface $trigger */`
`55`	`59`	`/** @var int $index */`
`56`	`60`	`/** @var \DateTimeImmutable $time */`
`57`		`- /** @var object $message */`
`58`		`- [$time, $index, $trigger, $message] = $heap->extract();`
	`61`	`+ /** @var object $recurringMessage */`
	`62`	`+ [$time, $index, $trigger, $recurringMessage] = $heap->extract();`
`59`	`63`	`$yield = true;`
`60`	`64`
`61`	`65`	`if ($time < $lastTime) {`
`@@ -66,11 +70,11 @@ public function getMessages(): \Generator`
`66`	`70`	`}`
`67`	`71`
`68`	`72`	`if ($nextTime = $trigger->getNextRunDate($time)) {`
`69`		`- $heap->insert([$nextTime, $index, $trigger, $message]);`
	`73`	`+ $heap->insert([$nextTime, $index, $trigger, $recurringMessage]);`
`70`	`74`	`}`
`71`	`75`
`72`	`76`	`if ($yield) {`
`73`		`- yield $message;`
	`77`	`+ yield $recurringMessage;`
`74`	`78`	`$this->checkpoint->save($time, $index);`
`75`	`79`	`}`
`76`	`80`	`}`
`@@ -93,7 +97,7 @@ private function heap(\DateTimeImmutable $time): TriggerHeap`
`93`	`97`	`continue;`
`94`	`98`	`}`
`95`	`99`
`96`		`- $heap->insert([$nextTime, $index, $recurringMessage->getTrigger(), $recurringMessage->getMessage()]);`
	`100`	`+ $heap->insert([$nextTime, $index, $recurringMessage->getTrigger(), $recurringMessage]);`
`97`	`101`	`}`
`98`	`102`
`99`	`103`	`return $this->triggerHeap = $heap;`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,14 @@`
`12`	`12`	`namespace Symfony\Component\Scheduler\Messenger;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Messenger\Stamp\NonSendableStampInterface;`
	`15`	`+use Symfony\Component\Scheduler\RecurringMessage;`
`15`	`16`
`16`	`17`	`/**`
`17`	`18`	`* @experimental`
`18`	`19`	`*/`
`19`	`20`	`final class ScheduledStamp implements NonSendableStampInterface`
`20`	`21`	`{`
	`22`	`+ public function __construct(public readonly RecurringMessage $recurringMessage)`
	`23`	`+ {`
	`24`	`+ }`
`21`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`use Symfony\Component\Messenger\Transport\TransportInterface;`
`16`	`16`	`use Symfony\Component\Scheduler\Exception\LogicException;`
`17`	`17`	`use Symfony\Component\Scheduler\Generator\MessageGeneratorInterface;`
	`18`	`+use Symfony\Component\Scheduler\RecurringMessage;`
`18`	`19`
`19`	`20`	`/**`
`20`	`21`	`* @experimental`
`@@ -29,7 +30,11 @@ public function __construct(`
`29`	`30`	`public function get(): iterable`
`30`	`31`	`{`
`31`	`32`	`foreach ($this->messageGenerator->getMessages() as $message) {`
`32`		`- yield Envelope::wrap($message, [new ScheduledStamp()]);`
	`33`	`+ if (!$message instanceof RecurringMessage) {`
	`34`	`+ throw new LogicException(sprintf('Messages from "%s" must be instances of "%s". Got "%s".', __CLASS__, RecurringMessage::class, get_debug_type($message)));`
	`35`	`+ }`
	`36`	`+`
	`37`	`+ yield Envelope::wrap($message->getMessage(), [new ScheduledStamp($message)]);`
`33`	`38`	`}`
`34`	`39`	`}`
`35`	`40`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,8 @@ public function testGetMessages(string $startTime, array $runs, array $schedule)`
`47`	`47`
`48`	`48`	`foreach ($runs as $time => $expected) {`
`49`	`49`	`$now = self::makeDateTime($time);`
`50`		`- $this->assertSame($expected, iterator_to_array($scheduler->getMessages()));`
	`50`	`+ $messages = array_map(fn (RecurringMessage $m) => $m->getMessage(), iterator_to_array($scheduler->getMessages()));`
	`51`	`+ $this->assertSame($expected, $messages);`
`51`	`52`	`}`
`52`	`53`	`}`
`53`	`54`