[VarExporter] generate __doUnserialize() method in ProxyHelper::gener…

…ateLazyProxy()
symfony · Jun 24, 2024 · f9a0606 · f9a0606
1 parent 792ca83
commit f9a0606
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 1 deletion.
diff --git a/ProxyHelper.php b/ProxyHelper.php
@@ -197,10 +197,35 @@ public static function generateLazyProxy(?\ReflectionClass $class, array $interf
         $body = $methods ? "\n".implode("\n\n", $methods)."\n" : '';
         $propertyScopes = $class ? self::exportPropertyScopes($class->name) : '[]';
 
+        if (
+            $class?->hasMethod('__unserialize')
+            && !$class->getMethod('__unserialize')->getParameters()[0]->getType()
+        ) {
+            // fix contravariance type problem when $class declares a `__unserialize()` method without typehint.
+            $lazyProxyTraitStatement = <<<EOPHP
+            use \Symfony\Component\VarExporter\LazyProxyTrait {
+                    __unserialize as private __doUnserialize;
+                }
+            EOPHP;
+
+            $body .= <<<EOPHP
+
+                    public function __unserialize(\$data): void
+                    {
+                        \$this->__doUnserialize(\$data);
+                    }
+
+                EOPHP;
+        } else {
+            $lazyProxyTraitStatement = <<<EOPHP
+            use \Symfony\Component\VarExporter\LazyProxyTrait;
+            EOPHP;
+        }
+
         return <<<EOPHP
             {$parent} implements \\{$interfaces}
             {
-                use \Symfony\Component\VarExporter\LazyProxyTrait;
+                {$lazyProxyTraitStatement}
 
                 private const LAZY_OBJECT_PROPERTY_SCOPES = {$propertyScopes};
             {$body}}

diff --git a/Tests/ProxyHelperTest.php b/Tests/ProxyHelperTest.php
@@ -160,6 +160,50 @@ class_exists(\Symfony\Component\VarExporter\Internal\LazyObjectState::class);
         $this->assertSame($expected, ProxyHelper::generateLazyProxy(null, [new \ReflectionClass(TestForProxyHelperInterface1::class), new \ReflectionClass(TestForProxyHelperInterface2::class)]));
     }
 
+    /**
+     * @dataProvider classWithUnserializeMagicMethodProvider
+     */
+    public function testGenerateLazyProxyForClassWithUnserializeMagicMethod(object $obj, string $expected)
+    {
+        $this->assertStringContainsString($expected, ProxyHelper::generateLazyProxy(new \ReflectionClass($obj::class)));
+    }
+
+    public static function classWithUnserializeMagicMethodProvider(): iterable
+    {
+        yield 'not type hinted __unserialize method' => [new class() {
+            public function __unserialize($array)
+            {
+            }
+        }, <<<'EOPHP'
+        implements \Symfony\Component\VarExporter\LazyObjectInterface
+        {
+            use \Symfony\Component\VarExporter\LazyProxyTrait {
+                __unserialize as private __doUnserialize;
+            }
+
+            private const LAZY_OBJECT_PROPERTY_SCOPES = [];
+
+            public function __unserialize($data): void
+            {
+                $this->__doUnserialize($data);
+            }
+        }
+        EOPHP];
+
+        yield 'type hinted __unserialize method' => [new class() {
+            public function __unserialize(array $array)
+            {
+            }
+        }, <<<'EOPHP'
+        implements \Symfony\Component\VarExporter\LazyObjectInterface
+        {
+            use \Symfony\Component\VarExporter\LazyProxyTrait;
+
+            private const LAZY_OBJECT_PROPERTY_SCOPES = [];
+        }
+        EOPHP];
+    }
+
     public function testAttributes()
     {
         $expected = <<<'EOPHP'
@@ -182,6 +226,7 @@ public function foo(#[\SensitiveParameter, AnotherAttribute] $a): int
             {
             }
         });
+
         $this->assertStringContainsString($expected, ProxyHelper::generateLazyProxy($class));
     }