Fix phpstan/phpstan#13705: Adding elements to empty array in while loop does not result in array being recognized as potentially non-empty for in_array
#5419
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace Bug13705; | ||
|
|
||
| use function PHPStan\Testing\assertType; | ||
|
|
||
| function whileLoop(): void | ||
| { | ||
| $quantity = random_int(1, 42); | ||
| $codes = []; | ||
| while (count($codes) < $quantity) { | ||
| assertType('list<non-empty-string>', $codes); | ||
| $code = random_bytes(16); | ||
| if (!in_array($code, $codes, true)) { | ||
| $codes[] = $code; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param list<string> $arr | ||
| * @param int<2, 5> $boundedRange | ||
| * @param int<2, max> $unboundedMaxRange | ||
| * @param int<min, 5> $unboundedMinRange | ||
| */ | ||
| function countLessThanRange(array $arr, int $boundedRange, int $unboundedMaxRange, int $unboundedMinRange): void | ||
| { | ||
| // count($arr) < $range → inverted to NOT($range <= count($arr)) | ||
| // Inner: orEqual=true, false context → falsey + max !== null + orEqual (branch 1) | ||
| // Else: orEqual=true, true context → truthy + min !== null + orEqual (branch 3) | ||
| if (count($arr) < $boundedRange) { | ||
| assertType('list<string>', $arr); | ||
| } else { | ||
| assertType('non-empty-list<string>&hasOffsetValue(1, string)', $arr); | ||
| } | ||
|
|
||
| // count($arr) < unbounded max range → falsey + max is null → fallback via min (branch 3/4) | ||
| if (count($arr) < $unboundedMaxRange) { | ||
| assertType('list<string>', $arr); | ||
| } else { | ||
| assertType('non-empty-list<string>&hasOffsetValue(1, string)', $arr); | ||
| } | ||
|
|
||
| // count($arr) < unbounded min range → fallback branch (min is null) | ||
| if (count($arr) < $unboundedMinRange) { | ||
| assertType('list<string>', $arr); | ||
| } else { | ||
| assertType('list<string>', $arr); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param list<string> $arr | ||
| * @param int<2, 5> $boundedRange | ||
| */ | ||
| function countLessThanOrEqualRange(array $arr, int $boundedRange): void | ||
| { | ||
| // count($arr) <= $range → inverted to NOT($range < count($arr)) | ||
| // Inner: orEqual=false, false context → falsey + max !== null + !orEqual (branch 2) | ||
| // Else: orEqual=false, true context → truthy + min !== null + !orEqual (branch 4) | ||
| if (count($arr) <= $boundedRange) { | ||
| assertType('list<string>', $arr); | ||
| } else { | ||
| assertType('non-empty-list<string>&hasOffsetValue(1, string)&hasOffsetValue(2, string)', $arr); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param list<string> $arr | ||
| * @param int<2, 5> $boundedRange | ||
| */ | ||
| function rangeGreaterThanOrEqualCount(array $arr, int $boundedRange): void | ||
| { | ||
| // $range >= count($arr) → same as count($arr) <= $range | ||
| if ($boundedRange >= count($arr)) { | ||
| assertType('list<string>', $arr); | ||
| } else { | ||
| assertType('non-empty-list<string>&hasOffsetValue(1, string)&hasOffsetValue(2, string)', $arr); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param list<string> $arr | ||
| * @param int<2, 5> $boundedRange | ||
| */ | ||
| function rangeLessThanOrEqualCount(array $arr, int $boundedRange): void | ||
| { | ||
| // $range <= count($arr) → direct, orEqual=true | ||
| // True context: truthy + orEqual + min !== null (branch 3) | ||
| // False context: falsey + orEqual + max !== null (branch 1) | ||
| if ($boundedRange <= count($arr)) { | ||
| assertType('non-empty-list<string>&hasOffsetValue(1, string)', $arr); | ||
| } else { | ||
| assertType('list<string>', $arr); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param list<string> $arr | ||
| * @param int<2, 5> $boundedRange | ||
| */ | ||
| function rangeLessThanCount(array $arr, int $boundedRange): void | ||
| { | ||
| // $range < count($arr) → direct, orEqual=false | ||
| // True context: truthy + !orEqual + min !== null (branch 4) | ||
| // False context: falsey + !orEqual + max !== null (branch 2) | ||
| if ($boundedRange < count($arr)) { | ||
| assertType('non-empty-list<string>&hasOffsetValue(1, string)&hasOffsetValue(2, string)', $arr); | ||
| } else { | ||
| assertType('list<string>', $arr); | ||
| } | ||
| } | ||
|
|
||
| function whileLoopOriginal(int $length, int $quantity): void | ||
| { | ||
| if ($length < 8) { | ||
| throw new \InvalidArgumentException(); | ||
| } | ||
| $codes = []; | ||
| while ($quantity >= 1 && count($codes) < $quantity) { | ||
| $code = ''; | ||
| for ($i = 0; $i < $length; $i++) { | ||
| $code .= 'x'; | ||
| } | ||
| if (!in_array($code, $codes, true)) { | ||
| $codes[] = $code; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class HelloWorld | ||
| { | ||
| private const MIN_LENGTH = 8; | ||
|
|
||
| /** | ||
| * @return list<non-empty-string> | ||
| */ | ||
| public function generatePlainRecoveryCodes(int $length = 8, int $quantity = 8): array | ||
| { | ||
| if ($length < self::MIN_LENGTH) { | ||
| throw new \InvalidArgumentException( | ||
| $length . ' is not allowed as length for recovery codes. Must be at least ' . self::MIN_LENGTH, | ||
| 1613666803 | ||
| ); | ||
| } | ||
| $codes = []; | ||
| while ($quantity >= 1 && count($codes) < $quantity) { | ||
| $code = ''; | ||
| for ($i = 0; $i < $length; $i++) { | ||
| $code .= 'x'; | ||
| } | ||
| if (!in_array($code, $codes, true)) { | ||
| $codes[] = $code; | ||
| } | ||
| } | ||
| return $codes; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the newly added bug-13705.php should also be checked against a rule test which verifies we will no longer get
"Call to function in_array() with arguments literal-string&non-falsy-string, array{} and true will always evaluate to false." and similar errors
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pushed both commits. Here's a summary of the changes:
Commit 1: Add rule test for bug-13705
tests/PHPStan/Rules/Comparison/data/bug-13705.phpwith three test cases (simple while loop, compound condition with$quantity >= 1 &&, and the original issue's class method)testBug13705()toImpossibleCheckTypeFunctionCallRuleTestexpecting no errorsCommit 2: Fix IntegerRangeType count narrowing for falsey context with unbounded max
$quantityisint<1, max>(unbounded max, e.g. after$quantity >= 1narrowing), the falsey context fell through to the min-based branch, producingsizeType = int<1, max>which incorrectly narrowed arrays toarray{}elseif ($leftType->getMin() !== null)toelseif ($context->truthy() && $leftType->getMin() !== null)— the min-based branch should only apply in truthy context$sizeTypeis left asnulland no count narrowing occurs (correct behavior since we can't determine a definite threshold)bug-4700.phptest expectations which were previously overly precise (narrowing toarray{}when the range was unbounded)