Skip to content

Invalidate maybe-impure function return values after impure method/static calls #5667

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 11 commits into
base: 2.1.x
Choose a base branch
from
+240 −80
Open

Invalidate maybe-impure function return values after impure method/static calls #5667

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e9ba032
Invalidate maybe-impure function return values after impure method/st…
VincentLanglet May 14, 2026
923d2b1
Prevent type narrowing of expressions containing impure calls
phpstan-bot May 15, 2026
e731e88
Remove redundant early returns subsumed by expressionContainsNonPureCall
phpstan-bot May 15, 2026
452a3c8
Return TrinaryLogic from expressionContainsNonPureCall
phpstan-bot May 15, 2026
7687df3
Add tests for impure closures and arrow functions
phpstan-bot May 15, 2026
1fd7cb8
Revert "Return TrinaryLogic from expressionContainsNonPureCall"
staabm May 15, 2026
968e01a
Update TypeSpecifier.php
staabm May 15, 2026
aadf81a
Do not treat unknown functions as non-pure in sub-expression purity c…
phpstan-bot May 15, 2026
9d80f7d
Add non-regression test for unknown function sub-expression handling
phpstan-bot May 15, 2026
5ef8c3d
Replace unit test with NSRT integration test for FAUX_FUNCTION handling
phpstan-bot May 15, 2026
159e29a
Restore unit test for unknown function sub-expression handling
phpstan-bot May 15, 2026
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
17 changes: 17 additions & 0 deletions tests/PHPStan/Analyser/TypeSpecifierTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use PHPStan\Type\ArrayType;
use PHPStan\Type\ClassStringType;
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\Constant\ConstantIntegerType;
use PHPStan\Type\FloatType;
use PHPStan\Type\Generic\GenericClassStringType;
use PHPStan\Type\IntegerType;
Expand Down Expand Up @@ -1354,6 +1355,22 @@ private static function createInstanceOf(string $className, string $variableName
return new Expr\Instanceof_(new Variable($variableName), new Name($className));
}

public function testUnknownFunctionSubExpressionDoesNotPreventNarrowing(): void
Copy link
Copy Markdown
Contributor

@staabm staabm May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could this be tested via StrContainingTypeSpecifyingExtension with a str-containing function instead?

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Replaced the contrived TypeSpecifierTest::testUnknownFunctionSubExpressionDoesNotPreventNarrowing unit test (which manually built count(FAUX_FUNCTION($foo)) AST nodes) with an NSRT integration test in non-empty-string-str-containing-fns.php that exercises str_contains with a non-empty-string needle — which triggers the FAUX_FUNCTION rootExpr path in StrContainingTypeSpecifyingExtension. The test verifies narrowing works correctly across two successive str_contains calls. All 12071 tests pass, PHPStan self-analysis clean, CS clean.

Copy link
Copy Markdown
Contributor

@staabm staabm May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the newly added test does not fail when reverting aadf81a

Copy link
Copy Markdown
Collaborator Author

@phpstan-bot phpstan-bot May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed. The fix restores the TypeSpecifierTest::testUnknownFunctionSubExpressionDoesNotPreventNarrowing unit test which directly exercises the unknown-function-in-sub-expression code path by calling TypeSpecifier::create() with count(FAUX_FUNCTION($foo)). I verified that this test correctly fails when reverting commit aadf81a (empty SpecifiedTypes instead of narrowed type) and passes with the fix in place. The NSRT test in non-empty-string-str-containing-fns.php was removed since it only narrows a Variable and never touches expressionContainsNonPureCall with unknown functions.

{
$fauxFuncCall = new FuncCall(new Name('FAUX_FUNCTION'), [new Arg(new Variable('foo'))]);
$countCall = new FuncCall(new Name('count'), [new Arg($fauxFuncCall)]);

$specifiedTypes = $this->typeSpecifier->create(
$countCall,
new ConstantIntegerType(1),
TypeSpecifierContext::createTrue(),
$this->scope,
);

$result = $this->toReadableResult($specifiedTypes);
$this->assertSame(['count(FAUX_FUNCTION($foo))' => '1'], $result);
}

/**
* @param non-empty-string $functionName
*/
Expand Down
Loading