Remove purity check from native type

Author: VincentLanglet

src/Rules/PhpDoc/VarTagTypeRuleHelper.php

@@ -4,11 +4,14 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr;
+use PHPStan\Analyser\NameScope;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\Expr\GetOffsetValueTypeExpr;
 use PHPStan\PhpDoc\Tag\VarTag;
+use PHPStan\PhpDoc\TypeNodeResolver;
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\TrinaryLogic;
 use PHPStan\Type\ArrayType;
 use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\MixedType;
@@ -24,8 +27,11 @@
 final class VarTagTypeRuleHelper
 {
 
-	public function __construct(private bool $checkTypeAgainstPhpDocType, private bool $strictWideningCheck)
-	{
+	public function __construct(
+		private TypeNodeResolver $typeNodeResolver,
+		private bool $checkTypeAgainstPhpDocType,
+		private bool $strictWideningCheck
+	) {
 	}
 
 	/**
@@ -134,15 +140,15 @@ private function shouldVarTagTypeBeReported(Node\Expr $expr, Type $type, Type $v
 				$type = new ArrayType(new MixedType(), new MixedType());
 			}
 
-			return $type->isSuperTypeOf($varTagType)->no();
+			return $this->isSuperTypeOfVarType($type, $varTagType)->no();
 		}
 
 		if ($expr instanceof Expr\ConstFetch) {
-			return $type->isSuperTypeOf($varTagType)->no();
+			return $this->isSuperTypeOfVarType($type, $varTagType)->no();
 		}
 
 		if ($expr instanceof Node\Scalar) {
-			return $type->isSuperTypeOf($varTagType)->no();
+			return $this->isSuperTypeOfVarType($type, $varTagType)->no();
 		}
 
 		if ($expr instanceof Expr\New_) {
@@ -157,36 +163,43 @@ private function shouldVarTagTypeBeReported(Node\Expr $expr, Type $type, Type $v
 	private function checkType(Type $type, Type $varTagType, int $depth = 0): bool
 	{
 		if ($this->strictWideningCheck) {
-			return !$type->isSuperTypeOf($varTagType)->yes();
+			return !$this->isSuperTypeOfVarType($type, $varTagType)->yes();
 		}
 
 		if ($type->isConstantArray()->yes()) {
 			if ($type->isIterableAtLeastOnce()->no()) {
 				$type = new ArrayType(new MixedType(), new MixedType());
-				return $type->isSuperTypeOf($varTagType)->no();
+				return $this->isSuperTypeOfVarType($type, $varTagType)->no();
 			}
 		}
 
 		if ($type->isIterable()->yes() && $varTagType->isIterable()->yes()) {
-			if ($type->isSuperTypeOf($varTagType)->no()) {
+			if ($this->isSuperTypeOfVarType($type, $varTagType)->no()) {
 				return true;
 			}
 
 			$innerType = $type->getIterableValueType();
 			$innerVarTagType = $varTagType->getIterableValueType();
 
 			if ($type->equals($innerType) || $varTagType->equals($innerVarTagType)) {
-				return !$innerType->isSuperTypeOf($innerVarTagType)->yes();
+				return !$this->isSuperTypeOfVarType($innerType, $innerVarTagType)->yes();
 			}
 
 			return $this->checkType($innerType, $innerVarTagType, $depth + 1);
 		}
 
-		if ($type->isConstantValue()->yes() && $depth === 0) {
-			return $type->isSuperTypeOf($varTagType)->no();
+		if ($depth === 0 && $type->isConstantValue()->yes()) {
+			return $this->isSuperTypeOfVarType($type, $varTagType)->no();
 		}
 
-		return !$type->isSuperTypeOf($varTagType)->yes();
+		return !$this->isSuperTypeOfVarType($type, $varTagType)->yes();
+	}
+
+	private function isSuperTypeOfVarType(Type $type, Type $varTagType): TrinaryLogic
+	{
+		$type = $this->typeNodeResolver->resolve($type->toPhpDocNode(), new NameScope(null, []));
+
+		return $type->isSuperTypeOf($varTagType);
 	}
 
 }

tests/PHPStan/Rules/PhpDoc/VarTagChangedExpressionTypeRuleTest.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Rules\PhpDoc;
 
+use PHPStan\PhpDoc\TypeNodeResolver;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 
@@ -13,7 +14,11 @@ class VarTagChangedExpressionTypeRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new VarTagChangedExpressionTypeRule(new VarTagTypeRuleHelper(true, true));
+		return new VarTagChangedExpressionTypeRule(new VarTagTypeRuleHelper(
+			self::getContainer()->getByType(TypeNodeResolver::class),
+			true,
+			true,
+		));
 	}
 
 	public function testRule(): void

tests/PHPStan/Rules/PhpDoc/WrongVariableNameInVarTagRuleTest.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Rules\PhpDoc;
 
+use PHPStan\PhpDoc\TypeNodeResolver;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 use PHPStan\Type\FileTypeMapper;
@@ -23,7 +24,11 @@ protected function getRule(): Rule
 	{
 		return new WrongVariableNameInVarTagRule(
 			self::getContainer()->getByType(FileTypeMapper::class),
-			new VarTagTypeRuleHelper($this->checkTypeAgainstPhpDocType, $this->strictWideningCheck),
+			new VarTagTypeRuleHelper(
+				self::getContainer()->getByType(TypeNodeResolver::class),
+				$this->checkTypeAgainstPhpDocType,
+				$this->strictWideningCheck,
+			),
 			$this->checkTypeAgainstNativeType,
 		);
 	}
@@ -182,6 +187,11 @@ public function testBug4505(): void
 		$this->analyse([__DIR__ . '/data/bug-4505.php'], []);
 	}
 
+	public function testBug12458(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-12458.php'], []);
+	}
+
 	public function testEnums(): void
 	{
 		if (PHP_VERSION_ID < 80100) {

tests/PHPStan/Rules/PhpDoc/data/bug-12458.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+Namespace Bug12458;
+
+class HelloWorld
+{
+	/**
+	 * @param list<HelloWorld> $a
+	 */
+	public function test(array $a): void
+	{
+		/** @var \Closure(): list<HelloWorld> $c */
+		$c = function () use ($a): array {
+			return $a;
+		};
+	}
+}