PHP 8.3 | Tokenizer/PHP + Generic/UnconditionalIfStatement: bug fix #3890
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When analyzing code during live coding, a situation could occur where the open parenthesis for an `if` control structure exists, but not a closing parenthesis. In that case, `$end` would be set to `-1` (via `-- null`) and the `for` loop would never even run, but a warning would still be thrown for the code. This warning is a false positive and should be avoided. On top of that, PHP 8.3 deprecates the use of the increment/decrement operators on non-float/non-integer values, which can cause the below warning when running the sniff on PHP 8.3. ``` An error occurred during processing; checking has been aborted. The error message was: Decrement on type null has no effect, this will change in the next major version of PHP in path\to\src\Standards\Generic\Sniffs\CodeAnalysis\UnconditionalIfStatementSniff.php on line 72 ``` Both the incorrect sniff warning, as well as the PHP 8.3 deprecation warning will now be avoided via the defensive coding added to the sniff. When debugging the issue on the command line with the added test and using the following command `phpcs -ps ./generic/tests/codeanalysis/UnconditionalIfStatementUnitTest.inc --standard=Generic --sniffs=Generic.CodeAnalysis.UnconditionalIfStatement`, I was not receiving any output at all. Digging deeper, I discovered two (loosely related) bugs in the Tokenizer/PHP class, which were the cause of that and which could be seen when running the tests: ``` Undefined array key 63 path\to\src\Tokenizers\PHP.php:3074 path\to\src\Tokenizers\Tokenizer.php:103 path\to\src\Files\File.php:577 path\to\src\Files\File.php:331 path\to\src\Files\LocalFile.php:92 path\to\tests\Standards\AbstractSniffUnitTest.php:175 path\to\tests\TestSuite7.php:28 ``` This bug is fixed by fixing the incorrect comparison on line 3073. ... which then exposed the next bug: ``` Undefined array key 63 path\to\src\Tokenizers\PHP.php:3080 path\to\src\Tokenizers\Tokenizer.php:103 path\to\src\Files\File.php:577 path\to\src\Files\File.php:331 path\to\src\Files\LocalFile.php:92 path\to\tests\Standards\AbstractSniffUnitTest.php:175 path\to\tests\TestSuite7.php:28 ``` ... which is fixed by adding some extra defensive coding in the condition. All three fixes are covered by the one test which was added.
fredden
approved these changes
Sep 21, 2023
jrfnl
changed the title
1 task
|
Closing as replaced by PHPCSStandards/PHP_CodeSniffer#90 |
jrfnl
deleted the
php-8.3/generic-unconditionalifstatement-tokenizer-php-bugs
branch
|
FYI: this fix is included in today's PHP_CodeSniffer 3.8.0 release. As per #3932, development on PHP_CodeSniffer will continue in the PHPCSStandards/PHP_CodeSniffer repository. If you want to stay informed, you may want to start "watching" that repo (or watching releases from that repo). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
When analyzing code during live coding, a situation could occur where the open parenthesis for an
ifcontrol structure exists, but not a closing parenthesis. In that case,$endwould be set to-1(via--null) and theforloop would never even run, but a warning would still be thrown for the code.This warning is a false positive and should be avoided.
On top of that, PHP 8.3 deprecates the use of the increment/decrement operators on non-float/non-integer values, which can cause the below warning when running the sniff on PHP 8.3.
Both the incorrect sniff warning, as well as the PHP 8.3 deprecation warning will now be avoided via the defensive coding added to the sniff.
When debugging the issue on the command line with the added test and using the following command
phpcs -ps ./generic/tests/codeanalysis/UnconditionalIfStatementUnitTest.inc --standard=Generic --sniffs=Generic.CodeAnalysis.UnconditionalIfStatement, I was not receiving any output at all.Digging deeper, I discovered two (loosely related) bugs in the Tokenizer/PHP class, which were the cause of that and which could be seen when running the tests:
This bug is fixed by fixing the incorrect comparison on line 3073.
... which then exposed the next bug:
... which is fixed by adding some extra defensive coding in the condition.
All three fixes are covered by the one test which was added.
Suggested changelog entry
true/false/nullis at the end of a file during live coding.Related issues/external references
N/A
Types of changes