Skip to content
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

Jump to bottom

Fix false positive for unused variable in try (fixes #7613). #7664

Merged
merged 3 commits into from Feb 13, 2022
Merged

Fix false positive for unused variable in try (fixes #7613). #7664

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b1599d
Fix false positive for unused variable in try (fixes #7613).
AndrolGenhald Feb 13, 2022
32c3894
Fix issue with nested `try` block and add more tests.
AndrolGenhald Feb 13, 2022
fd0ecf2
Rename variable to be consistent with existing convention.
AndrolGenhald Feb 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/Psalm/Context.php
View file
Open in desktop
Expand Up @@ -108,6 +108,13 @@ class Context
*/
public $inside_assignment = false;

/**
* Whether or not we're inside a try block.
*
* @var bool
*/
public $inside_try = false;

/**
* @var null|CodeLocation
*/
Expand Down
3 changes: 3 additions & 0 deletions src/Psalm/Internal/Analyzer/Statements/Block/TryAnalyzer.php
View file
Open in desktop
Expand Up @@ -86,9 +86,12 @@ public static function analyze(

$old_referenced_var_ids = $try_context->referenced_var_ids;

$previously_inside_try = $context->inside_try;
orklah marked this conversation as resolved.
Show resolved Hide resolved
$context->inside_try = true;
AndrolGenhald marked this conversation as resolved.
Show resolved Hide resolved
if ($statements_analyzer->analyze($stmt->stmts, $context) === false) {
return false;
}
$context->inside_try = $previously_inside_try;

if ($try_context->finally_scope) {
foreach ($context->vars_in_scope as $var_id => $type) {
Expand Down
8 changes: 8 additions & 0 deletions src/Psalm/Internal/Analyzer/Statements/Expression/AssignmentAnalyzer.php
View file
Open in desktop
Expand Up @@ -315,6 +315,14 @@ public static function analyze(
$assign_value_type->parent_nodes = [
$assignment_node->id => $assignment_node
];

if ($context->inside_try) {
// Copy previous assignment's parent nodes inside a try. Since an exception could be thrown at any
// point this is a workaround to ensure that use of a variable also uses all previous assignments.
if (isset($context->vars_in_scope[$array_var_id])) {
$assign_value_type->parent_nodes += $context->vars_in_scope[$array_var_id]->parent_nodes;
}
}
}

if ($array_var_id && isset($context->vars_in_scope[$array_var_id])) {
Expand Down
19 changes: 19 additions & 0 deletions tests/TaintTest.php
View file
Open in desktop
Expand Up @@ -2285,6 +2285,25 @@ function sinkNotWorking($sink) : string {}
echo sinkNotWorking($_GET["taint"]);',
'error_message' => 'TaintedHtml',
],
'taintEscapedInTryMightNotWork' => [
'<?php
/** @psalm-taint-escape html */
function escapeHtml(string $arg): string
{
return htmlspecialchars($arg);
}

$tainted = $_GET["foo"];

try {
$tainted = escapeHtml($tainted);
} catch (Throwable $_) {
}

echo $tainted;
',
'error_message' => 'TaintedHtml',
],
AndrolGenhald marked this conversation as resolved.
Show resolved Hide resolved
];
}

Expand Down
80 changes: 80 additions & 0 deletions tests/UnusedVariableTest.php
View file
Open in desktop
Expand Up @@ -2436,6 +2436,43 @@ function setProxySettingsFromEnv(): void {
$a = false;
}'
],
'usedInCatchIsAlwaysUsedInTry' => [
'<?php
$step = 0;
try {
$step = 1;
$step = 2;
} catch (Throwable $_) {
echo $step;
}
',
],
'usedInFinallyIsAlwaysUsedInTry' => [
'<?php
$step = 0;
try {
$step = 1;
$step = 2;
} finally {
echo $step;
}
',
],
'usedInFinallyIsAlwaysUsedInTryWithNestedTry' => [
'<?php
$step = 0;
try {
try {
$step = 1;
} finally {
}
$step = 2;
$step = 3;
} finally {
echo $step;
}
',
],
];
}

Expand Down Expand Up @@ -3416,6 +3453,49 @@ function takesArray($a) : void {
}',
'error_message' => 'MixedArgumentTypeCoercion - src' . DIRECTORY_SEPARATOR . 'somefile.php:12:44 - Argument 1 of takesArrayOfString expects array<array-key, string>, parent type array{mixed} provided. Consider improving the type at src' . DIRECTORY_SEPARATOR . 'somefile.php:10:41'
],
'warnAboutUnusedVariableInTryReassignedInCatch' => [
'<?php
$step = 0;
try {
$step = 1;
$step = 2;
} catch (Throwable $_) {
$step = 3;
echo $step;
}
',
'error_message' => 'UnusedVariable',
],
'warnAboutUnusedVariableInTryReassignedInFinally' => [
'<?php
$step = 0;
try {
$step = 1;
$step = 2;
} finally {
$step = 3;
echo $step;
}
',
'error_message' => 'UnusedVariable',
],
'SKIPPED-warnAboutVariableUsedInNestedTryNotUsedInOuterTry' => [
'<?php
$step = 0;
try {
$step = 1; // Unused
$step = 2;
try {
$step = 3;
$step = 4;
} finally {
echo $step;
}
} finally {
}
',
'error_message' => 'UnusedVariable',
],
orklah marked this conversation as resolved.
Show resolved Hide resolved
];
}
}