[Serializer] Improve denormalization of backed enums

rodion-k · rodion-k · commit 90ffb90fc5af · 2023-05-03T13:57:14.000+03:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -21,6 +21,8 @@ CHANGELOG
    * `JsonSerializableNormalizer`
    * `ObjectNormalizer`
    * `PropertyNormalizer`
+ * Make `BackedEnumNormalizer` throw `NotNormalizableValueException` when the backed type doesn't match
+ * Make `BackedEnumNormalizer` throw `NotNormalizableValueException` when the value does not belong to a backed enumeration
 
 6.2
 ---
diff --git a/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Serializer\Normalizer;
 
-use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
 use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
 
@@ -69,14 +68,17 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
             }
         }
 
-        if (!\is_int($data) && !\is_string($data)) {
-            throw NotNormalizableValueException::createForUnexpectedDataType('The data is neither an integer nor a string, you should pass an integer or a string that can be parsed as an enumeration case of type '.$type.'.', $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);
+        $backingType = (new \ReflectionEnum($type))->getBackingType()->getName();
+        $givenType = \get_debug_type($data);
+
+        if ($givenType !== $backingType) {
+            throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Data expected to be "%s", "%s" given. You should pass a value that can be parsed as an enumeration case of type %s.', $backingType, $givenType, $type), $data, [$backingType], $context['deserialization_path'] ?? null, true);
         }
 
         try {
             return $type::from($data);
         } catch (\ValueError $e) {
-            throw new InvalidArgumentException('The data must belong to a backed enumeration of type '.$type);
+            throw NotNormalizableValueException::createForUnexpectedDataType('The data must belong to a backed enumeration of type '.$type, $data, [$backingType], $context['deserialization_path'] ?? null, true);
         }
     }
 
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php
@@ -86,9 +86,16 @@ public function testDenormalizeObjectThrowsException()
         $this->normalizer->denormalize(new \stdClass(), StringBackedEnumDummy::class);
     }
 
+    public function testDenormalizeBadBackingTypeThrowsException()
+    {
+        $this->expectException(NotNormalizableValueException::class);
+        $this->expectExceptionMessage('Data expected to be "string", "int" given. You should pass a value that can be parsed as an enumeration case of type '.StringBackedEnumDummy::class.'.');
+        $this->normalizer->denormalize(1, StringBackedEnumDummy::class);
+    }
+
     public function testDenormalizeBadBackingValueThrowsException()
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(NotNormalizableValueException::class);
         $this->expectExceptionMessage('The data must belong to a backed enumeration of type '.StringBackedEnumDummy::class);
 
         $this->normalizer->denormalize('POST', StringBackedEnumDummy::class);
diff --git a/src/Symfony/Component/Serializer/Tests/SerializerTest.php b/src/Symfony/Component/Serializer/Tests/SerializerTest.php
@@ -59,6 +59,7 @@
 use Symfony\Component\Serializer\Tests\Fixtures\NormalizableTraversableDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\Php74Full;
 use Symfony\Component\Serializer\Tests\Fixtures\Php80WithPromotedTypedConstructor;
+use Symfony\Component\Serializer\Tests\Fixtures\StringBackedEnumDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\TraversableDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\TrueBuiltInDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\UpcomingDenormalizerInterface as DenormalizerInterface;
@@ -1208,7 +1209,7 @@ public function testCollectDenormalizationErrorsWithEnumConstructor()
         $this->assertSame($expected, $exceptionsAsArray);
     }
 
