[VarExporter] generate __doUnserialize() method in ProxyHelper::generateLazyProxy()

nikophil · nikophil · commit 37e6102b16b5 · 2024-06-20T11:03:34.000+02:00
diff --git a/src/Symfony/Component/VarExporter/ProxyHelper.php b/src/Symfony/Component/VarExporter/ProxyHelper.php
@@ -200,10 +200,17 @@ public static function generateLazyProxy(?\ReflectionClass $class, array $interf
         return <<<EOPHP
             {$parent} implements \\{$interfaces}
             {
-                use \Symfony\Component\VarExporter\LazyProxyTrait;
+                use \Symfony\Component\VarExporter\LazyProxyTrait {
+                    __unserialize as __doUnserialize;
+                }
 
                 private const LAZY_OBJECT_PROPERTY_SCOPES = {$propertyScopes};
-            {$body}}
+            {$body}
+                public function __unserialize(\$data): void
+                { 
+                    \$this->__doUnserialize(\$data);
+                }
+            }
 
             // Help opcache.preload discover always-needed symbols
             class_exists(\Symfony\Component\VarExporter\Internal\Hydrator::class);
diff --git a/src/Symfony/Component/VarExporter/Tests/LazyProxyTraitTest.php b/src/Symfony/Component/VarExporter/Tests/LazyProxyTraitTest.php
@@ -298,6 +298,30 @@ public function testNormalization()
         $this->assertSame(['property' => 'property', 'method' => 'method'], $output);
     }
 
