bug #47169 [Serializer] Fix throwing right exception in ArrayDenormalizer with invalid type (norkunas)

fabpot · fabpot · commit 12ea6e2a4b50 · 2022-08-03T09:07:49.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Serializer] Fix throwing right exception in ArrayDenormalizer with invalid type | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A Currently it's possible to catch most errors with serializer when using `DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true` but there was no tests trying to deserialize list of objects with an invalid value. So it failed my expectations, because in an api using serializer, consumers could get 500 instead of the proper response, therefore I've submit this as a bugfix. Commits ------- 6337bfd [Serializer] Fix throwing right exception in ArrayDenormalizer with invalid type
diff --git a/src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php b/src/Symfony/Component/Serializer/Normalizer/ArrayDenormalizer.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Serializer\Normalizer;
 
+use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\Exception\BadMethodCallException;
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
 use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
@@ -40,7 +41,7 @@ public function denormalize($data, string $type, string $format = null, array $c
             throw new BadMethodCallException('Please set a denormalizer before calling denormalize()!');
         }
         if (!\is_array($data)) {
-            throw new InvalidArgumentException('Data expected to be an array, '.get_debug_type($data).' given.');
+            throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Data expected to be "%s", "%s" given.', $type, get_debug_type($data)), $data, [Type::BUILTIN_TYPE_ARRAY], $context['deserialization_path'] ?? null);
         }
         if (!str_ends_with($type, '[]')) {
             throw new InvalidArgumentException('Unsupported class: '.$type);
diff --git a/src/Symfony/Component/Serializer/Tests/Fixtures/Php74Full.php b/src/Symfony/Component/Serializer/Tests/Fixtures/Php74Full.php
@@ -31,6 +31,8 @@ final class Php74Full
     public DummyMessageInterface $dummyMessage;
     /** @var TestFoo[] $nestedArray */
     public TestFoo $nestedObject;
+    /** @var Php74Full[] */
+    public $anotherCollection;
 }
 
 
diff --git a/src/Symfony/Component/Serializer/Tests/SerializerTest.php b/src/Symfony/Component/Serializer/Tests/SerializerTest.php
@@ -854,7 +854,8 @@ public function testCollectDenormalizationErrors(?ClassMetadataFactory $classMet
             },
             "nestedObject": {
                 "int": "string"
-            }
+            },
+            "anotherCollection": null
         }';
 
         $extractor = new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()]);
@@ -1030,6 +1031,13 @@ public function testCollectDenormalizationErrors(?ClassMetadataFactory $classMet
                 'useMessageForUser' => true,
                 'message' => 'The type of the key "int" must be "int" ("string" given).',
             ],
+            [
+                'currentType' => 'null',
+                'expectedTypes' => ['array'],
+                'path' => 'anotherCollection',
+                'useMessageForUser' => false,
+                'message' => 'Data expected to be "Symfony\Component\Serializer\Tests\Fixtures\Php74Full[]", "null" given.',
+            ],
         ];
 
         $this->assertSame($expected, $exceptionsAsArray);

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Serializer\Normalizer;`
`13`	`13`
	`14`	`+use Symfony\Component\PropertyInfo\Type;`
`14`	`15`	`use Symfony\Component\Serializer\Exception\BadMethodCallException;`
`15`	`16`	`use Symfony\Component\Serializer\Exception\InvalidArgumentException;`
`16`	`17`	`use Symfony\Component\Serializer\Exception\NotNormalizableValueException;`
`@@ -40,7 +41,7 @@ public function denormalize($data, string $type, string $format = null, array $c`
`40`	`41`	`throw new BadMethodCallException('Please set a denormalizer before calling denormalize()!');`
`41`	`42`	`}`
`42`	`43`	`if (!\is_array($data)) {`
`43`		`- throw new InvalidArgumentException('Data expected to be an array, '.get_debug_type($data).' given.');`
	`44`	`+ throw NotNormalizableValueException::createForUnexpectedDataType(sprintf('Data expected to be "%s", "%s" given.', $type, get_debug_type($data)), $data, [Type::BUILTIN_TYPE_ARRAY], $context['deserialization_path'] ?? null);`
`44`	`45`	`}`
`45`	`46`	`if (!str_ends_with($type, '[]')) {`
`46`	`47`	`throw new InvalidArgumentException('Unsupported class: '.$type);`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ final class Php74Full`
`31`	`31`	`public DummyMessageInterface $dummyMessage;`
`32`	`32`	`/** @var TestFoo[] $nestedArray */`
`33`	`33`	`public TestFoo $nestedObject;`
	`34`	`+ /** @var Php74Full[] */`
	`35`	`+ public $anotherCollection;`
`34`	`36`	`}`
`35`	`37`
`36`	`38`