feature #59679 [Scheduler] Normalize TriggerInterface as string (valtzu)

fabpot · fabpot · commit 277486aef8c7 · 2025-02-07T08:46:50.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [Scheduler] Normalize `TriggerInterface` as `string` | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | yes | New feature? | yes | Deprecations? | no | Issues | Fix #53562 | License | MIT Fix the issue with Scheduler & Serializer like `@kbond` described in #53562 (comment). Fixes the following error: ``` Could not decode stamp: The type of the "trigger" attribute for class "Symfony\Component\Scheduler\Generator\MessageContext" must be one of "Symfony\Component\Scheduler\Trigger\TriggerInterface" ("array" given). ``` Commits ------- 3aa47e0 Normalize `TriggerInterface` as `string`
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/scheduler.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/scheduler.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Scheduler\EventListener\DispatchSchedulerEventListener;
 use Symfony\Component\Scheduler\Messenger\SchedulerTransportFactory;
+use Symfony\Component\Scheduler\Messenger\Serializer\Normalizer\SchedulerTriggerNormalizer;
 use Symfony\Component\Scheduler\Messenger\ServiceCallMessageHandler;
 
 return static function (ContainerConfigurator $container) {
@@ -34,5 +35,7 @@
                 service('event_dispatcher'),
             ])
             ->tag('kernel.event_subscriber')
+        ->set('serializer.normalizer.scheduler_trigger', SchedulerTriggerNormalizer::class)
+            ->tag('serializer.normalizer', ['built_in' => true, 'priority' => -880])
     ;
 };
diff --git a/src/Symfony/Component/Scheduler/CHANGELOG.md b/src/Symfony/Component/Scheduler/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add `TriggerNormalizer`
+
 7.2
 ---
 
diff --git a/src/Symfony/Component/Scheduler/Messenger/Serializer/Normalizer/SchedulerTriggerNormalizer.php b/src/Symfony/Component/Scheduler/Messenger/Serializer/Normalizer/SchedulerTriggerNormalizer.php
@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Scheduler\Messenger\Serializer\Normalizer;
+
+use Symfony\Component\Messenger\Transport\Serialization\Serializer;
+use Symfony\Component\Scheduler\Trigger\TriggerInterface;
+use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+final class SchedulerTriggerNormalizer implements DenormalizerInterface, NormalizerInterface
+{
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            TriggerInterface::class => false,
+        ];
+    }
+
+    /**
+     * @param TriggerInterface $data
+     */
+    public function normalize(mixed $data, ?string $format = null, array $context = []): string
+    {
+        return (string) $data;
+    }
+
+    public function supportsNormalization(mixed $data, ?string $format = null, array $context = []): bool
+    {
+        return $data instanceof TriggerInterface && ($context[Serializer::MESSENGER_SERIALIZATION_CONTEXT] ?? false);
+    }
+
+    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): TriggerInterface
+    {
+        return new class($data) implements TriggerInterface {
+            public function __construct(private readonly string $description)
+            {
+            }
+
+            public function __toString(): string
+            {
+                return $this->description;
+            }
+
+            public function getNextRunDate(\DateTimeImmutable $run): ?\DateTimeImmutable
+            {
+                throw new \LogicException('Not possible to get next run date from a deserialized trigger.');
+            }
+        };
+    }
+
+    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []): bool
+    {
+        return TriggerInterface::class === $type && ($context[Serializer::MESSENGER_SERIALIZATION_CONTEXT] ?? false) && \is_string($data);
+    }
+}
diff --git a/src/Symfony/Component/Scheduler/Tests/Messenger/SchedulerTriggerNormalizerTest.php b/src/Symfony/Component/Scheduler/Tests/Messenger/SchedulerTriggerNormalizerTest.php
@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Scheduler\Tests\Messenger;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Scheduler\Messenger\Serializer\Normalizer\SchedulerTriggerNormalizer;
+use Symfony\Component\Scheduler\Trigger\CallbackTrigger;
+use Symfony\Component\Scheduler\Trigger\PeriodicalTrigger;
+use Symfony\Component\Scheduler\Trigger\TriggerInterface;
+
+class SchedulerTriggerNormalizerTest extends TestCase
+{
+    private SchedulerTriggerNormalizer $normalizer;
+
+    /**
+     * @before
+     */
+    protected function setUpNormalizer(): void
+    {
+        $this->normalizer = new SchedulerTriggerNormalizer();
+    }
+
+    /**
+     * @dataProvider normalizeProvider
+     */
+    public function testNormalize(mixed $data, mixed $expected)
+    {
+        self::assertSame($expected, $this->normalizer->normalize($data));
+    }
+
+    public static function normalizeProvider(): iterable
+    {
+        yield 'CallbackTrigger' => [new CallbackTrigger(fn () => null, 'test1'), 'test1'];
+        yield 'PeriodicalTrigger' => [new PeriodicalTrigger(5), 'every 5 seconds'];
+    }
+
+    /**
+     * @dataProvider supportsNormalizationProvider
+     */
+    public function testSupportsNormalization(mixed $data, array $context, bool $expected)
+    {
+        self::assertSame($expected, $this->normalizer->supportsNormalization($data, 'json', $context));
+    }
+
+    public static function supportsNormalizationProvider(): iterable
+    {
+        yield 'CallbackTrigger, messenger context' => [new CallbackTrigger(fn () => null, 'test1'), ['messenger_serialization' => true], true];
+        yield 'CallbackTrigger, normal context' => [new CallbackTrigger(fn () => null, 'test1'), [], false];
+        yield 'PeriodicalTrigger, messenger context' => [new PeriodicalTrigger(5), ['messenger_serialization' => true], true];
+        yield 'PeriodicalTrigger, normal context' => [new PeriodicalTrigger(5), [], false];
+        yield 'stdClass, messenger context' => [new \stdClass(), ['messenger_serialization' => true], false];
+        yield 'stdClass, normal context' => [new \stdClass(), [], false];
+    }
+
+    /**
+     * @dataProvider supportsDenormalizationProvider
+     */
+    public function testSupportsDenormalization(mixed $data, string $type, array $context, bool $expected)
+    {
+        self::assertSame($expected, $this->normalizer->supportsDenormalization($data, $type, 'json', $context));
+    }
+
+    public static function supportsDenormalizationProvider(): iterable
+    {
+        yield 'unknown type' => ['test', \stdClass::class, ['messenger_serialization' => true], false];
+        yield 'string, messenger context' => ['test', TriggerInterface::class, ['messenger_serialization' => true], true];
+        yield 'string, normal context' => ['test', TriggerInterface::class, [], false];
+        yield 'array, messenger context' => [['a' => 'b'], TriggerInterface::class, ['messenger_serialization' => true], false];
+        yield 'array, normal context' => [['a' => 'b'], TriggerInterface::class, [], false];
+    }
+
+    public function testDenormalize()
+    {
+        $trigger = $this->normalizer->denormalize('every 5 seconds', TriggerInterface::class);
+        self::assertSame('every 5 seconds', (string) $trigger);
+    }
+}
