fixes remote caching not managing resource files #6554
Merged
Conversation
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
What is the problem? When using remote caching, the resource files are not tracked so if they have changed, pullRemoteCache will deliver both the old resource file as well as the changed one. This is a problem, because it's not the behaviour that our users will expect and it's not in keeping with the contract of this feature. Why is this happening? Zinc, sbt's incremental compiler, keeps track of changes that have been made. It keeps this in what is called the Analysis file. However, resource files are not tracked in the Analysis file, so remote caching is not invalidating the unchanged resource file in place of the latest version. What is the solution? PullRemoteCache deletes all of the resources files. After this, copyResources is called by PackageBin, which puts the latest version of the resources back.
|
I think this fix is good on its own, and is ready to merge. I've actually thought of another cool way to fix this. When we saw copyResources: sbt/main/src/main/scala/sbt/Defaults.scala Lines 2529 to 2535 in 4926cb4 that is sort of doing something like incremental compilation, but it's just not virtualized like this PR does. So... if we take |
sebastian-alfers
added a commit
to sebastian-alfers/sbt
that referenced
this pull request
Jun 20, 2021
Merge pull request sbt#6551 from samuelClarencTeads/bspIntegrationTestTag Add the tag "integration-test" to the it configuration in BSP. fixes remote caching not managing resource files What is the problem? When using remote caching, the resource files are not tracked so if they have changed, pullRemoteCache will deliver both the old resource file as well as the changed one. This is a problem, because it's not the behaviour that our users will expect and it's not in keeping with the contract of this feature. Why is this happening? Zinc, sbt's incremental compiler, keeps track of changes that have been made. It keeps this in what is called the Analysis file. However, resource files are not tracked in the Analysis file, so remote caching is not invalidating the unchanged resource file in place of the latest version. What is the solution? PullRemoteCache deletes all of the resources files. After this, copyResources is called by PackageBin, which puts the latest version of the resources back. Merge branch 'develop' into remote-cache Merge pull request sbt#6554 from Nirvikalpa108/remote-cache fixes remote caching not managing resource files Merge branch 'develop' into restore-charridge-return cleanup spec; Merge branch 'restore-charridge-return' of github.com:sebastian-alfers/sbt into restore-charridge-return
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
…yncing An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
…yncing An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
…yncing An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Jul 31, 2021
…yncing An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Oct 30, 2021
…yncing An alternative to sbt#6554.
Nirvikalpa108
pushed a commit
to Nirvikalpa108/sbt
that referenced
this pull request
Oct 30, 2021
…yncing An alternative to sbt#6554.
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.
What is the problem? 😔
When using remote caching, the resource files are not tracked so if they have changed, pullRemoteCache will deliver both the old resource file as well as the most recent version.
This is a problem, because it's not the behaviour that our users will expect and it's not in keeping with the contract of this feature.
Why is this happening?
Zinc, sbt's incremental compiler, keeps track of changes that have been made. It keeps this in what is called the Analysis file. However, resource files are not tracked in the Analysis file, so remote caching is not invalidating the unchanged resource in place of the new one.
What is the solution? 😃
PullRemoteCache deletes all of the resources files. After this, copyResources is called by PackageBin, which puts the latest
version of the resources back.
fixes #6394