bug symfony#52680 [Serializer] Fix access to private properties/getters when using the @Ignore annotation (mtarld)

nicolas-grekas · nicolas-grekas · commit 1da3a5ccbb67 · 2023-11-24T12:44:17.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [Serializer] Fix access to private properties/getters when using the ``@Ignore`` annotation | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix symfony#52673 symfony#49710 | License | MIT Commits ------- cc356b0 [Serializer] Fix access to private when Ignore
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -302,22 +302,18 @@ protected function getAttributes(object $object, ?string $format, array $context
             return $this->attributesCache[$key];
         }
 
-        $allowedAttributes = $this->getAllowedAttributes($object, $context, true);
-
-        if (false !== $allowedAttributes) {
-            if ($context['cache_key']) {
-                $this->attributesCache[$key] = $allowedAttributes;
-            }
-
-            return $allowedAttributes;
-        }
-
         $attributes = $this->extractAttributes($object, $format, $context);
 
         if ($this->classDiscriminatorResolver && $mapping = $this->classDiscriminatorResolver->getMappingForMappedObject($object)) {
             array_unshift($attributes, $mapping->getTypeProperty());
         }
 
+        $allowedAttributes = $this->getAllowedAttributes($object, $context, true);
+
+        if (false !== $allowedAttributes) {
+            $attributes = array_intersect($attributes, $allowedAttributes);
+        }
+
         if ($context['cache_key'] && \stdClass::class !== $class) {
             $this->attributesCache[$key] = $attributes;
         }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractObjectNormalizerTest.php
@@ -15,6 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
 use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\Serializer\Annotation\Ignore;
 use Symfony\Component\Serializer\Exception\ExtraAttributesException;
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
 use Symfony\Component\Serializer\Exception\LogicException;
@@ -444,6 +445,14 @@ public function testNormalizeEmptyObject()
         $normalizedData = $normalizer->normalize(new EmptyDummy(), 'any', ['preserve_empty_objects' => true]);
         $this->assertEquals(new \ArrayObject(), $normalizedData);
     }
+
+    public function testNormalizeWithIgnoreAnnotationAndPrivateProperties()
+    {
+        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+        $serializer = new Serializer([new ObjectNormalizer($classMetadataFactory)]);
+
+        $this->assertSame(['foo' => 'foo'], $serializer->normalize(new ObjectDummyWithIgnoreAnnotationAndPrivateProperty()));
+    }
 }
 
 class AbstractObjectNormalizerDummy extends AbstractObjectNormalizer
@@ -484,6 +493,16 @@ class EmptyDummy
 {
 }
 
+class ObjectDummyWithIgnoreAnnotationAndPrivateProperty
+{
+    public $foo = 'foo';
+
+    /** @Ignore */
+    public $ignored = 'ignored';
+
+    private $private = 'private';
+}
+
 class AbstractObjectNormalizerWithMetadata extends AbstractObjectNormalizer
 {
     public function __construct()
diff --git a/src/Symfony/Component/Serializer/Tests/SerializerTest.php b/src/Symfony/Component/Serializer/Tests/SerializerTest.php
@@ -471,7 +471,7 @@ public function testDeserializeAndSerializeInterfacedObjectsWithTheClassMetadata
             'groups' => ['two'],
         ]);
 
-        $this->assertEquals('{"two":2,"type":"one"}', $serialized);
+        $this->assertEquals('{"type":"one","two":2}', $serialized);
     }
 
     public function testDeserializeAndSerializeNestedInterfacedObjectsWithTheClassMetadataDiscriminator()

Original file line number	Diff line number	Diff line change
`@@ -471,7 +471,7 @@ public function testDeserializeAndSerializeInterfacedObjectsWithTheClassMetadata`
`471`	`471`	`'groups' => ['two'],`
`472`	`472`	`]);`
`473`	`473`
`474`		`- $this->assertEquals('{"two":2,"type":"one"}', $serialized);`
	`474`	`+ $this->assertEquals('{"type":"one","two":2}', $serialized);`
`475`	`475`	`}`
`476`	`476`
`477`	`477`	`public function testDeserializeAndSerializeNestedInterfacedObjectsWithTheClassMetadataDiscriminator()`