Skip to content

Commit 34bacd7

Browse files
ondrejmirtesondrejmirtes
committed
Show TypeResult reasons in StrictComparisonOfDifferentTypesRule
1 parent a815d57 commit 34bacd7

11 files changed

+173
-50
lines changed

‎conf/config.neon

+3
Original file line numberDiff line numberDiff line change
@@ -582,6 +582,9 @@ services:
582582
arguments:
583583
cacheFilePath: %resultCachePath%
584584

585+
-
586+
class: PHPStan\Analyser\RicherScopeGetTypeHelper
587+
585588
-
586589
class: PHPStan\Cache\Cache
587590
arguments:

‎src/Analyser/DirectInternalScopeFactory.php

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ public function __construct(
3434
private PropertyReflectionFinder $propertyReflectionFinder,
3535
private Parser $parser,
3636
private NodeScopeResolver $nodeScopeResolver,
37+
private RicherScopeGetTypeHelper $richerScopeGetTypeHelper,
3738
private PhpVersion $phpVersion,
3839
private bool $explicitMixedInUnknownGenericNew,
3940
private bool $explicitMixedForGlobalVariables,
@@ -85,6 +86,7 @@ public function create(
8586
$this->propertyReflectionFinder,
8687
$this->parser,
8788
$this->nodeScopeResolver,
89+
$this->richerScopeGetTypeHelper,
8890
$this->constantResolver,
8991
$context,
9092
$this->phpVersion,

‎src/Analyser/LazyInternalScopeFactory.php

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ public function create(
7979
$this->container->getByType(PropertyReflectionFinder::class),
8080
$this->container->getService('currentPhpVersionSimpleParser'),
8181
$this->container->getByType(NodeScopeResolver::class),
82+
$this->container->getByType(RicherScopeGetTypeHelper::class),
8283
$this->container->getByType(ConstantResolver::class),
8384
$context,
8485
$this->container->getByType(PhpVersion::class),

‎src/Analyser/MutatingScope.php

+4-38
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ public function __construct(
204204
private PropertyReflectionFinder $propertyReflectionFinder,
205205
private Parser $parser,
206206
private NodeScopeResolver $nodeScopeResolver,
207+
private RicherScopeGetTypeHelper $richerScopeGetTypeHelper,
207208
private ConstantResolver $constantResolver,
208209
private ScopeContext $context,
209210
private PhpVersion $phpVersion,
@@ -924,46 +925,11 @@ private function resolveType(string $exprString, Expr $node): Type
924925
}
925926

926927
if ($node instanceof Expr\BinaryOp\Identical) {
927-
if (
928-
$node->left instanceof Variable
929-
&& is_string($node->left->name)
930-
&& $node->right instanceof Variable
931-
&& is_string($node->right->name)
932-
&& $node->left->name === $node->right->name
933-
) {
934-
return new ConstantBooleanType(true);
935-
}
936-
937-
$leftType = $this->getType($node->left);
938-
$rightType = $this->getType($node->right);
939-
940-
if (
941-
(
942-
$node->left instanceof Node\Expr\PropertyFetch
943-
|| $node->left instanceof Node\Expr\StaticPropertyFetch
944-
)
945-
&& $rightType->isNull()->yes()
946-
&& !$this->hasPropertyNativeType($node->left)
947-
) {
948-
return new BooleanType();
949-
}
950-
951-
if (
952-
(
953-
$node->right instanceof Node\Expr\PropertyFetch
954-
|| $node->right instanceof Node\Expr\StaticPropertyFetch
955-
)
956-
&& $leftType->isNull()->yes()
957-
&& !$this->hasPropertyNativeType($node->right)
958-
) {
959-
return new BooleanType();
960-
}
961-
962-
return $this->initializerExprTypeResolver->resolveIdenticalType($leftType, $rightType)->type;
928+
return $this->richerScopeGetTypeHelper->getIdenticalResult($this, $node)->type;
963929
}
964930

965931
if ($node instanceof Expr\BinaryOp\NotIdentical) {
966-
return $this->getType(new Expr\BooleanNot(new BinaryOp\Identical($node->left, $node->right)));
932+
return $this->richerScopeGetTypeHelper->getNotIdenticalResult($this, $node)->type;
967933
}
968934

969935
if ($node instanceof Expr\Instanceof_) {
@@ -2654,7 +2620,7 @@ private function promoteNativeTypes(): self
26542620
/**
26552621
* @param Node\Expr\PropertyFetch|Node\Expr\StaticPropertyFetch $propertyFetch
26562622
*/
2657-
private function hasPropertyNativeType($propertyFetch): bool
2623+
public function hasPropertyNativeType($propertyFetch): bool
26582624
{
26592625
$propertyReflection = $this->propertyReflectionFinder->findPropertyReflectionFromNode($propertyFetch, $this);
26602626
if ($propertyReflection === null) {

‎src/Analyser/RicherScopeGetTypeHelper.php

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Analyser;
4+
5+
use PhpParser\Node;
6+
use PhpParser\Node\Expr\BinaryOp\Identical;
7+
use PhpParser\Node\Expr\Variable;
8+
use PHPStan\Reflection\InitializerExprTypeResolver;
9+
use PHPStan\Type\BooleanType;
10+
use PHPStan\Type\Constant\ConstantBooleanType;
11+
use PHPStan\Type\TypeResult;
12+
use function is_string;
13+
14+
final class RicherScopeGetTypeHelper
15+
{
16+
17+
public function __construct(private InitializerExprTypeResolver $initializerExprTypeResolver)
18+
{
19+
}
20+
21+
/**
22+
* @return TypeResult<BooleanType>
23+
*/
24+
public function getIdenticalResult(Scope $scope, Identical $expr): TypeResult
25+
{
26+
if (
27+
$expr->left instanceof Variable
28+
&& is_string($expr->left->name)
29+
&& $expr->right instanceof Variable
30+
&& is_string($expr->right->name)
31+
&& $expr->left->name === $expr->right->name
32+
) {
33+
return new TypeResult(new ConstantBooleanType(true), []);
34+
}
35+
36+
$leftType = $scope->getType($expr->left);
37+
$rightType = $scope->getType($expr->right);
38+
39+
if (
40+
(
41+
$expr->left instanceof Node\Expr\PropertyFetch
42+
|| $expr->left instanceof Node\Expr\StaticPropertyFetch
43+
)
44+
&& $rightType->isNull()->yes()
45+
&& !$scope->hasPropertyNativeType($expr->left)
46+
) {
47+
return new TypeResult(new BooleanType(), []);
48+
}
49+
50+
if (
51+
(
52+
$expr->right instanceof Node\Expr\PropertyFetch
53+
|| $expr->right instanceof Node\Expr\StaticPropertyFetch
54+
)
55+
&& $leftType->isNull()->yes()
56+
&& !$scope->hasPropertyNativeType($expr->right)
57+
) {
58+
return new TypeResult(new BooleanType(), []);
59+
}
60+
61+
return $this->initializerExprTypeResolver->resolveIdenticalType($leftType, $rightType);
62+
}
63+
64+
/**
65+
* @return TypeResult<BooleanType>
66+
*/
67+
public function getNotIdenticalResult(Scope $scope, Node\Expr\BinaryOp\NotIdentical $expr): TypeResult
68+
{
69+
$identicalResult = $this->getIdenticalResult($scope, new Identical($expr->left, $expr->right));
70+
$identicalType = $identicalResult->type;
71+
if ($identicalType instanceof ConstantBooleanType) {
72+
return new TypeResult(new ConstantBooleanType(!$identicalType->getValue()), $identicalResult->reasons);
73+
}
74+
75+
return new TypeResult(new BooleanType(), []);
76+
}
77+
78+
}

‎src/Rules/Comparison/StrictComparisonOfDifferentTypesRule.php

+15-3
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
namespace PHPStan\Rules\Comparison;
44

55
use PhpParser\Node;
6+
use PHPStan\Analyser\RicherScopeGetTypeHelper;
67
use PHPStan\Analyser\Scope;
78
use PHPStan\Parser\LastConditionVisitor;
89
use PHPStan\Rules\Rule;
910
use PHPStan\Rules\RuleErrorBuilder;
1011
use PHPStan\TrinaryLogic;
1112
use PHPStan\Type\Constant\ConstantBooleanType;
1213
use PHPStan\Type\VerbosityLevel;
14+
use function count;
1315
use function sprintf;
1416

1517
/**
@@ -19,6 +21,7 @@ final class StrictComparisonOfDifferentTypesRule implements Rule
1921
{
2022

2123
public function __construct(
24+
private RicherScopeGetTypeHelper $richerScopeGetTypeHelper,
2225
private bool $checkAlwaysTrueStrictComparison,
2326
private bool $treatPhpDocTypesAsCertain,
2427
private bool $reportAlwaysTrueInLastCondition,
@@ -34,19 +37,28 @@ public function getNodeType(): string
3437

3538
public function processNode(Node $node, Scope $scope): array
3639
{
37-
if (!$node instanceof Node\Expr\BinaryOp\Identical && !$node instanceof Node\Expr\BinaryOp\NotIdentical) {
40+
if ($node instanceof Node\Expr\BinaryOp\Identical) {
41+
$nodeTypeResult = $this->richerScopeGetTypeHelper->getIdenticalResult($this->treatPhpDocTypesAsCertain ? $scope : $scope->doNotTreatPhpDocTypesAsCertain(), $node);
42+
} elseif ($node instanceof Node\Expr\BinaryOp\NotIdentical) {
43+
$nodeTypeResult = $this->richerScopeGetTypeHelper->getNotIdenticalResult($this->treatPhpDocTypesAsCertain ? $scope : $scope->doNotTreatPhpDocTypesAsCertain(), $node);
44+
} else {
3845
return [];
3946
}
4047

41-
$nodeType = $this->treatPhpDocTypesAsCertain ? $scope->getType($node) : $scope->getNativeType($node);
48+
$nodeType = $nodeTypeResult->type;
4249
if (!$nodeType instanceof ConstantBooleanType) {
4350
return [];
4451
}
4552

4653
$leftType = $this->treatPhpDocTypesAsCertain ? $scope->getType($node->left) : $scope->getNativeType($node->left);
4754
$rightType = $this->treatPhpDocTypesAsCertain ? $scope->getType($node->right) : $scope->getNativeType($node->right);
4855

49-
$addTip = function (RuleErrorBuilder $ruleErrorBuilder) use ($scope, $node): RuleErrorBuilder {
56+
$addTip = function (RuleErrorBuilder $ruleErrorBuilder) use ($scope, $node, $nodeTypeResult): RuleErrorBuilder {
57+
$reasons = $nodeTypeResult->reasons;
58+
if (count($reasons) > 0) {
59+
return $ruleErrorBuilder->acceptsReasonsTip($reasons);
60+
}
61+
5062
if (!$this->treatPhpDocTypesAsCertain) {
5163
return $ruleErrorBuilder;
5264
}

‎src/Testing/PHPStanTestCase.php

+12-8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use PHPStan\Analyser\Error;
88
use PHPStan\Analyser\MutatingScope;
99
use PHPStan\Analyser\NodeScopeResolver;
10+
use PHPStan\Analyser\RicherScopeGetTypeHelper;
1011
use PHPStan\Analyser\ScopeFactory;
1112
use PHPStan\Analyser\TypeSpecifier;
1213
use PHPStan\BetterReflection\Reflector\ClassReflector;
@@ -168,25 +169,28 @@ public static function createScopeFactory(ReflectionProvider $reflectionProvider
168169
$reflectionProviderProvider = new DirectReflectionProviderProvider($reflectionProvider);
169170
$constantResolver = new ConstantResolver($reflectionProviderProvider, $dynamicConstantNames);
170171

172+
$initializerExprTypeResolver = new InitializerExprTypeResolver(
173+
$constantResolver,
174+
$reflectionProviderProvider,
175+
$container->getByType(PhpVersion::class),
176+
$container->getByType(OperatorTypeSpecifyingExtensionRegistryProvider::class),
177+
new OversizedArrayBuilder(),
178+
$container->getParameter('usePathConstantsAsConstantString'),
179+
);
180+
171181
return new ScopeFactory(
172182
new DirectInternalScopeFactory(
173183
MutatingScope::class,
174184
$reflectionProvider,
175-
new InitializerExprTypeResolver(
176-
$constantResolver,
177-
$reflectionProviderProvider,
178-
$container->getByType(PhpVersion::class),
179-
$container->getByType(OperatorTypeSpecifyingExtensionRegistryProvider::class),
180-
new OversizedArrayBuilder(),
181-
$container->getParameter('usePathConstantsAsConstantString'),
182-
),
185+
$initializerExprTypeResolver,
183186
$container->getByType(DynamicReturnTypeExtensionRegistryProvider::class),
184187
$container->getByType(ExpressionTypeResolverExtensionRegistryProvider::class),
185188
$container->getByType(ExprPrinter::class),
186189
$typeSpecifier,
187190
new PropertyReflectionFinder(),
188191
self::getParser(),
189192
$container->getByType(NodeScopeResolver::class),
193+
new RicherScopeGetTypeHelper($initializerExprTypeResolver),
190194
$container->getByType(PhpVersion::class),
191195
$container->getParameter('featureToggles')['explicitMixedInUnknownGenericNew'],
192196
$container->getParameter('featureToggles')['explicitMixedForGlobalVariables'],

‎src/Type/MixedType.php

+12-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,18 @@ public function isSuperTypeOfWithReason(Type $type): IsSuperTypeOfResult
159159
return IsSuperTypeOfResult::createMaybe();
160160
}
161161

162-
return $this->subtractedType->isSuperTypeOfWithReason($type)->negate();
162+
$result = $this->subtractedType->isSuperTypeOfWithReason($type)->negate();
163+
if ($result->no()) {
164+
return IsSuperTypeOfResult::createNo([
165+
sprintf(
166+
'Type %s has already been eliminated from %s.',
167+
$this->subtractedType->describe(VerbosityLevel::precise()),
168+
$this->describe(VerbosityLevel::typeOnly()),
169+
),
170+
]);
171+
}
172+
173+
return $result;
163174
}
164175

165176
public function setOffsetValueType(?Type $offsetType, Type $valueType, bool $unionValues = true): Type

‎tests/PHPStan/Rules/Comparison/StrictComparisonOfDifferentTypesRuleTest.php

+20
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace PHPStan\Rules\Comparison;
44

5+
use PHPStan\Analyser\RicherScopeGetTypeHelper;
56
use PHPStan\Rules\Rule;
67
use PHPStan\Testing\RuleTestCase;
78
use const PHP_INT_SIZE;
@@ -22,6 +23,7 @@ class StrictComparisonOfDifferentTypesRuleTest extends RuleTestCase
2223
protected function getRule(): Rule
2324
{
2425
return new StrictComparisonOfDifferentTypesRule(
26+
self::getContainer()->getByType(RicherScopeGetTypeHelper::class),
2527
$this->checkAlwaysTrueStrictComparison,
2628
$this->treatPhpDocTypesAsCertain,
2729
$this->reportAlwaysTrueInLastCondition,
@@ -216,10 +218,12 @@ public function testStrictComparison(): void
216218
[
217219
'Strict comparison using === between mixed and \'foo\' will always evaluate to false.',
218220
808,
221+
'Type 1|string has already been eliminated from mixed.',
219222
],
220223
[
221224
'Strict comparison using !== between mixed and 1 will always evaluate to true.',
222225
812,
226+
'Type 1|string has already been eliminated from mixed.',
223227
],
224228
[
225229
'Strict comparison using === between \'foo\' and \'foo\' will always evaluate to true.',
@@ -275,6 +279,16 @@ public function testStrictComparison(): void
275279
1014,
276280
$tipText,
277281
],
282+
[
283+
'Strict comparison using === between mixed and null will always evaluate to false.',
284+
1030,
285+
'Type null has already been eliminated from mixed.',
286+
],
287+
[
288+
'Strict comparison using !== between mixed and null will always evaluate to true.',
289+
1034,
290+
'Type null has already been eliminated from mixed.',
291+
],
278292
],
279293
);
280294
}
@@ -419,6 +433,7 @@ public function testStrictComparisonWithoutAlwaysTrue(): void
419433
[
420434
'Strict comparison using === between mixed and \'foo\' will always evaluate to false.',
421435
808,
436+
'Type 1|string has already been eliminated from mixed.',
422437
],
423438
[
424439
'Strict comparison using === between NAN and NAN will always evaluate to false.',
@@ -433,6 +448,11 @@ public function testStrictComparisonWithoutAlwaysTrue(): void
433448
1014,
434449
$tipText,
435450
],
451+
[
452+
'Strict comparison using === between mixed and null will always evaluate to false.',
453+
1030,
454+
'Type null has already been eliminated from mixed.',
455+
],
436456
],
437457
);
438458
}

‎tests/PHPStan/Rules/Comparison/data/strict-comparison.php

+20
Original file line numberDiff line numberDiff line change
@@ -1017,3 +1017,23 @@ public function doFoo($a): void
10171017
}
10181018

10191019
}
1020+
1021+
class SubtractedMixedAgainstNull
1022+
{
1023+
1024+
public function doFoo($m): void
1025+
{
1026+
if ($m === null) {
1027+
return;
1028+
}
1029+
1030+
if ($m === null) {
1031+
1032+
}
1033+
1034+
if ($m !== null) {
1035+
1036+
}
1037+
}
1038+
1039+
}

0 commit comments

Comments
 (0)