feature #50155 [Scheduler] add schedule name to MessageContext (kbond)

fabpot · fabpot · commit 32c5fb051773 · 2023-04-26T19:50:40.000+02:00
This PR was merged into the 6.3 branch. Discussion ---------- [Scheduler] add schedule name to `MessageContext` | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a Alternative to #49864. Commits ------- dc0f0e2 [Scheduler] add schedule name to `MessageContext`
diff --git a/src/Symfony/Component/Scheduler/Generator/MessageContext.php b/src/Symfony/Component/Scheduler/Generator/MessageContext.php
@@ -21,9 +21,10 @@
 final class MessageContext
 {
     public function __construct(
+        public readonly string $name,
         public readonly TriggerInterface $trigger,
         public readonly \DateTimeImmutable $triggeredAt,
-        public readonly \DateTimeImmutable|null $nextTriggerAt = null,
+        public readonly ?\DateTimeImmutable $nextTriggerAt = null,
     ) {
     }
 }
diff --git a/src/Symfony/Component/Scheduler/Generator/MessageGenerator.php b/src/Symfony/Component/Scheduler/Generator/MessageGenerator.php
@@ -27,14 +27,12 @@ final class MessageGenerator implements MessageGeneratorInterface
 
     public function __construct(
         private readonly Schedule $schedule,
-        string|CheckpointInterface $checkpoint,
+        private readonly string $name,
         private readonly ClockInterface $clock = new Clock(),
+        CheckpointInterface $checkpoint = null,
     ) {
         $this->waitUntil = new \DateTimeImmutable('@0');
-        if (\is_string($checkpoint)) {
-            $checkpoint = new Checkpoint('scheduler_checkpoint_'.$checkpoint, $this->schedule->getLock(), $this->schedule->getState());
-        }
-        $this->checkpoint = $checkpoint;
+        $this->checkpoint = $checkpoint ?? new Checkpoint('scheduler_checkpoint_'.$this->name, $this->schedule->getLock(), $this->schedule->getState());
     }
 
     public function getMessages(): \Generator
@@ -70,7 +68,7 @@ public function getMessages(): \Generator
             }
 
             if ($yield) {
-                yield (new MessageContext($trigger, $time, $nextTime)) => $message;
+                yield (new MessageContext($this->name, $trigger, $time, $nextTime)) => $message;
                 $this->checkpoint->save($time, $index);
             }
         }
diff --git a/src/Symfony/Component/Scheduler/Messenger/SchedulerTransportFactory.php b/src/Symfony/Component/Scheduler/Messenger/SchedulerTransportFactory.php
@@ -17,7 +17,6 @@
 use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
 use Symfony\Component\Messenger\Transport\TransportFactoryInterface;
 use Symfony\Component\Scheduler\Exception\InvalidArgumentException;
-use Symfony\Component\Scheduler\Generator\Checkpoint;
 use Symfony\Component\Scheduler\Generator\MessageGenerator;
 use Symfony\Component\Scheduler\Schedule;
 
@@ -46,9 +45,8 @@ public function createTransport(string $dsn, array $options, SerializerInterface
 
         /** @var Schedule $schedule */
         $schedule = $this->scheduleProviders->get($scheduleName)->getSchedule();
-        $checkpoint = new Checkpoint('scheduler_checkpoint_'.$scheduleName, $schedule->getLock(), $schedule->getState());
 
-        return new SchedulerTransport(new MessageGenerator($schedule, $checkpoint, $this->clock));
+        return new SchedulerTransport(new MessageGenerator($schedule, $scheduleName, $this->clock));
     }
 
     public function supports(string $dsn, array $options): bool
diff --git a/src/Symfony/Component/Scheduler/Tests/Messenger/SchedulerTransportTest.php b/src/Symfony/Component/Scheduler/Tests/Messenger/SchedulerTransportTest.php
@@ -34,15 +34,16 @@ public function testGetFromIterator()
         $generator->method('getMessages')->willReturnCallback(function () use ($messages): \Generator {
             $trigger = $this->createMock(TriggerInterface::class);
             $triggerAt = new \DateTimeImmutable('2020-02-20T02:00:00', new \DateTimeZone('UTC'));
-            yield (new MessageContext($trigger, $triggerAt)) => $messages[0];
-            yield (new MessageContext($trigger, $triggerAt)) => $messages[1];
+            yield (new MessageContext('default', $trigger, $triggerAt)) => $messages[0];
+            yield (new MessageContext('default', $trigger, $triggerAt)) => $messages[1];
         });
         $transport = new SchedulerTransport($generator);
 
         foreach ($transport->get() as $envelope) {
             $this->assertInstanceOf(Envelope::class, $envelope);
-            $this->assertNotNull($envelope->last(ScheduledStamp::class));
+            $this->assertNotNull($stamp = $envelope->last(ScheduledStamp::class));
             $this->assertSame(array_shift($messages), $envelope->getMessage());
+            $this->assertSame('default', $stamp->messageContext->name);
         }
 
         $this->assertEmpty($messages);

Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,10 @@`
`21`	`21`	`final class MessageContext`
`22`	`22`	`{`
`23`	`23`	`public function __construct(`
	`24`	`+ public readonly string $name,`
`24`	`25`	`public readonly TriggerInterface $trigger,`
`25`	`26`	`public readonly \DateTimeImmutable $triggeredAt,`
`26`		`- public readonly \DateTimeImmutable\|null $nextTriggerAt = null,`
	`27`	`+ public readonly ?\DateTimeImmutable $nextTriggerAt = null,`
`27`	`28`	`) {`
`28`	`29`	`}`
`29`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,14 +27,12 @@ final class MessageGenerator implements MessageGeneratorInterface`
`27`	`27`
`28`	`28`	`public function __construct(`
`29`	`29`	`private readonly Schedule $schedule,`
`30`		`- string\|CheckpointInterface $checkpoint,`
	`30`	`+ private readonly string $name,`
`31`	`31`	`private readonly ClockInterface $clock = new Clock(),`
	`32`	`+ CheckpointInterface $checkpoint = null,`
`32`	`33`	`) {`
`33`	`34`	`$this->waitUntil = new \DateTimeImmutable('@0');`
`34`		`- if (\is_string($checkpoint)) {`
`35`		`- $checkpoint = new Checkpoint('scheduler_checkpoint_'.$checkpoint, $this->schedule->getLock(), $this->schedule->getState());`
`36`		`- }`
`37`		`- $this->checkpoint = $checkpoint;`
	`35`	`+ $this->checkpoint = $checkpoint ?? new Checkpoint('scheduler_checkpoint_'.$this->name, $this->schedule->getLock(), $this->schedule->getState());`
`38`	`36`	`}`
`39`	`37`
`40`	`38`	`public function getMessages(): \Generator`
`@@ -70,7 +68,7 @@ public function getMessages(): \Generator`
`70`	`68`	`}`
`71`	`69`
`72`	`70`	`if ($yield) {`
`73`		`- yield (new MessageContext($trigger, $time, $nextTime)) => $message;`
	`71`	`+ yield (new MessageContext($this->name, $trigger, $time, $nextTime)) => $message;`
`74`	`72`	`$this->checkpoint->save($time, $index);`
`75`	`73`	`}`
`76`	`74`	`}`