bug symfony#34791 [Serializer] Skip uninitialized (PHP 7.4) properties in PropertyNormalizer and ObjectNormalizer (vudaltsov)

fabpot · fabpot · commit f7244c6c3d47 · 2019-12-15T14:47:04.000+01:00
This PR was squashed before being merged into the 3.4 branch (closes symfony#34791). Discussion ---------- [Serializer] Skip uninitialized (PHP 7.4) properties in PropertyNormalizer and ObjectNormalizer | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a When trying to read from an uninitialized property in PHP 7.4, a `TypeError` is generated, see https://wiki.php.net/rfc/typed_properties_v2#uninitialized_and_unset_properties. This PR fixes the issue. Commits ------- 1ed8e42 [Serializer] Skip uninitialized (PHP 7.4) properties in PropertyNormalizer and ObjectNormalizer
diff --git a/Normalizer/ObjectNormalizer.php b/Normalizer/ObjectNormalizer.php
@@ -83,8 +83,14 @@ protected function extractAttributes($object, $format = null, array $context = [
             }
         }
 
+        $checkPropertyInitialization = \PHP_VERSION_ID >= 70400;
+
         // properties
         foreach ($reflClass->getProperties(\ReflectionProperty::IS_PUBLIC) as $reflProperty) {
+            if ($checkPropertyInitialization && !$reflProperty->isInitialized($object)) {
+                continue;
+            }
+
             if ($reflProperty->isStatic() || !$this->isAllowedAttribute($object, $reflProperty->name, $format, $context)) {
                 continue;
             }
diff --git a/Normalizer/PropertyNormalizer.php b/Normalizer/PropertyNormalizer.php
@@ -99,9 +99,20 @@ protected function extractAttributes($object, $format = null, array $context = [
     {
         $reflectionObject = new \ReflectionObject($object);
         $attributes = [];
+        $checkPropertyInitialization = \PHP_VERSION_ID >= 70400;
 
         do {
             foreach ($reflectionObject->getProperties() as $property) {
+                if ($checkPropertyInitialization) {
+                    if (!$property->isPublic()) {
+                        $property->setAccessible(true);
+                    }
+
+                    if (!$property->isInitialized($object)) {
+                        continue;
+                    }
+                }
+
                 if (!$this->isAllowedAttribute($reflectionObject->getName(), $property->name, $format, $context)) {
                     continue;
                 }
diff --git a/Tests/Fixtures/Php74Dummy.php b/Tests/Fixtures/Php74Dummy.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Tests\Fixtures;
+
+/**
+ * @author Valentin Udaltsov <udaltsov.valentin@gmail.com>
+ */
+final class Php74Dummy
+{
+    public string $uninitializedProperty;
+
+    public string $initializedProperty = 'defaultValue';
+}
diff --git a/Tests/Normalizer/ObjectNormalizerTest.php b/Tests/Normalizer/ObjectNormalizerTest.php
@@ -28,6 +28,7 @@
 use Symfony\Component\Serializer\Tests\Fixtures\CircularReferenceDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\GroupDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\MaxDepthDummy;
+use Symfony\Component\Serializer\Tests\Fixtures\Php74Dummy;
 use Symfony\Component\Serializer\Tests\Fixtures\SiblingHolder;
 
 /**
@@ -81,6 +82,18 @@ public function testNormalize()
         );
     }
 
+    /**
+     * @requires PHP 7.4
+     */
+    public function testNormalizeObjectWithUninitializedProperties()
+    {
+        $obj = new Php74Dummy();
+        $this->assertEquals(
+            ['initializedProperty' => 'defaultValue'],
+            $this->normalizer->normalize($obj, 'any')
+        );
+    }
+
     public function testDenormalize()
     {
         $obj = $this->normalizer->denormalize(
diff --git a/Tests/Normalizer/PropertyNormalizerTest.php b/Tests/Normalizer/PropertyNormalizerTest.php
@@ -22,6 +22,7 @@
 use Symfony\Component\Serializer\Tests\Fixtures\GroupDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\GroupDummyChild;
 use Symfony\Component\Serializer\Tests\Fixtures\MaxDepthDummy;
+use Symfony\Component\Serializer\Tests\Fixtures\Php74Dummy;
 use Symfony\Component\Serializer\Tests\Fixtures\PropertyCircularReferenceDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\PropertySiblingHolder;
 
@@ -55,6 +56,18 @@ public function testNormalize()
         );
     }
 
+    /**
+     * @requires PHP 7.4
+     */
+    public function testNormalizeObjectWithUninitializedProperties()
+    {
+        $obj = new Php74Dummy();
+        $this->assertEquals(
+            ['initializedProperty' => 'defaultValue'],
+            $this->normalizer->normalize($obj, 'any')
+        );
+    }
+
     public function testDenormalize()
     {
         $obj = $this->normalizer->denormalize(

Original file line number	Diff line number	Diff line change
`@@ -83,8 +83,14 @@ protected function extractAttributes($object, $format = null, array $context = [`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`
	`86`	`+ $checkPropertyInitialization = \PHP_VERSION_ID >= 70400;`
	`87`	`+`
`86`	`88`	`// properties`
`87`	`89`	`foreach ($reflClass->getProperties(\ReflectionProperty::IS_PUBLIC) as $reflProperty) {`
	`90`	`+ if ($checkPropertyInitialization && !$reflProperty->isInitialized($object)) {`
	`91`	`+ continue;`
	`92`	`+ }`
	`93`	`+`
`88`	`94`	`if ($reflProperty->isStatic() \|\| !$this->isAllowedAttribute($object, $reflProperty->name, $format, $context)) {`
`89`	`95`	`continue;`
`90`	`96`	`}`