trigger unique messages at runtime using MessageProvider

Jeroeny · Jeroeny · commit 087967beaafa · 2023-09-15T11:11:28.000+02:00
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -16,17 +16,17 @@
 use Symfony\Component\Scheduler\Trigger\CallbackMessageProvider;
 use Symfony\Component\Scheduler\Trigger\CronExpressionTrigger;
 use Symfony\Component\Scheduler\Trigger\JitterTrigger;
-use Symfony\Component\Scheduler\Trigger\MessageProvider;
+use Symfony\Component\Scheduler\Trigger\MessageProviderInterface;
 use Symfony\Component\Scheduler\Trigger\PeriodicalTrigger;
 use Symfony\Component\Scheduler\Trigger\TriggerInterface;
 
-final class RecurringMessage implements MessageProvider
+final class RecurringMessage implements MessageProviderInterface
 {
     private string $id;
 
     private function __construct(
         private readonly TriggerInterface $trigger,
-        private readonly MessageProvider $provider,
+        private readonly MessageProviderInterface $provider,
     ) {
     }
 
@@ -61,19 +61,16 @@ public static function cron(string $expression, object $message, \DateTimeZone|s
         return self::trigger(CronExpressionTrigger::fromSpec($expression, (string) $message, $timezone), $message);
     }
 
+    /**
+     * @param MessageProviderInterface|object $message A message provider that yields messages or a static message that will be dispatched on every trigger.
+     */
     public static function trigger(TriggerInterface $trigger, object $message): self
     {
-        if ($message instanceof MessageProvider) {
+        if ($message instanceof MessageProviderInterface) {
             return new self($trigger, $message);
         }
 
-        try {
-            $description = $message instanceof \Stringable ? (string) $message : '';
-        } catch (\Exception) {
-            $description = $message::class;
-        }
-
-        return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $description));
+        return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $message instanceof \Stringable ? (string) $message : ''));
     }
 
     public function withJitter(int $maxSeconds = 60): self
@@ -103,7 +100,7 @@ public function getMessages(MessageContext $context): iterable
         return $this->provider->getMessages($context);
     }
 
-    public function getProvider(): MessageProvider
+    public function getProvider(): MessageProviderInterface
     {
         return $this->provider;
     }
diff --git a/src/Symfony/Component/Scheduler/Tests/Generator/MessageGeneratorTest.php b/src/Symfony/Component/Scheduler/Tests/Generator/MessageGeneratorTest.php
@@ -130,9 +130,9 @@ public function testYieldedContext()
 
     public static function messagesProvider(): \Generator
     {
-        $first = (object) ['id' => 'first'];
-        $second = (object) ['id' => 'second'];
-        $third = (object) ['id' => 'third'];
+        $first = new Message(['id' => 'first']);
+        $second = new Message(['id' => 'second']);
+        $third = new Message(['id' => 'third']);
 
         yield 'first' => [
             'startTime' => '22:12:00',
@@ -262,3 +262,14 @@ private static function makeDateTime(string $time): \DateTimeImmutable
         return new \DateTimeImmutable('2020-02-20T'.$time, new \DateTimeZone('UTC'));
     }
 }
+
+class Message {
+    public function __construct(private readonly array $data)
+    {
+    }
+
+    public function __toString(): string
+    {
+        return (string) spl_object_id($this);
+    }
+}
diff --git a/src/Symfony/Component/Scheduler/Tests/Trigger/CallbackMessageProviderTest.php b/src/Symfony/Component/Scheduler/Tests/Trigger/CallbackMessageProviderTest.php
@@ -23,7 +23,7 @@ public function testToString()
         $context = new MessageContext('test', 'test', $this->createMock(TriggerInterface::class), $this->createMock(\DateTimeImmutable::class));
         $messageProvider = new CallbackMessageProvider(fn () => []);
         $this->assertEquals([], $messageProvider->getMessages($context));
-        $this->assertMatchesRegularExpression('/^[\da-f]{32}$/', (string) $messageProvider);
+        $this->assertEquals('', (string) $messageProvider);
 
         $messageProvider = new CallbackMessageProvider(fn () => [new \stdClass()], '');
         $this->assertEquals([new \stdClass()], $messageProvider->getMessages($context));
diff --git a/src/Symfony/Component/Scheduler/Trigger/CallbackMessageProvider.php b/src/Symfony/Component/Scheduler/Trigger/CallbackMessageProvider.php
@@ -13,16 +13,15 @@
 
 use Symfony\Component\Scheduler\Generator\MessageContext;
 
