Separate message provider id and description

valtzu · valtzu · commit 687a3d64d96f · 2023-12-06T21:07:26.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Messenger/DummyTask.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Messenger/DummyTask.php
@@ -9,6 +9,9 @@
 #[AsCronTask(expression: '0 * * * *', timezone: 'Europe/Berlin', arguments: ['2'], schedule: 'dummy_task', method: 'method2')]
 #[AsPeriodicTask(frequency: 5, arguments: [3], schedule: 'dummy_task')]
 #[AsPeriodicTask(frequency: '1 day', from: '2023-10-25 09:59:00Z', jitter: 60, arguments: ['4'], schedule: 'dummy_task', method: 'method4')]
+#[AsPeriodicTask(frequency: '1 day', from: '2023-10-25 09:59:00Z', arguments: ['9'], schedule: 'dummy_task', method: 'method5')]
+#[AsPeriodicTask(frequency: '1 day', from: '2023-10-25 09:59:00Z', arguments: ['9b'], schedule: 'dummy_task', method: 'method5')]
+#[AsPeriodicTask(frequency: '1 day', from: '2023-10-25 09:59:00Z', arguments: ['named' => '9'], schedule: 'dummy_task', method: 'method5')]
 class DummyTask
 {
     public static array $calls = [];
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SchedulerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SchedulerTest.php
@@ -84,6 +84,7 @@ public function testAutoconfiguredScheduler()
         $this->assertCount(779, $calls['__invoke']);
         $this->assertSame([['2']], $calls['method2']);
         $this->assertSame([['4']], $calls['method4']);
+        $this->assertSame([['9'], ['9b'], ['named' => '9']], $calls['method5']);
         $this->assertSame([['5', 6], ['7', 8]], $calls['attributesOnMethod']);
     }
 
diff --git a/src/Symfony/Component/Scheduler/Command/DebugCommand.php b/src/Symfony/Component/Scheduler/Command/DebugCommand.php
@@ -114,6 +114,9 @@ private static function renderRecurringMessage(RecurringMessage $recurringMessag
             return null;
         }
 
-        return [(string) $trigger, $recurringMessage->getProvider()->getId(), $next];
+        $provider = $recurringMessage->getProvider();
+        $description = $provider instanceof \Stringable ? (string) $provider : $provider->getId();
+
+        return [(string) $trigger, $description, $next];
     }
 }
diff --git a/src/Symfony/Component/Scheduler/RecurringMessage.php b/src/Symfony/Component/Scheduler/RecurringMessage.php
@@ -75,14 +75,15 @@ public static function trigger(TriggerInterface $trigger, object $message): self
             return new self($trigger, $message);
         }
 
-        $description = '';
-        try {
-            $description = $message instanceof \Stringable ? (string) $message : serialize($message);
-        } catch (\Exception) {
+        $description = $message::class;
+        if ($message instanceof \Stringable) {
+            try {
+                $description .= "($message)";
+            } catch (\Exception) {
+            }
         }
-        $description = sprintf('%s(%s)', $message::class, $description);
 
-        return new self($trigger, new StaticMessageProvider([$message], $description));
+        return new self($trigger, new StaticMessageProvider([$message], hash('crc32c', serialize($message)), $description));
     }
 
     public function withJitter(int $maxSeconds = 60): self
diff --git a/src/Symfony/Component/Scheduler/Tests/Trigger/CallbackMessageProviderTest.php b/src/Symfony/Component/Scheduler/Tests/Trigger/CallbackMessageProviderTest.php
@@ -29,8 +29,9 @@ public function testToString()
         $this->assertEquals([new \stdClass()], $messageProvider->getMessages($context));
         $this->assertSame('', $messageProvider->getId());
 
-        $messageProvider = new CallbackMessageProvider(fn () => yield new \stdClass(), 'foo');
+        $messageProvider = new CallbackMessageProvider(fn () => yield new \stdClass(), 'foo', 'bar');
         $this->assertInstanceOf(\Generator::class, $messageProvider->getMessages($context));
         $this->assertSame('foo', $messageProvider->getId());
+        $this->assertSame('bar', (string) $messageProvider);
     }
 }
diff --git a/src/Symfony/Component/Scheduler/Trigger/CallbackMessageProvider.php b/src/Symfony/Component/Scheduler/Trigger/CallbackMessageProvider.php
@@ -13,14 +13,14 @@
 
 use Symfony\Component\Scheduler\Generator\MessageContext;
 
-final class CallbackMessageProvider implements MessageProviderInterface
+final class CallbackMessageProvider implements MessageProviderInterface, \Stringable
 {
     private \Closure $callback;
 
     /**
      * @param callable(MessageContext): iterable<object> $callback
      */
-    public function __construct(callable $callback, private string $id = '')
+    public function __construct(callable $callback, private string $id = '', private string $description = '')
     {
         $this->callback = $callback(...);
     }
@@ -34,4 +34,9 @@ public function getId(): string
     {
         return $this->id;
     }
+
+    public function __toString(): string
+    {
+        return $this->description ?: $this->id;
+    }
 }
diff --git a/src/Symfony/Component/Scheduler/Trigger/StaticMessageProvider.php b/src/Symfony/Component/Scheduler/Trigger/StaticMessageProvider.php
@@ -13,14 +13,15 @@
 
 use Symfony\Component\Scheduler\Generator\MessageContext;
 
