[VarExporter] fix proxy helper when a method returns null

nikophil · nikophil · commit 23c16c656314 · 2024-05-07T10:05:15.000+02:00
diff --git a/src/Symfony/Component/VarDumper/Caster/ReflectionCaster.php b/src/Symfony/Component/VarDumper/Caster/ReflectionCaster.php
@@ -231,7 +231,7 @@ public static function castFunctionAbstract(\ReflectionFunctionAbstract $c, arra
         if (isset($a[$prefix.'returnType'])) {
             $v = $a[$prefix.'returnType'];
             $v = $v instanceof \ReflectionNamedType ? $v->getName() : (string) $v;
-            $a[$prefix.'returnType'] = new ClassStub($a[$prefix.'returnType'] instanceof \ReflectionNamedType && $a[$prefix.'returnType']->allowsNull() && 'mixed' !== $v ? '?'.$v : $v, [class_exists($v, false) || interface_exists($v, false) || trait_exists($v, false) ? $v : '', '']);
+            $a[$prefix.'returnType'] = new ClassStub($a[$prefix.'returnType'] instanceof \ReflectionNamedType && $a[$prefix.'returnType']->allowsNull() && !\in_array($v, ['mixed', 'null'], true) ? '?'.$v : $v, [class_exists($v, false) || interface_exists($v, false) || trait_exists($v, false) ? $v : '', '']);
         }
         if (isset($a[$prefix.'class'])) {
             $a[$prefix.'class'] = new ClassStub($a[$prefix.'class']);
@@ -413,7 +413,7 @@ public static function getSignature(array $a)
                     if (!$type instanceof \ReflectionNamedType) {
                         $signature .= $type.' ';
                     } else {
-                        if ($param->allowsNull() && 'mixed' !== $type->getName()) {
+                        if ($param->allowsNull() && !\in_array($type->getName(), ['mixed', 'null'], true)) {
                             $signature .= '?';
                         }
                         $signature .= substr(strrchr('\\'.$type->getName(), '\\'), 1).' ';
diff --git a/src/Symfony/Component/VarDumper/Tests/Caster/ReflectionCasterTest.php b/src/Symfony/Component/VarDumper/Tests/Caster/ReflectionCasterTest.php
@@ -18,6 +18,7 @@
 use Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo;
 use Symfony\Component\VarDumper\Tests\Fixtures\LotsOfAttributes;
 use Symfony\Component\VarDumper\Tests\Fixtures\NotLoadableClass;
+use Symfony\Component\VarDumper\Tests\Fixtures\Php82NullStandaloneReturnType;
 use Symfony\Component\VarDumper\Tests\Fixtures\ReflectionIntersectionTypeFixture;
 use Symfony\Component\VarDumper\Tests\Fixtures\ReflectionNamedTypeFixture;
 use Symfony\Component\VarDumper\Tests\Fixtures\ReflectionUnionTypeFixture;
@@ -95,7 +96,7 @@ public function testClosureCaster()
     $b: & 123
   }
   file: "%sReflectionCasterTest.php"
-  line: "88 to 88"
+  line: "%s"
 }
 EOTXT
             , $var
@@ -406,6 +407,26 @@ class: "Symfony\Component\VarDumper\Tests\Caster\ReflectionCasterTest"
         );
     }
 
+    /**
+     * @requires PHP 8.2
+     */
+    public function testNullReturnType()
+    {
+        $className = Php82NullStandaloneReturnType::class;
+
+        $this->assertDumpMatchesFormat(
+            <<<EOTXT
+{$className}::foo(null \$bar): null {
+  returnType: "null"
+  this: {$className} { …}
+  file: "%s"
+  line: "%s"
+}
+EOTXT
+            , (new Php82NullStandaloneReturnType())->foo(...)
+        );
+    }
+
     public function testUnionReturnType()
     {
         $f = function (): int|float {};
diff --git a/src/Symfony/Component/VarDumper/Tests/Fixtures/Php82NullStandaloneReturnType.php b/src/Symfony/Component/VarDumper/Tests/Fixtures/Php82NullStandaloneReturnType.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Component\VarDumper\Tests\Fixtures;
+
+class Php82NullStandaloneReturnType
+{
+    public function foo(null $bar): null
+    {
+        return null;
+    }
+}
diff --git a/src/Symfony/Component/VarExporter/ProxyHelper.php b/src/Symfony/Component/VarExporter/ProxyHelper.php
@@ -311,7 +311,7 @@ public static function exportType(\ReflectionFunctionAbstract|\ReflectionPropert
             return '';
         }
         if (null === $glue) {
-            return (!$noBuiltin && $type->allowsNull() && 'mixed' !== $name ? '?' : '').$types[0];
+            return (!$noBuiltin && $type->allowsNull() && !\in_array($name, ['mixed', 'null'], true) ? '?' : '').$types[0];
         }
         sort($types);
 
diff --git a/src/Symfony/Component/VarExporter/Tests/Fixtures/LazyProxy/Php82NullStandaloneReturnType.php b/src/Symfony/Component/VarExporter/Tests/Fixtures/LazyProxy/Php82NullStandaloneReturnType.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Component\VarExporter\Tests\Fixtures\LazyProxy;
+
+class Php82NullStandaloneReturnType
+{
+    public function foo(): null
+    {
+        return null;
+    }
+}
diff --git a/src/Symfony/Component/VarExporter/Tests/ProxyHelperTest.php b/src/Symfony/Component/VarExporter/Tests/ProxyHelperTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\VarExporter\Exception\LogicException;
 use Symfony\Component\VarExporter\ProxyHelper;
+use Symfony\Component\VarExporter\Tests\Fixtures\LazyProxy\Php82NullStandaloneReturnType;
 use Symfony\Component\VarExporter\Tests\Fixtures\LazyProxy\StringMagicGetClass;
 
 class ProxyHelperTest extends TestCase
@@ -188,6 +189,17 @@ public function testCannotGenerateGhostForStringMagicGet()
         $this->expectException(LogicException::class);
         ProxyHelper::generateLazyGhost(new \ReflectionClass(StringMagicGetClass::class));
     }
+
+    /**
+     * @requires PHP 8.2
+     */
+    public function testNullStandaloneReturnType()
+    {
+        self::assertStringContainsString(
+            'public function foo(): null',
+            ProxyHelper::generateLazyProxy(new \ReflectionClass(Php82NullStandaloneReturnType::class))
+        );
+    }
 }
 
 abstract class TestForProxyHelper

Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,7 @@ public static function exportType(\ReflectionFunctionAbstract\|\ReflectionPropert`
`311`	`311`	`return '';`
`312`	`312`	`}`
`313`	`313`	`if (null === $glue) {`
`314`		`- return (!$noBuiltin && $type->allowsNull() && 'mixed' !== $name ? '?' : '').$types[0];`
	`314`	`+ return (!$noBuiltin && $type->allowsNull() && !\in_array($name, ['mixed', 'null'], true) ? '?' : '').$types[0];`
`315`	`315`	`}`
`316`	`316`	`sort($types);`
`317`	`317`