4.0 | Make sure that everything which was deprecated in 3.x has been removed in 4.0 #6
Closed
18 tasks done
Comments
|
Loosely related to #120 |
77 tasks
jrfnl
added a commit
that referenced
this issue
Apr 10, 2025
This fixes the following fatal error which would occur if the `Diff` report is used in combination with caching: ``` Fatal error: Uncaught Error: Call to a member function getFixableCount() on null in path/to/PHP_CodeSniffer/src/Fixer.php:144 Stack trace: #0 path/to/PHP_CodeSniffer/src/Reports/Diff.php(73): PHP_CodeSniffer\Fixer->fixFile() #1 path/to/PHP_CodeSniffer/src/Reporter.php(285): PHP_CodeSniffer\Reports\Diff->generateFileReport(Array, Object(PHP_CodeSniffer\Files\LocalFile), true, 150) #2 path/to/PHP_CodeSniffer/src/Runner.php(659): PHP_CodeSniffer\Reporter->cacheFileReport(Object(PHP_CodeSniffer\Files\LocalFile)) #3 path/to/PHP_CodeSniffer/src/Runner.php(400): PHP_CodeSniffer\Runner->processFile(Object(PHP_CodeSniffer\Files\LocalFile)) #4 path/to/PHP_CodeSniffer/src/Runner.php(119): PHP_CodeSniffer\Runner->run() #5 path/to/PHP_CodeSniffer/bin/phpcs(30): PHP_CodeSniffer\Runner->runPHPCS() #6 {main} thrown in path/to/PHP_CodeSniffer/src/Fixer.php on line 144 ```
jrfnl
added a commit
that referenced
this issue
Apr 10, 2025
…report Okay, so this is an awkward one. If both the `Code` + the `Diff` report were requested + caching was turned on + the _order_ of the requested reports was `Code,Diff` (i.e. first the code report), the following fatal error which would occur: ``` Fatal error: Uncaught Error: Call to a member function getFixableCount() on null in path/to/PHP_CodeSniffer/src/Fixer.php:144 Stack trace: #0 path/to/PHP_CodeSniffer/src/Reports/Diff.php(73): PHP_CodeSniffer\Fixer->fixFile() #1 path/to/PHP_CodeSniffer/src/Reporter.php(285): PHP_CodeSniffer\Reports\Diff->generateFileReport(Array, Object(PHP_CodeSniffer\Files\LocalFile), true, 150) #2 path/to/PHP_CodeSniffer/src/Runner.php(659): PHP_CodeSniffer\Reporter->cacheFileReport(Object(PHP_CodeSniffer\Files\LocalFile)) #3 path/to/PHP_CodeSniffer/src/Runner.php(400): PHP_CodeSniffer\Runner->processFile(Object(PHP_CodeSniffer\Files\LocalFile)) #4 path/to/PHP_CodeSniffer/src/Runner.php(119): PHP_CodeSniffer\Runner->run() #5 path/to/PHP_CodeSniffer/bin/phpcs(30): PHP_CodeSniffer\Runner->runPHPCS() #6 {main} thrown in path/to/PHP_CodeSniffer/src/Fixer.php on line 144 ``` To reproduce the issue (on `master`): 1. Create a small test file like: ```php <?php echo 'hello'.callMe( $p ); ``` 2. Run the following command to initialize the cache: ```bash phpcs -ps ./test.php --standard=PSR2 --report=Code,Diff --cache ``` All should be fine. 3. Now run the same command again and see the fatal error. Some investigating later, it turns out that both the `Code` report, as well as the `Diff` report, re-parse the current file, with the `Diff` report initializing the fixer once the file has reparsed, but the `Code` report not doing so (as it doesn't need the fixer). The problem with that is that the `Code` report basically leaves the `Fixer` in an invalid state, leading to the above error. While it is up for debate whether reports should ever (be allowed to) re-parse files, for now, let's fix the fatal. Re-evaluating the report setup should definitely be done, but should probably wait until the Reports classes have test coverage.
jrfnl
added a commit
that referenced
this issue
Apr 13, 2025
…report Okay, so this is an awkward one. If both the `Code` + the `Diff` report were requested + caching was turned on + the _order_ of the requested reports was `Code,Diff` (i.e. first the code report), the following fatal error which would occur: ``` Fatal error: Uncaught Error: Call to a member function getFixableCount() on null in path/to/PHP_CodeSniffer/src/Fixer.php:144 Stack trace: #0 path/to/PHP_CodeSniffer/src/Reports/Diff.php(73): PHP_CodeSniffer\Fixer->fixFile() #1 path/to/PHP_CodeSniffer/src/Reporter.php(285): PHP_CodeSniffer\Reports\Diff->generateFileReport(Array, Object(PHP_CodeSniffer\Files\LocalFile), true, 150) #2 path/to/PHP_CodeSniffer/src/Runner.php(659): PHP_CodeSniffer\Reporter->cacheFileReport(Object(PHP_CodeSniffer\Files\LocalFile)) #3 path/to/PHP_CodeSniffer/src/Runner.php(400): PHP_CodeSniffer\Runner->processFile(Object(PHP_CodeSniffer\Files\LocalFile)) #4 path/to/PHP_CodeSniffer/src/Runner.php(119): PHP_CodeSniffer\Runner->run() #5 path/to/PHP_CodeSniffer/bin/phpcs(30): PHP_CodeSniffer\Runner->runPHPCS() #6 {main} thrown in path/to/PHP_CodeSniffer/src/Fixer.php on line 144 ``` To reproduce the issue (on `master`): 1. Create a small test file like: ```php <?php echo 'hello'.callMe( $p ); ``` 2. Run the following command to initialize the cache: ```bash phpcs -ps ./test.php --standard=PSR2 --report=Code,Diff --cache ``` All should be fine. 3. Now run the same command again and see the fatal error. Some investigating later, it turns out that both the `Code` report, as well as the `Diff` report, re-parse the current file, with the `Diff` report initializing the fixer once the file has reparsed, but the `Code` report not doing so (as it doesn't need the fixer). The problem with that is that the `Code` report basically leaves the `Fixer` in an invalid state, leading to the above error. While it is up for debate whether reports should ever (be allowed to) re-parse files, for now, let's fix the fatal. Re-evaluating the report setup should definitely be done, but should probably wait until the Reports classes have test coverage.
This was referenced Apr 14, 2025
Merged
|
All related PRs have been merged into the new 4.x branch. Closing this ticket as fixed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
$ignoreCommentsparameter for theAbstractPatternSniff::__construct()method. - PR AbstractPatternSniff::__construct(): remove the $ignoreComments property #974print*()methods in theGeneratorclasses - See Generators: don't print documentation title if there are no docs #755Sniffinterface - See 4.0 | Deprecate and remove support for Sniffs not implementing the PHPCSSniffinterface #694Generic.Functions.CallTimePassByReference: remove sniff #921The text was updated successfully, but these errors were encountered: