Skip to content

Fix #5919: Only one possible (always entered) loop exit path is not detected #5072

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

Open
phpstan-bot wants to merge 1 commit into
base: 2.1.x
Choose a base branch
from
Open

Fix #5919: Only one possible (always entered) loop exit path is not detected #5072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 44 additions & 21 deletions src/Analyser/NodeScopeResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1520,8 +1520,15 @@ private function processStmtNode(
}

$breakExitPoints = $finalScopeResult->getExitPointsByType(Break_::class);
foreach ($breakExitPoints as $breakExitPoint) {
$finalScope = $finalScope->mergeWith($breakExitPoint->getScope());
if ($alwaysIterates && count($breakExitPoints) > 0) {
$finalScope = $breakExitPoints[0]->getScope();
for ($i = 1, $breakExitPointsCount = count($breakExitPoints); $i < $breakExitPointsCount; $i++) {
$finalScope = $finalScope->mergeWith($breakExitPoints[$i]->getScope());
}
} else {
foreach ($breakExitPoints as $breakExitPoint) {
$finalScope = $finalScope->mergeWith($breakExitPoint->getScope());
}
}

$isIterableAtLeastOnce = $beforeCondBooleanType->isTrue()->yes();
Expand Down Expand Up @@ -1627,8 +1634,16 @@ private function processStmtNode(
} else {
$this->processExprNode($stmt, $stmt->cond, $bodyScope, $storage, $nodeCallback, ExpressionContext::createDeep());
}
foreach ($bodyScopeResult->getExitPointsByType(Break_::class) as $breakExitPoint) {
$finalScope = $breakExitPoint->getScope()->mergeWith($finalScope);
$breakExitPoints = $bodyScopeResult->getExitPointsByType(Break_::class);
if ($alwaysIterates && count($breakExitPoints) > 0) {
$finalScope = $breakExitPoints[0]->getScope();
for ($i = 1, $breakExitPointsCount = count($breakExitPoints); $i < $breakExitPointsCount; $i++) {
$finalScope = $finalScope->mergeWith($breakExitPoints[$i]->getScope());
}
} else {
foreach ($breakExitPoints as $breakExitPoint) {
$finalScope = $breakExitPoint->getScope()->mergeWith($finalScope);
}
}

return new InternalStatementResult(
Expand Down Expand Up @@ -1739,26 +1754,34 @@ private function processStmtNode(
$finalScope = $finalScope->filterByFalseyValue($lastCondExpr);
}

foreach ($finalScopeResult->getExitPointsByType(Break_::class) as $breakExitPoint) {
$finalScope = $breakExitPoint->getScope()->mergeWith($finalScope);
}

if ($isIterableAtLeastOnce->no() || $finalScopeResult->isAlwaysTerminating()) {
if ($this->polluteScopeWithLoopInitialAssignments) {
$finalScope = $initScope;
} else {
$finalScope = $scope;
$breakExitPoints = $finalScopeResult->getExitPointsByType(Break_::class);
if ($alwaysIterates->yes() && count($breakExitPoints) > 0) {
$finalScope = $breakExitPoints[0]->getScope();
for ($i = 1, $breakExitPointsCount = count($breakExitPoints); $i < $breakExitPointsCount; $i++) {
$finalScope = $finalScope->mergeWith($breakExitPoints[$i]->getScope());
}
} else {
foreach ($breakExitPoints as $breakExitPoint) {
$finalScope = $breakExitPoint->getScope()->mergeWith($finalScope);
}

} elseif ($isIterableAtLeastOnce->maybe()) {
if ($this->polluteScopeWithLoopInitialAssignments) {
$finalScope = $finalScope->mergeWith($initScope);
if ($isIterableAtLeastOnce->no() || $finalScopeResult->isAlwaysTerminating()) {
if ($this->polluteScopeWithLoopInitialAssignments) {
$finalScope = $initScope;
} else {
$finalScope = $scope;
}

} elseif ($isIterableAtLeastOnce->maybe()) {
if ($this->polluteScopeWithLoopInitialAssignments) {
$finalScope = $finalScope->mergeWith($initScope);
} else {
$finalScope = $finalScope->mergeWith($scope);
}
} else {
$finalScope = $finalScope->mergeWith($scope);
}
} else {
if (!$this->polluteScopeWithLoopInitialAssignments) {
$finalScope = $finalScope->mergeWith($scope);
if (!$this->polluteScopeWithLoopInitialAssignments) {
$finalScope = $finalScope->mergeWith($scope);
}
}
}

Expand Down
10 changes: 10 additions & 0 deletions tests/PHPStan/Rules/Variables/DefinedVariableRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1257,4 +1257,14 @@ public function testBug12944(): void
$this->analyse([__DIR__ . '/data/bug-12944.php'], []);
}

public function testBug5919(): void
{
$this->cliArgumentsVariablesRegistered = true;
$this->polluteScopeWithLoopInitialAssignments = true;
$this->checkMaybeUndefinedVariables = true;
$this->polluteScopeWithAlwaysIterableForeach = true;

$this->analyse([__DIR__ . '/data/bug-5919.php'], []);
}

}
59 changes: 59 additions & 0 deletions tests/PHPStan/Rules/Variables/data/bug-5919.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?php declare(strict_types = 1);

namespace Bug5919;

/**
* @return mixed[]
*/
function queryApi(): array
{
return [5];
}

function testWhileTrueWithTryCatch(): void
{
while (true) {
try {
$s = queryApi();
break;
} catch (\Exception $e) {
if (rand(0, 1)) {
throw $e;
}
}
}

var_dump(count($s));
}

function testDoWhileWithTryCatch(): void
{
do {
try {
$s = queryApi();
break;
} catch (\Exception $e) {
if (rand(0, 1)) {
throw $e;
}
}
} while (true);

var_dump(count($s));
}

function testForEverWithTryCatch(): void
{
for (;;) {
try {
$s = queryApi();
break;
} catch (\Exception $e) {
if (rand(0, 1)) {
throw $e;
}
}
}

var_dump(count($s));
}
Loading