Bleeding edge - check that function-scoped template type is in a para…

…meter
phpstan · Feb 6, 2021 · 18bdd34 · 18bdd34
1 parent f11c0f0
commit 18bdd34
Show file tree

Hide file tree

Showing 11 changed files with 96 additions and 13 deletions.
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -11,3 +11,4 @@ parameters:
 		detectDuplicateStubFiles: true
 		checkLogicalAndConstantCondition: true
 		checkLogicalOrConstantCondition: true
+		checkMissingTemplateTypeInParameter: true
diff --git a/conf/config.neon b/conf/config.neon
@@ -24,6 +24,7 @@ parameters:
 		detectDuplicateStubFiles: false
 		checkLogicalAndConstantCondition: false
 		checkLogicalOrConstantCondition: false
+		checkMissingTemplateTypeInParameter: false
 	fileExtensions:
 		- php
 	checkAlwaysTrueCheckTypeFunctionCall: false
@@ -174,7 +175,8 @@ parametersSchema:
 		dateTimeInstantiation: bool(),
 		detectDuplicateStubFiles: bool(),
 		checkLogicalAndConstantCondition: bool(),
-		checkLogicalOrConstantCondition: bool()
+		checkLogicalOrConstantCondition: bool(),
+		checkMissingTemplateTypeInParameter: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAlwaysTrueCheckTypeFunctionCall: bool()
@@ -699,6 +701,7 @@ services:
 		arguments:
 			checkClassCaseSensitivity: %checkClassCaseSensitivity%
 			checkThisOnly: %checkThisOnly%
+			checkMissingTemplateTypeInParameter: %featureToggles.checkMissingTemplateTypeInParameter%
 
 	-
 		class: PHPStan\Rules\FunctionReturnTypeCheck

diff --git a/src/Rules/FunctionDefinitionCheck.php b/src/Rules/FunctionDefinitionCheck.php
@@ -19,7 +19,10 @@
 use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\Reflection\Php\PhpMethodFromParserNodeReflection;
 use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Type\Generic\TemplateType;
 use PHPStan\Type\NonexistentParentClassType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeTraverser;
 use PHPStan\Type\VerbosityLevel;
 use PHPStan\Type\VoidType;
 
@@ -36,34 +39,40 @@ class FunctionDefinitionCheck
 
 	private bool $checkThisOnly;
 
+	private bool $checkMissingTemplateTypeInParameter;
+
 	public function __construct(
 		ReflectionProvider $reflectionProvider,
 		ClassCaseSensitivityCheck $classCaseSensitivityCheck,
 		PhpVersion $phpVersion,
 		bool $checkClassCaseSensitivity,
-		bool $checkThisOnly
+		bool $checkThisOnly,
+		bool $checkMissingTemplateTypeInParameter
 	)
 	{
 		$this->reflectionProvider = $reflectionProvider;
 		$this->classCaseSensitivityCheck = $classCaseSensitivityCheck;
 		$this->phpVersion = $phpVersion;
 		$this->checkClassCaseSensitivity = $checkClassCaseSensitivity;
 		$this->checkThisOnly = $checkThisOnly;
+		$this->checkMissingTemplateTypeInParameter = $checkMissingTemplateTypeInParameter;
 	}
 
 	/**
 	 * @param \PhpParser\Node\Stmt\Function_ $function
 	 * @param string $parameterMessage
 	 * @param string $returnMessage
 	 * @param string $unionTypesMessage
+	 * @param string $templateTypeMissingInParameterMessage
 	 * @return RuleError[]
 	 */
 	public function checkFunction(
 		Function_ $function,
 		FunctionReflection $functionReflection,
 		string $parameterMessage,
 		string $returnMessage,
-		string $unionTypesMessage
+		string $unionTypesMessage,
+		string $templateTypeMissingInParameterMessage
 	): array
 	{
 		$parametersAcceptor = ParametersAcceptorSelector::selectSingle($functionReflection->getVariants());
@@ -73,7 +82,8 @@ public function checkFunction(
 			$function,
 			$parameterMessage,
 			$returnMessage,
-			$unionTypesMessage
+			$unionTypesMessage,
+			$templateTypeMissingInParameterMessage
 		);
 	}
 
