New RuleLevelHelper::accepts() behaviour only for bleedingEdge

Because the new behaviour behaves slightly differently - for example, arrays with nullable values might be reported sooner than level 8 if it's a constant array where one of the value types is null.
phpstan · Jan 28, 2023 · 941fc81 · 941fc81
1 parent c0ff269
commit 941fc81
Show file tree

Hide file tree

Showing 59 changed files with 202 additions and 57 deletions.
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -29,3 +29,4 @@ parameters:
 		disableUnreachableBranchesRules: true
 		varTagType: true
 		closureDefaultParameterTypeRule: true
+		newRuleLevelHelper: true
diff --git a/conf/config.neon b/conf/config.neon
@@ -59,6 +59,7 @@ parameters:
 		disableUnreachableBranchesRules: false
 		varTagType: false
 		closureDefaultParameterTypeRule: false
+		newRuleLevelHelper: false
 	fileExtensions:
 		- php
 	checkAdvancedIsset: false
@@ -284,6 +285,7 @@ parametersSchema:
 		disableUnreachableBranchesRules: bool()
 		varTagType: bool()
 		closureDefaultParameterTypeRule: bool()
+		newRuleLevelHelper: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAdvancedIsset: bool()
@@ -1104,6 +1106,7 @@ services:
 			checkUnionTypes: %checkUnionTypes%
 			checkExplicitMixed: %checkExplicitMixed%
 			checkImplicitMixed: %checkImplicitMixed%
+			newRuleLevelHelper: %featureToggles.newRuleLevelHelper%
 			checkBenevolentUnionTypes: %checkBenevolentUnionTypes%
 
 	-

diff --git a/src/Rules/RuleLevelHelper.php b/src/Rules/RuleLevelHelper.php
@@ -19,6 +19,7 @@
 use PHPStan\Type\TypeTraverser;
 use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
+use function array_merge;
 use function count;
 use function sprintf;
 use function strpos;
