apply feedback

Jeroeny · Jeroeny · commit 8869bd7a9585 · 2023-09-15T11:45:08.000+02:00
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -40,6 +40,8 @@ private function __construct(
      *  * A relative date format as supported by \DateInterval;
      *  * A \DateInterval instance.
      *
+     * @param MessageProviderInterface|object $message A message provider that yields messages or a static message that will be dispatched on every trigger
+     *
      * @see https://en.wikipedia.org/wiki/ISO_8601#Durations
      * @see https://php.net/datetime.formats.relative
      */
@@ -48,6 +50,9 @@ public static function every(string|int|\DateInterval $frequency, object $messag
         return self::trigger(new PeriodicalTrigger($frequency, $from, $until), $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 cron(string $expression, object $message, \DateTimeZone|string $timezone = null): self
     {
         if (!str_contains($expression, '#')) {
@@ -62,15 +67,21 @@ public static function cron(string $expression, object $message, \DateTimeZone|s
     }
 
     /**
-     * @param MessageProviderInterface|object $message A message provider that yields messages or a static message that will be dispatched on every trigger.
+     * @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 MessageProviderInterface) {
             return new self($trigger, $message);
         }
 
-        return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $message instanceof \Stringable ? (string) $message : ''));
+        try {
+            $description = $message instanceof \Stringable ? (string) $message : serialize($message);
+        } catch (\Exception) {
+            $description = $message::class;
+        }
+
+        return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $description));
     }
 
     public function withJitter(int $maxSeconds = 60): self
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 = new Message(['id' => 'first']);
-        $second = new Message(['id' => 'second']);
-        $third = new Message(['id' => 'third']);
+        $first = (object) ['id' => 'first'];
+        $second = (object) ['id' => 'second'];
+        $third = (object) ['id' => 'third'];
 
         yield 'first' => [
             'startTime' => '22:12:00',
@@ -262,15 +262,3 @@ 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/Trigger/CallbackMessageProvider.php b/src/Symfony/Component/Scheduler/Trigger/CallbackMessageProvider.php
@@ -16,12 +16,10 @@
 final class CallbackMessageProvider implements MessageProviderInterface, \Stringable
 {
     private \Closure $callback;
-    private string $description;
 
     public function __construct(callable $callback, private string $description = '')
     {
         $this->callback = $callback(...);
-        $this->description = $description;
     }
 
     public function getMessages(MessageContext $context): iterable

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@ private function __construct(`
`40`	`40`	`* * A relative date format as supported by \DateInterval;`
`41`	`41`	`* * A \DateInterval instance.`
`42`	`42`	`*`
	`43`	`+ * @param MessageProviderInterface\|object $message A message provider that yields messages or a static message that will be dispatched on every trigger`
	`44`	`+ *`
`43`	`45`	`* @see https://en.wikipedia.org/wiki/ISO_8601#Durations`
`44`	`46`	`* @see https://php.net/datetime.formats.relative`
`45`	`47`	`*/`
`@@ -48,6 +50,9 @@ public static function every(string\|int\|\DateInterval $frequency, object $messag`
`48`	`50`	`return self::trigger(new PeriodicalTrigger($frequency, $from, $until), $message);`
`49`	`51`	`}`
`50`	`52`
	`53`	`+ /**`
	`54`	`+ * @param MessageProviderInterface\|object $message A message provider that yields messages or a static message that will be dispatched on every trigger`
	`55`	`+ */`
`51`	`56`	`public static function cron(string $expression, object $message, \DateTimeZone\|string $timezone = null): self`
`52`	`57`	`{`
`53`	`58`	`if (!str_contains($expression, '#')) {`
`@@ -62,15 +67,21 @@ public static function cron(string $expression, object $message, \DateTimeZone\|s`
`62`	`67`	`}`
`63`	`68`
`64`	`69`	`/**`
`65`		`- * @param MessageProviderInterface\|object $message A message provider that yields messages or a static message that will be dispatched on every trigger.`
	`70`	`+ * @param MessageProviderInterface\|object $message A message provider that yields messages or a static message that will be dispatched on every trigger`
`66`	`71`	`*/`
`67`	`72`	`public static function trigger(TriggerInterface $trigger, object $message): self`
`68`	`73`	`{`
`69`	`74`	`if ($message instanceof MessageProviderInterface) {`
`70`	`75`	`return new self($trigger, $message);`
`71`	`76`	`}`
`72`	`77`
`73`		`- return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $message instanceof \Stringable ? (string) $message : ''));`
	`78`	`+ try {`
	`79`	`+ $description = $message instanceof \Stringable ? (string) $message : serialize($message);`
	`80`	`+ } catch (\Exception) {`
	`81`	`+ $description = $message::class;`
	`82`	`+ }`
	`83`	`+`
	`84`	`+ return new self($trigger, new CallbackMessageProvider(static fn (): array => [$message], $description));`
`74`	`85`	`}`
`75`	`86`
`76`	`87`	`public function withJitter(int $maxSeconds = 60): self`
Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,10 @@`
`16`	`16`	`final class CallbackMessageProvider implements MessageProviderInterface, \Stringable`
`17`	`17`	`{`
`18`	`18`	`private \Closure $callback;`
`19`		`- private string $description;`
`20`	`19`
`21`	`20`	`public function __construct(callable $callback, private string $description = '')`
`22`	`21`	`{`
`23`	`22`	`$this->callback = $callback(...);`
`24`		`- $this->description = $description;`
`25`	`23`	`}`
`26`	`24`
`27`	`25`	`public function getMessages(MessageContext $context): iterable`