GNSR is dead, long live FNSR

Author: ondrejmirtes

src/Testing/RuleTestCase.php

@@ -6,6 +6,7 @@
 use PHPStan\Analyser\Analyser;
 use PHPStan\Analyser\AnalyserResultFinalizer;
 use PHPStan\Analyser\Error;
+use PHPStan\Analyser\Fiber\FiberNodeScopeResolver;
 use PHPStan\Analyser\FileAnalyser;
 use PHPStan\Analyser\Generator\GeneratorNodeScopeResolver;
 use PHPStan\Analyser\Generator\GeneratorScopeFactory;
@@ -97,7 +98,13 @@ protected function createNodeScopeResolver(): NodeScopeResolver|GeneratorNodeSco
 		$reflectionProvider = $this->createReflectionProvider();
 		$typeSpecifier = $this->getTypeSpecifier();
 
-		return new NodeScopeResolver(
+		$enableFnsr = getenv('PHPSTAN_FNSR');
+		$className = NodeScopeResolver::class;
+		if ($enableFnsr === '1') {
+			$className = FiberNodeScopeResolver::class;
+		}
+
+		return new $className(
 			$reflectionProvider,
 			self::getContainer()->getByType(InitializerExprTypeResolver::class),
 			self::getReflector(),

src/Testing/TypeInferenceTestCase.php

@@ -5,6 +5,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Name;
+use PHPStan\Analyser\Fiber\FiberNodeScopeResolver;
 use PHPStan\Analyser\Generator\GeneratorNodeScopeResolver;
 use PHPStan\Analyser\Generator\GeneratorScopeFactory;
 use PHPStan\Analyser\Generator\NodeHandler\VarAnnotationHelper;
@@ -71,7 +72,13 @@ protected static function createNodeScopeResolver(): NodeScopeResolver|Generator
 		$reflectionProvider = self::createReflectionProvider();
 		$typeSpecifier = $container->getService('typeSpecifier');
 
-		return new NodeScopeResolver(
+		$enableFnsr = getenv('PHPSTAN_FNSR');
+		$className = NodeScopeResolver::class;
+		if ($enableFnsr === '1') {
+			$className = FiberNodeScopeResolver::class;
+		}
+
+		return new $className(
 			$reflectionProvider,
 			$container->getByType(InitializerExprTypeResolver::class),
 			self::getReflector(),

tests/PHPStan/Analyser/Fiber/FiberNodeScopeResolverRuleTest.php

@@ -0,0 +1,109 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\Fiber;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Testing\RuleTestCase;
+use PHPStan\Type\VerbosityLevel;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\RequiresPhp;
+
+/**
+ * @extends RuleTestCase<Rule<Node>>
+ */
+#[RequiresPhp('>= 8.1')]
+class FiberNodeScopeResolverRuleTest extends RuleTestCase
+{
+
+	/** @var callable(Node, Scope): list<IdentifierRuleError> */
+	private $ruleCallback;
+
+	protected function getRule(): Rule
+	{
+		return new class ($this->ruleCallback) implements Rule {
+
+			/**
+			 * @param callable(Node, Scope): list<IdentifierRuleError> $ruleCallback
+			 */
+			public function __construct(private $ruleCallback)
+			{
+			}
+
+			public function getNodeType(): string
+			{
+				return Node::class;
+			}
+
+			public function processNode(Node $node, Scope $scope): array
+			{
+				return ($this->ruleCallback)($node, $scope);
+			}
+
+		};
+	}
+
+	public static function dataRule(): iterable
+	{
+		yield [
+			static fn (Node $node, Scope $scope) => [],
+			[],
+		];
+		yield [
+			static function (Node $node, Scope $scope) {
+				if (!$node instanceof Node\Expr\MethodCall) {
+					return [];
+				}
+
+				$arg0 = $scope->getType($node->getArgs()[0]->value);
+				$arg0 = $scope->getType($node->getArgs()[0]->value); // on purpose to hit the cache
+
+				return [
+					RuleErrorBuilder::message($arg0->describe(VerbosityLevel::precise()))->identifier('gnsr.rule')->build(),
+					RuleErrorBuilder::message($scope->getType($node->getArgs()[1]->value)->describe(VerbosityLevel::precise()))->identifier('gnsr.rule')->build(),
+					RuleErrorBuilder::message($scope->getType($node->getArgs()[2]->value)->describe(VerbosityLevel::precise()))->identifier('gnsr.rule')->build(),
+				];
+			},
+			[
+				['1', 21],
+				['2', 21],
+				['3', 21],
+			],
+		];
+		yield [
+			static function (Node $node, Scope $scope) {
+				if (!$node instanceof Node\Expr\MethodCall) {
+					return [];
+				}
+
+				$synthetic = $scope->getType(new Node\Scalar\String_('foo'));
+				$synthetic2 = $scope->getType(new Node\Scalar\String_('bar'));
+
+				return [
+					RuleErrorBuilder::message($synthetic->describe(VerbosityLevel::precise()))->identifier('gnsr.rule')->build(),
+					RuleErrorBuilder::message($synthetic2->describe(VerbosityLevel::precise()))->identifier('gnsr.rule')->build(),
+				];
+			},
+			[
+				['\'foo\'', 21],
+				['\'bar\'', 21],
+			],
+		];
+	}
+
+	/**
+	 * @param callable(Node, Scope): list<IdentifierRuleError> $ruleCallback
+	 * @param list<array{0: string, 1: int, 2?: string|null}> $expectedErrors
+	 * @return void
+	 */
+	#[DataProvider('dataRule')]
+	public function testRule(callable $ruleCallback, array $expectedErrors): void
+	{
+		$this->ruleCallback = $ruleCallback;
+		$this->analyse([__DIR__ . '/data/rule.php'], $expectedErrors);
+	}
+
+}

tests/PHPStan/Analyser/Fiber/FiberNodeScopeResolverTest.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser\Fiber;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\RequiresPhp;
+
+#[RequiresPhp('>= 8.1')]
+class FiberNodeScopeResolverTest extends TypeInferenceTestCase
+{
+
+	public static function dataFileAsserts(): iterable
+	{
+		yield from self::gatherAssertTypes(__DIR__ . '/data/gnsr.php');
+	}
+
+	/**
+	 * @param mixed ...$args
+	 */
+	#[DataProvider('dataFileAsserts')]
+	public function testFileAsserts(
+		string $assertType,
+		string $file,
+		...$args,
+	): void
+	{
+		$this->assertFileAsserts($assertType, $file, ...$args);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../../conf/bleedingEdge.neon',
+		];
+	}
+
+}