@@ -33,6 +34,7 @@ public function __construct(
 		private bool $checkUnionTypes,
 		private bool $checkExplicitMixed,
 		private bool $checkImplicitMixed,
+		private bool $newRuleLevelHelper,
 		private bool $checkBenevolentUnionTypes,
 	)
 	{
@@ -105,10 +107,148 @@ private function transformAcceptedType(Type $acceptingType, Type $acceptedType):
 
 	public function acceptsWithReason(Type $acceptingType, Type $acceptedType, bool $strictTypes): RuleLevelHelperAcceptsResult
 	{
-		[$acceptedType, $checkForUnion] = $this->transformAcceptedType($acceptingType, $acceptedType);
-		$acceptingType = $this->transformCommonType($acceptingType);
+		if ($this->newRuleLevelHelper) {
+			[$acceptedType, $checkForUnion] = $this->transformAcceptedType($acceptingType, $acceptedType);
+			$acceptingType = $this->transformCommonType($acceptingType);
+
+			$accepts = $acceptingType->acceptsWithReason($acceptedType, $strictTypes);
+
+			return new RuleLevelHelperAcceptsResult(
+				$checkForUnion ? $accepts->yes() : !$accepts->no(),
+				$accepts->reasons,
+			);
+		}
+
+		$checkForUnion = $this->checkUnionTypes;
+
+		if ($this->checkBenevolentUnionTypes) {
+			$traverse = static function (Type $type, callable $traverse) use (&$checkForUnion): Type {
+				if ($type instanceof BenevolentUnionType) {
+					$checkForUnion = true;
+					return new UnionType($type->getTypes());
+				}
+
+				return $traverse($type);
+			};
+
+			$acceptedType = TypeTraverser::map($acceptedType, $traverse);
+		}
+
+		if (
+			$this->checkExplicitMixed
+		) {
+			$traverse = static function (Type $type, callable $traverse): Type {
+				if ($type instanceof TemplateMixedType) {
+					return $type->toStrictMixedType();
+				}
+				if (
+					$type instanceof MixedType
+					&& $type->isExplicitMixed()
+				) {
+					return new StrictMixedType();
+				}
+
+				return $traverse($type);
+			};
+			$acceptingType = TypeTraverser::map($acceptingType, $traverse);
+			$acceptedType = TypeTraverser::map($acceptedType, $traverse);
+		}
+
+		if (
+			$this->checkImplicitMixed
+		) {
+			$traverse = static function (Type $type, callable $traverse): Type {
+				if ($type instanceof TemplateMixedType) {
+					return $type->toStrictMixedType();
+				}
+				if (
+					$type instanceof MixedType
+					&& !$type->isExplicitMixed()
+				) {
+					return new StrictMixedType();
+				}
+
+				return $traverse($type);
+			};
+			$acceptingType = TypeTraverser::map($acceptingType, $traverse);
+			$acceptedType = TypeTraverser::map($acceptedType, $traverse);
+		}
+
+		if (
+			!$this->checkNullables
+			&& !$acceptingType instanceof NullType
+			&& !$acceptedType instanceof NullType
+			&& !$acceptedType instanceof BenevolentUnionType
+		) {
+			$acceptedType = TypeCombinator::removeNull($acceptedType);
+		}
 
 		$accepts = $acceptingType->acceptsWithReason($acceptedType, $strictTypes);
+		if ($accepts->yes()) {
+			return new RuleLevelHelperAcceptsResult(true, $accepts->reasons);
+		}
+		if ($acceptingType instanceof UnionType) {
+			$reasons = [];
+			foreach ($acceptingType->getTypes() as $innerType) {
+				$accepts = self::acceptsWithReason($innerType, $acceptedType, $strictTypes);
+				if ($accepts->result) {
+					return $accepts;
+				}
+
+				$reasons = array_merge($reasons, $accepts->reasons);
+			}
+
+			return new RuleLevelHelperAcceptsResult(false, $reasons);
+		}
+
+		if (
+			$acceptedType->isArray()->yes()
+			&& $acceptingType->isArray()->yes()
+			&& (
+				$acceptedType->isConstantArray()->no()
+				|| !$acceptedType->isIterableAtLeastOnce()->no()
+			)
+			&& $acceptingType->isConstantArray()->no()
+		) {
+			if ($acceptingType->isIterableAtLeastOnce()->yes() && !$acceptedType->isIterableAtLeastOnce()->yes()) {
+				$verbosity = VerbosityLevel::getRecommendedLevelByType($acceptingType, $acceptedType);
+				return new RuleLevelHelperAcceptsResult(false, [
+					sprintf(
+						'%s %s empty.',
+						$acceptedType->describe($verbosity),
+						$acceptedType->isIterableAtLeastOnce()->no() ? 'is' : 'might be',
+					),
+				]);
+			}
+
+			if (
+				$acceptingType->isList()->yes()
+				&& !$acceptedType->isList()->yes()
+			) {
+				$report = $checkForUnion || $acceptedType->isList()->no();
+
+				if ($report) {
+					$verbosity = VerbosityLevel::getRecommendedLevelByType($acceptingType, $acceptedType);
+					return new RuleLevelHelperAcceptsResult(false, [
+						sprintf(
+							'%s %s a list.',
+							$acceptedType->describe($verbosity),
+							$acceptedType->isList()->no() ? 'is not' : 'might not be',
+						),
+					]);
+				}
+			}
+
+			return self::acceptsWithReason(
+				$acceptingType->getIterableKeyType(),
+				$acceptedType->getIterableKeyType(),
+				$strictTypes,
+			)->and(self::acceptsWithReason(
+				$acceptingType->getIterableValueType(),
+				$acceptedType->getIterableValueType(),
+				$strictTypes,
+			));
+		}
 
 		return new RuleLevelHelperAcceptsResult(
 			$checkForUnion ? $accepts->yes() : !$accepts->no(),

diff --git a/tests/PHPStan/Rules/Arrays/AppendedArrayItemTypeRuleTest.php b/tests/PHPStan/Rules/Arrays/AppendedArrayItemTypeRuleTest.php
@@ -17,7 +17,7 @@ protected function getRule(): Rule
 	{
 		return new AppendedArrayItemTypeRule(
 			new PropertyReflectionFinder(),
-			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false),
+			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Arrays/ArrayDestructuringRuleTest.php b/tests/PHPStan/Rules/Arrays/ArrayDestructuringRuleTest.php
@@ -17,7 +17,7 @@ class ArrayDestructuringRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false);
+		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false);
 
 		return new ArrayDestructuringRule(
 			$ruleLevelHelper,

diff --git a/tests/PHPStan/Rules/Arrays/ArrayUnpackingRuleTest.php b/tests/PHPStan/Rules/Arrays/ArrayUnpackingRuleTest.php
@@ -22,7 +22,7 @@ protected function getRule(): Rule
 	{
 		return new ArrayUnpackingRule(
 			self::getContainer()->getByType(PhpVersion::class),
-			new RuleLevelHelper($this->createReflectionProvider(), true, false, $this->checkUnions, false, false, $this->checkBenevolentUnions),
+			new RuleLevelHelper($this->createReflectionProvider(), true, false, $this->checkUnions, false, false, true, $this->checkBenevolentUnions),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Arrays/InvalidKeyInArrayDimFetchRuleTest.php b/tests/PHPStan/Rules/Arrays/InvalidKeyInArrayDimFetchRuleTest.php
@@ -14,7 +14,7 @@ class InvalidKeyInArrayDimFetchRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false);
+		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false);
 		return new InvalidKeyInArrayDimFetchRule($ruleLevelHelper, true);
 	}
 

diff --git a/tests/PHPStan/Rules/Arrays/IterableInForeachRuleTest.php b/tests/PHPStan/Rules/Arrays/IterableInForeachRuleTest.php
@@ -17,7 +17,7 @@ class IterableInForeachRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new IterableInForeachRule(new RuleLevelHelper($this->createReflectionProvider(), true, false, true, $this->checkExplicitMixed, false, false));
+		return new IterableInForeachRule(new RuleLevelHelper($this->createReflectionProvider(), true, false, true, $this->checkExplicitMixed, false, true, false));
 	}
 
 	public function testCheckWithMaybes(): void

diff --git a/tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRuleTest.php b/tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRuleTest.php
@@ -19,7 +19,7 @@ class NonexistentOffsetInArrayDimFetchRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, $this->checkExplicitMixed, false, false);
+		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, $this->checkExplicitMixed, false, true, false);
 
 		return new NonexistentOffsetInArrayDimFetchRule(
 			$ruleLevelHelper,

diff --git a/tests/PHPStan/Rules/Arrays/OffsetAccessAssignOpRuleTest.php b/tests/PHPStan/Rules/Arrays/OffsetAccessAssignOpRuleTest.php
@@ -17,7 +17,7 @@ class OffsetAccessAssignOpRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, $this->checkUnions, false, false, false);
+		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, $this->checkUnions, false, false, true, false);
 		return new OffsetAccessAssignOpRule($ruleLevelHelper);
 	}
 

