[Serializer] Throw InvalidArgumentException if the data needed in the constructor doesn't belong to a backedEnum

allison guilhem · alli83 · commit c30f057db29a · 2022-08-18T20:47:30.000+02:00
diff --git a/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/BackedEnumNormalizer.php
@@ -64,7 +64,7 @@ public function denormalize($data, string $type, string $format = null, array $c
         try {
             return $type::from($data);
         } catch (\ValueError $e) {
-            throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true, $e->getCode(), $e);
+            throw new InvalidArgumentException('The data must belong to a backed enumeration of type '.$type);
         }
     }
 
diff --git a/src/Symfony/Component/Serializer/Tests/Fixtures/DummyObjectWithEnumConstructor.php b/src/Symfony/Component/Serializer/Tests/Fixtures/DummyObjectWithEnumConstructor.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Symfony\Component\Serializer\Tests\Fixtures;
+
+use Symfony\Component\Serializer\Tests\Fixtures\StringBackedEnumDummy;
+
+class DummyObjectWithEnumConstructor
+{
+    public function __construct(public StringBackedEnumDummy $get)
+    {
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/BackedEnumNormalizerTest.php
@@ -115,8 +115,9 @@ public function testDenormalizeObjectThrowsException()
      */
     public function testDenormalizeBadBackingValueThrowsException()
     {
-        $this->expectException(NotNormalizableValueException::class);
-        $this->expectExceptionMessage('"POST" is not a valid backing value for enum "'.StringBackedEnumDummy::class.'"');
+        $this->expectException(InvalidArgumentException::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
@@ -36,6 +36,7 @@
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
 use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
+use Symfony\Component\Serializer\Normalizer\BackedEnumNormalizer;
 use Symfony\Component\Serializer\Normalizer\CustomNormalizer;
 use Symfony\Component\Serializer\Normalizer\DataUriNormalizer;
 use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
@@ -58,6 +59,7 @@
 use Symfony\Component\Serializer\Tests\Fixtures\DummyMessageInterface;
 use Symfony\Component\Serializer\Tests\Fixtures\DummyMessageNumberOne;
 use Symfony\Component\Serializer\Tests\Fixtures\DummyMessageNumberTwo;
+use Symfony\Component\Serializer\Tests\Fixtures\DummyObjectWithEnumConstructor;
 use Symfony\Component\Serializer\Tests\Fixtures\FalseBuiltInDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\NormalizableTraversableDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\Php74Full;
@@ -1173,6 +1175,69 @@ public function testCollectDenormalizationErrorsWithConstructor(?ClassMetadataFa
         $this->assertSame($expected, $exceptionsAsArray);
     }
 
+    /**
+     * @requires PHP 8.1
+     */
+    public function testCollectDenormalizationErrorsWithEnumConstructor()
+    {
+        $serializer = new Serializer(
+            [
+                new BackedEnumNormalizer(),
+                new ObjectNormalizer(),
+            ],
+            ['json' => new JsonEncoder()]
+        );
+
+        try {
+            $serializer->deserialize('{"invalid": "GET"}', DummyObjectWithEnumConstructor::class, 'json', [
+                DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true,
+            ]);
+        } catch (\Throwable $th) {
+            $this->assertInstanceOf(PartialDenormalizationException::class, $th);
+        }
+
+        $exceptionsAsArray = array_map(function (NotNormalizableValueException $e): array {
+            return [
+                'currentType' => $e->getCurrentType(),
+                'useMessageForUser' => $e->canUseMessageForUser(),
+                'message' => $e->getMessage(),
+            ];
+        }, $th->getErrors());
+
+        $expected = [
+            [
+                'currentType' => 'array',
+                'useMessageForUser' => true,
+                'message' => 'Failed to create object because the class misses the "get" property.',
+            ],
+        ];
+
+        $this->assertSame($expected, $exceptionsAsArray);
+    }
+
+    /**
+     * @requires PHP 8.1
+     */
+    public function testNoCollectDenormalizationErrorsWithWrongEnum()
+    {
+        $serializer = new Serializer(
+            [
+                new BackedEnumNormalizer(),
+                new ObjectNormalizer(),
+            ],
+            ['json' => new JsonEncoder()]
+        );
+
+        try {
+            $serializer->deserialize('{"get": "invalid"}', DummyObjectWithEnumConstructor::class, 'json', [
+                DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true,
+            ]);
+        } catch (\Throwable $th) {
+            $this->assertNotInstanceOf(PartialDenormalizationException::class, $th);
+            $this->assertInstanceOf(InvalidArgumentException::class, $th);
+        }
+    }
+
     public function provideCollectDenormalizationErrors()
     {
         return [

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function denormalize($data, string $type, string $format = null, array $c`
`64`	`64`	`try {`
`65`	`65`	`return $type::from($data);`
`66`	`66`	`} catch (\ValueError $e) {`
`67`		`- throw NotNormalizableValueException::createForUnexpectedDataType($e->getMessage(), $data, [Type::BUILTIN_TYPE_INT, Type::BUILTIN_TYPE_STRING], $context['deserialization_path'] ?? null, true, $e->getCode(), $e);`
	`67`	`+ throw new InvalidArgumentException('The data must belong to a backed enumeration of type '.$type);`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`
Original file line number	Diff line number	Diff line change
`@@ -115,8 +115,9 @@ public function testDenormalizeObjectThrowsException()`
`115`	`115`	`*/`
`116`	`116`	`public function testDenormalizeBadBackingValueThrowsException()`
`117`	`117`	`{`
`118`		`- $this->expectException(NotNormalizableValueException::class);`
`119`		`- $this->expectExceptionMessage('"POST" is not a valid backing value for enum "'.StringBackedEnumDummy::class.'"');`
	`118`	`+ $this->expectException(InvalidArgumentException::class);`
	`119`	`+ $this->expectExceptionMessage('The data must belong to a backed enumeration of type '.StringBackedEnumDummy::class);`
	`120`	`+`
`120`	`121`	`$this->normalizer->denormalize('POST', StringBackedEnumDummy::class);`
`121`	`122`	`}`
`122`	`123`