Assert ExprCacheHelper->import() will not mix up same expr-string based attributes

Author: staabm

tests/PHPStan/Parser/CachedParserTest.php

@@ -5,8 +5,13 @@
 use Generator;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Namespace_;
+use PHPStan\BetterReflection\BetterReflection;
+use PHPStan\BetterReflection\Reflection\ExprCacheHelper;
+use PHPStan\BetterReflection\SourceLocator\SourceStubber\PhpStormStubsSourceStubber;
 use PHPStan\File\FileHelper;
 use PHPStan\File\FileReader;
+use PHPStan\Node\Printer\Printer;
+use PHPStan\Php\PhpVersion;
 use PHPStan\Testing\PHPStanTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\MockObject\Stub;
@@ -123,4 +128,55 @@ public function testParseTheSameFileWithDifferentMethod(): void
 		$this->assertSame(2, $stmts[0]->stmts[1]->expr->expr->class->getAttribute(AnonymousClassVisitor::ATTRIBUTE_LINE_INDEX));
 	}
 
+	public function testWithExprCacheHelper(): void
+	{
+		$fileHelper = self::getContainer()->getByType(FileHelper::class);
+		$pathRoutingParser = new PathRoutingParser(
+			$fileHelper,
+			self::getContainer()->getService('currentPhpVersionRichParser'),
+			self::getContainer()->getService('currentPhpVersionSimpleDirectParser'),
+			self::getContainer()->getService('php8Parser'),
+			null,
+		);
+		$parser = new CachedParser($pathRoutingParser, 500);
+		$path = $fileHelper->normalizePath(__DIR__ . '/data/parser-cache-bug.php');
+		$pathRoutingParser->setAnalysedFiles([$path]);
+		$contents = FileReader::read($path);
+		$stmts = $parser->parseString($contents);
+
+		$this->assertInstanceOf(Namespace_::class, $stmts[0]);
+		$ns = $stmts[0];
+
+		$this->assertInstanceOf(Node\Stmt\Class_::class, $ns->stmts[1]);
+		$class = $ns->stmts[1];
+
+		$this->assertInstanceOf(Node\Stmt\Property::class, $class->stmts[0]);
+		$property = $class->stmts[0];
+		$this->assertInstanceOf(Node\AttributeGroup::class, $property->attrGroups[0]);
+		$group = $property->attrGroups[0];
+		$this->assertInstanceOf(Node\Attribute::class, $group->attrs[0]);
+		$attribute = $group->attrs[0];
+
+		$expr = $attribute->args[0]->value;
+		$this->assertSame(['startLine' => 8, 'startTokenPos' => 21, 'startFilePos' => 88, 'endLine' => 8, 'endTokenPos' => 21, 'endFilePos' => 94, 'kind' => 1, 'rawValue' => "'hello'"], $expr->getAttributes());
+		$exported = ExprCacheHelper::export($expr);
+		$reImported = ExprCacheHelper::import($exported);
+		$this->assertSame(['startLine' => 8, 'startTokenPos' => 21, 'startFilePos' => 88, 'endLine' => 8, 'endTokenPos' => 21, 'endFilePos' => 94, 'kind' => 1, 'rawValue' => "'hello'"], $reImported->getAttributes());
+
+		$this->assertInstanceOf(Node\Stmt\Property::class, $class->stmts[1]);
+		$property = $class->stmts[1];
+		$this->assertInstanceOf(Node\AttributeGroup::class, $property->attrGroups[0]);
+		$group = $property->attrGroups[0];
+		$this->assertInstanceOf(Node\Attribute::class, $group->attrs[0]);
+		$attribute = $group->attrs[0];
+
+		$expr = $attribute->args[0]->value;
+		$this->assertSame(['startLine' => 10, 'startTokenPos' => 35, 'startFilePos' => 137, 'endLine' => 10, 'endTokenPos' => 35, 'endFilePos' => 143, 'kind' => 1, 'rawValue' => "'hello'"], $expr->getAttributes());
+		$exported = ExprCacheHelper::export($expr);
+		unset($exported['attributes']['startLine']); // modify attributes
+		$reImported = ExprCacheHelper::import($exported);
+		// assert that we get back the default start-line instead of a stale cached startLine of previous same value expression
+		$this->assertSame(['startLine' => 1, 'startTokenPos' => 35, 'startFilePos' => 137, 'endLine' => 10, 'endTokenPos' => 35, 'endFilePos' => 143, 'kind' => 1, 'rawValue' => "'hello'"], $reImported->getAttributes());
+	}
+
 }

tests/PHPStan/Parser/data/parser-cache-bug.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace ParserCacheBug;
+
+use Attribute;
+
+class ParserCacheBug {
+	#[MyAttribute('hello')]
+	protected string $foo;
+	#[MyAttribute('hello')]
+	protected string $bar;
+}
+
+#[Attribute]
+class MyAttribute
+{
+	public string $arg;
+
+	public function __construct(string $event)
+	{
+		$this->arg = $event;
+	}
+}