diff --git a/tests/PHPStan/Rules/Arrays/OffsetAccessAssignmentRuleTest.php b/tests/PHPStan/Rules/Arrays/OffsetAccessAssignmentRuleTest.php
@@ -17,7 +17,7 @@ class OffsetAccessAssignmentRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, $this->checkUnionTypes, false, false, false);
+		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, $this->checkUnionTypes, false, false, true, false);
 		return new OffsetAccessAssignmentRule($ruleLevelHelper);
 	}
 

diff --git a/tests/PHPStan/Rules/Arrays/OffsetAccessValueAssignmentRuleTest.php b/tests/PHPStan/Rules/Arrays/OffsetAccessValueAssignmentRuleTest.php
@@ -15,7 +15,7 @@ class OffsetAccessValueAssignmentRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new OffsetAccessValueAssignmentRule(new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false));
+		return new OffsetAccessValueAssignmentRule(new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false));
 	}
 
 	public function testRule(): void

diff --git a/tests/PHPStan/Rules/Arrays/UnpackIterableInArrayRuleTest.php b/tests/PHPStan/Rules/Arrays/UnpackIterableInArrayRuleTest.php
@@ -15,7 +15,7 @@ class UnpackIterableInArrayRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new UnpackIterableInArrayRule(new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false));
+		return new UnpackIterableInArrayRule(new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false));
 	}
 
 	public function testRule(): void

diff --git a/tests/PHPStan/Rules/Cast/EchoRuleTest.php b/tests/PHPStan/Rules/Cast/EchoRuleTest.php
@@ -16,7 +16,7 @@ class EchoRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new EchoRule(
-			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false),
+			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Cast/InvalidCastRuleTest.php b/tests/PHPStan/Rules/Cast/InvalidCastRuleTest.php
@@ -16,7 +16,7 @@ class InvalidCastRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		$broker = $this->createReflectionProvider();
-		return new InvalidCastRule($broker, new RuleLevelHelper($broker, true, false, true, false, false, false));
+		return new InvalidCastRule($broker, new RuleLevelHelper($broker, true, false, true, false, false, true, false));
 	}
 
 	public function testRule(): void

