Rector conflicts with nikic/parser when using phpunit

[nikophil]

Hello,

I got a strange behavior where Rector conflicts with nikic/parser, but only when running phpunit.

I have a project with the following conf in composer.json:

{
    "require": {
        "php": "^8.2",
        "nikic/php-parser": "^5.0"
    },
    "require-dev": {
        "rector/rector": "^1.0",
        "symfony/phpunit-bridge": "6.4.*"
    },
}

I can run composer install without any problem, as well as accessing to my app via http. Even the project's test suite is OK.
The problem occurs when I want to run rector tests (which inherit from AbstractRectorTestCase.

➜ vendor/bin/simple-phpunit --filter AddEmbedResourceSerializationGroupRectorTest
PHPUnit 9.6.17 by Sebastian Bergmann and contributors.

Testing 
PHP Fatal error:  Cannot declare interface PhpParser\Node, because the name is already in use in /app/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/Node.php on line 6
PHP Fatal error:  Uncaught RuntimeException: The autoloader expected class "Composer\InstalledVersions" to be defined in file "/app/vendor/rector/rector/vendor/composer/../composer/InstalledVersions.php". The file was found but the class was not in it, the class name or namespace probably has a typo. in /app/vendor/symfony/error-handler/DebugClassLoader.php:350
Stack trace:
#0 /app/vendor/symfony/error-handler/DebugClassLoader.php(307): Symfony\Component\ErrorHandler\DebugClassLoader->checkClass()
#1 [internal function]: Symfony\Component\ErrorHandler\DebugClassLoader->loadClass()
#2 /app/vendor/symfony/error-handler/DebugClassLoader.php(443): class_exists()
#3 /app/vendor/symfony/error-handler/DebugClassLoader.php(334): Symfony\Component\ErrorHandler\DebugClassLoader->checkAnnotations()
#4 /app/vendor/symfony/error-handler/DebugClassLoader.php(263): Symfony\Component\ErrorHandler\DebugClassLoader->checkClass()
#5 /app/vendor/symfony/phpunit-bridge/DeprecationErrorHandler.php(198): Symfony\Component\ErrorHandler\DebugClassLoader::checkClasses()
#6 [internal function]: Symfony\Bridge\PhpUnit\DeprecationErrorHandler->shutdown()
#7 {main}
  thrown in /app/vendor/symfony/error-handler/DebugClassLoader.php on line 350

Fatal error: Cannot declare interface PhpParser\Node, because the name is already in use in /app/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/Node.php on line 6

Fatal error: Uncaught RuntimeException: The autoloader expected class "Composer\InstalledVersions" to be defined in file "/app/vendor/rector/rector/vendor/composer/../composer/InstalledVersions.php". The file was found but the class was not in it, the class name or namespace probably has a typo. in /app/vendor/symfony/error-handler/DebugClassLoader.php:350
Stack trace:
#0 /app/vendor/symfony/error-handler/DebugClassLoader.php(307): Symfony\Component\ErrorHandler\DebugClassLoader->checkClass()
#1 [internal function]: Symfony\Component\ErrorHandler\DebugClassLoader->loadClass()
#2 /app/vendor/symfony/error-handler/DebugClassLoader.php(443): class_exists()
#3 /app/vendor/symfony/error-handler/DebugClassLoader.php(334): Symfony\Component\ErrorHandler\DebugClassLoader->checkAnnotations()
#4 /app/vendor/symfony/error-handler/DebugClassLoader.php(263): Symfony\Component\ErrorHandler\DebugClassLoader->checkClass()
#5 /app/vendor/symfony/phpunit-bridge/DeprecationErrorHandler.php(198): Symfony\Component\ErrorHandler\DebugClassLoader::checkClasses()
#6 [internal function]: Symfony\Bridge\PhpUnit\DeprecationErrorHandler->shutdown()
#7 {main}
  thrown in /app/vendor/symfony/error-handler/DebugClassLoader.php on line 350

I'm also wondering if the problem does not come from Symfony's phpunit bridge, but even when using directly phpunit binary, I got the same error.

NOTE: I saw #6958 but the answers to this discussions seems to not be helpful in my case

any help would be appreciated :)

thanks!

[samsonasik]

Could you create simple reproducible repo and step by step to reproduce the error? Thank you.

[nikophil]

Hi!

thanks for your answer

here is a reproducer:
https://github.com/nikophil/rector-bug-reproducer

I basically did:

$ composer req symfony/flex symfony/framework-bundle
$ composer req test
$ composer req nikic/php-parser
$ composer req --dev rector/rector
$ vendor/bin/rector custom-rule

and then:

$ vendor/bin/simple-phpunit
PHPUnit 9.6.17 by Sebastian Bergmann and contributors.

Testing 
PHP Fatal error:  Cannot declare interface PhpParser\Parser, because the name is already in use in /home/nikophil/works/github.com/nikophil/rector-bug-reproducer/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/Parser.php on line 6

Fatal error: Cannot declare interface PhpParser\Parser, because the name is already in use in /home/nikophil/works/github.com/nikophil/rector-bug-reproducer/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/Parser.php on line 6

note that nikic/parser seems to be the only dep in vendor/rector/rector/vendor which seems to be not prefixed. Don't know if this is made on purpose

[samsonasik]

not sure, probably some conflict with symfony deps

[nikophil]

Actually, when I comment out this line, the problem does not occur.

Symfony's error handler seems to be buggy towards this. When I disable SymfonyTestsListener everything works!

At the end, in my real project, I'll use another phpunit config file specific for rector.

Thanks a lot for your support! 🙏

[staabm]

fwiw, we are diving deeper into this problem in #8567 (comment)

[nikophil]

super nice, because, in my real life project, I still don't manage to make it work

[devnix]

@nikophil had the same problem: uninstall symfony/phpunit-bridge

[ivastly]

at the time of writing this error is still reproducable (rector 2.1.7, phpstan 2.1.27, nikic/php-parser 5.6.1). Found a dirty fix just to run the tests for my own rector rules - just add return; at the first line of vendor/rector/rector/preload.php.

Rector tool itself stops working after this, so I need to always jump between the dirty fix to run the tests and original version to run rector.

[samsonasik]

Hi @ivastly , this happen mostly on phpunit 12, you can preload it in composer.json:

{
    "autoload-dev": {
        "psr-4": {
            "Your\\Test\\": "tests/"
        },
        "files": [
            "vendor/rector/rector/preload.php"
        ]
    }
}

see documentation https://getrector.com/documentation/troubleshooting-preload

[ivastly]

works like a charm, thanks a lot! So strange that my LLM has not suggested this fix right away. It proposed to use rector-src repo instead.