[BE] Validate @var tags

Author: ondrejmirtes

changelog-2.0.md

@@ -7,10 +7,12 @@ Major new features 🚀
 
 * **Array `list` type** ([#1751](https://github.com/phpstan/phpstan-src/pull/1751)), #3311, #8185, #6243, thanks @rvanvelzen!
     * Lists are arrays with sequential integer keys starting at 0
-* Lower memory consumption thanks to breaking up of reference cycles
+* **Validate inline PHPDoc `@var` tag** type against native type (level 2) (https://github.com/phpstan/phpstan-src/commit/a69e3bc2f1e87f6da1e65d7935f1cc36bd5c42fe)
+    * Set [`reportWrongPhpDocTypeInVarTag`](https://phpstan.org/config-reference#reportwrongphpdoctypeinvartag) to `true` to have all types validated, not just native ones
+* **Lower memory consumption** thanks to breaking up of reference cycles
     * [Learn more »](https://phpstan.org/blog/preprocessing-ast-for-custom-rules)
     * In testing the memory consumption was reduced by 50–70 %.
-* **Enhancements in Handling Parameters Passed by Reference**
+* **Enhancements in handling parameters passed by reference**
     * [Learn more on phpstan.org](https://phpstan.org/blog/enhancements-in-handling-parameters-passed-by-reference)
     * [#2941](https://github.com/phpstan/phpstan-src/pull/2941), thanks @ljmaskey!
 * LogicalXorConstantConditionRule (level 4) (https://github.com/phpstan/phpstan-src/commit/3a12724fd636b1bcf36c22b36e8f765d97150895, https://github.com/phpstan/phpstan-src/commit/3b011f6524254dad0f16840fdcfdbe7421548617), #7539
@@ -56,8 +58,6 @@ Bleeding edge (TODO move to other sections)
 * Move IllegalConstructorMethodCallRule and IllegalConstructorStaticCallRule to phpstan-strict-rules (https://github.com/phpstan/phpstan-src/commit/124b30f98c182193187be0b9c2e151e477429b7a, https://github.com/phpstan/phpstan-strict-rules/commit/0c82c96f2a55d8b91bbc7ee6512c94f68a206b43)
 * Add `@readonly` rule that disallows default values ([#1391](https://github.com/phpstan/phpstan-src/pull/1391)), thanks @herndlm!
 * MissingMagicSerializationMethodsRule ([#1711](https://github.com/phpstan/phpstan-src/pull/1711)), #7482, thanks @staabm!
-* Validate inline PHPDoc `@var` tag type against native type (https://github.com/phpstan/phpstan-src/commit/a69e3bc2f1e87f6da1e65d7935f1cc36bd5c42fe)
-    * Set [`reportWrongPhpDocTypeInVarTag`](https://phpstan.org/config-reference#reportwrongphpdoctypeinvartag) to `true` to have all types validated, not just native ones
 * Always report always true conditions, except for last elseif and match arm ([#2105](https://github.com/phpstan/phpstan-src/pull/2105)), thanks @staabm!
 * Disable "unreachable branches" rules: UnreachableIfBranchesRule, UnreachableTernaryElseBranchRule, unreachable arm error in MatchExpressionRule
     * Because "always true" is always reported, these are no longer needed

conf/bleedingEdge.neon

@@ -15,7 +15,6 @@ parameters:
 		alwaysCheckTooWideReturnTypeFinalMethods: true
 		alwaysTrueAlwaysReported: true
 		disableUnreachableBranchesRules: true
-		varTagType: true
 		closureDefaultParameterTypeRule: true
 		propertyVariance: true
 		magicConstantOutOfContext: true

conf/config.level2.neon

@@ -52,6 +52,8 @@ rules:
 	- PHPStan\Rules\PhpDoc\IncompatiblePropertyPhpDocTypeRule
 	- PHPStan\Rules\PhpDoc\InvalidThrowsPhpDocValueRule
 	- PHPStan\Rules\PhpDoc\IncompatibleParamImmediatelyInvokedCallableRule
+	- PHPStan\Rules\PhpDoc\VarTagChangedExpressionTypeRule
+	- PHPStan\Rules\PhpDoc\WrongVariableNameInVarTagRule
 	- PHPStan\Rules\Properties\AccessPrivatePropertyThroughStaticRule
 	- PHPStan\Rules\Classes\RequireImplementsRule
 	- PHPStan\Rules\Classes\RequireExtendsRule
@@ -68,8 +70,6 @@ conditionalTags:
 		phpstan.rules.rule: %featureToggles.illegalConstructorMethodCall%
 	PHPStan\Rules\Methods\IllegalConstructorStaticCallRule:
 		phpstan.rules.rule: %featureToggles.illegalConstructorMethodCall%
-	PHPStan\Rules\PhpDoc\VarTagChangedExpressionTypeRule:
-		phpstan.rules.rule: %featureToggles.varTagType%
 	PHPStan\Rules\Generics\PropertyVarianceRule:
 		phpstan.rules.rule: %featureToggles.propertyVariance%
 	PHPStan\Rules\Pure\PureFunctionRule:
@@ -125,14 +125,6 @@ services:
 		class: PHPStan\Rules\PhpDoc\InvalidPHPStanDocTagRule
 		tags:
 			- phpstan.rules.rule
-	-
-		class: PHPStan\Rules\PhpDoc\VarTagChangedExpressionTypeRule
-	-
-		class: PHPStan\Rules\PhpDoc\WrongVariableNameInVarTagRule
-		arguments:
-			checkTypeAgainstNativeType: %featureToggles.varTagType%
-		tags:
-			- phpstan.rules.rule
 	-
 		class: PHPStan\Rules\Generics\PropertyVarianceRule
 		arguments:

conf/config.neon

@@ -36,7 +36,6 @@ parameters:
 		alwaysCheckTooWideReturnTypeFinalMethods: false
 		alwaysTrueAlwaysReported: false
 		disableUnreachableBranchesRules: false
-		varTagType: false
 		closureDefaultParameterTypeRule: false
 		propertyVariance: false
 		stricterFunctionMap: false

conf/parametersSchema.neon

@@ -42,7 +42,6 @@ parametersSchema:
 		alwaysCheckTooWideReturnTypeFinalMethods: bool()
 		alwaysTrueAlwaysReported: bool()
 		disableUnreachableBranchesRules: bool()
-		varTagType: bool()
 		closureDefaultParameterTypeRule: bool()
 		propertyVariance: bool()
 		stricterFunctionMap: bool()

src/Rules/PhpDoc/WrongVariableNameInVarTagRule.php

@@ -37,7 +37,6 @@ final class WrongVariableNameInVarTagRule implements Rule
 	public function __construct(
 		private FileTypeMapper $fileTypeMapper,
 		private VarTagTypeRuleHelper $varTagTypeRuleHelper,
-		private bool $checkTypeAgainstNativeType,
 	)
 	{
 	}
@@ -138,11 +137,6 @@ private function processAssign(Scope $scope, Node\Expr $var, Node\Expr $expr, ar
 		$errors = [];
 		$hasMultipleMessage = false;
 		$assignedVariables = $this->getAssignedVariables($var);
-		if ($this->checkTypeAgainstNativeType) {
-			foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $var, $expr, $varTags, $assignedVariables) as $error) {
-				$errors[] = $error;
-			}
-		}
 		foreach (array_keys($varTags) as $key) {
 			if (is_int($key)) {
 				if (count($varTags) !== 1) {
@@ -181,6 +175,12 @@ private function processAssign(Scope $scope, Node\Expr $var, Node\Expr $expr, ar
 			}
 		}
 
+		if (count($errors) === 0) {
+			foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $var, $expr, $varTags, $assignedVariables) as $error) {
+				$errors[] = $error;
+			}
+		}
+
 		return $errors;
 	}
 
@@ -251,19 +251,17 @@ private function processForeach(Scope $scope, Node\Expr $iterateeExpr, ?Node\Exp
 			))->identifier('varTag.differentVariable')->build();
 		}
 
-		if ($this->checkTypeAgainstNativeType) {
-			foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $iterateeExpr, $iterateeExpr, $varTags, $variableNames) as $error) {
-				$errors[] = $error;
-			}
-			if ($keyVar !== null) {
-				foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $keyVar, new GetIterableKeyTypeExpr($iterateeExpr), $varTags, $variableNames) as $error) {
-					$errors[] = $error;
-				}
-			}
-			foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $valueVar, new GetIterableValueTypeExpr($iterateeExpr), $varTags, $variableNames) as $error) {
+		foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $iterateeExpr, $iterateeExpr, $varTags, $variableNames) as $error) {
+			$errors[] = $error;
+		}
+		if ($keyVar !== null) {
+			foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $keyVar, new GetIterableKeyTypeExpr($iterateeExpr), $varTags, $variableNames) as $error) {
 				$errors[] = $error;
 			}
 		}
+		foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $valueVar, new GetIterableValueTypeExpr($iterateeExpr), $varTags, $variableNames) as $error) {
+			$errors[] = $error;
+		}
 
 		return $errors;
 	}
@@ -321,14 +319,12 @@ private function processStatic(Scope $scope, array $vars, array $varTags): array
 			))->identifier('varTag.differentVariable')->build();
 		}
 
