[Scheduler] Separate id and description in message providers

Author: valtzu

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 = [];

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']);
     }
 

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];
     }
 }

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], strtr(substr(base64_encode(hash('xxh128', serialize($message), true)), 0, 7), '/+', '._'), -7), $description));
     }
 
     public function withJitter(int $maxSeconds = 60): self

src/Symfony/Component/Scheduler/Tests/Command/DebugCommandTest.php

@@ -106,11 +106,11 @@ public function testExecuteWithScheduleWithoutTriggerShowingNoNextRunWithAllOpti
             "schedule_name\n".
             "-------------\n".
             "\n".
-            " --------- ------------------------------- ---------- \n".
-            "  Trigger   Provider                        Next Run  \n".
-            " --------- ------------------------------- ---------- \n".
-            "  test      stdClass(O:8:\"stdClass\":0:{})   -         \n".
-            " --------- ------------------------------- ---------- \n".
+            " --------- ---------- ---------- \n".
+            "  Trigger   Provider   Next Run  \n".
+            " --------- ---------- ---------- \n".
+            "  test      stdClass   -         \n".
+            " --------- ---------- ---------- \n".
             "\n", $tester->getDisplay(true));
     }
 
@@ -143,11 +143,11 @@ public function testExecuteWithSchedule()
             "schedule_name\n".
             "-------------\n".
             "\n".
-            " ------------------------------- ------------------------------- --------------------------------- \n".
-            "  Trigger                         Provider                        Next Run                         \n".
-            " ------------------------------- ------------------------------- --------------------------------- \n".
-            "  every first day of next month   stdClass\(O:8:\"stdClass\":0:{}\)   \w{3}, \d{1,2} \w{3} \d{4} \d{2}:\d{2}:\d{2} (\+|-)\d{4}  \n".
-            " ------------------------------- ------------------------------- --------------------------------- \n".
+            " ------------------------------- ---------- --------------------------------- \n".
+            "  Trigger                         Provider   Next Run                         \n".
+            " ------------------------------- ---------- --------------------------------- \n".
+            "  every first day of next month   stdClass   \w{3}, \d{1,2} \w{3} \d{4} \d{2}:\d{2}:\d{2} (\+|-)\d{4}  \n".
+            " ------------------------------- ---------- --------------------------------- \n".
             "\n/", $tester->getDisplay(true));
     }
 }

src/Symfony/Component/Scheduler/Tests/RecurringMessageTest.php

@@ -20,12 +20,7 @@ class RecurringMessageTest extends TestCase
 {
     public function testCanCreateHashedCronMessage()
     {
-        $object = new class() {
-            public function __toString(): string
-            {
-                return 'my task';
-            }
-        };
+        $object = new DummyStringableMessage();
 
         if (class_exists(Randomizer::class)) {
             $this->assertSame('30 0 * * *', (string) RecurringMessage::cron('#midnight', $object)->getTrigger());
@@ -52,3 +47,11 @@ public function testUniqueId()
         $this->assertNotSame($message1->getId(), $message2->getId());
     }
 }
+
+class DummyStringableMessage implements \Stringable
+{
+    public function __toString(): string
+    {
+        return 'my task';
+    }
+}

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);
     }
 }

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;
+    }
 }

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;
+    }
 }