Caching and multiple configurations for a project

[mfn]

Feature request

The documentation https://phpstan.org/user-guide/result-cache is quite clear to me:

You should always analyse the whole project - the list of paths passed to the analyse command should be the same to take advantage of the result cache. If the list of paths differs from run to run, the cache is rebuilt from the ground up each time.

I experiences this when having a project with two phpstan configuration files:

• phpstan.neon
  and
• phpstan-tests.neon

Running phpstan with one config invalidates the result of the other.

The solution was to be explicit about the tmpDir in each configuration file, as documented in https://phpstan.org/config-reference#caching .

Suggestion: would it make sense to consider the "config file name" as part of the cache key so multiple configs wouldn't cancel out each other?

Thanks! :)

[ondrejmirtes]

Hi, there's simply one result cache per tmpDir. Your needs are already solved with different tmpDir per config file so this change would seem redundant.

You can also probably solve this by merging phpstan.neon and phpstan-tests.neon and run PHPStan only once. If you execute different rules (different level) for src and tests then you can probably solve this by introducing the baseline :)

[mfn]

If you execute different rules (different level) for src and tests then you can probably solve this by introducing the baseline :)

No, they're completely different. Different parameters, different rules, etc.

there's simply one result cache per tmpDir.

Oh. But how does this work when I've multiple, completely independently, projects who all default to the system tmpDir? Are they interfering with each other, too?

[ondrejmirtes]

Are they interfering with each other, too?

Currently yes.

[mfn]

Uh… 💥 😏

[voku]

Thanks for this discussion, now I know that I have to configure different tmp directories, but it would be even clearer if there where a cacheDir setting.

[mfn]

With the recent support of PhpStorm for phpstan, I think I observed the following:

• run phpstan regular (in the terminal), builds cache
• run it regular again, uses cache
• configure phpstan in phpstorm
• when phpstorm triggers the validation (of a single file!) it seems the whole cache is invalidated
• and when I run phpstan regular (terminal) again, it rebuilds the cache

In both cases I use the same configuration.

Anyone observing this too?

Is this an independent issue or maybe related to this?

[ondrejmirtes]

This is currently expected - running PHPStan on a single file overwrites the whole cache and caches the result for that file.

[mfn]

I guess I could fix it by providing yet another configuration file for the PhpStorm integration with yet another tmpDir… 🤔

[ondrejmirtes]

I could skip cache-saving in PHPStan when only files are passed on the command line.

[ondrejmirtes]

I just made a few improvements to result cache:

• Result cache does not get restored and saved when only files and not directories are passed as analysed paths: phpstan/phpstan-src@dd11e25 (released in 0.12.57)
• Result cache does not get invalidated when only ignoreErrors changes (phpstan/phpstan-src@ef84d94) - this makes working with the baseline instantaneous! (released in 0.12.57)
• Configurable result cache path (phpstan/phpstan-src@518b20d) - now in dev-master

So this issue can be closed, because now you can set resultCachePath: %tmpDir%/resultCache-tests.php in phpstan-tests.neon and it will do what you expect ;)

[mfn]

Nice, thank you @ondrejmirtes !

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.