-		if ($this->checkTypeAgainstNativeType) {
-			foreach ($vars as $var) {
-				if ($var->default === null) {
-					continue;
-				}
-				foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $var->var, $var->default, $varTags, $variableNames) as $error) {
-					$errors[] = $error;
-				}
+		foreach ($vars as $var) {
+			if ($var->default === null) {
+				continue;
+			}
+			foreach ($this->varTagTypeRuleHelper->checkVarType($scope, $var->var, $var->default, $varTags, $variableNames) as $error) {
+				$errors[] = $error;
 			}
 		}
 

tests/PHPStan/Rules/PhpDoc/WrongVariableNameInVarTagRuleTest.php

@@ -13,8 +13,6 @@
 class WrongVariableNameInVarTagRuleTest extends RuleTestCase
 {
 
-	private bool $checkTypeAgainstNativeType = false;
-
 	private bool $checkTypeAgainstPhpDocType = false;
 
 	private bool $strictWideningCheck = false;
@@ -24,13 +22,20 @@ protected function getRule(): Rule
 		return new WrongVariableNameInVarTagRule(
 			self::getContainer()->getByType(FileTypeMapper::class),
 			new VarTagTypeRuleHelper($this->checkTypeAgainstPhpDocType, $this->strictWideningCheck),
-			$this->checkTypeAgainstNativeType,
 		);
 	}
 
 	public function testRule(): void
 	{
 		$this->analyse([__DIR__ . '/data/wrong-variable-name-var.php'], [
+			[
+				'PHPDoc tag @var with type int is not subtype of native type void.',
+				11,
+			],
+			[
+				'PHPDoc tag @var with type int is not subtype of native type void.',
+				14,
+			],
 			[
 				'Variable $foo in PHPDoc tag @var does not match assigned variable $test.',
 				17,
@@ -71,6 +76,10 @@ public function testRule(): void
 				'Variable $foo in PHPDoc tag @var does not exist.',
 				109,
 			],
+			[
+				'PHPDoc tag @var with type int is not subtype of native type void.',
+				120,
+			],
 			[
 				'Multiple PHPDoc @var tags above single variable assignment are not supported.',
 				126,
@@ -253,12 +262,9 @@ public function dataReportWrongType(): iterable
 			],
 		];
 
-		yield [false, false, false, []];
-		yield [true, false, false, $nativeCheckOnly];
-		yield [true, false, true, $nativeCheckOnly];
-		yield [false, true, false, []];
-		yield [false, true, true, []];
-		yield [true, true, false, [
+		yield [false, false, $nativeCheckOnly];
+		yield [false, true, $nativeCheckOnly];
+		yield [true, false, [
 			[
 				'PHPDoc tag @var with type string|null is not subtype of native type string.',
 				14,
@@ -349,7 +355,7 @@ public function dataReportWrongType(): iterable
 				204,
 			],
 		]];
-		yield [true, true, true, [
+		yield [true, true, [
 			[
 				'PHPDoc tag @var with type string|null is not subtype of native type string.',
 				14,
@@ -469,43 +475,33 @@ public function dataReportWrongType(): iterable
 	/**
 	 * @dataProvider dataPermutateCheckTypeAgainst
 	 */
-	public function testEmptyArrayInitWithWiderPhpDoc(bool $checkTypeAgainstNativeType, bool $checkTypeAgainstPhpDocType): void
+	public function testEmptyArrayInitWithWiderPhpDoc(bool $checkTypeAgainstPhpDocType): void
 	{
-		$this->checkTypeAgainstNativeType = $checkTypeAgainstNativeType;
 		$this->checkTypeAgainstPhpDocType = $checkTypeAgainstPhpDocType;
-
-		$errors = !$checkTypeAgainstNativeType
-			? []
-			: [
-				[
-					'PHPDoc tag @var with type int is not subtype of native type array{}.',
-					24,
-				],
-			];
-
-		$this->analyse([__DIR__ . '/data/var-above-empty-array-widening.php'], $errors);
+		$this->analyse([__DIR__ . '/data/var-above-empty-array-widening.php'], [
+			[
+				'PHPDoc tag @var with type int is not subtype of native type array{}.',
+				24,
+			],
+		]);
 	}
 
 	public function dataPermutateCheckTypeAgainst(): iterable
 	{
-		yield [true, true];
-		yield [false, true];
-		yield [true, false];
-		yield [false, false];
+		yield [true];
+		yield [false];
 	}
 
 	/**
 	 * @dataProvider dataReportWrongType
 	 * @param list<array{0: string, 1: int, 2?: string}> $expectedErrors
 	 */
 	public function testReportWrongType(
-		bool $checkTypeAgainstNativeType,
 		bool $checkTypeAgainstPhpDocType,
 		bool $strictWideningCheck,
 		array $expectedErrors,
 	): void
 	{
-		$this->checkTypeAgainstNativeType = $checkTypeAgainstNativeType;
 		$this->checkTypeAgainstPhpDocType = $checkTypeAgainstPhpDocType;
 		$this->strictWideningCheck = $strictWideningCheck;
 		$this->analyse([__DIR__ . '/data/wrong-var-native-type.php'], $expectedErrors);