@@ -170,14 +180,16 @@ public function checkAnonymousFunction(
 	 * @param string $parameterMessage
 	 * @param string $returnMessage
 	 * @param string $unionTypesMessage
+	 * @param string $templateTypeMissingInParameterMessage
 	 * @return RuleError[]
 	 */
 	public function checkClassMethod(
 		PhpMethodFromParserNodeReflection $methodReflection,
 		ClassMethod $methodNode,
 		string $parameterMessage,
 		string $returnMessage,
-		string $unionTypesMessage
+		string $unionTypesMessage,
+		string $templateTypeMissingInParameterMessage
 	): array
 	{
 		/** @var \PHPStan\Reflection\ParametersAcceptorWithPhpDocs $parametersAcceptor */
@@ -188,7 +200,8 @@ public function checkClassMethod(
 			$methodNode,
 			$parameterMessage,
 			$returnMessage,
-			$unionTypesMessage
+			$unionTypesMessage,
+			$templateTypeMissingInParameterMessage
 		);
 	}
 
@@ -198,14 +211,16 @@ public function checkClassMethod(
 	 * @param string $parameterMessage
 	 * @param string $returnMessage
 	 * @param string $unionTypesMessage
+	 * @param string $templateTypeMissingInParameterMessage
 	 * @return RuleError[]
 	 */
 	private function checkParametersAcceptor(
 		ParametersAcceptor $parametersAcceptor,
 		FunctionLike $functionNode,
 		string $parameterMessage,
 		string $returnMessage,
-		string $unionTypesMessage
+		string $unionTypesMessage,
+		string $templateTypeMissingInParameterMessage
 	): array
 	{
 		$errors = [];
@@ -301,6 +316,25 @@ private function checkParametersAcceptor(
 			$errors[] = RuleErrorBuilder::message(sprintf($returnMessage, $parametersAcceptor->getReturnType()->describe(VerbosityLevel::typeOnly())))->line($returnTypeNode->getLine())->build();
 		}
 
+		if ($this->checkMissingTemplateTypeInParameter) {
+			$templateTypeMap = $parametersAcceptor->getTemplateTypeMap();
+			$templateTypes = $templateTypeMap->getTypes();
+			foreach ($parametersAcceptor->getParameters() as $parameter) {
+				TypeTraverser::map($parameter->getType(), static function (Type $type, callable $traverse) use (&$templateTypes): Type {
+					if ($type instanceof TemplateType) {
+						unset($templateTypes[$type->getName()]);
+						return $type;
+					}
+
+					return $traverse($type);
+				});
+			}
+
+			foreach (array_keys($templateTypes) as $templateTypeName) {
+				$errors[] = RuleErrorBuilder::message(sprintf($templateTypeMissingInParameterMessage, $templateTypeName))->build();
+			}
+		}
+
 		return $errors;
 	}
 

diff --git a/src/Rules/Functions/ExistingClassesInTypehintsRule.php b/src/Rules/Functions/ExistingClassesInTypehintsRule.php
@@ -45,7 +45,8 @@ public function processNode(Node $node, Scope $scope): array
 				'Return typehint of function %s() has invalid type %%s.',
 				$functionName
 			),
-			sprintf('Function %s() uses native union types but they\'re supported only on PHP 8.0 and later.', $functionName)
+			sprintf('Function %s() uses native union types but they\'re supported only on PHP 8.0 and later.', $functionName),
+			sprintf('Template type %%s of function %s() is not referenced in a parameter.', $functionName)
 		);
 	}
 

diff --git a/src/Rules/Methods/ExistingClassesInTypehintsRule.php b/src/Rules/Methods/ExistingClassesInTypehintsRule.php
@@ -49,7 +49,8 @@ public function processNode(Node $node, Scope $scope): array
 				$scope->getClassReflection()->getDisplayName(),
 				$methodReflection->getName()
 			),
