refactor: split phpstan-baseline into smaller files #9299

paulbalandan · 2024-12-02T14:16:08Z

Description
This PR splits our existing enormous phpstan-baseline.php into smaller baseline files named by their identifiers, thanks to https://github.com/shipmonk-rnd/phpstan-baseline-per-identifier/tree/2.0.0. Currently, the baseline contains 4,052 errors. That's very overwhelming to fix. TBH, when looking at the baseline I cannot continue further because of the bulk of technical debt we have.

The pro of this approach is that we can attack the baseline by identifier, making the cleanup less overwhelming. The cleanup would be bite-sized. The con of this approach is that we have too many baselines now, but that is the consequence of having 4k+ errors.

Same command to generate the baseline: composer phpstan:baseline

P.S I have fixed some of the files as PHPStan complains of No error to ignore stuff.

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

michalsn

I like this idea. Smaller baseline files seem like easier to deal with.

utils/phpstan-baseline/codeigniter.unknownServiceMethod.neon

.github/workflows/reusable-coveralls.yml

ddevsr · 2024-12-10T04:26:08Z

@paulbalandan By the way, i see this another error. Can you update rector to RC3? cc @samsonasik

Rector error

Run vendor/bin/rector process --dry-run --no-progress-bar
{
    "title": "_PHPStan_e6dc705b2\\Nette\\Schema\\ValidationException",
    "type": "_PHPStan_e6dc705b2\\Nette\\Schema\\ValidationException",
    "code": 500,
    "message": "Unexpected item 'parameters › shipmonkBaselinePerIdentifier'.",
    "file": "phar:///home/runner/work/CodeIgniter4/CodeIgniter4/vendor/phpstan/phpstan/phpstan.phar/vendor/nette/schema/src/Schema/Processor.php",
    "line": 75,
    "trace": [
        {
            "file": "phar:///home/runner/work/CodeIgniter4/CodeIgniter4/vendor/phpstan/phpstan/phpstan.phar/vendor/nette/schema/src/Schema/Processor.php",
            "line": 38,
            "function": "throwsErrors",
            "class": "_PHPStan_e6dc705b2\\Nette\\Schema\\Processor",
            "type": "->"
        },
        {
            "file": "phar:///home/runner/work/CodeIgniter4/CodeIgniter4/vendor/phpstan/phpstan/phpstan.phar/src/DependencyInjection/ContainerFactory.php",
            "line": 216,
            "function": "process",
            "class": "_PHPStan_e6dc705b2\\Nette\\Schema\\Processor",
            "type": "->"
        },
        {
            "file": "phar:///home/runner/work/CodeIgniter4/CodeIgniter4/vendor/phpstan/phpstan/phpstan.phar/src/DependencyInjection/ContainerFactory.php",
            "line": 104,
            "function": "validateParameters",
            "class": "PHPStan\\DependencyInjection\\ContainerFactory",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/src/NodeTypeResolver/DependencyInjection/PHPStanServicesFactory.php",
            "line": 51,
            "function": "create",
            "class": "PHPStan\\DependencyInjection\\ContainerFactory",
            "type": "->"
        },
        {
            "function": "__construct",
            "class": "Rector\\NodeTypeResolver\\DependencyInjection\\PHPStanServicesFactory",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 844,
            "function": "newInstanceArgs",
            "class": "ReflectionClass",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 705,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 652,
            "function": "resolve",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/src/DependencyInjection/LazyContainerFactory.php",
            "line": 273,
            "function": "make",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 807,
            "function": "Rector\\DependencyInjection\\{closure}",
            "class": "Rector\\DependencyInjection\\LazyContainerFactory",
            "type": "::"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 705,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 652,
            "function": "resolve",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": [9](https://github.com/codeigniter4/CodeIgniter4/actions/runs/12204169604/job/34048691307?pr=9299#step:11:10)47,
            "function": "make",
            "class": "RectorPrefix2024[11](https://github.com/codeigniter4/CodeIgniter4/actions/runs/12204169604/job/34048691307?pr=9299#step:11:12)\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 873,
            "function": "resolveClass",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 838,
            "function": "resolveDependencies",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 705,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 652,
            "function": "resolve",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 947,
            "function": "make",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 873,
            "function": "resolveClass",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 838,
            "function": "resolveDependencies",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 705,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 652,
            "function": "resolve",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 947,
            "function": "make",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 873,
            "function": "resolveClass",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 838,
            "function": "resolveDependencies",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 277,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 807,
            "function": "RectorPrefix202411\\Illuminate\\Container\\{closure}",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 705,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 652,
            "function": "resolve",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 496,
            "function": "make",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "function": "RectorPrefix202411\\Illuminate\\Container\\{closure}",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/ContextualBindingBuilder.php",
            "line": 72,
            "function": "iterator_to_array"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Util.php",
            "line": 40,
            "function": "RectorPrefix202411\\Illuminate\\Container\\{closure}",
            "class": "RectorPrefix202411\\Illuminate\\Container\\ContextualBindingBuilder",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 923,
            "function": "unwrapIfClosure",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 873,
            "function": "resolvePrimitive",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 838,
            "function": "resolveDependencies",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 705,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 652,
            "function": "resolve",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/src/DependencyInjection/LazyContainerFactory.php",
            "line": 245,
            "function": "make",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 807,
            "function": "Rector\\DependencyInjection\\{closure}",
            "class": "Rector\\DependencyInjection\\LazyContainerFactory",
            "type": "::"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 705,
            "function": "build",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/vendor/illuminate/container/Container.php",
            "line": 662,
            "function": "resolve",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/bin/rector.php",
            "line": [12](https://github.com/codeigniter4/CodeIgniter4/actions/runs/12204169604/job/34048691307?pr=9299#step:11:13)9,
            "function": "get",
            "class": "RectorPrefix202411\\Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/bin/rector",
            "line": 5,
            "args": [
                "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/bin/rector.php"
            ],
            "function": "require_once"
        },
        {
            "file": "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/bin/rector",
            "line": 1[19](https://github.com/codeigniter4/CodeIgniter4/actions/runs/12204169604/job/34048691307?pr=9299#step:11:20),
            "args": [
                "/home/runner/work/CodeIgniter4/CodeIgniter4/vendor/rector/rector/bin/rector"
            ],
            "function": "include"
        }
    ]
}

Ref : https://github.com/codeigniter4/CodeIgniter4/actions/runs/12204169604/job/34048691307?pr=9299

paulbalandan · 2024-12-10T04:28:45Z

Oh, I didn't notice that. But why does github actions not fail on that?

ddevsr · 2024-12-10T05:05:07Z

Maybe shipmonk no catch exception, I think this related to shipmonk using nette/neon not tested with phpstan/phpstan v2

phpstan.neon.dist

samsonasik · 2024-12-11T08:02:27Z

@ddevsr the codeigniter phpstan extension needs to be updated to use phpstan v2 first before it can require rector v2.

samsonasik · 2024-12-14T21:32:08Z

@ddevsr see PR:

refactor: upgrade to use phpstan 2 and rector 2 #9322

for upgrade to phpstan 2 and rector 2.

kenjis

LGTM!

paulbalandan · 2024-12-15T00:39:01Z

Thanks all for the reviews.

paulbalandan marked this pull request as draft December 2, 2024 14:19

paulbalandan force-pushed the split-phpstan-baseline branch 4 times, most recently from 4f170cf to 823f364 Compare December 6, 2024 18:13

paulbalandan marked this pull request as ready for review December 6, 2024 18:36

michalsn approved these changes Dec 7, 2024

View reviewed changes

datamweb reviewed Dec 7, 2024

View reviewed changes

utils/phpstan-baseline/codeigniter.unknownServiceMethod.neon Show resolved Hide resolved

kenjis added the github_actions Pull requests that update Github_actions code label Dec 9, 2024

kenjis reviewed Dec 9, 2024

View reviewed changes

.github/workflows/reusable-coveralls.yml Outdated Show resolved Hide resolved

kenjis added the refactor Pull requests that refactor code label Dec 9, 2024

paulbalandan force-pushed the split-phpstan-baseline branch 2 times, most recently from 35b2a34 to 17ca6ee Compare December 10, 2024 17:14

paulbalandan commented Dec 10, 2024

View reviewed changes

phpstan.neon.dist Show resolved Hide resolved

github-actions bot added the stale Pull requests with conflicts label Dec 11, 2024

This comment was marked as outdated.

Sign in to view

paulbalandan force-pushed the split-phpstan-baseline branch from 17ca6ee to 5978a9a Compare December 11, 2024 10:33

paulbalandan removed the stale Pull requests with conflicts label Dec 11, 2024

paulbalandan force-pushed the split-phpstan-baseline branch from 5978a9a to 4270d22 Compare December 11, 2024 16:02

github-actions bot added the stale Pull requests with conflicts label Dec 11, 2024

This comment was marked as outdated.

Sign in to view

paulbalandan force-pushed the split-phpstan-baseline branch from 4270d22 to 7f62e0e Compare December 11, 2024 16:56

paulbalandan removed the stale Pull requests with conflicts label Dec 11, 2024

paulbalandan force-pushed the split-phpstan-baseline branch 2 times, most recently from 18d59a4 to e8e2c9f Compare December 14, 2024 18:12

refactor: split phpstan-baseline into smaller files

b7a164b

paulbalandan added 2 commits December 15, 2024 02:14

Checkout base branch to resolve codeigniter4/framework

57b1617

Fix rector changes

8bceabc

paulbalandan force-pushed the split-phpstan-baseline branch from e8e2c9f to 8bceabc Compare December 14, 2024 18:14

paulbalandan requested a review from kenjis December 14, 2024 18:15

paulbalandan mentioned this pull request Dec 14, 2024

refactor: upgrade to use phpstan 2 and rector 2 #9322

Merged

5 tasks

kenjis approved these changes Dec 15, 2024

View reviewed changes

paulbalandan merged commit 242745c into codeigniter4:develop Dec 15, 2024
41 checks passed

paulbalandan deleted the split-phpstan-baseline branch December 15, 2024 00:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: split phpstan-baseline into smaller files #9299

refactor: split phpstan-baseline into smaller files #9299

paulbalandan commented Dec 2, 2024 •

edited

Loading

michalsn left a comment

ddevsr commented Dec 10, 2024 •

edited by paulbalandan

Loading

paulbalandan commented Dec 10, 2024

ddevsr commented Dec 10, 2024

This comment was marked as outdated.

samsonasik commented Dec 11, 2024

This comment was marked as outdated.

samsonasik commented Dec 14, 2024

kenjis left a comment

paulbalandan commented Dec 15, 2024

refactor: split phpstan-baseline into smaller files #9299

refactor: split phpstan-baseline into smaller files #9299

Conversation

paulbalandan commented Dec 2, 2024 • edited Loading

michalsn left a comment

Choose a reason for hiding this comment

ddevsr commented Dec 10, 2024 • edited by paulbalandan Loading

paulbalandan commented Dec 10, 2024

ddevsr commented Dec 10, 2024

This comment was marked as outdated.

samsonasik commented Dec 11, 2024

This comment was marked as outdated.

samsonasik commented Dec 14, 2024

kenjis left a comment

Choose a reason for hiding this comment

paulbalandan commented Dec 15, 2024

paulbalandan commented Dec 2, 2024 •

edited

Loading

ddevsr commented Dec 10, 2024 •

edited by paulbalandan

Loading