[dx] Set Option::SOURCE parameter from the resolved paths - #8424
Merged
TomasVotruba merged 2 commits intoSep 6, 2026
Merged
Conversation
AbstractRectorTestCase sets it, a real run never does, so code reading the parameter works under the test harness and is empty in production. Excluded from the cache invalidation hash: the paths change per invocation, so hashing them would drop the cache whenever the target changes.
Set the parameters and assert, as UnusedSkipResolverTest does.
TomasVotruba
reviewed
Sep 6, 2026
| * @var array<Option::*> | ||
| */ | ||
| private const array CACHE_IGNORED_PARAMETER_NAMES = [ | ||
| Option::SOURCE, |
Contributor
Author
There was a problem hiding this comment.
Without it, the new setParameter() call puts the resolved paths into hashForCacheInvalidation(). They differ per invocation, so rector process src/Foo.php followed by rector process would produce two different hashes and drop the unchanged-files cache each time. With it, the hash is the same as it is today, the parameter becomes visible without changing caching at all.
It also matches what the list already describes: the target narrows which files are visited, it does not change how any file is refactored.
Removing just this line fails testSourceParameterIsOutsideTheCacheInvalidationHash.
Member
|
Thanks 👍 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Option::SOURCEis only written toSimpleParameterProviderbyAbstractRectorTestCase. A real run leaves it empty, so an extension reading the processed paths from the parameter works under the test harness and gets[]in production.I hit this in a rules package that reads
Option::PATHSand falls back toOption::SOURCEto learn which paths a run covers. The fallback works in its tests and never fires in a real run.ConfigurationFactory::resolvePaths()now sets it to the paths it resolved: the command line when given,Option::PATHSotherwise. It already setsIS_RUN_NARROWEDandFILES_WITHOUT_EXTENSIONthere.Option::SOURCEis also inCACHE_IGNORED_PARAMETER_NAMES: the resolved paths change per invocation, so hashing them would drop the cache whenever the target changes.