[VarDumper] Fix generator dump on PHP 8.4

alexandre-daubois · alexandre-daubois · commit fc0dc0e2982b · 2024-05-27T15:21:28.000+02:00
diff --git a/src/Symfony/Component/VarDumper/Caster/ReflectionCaster.php b/src/Symfony/Component/VarDumper/Caster/ReflectionCaster.php
@@ -83,13 +83,13 @@ public static function castGenerator(\Generator $c, array $a, Stub $stub, bool $
         // Cannot create ReflectionGenerator based on a terminated Generator
         try {
             $reflectionGenerator = new \ReflectionGenerator($c);
+
+            return self::castReflectionGenerator($reflectionGenerator, $a, $stub, $isNested);
         } catch (\Exception $e) {
             $a[Caster::PREFIX_VIRTUAL.'closed'] = true;
 
             return $a;
         }
-
-        return self::castReflectionGenerator($reflectionGenerator, $a, $stub, $isNested);
     }
 
     public static function castType(\ReflectionType $c, array $a, Stub $stub, bool $isNested)
diff --git a/src/Symfony/Component/VarDumper/Tests/Caster/ReflectionCasterTest.php b/src/Symfony/Component/VarDumper/Tests/Caster/ReflectionCasterTest.php
@@ -500,6 +500,84 @@ class: "Symfony\Component\VarDumper\Tests\Caster\ReflectionCasterTest"
         );
     }
 
+    /**
+     * @requires PHP < 8.4
+     */
+    public function testGeneratorPriorTo84()
+    {
+        if (\extension_loaded('xdebug')) {
+            $this->markTestSkipped('xdebug is active');
+        }
+
+        $generator = new GeneratorDemo();
+        $generator = $generator->baz();
+
+        $expectedDump = <<<'EODUMP'
+Generator {
+  this: Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo { …}
+  %s: {
+    %sGeneratorDemo.php:14 {
+      Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo->baz()
+      › {
+      ›     yield from bar();
+      › }
+    }
+%A}
+  closed: false
+}
+EODUMP;
+
+        $this->assertDumpMatchesFormat($expectedDump, $generator);
+
+        foreach ($generator as $v) {
+            break;
+        }
+
+        $expectedDump = <<<'EODUMP'
+array:2 [
+  0 => ReflectionGenerator {
+    this: Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo { …}
+    %s: {
+      %s%eTests%eFixtures%eGeneratorDemo.php:%d {
+        Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo::foo()
+%A      ›     yield 1;
+%A    }
+      %s%eTests%eFixtures%eGeneratorDemo.php:20 { …}
+      %s%eTests%eFixtures%eGeneratorDemo.php:14 { …}
+%A  }
+    closed: false
+  }
+  1 => Generator {
+    %s: {
+      %s%eTests%eFixtures%eGeneratorDemo.php:%d {
+        Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo::foo()
+        ›     yield 1;
+        › }
+        › 
+      }
+%A  }
+    closed: false
+  }
+]
+EODUMP;
+
+        $r = new \ReflectionGenerator($generator);
+        $this->assertDumpMatchesFormat($expectedDump, [$r, $r->getExecutingGenerator()]);
+
+        foreach ($generator as $v) {
+        }
+
+        $expectedDump = <<<'EODUMP'
+Generator {
+  closed: true
+}
+EODUMP;
+        $this->assertDumpMatchesFormat($expectedDump, $generator);
+    }
+
+    /**
+     * @requires PHP 8.4
+     */
     public function testGenerator()
     {
         if (\extension_loaded('xdebug')) {
@@ -511,6 +589,7 @@ public function testGenerator()
 
         $expectedDump = <<<'EODUMP'
 Generator {
+  function: "Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo::baz"
   this: Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo { …}
   %s: {
     %sGeneratorDemo.php:14 {
@@ -519,6 +598,7 @@ public function testGenerator()
       ›     yield from bar();
       › }
     }
+    Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo->baz() {}
 %A}
   closed: false
 }
@@ -545,6 +625,7 @@ public function testGenerator()
     closed: false
   }
   1 => Generator {
+    function: "Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo::foo"
     %s: {
       %s%eTests%eFixtures%eGeneratorDemo.php:%d {
         Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo::foo()
@@ -566,6 +647,7 @@ public function testGenerator()
 
         $expectedDump = <<<'EODUMP'
 Generator {
+  function: "Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo::baz"
   closed: true
 }
 EODUMP;

Original file line number	Diff line number	Diff line change
`@@ -83,13 +83,13 @@ public static function castGenerator(\Generator $c, array $a, Stub $stub, bool $`
`83`	`83`	`// Cannot create ReflectionGenerator based on a terminated Generator`
`84`	`84`	`try {`
`85`	`85`	`$reflectionGenerator = new \ReflectionGenerator($c);`
	`86`	`+`
	`87`	`+ return self::castReflectionGenerator($reflectionGenerator, $a, $stub, $isNested);`
`86`	`88`	`} catch (\Exception $e) {`
`87`	`89`	`$a[Caster::PREFIX_VIRTUAL.'closed'] = true;`
`88`	`90`
`89`	`91`	`return $a;`
`90`	`92`	`}`
`91`		`-`
`92`		`- return self::castReflectionGenerator($reflectionGenerator, $a, $stub, $isNested);`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`public static function castType(\ReflectionType $c, array $a, Stub $stub, bool $isNested)`