bug #54315 [Serializer] Fixed BackedEnumNormalizer priority for translatable enum (IndraGunawan)

chalasr · chalasr · commit c87e4a1aed7a · 2024-03-23T17:08:06.000+01:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Serializer] Fixed BackedEnumNormalizer priority for translatable enum | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | | License | MIT ```php enum MyEnum: string implements TranslatableInterface { case Get = 'GET'; case Post = 'POST'; case Update = 'UPDATE'; public function trans(TranslatorInterface $translator, ?string $locale = null): string { return match ($this) { self::Get => 'custom_get', self::Post => 'custom_post', self::Update => 'custom_update' }; } } ``` ```php class MyController { public function __invoke(SerializerInterface $serializer) { dd($serializer->serialize(MyEnum::Get)); // ""custom_get"" , Expected result: ""GET"" } } ``` serialize a BackedEnum that implements `TranslatableInterface` will return the translation value instead of the enum item value. this is because `TranslatableNormalizer` ([ref](https://github.com/symfony/symfony/blob/7.1/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.php#L116-L118)) has higher priority than `BackedEnumNormalizer` this PR changes the `BackedEnumNormalizer` priority higher than `TranslatableNormalizer` priority Commits ------- 42fde94 [Serializer] Fixed BackedEnumNormalizer priority for translatable enum
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.php
@@ -219,6 +219,6 @@
             ])
 
         ->set('serializer.normalizer.backed_enum', BackedEnumNormalizer::class)
-            ->tag('serializer.normalizer', ['priority' => -915])
+            ->tag('serializer.normalizer', ['priority' => -880])
     ;
 };
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/TranslatableBackedEnum.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/TranslatableBackedEnum.php
@@ -0,0 +1,27 @@
+<?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\Bundle\FrameworkBundle\Tests\Fixtures;
+
+use Symfony\Contracts\Translation\TranslatableInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+enum TranslatableBackedEnum: string implements TranslatableInterface
+{
+    case Get = 'GET';
+
+    public function trans(TranslatorInterface $translator, ?string $locale = null): string
+    {
+        return match ($this) {
+            self::Get => 'custom_get_string',
+        };
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SerializerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SerializerTest.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
 
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\TranslatableBackedEnum;
+
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
@@ -67,6 +69,15 @@ public static function provideNormalizersAndEncodersWithDefaultContextOption():
             ['serializer.encoder.csv.alias'],
         ];
     }
+
+    public function testSerializeTranslatableBackedEnum()
+    {
+        static::bootKernel(['test_case' => 'Serializer']);
+
+        $serializer = static::getContainer()->get('serializer.alias');
+
+        $this->assertEquals('GET', $serializer->serialize(TranslatableBackedEnum::Get, 'yaml'));
+    }
 }
 
 class Foo

Original file line number	Diff line number	Diff line change
`@@ -219,6 +219,6 @@`
`219`	`219`	`])`
`220`	`220`
`221`	`221`	`->set('serializer.normalizer.backed_enum', BackedEnumNormalizer::class)`
`222`		`- ->tag('serializer.normalizer', ['priority' => -915])`
	`222`	`+ ->tag('serializer.normalizer', ['priority' => -880])`
`223`	`223`	`;`
`224`	`224`	`};`