[Serializer] Add option to skip uninitialized typed properties

vuryss · vuryss · commit 6b733b44fa76 · 2021-09-08T13:02:04.000+03:00
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\PropertyAccess\Exception\InvalidArgumentException;
 use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
+use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
 use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
 use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\Encoder\CsvEncoder;
@@ -58,6 +59,12 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
      */
     public const SKIP_NULL_VALUES = 'skip_null_values';
 
+    /**
+     * Flag to control whether uninitialized PHP>=7.4 typed class properties
+     * should be excluded when normalizing.
+     */
+    public const SKIP_UNINITIALIZED_VALUES = 'skip_uninitialized_values';
+
     /**
      * Callback to allow to set a value for an attribute when the max depth has
      * been reached.
@@ -180,7 +187,16 @@ public function normalize($object, string $format = null, array $context = [])
             }
 
             $attributeContext = $this->getAttributeNormalizationContext($object, $attribute, $context);
-            $attributeValue = $this->getAttributeValue($object, $attribute, $format, $attributeContext);
+
+            try {
+                $attributeValue = $this->getAttributeValue($object, $attribute, $format, $attributeContext);
+            } catch (UninitializedPropertyException $exception) {
+                if ($context[self::SKIP_UNINITIALIZED_VALUES] ?? $this->defaultContext[self::SKIP_UNINITIALIZED_VALUES] ?? false) {
+                    continue;
+                }
+                throw $exception;
+            }
+
             if ($maxDepthReached) {
                 $attributeValue = $maxDepthHandler($attributeValue, $object, $attribute, $format, $attributeContext);
             }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/Features/SkipUninitializedValuesTestTrait.php b/src/Symfony/Component/Serializer/Tests/Normalizer/Features/SkipUninitializedValuesTestTrait.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Symfony\Component\Serializer\Tests\Normalizer\Features;
+
+use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * Test AbstractObjectNormalizer::SKIP_UNINITIALIZED_VALUES.
+ */
+trait SkipUninitializedValuesTestTrait
+{
+    abstract protected function getNormalizerForSkipUninitializedValues(): NormalizerInterface;
+
+    /**
+     * @requires PHP 7.4
+     */
+    public function testSkipUninitializedValues()
+    {
+        $object = new TypedPropertiesObject();
+
+        $normalizer = $this->getNormalizerForSkipUninitializedValues();
+        $result = $normalizer->normalize($object, null, ['skip_uninitialized_values' => true, 'groups' => ['foo']]);
+        $this->assertSame(['initialized' => 'value'], $result);
+    }
+
+    /**
+     * @requires PHP 7.4
+     */
+    public function testWithoutSkipUninitializedValues()
+    {
+        $object = new TypedPropertiesObject();
+
+        $normalizer = $this->getNormalizerForSkipUninitializedValues();
+        $this->expectException(UninitializedPropertyException::class);
+        $normalizer->normalize($object, null, ['groups' => ['foo']]);
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/Features/TypedPropertiesObject.php b/src/Symfony/Component/Serializer/Tests/Normalizer/Features/TypedPropertiesObject.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Symfony\Component\Serializer\Tests\Normalizer\Features;
+
+use Symfony\Component\Serializer\Annotation\Groups;
+
+class TypedPropertiesObject
+{
+    /**
+     * @Groups({"foo"})
+     */
+    public string $unInitialized;
+
+    /**
+     * @Groups({"foo"})
+     */
+    public string $initialized = 'value';
+
+    /**
+     * @Groups({"bar"})
+     */
+    public string $initialized2 = 'value';
+}
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/ObjectNormalizerTest.php
@@ -49,6 +49,7 @@
 use Symfony\Component\Serializer\Tests\Normalizer\Features\ObjectDummy;
 use Symfony\Component\Serializer\Tests\Normalizer\Features\ObjectToPopulateTestTrait;
 use Symfony\Component\Serializer\Tests\Normalizer\Features\SkipNullValuesTestTrait;
+use Symfony\Component\Serializer\Tests\Normalizer\Features\SkipUninitializedValuesTestTrait;
 use Symfony\Component\Serializer\Tests\Normalizer\Features\TypeEnforcementTestTrait;
 
 /**
@@ -66,6 +67,7 @@ class ObjectNormalizerTest extends TestCase
     use MaxDepthTestTrait;
     use ObjectToPopulateTestTrait;
     use SkipNullValuesTestTrait;
+    use SkipUninitializedValuesTestTrait;
     use TypeEnforcementTestTrait;
 
     /**
@@ -534,6 +536,15 @@ protected function getNormalizerForSkipNullValues(): ObjectNormalizer
         return new ObjectNormalizer();
     }
 
+    // skip uninitialized
+
+    protected function getNormalizerForSkipUninitializedValues(): ObjectNormalizer
+    {
+        $classMetadataFactory = new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader()));
+
+        return new ObjectNormalizer($classMetadataFactory);
+    }
+
     // type enforcement
 
     protected function getDenormalizerForTypeEnforcement(): ObjectNormalizer
