Bleeding edge - deep inspect types for missing typehints

ondrejmirtes · ondrejmirtes · commit 2f456b91bbbc · 2021-06-08T10:37:57.000+02:00
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -19,3 +19,4 @@ parameters:
 		rememberFunctionValues: true
 		preciseExceptionTracking: true
 		apiRules: true
+		deepInspectTypes: true
diff --git a/conf/config.neon b/conf/config.neon
@@ -41,6 +41,7 @@ parameters:
 		rememberFunctionValues: false
 		preciseExceptionTracking: false
 		apiRules: false
+		deepInspectTypes: false
 	fileExtensions:
 		- php
 	checkAlwaysTrueCheckTypeFunctionCall: false
@@ -210,7 +211,8 @@ parametersSchema:
 		skipCheckGenericClasses: listOf(string()),
 		rememberFunctionValues: bool(),
 		preciseExceptionTracking: bool(),
-		apiRules: bool()
+		apiRules: bool(),
+		deepInspectTypes: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAlwaysTrueCheckTypeFunctionCall: bool()
@@ -836,6 +838,7 @@ services:
 			checkGenericClassInNonGenericObjectType: %checkGenericClassInNonGenericObjectType%
 			checkMissingCallableSignature: %checkMissingCallableSignature%
 			skipCheckGenericClasses: %featureToggles.skipCheckGenericClasses%
+			deepInspectTypes: %featureToggles.deepInspectTypes%
 
 	-
 		class: PHPStan\Rules\NullsafeCheck
diff --git a/src/Command/ErrorFormatter/CheckstyleErrorFormatter.php b/src/Command/ErrorFormatter/CheckstyleErrorFormatter.php
@@ -37,7 +37,7 @@ public function formatErrors(
 				$output->writeRaw(sprintf(
 					'  <error line="%d" column="1" severity="error" message="%s" />',
 					$this->escape((string) $error->getLine()),
-					$this->escape((string) $error->getMessage())
+					$this->escape($error->getMessage())
 				));
 				$output->writeLineFormatted('');
 			}
@@ -94,7 +94,7 @@ private function escape(string $string): string
 	 * Group errors by file
 	 *
 	 * @param AnalysisResult $analysisResult
-	 * @return array<string, array> Array that have as key the relative path of file
+	 * @return array<string, array<\PHPStan\Analyser\Error>> Array that have as key the relative path of file
 	 *                              and as value an array with occurred errors.
 	 */
 	private function groupByFile(AnalysisResult $analysisResult): array
diff --git a/src/Rules/MissingTypehintCheck.php b/src/Rules/MissingTypehintCheck.php
@@ -38,6 +38,8 @@ class MissingTypehintCheck
 	/** @var string[] */
 	private array $skipCheckGenericClasses;
 
+	private bool $deepInspectTypes;
+
 	/**
 	 * @param string[] $skipCheckGenericClasses
 	 */
@@ -46,14 +48,16 @@ public function __construct(
 		bool $checkMissingIterableValueType,
 		bool $checkGenericClassInNonGenericObjectType,
 		bool $checkMissingCallableSignature,
-		array $skipCheckGenericClasses = []
+		array $skipCheckGenericClasses = [],
+		bool $deepInspectTypes = false
 	)
 	{
 		$this->reflectionProvider = $reflectionProvider;
 		$this->checkMissingIterableValueType = $checkMissingIterableValueType;
 		$this->checkGenericClassInNonGenericObjectType = $checkGenericClassInNonGenericObjectType;
 		$this->checkMissingCallableSignature = $checkMissingCallableSignature;
 		$this->skipCheckGenericClasses = $skipCheckGenericClasses;
+		$this->deepInspectTypes = $deepInspectTypes;
 	}
 
 	/**
@@ -86,6 +90,10 @@ public function getIterableTypesWithMissingValueTypehint(Type $type): array
 					}
 					$iterablesWithMissingValueTypehint[] = $type;
 				}
+				if ($this->deepInspectTypes) {
+					return $traverse($type);
+				}
+
 				return $type;
 			}
 			return $traverse($type);
@@ -142,8 +150,8 @@ public function getNonGenericObjectTypesWithGenericClass(Type $type): array
 				];
 				return $type;
 			}
-			$traverse($type);
-			return $type;
+
+			return $traverse($type);
 		});
 
 		return $objectTypes;
diff --git a/tests/PHPStan/Rules/Methods/MissingMethodParameterTypehintRuleTest.php b/tests/PHPStan/Rules/Methods/MissingMethodParameterTypehintRuleTest.php
@@ -10,10 +10,13 @@
 class MissingMethodParameterTypehintRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
+	/** @var bool */
+	private $deepInspectTypes = false;
+
 	protected function getRule(): \PHPStan\Rules\Rule
 	{
 		$broker = $this->createReflectionProvider();
-		return new MissingMethodParameterTypehintRule(new MissingTypehintCheck($broker, true, true, true));
+		return new MissingMethodParameterTypehintRule(new MissingTypehintCheck($broker, true, true, true, [], $this->deepInspectTypes));
 	}
 
 	public function testRule(): void
@@ -92,4 +95,32 @@ public function testPromotedProperties(): void
 		]);
 	}
 
+	public function testDoNotDeepInspectTypes(): void
+	{
+		$this->analyse([__DIR__ . '/data/deep-inspect-types.php'], [
+			[
+				'Method DeepInspectTypes\Foo::doBar() has parameter $bars with generic class DeepInspectTypes\Bar but does not specify its types: T',
+				17,
+				MissingTypehintCheck::TURN_OFF_NON_GENERIC_CHECK_TIP,
+			],
+		]);
+	}
+
+	public function testDeepInspectTypes(): void
+	{
+		$this->deepInspectTypes = true;
+		$this->analyse([__DIR__ . '/data/deep-inspect-types.php'], [
+			[
+				'Method DeepInspectTypes\Foo::doFoo() has parameter $foo with no value type specified in iterable type iterable.',
+				11,
+				MissingTypehintCheck::TURN_OFF_MISSING_ITERABLE_VALUE_TYPE_TIP,
+			],
+			[
+				'Method DeepInspectTypes\Foo::doBar() has parameter $bars with generic class DeepInspectTypes\Bar but does not specify its types: T',
+				17,
+				MissingTypehintCheck::TURN_OFF_NON_GENERIC_CHECK_TIP,
+			],
+		]);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Methods/data/deep-inspect-types.php b/tests/PHPStan/Rules/Methods/data/deep-inspect-types.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace DeepInspectTypes;
+
+class Foo
+{
+
+	/**
+	 * @param array<iterable> $foo
+	 */
+	public function doFoo(array $foo): void
+	{
+
+	}
+
+	/** @param array<Bar> $bars */
+	public function doBar(array $bars): void
+	{
+
+	}
+
+}
+
+/** @template T */
+class Bar
+{
+
+}
