Separate feature toggle for reportNestedTooWideType, turned off temporarily

ondrejmirtes · ondrejmirtes · commit 1611a884837d · 2025-09-25T08:29:40.000+02:00
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -12,3 +12,4 @@ parameters:
 		checkExtensionsForComparisonOperators: true
 		reportTooWideBool: true
 		rawMessageInBaseline: true
+		reportNestedTooWideType: false
diff --git a/conf/config.neon b/conf/config.neon
@@ -36,6 +36,7 @@ parameters:
 		checkExtensionsForComparisonOperators: false
 		reportTooWideBool: false
 		rawMessageInBaseline: false
+		reportNestedTooWideType: false
 	fileExtensions:
 		- php
 	checkAdvancedIsset: false
diff --git a/conf/parametersSchema.neon b/conf/parametersSchema.neon
@@ -39,6 +39,7 @@ parametersSchema:
 		checkExtensionsForComparisonOperators: bool()
 		reportTooWideBool: bool()
 		rawMessageInBaseline: bool()
+		reportNestedTooWideType: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAdvancedIsset: bool()
diff --git a/src/Rules/TooWideTypehints/TooWideTypeCheck.php b/src/Rules/TooWideTypehints/TooWideTypeCheck.php
@@ -36,6 +36,8 @@ public function __construct(
 		private PropertyReflectionFinder $propertyReflectionFinder,
 		#[AutowiredParameter(ref: '%featureToggles.reportTooWideBool%')]
 		private bool $reportTooWideBool,
+		#[AutowiredParameter(ref: '%featureToggles.reportNestedTooWideType%')]
+		private bool $reportNestedTooWideType,
 	)
 	{
 	}
@@ -105,7 +107,7 @@ public function checkProperty(
 				);
 			}
 
-			if (!$this->reportTooWideBool) {
+			if (!$this->reportNestedTooWideType) {
 				return [];
 			}
 
@@ -227,7 +229,7 @@ public function checkFunctionReturnType(
 				);
 			}
 
-			if (!$this->reportTooWideBool) {
+			if (!$this->reportNestedTooWideType) {
 				return [];
 			}
 
@@ -290,7 +292,7 @@ public function checkParameterOutType(
 		$parameterOutType = TypeUtils::resolveLateResolvableTypes($parameterOutType);
 		$narrowedType = $this->narrowType($parameterOutType, $actualVariableType, $scope, false, false);
 		if ($narrowedType->equals($parameterOutType)) {
-			if (!$this->reportTooWideBool) {
+			if (!$this->reportNestedTooWideType) {
 				return [];
 			}
 
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideArrowFunctionReturnTypehintRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideArrowFunctionReturnTypehintRuleTest.php
@@ -15,7 +15,7 @@ class TooWideArrowFunctionReturnTypehintRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new TooWideArrowFunctionReturnTypehintRule(
-			new TooWideTypeCheck(new PropertyReflectionFinder(), true),
+			new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),
 		);
 	}
 
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideClosureReturnTypehintRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideClosureReturnTypehintRuleTest.php
@@ -15,7 +15,7 @@ class TooWideClosureReturnTypehintRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new TooWideClosureReturnTypehintRule(
-			new TooWideTypeCheck(new PropertyReflectionFinder(), true),
+			new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),
 		);
 	}
 
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideFunctionParameterOutTypeRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideFunctionParameterOutTypeRuleTest.php
@@ -15,7 +15,7 @@ class TooWideFunctionParameterOutTypeRuleTest extends RuleTestCase
 	protected function getRule(): TRule
 	{
 		return new TooWideFunctionParameterOutTypeRule(new TooWideParameterOutTypeCheck(
-			new TooWideTypeCheck(new PropertyReflectionFinder(), true),
+			new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),
 		));
 	}
 
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRuleTest.php
@@ -15,9 +15,11 @@ class TooWideFunctionReturnTypehintRuleTest extends RuleTestCase
 
 	private bool $reportTooWideBool = false;
 
+	private bool $reportNestedTooWideType = false;
+
 	protected function getRule(): Rule
 	{
-		return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool));
+		return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool, $this->reportNestedTooWideType));
 	}
 
 	public function testRule(): void
