Request the current ExprAnalysisResultStorage in generators

ondrejmirtes · ondrejmirtes · commit 65fc46052d75 · 2025-11-24T14:05:00.000+01:00
diff --git a/build/PHPStan/Build/GeneratorYieldSendTypeExtension.php b/build/PHPStan/Build/GeneratorYieldSendTypeExtension.php
@@ -7,6 +7,7 @@
 use PHPStan\Analyser\Generator\ExprAnalysisRequest;
 use PHPStan\Analyser\Generator\ExprAnalysisResult;
 use PHPStan\Analyser\Generator\ExprAnalysisResultStorage;
+use PHPStan\Analyser\Generator\GetExprAnalysisResultStorageRequest;
 use PHPStan\Analyser\Generator\NodeCallbackRequest;
 use PHPStan\Analyser\Generator\PersistStorageRequest;
 use PHPStan\Analyser\Generator\RestoreStorageRequest;
@@ -15,6 +16,7 @@
 use PHPStan\Analyser\Generator\StmtAnalysisRequest;
 use PHPStan\Analyser\Generator\StmtAnalysisResult;
 use PHPStan\Analyser\Generator\StmtsAnalysisRequest;
+use PHPStan\Analyser\Generator\StoreExprResultRequest;
 use PHPStan\Analyser\Generator\TypeExprRequest;
 use PHPStan\Analyser\Generator\TypeExprResult;
 use PHPStan\Analyser\Scope;
@@ -66,6 +68,12 @@ public function getType(Expr $expr, Scope $scope): ?Type
 		if ((new ObjectType(PersistStorageRequest::class))->isSuperTypeOf($valueType)->yes()) {
 			return new ObjectType(ExprAnalysisResultStorage::class);
 		}
+		if ((new ObjectType(GetExprAnalysisResultStorageRequest::class))->isSuperTypeOf($valueType)->yes()) {
+			return new ObjectType(ExprAnalysisResultStorage::class);
+		}
+		if ((new ObjectType(StoreExprResultRequest::class))->isSuperTypeOf($valueType)->yes()) {
+			return new NullType();
+		}
 		if ((new ObjectType(RestoreStorageRequest::class))->isSuperTypeOf($valueType)->yes()) {
 			return new NullType();
 		}
diff --git a/src/Analyser/Generator/GeneratorNodeScopeResolver.php b/src/Analyser/Generator/GeneratorNodeScopeResolver.php
@@ -75,7 +75,7 @@
  *   a hypothetical method call) are analyzed on-demand when requested, with the Fiber
  *   suspending until analysis completes
  *
- * @phpstan-type GeneratorTValueType = ExprAnalysisRequest|StmtAnalysisRequest|StmtsAnalysisRequest|NodeCallbackRequest|AttrGroupsAnalysisRequest|TypeExprRequest|PersistStorageRequest|RestoreStorageRequest|RunInFiberRequest<mixed>
+ * @phpstan-type GeneratorTValueType = ExprAnalysisRequest|StmtAnalysisRequest|StmtsAnalysisRequest|NodeCallbackRequest|AttrGroupsAnalysisRequest|TypeExprRequest|PersistStorageRequest|RestoreStorageRequest|RunInFiberRequest<mixed>|GetExprAnalysisResultStorageRequest|StoreExprResultRequest
  * @phpstan-type GeneratorTSendType = ExprAnalysisResult|StmtAnalysisResult|TypeExprResult|ExprAnalysisResultStorage|RunInFiberResult<mixed>|null
  */
 #[AutowiredService]
