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

Avoid wrong assertions when working with objects returned by methods #9685

Merged
merged 1 commit into from
Apr 21, 2023
Merged

Avoid wrong assertions when working with objects returned by methods #9685

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
53 changes: 37 additions & 16 deletions .../Internal/Analyzer/Statements/Expression/Call/Method/ExistingAtomicMethodCallAnalyzer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,13 @@
use Psalm\Type\Union;
use UnexpectedValueException;

use function array_filter;
use function array_map;
use function count;
use function explode;
use function in_array;
use function is_string;
use function strpos;
use function strtolower;

/**
Expand Down Expand Up @@ -422,30 +425,48 @@ public static function analyze(
}

if ($method_storage->if_true_assertions) {
$possibilities = array_map(
static fn(Possibilities $assertion): Possibilities => $assertion->getUntemplatedCopy(
$template_result,
$lhs_var_id,
$codebase,
),
$method_storage->if_true_assertions,
);
if ($lhs_var_id === null) {
$possibilities = array_filter(
$possibilities,
static fn(Possibilities $assertion): bool => !(is_string($assertion->var_id)
&& strpos($assertion->var_id, '$this->') === 0
)
);
}
$statements_analyzer->node_data->setIfTrueAssertions(
$stmt,
array_map(
static fn(Possibilities $assertion): Possibilities => $assertion->getUntemplatedCopy(
$template_result,
$lhs_var_id,
$codebase,
),
$method_storage->if_true_assertions,
),
$possibilities,
);
}

if ($method_storage->if_false_assertions) {
$possibilities = array_map(
static fn(Possibilities $assertion): Possibilities => $assertion->getUntemplatedCopy(
$template_result,
$lhs_var_id,
$codebase,
),
$method_storage->if_false_assertions,
);
if ($lhs_var_id === null) {
$possibilities = array_filter(
$possibilities,
static fn(Possibilities $assertion): bool => !(is_string($assertion->var_id)
&& strpos($assertion->var_id, '$this->') === 0
)
);
}
$statements_analyzer->node_data->setIfFalseAssertions(
$stmt,
array_map(
static fn(Possibilities $assertion): Possibilities => $assertion->getUntemplatedCopy(
$template_result,
$lhs_var_id,
$codebase,
),
$method_storage->if_false_assertions,
),
$possibilities,
);
}
}
Expand Down
24 changes: 24 additions & 0 deletions tests/AssertAnnotationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2007,6 +2007,30 @@ function assertString(A $arg): bool {return $arg->b !== null;}
function requiresString(string $_str): void {}
',
],
'assertionOnPropertyReturnedByMethod' => [
'code' => '<?php
class a {
public ?int $id = null;
/**
* @psalm-mutation-free
*
* @psalm-assert-if-true !null $this->id
*/
public function isExists(): bool {
return $this->id !== null;
}
}

class b {
public ?int $id = null;
public function __construct(private a $a) {
if ($this->getA()->isExists()) {
/** @psalm-check-type-exact $this->id = ?int */
}
}
public function getA(): a { return $this->a; }
}',
],
'assertWithEmptyStringOnKeyedArray' => [
'code' => '<?php
class A
Expand Down