@@ -74,6 +76,7 @@ public function testBug10312a(): void
 	public function testBug13384cPhp82(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384c.php'], [
 			[
 				'Function Bug13384c\doFoo() never returns true so the return type can be changed to false.',
@@ -98,6 +101,7 @@ public function testBug13384cPhp82(): void
 	public function testBug13384cPrePhp82(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384c.php'], [
 			[
 				'Function Bug13384c\doFooPhpdoc() never returns false so the return type can be changed to true.',
@@ -118,6 +122,7 @@ public function testBug13384cOff(): void
 	public function testNestedTooWideType(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/nested-too-wide-function-return-type.php'], [
 			[
 				'Return type array<array{int, bool}> of function NestedTooWideFunctionReturnType\dataProvider() can be narrowed to array<array{int, false}>.',
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideMethodParameterOutTypeRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideMethodParameterOutTypeRuleTest.php
@@ -18,7 +18,7 @@ protected function getRule(): TRule
 	{
 		return new TooWideMethodParameterOutTypeRule(
 			new TooWideParameterOutTypeCheck(
-				new TooWideTypeCheck(new PropertyReflectionFinder(), true),
+				new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),
 			),
 			$this->checkProtectedAndPublicMethods,
 		);
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideMethodReturnTypehintRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideMethodReturnTypehintRuleTest.php
@@ -18,9 +18,11 @@ class TooWideMethodReturnTypehintRuleTest extends RuleTestCase
 
 	private bool $reportTooWideBool = false;
 
+	private bool $reportNestedTooWideType = false;
+
 	protected function getRule(): Rule
 	{
-		return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool));
+		return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool, $this->reportNestedTooWideType));
 	}
 
 	public function testPrivate(): void
@@ -227,6 +229,7 @@ public function testBug10312d(): void
 	public function testBug13384c(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384c.php'], [
 			[
 				'Method Bug13384c\Bug13384c::doBar() never returns true so the return type can be changed to false.',
@@ -259,6 +262,7 @@ public function testBug13384c(): void
 	public function testBug13384cPrePhp82(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384c.php'], [
 			[
 				'Method Bug13384c\Bug13384c::doBarPhpdoc() never returns false so the return type can be changed to true.',
@@ -279,6 +283,7 @@ public function testBug13384cOff(): void
 	public function testNestedTooWideType(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/nested-too-wide-method-return-type.php'], [
 			[
 				'Return type array<array{int, bool}> of method NestedTooWideMethodReturnType\Foo::dataProvider() can be narrowed to array<array{int, false}>.',
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWidePropertyTypeRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWidePropertyTypeRuleTest.php
@@ -16,11 +16,13 @@ class TooWidePropertyTypeRuleTest extends RuleTestCase
 
 	private bool $reportTooWideBool = false;
 
+	private bool $reportNestedTooWideType = false;
+
 	protected function getRule(): Rule
 	{
 		return new TooWidePropertyTypeRule(
 			new DirectReadWritePropertiesExtensionProvider([]),
-			new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool),
+			new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool, $this->reportNestedTooWideType),
 		);
 	}
 
@@ -64,6 +66,7 @@ public function testBug11667(): void
 	public function testBug13384(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384.php'], [
 			[
 				'Static property Bug13384\ShutdownHandlerFalseDefault::$registered (bool) is never assigned true so the property type can be changed to false.',
@@ -80,12 +83,14 @@ public function testBug13384(): void
 	public function testBug13384PrePhp82(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384.php'], []);
 	}
 
 	public function testBug13384Phpdoc(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384-phpdoc.php'], [
 			[
 				'Static property Bug13384Phpdoc\ShutdownHandlerPhpdocTypes::$registered (bool) is never assigned true so the property type can be changed to false.',
@@ -97,6 +102,7 @@ public function testBug13384Phpdoc(): void
 	public function testBug13384b(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-13384b.php'], []);
 	}
 
@@ -108,12 +114,14 @@ public function testBug13384bOff(): void
 	public function testBugPR4318(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/bug-pr-4318.php'], []);
 	}
 
 	public function testNestedTooWideType(): void
 	{
 		$this->reportTooWideBool = true;
+		$this->reportNestedTooWideType = true;
 		$this->analyse([__DIR__ . '/data/nested-too-wide-property-type.php'], [
 			[
 				'Type array<array{int, bool}> of property NestedTooWidePropertyType\Foo::$a can be narrowed to array<array{int, false}>.',

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@ public function __construct(`
`36`	`36`	`private PropertyReflectionFinder $propertyReflectionFinder,`
`37`	`37`	`#[AutowiredParameter(ref: '%featureToggles.reportTooWideBool%')]`
`38`	`38`	`private bool $reportTooWideBool,`
	`39`	`+ #[AutowiredParameter(ref: '%featureToggles.reportNestedTooWideType%')]`
	`40`	`+ private bool $reportNestedTooWideType,`
`39`	`41`	`)`
`40`	`42`	`{`
`41`	`43`	`}`
`@@ -105,7 +107,7 @@ public function checkProperty(`
`105`	`107`	`);`
`106`	`108`	`}`
`107`	`109`
`108`		`- if (!$this->reportTooWideBool) {`
	`110`	`+ if (!$this->reportNestedTooWideType) {`
`109`	`111`	`return [];`
`110`	`112`	`}`
`111`	`113`
`@@ -227,7 +229,7 @@ public function checkFunctionReturnType(`
`227`	`229`	`);`
`228`	`230`	`}`
`229`	`231`
`230`		`- if (!$this->reportTooWideBool) {`
	`232`	`+ if (!$this->reportNestedTooWideType) {`
`231`	`233`	`return [];`
`232`	`234`	`}`
`233`	`235`
`@@ -290,7 +292,7 @@ public function checkParameterOutType(`
`290`	`292`	`$parameterOutType = TypeUtils::resolveLateResolvableTypes($parameterOutType);`
`291`	`293`	`$narrowedType = $this->narrowType($parameterOutType, $actualVariableType, $scope, false, false);`
`292`	`294`	`if ($narrowedType->equals($parameterOutType)) {`
`293`		`- if (!$this->reportTooWideBool) {`
	`295`	`+ if (!$this->reportNestedTooWideType) {`
`294`	`296`	`return [];`
`295`	`297`	`}`
`296`	`298`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class TooWideArrowFunctionReturnTypehintRuleTest extends RuleTestCase`
`15`	`15`	`protected function getRule(): Rule`
`16`	`16`	`{`
`17`	`17`	`return new TooWideArrowFunctionReturnTypehintRule(`
`18`		`- new TooWideTypeCheck(new PropertyReflectionFinder(), true),`
	`18`	`+ new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),`
`19`	`19`	`);`
`20`	`20`	`}`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class TooWideClosureReturnTypehintRuleTest extends RuleTestCase`
`15`	`15`	`protected function getRule(): Rule`
`16`	`16`	`{`
`17`	`17`	`return new TooWideClosureReturnTypehintRule(`
`18`		`- new TooWideTypeCheck(new PropertyReflectionFinder(), true),`
	`18`	`+ new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),`
`19`	`19`	`);`
`20`	`20`	`}`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class TooWideFunctionParameterOutTypeRuleTest extends RuleTestCase`
`15`	`15`	`protected function getRule(): TRule`
`16`	`16`	`{`
`17`	`17`	`return new TooWideFunctionParameterOutTypeRule(new TooWideParameterOutTypeCheck(`
`18`		`- new TooWideTypeCheck(new PropertyReflectionFinder(), true),`
	`18`	`+ new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),`
`19`	`19`	`));`
`20`	`20`	`}`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,11 @@ class TooWideFunctionReturnTypehintRuleTest extends RuleTestCase`
`15`	`15`
`16`	`16`	`private bool $reportTooWideBool = false;`
`17`	`17`
	`18`	`+ private bool $reportNestedTooWideType = false;`
	`19`	`+`
`18`	`20`	`protected function getRule(): Rule`
`19`	`21`	`{`
`20`		`- return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool));`
	`22`	`+ return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool, $this->reportNestedTooWideType));`
`21`	`23`	`}`
`22`	`24`
`23`	`25`	`public function testRule(): void`
`@@ -74,6 +76,7 @@ public function testBug10312a(): void`
`74`	`76`	`public function testBug13384cPhp82(): void`
`75`	`77`	`{`
`76`	`78`	`$this->reportTooWideBool = true;`
	`79`	`+ $this->reportNestedTooWideType = true;`
`77`	`80`	`$this->analyse([__DIR__ . '/data/bug-13384c.php'], [`
`78`	`81`	`[`
`79`	`82`	`'Function Bug13384c\doFoo() never returns true so the return type can be changed to false.',`
`@@ -98,6 +101,7 @@ public function testBug13384cPhp82(): void`
`98`	`101`	`public function testBug13384cPrePhp82(): void`
`99`	`102`	`{`
`100`	`103`	`$this->reportTooWideBool = true;`
	`104`	`+ $this->reportNestedTooWideType = true;`
`101`	`105`	`$this->analyse([__DIR__ . '/data/bug-13384c.php'], [`
`102`	`106`	`[`
`103`	`107`	`'Function Bug13384c\doFooPhpdoc() never returns false so the return type can be changed to true.',`
`@@ -118,6 +122,7 @@ public function testBug13384cOff(): void`
`118`	`122`	`public function testNestedTooWideType(): void`
`119`	`123`	`{`
`120`	`124`	`$this->reportTooWideBool = true;`
	`125`	`+ $this->reportNestedTooWideType = true;`
`121`	`126`	`$this->analyse([__DIR__ . '/data/nested-too-wide-function-return-type.php'], [`
`122`	`127`	`[`
`123`	`128`	`'Return type array<array{int, bool}> of function NestedTooWideFunctionReturnType\dataProvider() can be narrowed to array<array{int, false}>.',`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ protected function getRule(): TRule`
`18`	`18`	`{`
`19`	`19`	`return new TooWideMethodParameterOutTypeRule(`
`20`	`20`	`new TooWideParameterOutTypeCheck(`
`21`		`- new TooWideTypeCheck(new PropertyReflectionFinder(), true),`
	`21`	`+ new TooWideTypeCheck(new PropertyReflectionFinder(), true, true),`
`22`	`22`	`),`
`23`	`23`	`$this->checkProtectedAndPublicMethods,`
`24`	`24`	`);`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,11 @@ class TooWideMethodReturnTypehintRuleTest extends RuleTestCase`
`18`	`18`
`19`	`19`	`private bool $reportTooWideBool = false;`
`20`	`20`
	`21`	`+ private bool $reportNestedTooWideType = false;`
	`22`	`+`
`21`	`23`	`protected function getRule(): Rule`
`22`	`24`	`{`
`23`		`- return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool));`
	`25`	`+ return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck(new PropertyReflectionFinder(), $this->reportTooWideBool, $this->reportNestedTooWideType));`
`24`	`26`	`}`
`25`	`27`
`26`	`28`	`public function testPrivate(): void`
`@@ -227,6 +229,7 @@ public function testBug10312d(): void`
`227`	`229`	`public function testBug13384c(): void`
`228`	`230`	`{`
`229`	`231`	`$this->reportTooWideBool = true;`
	`232`	`+ $this->reportNestedTooWideType = true;`
`230`	`233`	`$this->analyse([__DIR__ . '/data/bug-13384c.php'], [`
`231`	`234`	`[`
`232`	`235`	`'Method Bug13384c\Bug13384c::doBar() never returns true so the return type can be changed to false.',`
`@@ -259,6 +262,7 @@ public function testBug13384c(): void`
`259`	`262`	`public function testBug13384cPrePhp82(): void`
`260`	`263`	`{`
`261`	`264`	`$this->reportTooWideBool = true;`
	`265`	`+ $this->reportNestedTooWideType = true;`
`262`	`266`	`$this->analyse([__DIR__ . '/data/bug-13384c.php'], [`
`263`	`267`	`[`
`264`	`268`	`'Method Bug13384c\Bug13384c::doBarPhpdoc() never returns false so the return type can be changed to true.',`
`@@ -279,6 +283,7 @@ public function testBug13384cOff(): void`
`279`	`283`	`public function testNestedTooWideType(): void`
`280`	`284`	`{`
`281`	`285`	`$this->reportTooWideBool = true;`
	`286`	`+ $this->reportNestedTooWideType = true;`
`282`	`287`	`$this->analyse([__DIR__ . '/data/nested-too-wide-method-return-type.php'], [`
`283`	`288`	`[`
`284`	`289`	`'Return type array<array{int, bool}> of method NestedTooWideMethodReturnType\Foo::dataProvider() can be narrowed to array<array{int, false}>.',`