-    public function testNoCollectDenormalizationErrorsWithWrongEnum()
+    public function testCollectDenormalizationErrorsWithWrongEnum()
     {
         $serializer = new Serializer(
             [
@@ -1223,8 +1224,9 @@ public function testNoCollectDenormalizationErrorsWithWrongEnum()
                 DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true,
             ]);
         } catch (\Throwable $th) {
-            $this->assertNotInstanceOf(PartialDenormalizationException::class, $th);
-            $this->assertInstanceOf(InvalidArgumentException::class, $th);
+            $this->assertInstanceOf(PartialDenormalizationException::class, $th);
+            $this->assertArrayHasKey(0, $th->getErrors());
+            $this->assertSame("The data must belong to a backed enumeration of type ".StringBackedEnumDummy::class, $th->getErrors()[0]->getMessage());
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Serializer\Normalizer;`
`13`	`13`
`14`		`-use Symfony\Component\PropertyInfo\Type;`
`15`	`14`	`use Symfony\Component\Serializer\Exception\InvalidArgumentException;`
`16`	`15`	`use Symfony\Component\Serializer\Exception\NotNormalizableValueException;`
`17`	`16`
`@@ -69,14 +68,17 @@ public function denormalize(mixed $data, string $type, string $format = null, ar`
`69`	`68`	`}`
`70`	`69`	`}`
`71`	`70`
`72`		`- if (!\is_int($data) && !\is_string($data)) {`
`73`		`- throw NotNormalizableValueException::createForUnexpectedDataType('The data is neither an integer nor a string, you should pass an integer or a string that can be parsed as an enumeration case of type '.$type.'.', $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true);`
	`71`	`+ $backingType = (new \ReflectionEnum($type))->getBackingType()->getName();`
	`72`	`+ $givenType = \get_debug_type($data);`
	`73`	`+`
	`74`	`+ if ($givenType !== $backingType) {`
	`75`	`+ throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Data expected to be "%s", "%s" given. You should pass a value that can be parsed as an enumeration case of type %s.', $backingType, $givenType, $type), $data, [$backingType], $context['deserialization_path'] ?? null, true);`
`74`	`76`	`}`
`75`	`77`
`76`	`78`	`try {`
`77`	`79`	`return $type::from($data);`
`78`	`80`	`} catch (\ValueError $e) {`
`79`		`- throw new InvalidArgumentException('The data must belong to a backed enumeration of type '.$type);`
	`81`	`+ throw NotNormalizableValueException::createForUnexpectedDataType('The data must belong to a backed enumeration of type '.$type, $data, [$backingType], $context['deserialization_path'] ?? null, true);`
`80`	`82`	`}`
`81`	`83`	`}`
`82`	`84`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,7 @@`
`59`	`59`	`use Symfony\Component\Serializer\Tests\Fixtures\NormalizableTraversableDummy;`
`60`	`60`	`use Symfony\Component\Serializer\Tests\Fixtures\Php74Full;`
`61`	`61`	`use Symfony\Component\Serializer\Tests\Fixtures\Php80WithPromotedTypedConstructor;`
	`62`	`+use Symfony\Component\Serializer\Tests\Fixtures\StringBackedEnumDummy;`
`62`	`63`	`use Symfony\Component\Serializer\Tests\Fixtures\TraversableDummy;`
`63`	`64`	`use Symfony\Component\Serializer\Tests\Fixtures\TrueBuiltInDummy;`
`64`	`65`	`use Symfony\Component\Serializer\Tests\Fixtures\UpcomingDenormalizerInterface as DenormalizerInterface;`
`@@ -1208,7 +1209,7 @@ public function testCollectDenormalizationErrorsWithEnumConstructor()`
`1208`	`1209`	`$this->assertSame($expected, $exceptionsAsArray);`
`1209`	`1210`	`}`
`1210`	`1211`
`1211`		`- public function testNoCollectDenormalizationErrorsWithWrongEnum()`
	`1212`	`+ public function testCollectDenormalizationErrorsWithWrongEnum()`
`1212`	`1213`	`{`
`1213`	`1214`	`$serializer = new Serializer(`
`1214`	`1215`	`[`
`@@ -1223,8 +1224,9 @@ public function testNoCollectDenormalizationErrorsWithWrongEnum()`
`1223`	`1224`	`DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true,`
`1224`	`1225`	`]);`
`1225`	`1226`	`} catch (\Throwable $th) {`
`1226`		`- $this->assertNotInstanceOf(PartialDenormalizationException::class, $th);`
`1227`		`- $this->assertInstanceOf(InvalidArgumentException::class, $th);`
	`1227`	`+ $this->assertInstanceOf(PartialDenormalizationException::class, $th);`
	`1228`	`+ $this->assertArrayHasKey(0, $th->getErrors());`
	`1229`	`+ $this->assertSame("The data must belong to a backed enumeration of type ".StringBackedEnumDummy::class, $th->getErrors()[0]->getMessage());`
`1228`	`1230`	`}`
`1229`	`1231`	`}`
`1230`	`1232`