improve handling of unresolvable types in PHPDoc

Author: JanTvrdik

Diff for: src/Rules/PhpDoc/IncompatiblePhpDocTypeRule.php

@@ -5,6 +5,7 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Type\ArrayType;
+use PHPStan\Type\ErrorType;
 use PHPStan\Type\FileTypeMapper;
 use PHPStan\Type\Type;
 
@@ -54,6 +55,12 @@ public function processNode(Node $node, Scope $scope): array
 					$parameterName
 				);
 
+			} elseif ($phpDocParamType instanceof ErrorType) {
+				$errors[] = sprintf(
+					'PHPDoc tag @param for parameter $%s contains unresolvable type',
+					$parameterName
+				);
+
 			} else {
 				$nativeParamType = $nativeParameterTypes[$parameterName];
 				$isParamSuperType = $nativeParamType->isSuperTypeOf($phpDocParamType);
@@ -88,21 +95,25 @@ public function processNode(Node $node, Scope $scope): array
 		if ($resolvedPhpDoc->getReturnTag() !== null) {
 			$phpDocReturnType = $resolvedPhpDoc->getReturnTag()->getType();
 
-			$isReturnSuperType = $nativeReturnType->isSuperTypeOf($phpDocReturnType);
+			if ($phpDocReturnType instanceof ErrorType) {
+				$errors[] = 'PHPDoc tag @return contains unresolvable type';
 
-			if ($isReturnSuperType->no()) {
-				$errors[] = sprintf(
-					'PHPDoc tag @return with type %s is incompatible with native type %s',
-					$phpDocReturnType->describe(),
-					$nativeReturnType->describe()
-				);
+			} else {
+				$isReturnSuperType = $nativeReturnType->isSuperTypeOf($phpDocReturnType);
+				if ($isReturnSuperType->no()) {
+					$errors[] = sprintf(
+						'PHPDoc tag @return with type %s is incompatible with native type %s',
+						$phpDocReturnType->describe(),
+						$nativeReturnType->describe()
+					);
 
-			} elseif ($isReturnSuperType->maybe()) {
-				$errors[] = sprintf(
-					'PHPDoc tag @return with type %s is not subtype of native type %s',
-					$phpDocReturnType->describe(),
-					$nativeReturnType->describe()
-				);
+				} elseif ($isReturnSuperType->maybe()) {
+					$errors[] = sprintf(
+						'PHPDoc tag @return with type %s is not subtype of native type %s',
+						$phpDocReturnType->describe(),
+						$nativeReturnType->describe()
+					);
+				}
 			}
 		}
 

Diff for: src/Type/TypehintHelper.php

@@ -76,7 +76,7 @@ public static function decideType(
 		Type $phpDocType = null
 	): Type
 	{
-		if ($phpDocType !== null) {
+		if ($phpDocType !== null && !$phpDocType instanceof ErrorType) {
 			if ($type instanceof VoidType || $phpDocType instanceof VoidType) {
 				return new VoidType();
 			}

Diff for: tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -3653,6 +3653,41 @@ public function testMisleadingTypesWithoutNamespace(
 		);
 	}
 
+	public function dataUnresolvableTypes(): array
+	{
+		return [
+			[
+				'mixed',
+				'$arrayWithTooManyArgs',
+			],
+			[
+				'mixed',
+				'$iterableWithTooManyArgs',
+			],
+			[
+				'mixed',
+				'$genericFoo',
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider dataUnresolvableTypes
+	 * @param string $description
+	 * @param string $expression
+	 */
+	public function testUnresolvableTypes(
+		string $description,
+		string $expression
+	)
+	{
+		$this->assertTypes(
+			__DIR__ . '/data/unresolvable-types.php',
+			$description,
+			$expression
+		);
+	}
+
 	public function dataCombineTypes(): array
 	{
 		return [

Diff for: tests/PHPStan/Analyser/data/unresolvable-types.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace UnresolvableTypes;
+
+/**
+ * @param array<int, int, int> $arrayWithTooManyArgs
+ * @param iterable<int, int, int> $iterableWithTooManyArgs
+ * @param \Foo<int> $genericFoo
+ */
+function test(
+	$arrayWithTooManyArgs,
+	$iterableWithTooManyArgs,
+	$genericFoo
+) {
+	die;
+}

Diff for: tests/PHPStan/Rules/PhpDoc/IncompatiblePhpDocTypeRuleTest.php

@@ -45,6 +45,18 @@ public function testRule()
 				'PHPDoc tag @param for parameter $numbers with type array<int, string> is incompatible with native type array<int, int>',
 				99,
 			],
+			[
+				'PHPDoc tag @param for parameter $arr contains unresolvable type',
+				117,
+			],
+			[
+				'PHPDoc tag @param references unknown parameter $arrX',
+				117,
+			],
+			[
+				'PHPDoc tag @return contains unresolvable type',
+				117,
+			],
 		]);
 	}
 

Diff for: tests/PHPStan/Rules/PhpDoc/data/incompatible-types.php

@@ -108,3 +108,13 @@ function variadicStringArrays(array ...$strings)
 {
 
 }
+
+/**
+ * @param  array<int, int, int> $arr
+ * @param  array<int, int, int> $arrX
+ * @return bool <strong>true</strong> or <strong>false</strong>
+ */
+function unresolvableTypes(array $arr): bool
+{
+
+}