Skip to content

Commit 9efcdf5

Browse files
staabmstaabm
authored
Fix lost list-type if substituted a element via loop
1 parent b225f74 commit 9efcdf5

File tree

3 files changed

+154
-4
lines changed

3 files changed

+154
-4
lines changed

‎src/Analyser/NodeScopeResolver.php‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5450,14 +5450,15 @@ private function processAssignVar(
54505450
$offsetValueType = $varType;
54515451
$offsetNativeValueType = $varNativeType;
54525452

5453-
$valueToWrite = $this->produceArrayDimFetchAssignValueToWrite($offsetTypes, $offsetValueType, $valueToWrite);
5453+
$valueToWrite = $this->produceArrayDimFetchAssignValueToWrite($dimFetchStack, $offsetTypes, $offsetValueType, $valueToWrite, $scope);
54545454

54555455
if (!$offsetValueType->equals($offsetNativeValueType) || !$valueToWrite->equals($nativeValueToWrite)) {
5456-
$nativeValueToWrite = $this->produceArrayDimFetchAssignValueToWrite($offsetNativeTypes, $offsetNativeValueType, $nativeValueToWrite);
5456+
$nativeValueToWrite = $this->produceArrayDimFetchAssignValueToWrite($dimFetchStack, $offsetNativeTypes, $offsetNativeValueType, $nativeValueToWrite, $scope);
54575457
} else {
54585458
$rewritten = false;
54595459
foreach ($offsetTypes as $i => $offsetType) {
54605460
$offsetNativeType = $offsetNativeTypes[$i];
5461+
54615462
if ($offsetType === null) {
54625463
if ($offsetNativeType !== null) {
54635464
throw new ShouldNotHappenException();
@@ -5471,7 +5472,7 @@ private function processAssignVar(
54715472
continue;
54725473
}
54735474

5474-
$nativeValueToWrite = $this->produceArrayDimFetchAssignValueToWrite($offsetNativeTypes, $offsetNativeValueType, $nativeValueToWrite);
5475+
$nativeValueToWrite = $this->produceArrayDimFetchAssignValueToWrite($dimFetchStack, $offsetNativeTypes, $offsetNativeValueType, $nativeValueToWrite, $scope);
54755476
$rewritten = true;
54765477
break;
54775478
}
@@ -5784,9 +5785,10 @@ static function (): void {
57845785
}
57855786

57865787
/**
5788+
* @param list<ArrayDimFetch> $dimFetchStack
57875789
* @param list<Type|null> $offsetTypes
57885790
*/
5789-
private function produceArrayDimFetchAssignValueToWrite(array $offsetTypes, Type $offsetValueType, Type $valueToWrite): Type
5791+
private function produceArrayDimFetchAssignValueToWrite(array $dimFetchStack, array $offsetTypes, Type $offsetValueType, Type $valueToWrite, Scope $scope): Type
57905792
{
57915793
$offsetValueTypeStack = [$offsetValueType];
57925794
foreach (array_slice($offsetTypes, 0, -1) as $offsetType) {
@@ -5821,6 +5823,31 @@ private function produceArrayDimFetchAssignValueToWrite(array $offsetTypes, Type
58215823
$offsetValueType = TypeCombinator::intersect($offsetValueType, TypeCombinator::union(...$types));
58225824
}
58235825
$valueToWrite = $offsetValueType->setOffsetValueType($offsetType, $valueToWrite, $i === 0);
5826+
5827+
$arrayDimFetch = $dimFetchStack[$i] ?? null;
5828+
if ($arrayDimFetch === null || !$offsetValueType->isList()->yes()) {
5829+
continue;
5830+
}
5831+
5832+
if ($scope->hasExpressionType($arrayDimFetch)->yes()) { // keep list for $list[$index] assignments
5833+
$valueToWrite = TypeCombinator::intersect($valueToWrite, new AccessoryArrayListType());
5834+
} elseif ($arrayDimFetch->dim instanceof BinaryOp\Plus) {
5835+
if ( // keep list for $list[$index + 1] assignments
5836+
$arrayDimFetch->dim->right instanceof Variable
5837+
&& $arrayDimFetch->dim->left instanceof Node\Scalar\Int_
5838+
&& $arrayDimFetch->dim->left->value === 1
5839+
&& $scope->hasExpressionType(new ArrayDimFetch($arrayDimFetch->var, $arrayDimFetch->dim->right))->yes()
5840+
) {
5841+
$valueToWrite = TypeCombinator::intersect($valueToWrite, new AccessoryArrayListType());
5842+
} elseif ( // keep list for $list[1 + $index] assignments
5843+
$arrayDimFetch->dim->left instanceof Variable
5844+
&& $arrayDimFetch->dim->right instanceof Node\Scalar\Int_
5845+
&& $arrayDimFetch->dim->right->value === 1
5846+
&& $scope->hasExpressionType(new ArrayDimFetch($arrayDimFetch->var, $arrayDimFetch->dim->left))->yes()
5847+
) {
5848+
$valueToWrite = TypeCombinator::intersect($valueToWrite, new AccessoryArrayListType());
5849+
}
5850+
}
58245851
}
58255852

58265853
return $valueToWrite;

‎tests/PHPStan/Analyser/nsrt/bug-12274.php‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
<?php declare(strict_types=1);
2+
3+
namespace Bug12274;
4+
5+
use function PHPStan\Testing\assertType;
6+
7+
/**
8+
* @param non-empty-list<int> $items
9+
*
10+
* @return non-empty-list<int>
11+
*/
12+
function getItems(array $items): array
13+
{
14+
foreach ($items as $index => $item) {
15+
$items[$index] = 1;
16+
}
17+
18+
assertType('non-empty-list<int>', $items);
19+
return $items;
20+
}
21+
22+
/**
23+
* @param non-empty-list<int> $items
24+
*
25+
* @return non-empty-list<int>
26+
*/
27+
function getItemsByModifiedIndex(array $items): array
28+
{
29+
foreach ($items as $index => $item) {
30+
$index++;
31+
32+
$items[$index] = 1;
33+
}
34+
35+
assertType('non-empty-array<int<0, max>, int>', $items);
36+
return $items;
37+
}
38+
39+
/** @param list<int> $list */
40+
function testKeepListAfterIssetIndex(array $list, int $i): void
41+
{
42+
if (isset($list[$i])) {
43+
assertType('list<int>', $list);
44+
$list[$i] = 21;
45+
assertType('non-empty-list<int>', $list);
46+
$list[$i+1] = 21;
47+
assertType('non-empty-list<int>', $list);
48+
}
49+
assertType('list<int>', $list);
50+
}
51+
52+
/** @param list<list<int>> $nestedList */
53+
function testKeepNestedListAfterIssetIndex(array $nestedList, int $i, int $j): void
54+
{
55+
if (isset($nestedList[$i][$j])) {
56+
assertType('list<list<int>>', $nestedList);
57+
assertType('list<int>', $nestedList[$i]);
58+
$nestedList[$i][$j] = 21;
59+
assertType('non-empty-list<non-empty-list<int>>', $nestedList);
60+
assertType('non-empty-list<int>', $nestedList[$i]);
61+
}
62+
assertType('list<list<int>>', $nestedList);
63+
}
64+
65+
/** @param list<int> $list */
66+
function testKeepListAfterIssetIndexPlusOne(array $list, int $i): void
67+
{
68+
if (isset($list[$i])) {
69+
assertType('list<int>', $list);
70+
$list[$i+1] = 21;
71+
assertType('non-empty-list<int>', $list);
72+
}
73+
assertType('list<int>', $list);
74+
}
75+
76+
/** @param list<int> $list */
77+
function testKeepListAfterIssetIndexOnePlus(array $list, int $i): void
78+
{
79+
if (isset($list[$i])) {
80+
assertType('list<int>', $list);
81+
$list[1+$i] = 21;
82+
assertType('non-empty-list<int>', $list);
83+
}
84+
assertType('list<int>', $list);
85+
}
86+
87+
/** @param list<int> $list */
88+
function testShouldLooseListbyAst(array $list, int $i): void
89+
{
90+
if (isset($list[$i])) {
91+
$i++;
92+
93+
assertType('list<int>', $list);
94+
$list[1+$i] = 21;
95+
assertType('non-empty-array<int, int>', $list);
96+
}
97+
assertType('array<int, int>', $list);
98+
}
99+
100+
/** @param list<int> $list */
101+
function testShouldLooseListbyAst2(array $list, int $i): void
102+
{
103+
if (isset($list[$i])) {
104+
assertType('list<int>', $list);
105+
$list[2+$i] = 21;
106+
assertType('non-empty-array<int, int>', $list);
107+
}
108+
assertType('array<int, int>', $list);
109+
}

‎tests/PHPStan/Rules/Functions/ReturnTypeRuleTest.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,4 +345,18 @@ public function testBug11301(): void
345345
]);
346346
}
347347

348+
public function testBug12274(): void
349+
{
350+
$this->checkExplicitMixed = true;
351+
$this->checkNullables = true;
352+
353+
$this->analyse([__DIR__ . '/../../Analyser/nsrt/bug-12274.php'], [
354+
[
355+
'Function Bug12274\getItemsByModifiedIndex() should return non-empty-list<int> but returns non-empty-array<int<0, max>, int>.',
356+
36,
357+
'non-empty-array<int<0, max>, int> might not be a list.',
358+
],
359+
]);
360+
}
361+
348362
}

0 commit comments

Comments
 (0)