Add support for result cache meta extensions

[Wirone]

Important

This feature was brought to you thanks to GetResponse - Marketing Software for Professional Email Marketing, which paid for my work on this.

This introduces contract for extending the way how result cache metadata is calculated, so PHPStan extensions can take part into deciding whether analysis should be re-run or its result can be re-use from cache.

It is a base for phpstan/phpstan-symfony#255, which needs separate PR that introduces ResultCacheMetaExtension for Symfony DI container. It will be done when this gets merged (and released?).

@ondrejmirtes I need some help / your decisions:

• I did not add any tests, as I don't see any tests for ResultCacheManager. Please point me how/if I should test this extension point. Just run make build and verified everything passes.
• I've added phpstanExtensions entry to the array with metadata but I am not 100% satisfied with it. Maybe it should be metaExtensions or metaFromPhpstanExtensions or something different. Or maybe it shouldn't be nested, but merged with the main array? Let me know.
• I've added this to ConditionalTagsExtension because after code analysis and seeing how e.g. DiagnoseExtension is implemented I've encountered such usage and thought ResultCacheManager should be there too. But it's a wild guess only, please let me know if I should keep it there.
• Should any of existing ResultCacheManager::getMeta() items be converted to an extension? That could act as e2e test, but also could require some hacks in order to keep backward compatibility with existing result caches (depending on the scheme of the array with metadata).

[ondrejmirtes]

is there a way to start working on phpstan/phpstan-symfony extension before this is merged and released

No need to do that. First we need to agree how it should work here, then merge it, then you can require ^2.1.1 in phpstan-symfony

[ondrejmirtes]

Really nice! You almost nailed it :)

If you wanted to add a test, it'd make sense to do an E2E test similar to what we do here:

phpstan-src/.github/workflows/e2e-tests.yml

Lines 128 to 137 in b614f70

	- script: |
	cd e2e/bug-9622-trait
	echo -n > phpstan-baseline.neon
	../../bin/phpstan -vvv
	patch -b src/Foo.php < patch-1.patch
	cat baseline-1.neon > phpstan-baseline.neon
	../../bin/phpstan -vvv
	mv src/Foo.php.orig src/Foo.php
	echo -n > phpstan-baseline.neon
	../../bin/phpstan -vvv

1. Create an example project under e2e directory
2. Create some sample result cache meta extension there that would return different hash based on something we'll change later
3. Run PHPStan, Run PHPStan again with --fail-without-result-cache - should exit with 0
4. Change the thing that will change the hash. Can be some txt file within the project.
5. Run PHPStan again with --fail-without-result-cache, should error. You can assert the output with bashunit similarly to here

   phpstan-src/.github/workflows/e2e-tests.yml

   Lines 172 to 176 in b614f70

   	OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyze --no-progress --level 8 --error-format raw data/")
   	echo "$OUTPUT"
   	../bashunit -a line_count 2 "$OUTPUT"
   	../bashunit -a matches "Note: Using configuration file .+phpstan.neon." "$OUTPUT"
   	../bashunit -a contains 'Method class@anonymous/TestClassUsingTrait.php:20::doBar() should return stdClass but returns Exception.' "$OUTPUT"

[Wirone]

@ondrejmirtes rebased on top of 2.1.x and updated to follow your review. Thanks for the guidance, it was really helpful 🙂.

[ondrejmirtes]

Thank you. Now you can send the portion in phpstan-symfony while requiring PHPStan ^2.1.2 :)

[ondrejmirtes]

Docs: phpstan/phpstan@3fa1a7c

[Wirone]

Thank you. Now you can send the portion in phpstan-symfony while requiring PHPStan ^2.1.2 :)

@ondrejmirtes is 2.1.2 going to be tagged soon? I would like to start working on Symfony extension 🙂.

[ondrejmirtes]

You can put that requirement in composer.json in the extension now and it's going to download the current dev version.

[Wirone]

Yeah, I just did it and was surprised it worked (Installing phpstan/phpstan (2.1.x-dev 3fa1a7c)) 😅. What kind of sorcery is this? Is this Composer's thing (like automatically take 2.1.x-dev if the constraint requires not released version and there's "minimum-stability": "dev") 🤔?

[ondrejmirtes]

Yeah, probably something like that.