+    /**
+     * @dataProvider classWithUnserializeMagicMethodProvider
+     */
+    public function testItCanProxifyClassWithUnserializeMagicMethod(object $obj)
+    {
+        $proxy = $this->createLazyProxy($obj::class, fn () => $obj);
+        self::assertIsObject($proxy);
+    }
+
+    public static function classWithUnserializeMagicMethodProvider(): iterable
+    {
+        yield 'not type hinted __unserialize method' => [new class() {
+            public function __unserialize($array)
+            {
+            }
+        }];
+
+        yield 'type hinted __unserialize method' => [new class() {
+            public function __unserialize(array $array)
+            {
+            }
+        }];
+    }
+
     /**
      * @template T
      *
diff --git a/src/Symfony/Component/VarExporter/Tests/ProxyHelperTest.php b/src/Symfony/Component/VarExporter/Tests/ProxyHelperTest.php
@@ -66,7 +66,9 @@ public function testGenerateLazyProxy()
         $expected = <<<'EOPHP'
          extends \Symfony\Component\VarExporter\Tests\TestForProxyHelper implements \Symfony\Component\VarExporter\LazyObjectInterface
         {
-            use \Symfony\Component\VarExporter\LazyProxyTrait;
+            use \Symfony\Component\VarExporter\LazyProxyTrait {
+                __unserialize as __doUnserialize;
+            }
 
             private const LAZY_OBJECT_PROPERTY_SCOPES = [];
 
@@ -96,6 +98,11 @@ protected function foo7()
 
                 return throw new \BadMethodCallException('Cannot forward abstract method "Symfony\Component\VarExporter\Tests\TestForProxyHelper::foo7()".');
             }
+
+            public function __unserialize($data): void
+            { 
+                $this->__doUnserialize($data);
+            }
         }
 
         // Help opcache.preload discover always-needed symbols
@@ -113,7 +120,9 @@ public function testGenerateLazyProxyForInterfaces()
         $expected = <<<'EOPHP'
          implements \Symfony\Component\VarExporter\Tests\TestForProxyHelperInterface1, \Symfony\Component\VarExporter\Tests\TestForProxyHelperInterface2, \Symfony\Component\VarExporter\LazyObjectInterface
         {
-            use \Symfony\Component\VarExporter\LazyProxyTrait;
+            use \Symfony\Component\VarExporter\LazyProxyTrait {
+                __unserialize as __doUnserialize;
+            }
 
             private const LAZY_OBJECT_PROPERTY_SCOPES = [];
 
@@ -148,6 +157,11 @@ public static function foo3(): string
             {
                 throw new \BadMethodCallException('Cannot forward abstract method "Symfony\Component\VarExporter\Tests\TestForProxyHelperInterface2::foo3()".');
             }
+
+            public function __unserialize($data): void
+            { 
+                $this->__doUnserialize($data);
+            }
         }
 
         // Help opcache.preload discover always-needed symbols
@@ -172,7 +186,6 @@ public function foo(#[\SensitiveParameter] $a): int
 
                 return parent::foo(...\func_get_args());
             }
-        }
 
         EOPHP;
 
@@ -182,6 +195,7 @@ public function foo(#[\SensitiveParameter, AnotherAttribute] $a): int
             {
             }
         });
+
         $this->assertStringContainsString($expected, ProxyHelper::generateLazyProxy($class));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,9 @@ public function testGenerateLazyProxy()`
`66`	`66`	`$expected = <<<'EOPHP'`
`67`	`67`	`extends \Symfony\Component\VarExporter\Tests\TestForProxyHelper implements \Symfony\Component\VarExporter\LazyObjectInterface`
`68`	`68`	`{`
`69`		`- use \Symfony\Component\VarExporter\LazyProxyTrait;`
	`69`	`+ use \Symfony\Component\VarExporter\LazyProxyTrait {`
	`70`	`+ __unserialize as __doUnserialize;`
	`71`	`+ }`
`70`	`72`
`71`	`73`	`private const LAZY_OBJECT_PROPERTY_SCOPES = [];`
`72`	`74`
`@@ -96,6 +98,11 @@ protected function foo7()`
`96`	`98`
`97`	`99`	`return throw new \BadMethodCallException('Cannot forward abstract method "Symfony\Component\VarExporter\Tests\TestForProxyHelper::foo7()".');`
`98`	`100`	`}`
	`101`	`+`
	`102`	`+ public function __unserialize($data): void`
	`103`	`+ {`
	`104`	`+ $this->__doUnserialize($data);`
	`105`	`+ }`
`99`	`106`	`}`
`100`	`107`
`101`	`108`	`// Help opcache.preload discover always-needed symbols`
`@@ -113,7 +120,9 @@ public function testGenerateLazyProxyForInterfaces()`
`113`	`120`	`$expected = <<<'EOPHP'`
`114`	`121`	`implements \Symfony\Component\VarExporter\Tests\TestForProxyHelperInterface1, \Symfony\Component\VarExporter\Tests\TestForProxyHelperInterface2, \Symfony\Component\VarExporter\LazyObjectInterface`
`115`	`122`	`{`
`116`		`- use \Symfony\Component\VarExporter\LazyProxyTrait;`
	`123`	`+ use \Symfony\Component\VarExporter\LazyProxyTrait {`
	`124`	`+ __unserialize as __doUnserialize;`
	`125`	`+ }`
`117`	`126`
`118`	`127`	`private const LAZY_OBJECT_PROPERTY_SCOPES = [];`
`119`	`128`
`@@ -148,6 +157,11 @@ public static function foo3(): string`
`148`	`157`	`{`
`149`	`158`	`throw new \BadMethodCallException('Cannot forward abstract method "Symfony\Component\VarExporter\Tests\TestForProxyHelperInterface2::foo3()".');`
`150`	`159`	`}`
	`160`	`+`
	`161`	`+ public function __unserialize($data): void`
	`162`	`+ {`
	`163`	`+ $this->__doUnserialize($data);`
	`164`	`+ }`
`151`	`165`	`}`
`152`	`166`
`153`	`167`	`// Help opcache.preload discover always-needed symbols`
`@@ -172,7 +186,6 @@ public function foo(#[\SensitiveParameter] $a): int`
`172`	`186`
`173`	`187`	`return parent::foo(...\func_get_args());`
`174`	`188`	`}`
`175`		`- }`
`176`	`189`
`177`	`190`	`EOPHP;`
`178`	`191`
`@@ -182,6 +195,7 @@ public function foo(#[\SensitiveParameter, AnotherAttribute] $a): int`
`182`	`195`	`{`
`183`	`196`	`}`
`184`	`197`	`});`
	`198`	`+`
`185`	`199`	`$this->assertStringContainsString($expected, ProxyHelper::generateLazyProxy($class));`
`186`	`200`	`}`
`187`	`201`