bug #53906 [VarDumper] Fix serialization of stubs with null or uninitialized values (derrabus)

derrabus · derrabus · commit 9f692c67702d · 2024-02-13T09:52:57.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [VarDumper] Fix serialization of stubs with null or uninitialized values | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #53905 | License | MIT The`Stub::__sleep()` implementation excludes properties from the serialized representation that are set to their defaults, but it cannot tell apart properties with a null value from properties that don't have a default. This is an issue for typed properties that are uninitialized by default. Commits ------- 3ffd495 [VarDumper] Fix serialization of stubs with null or uninitialized values
diff --git a/src/Symfony/Component/VarDumper/Cloner/Internal/NoDefault.php b/src/Symfony/Component/VarDumper/Cloner/Internal/NoDefault.php
@@ -0,0 +1,25 @@
+<?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\VarDumper\Cloner\Internal;
+
+/**
+ * Flags a typed property that has no default value.
+ *
+ * This dummy object is used to distinguish a property with a default value of null
+ * from a property that is uninitialized by default.
+ *
+ * @internal
+ */
+enum NoDefault
+{
+    case NoDefault;
+}
diff --git a/src/Symfony/Component/VarDumper/Cloner/Stub.php b/src/Symfony/Component/VarDumper/Cloner/Stub.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\VarDumper\Cloner;
 
+use Symfony\Component\VarDumper\Cloner\Internal\NoDefault;
+
 /**
  * Represents the main properties of a PHP variable.
  *
@@ -50,15 +52,20 @@ public function __sleep(): array
         $properties = [];
 
         if (!isset(self::$defaultProperties[$c = static::class])) {
-            self::$defaultProperties[$c] = get_class_vars($c);
+            $reflection = new \ReflectionClass($c);
+            self::$defaultProperties[$c] = [];
+
+            foreach ($reflection->getProperties() as $p) {
+                if ($p->isStatic()) {
+                    continue;
+                }
 
-            foreach ((new \ReflectionClass($c))->getStaticProperties() as $k => $v) {
-                unset(self::$defaultProperties[$c][$k]);
+                self::$defaultProperties[$c][$p->name] = $p->hasDefaultValue() ? $p->getDefaultValue() : ($p->hasType() ? NoDefault::NoDefault : null);
             }
         }
 
         foreach (self::$defaultProperties[$c] as $k => $v) {
-            if ($this->$k !== $v) {
+            if (NoDefault::NoDefault === $v || $this->$k !== $v) {
                 $properties[] = $k;
             }
         }
diff --git a/src/Symfony/Component/VarDumper/Tests/Cloner/StubTest.php b/src/Symfony/Component/VarDumper/Tests/Cloner/StubTest.php
@@ -0,0 +1,53 @@
+<?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\VarDumper\Tests\Cloner;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\VarDumper\Cloner\Stub;
+
+final class StubTest extends TestCase
+{
+    public function testUnserializeNullValue()
+    {
+        $stub = new Stub();
+        $stub->value = null;
+
+        $stub = unserialize(serialize($stub));
+
+        self::assertNull($stub->value);
+    }
+
+    public function testUnserializeNullInTypedProperty()
+    {
+        $stub = new MyStub();
+        $stub->myProp = null;
+
+        $stub = unserialize(serialize($stub));
+
+        self::assertNull($stub->myProp);
+    }
+
+    public function testUninitializedStubPropertiesAreLeftUninitialized()
+    {
+        $stub = new MyStub();
+
+        $stub = unserialize(serialize($stub));
+
+        $r = new \ReflectionProperty(MyStub::class, 'myProp');
+        self::assertFalse($r->isInitialized($stub));
+    }
+}
+
+final class MyStub extends Stub
+{
+    public mixed $myProp;
+}

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\VarDumper\Cloner;`
`13`	`13`
	`14`	`+use Symfony\Component\VarDumper\Cloner\Internal\NoDefault;`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* Represents the main properties of a PHP variable.`
`16`	`18`	`*`
`@@ -50,15 +52,20 @@ public function __sleep(): array`
`50`	`52`	`$properties = [];`
`51`	`53`
`52`	`54`	`if (!isset(self::$defaultProperties[$c = static::class])) {`
`53`		`- self::$defaultProperties[$c] = get_class_vars($c);`
	`55`	`+ $reflection = new \ReflectionClass($c);`
	`56`	`+ self::$defaultProperties[$c] = [];`
	`57`	`+`
	`58`	`+ foreach ($reflection->getProperties() as $p) {`
	`59`	`+ if ($p->isStatic()) {`
	`60`	`+ continue;`
	`61`	`+ }`
`54`	`62`
`55`		`- foreach ((new \ReflectionClass($c))->getStaticProperties() as $k => $v) {`
`56`		`- unset(self::$defaultProperties[$c][$k]);`
	`63`	`+ self::$defaultProperties[$c][$p->name] = $p->hasDefaultValue() ? $p->getDefaultValue() : ($p->hasType() ? NoDefault::NoDefault : null);`
`57`	`64`	`}`
`58`	`65`	`}`
`59`	`66`
`60`	`67`	`foreach (self::$defaultProperties[$c] as $k => $v) {`
`61`		`- if ($this->$k !== $v) {`
	`68`	`+ if (NoDefault::NoDefault === $v \|\| $this->$k !== $v) {`
`62`	`69`	`$properties[] = $k;`
`63`	`70`	`}`
`64`	`71`	`}`