Handle invalid type aliases better

ondrejmirtes · ondrejmirtes · commit fc5515a516c6 · 2023-04-04T16:12:56.000+02:00
diff --git a/src/PhpDoc/TypeNodeResolver.php b/src/PhpDoc/TypeNodeResolver.php
@@ -28,6 +28,7 @@
 use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
+use PHPStan\PhpDocParser\Ast\Type\InvalidTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\OffsetAccessTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
@@ -164,6 +165,8 @@ public function resolve(TypeNode $typeNode, NameScope $nameScope): Type
 			return $this->resolveConstTypeNode($typeNode, $nameScope);
 		} elseif ($typeNode instanceof OffsetAccessTypeNode) {
 			return $this->resolveOffsetAccessNode($typeNode, $nameScope);
+		} elseif ($typeNode instanceof InvalidTypeNode) {
+			return new MixedType(true);
 		}
 
 		return new ErrorType();
diff --git a/src/Rules/PhpDoc/InvalidPhpDocTagValueRule.php b/src/Rules/PhpDoc/InvalidPhpDocTagValueRule.php
@@ -6,6 +6,8 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\VirtualNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\InvalidTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\TypeAliasTagValueNode;
+use PHPStan\PhpDocParser\Ast\Type\InvalidTypeNode;
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\PhpDocParser\Parser\TokenIterator;
@@ -71,11 +73,24 @@ public function processNode(Node $node, Scope $scope): array
 
 		$errors = [];
 		foreach ($phpDocNode->getTags() as $phpDocTag) {
-			if (!($phpDocTag->value instanceof InvalidTagValueNode)) {
+			if (strpos($phpDocTag->name, '@psalm-') === 0) {
 				continue;
 			}
 
-			if (strpos($phpDocTag->name, '@psalm-') === 0) {
+			if ($phpDocTag->value instanceof TypeAliasTagValueNode) {
+				if (!$phpDocTag->value->type instanceof InvalidTypeNode) {
+					continue;
+				}
+
+				$errors[] = RuleErrorBuilder::message(sprintf(
+					'PHPDoc tag %s %s has invalid value: %s',
+					$phpDocTag->name,
+					$phpDocTag->value->alias,
+					$phpDocTag->value->type->getException()->getMessage(),
+				))->build();
+
+				continue;
+			} elseif (!($phpDocTag->value instanceof InvalidTagValueNode)) {
 				continue;
 			}
 
diff --git a/tests/PHPStan/Analyser/NodeScopeResolverTest.php b/tests/PHPStan/Analyser/NodeScopeResolverTest.php
@@ -1221,6 +1221,7 @@ public function dataFileAsserts(): iterable
 		yield from $this->gatherAssertTypes(__DIR__ . '/../Rules/PhpDoc/data/bug-8609-function.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-9131.php');
 		yield from $this->gatherAssertTypes(__DIR__ . '/data/more-types.php');
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/invalid-type-aliases.php');
 	}
 
 	/**
diff --git a/tests/PHPStan/Analyser/data/invalid-type-aliases.php b/tests/PHPStan/Analyser/data/invalid-type-aliases.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace InvalidTypeAliases;
+
+use function PHPStan\Testing\assertType;
+
+/** @psalm-type MyObject = what{foo: 'bar'} */
+class HelloWorld
+{
+	/** @psalm-param MyObject $a */
+	public function acceptsAlias($a)
+	{
+		assertType('mixed', $a);
+		assertType('mixed', $this->returnsAlias());
+	}
+
+	/** @psalm-return MyObject */
+	public function returnsAlias()
+	{
+
+	}
+}
diff --git a/tests/PHPStan/Rules/Classes/data/local-type-aliases.php b/tests/PHPStan/Rules/Classes/data/local-type-aliases.php
@@ -62,3 +62,9 @@ class Generic
 class Invalid
 {
 }
+
+/** @psalm-type MyObject = what{} */
+class InvalidTypeDefinitionToIgnoreBecauseItsAParseErrorAlreadyReportedInInvalidPhpDocTagValueRule
+{
+
+}
diff --git a/tests/PHPStan/Rules/PhpDoc/InvalidPhpDocTagValueRuleTest.php b/tests/PHPStan/Rules/PhpDoc/InvalidPhpDocTagValueRuleTest.php
@@ -129,4 +129,15 @@ public function testBug4731WithoutFirstTag(): void
 		$this->analyse([__DIR__ . '/data/bug-4731-no-first-tag.php'], []);
 	}
 
+	public function testInvalidTypeInTypeAlias(): void
+	{
+		$this->checkAllInvalidPhpDocs = true;
+		$this->analyse([__DIR__ . '/data/invalid-type-type-alias.php'], [
+			[
+				'PHPDoc tag @phpstan-type InvalidFoo has invalid value: Unexpected token "{", expected TOKEN_PHPDOC_EOL at offset 65',
+				12,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/PhpDoc/data/invalid-type-type-alias.php b/tests/PHPStan/Rules/PhpDoc/data/invalid-type-type-alias.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace InvalidTypeInTypeAlias;
+
+/**
+ * @phpstan-type Foo array{}
+ * @phpstan-type InvalidFoo what{}
+ *
+ * @psalm-type Foo array{}
+ * @psalm-type InvalidFoo what{}
+ */
+class Foo
+{
+
+
+
+}

Original file line number	Diff line number	Diff line change
`@@ -1221,6 +1221,7 @@ public function dataFileAsserts(): iterable`
`1221`	`1221`	`yield from $this->gatherAssertTypes(__DIR__ . '/../Rules/PhpDoc/data/bug-8609-function.php');`
`1222`	`1222`	`yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-9131.php');`
`1223`	`1223`	`yield from $this->gatherAssertTypes(__DIR__ . '/data/more-types.php');`
	`1224`	`+ yield from $this->gatherAssertTypes(__DIR__ . '/data/invalid-type-aliases.php');`
`1224`	`1225`	`}`
`1225`	`1226`
`1226`	`1227`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -62,3 +62,9 @@ class Generic`
`62`	`62`	`class Invalid`
`63`	`63`	`{`
`64`	`64`	`}`
	`65`	`+`
	`66`	`+/** @psalm-type MyObject = what{} */`
	`67`	`+class InvalidTypeDefinitionToIgnoreBecauseItsAParseErrorAlreadyReportedInInvalidPhpDocTagValueRule`
	`68`	`+{`
	`69`	`+`
	`70`	`+}`