[autoload] Add workaround for phpstan + rector tests co-run to avoid duplicated php-parser loading error

[TomasVotruba]

This happens when:

• project uses phpstan rule tests
• phpunit runs
• rector rule test case runs second

[samsonasik]

This may cause invalid phpunit test for rector rules, since we need load preload script, see

rector-src/src/Testing/PHPUnit/AbstractLazyTestCase.php

Lines 62 to 75 in 366f329

	private function includePreloadFilesAndScoperAutoload(): void
	{
	if (file_exists(__DIR__ . '/../../../preload.php')) {
	if (file_exists(__DIR__ . '/../../../vendor')) {
	require_once __DIR__ . '/../../../preload.php';
	// test case in rector split package
	} elseif (file_exists(__DIR__ . '/../../../../../../vendor')) {
	require_once __DIR__ . '/../../../preload-split-package.php';
	}
	}
	if (\file_exists(__DIR__ . '/../../../vendor/scoper-autoload.php')) {
	require_once __DIR__ . '/../../../vendor/scoper-autoload.php';
	}

Also, please run the script:

php build/build-preload.php .

so it regenerated and we can test.

[samsonasik]

this may cause repetitive apply cs after rebuild weekly, if cs is required, the cs fix position needs to be after generate preload on workflow build so it always have same result:

rector-src/.github/workflows/weekly_pull_requests.yaml

Lines 21 to 29 in 89bfc23

	-
	name: 'Apply Coding Standard'
	run: "composer fix-cs"
	branch: 'automated-apply-coding-standards'
	-
	name: 'Re-Generate preload.php'
	run: "composer preload"
	branch: 'automated-regenerated-preload'

or on build/build-preload.php script, or add use statement early there.

[samsonasik]

/cc @Androoha1 @nikophil @staabm @megawubs could you verify manual this patch, thank you.

update vendor/rector/rector/preload.php with the preload.php updated here.

[samsonasik]

Also @ivastly @nikophil @devnix , could you verify manual this patch with the following steps, thank you.

• remove hack on composer.json -> files handling
• run composer update
• Manually update vendor/rector/rector/preload.php with the preload.php updated here

[samsonasik]

Also @ostrolucky @smnandre could you verify manual this patch with the following steps, thank you.

• remove hack on composer.json -> files handling
• run composer update
• Manually update vendor/rector/rector/preload.php with the preload.php updated here.

Ref of existing PR on your repository that use composer.json -> files handling.

• chore!: handle conflict phpunit 12+ conflict preload with rector ostrolucky/rector-rules#44

[samsonasik]

@TomasVotruba I tested manually on https://github.com/ostrolucky/rector-rules repository, and seems still error:

➜  rector-rules git:(main) ✗ vendor/bin/phpunit
PHP Fatal error:  Cannot declare interface PhpParser\NodeVisitor, because the name is already in use in /Users/samsonasik/www/rector-rules/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/NodeVisitor.php on line 6

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

Step to reproduce:

• git clone https://github.com/ostrolucky/rector-rules
• Run composer install
• Manually update vendor/rector/rector/preload.php with the patch.
• Run vendor/bin/phpunit

[staabm]

could you verify manual this patch, thank you.

@samsonasik what do you want to be tested?

[samsonasik]

@staabm I already tested on phpunit 12, and it still error with this patch as above #7440 (review)

➜  rector-rules git:(main) ✗ vendor/bin/phpunit
PHP Fatal error:  Cannot declare interface PhpParser\NodeVisitor, because the name is already in use in /Users/samsonasik/www/rector-rules/vendor/rector/rector/vendor/nikic/php-parser/lib/PhpParser/NodeVisitor.php on line 6

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

Step to reproduce:

• git clone https://github.com/ostrolucky/rector-rules
• Run composer install
• Manually update vendor/rector/rector/preload.php with the patch.
• Run vendor/bin/phpunit

[TomasVotruba]

@samsonasik This is not related to PHPUnit 12. This bug existed before. It's about order of the tests loaded.
If PHPStan test case is loaded first (by any testing tool), then RectorTestCase, it would trigged loading php-parser classes twice. This PR avoid it and gives priority to PHPStan classes. Despite not having access to stmts aware interface, that's the trade off.

[samsonasik]

@TomasVotruba then the tweak still needed? I tested on https://github.com/ostrolucky/rector-rules, apply this patch, and still error.

[TomasVotruba]

Let's give it a go. Test this in projects with both PHPStan and Rector tests.

[TomasVotruba]

@samsonasik For PHPUnit 12, yes. This is not related to PHPUnit version, but autoload.

[samsonasik]

also preload-split-package.php:

Suggested change

	__DIR__ . '/preload.php',
	__DIR__ . '/preload.php',
	__DIR__ . '/preload-split-package.php',

[TomasVotruba]

I'll check https://github.com/ostrolucky/rector-rules repo

[samsonasik]

new line is needed here.

[samsonasik]

see PR:

• Avoid apply cs on preload-split-package.php #7441

[TomasVotruba]

Let's try reviving 3 years old PR that solves this magic autoload workarounds :)
nikic/PHP-Parser#836

[samsonasik]

@TomasVotruba for note, we not only patch to apply StmtsAwareInterface, but also NodeTraverser.php for cache NodeVisitor

https://github.com/rectorphp/vendor-patches/blob/18e174cbea7beaccb140cfcf03cca3097e95ee92/patches/nikic-php-parser-lib-phpparser-nodetraverser-php.patch

so we still can't rely on "in project" nikic/php-parser vendor.

[samsonasik]

@TomasVotruba in preload.php, we also load phpstan-phpdoc-parser classes, so the order still matters.

rector-src/build/build-preload.php

Lines 172 to 186 in 69ccff5

	private function buildPreloadScriptForSplitPhpDocParser(string $buildDirectory, string $preloadFile): void
	{
	$vendorDir = $buildDirectory . '/vendor';
	if (! is_dir($vendorDir . '/phpstan/phpdoc-parser')) {
	return;
	}
	// 1. find phpdoc-parser file infos
	$fileInfos = $this->findPhpDocParserFilesAndSortThem($vendorDir);
	// 2. create preload-split-package.php from provided files
	$preloadFileContent = $this->createPreloadFileContentForSplitPackage($fileInfos, true);
	file_put_contents($preloadFile, $preloadFileContent, FILE_APPEND);
	}

[TomasVotruba]

@samsonasik Let's resolve one problem at a time.

[nikophil]

Hi @samsonasik

sorry for the late reply.

I tried to update rector, and manualy modify preload.php and still have the problem with PhpParser

tried on Foundry's rules : vendor/bin/phpunit -c phpunit-rector.xml.dist

[TomasVotruba]

@nikophil This is not related to your issue. It's a different case: #7440 (comment)