bug #51399 [Serializer] Fix deserializing of nested snake_case attributes using CamelCaseToSnakeCaseNameConverter (Victor-Truhanovich)

nicolas-grekas · nicolas-grekas · commit bf4ea595a94a · 2023-08-23T12:09:44.000+02:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [Serializer] Fix deserializing of nested snake_case attributes using CamelCaseToSnakeCaseNameConverter | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT It was not possible to deserialize nested attributes using CamelCaseToSnakeCaseNameConverter ### Example ```php readonly class Foo { public function __conctruct( #[SerializedPath("[one][two_three]")] public $fooBar, ) { } } $factory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())); $normalizer = new ObjectNormalizer($factory, new CamelCaseToSnakeCaseNameConverter()); $serializer = new Serializer([$normalizer]); $data = [ 'one' => [ 'two_three' => 'fooBar', ], ]; $foo = $serializer->denormalize($data, Foo::class, 'any'); ``` Commits ------- f114c55 [Serializer] Fix deserializing of nested snake_case attributes using CamelCaseToSnakeCaseNameConverter
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -326,13 +326,15 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
         $mappedClass = $this->getMappedClass($normalizedData, $type, $context);
 
         $nestedAttributes = $this->getNestedAttributes($mappedClass);
-        $nestedData = [];
+        $nestedData = $originalNestedData = [];
         $propertyAccessor = PropertyAccess::createPropertyAccessor();
         foreach ($nestedAttributes as $property => $serializedPath) {
             if (null === $value = $propertyAccessor->getValue($normalizedData, $serializedPath)) {
                 continue;
             }
-            $nestedData[$property] = $value;
+            $convertedProperty = $this->nameConverter ? $this->nameConverter->normalize($property, $mappedClass, $format, $context) : $property;
+            $nestedData[$convertedProperty] = $value;
+            $originalNestedData[$property] = $value;
             $normalizedData = $this->removeNestedValue($serializedPath->getElements(), $normalizedData);
         }
 
@@ -345,7 +347,7 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
             if ($this->nameConverter) {
                 $notConverted = $attribute;
                 $attribute = $this->nameConverter->denormalize($attribute, $resolvedClass, $format, $context);
-                if (isset($nestedData[$notConverted]) && !isset($nestedData[$attribute])) {
+                if (isset($nestedData[$notConverted]) && !isset($originalNestedData[$attribute])) {
                     throw new LogicException(sprintf('Duplicate values for key "%s" found. One value is set via the SerializedPath annotation: "%s", the other one is set via the SerializedName annotation: "%s".', $notConverted, implode('->', $nestedAttributes[$notConverted]->getElements()), $attribute));
                 }
             }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractObjectNormalizerTest.php
@@ -33,6 +33,7 @@
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
 use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
 use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
+use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 use Symfony\Component\Serializer\NameConverter\MetadataAwareNameConverter;
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
@@ -140,6 +141,29 @@ public function testDenormalizeWithNestedAttributesWithoutMetadata()
         $this->assertNull($test->notfoo);
     }
 
+    public function testDenormalizeWithSnakeCaseNestedAttributes()
+    {
+        $factory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+        $normalizer = new ObjectNormalizer($factory, new CamelCaseToSnakeCaseNameConverter());
+        $data = [
+            'one' => [
+                'two_three' => 'fooBar',
+            ],
+        ];
+        $test = $normalizer->denormalize($data, SnakeCaseNestedDummy::class, 'any');
+        $this->assertSame('fooBar', $test->fooBar);
+    }
+
+    public function testNormalizeWithSnakeCaseNestedAttributes()
+    {
+        $factory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+        $normalizer = new ObjectNormalizer($factory, new CamelCaseToSnakeCaseNameConverter());
+        $dummy = new SnakeCaseNestedDummy();
+        $dummy->fooBar = 'fooBar';
+        $test = $normalizer->normalize($dummy, 'any');
+        $this->assertSame(['one' => ['two_three' => 'fooBar']], $test);
+    }
+
     public function testDenormalizeWithNestedAttributes()
     {
         $normalizer = new AbstractObjectNormalizerWithMetadata();
@@ -861,6 +885,14 @@ public function __construct(
     }
 }
 
+class SnakeCaseNestedDummy
+{
+    /**
+     * @SerializedPath("[one][two_three]")
+     */
+    public $fooBar;
+}
+
 /**
  * @DiscriminatorMap(typeProperty="type", mapping={
  *     "first" = FirstNestedDummyWithConstructorAndDiscriminator::class,

Original file line number	Diff line number	Diff line change
`@@ -326,13 +326,15 @@ public function denormalize(mixed $data, string $type, string $format = null, ar`
`326`	`326`	`$mappedClass = $this->getMappedClass($normalizedData, $type, $context);`
`327`	`327`
`328`	`328`	`$nestedAttributes = $this->getNestedAttributes($mappedClass);`
`329`		`- $nestedData = [];`
	`329`	`+ $nestedData = $originalNestedData = [];`
`330`	`330`	`$propertyAccessor = PropertyAccess::createPropertyAccessor();`
`331`	`331`	`foreach ($nestedAttributes as $property => $serializedPath) {`
`332`	`332`	`if (null === $value = $propertyAccessor->getValue($normalizedData, $serializedPath)) {`
`333`	`333`	`continue;`
`334`	`334`	`}`
`335`		`- $nestedData[$property] = $value;`
	`335`	`+ $convertedProperty = $this->nameConverter ? $this->nameConverter->normalize($property, $mappedClass, $format, $context) : $property;`
	`336`	`+ $nestedData[$convertedProperty] = $value;`
	`337`	`+ $originalNestedData[$property] = $value;`
`336`	`338`	`$normalizedData = $this->removeNestedValue($serializedPath->getElements(), $normalizedData);`
`337`	`339`	`}`
`338`	`340`
`@@ -345,7 +347,7 @@ public function denormalize(mixed $data, string $type, string $format = null, ar`
`345`	`347`	`if ($this->nameConverter) {`
`346`	`348`	`$notConverted = $attribute;`
`347`	`349`	`$attribute = $this->nameConverter->denormalize($attribute, $resolvedClass, $format, $context);`
`348`		`- if (isset($nestedData[$notConverted]) && !isset($nestedData[$attribute])) {`
	`350`	`+ if (isset($nestedData[$notConverted]) && !isset($originalNestedData[$attribute])) {`
`349`	`351`	`throw new LogicException(sprintf('Duplicate values for key "%s" found. One value is set via the SerializedPath annotation: "%s", the other one is set via the SerializedName annotation: "%s".', $notConverted, implode('->', $nestedAttributes[$notConverted]->getElements()), $attribute));`
`350`	`352`	`}`
`351`	`353`	`}`