-final class StaticMessageProvider implements MessageProviderInterface
+final class StaticMessageProvider implements MessageProviderInterface, \Stringable
 {
     /**
      * @param array<object> $messages
      */
     public function __construct(
         private array $messages,
         private string $id = '',
+        private string $description = '',
     ) {
     }
 
@@ -33,4 +34,9 @@ public function getId(): string
     {
         return $this->id;
     }
+
+    public function __toString(): string
+    {
+        return $this->description ?: $this->id;
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@ public function testAutoconfiguredScheduler()`
`84`	`84`	`$this->assertCount(779, $calls['__invoke']);`
`85`	`85`	`$this->assertSame([['2']], $calls['method2']);`
`86`	`86`	`$this->assertSame([['4']], $calls['method4']);`
	`87`	`+ $this->assertSame([['9'], ['9b'], ['named' => '9']], $calls['method5']);`
`87`	`88`	`$this->assertSame([['5', 6], ['7', 8]], $calls['attributesOnMethod']);`
`88`	`89`	`}`
`89`	`90`
Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,9 @@ private static function renderRecurringMessage(RecurringMessage $recurringMessag`
`114`	`114`	`return null;`
`115`	`115`	`}`
`116`	`116`
`117`		`- return [(string) $trigger, $recurringMessage->getProvider()->getId(), $next];`
	`117`	`+ $provider = $recurringMessage->getProvider();`
	`118`	`+ $description = $provider instanceof \Stringable ? (string) $provider : $provider->getId();`
	`119`	`+`
	`120`	`+ return [(string) $trigger, $description, $next];`
`118`	`121`	`}`
`119`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,14 +75,15 @@ public static function trigger(TriggerInterface $trigger, object $message): self`
`75`	`75`	`return new self($trigger, $message);`
`76`	`76`	`}`
`77`	`77`
`78`		`- $description = '';`
`79`		`- try {`
`80`		`- $description = $message instanceof \Stringable ? (string) $message : serialize($message);`
`81`		`- } catch (\Exception) {`
	`78`	`+ $description = $message::class;`
	`79`	`+ if ($message instanceof \Stringable) {`
	`80`	`+ try {`
	`81`	`+ $description .= "($message)";`
	`82`	`+ } catch (\Exception) {`
	`83`	`+ }`
`82`	`84`	`}`
`83`		`- $description = sprintf('%s(%s)', $message::class, $description);`
`84`	`85`
`85`		`- return new self($trigger, new StaticMessageProvider([$message], $description));`
	`86`	`+ return new self($trigger, new StaticMessageProvider([$message], hash('crc32c', serialize($message)), $description));`
`86`	`87`	`}`
`87`	`88`
`88`	`89`	`public function withJitter(int $maxSeconds = 60): self`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,9 @@ public function testToString()`
`29`	`29`	`$this->assertEquals([new \stdClass()], $messageProvider->getMessages($context));`
`30`	`30`	`$this->assertSame('', $messageProvider->getId());`
`31`	`31`
`32`		`- $messageProvider = new CallbackMessageProvider(fn () => yield new \stdClass(), 'foo');`
	`32`	`+ $messageProvider = new CallbackMessageProvider(fn () => yield new \stdClass(), 'foo', 'bar');`
`33`	`33`	`$this->assertInstanceOf(\Generator::class, $messageProvider->getMessages($context));`
`34`	`34`	`$this->assertSame('foo', $messageProvider->getId());`
	`35`	`+ $this->assertSame('bar', (string) $messageProvider);`
`35`	`36`	`}`
`36`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,14 +13,14 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\Scheduler\Generator\MessageContext;`
`15`	`15`
`16`		`-final class CallbackMessageProvider implements MessageProviderInterface`
	`16`	`+final class CallbackMessageProvider implements MessageProviderInterface, \Stringable`
`17`	`17`	`{`
`18`	`18`	`private \Closure $callback;`
`19`	`19`
`20`	`20`	`/**`
`21`	`21`	`* @param callable(MessageContext): iterable<object> $callback`
`22`	`22`	`*/`
`23`		`- public function __construct(callable $callback, private string $id = '')`
	`23`	`+ public function __construct(callable $callback, private string $id = '', private string $description = '')`
`24`	`24`	`{`
`25`	`25`	`$this->callback = $callback(...);`
`26`	`26`	`}`
`@@ -34,4 +34,9 @@ public function getId(): string`
`34`	`34`	`{`
`35`	`35`	`return $this->id;`
`36`	`36`	`}`
	`37`	`+`
	`38`	`+ public function __toString(): string`
	`39`	`+ {`
	`40`	`+ return $this->description ?: $this->id;`
	`41`	`+ }`
`37`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,14 +13,15 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\Scheduler\Generator\MessageContext;`
`15`	`15`
`16`		`-final class StaticMessageProvider implements MessageProviderInterface`
	`16`	`+final class StaticMessageProvider implements MessageProviderInterface, \Stringable`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`	`19`	`* @param array<object> $messages`
`20`	`20`	`*/`
`21`	`21`	`public function __construct(`
`22`	`22`	`private array $messages,`
`23`	`23`	`private string $id = '',`
	`24`	`+ private string $description = '',`
`24`	`25`	`) {`
`25`	`26`	`}`
`26`	`27`
`@@ -33,4 +34,9 @@ public function getId(): string`
`33`	`34`	`{`
`34`	`35`	`return $this->id;`
`35`	`36`	`}`
	`37`	`+`
	`38`	`+ public function __toString(): string`
	`39`	`+ {`
	`40`	`+ return $this->description ?: $this->id;`
	`41`	`+ }`
`36`	`42`	`}`