Prohibit BuildServiceProviders in configuration cache fingerprint#24099
Merged
Conversation
bamboo
reviewed
Mar 2, 2023
Member
There was a problem hiding this comment.
🟡 I think used at configuration time is too generic and it might become a source of confusion but I don't have a better suggestion right now.
Member
Author
There was a problem hiding this comment.
I don't think it is possible to hit this without going through a ValueSource, but I might be missing something here, so I went with a generic term. "Fingerprinting" would be more precise, but we don't have it as a user-facing concept,AFAIK.
Custom ValueSource implementations may fail to serialize. Prior to this commit, the failure was attributed to "Gradle runtime" which is misleading. Now it is attributed to the build file or plugin that produces the input.
The typical way to make something an input to the configuration is to use the ValueSource, and then obtain its value at configuration time. Gradle recomputes these ValueSources when checking if the configuration cache is still valid. However, at this point not all build state is restored, but only a subset of it. This subset is not enough to restore BuildServices if these are used as ValueSource inputs. Before Gradle was failing the build with rather cryptic "cannot find project :" error, and only when running from the cache - the initial storing build was fine, even with load-after-store. With this commit, a special set of codecs is used to store the fingerprinting data, in which the BuildServiceProviders are explicitly not supported. This way we can detect the providers even in long mapping chains. We may revisit the decision and make it possible to use BuildServices in the future, but it requires a large rewrite of the fingerprinting code.
This is unlikely to happen, as this thing is hard to get as a configuration input anyway, so it is just-in-case.
1aa8fb6 to
ec99b69
Compare
Member
Author
|
@bot-gradle test ACC |
Collaborator
|
I've triggered the following builds for you: |
Member
Author
|
@bot-gradle test and merge |
Collaborator
|
I've triggered a build for you. |
hythloda
reviewed
Mar 3, 2023
| [[config_cache:not_yet_implemented:build_services_in_fingerprint]] | ||
| === Using build services to invalidate the configuration cache | ||
|
|
||
| Currently, it is not possible to use a `BuildServiceProvider` or provider derived of it with `map` or `flatMap` as a parameter for the `ValueSource`, if the value of the `ValueSource` is accessed at configuration time. |
Contributor
There was a problem hiding this comment.
💄
Suggested change
| Currently, it is not possible to use a `BuildServiceProvider` or provider derived of it with `map` or `flatMap` as a parameter for the `ValueSource`, if the value of the `ValueSource` is accessed at configuration time. | |
| Currently, it is impossible to use a `BuildServiceProvider` or provider derived from it with `map` or `flatMap` as a parameter for the `ValueSource`, if the value of the `ValueSource` is accessed at configuration time. |
hythloda
reviewed
Mar 3, 2023
| === Using build services to invalidate the configuration cache | ||
|
|
||
| Currently, it is not possible to use a `BuildServiceProvider` or provider derived of it with `map` or `flatMap` as a parameter for the `ValueSource`, if the value of the `ValueSource` is accessed at configuration time. | ||
| The same applies such `ValueSource` is obtained in a task that executes as part of configuration phase, for example tasks of the `buildSrc` build or included builds contributing plugins. |
Contributor
There was a problem hiding this comment.
💄
Suggested change
| The same applies such `ValueSource` is obtained in a task that executes as part of configuration phase, for example tasks of the `buildSrc` build or included builds contributing plugins. | |
| The same applies such as `ValueSource` is obtained in a task that executes as part of the configuration phase, for example, tasks of the `buildSrc` build or included builds contributing plugins. |
Member
Author
There was a problem hiding this comment.
@hythloda thank you for the review, I'll apply your suggestions in a follow-up PR.
Regarding this one, I missed a conjunction here, and intended to write "The same applies when such a ValueSource". Is it correct?
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
4 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.
Fixes #22337