diff --git a/tests/PHPStan/Rules/Cast/InvalidPartOfEncapsedStringRuleTest.php b/tests/PHPStan/Rules/Cast/InvalidPartOfEncapsedStringRuleTest.php
@@ -19,7 +19,7 @@ protected function getRule(): Rule
 	{
 		return new InvalidPartOfEncapsedStringRule(
 			new ExprPrinter(new Printer()),
-			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false),
+			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Cast/PrintRuleTest.php b/tests/PHPStan/Rules/Cast/PrintRuleTest.php
@@ -16,7 +16,7 @@ class PrintRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		return new PrintRule(
-			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, false),
+			new RuleLevelHelper($this->createReflectionProvider(), true, false, true, false, false, true, false),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Classes/ClassAttributesRuleTest.php b/tests/PHPStan/Rules/Classes/ClassAttributesRuleTest.php
@@ -27,7 +27,7 @@ protected function getRule(): Rule
 			new AttributesCheck(
 				$reflectionProvider,
 				new FunctionCallParametersCheck(
-					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, false),
+					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, true, false),
 					new NullsafeCheck(),
 					new PhpVersion(80000),
 					new UnresolvableTypeHelper(),

diff --git a/tests/PHPStan/Rules/Classes/ClassConstantAttributesRuleTest.php b/tests/PHPStan/Rules/Classes/ClassConstantAttributesRuleTest.php
@@ -26,7 +26,7 @@ protected function getRule(): Rule
 			new AttributesCheck(
 				$reflectionProvider,
 				new FunctionCallParametersCheck(
-					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, false),
+					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, true, false),
 					new NullsafeCheck(),
 					new PhpVersion(80000),
 					new UnresolvableTypeHelper(),

diff --git a/tests/PHPStan/Rules/Classes/ClassConstantRuleTest.php b/tests/PHPStan/Rules/Classes/ClassConstantRuleTest.php
@@ -20,7 +20,7 @@ class ClassConstantRuleTest extends RuleTestCase
 	protected function getRule(): Rule
 	{
 		$broker = $this->createReflectionProvider();
-		return new ClassConstantRule($broker, new RuleLevelHelper($broker, true, false, true, false, false, false), new ClassCaseSensitivityCheck($broker, true), new PhpVersion($this->phpVersion));
+		return new ClassConstantRule($broker, new RuleLevelHelper($broker, true, false, true, false, false, true, false), new ClassCaseSensitivityCheck($broker, true), new PhpVersion($this->phpVersion));
 	}
 
 	public function testClassConstant(): void

diff --git a/tests/PHPStan/Rules/Classes/InstantiationRuleTest.php b/tests/PHPStan/Rules/Classes/InstantiationRuleTest.php
@@ -24,7 +24,7 @@ protected function getRule(): Rule
 		$broker = $this->createReflectionProvider();
 		return new InstantiationRule(
 			$broker,
-			new FunctionCallParametersCheck(new RuleLevelHelper($broker, true, false, true, false, false, false), new NullsafeCheck(), new PhpVersion(80000), new UnresolvableTypeHelper(), new PropertyReflectionFinder(), true, true, true, true, true),
+			new FunctionCallParametersCheck(new RuleLevelHelper($broker, true, false, true, false, false, true, false), new NullsafeCheck(), new PhpVersion(80000), new UnresolvableTypeHelper(), new PropertyReflectionFinder(), true, true, true, true, true),
 			new ClassCaseSensitivityCheck($broker, true),
 		);
 	}

diff --git a/tests/PHPStan/Rules/EnumCases/EnumCaseAttributesRuleTest.php b/tests/PHPStan/Rules/EnumCases/EnumCaseAttributesRuleTest.php
@@ -26,7 +26,7 @@ protected function getRule(): Rule
 			new AttributesCheck(
 				$reflectionProvider,
 				new FunctionCallParametersCheck(
-					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, false),
+					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, true, false),
 					new NullsafeCheck(),
 					new PhpVersion(80100),
 					new UnresolvableTypeHelper(),

diff --git a/tests/PHPStan/Rules/Functions/ArrowFunctionAttributesRuleTest.php b/tests/PHPStan/Rules/Functions/ArrowFunctionAttributesRuleTest.php
@@ -26,7 +26,7 @@ protected function getRule(): Rule
 			new AttributesCheck(
 				$reflectionProvider,
 				new FunctionCallParametersCheck(
-					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, false),
+					new RuleLevelHelper($reflectionProvider, true, false, true, false, false, true, false),
 					new NullsafeCheck(),
 					new PhpVersion(80000),
 					new UnresolvableTypeHelper(),

diff --git a/tests/PHPStan/Rules/Functions/ArrowFunctionReturnTypeRuleTest.php b/tests/PHPStan/Rules/Functions/ArrowFunctionReturnTypeRuleTest.php
@@ -23,6 +23,7 @@ protected function getRule(): Rule
 			true,
 			false,
 			false,
+			true,
 			false,
 		)));
 	}

diff --git a/tests/PHPStan/Rules/Functions/CallCallablesRuleTest.php b/tests/PHPStan/Rules/Functions/CallCallablesRuleTest.php
@@ -22,7 +22,7 @@ class CallCallablesRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, $this->checkExplicitMixed, false, false);
+		$ruleLevelHelper = new RuleLevelHelper($this->createReflectionProvider(), true, false, true, $this->checkExplicitMixed, false, true, false);
 		return new CallCallablesRule(
 			new FunctionCallParametersCheck(
 				$ruleLevelHelper,