@@ -178,7 +178,7 @@ private function runTrampoline(
 	): void
 	{
 		while (true) {
-			$pendingFibersGen = $this->processPendingFibers($fibersStorage, $exprAnalysisResultStorage);
+			$pendingFibersGen = $this->processPendingFibers($exprAnalysisResultStorage, $fibersStorage);
 			if ($pendingFibersGen->valid()) {
 				$stack[] = $gen;
 				$gen = new IdentifiedGeneratorInStack($pendingFibersGen, new Stmt\Expression(new Node\Scalar\String_('pendingFibers')), null, null);
@@ -193,7 +193,6 @@ private function runTrampoline(
 					$gen = new IdentifiedGeneratorInStack(
 						$this->invokeNodeCallback(
 							$fibersStorage,
-							$exprAnalysisResultStorage,
 							$yielded->node,
 							$yielded->scope,
 							$alternativeNodeCallback !== null
@@ -211,7 +210,7 @@ private function runTrampoline(
 				} elseif ($yielded instanceof ExprAnalysisRequest) {
 					$stack[] = $gen;
 					$gen = new IdentifiedGeneratorInStack(
-						$this->analyseExpr($fibersStorage, $exprAnalysisResultStorage, $yielded->stmt, $yielded->expr, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback, $stack, $yielded->originFile, $yielded->originLine),
+						$this->analyseExpr($fibersStorage, $yielded->stmt, $yielded->expr, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback, $stack, $yielded->originFile, $yielded->originLine),
 						$yielded->expr,
 						$yielded->originFile,
 						$yielded->originLine,
@@ -275,6 +274,19 @@ private function runTrampoline(
 					);
 					$gen->generator->current();
 					continue;
+				} elseif ($yielded instanceof GetExprAnalysisResultStorageRequest) {
+					$gen->generator->send($exprAnalysisResultStorage);
+					continue;
+				} elseif ($yielded instanceof StoreExprResultRequest) {
+					$exprAnalysisResultStorage->storeExprAnalysisResult(
+						$yielded->expr,
+						$yielded->result,
+						$yielded->stack,
+						$yielded->file,
+						$yielded->line,
+					);
+					$gen->generator->next();
+					continue;
 				} else { // phpcs:ignore
 					throw new NeverException($yielded);
 				}
@@ -292,7 +304,7 @@ private function runTrampoline(
 
 					$stack[] = $gen;
 					$gen = new IdentifiedGeneratorInStack(
-						$this->analyseExpr(null, $exprAnalysisResultStorage, $request->stmt, $request->expr, $request->scope, $request->context, $request->alternativeNodeCallback, $stack, $request->originFile, $request->originLine),
+						$this->analyseExpr(null, $request->stmt, $request->expr, $request->scope, $request->context, $request->alternativeNodeCallback, $stack, $request->originFile, $request->originLine),
 						$request->expr,
 						$request->originFile,
 						$request->originLine,
@@ -450,8 +462,9 @@ private function runInFiber(callable $callback): Generator
 	 * @param list<IdentifiedGeneratorInStack> $stack
 	 * @return Generator<int, GeneratorTValueType, GeneratorTSendType, ExprAnalysisResult>
 	 */
-	private function analyseExpr(?PendingFibersStorage $fibersStorage, ExprAnalysisResultStorage $storage, Stmt $stmt, Expr $expr, GeneratorScope $scope, ExpressionContext $context, ?callable $alternativeNodeCallback, array $stack, ?string $file, ?int $line): Generator
+	private function analyseExpr(?PendingFibersStorage $fibersStorage, Stmt $stmt, Expr $expr, GeneratorScope $scope, ExpressionContext $context, ?callable $alternativeNodeCallback, array $stack, ?string $file, ?int $line): Generator
 	{
+		$storage = yield new GetExprAnalysisResultStorageRequest();
 		$foundExprAnalysisResult = $storage->findExprAnalysisResult($expr);
 		if ($foundExprAnalysisResult !== null) {
 			if ($alternativeNodeCallback instanceof NoopNodeCallback) {
@@ -488,7 +501,7 @@ private function analyseExpr(?PendingFibersStorage $fibersStorage, ExprAnalysisR
 				throw new ShouldNotHappenException();
 			}
 
-			$exprGen = $this->analyseExpr($fibersStorage, $storage, $stmt, $newExpr, $scope, $context, $alternativeNodeCallback, $stack, $file, $line);
+			$exprGen = $this->analyseExpr($fibersStorage, $stmt, $newExpr, $scope, $context, $alternativeNodeCallback, $stack, $file, $line);
 			yield from $exprGen;
 
 			return $exprGen->getReturn();
@@ -508,10 +521,10 @@ private function analyseExpr(?PendingFibersStorage $fibersStorage, ExprAnalysisR
 			yield from $gen;
 
 			$exprAnalysisResult = $gen->getReturn();
-			$storage->storeExprAnalysisResult($expr, $exprAnalysisResult, $stack, $file, $line);
+			yield new StoreExprResultRequest($expr, $exprAnalysisResult, $stack, $file, $line);
 
 			if ($fibersStorage !== null) {
-				yield from $this->processPendingFibersForRequestedExpr($fibersStorage, $storage, $expr, $exprAnalysisResult);
+				yield from $this->processPendingFibersForRequestedExpr($fibersStorage, $expr, $exprAnalysisResult);
 			}
 
 			return $exprAnalysisResult;
@@ -540,7 +553,6 @@ private function analyseExprForType(ExprAnalysisResultStorage $storage, Expr $ex
 	 */
 	private function invokeNodeCallback(
 		PendingFibersStorage $fibersStorage,
-		ExprAnalysisResultStorage $exprAnalysisResultStorage,
 		Node $node,
 		Scope $scope,
 		callable $nodeCallback,
@@ -550,7 +562,7 @@ private function invokeNodeCallback(
 			$nodeCallback($node, $scope);
 		});
 		$request = $fiber->start();
-		yield from $this->runFiberForNodeCallback($fibersStorage, $exprAnalysisResultStorage, $fiber, $request);
+		yield from $this->runFiberForNodeCallback($fibersStorage, $fiber, $request);
 
 		return null;
 	}
@@ -561,13 +573,13 @@ private function invokeNodeCallback(
 	 */
 	private function runFiberForNodeCallback(
 		PendingFibersStorage $fibersStorage,
-		ExprAnalysisResultStorage $exprAnalysisResultStorage,
 		Fiber $fiber,
 		ExprAnalysisRequest|NodeCallbackRequest|null $request,
 	): Generator
 	{
 		while (!$fiber->isTerminated()) {
 			if ($request instanceof ExprAnalysisRequest) {
+				$exprAnalysisResultStorage = yield new GetExprAnalysisResultStorageRequest();
 				$result = $exprAnalysisResultStorage->findExprAnalysisResult($request->expr);
 
 				if ($result !== null) {
@@ -603,7 +615,7 @@ private function runFiberForNodeCallback(
 	/**
 	 * @return Generator<int, GeneratorTValueType, GeneratorTSendType, void>
 	 */
-	private function processPendingFibers(PendingFibersStorage $fibersStorage, ExprAnalysisResultStorage $exprAnalysisResultStorage): Generator
+	private function processPendingFibers(ExprAnalysisResultStorage $exprAnalysisResultStorage, PendingFibersStorage $fibersStorage): Generator
 	{
 		$restartLoop = true;
 
@@ -623,7 +635,7 @@ private function processPendingFibers(PendingFibersStorage $fibersStorage, ExprA
 
 				$fiber = $pending['fiber'];
 				$request = $fiber->resume($exprAnalysisResult);
-				yield from $this->runFiberForNodeCallback($fibersStorage, $exprAnalysisResultStorage, $fiber, $request);
+				yield from $this->runFiberForNodeCallback($fibersStorage, $fiber, $request);
 
 				// Break and restart the loop since the array may have been modified
 				break;
@@ -634,7 +646,7 @@ private function processPendingFibers(PendingFibersStorage $fibersStorage, ExprA
 	/**
 	 * @return Generator<int, GeneratorTValueType, GeneratorTSendType, void>
 	 */
-	private function processPendingFibersForRequestedExpr(PendingFibersStorage $fibersStorage, ExprAnalysisResultStorage $exprAnalysisResultStorage, Expr $expr, ExprAnalysisResult $result): Generator
+	private function processPendingFibersForRequestedExpr(PendingFibersStorage $fibersStorage, Expr $expr, ExprAnalysisResult $result): Generator
 	{
 		$restartLoop = true;
 
@@ -652,7 +664,7 @@ private function processPendingFibersForRequestedExpr(PendingFibersStorage $fibe
 
 				$fiber = $pending['fiber'];
 				$request = $fiber->resume($result);
-				yield from $this->runFiberForNodeCallback($fibersStorage, $exprAnalysisResultStorage, $fiber, $request);
+				yield from $this->runFiberForNodeCallback($fibersStorage, $fiber, $request);
 
 				// Break and restart the loop since the array may have been modified
 				break;
diff --git a/src/Analyser/Generator/GetExprAnalysisResultStorageRequest.php b/src/Analyser/Generator/GetExprAnalysisResultStorageRequest.php
@@ -0,0 +1,8 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\Generator;
+
+final class GetExprAnalysisResultStorageRequest
+{
+
+}
diff --git a/src/Analyser/Generator/StoreExprResultRequest.php b/src/Analyser/Generator/StoreExprResultRequest.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\Generator;
+
+use PhpParser\Node\Expr;
+
+final class StoreExprResultRequest
+{
+
+	/**
+	 * @param list<IdentifiedGeneratorInStack> $stack
+	 */
+	public function __construct(
+		public readonly Expr $expr,
+		public readonly ExprAnalysisResult $result,
+		public readonly array $stack,
+		public readonly ?string $file,
+		public readonly ?int $line,
+	)
+	{
+	}
+
+}
diff --git a/tests/PHPStan/Analyser/Generator/GeneratorNodeScopeResolverRuleTest.php b/tests/PHPStan/Analyser/Generator/GeneratorNodeScopeResolverRuleTest.php
@@ -160,7 +160,6 @@ static function (Node $node, Scope $scope) {
 			[
 				['exit through', 666],
 				['Called on GeneratorNodeScopeResolverRule\\Foo, arg: 1', 21],
-				['exit through', 666],
 				['Virtual node invoked: \'foo\', 3', 23],
 				['Called on GeneratorNodeScopeResolverRule\\Foo, arg: \'foo\'', 23],
 			],
diff --git a/tests/PHPStan/Analyser/nsrt/gnsr-yield-in-generator-ns.php b/tests/PHPStan/Analyser/nsrt/gnsr-yield-in-generator-ns.php
@@ -21,6 +21,8 @@ public function doFoo(): Generator
 		assertType('null', yield new AttrGroupsAnalysisRequest());
 		assertType(ExprAnalysisResultStorage::class, yield new PersistStorageRequest());
 		assertType('null', yield new RestoreStorageRequest());
+		assertType('null', yield new StoreExprResultRequest());
+		assertType(ExprAnalysisResultStorage::class, yield new GetExprAnalysisResultStorageRequest());
 		assertType(RunInFiberResult::class . '<1>', yield new RunInFiberRequest(fn () => 1));
 
 		$a = 's';

Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,6 @@ static function (Node $node, Scope $scope) {`
`160`	`160`	`[`
`161`	`161`	`['exit through', 666],`
`162`	`162`	`['Called on GeneratorNodeScopeResolverRule\\Foo, arg: 1', 21],`
`163`		`- ['exit through', 666],`
`164`	`163`	`['Virtual node invoked: \'foo\', 3', 23],`
`165`	`164`	`['Called on GeneratorNodeScopeResolverRule\\Foo, arg: \'foo\'', 23],`
`166`	`165`	`],`