-			sprintf('Method %s::%s() uses native union types but they\'re supported only on PHP 8.0 and later.', $scope->getClassReflection()->getDisplayName(), $methodReflection->getName())
+			sprintf('Method %s::%s() uses native union types but they\'re supported only on PHP 8.0 and later.', $scope->getClassReflection()->getDisplayName(), $methodReflection->getName()),
+			sprintf('Template type %%s of method %s::%s() is not referenced in a parameter.', $scope->getClassReflection()->getDisplayName(), $methodReflection->getName())
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInArrowFunctionTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInArrowFunctionTypehintsRuleTest.php
@@ -18,7 +18,7 @@ class ExistingClassesInArrowFunctionTypehintsRuleTest extends \PHPStan\Testing\R
 	protected function getRule(): \PHPStan\Rules\Rule
 	{
 		$broker = $this->createReflectionProvider();
-		return new ExistingClassesInArrowFunctionTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false));
+		return new ExistingClassesInArrowFunctionTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false, true));
 	}
 
 	public function testRule(): void

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInClosureTypehintsRuleTest.php
@@ -18,7 +18,7 @@ class ExistingClassesInClosureTypehintsRuleTest extends \PHPStan\Testing\RuleTes
 	protected function getRule(): \PHPStan\Rules\Rule
 	{
 		$broker = $this->createReflectionProvider();
-		return new ExistingClassesInClosureTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false));
+		return new ExistingClassesInClosureTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false, true));
 	}
 
 	public function testExistingClassInTypehint(): void

diff --git a/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Functions/ExistingClassesInTypehintsRuleTest.php
@@ -19,7 +19,7 @@ class ExistingClassesInTypehintsRuleTest extends \PHPStan\Testing\RuleTestCase
 	protected function getRule(): \PHPStan\Rules\Rule
 	{
 		$broker = $this->createReflectionProvider();
-		return new ExistingClassesInTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false));
+		return new ExistingClassesInTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false, true));
 	}
 
 	public function testExistingClassInTypehint(): void
@@ -86,6 +86,10 @@ public function testExistingClassInTypehint(): void
 				'Parameter $string of function TestFunctionTypehints\genericTemplateClassString() has invalid typehint type TestFunctionTypehints\SomeNonexistentClass.',
 				87,
 			],
+			[
+				'Template type T of function TestFunctionTypehints\templateTypeMissingInParameter() is not referenced in a parameter.',
+				96,
+			],
 		]);
 	}
 

diff --git a/tests/PHPStan/Rules/Functions/data/typehints.php b/tests/PHPStan/Rules/Functions/data/typehints.php
@@ -88,3 +88,12 @@ function genericTemplateClassString(string $string)
 {
 
 }
+
+/**
+ * @template T
+ * @param class-string $a
+ */
+function templateTypeMissingInParameter(string $a)
+{
+
+}
diff --git a/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php b/tests/PHPStan/Rules/Methods/ExistingClassesInTypehintsRuleTest.php
@@ -19,7 +19,7 @@ class ExistingClassesInTypehintsRuleTest extends \PHPStan\Testing\RuleTestCase
 	protected function getRule(): \PHPStan\Rules\Rule
 	{
 		$broker = $this->createReflectionProvider();
-		return new ExistingClassesInTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false));
+		return new ExistingClassesInTypehintsRule(new FunctionDefinitionCheck($broker, new ClassCaseSensitivityCheck($broker), new PhpVersion($this->phpVersionId), true, false, true));
 	}
 
 	public function testExistingClassInTypehint(): void
@@ -124,6 +124,10 @@ public function testExistingClassInTypehint(): void
 				'Parameter $cb of method TestMethodTypehints\CallableTypehints::doFoo() has invalid typehint type TestMethodTypehints\Ble.',
 				113,
 			],
+			[
+				'Template type U of method TestMethodTypehints\TemplateTypeMissingInParameter::doFoo() is not referenced in a parameter.',
+				130,
+			],
 		]);
 	}
 

diff --git a/tests/PHPStan/Rules/Methods/data/typehints.php b/tests/PHPStan/Rules/Methods/data/typehints.php
@@ -116,3 +116,29 @@ public function doFoo(callable $cb): void
 	}
 
 }
+
+/**
+ * @template T
+ */
+class TemplateTypeMissingInParameter
+{
+
+	/**
+	 * @template U of object
+	 * @param class-string $class
+	 */
+	public function doFoo(string $class): void
+	{
+
+	}
+
+	/**
+	 * @template U of object
+	 * @param class-string<U> $class
+	 */
+	public function doBar(string $class): void
+	{
+
+	}
+
+}