[BE] Improve impossible type checker for void-returning functions

ondrejmirtes · ondrejmirtes · commit bc86dcc1f83d · 2024-09-23T16:01:27.000+02:00
diff --git a/changelog-2.0.md b/changelog-2.0.md
@@ -126,6 +126,7 @@ Improvements 🔧
 * Check mixed in unary operator ([#3253](https://github.com/phpstan/phpstan-src/pull/3253)), thanks @schlndh!
 * Stub files validation - detect duplicate classes and functions (https://github.com/phpstan/phpstan-src/commit/ddf8d5c3859c2c75c20f525a0e2ca8b99032373a, https://github.com/phpstan/phpstan-src/commit/17e4b74335e5235d7cd6708eb687a774a0eeead4)
 * NoopRule - take advantage of impure points (https://github.com/phpstan/phpstan-src/commit/a6470521b65d7424f552633c1f3827704c6262c3), #10389
+* Improve impossible type checker for void-returning functions ([#1857](https://github.com/phpstan/phpstan-src/pull/1857)), #8169, thanks @rvanvelzen!
 
 Bugfixes 🐛
 =====================
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -16,7 +16,6 @@ parameters:
 		runtimeReflectionRules: true
 		curlSetOptTypes: true
 		missingMagicSerializationRule: true
-		nullContextForVoidReturningFunctions: true
 		alwaysCheckTooWideReturnTypeFinalMethods: true
 		alwaysTrueAlwaysReported: true
 		disableUnreachableBranchesRules: true
diff --git a/conf/config.neon b/conf/config.neon
@@ -37,7 +37,6 @@ parameters:
 		runtimeReflectionRules: false
 		curlSetOptTypes: false
 		missingMagicSerializationRule: false
-		nullContextForVoidReturningFunctions: false
 		alwaysCheckTooWideReturnTypeFinalMethods: false
 		alwaysTrueAlwaysReported: false
 		disableUnreachableBranchesRules: false
@@ -895,7 +894,6 @@ services:
 		arguments:
 			universalObjectCratesClasses: %universalObjectCratesClasses%
 			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%
-			nullContextForVoidReturningFunctions: %featureToggles.nullContextForVoidReturningFunctions%
 
 	-
 		class: PHPStan\Rules\Exceptions\DefaultExceptionTypeResolver
@@ -1792,7 +1790,6 @@ services:
 		arguments:
 			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%
 			universalObjectCratesClasses: %universalObjectCratesClasses%
-			nullContextForVoidReturningFunctions: %featureToggles.nullContextForVoidReturningFunctions%
 		tags:
 			- phpstan.broker.dynamicFunctionReturnTypeExtension
 
diff --git a/conf/parametersSchema.neon b/conf/parametersSchema.neon
@@ -43,7 +43,6 @@ parametersSchema:
 		runtimeReflectionRules: bool()
 		curlSetOptTypes: bool()
 		missingMagicSerializationRule: bool()
-		nullContextForVoidReturningFunctions: bool()
 		alwaysCheckTooWideReturnTypeFinalMethods: bool()
 		alwaysTrueAlwaysReported: bool()
 		disableUnreachableBranchesRules: bool()
diff --git a/src/Rules/Comparison/ImpossibleCheckTypeHelper.php b/src/Rules/Comparison/ImpossibleCheckTypeHelper.php
@@ -48,7 +48,6 @@ public function __construct(
 		private TypeSpecifier $typeSpecifier,
 		private array $universalObjectCratesClasses,
 		private bool $treatPhpDocTypesAsCertain,
-		private bool $nullContextForVoidReturningFunctions,
 	)
 	{
 	}
@@ -369,16 +368,11 @@ public function doNotTreatPhpDocTypesAsCertain(): self
 			$this->typeSpecifier,
 			$this->universalObjectCratesClasses,
 			false,
-			$this->nullContextForVoidReturningFunctions,
 		);
 	}
 
 	private function determineContext(Scope $scope, Expr $node): TypeSpecifierContext
 	{
-		if (!$this->nullContextForVoidReturningFunctions) {
-			return TypeSpecifierContext::createTruthy();
-		}
-
 		if ($node instanceof Expr\CallLike && $node->isFirstClassCallable()) {
 			return TypeSpecifierContext::createTruthy();
 		}
diff --git a/src/Type/Php/TypeSpecifyingFunctionsDynamicReturnTypeExtension.php b/src/Type/Php/TypeSpecifyingFunctionsDynamicReturnTypeExtension.php
@@ -25,7 +25,7 @@ final class TypeSpecifyingFunctionsDynamicReturnTypeExtension implements Dynamic
 	/**
 	 * @param string[] $universalObjectCratesClasses
 	 */
-	public function __construct(private ReflectionProvider $reflectionProvider, private bool $treatPhpDocTypesAsCertain, private array $universalObjectCratesClasses, private bool $nullContextForVoidReturningFunctions)
+	public function __construct(private ReflectionProvider $reflectionProvider, private bool $treatPhpDocTypesAsCertain, private array $universalObjectCratesClasses)
 	{
 	}
 
@@ -68,7 +68,7 @@ public function getTypeFromFunctionCall(
 	private function getHelper(): ImpossibleCheckTypeHelper
 	{
 		if ($this->helper === null) {
-			$this->helper = new ImpossibleCheckTypeHelper($this->reflectionProvider, $this->typeSpecifier, $this->universalObjectCratesClasses, $this->treatPhpDocTypesAsCertain, $this->nullContextForVoidReturningFunctions);
+			$this->helper = new ImpossibleCheckTypeHelper($this->reflectionProvider, $this->typeSpecifier, $this->universalObjectCratesClasses, $this->treatPhpDocTypesAsCertain);
 		}
 
 		return $this->helper;
diff --git a/tests/PHPStan/Rules/Comparison/BooleanAndConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/BooleanAndConstantConditionRuleTest.php
@@ -24,7 +24,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/BooleanNotConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/BooleanNotConstantConditionRuleTest.php
@@ -24,7 +24,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/BooleanOrConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/BooleanOrConstantConditionRuleTest.php
@@ -25,7 +25,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/DoWhileLoopConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/DoWhileLoopConstantConditionRuleTest.php
@@ -22,7 +22,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/ElseIfConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/ElseIfConstantConditionRuleTest.php
@@ -25,7 +25,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/IfConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/IfConstantConditionRuleTest.php
@@ -23,7 +23,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeFunctionCallRuleTest.php b/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeFunctionCallRuleTest.php
@@ -31,7 +31,6 @@ protected function getRule(): Rule
 				$this->getTypeSpecifier(),
 				[stdClass::class],
 				$this->treatPhpDocTypesAsCertain,
-				true,
 			),
 			$this->checkAlwaysTrueCheckTypeFunctionCall,
 			$this->treatPhpDocTypesAsCertain,
diff --git a/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeGenericOverwriteRuleTest.php b/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeGenericOverwriteRuleTest.php
@@ -19,7 +19,6 @@ public function getRule(): Rule
 				$this->getTypeSpecifier(),
 				[],
 				true,
-				true,
 			),
 			true,
 			true,
diff --git a/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeMethodCallRuleEqualsTest.php b/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeMethodCallRuleEqualsTest.php
@@ -19,7 +19,6 @@ public function getRule(): Rule
 				$this->getTypeSpecifier(),
 				[],
 				true,
-				true,
 			),
 			true,
 			true,
diff --git a/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeMethodCallRuleTest.php b/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeMethodCallRuleTest.php
@@ -24,7 +24,6 @@ public function getRule(): Rule
 				$this->getTypeSpecifier(),
 				[],
 				$this->treatPhpDocTypesAsCertain,
-				true,
 			),
 			true,
 			$this->treatPhpDocTypesAsCertain,
diff --git a/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeStaticMethodCallRuleTest.php b/tests/PHPStan/Rules/Comparison/ImpossibleCheckTypeStaticMethodCallRuleTest.php
@@ -23,7 +23,6 @@ public function getRule(): Rule
 				$this->getTypeSpecifier(),
 				[],
 				$this->treatPhpDocTypesAsCertain,
-				true,
 			),
 			true,
 			$this->treatPhpDocTypesAsCertain,
diff --git a/tests/PHPStan/Rules/Comparison/LogicalXorConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/LogicalXorConstantConditionRuleTest.php
@@ -24,7 +24,6 @@ protected function getRule(): TRule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/MatchExpressionRuleTest.php b/tests/PHPStan/Rules/Comparison/MatchExpressionRuleTest.php
@@ -27,7 +27,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/TernaryOperatorConstantConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/TernaryOperatorConstantConditionRuleTest.php
@@ -22,7 +22,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/UnreachableIfBranchesRuleTest.php b/tests/PHPStan/Rules/Comparison/UnreachableIfBranchesRuleTest.php
@@ -22,7 +22,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/UnreachableTernaryElseBranchRuleTest.php b/tests/PHPStan/Rules/Comparison/UnreachableTernaryElseBranchRuleTest.php
@@ -22,7 +22,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/WhileLoopAlwaysFalseConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/WhileLoopAlwaysFalseConditionRuleTest.php
@@ -22,7 +22,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,
diff --git a/tests/PHPStan/Rules/Comparison/WhileLoopAlwaysTrueConditionRuleTest.php b/tests/PHPStan/Rules/Comparison/WhileLoopAlwaysTrueConditionRuleTest.php
@@ -22,7 +22,6 @@ protected function getRule(): Rule
 					$this->getTypeSpecifier(),
 					[],
 					$this->treatPhpDocTypesAsCertain,
-					true,
 				),
 				$this->treatPhpDocTypesAsCertain,
 				true,

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,6 @@ public function __construct(`
`48`	`48`	`private TypeSpecifier $typeSpecifier,`
`49`	`49`	`private array $universalObjectCratesClasses,`
`50`	`50`	`private bool $treatPhpDocTypesAsCertain,`
`51`		`- private bool $nullContextForVoidReturningFunctions,`
`52`	`51`	`)`
`53`	`52`	`{`
`54`	`53`	`}`
`@@ -369,16 +368,11 @@ public function doNotTreatPhpDocTypesAsCertain(): self`
`369`	`368`	`$this->typeSpecifier,`
`370`	`369`	`$this->universalObjectCratesClasses,`
`371`	`370`	`false,`
`372`		`- $this->nullContextForVoidReturningFunctions,`
`373`	`371`	`);`
`374`	`372`	`}`
`375`	`373`
`376`	`374`	`private function determineContext(Scope $scope, Expr $node): TypeSpecifierContext`
`377`	`375`	`{`
`378`		`- if (!$this->nullContextForVoidReturningFunctions) {`
`379`		`- return TypeSpecifierContext::createTruthy();`
`380`		`- }`
`381`		`-`
`382`	`376`	`if ($node instanceof Expr\CallLike && $node->isFirstClassCallable()) {`
`383`	`377`	`return TypeSpecifierContext::createTruthy();`
`384`	`378`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ final class TypeSpecifyingFunctionsDynamicReturnTypeExtension implements Dynamic`
`25`	`25`	`/**`
`26`	`26`	`* @param string[] $universalObjectCratesClasses`
`27`	`27`	`*/`
`28`		`- public function __construct(private ReflectionProvider $reflectionProvider, private bool $treatPhpDocTypesAsCertain, private array $universalObjectCratesClasses, private bool $nullContextForVoidReturningFunctions)`
	`28`	`+ public function __construct(private ReflectionProvider $reflectionProvider, private bool $treatPhpDocTypesAsCertain, private array $universalObjectCratesClasses)`
`29`	`29`	`{`
`30`	`30`	`}`
`31`	`31`
`@@ -68,7 +68,7 @@ public function getTypeFromFunctionCall(`
`68`	`68`	`private function getHelper(): ImpossibleCheckTypeHelper`
`69`	`69`	`{`
`70`	`70`	`if ($this->helper === null) {`
`71`		`- $this->helper = new ImpossibleCheckTypeHelper($this->reflectionProvider, $this->typeSpecifier, $this->universalObjectCratesClasses, $this->treatPhpDocTypesAsCertain, $this->nullContextForVoidReturningFunctions);`
	`71`	`+ $this->helper = new ImpossibleCheckTypeHelper($this->reflectionProvider, $this->typeSpecifier, $this->universalObjectCratesClasses, $this->treatPhpDocTypesAsCertain);`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`return $this->helper;`