Repository navigation
Build/QA: Retire booleanOr.alwaysTrue PHPStan baseline - #14037
huzaifaalmesbah wants to merge 3 commits into
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
…lean-or-always-true # Conflicts: # tests/phpstan/baselines/deadCode.unreachable.neon
…lean-or-always-true # Conflicts: # phpstan.neon.dist # tests/phpstan/baselines/deadCode.unreachable.neon
|
Other proposed purity annotations are in #14095 I also want to acknowledge that it is not ideal to have to annotate functions and methods with these tags. Ideally we would find a better solution, as they seem to be primarily needed as a PHPStan tooling limitation. Like maybe we could have a separate index built up of which functions/methods are pure/impure that is used by a PHPStan extension to avoid having to annotate. This index could even be maybe built up programmatically on a regular basis so that it doesn't need manual tagging. This is something I'd like to explore in the future. |
PHPStan infers `WP_HTML_Processor::next_token()` as pure, so the result of `is_tag_closer()` before the matching-closer loop in the block bindings processor's `replace_rich_text()` method survives across the loop, even though each `next_token()` call advances the parser to a different token. The `||` in the check after the loop is then reported as always true, the negation within it as always true, and the code that follows as unreachable. Adding `@phpstan-impure`, as was done for `WP_HTML_Tag_Processor::next_tag()` in r61934 and for `WP_HTML_Tag_Processor::parse_next_tag()` in r63301, resolves all three baselined errors. This empties the `booleanOr.alwaysTrue` baseline, so the file is removed along with its `includes` entry in `phpstan.neon.dist`. Developed in #14037. Follow-up to r61934, r63023, r63301. Props huzaifaalmesbah, rejaulalomkhan, tstokes8040. See #65817. git-svn-id: https://develop.svn.wordpress.org/trunk@64335 602fd350-edb4-49c9-b593-d223f7449a82
PHPStan infers `WP_HTML_Processor::next_token()` as pure, so the result of `is_tag_closer()` before the matching-closer loop in the block bindings processor's `replace_rich_text()` method survives across the loop, even though each `next_token()` call advances the parser to a different token. The `||` in the check after the loop is then reported as always true, the negation within it as always true, and the code that follows as unreachable. Adding `@phpstan-impure`, as was done for `WP_HTML_Tag_Processor::next_tag()` in r61934 and for `WP_HTML_Tag_Processor::parse_next_tag()` in r63301, resolves all three baselined errors. This empties the `booleanOr.alwaysTrue` baseline, so the file is removed along with its `includes` entry in `phpstan.neon.dist`. Developed in WordPress/wordpress-develop#14037. Follow-up to r61934, r63023, r63301. Props huzaifaalmesbah, rejaulalomkhan, tstokes8040. See #65817. Built from https://develop.svn.wordpress.org/trunk@64335 git-svn-id: http://core.svn.wordpress.org/trunk@63485 1a063a9b-81f0-0310-95a4-ce76da25c4cd
✅ Committed in r64335 (4be1db5).
Description
Retires the
booleanOr.alwaysTruePHPStan baseline in WordPress core by annotatingWP_HTML_Processor::next_token()with@phpstan-impure.WP_HTML_Processor::next_token()advances the HTML processor state and yields different tokens on consecutive calls. Without the@phpstan-impureannotation, PHPStan's purity inference assumed that successive calls inside iteration or boolean expressions would produce identical results. This caused PHPStan to flag||expressions as always true in callers likeWP_Block::replace_html().Adding
@phpstan-impureaccurately conveys the state mutation to PHPStan, which eliminates false positive purity assumptions across the codebase, resolves associated errors inbooleanNot.alwaysTrueanddeadCode.unreachable, and completely retiresbooleanOr.alwaysTrue.neon.Testing Instructions
Run static analysis:
Confirm 0 errors are found and
booleanOr.alwaysTrue.neonis no longer needed.Run PHPCS:
Confirm standards compliance.
Trac ticket: https://core.trac.wordpress.org/ticket/65817
Use of AI Tools
AI assistance: Yes
Tool(s): Google Antigravity
Model(s): Gemini 3.8 Flash
Used for: Researching static analysis reports and drafting initial baseline diffs; all logic, type declarations, and analysis results were manually investigated, verified, and run locally by me.