-final class CallbackMessageProvider implements MessageProvider, \Stringable
+final class CallbackMessageProvider implements MessageProviderInterface, \Stringable
 {
     private \Closure $callback;
-
-    private ?string $description;
+    private string $description;
 
     public function __construct(callable $callback, string $description = '')
     {
         $this->callback = $callback(...);
-        $this->description = $description ?? spl_object_hash($this->callback);
+        $this->description = $description;
     }
 
     public function getMessages(MessageContext $context): iterable
diff --git a/src/Symfony/Component/Scheduler/Trigger/MessageProviderInterface.php b/src/Symfony/Component/Scheduler/Trigger/MessageProviderInterface.php

Original file line number	Diff line number	Diff line change
`@@ -16,17 +16,17 @@`
`16`	`16`	`use Symfony\Component\Scheduler\Trigger\CallbackMessageProvider;`
`17`	`17`	`use Symfony\Component\Scheduler\Trigger\CronExpressionTrigger;`
`18`	`18`	`use Symfony\Component\Scheduler\Trigger\JitterTrigger;`
`19`		`-use Symfony\Component\Scheduler\Trigger\MessageProvider;`
	`19`	`+use Symfony\Component\Scheduler\Trigger\MessageProviderInterface;`
`20`	`20`	`use Symfony\Component\Scheduler\Trigger\PeriodicalTrigger;`
`21`	`21`	`use Symfony\Component\Scheduler\Trigger\TriggerInterface;`
`22`	`22`
`23`		`-final class RecurringMessage implements MessageProvider`
	`23`	`+final class RecurringMessage implements MessageProviderInterface`
`24`	`24`	`{`
`25`	`25`	`private string $id;`
`26`	`26`
`27`	`27`	`private function __construct(`
`28`	`28`	`private readonly TriggerInterface $trigger,`
`29`		`- private readonly MessageProvider $provider,`
	`29`	`+ private readonly MessageProviderInterface $provider,`
`30`	`30`	`) {`
`31`	`31`	`}`
`32`	`32`
`@@ -61,19 +61,16 @@ public static function cron(string $expression, object $message, \DateTimeZone\|s`
`61`	`61`	`return self::trigger(CronExpressionTrigger::fromSpec($expression, (string) $message, $timezone), $message);`
`62`	`62`	`}`
`63`	`63`
	`64`	`+ /**`
	`65`	`+ * @param MessageProviderInterface\|object $message A message provider that yields messages or a static message that will be dispatched on every trigger.`
	`66`	`+ */`
`64`	`67`	`public static function trigger(TriggerInterface $trigger, object $message): self`
`65`	`68`	`{`
`66`		`- if ($message instanceof MessageProvider) {`
	`69`	`+ if ($message instanceof MessageProviderInterface) {`
`67`	`70`	`return new self($trigger, $message);`
`68`	`71`	`}`
`69`	`72`
`70`		`- try {`
`71`		`- $description = $message instanceof \Stringable ? (string) $message : '';`
`72`		`- } catch (\Exception) {`
`73`		`- $description = $message::class;`
`74`		`- }`
`75`		`-`
`76`		`- return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $description));`
	`73`	`+ return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $message instanceof \Stringable ? (string) $message : ''));`
`77`	`74`	`}`
`78`	`75`
`79`	`76`	`public function withJitter(int $maxSeconds = 60): self`
`@@ -103,7 +100,7 @@ public function getMessages(MessageContext $context): iterable`
`103`	`100`	`return $this->provider->getMessages($context);`
`104`	`101`	`}`
`105`	`102`
`106`		`- public function getProvider(): MessageProvider`
	`103`	`+ public function getProvider(): MessageProviderInterface`
`107`	`104`	`{`
`108`	`105`	`return $this->provider;`
`109`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,16 +13,15 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\Scheduler\Generator\MessageContext;`
`15`	`15`
`16`		`-final class CallbackMessageProvider implements MessageProvider, \Stringable`
	`16`	`+final class CallbackMessageProvider implements MessageProviderInterface, \Stringable`
`17`	`17`	`{`
`18`	`18`	`private \Closure $callback;`
`19`		`-`
`20`		`- private ?string $description;`
	`19`	`+ private string $description;`
`21`	`20`
`22`	`21`	`public function __construct(callable $callback, string $description = '')`
`23`	`22`	`{`
`24`	`23`	`$this->callback = $callback(...);`
`25`		`- $this->description = $description ?? spl_object_hash($this->callback);`
	`24`	`+ $this->description = $description;`
`26`	`25`	`}`
`27`	`26`
`28`	`27`	`public function getMessages(MessageContext $context): iterable`