Configuration cache (JVM-local support only, just an idea) #721
Conversation
This file contains 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
… place where this is handled to be config-cache friendly.
…ed to reference the "worker" task `spotlessFoo` to do various things. We create a `SpotlessTaskService implements BuildService` to serve this role, which allows configuration cache to complete without errors.
…potlessTask from a previous build (the last build which actually configured)
…serialization error: ``` Caused by: java.lang.InstantiationError: [B at org.gradle.instantexecution.serialization.beans.BeanPropertyReader.newBean(BeanPropertyReader.kt:58) at org.gradle.instantexecution.serialization.beans.BeanStateReader$DefaultImpls.newBeanWithId(BeanStateReader.kt:25) at org.gradle.instantexecution.serialization.beans.BeanPropertyReader.newBeanWithId(BeanPropertyReader.kt:37) ```
|
The commit two above this implements Solution 2 using a The commit one above this shows that we still have serialization problems, probably related to gradle/gradle#13588 |
|
TODO: If a git branch changes location during a string of configuration cache runs, we need to update this value. Should be pretty easy to create a |
nedtwigg
commented
Nov 8, 2021
Comment on lines
+51
to
+73
| Formatter buildFormatter() { | ||
| // <sketchy configuration cache trick> | ||
| SpotlessTaskImpl original = SpotlessTaskService.instance().get(getPath()); | ||
| if (original == this) { | ||
| // a SpotlessTask is registered with the SpotlessTaskService **only** if configuration ran | ||
| // so if we're in this block, it means that we were configured | ||
| return Formatter.builder() | ||
| .lineEndingsPolicy(lineEndingsPolicy) | ||
| .encoding(Charset.forName(encoding)) | ||
| .rootDir(getProjectDir().toPath()) | ||
| .steps(steps) | ||
| .exceptionPolicy(exceptionPolicy) | ||
| .build(); | ||
| } else { | ||
| // if we're in this block, it means that configuration did not run, and this | ||
| // task was deserialized from disk. All of our fields are ".equals" to their | ||
| // originals, but their transient fields are missing, so we can't actually run | ||
| // them. Luckily, we saved the task from the original, just so that we could restore | ||
| // its formatter, whose transient fields are fully populated. | ||
| return original.buildFormatter(); | ||
| } | ||
| // </sketchy configuration cache trick> | ||
| } |
There was a problem hiding this comment.
One answer to https://discuss.gradle.org/t/how-to-determine-if-configuration-cache-is-enabled/41383 (pt 1 of 2)
Comment on lines
+37
to
+43
| synchronized void put(SpotlessTaskImpl task) { | ||
| map.put(task.getPath(), task); | ||
| } | ||
|
|
||
| synchronized SpotlessTaskImpl get(String taskPath) { | ||
| return Objects.requireNonNull(map.get(taskPath), taskPath); | ||
| } |
There was a problem hiding this comment.
nedtwigg
changed the title
|
#986 implements this idea but implemented better. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR builds on top of #720, to build full support for the configuration cache. The big thing left is that everything in Spotless (namely the git line-endings policy and all the FormatterStep) need to become round-trip serializable, with custom
readObject/writeObjectmethods.In many places throughout Spotless, we use a trick where if two objects serialize to the same bytes, then they are equal. To make that work, almost everything in Spotless is serializable, but there are lots of
transientfields, which are not correctly restored when an object is deserialized. I can think of two solutions:BuildServicewhich persists across the lifetime of a given configuration-cache, and use that to "rehydrate" fields which are not correctly deserialized.Solution 2 is a lot easier for us, and it also has the benefit that it would support Spotless' full suite of features. With solution 1, we will never be able to support closures which are in-line within a buildscript. That would be a real shame, because Gradle's inline closures are such a great part of the tool, and every plugin (not just Spotless) will be unable to use such closures unless there is some kind of long-lived
BuildService.