Debug when expr was already analysed

Author: ondrejmirtes

src/Analyser/Generator/ExprAnalysisResultStorage.php

@@ -14,28 +14,45 @@ final class ExprAnalysisResultStorage
 	/** @var SplObjectStorage<Expr, ExprAnalysisResult> */
 	private SplObjectStorage $expressionAnalysisResults;
 
+	/** @var SplObjectStorage<Expr, array{list<IdentifiedGeneratorInStack>, ?string, ?int}> */
+	private SplObjectStorage $whereAnalysed;
+
 	public function __construct()
 	{
 		$this->expressionAnalysisResults = new SplObjectStorage();
+		$this->whereAnalysed = new SplObjectStorage();
 	}
 
 	public function duplicate(): self
 	{
 		$new = new self();
 		$new->expressionAnalysisResults->addAll($this->expressionAnalysisResults);
+		$new->whereAnalysed->addAll($this->whereAnalysed);
 		return $new;
 	}
 
-	public function storeExprAnalysisResult(Expr $expr, ExprAnalysisResult $result): void
+	/**
+	 * @param list<IdentifiedGeneratorInStack> $stack
+	 */
+	public function storeExprAnalysisResult(Expr $expr, ExprAnalysisResult $result, array $stack, ?string $file, ?int $line): void
 	{
 		$this->expressionAnalysisResults[$expr] = $result;
+		$this->whereAnalysed[$expr] = [$stack, $file, $line];
 	}
 
 	public function findExprAnalysisResult(Expr $expr): ?ExprAnalysisResult
 	{
 		return $this->expressionAnalysisResults[$expr] ?? null;
 	}
 
+	/**
+	 * @return array{list<IdentifiedGeneratorInStack>, ?string, ?int}|null
+	 */
+	public function findExprAnalysisResultOrigin(Expr $expr): ?array
+	{
+		return $this->whereAnalysed[$expr] ?? null;
+	}
+
 	public function getExprAnalysisResult(Expr $expr): ExprAnalysisResult
 	{
 		if (!isset($this->expressionAnalysisResults[$expr])) {

src/Analyser/Generator/GeneratorNodeScopeResolver.php

@@ -204,7 +204,7 @@ private function runTrampoline(
 				} elseif ($yielded instanceof ExprAnalysisRequest) {
 					$stack[] = $gen;
 					$gen = new IdentifiedGeneratorInStack(
-						$this->analyseExpr($exprAnalysisResultStorage, $yielded->stmt, $yielded->expr, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback),
+						$this->analyseExpr($exprAnalysisResultStorage, $yielded->stmt, $yielded->expr, $yielded->scope, $yielded->context, $yielded->alternativeNodeCallback, $stack, $yielded->originFile, $yielded->originLine),
 						$yielded->expr,
 						$yielded->originFile,
 						$yielded->originLine,
@@ -292,7 +292,7 @@ private function runTrampoline(
 
 					$stack[] = $gen;
 					$gen = new IdentifiedGeneratorInStack(
-						$this->analyseExpr($exprAnalysisResultStorage, $request->stmt, $request->expr, $request->scope, $request->context, $request->alternativeNodeCallback),
+						$this->analyseExpr($exprAnalysisResultStorage, $request->stmt, $request->expr, $request->scope, $request->context, $request->alternativeNodeCallback, $stack, $request->originFile, $request->originLine),
 						$request->expr,
 						$request->originFile,
 						$request->originLine,
@@ -418,17 +418,32 @@ private function runInFiber(callable $callback): Generator
 
 	/**
 	 * @param (callable(Node, Scope, callable(Node, Scope): void): void)|null $alternativeNodeCallback
+	 * @param list<IdentifiedGeneratorInStack> $stack
 	 * @return Generator<int, GeneratorTValueType, GeneratorTSendType, ExprAnalysisResult>
 	 */
-	private function analyseExpr(ExprAnalysisResultStorage $storage, Stmt $stmt, Expr $expr, GeneratorScope $scope, ExpressionContext $context, ?callable $alternativeNodeCallback): Generator
+	private function analyseExpr(ExprAnalysisResultStorage $storage, Stmt $stmt, Expr $expr, GeneratorScope $scope, ExpressionContext $context, ?callable $alternativeNodeCallback, array $stack, ?string $file, ?int $line): Generator
 	{
 		$foundExprAnalysisResult = $storage->findExprAnalysisResult($expr);
 		if ($foundExprAnalysisResult !== null) {
 			if ($alternativeNodeCallback instanceof NoopNodeCallback) {
 				return $foundExprAnalysisResult;
 			}
 
-			throw new ShouldNotHappenException(sprintf('Expr %s on line %d has already been analysed', $this->exprPrinter->printExpr($expr), $expr->getStartLine()));
+			$where = "\n";
+			$origin = $storage->findExprAnalysisResultOrigin($expr);
+			if ($origin !== null) {
+				[$originStack, $originFile, $originLine] = $origin;
+				foreach ($originStack as $originStackItem) {
+					$where .= (string) $originStackItem . "\n";
+				}
+
+				if ($originFile !== null && $originLine !== null) {
+					$where .= $originFile . ':' . $originLine;
+					$where .= "\n";
+				}
+			}
+
+			throw new ShouldNotHappenException(sprintf('Expr %s on line %d has already been analysed in:%s', $this->exprPrinter->printExpr($expr), $expr->getStartLine(), $where));
 		}
 
 		if ($expr instanceof Expr\CallLike && $expr->isFirstClassCallable()) {
@@ -444,7 +459,7 @@ private function analyseExpr(ExprAnalysisResultStorage $storage, Stmt $stmt, Exp
 				throw new ShouldNotHappenException();
 			}
 
-			$exprGen = $this->analyseExpr($storage, $stmt, $newExpr, $scope, $context, $alternativeNodeCallback);
+			$exprGen = $this->analyseExpr($storage, $stmt, $newExpr, $scope, $context, $alternativeNodeCallback, $stack, $file, $line);
 			yield from $exprGen;
 
 			return $exprGen->getReturn();
@@ -464,7 +479,7 @@ private function analyseExpr(ExprAnalysisResultStorage $storage, Stmt $stmt, Exp
 			yield from $gen;
 
 			$exprAnalysisResult = $gen->getReturn();
-			$storage->storeExprAnalysisResult($expr, $exprAnalysisResult);
+			$storage->storeExprAnalysisResult($expr, $exprAnalysisResult, $stack, $file, $line);
 
 			return $exprAnalysisResult;
 		}