Skip to content

Fix InvalidComparisonOperationRule for UnionType #4168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2025
+74 −39
Merged

Fix InvalidComparisonOperationRule for UnionType #4168

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4857b6a
Fix InvalidComparisonOperationRule
VincentLanglet Jul 26, 2025
e14567b
Simplify
VincentLanglet Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 14 additions & 38 deletions src/Rules/Operators/InvalidComparisonOperationRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,14 @@
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Rules\RuleLevelHelper;
use PHPStan\ShouldNotHappenException;
use PHPStan\Type\BenevolentUnionType;
use PHPStan\Type\ArrayType;
use PHPStan\Type\ErrorType;
use PHPStan\Type\FloatType;
use PHPStan\Type\IntegerType;
use PHPStan\Type\MixedType;
use PHPStan\Type\NullType;
use PHPStan\Type\ObjectWithoutClassType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
use function get_class;
Expand Down Expand Up @@ -59,7 +60,9 @@ public function processNode(Node $node, Scope $scope): array
return [];
}

if ($this->isNumberType($scope, $node->left) && $this->isNumberType($scope, $node->right)) {
$isLeftNumberType = $this->isNumberType($scope, $node->left);
$isRightNumberType = $this->isNumberType($scope, $node->right);
if (($isLeftNumberType && $isRightNumberType) || (!$isLeftNumberType && !$isRightNumberType)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about xor instead? :D

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I never used it, i'll try.

Offtopic @ondrejmirtes I saw you merged/review multiple of my PRs. I dunno if you plan a release. I just wanted to inform you I dont have access to a computer until Wednesday. So if you want to include one of my pr (with requested changes) feel free to push on it and if any of these PR introduce a regression I wont be able to fix it before Wednesday.

It's maybe not a big issue for you, just wanted to inform you

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine, thank you for letting me know. I don't think there will be a major issue, PHPStan is continuously tested on several real-world projects (millions of LoC) so I know about the real issues pretty soon.

If something still comes up that a lot of people have problem with, they can wait on a one-before-last version before they upgrade.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simplification was easy finally
e14567b

return [];
}

Expand All @@ -80,10 +83,10 @@ public function processNode(Node $node, Scope $scope): array
}

if (
($this->isNumberType($scope, $node->left) && (
($isLeftNumberType && (
$this->isPossiblyNullableObjectType($scope, $node->right) || $this->isPossiblyNullableArrayType($scope, $node->right)
))
|| ($this->isNumberType($scope, $node->right) && (
|| ($isRightNumberType && (
$this->isPossiblyNullableObjectType($scope, $node->left) || $this->isPossiblyNullableArrayType($scope, $node->left)
))
) {
Expand Down Expand Up @@ -113,45 +116,18 @@ private function isNumberType(Scope $scope, Node\Expr $expr): bool

private function isPossiblyNullableObjectType(Scope $scope, Node\Expr $expr): bool
{
$acceptedType = new ObjectWithoutClassType();
$type = $scope->getType($expr);
$acceptedType = new UnionType([new ObjectWithoutClassType(), new NullType()]);

$type = $this->ruleLevelHelper->findTypeToCheck(
$scope,
$expr,
'',
static fn (Type $type): bool => $acceptedType->isSuperTypeOf($type)->yes(),
)->getType();

if ($type instanceof ErrorType) {
return false;
}

if (TypeCombinator::containsNull($type) && !$type->isNull()->yes()) {
$type = TypeCombinator::removeNull($type);
}

$isSuperType = $acceptedType->isSuperTypeOf($type);
if ($type instanceof BenevolentUnionType) {
return !$isSuperType->no();
}

return $isSuperType->yes();
return !$type->isNull()->yes() && $acceptedType->isSuperTypeOf($type)->yes();
}

private function isPossiblyNullableArrayType(Scope $scope, Node\Expr $expr): bool
{
$type = $this->ruleLevelHelper->findTypeToCheck(
$scope,
$expr,
'',
static fn (Type $type): bool => $type->isArray()->yes(),
)->getType();

if (TypeCombinator::containsNull($type) && !$type->isNull()->yes()) {
$type = TypeCombinator::removeNull($type);
}
$type = $scope->getType($expr);
$acceptedType = new UnionType([new ArrayType(new MixedType(), new MixedType()), new NullType()]);

return !($type instanceof ErrorType) && $type->isArray()->yes();
return !$type->isNull()->yes() && $acceptedType->isSuperTypeOf($type)->yes();
}

/** @return list<IdentifierRuleError> */
Expand Down
19 changes: 18 additions & 1 deletion tests/PHPStan/Rules/Operators/InvalidComparisonOperationRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@
class InvalidComparisonOperationRuleTest extends RuleTestCase
{

private bool $checkUnion = true;

protected function getRule(): Rule
{
return new InvalidComparisonOperationRule(
new RuleLevelHelper(self::createReflectionProvider(), true, false, true, false, false, false, true),
new RuleLevelHelper(self::createReflectionProvider(), true, false, $this->checkUnion, false, false, false, true),
$this->getContainer()->getByType(OperatorTypeSpecifyingExtensionRegistryProvider::class),
true,
);
Expand Down Expand Up @@ -168,6 +170,21 @@ public function testRuleWithNullsafeVariant(): void
]);
}

public function testBug3364(): void
{
$this->checkUnion = false;
$this->analyse([__DIR__ . '/data/bug-3364.php'], [
[
'Comparison operation "!=" between array<int|string>|null and 1 results in an error.',
18,
],
[
'Comparison operation "!=" between object|null and 1 results in an error.',
26,
],
]);
}

public function testBug11119(): void
{
$this->analyse([__DIR__ . '/data/bug-11119.php'], []);
Expand Down
42 changes: 42 additions & 0 deletions tests/PHPStan/Rules/Operators/data/bug-3364.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?php declare(strict_types = 1);

namespace Bug3364;

class HelloWorld
{
/**
* @param string|array<int|string>|null $value
*/
public function transform($value) {
$value != 1;
}

/**
* @param array<int|string>|null $value
*/
public function transform2($value) {
$value != 1;
}


/**
* @param object|null $value
*/
public function transform3($value) {
$value != 1;
}

/**
* @param array<int|string>|object $value
*/
public function transform4($value) {
$value != 1;
}

/**
* @param null $value
*/
public function transform5($value) {
$value != 1;
}
}
Loading