Resolve a concurrency bug that could cause the IDE server not to send updates for a particular version #5299
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
…ate IdeStates with an old version, because between a call to DocumentUpdate and StartNewCompilation, latestIdeState was set by an old compilation
MikaelMayer
approved these changes
Apr 5, 2024
| @@ -47,6 +46,7 @@ public record IdeState( | |||
| ImmutableDictionary<Uri, DocumentVerificationTree> VerificationTrees | |||
| ) { | |||
| public Uri Uri => Input.Uri.ToUri(); | |||
| public int Version => Input.Version; | |||
There was a problem hiding this comment.
Is Input.Version mutable? If so, this might cause concurrency issues. I think you already realized that the more immutable, the less concurrency issues.
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.
Description
latestIdeStatewith an updated version, as it should, but after that an old compilation would also setlatestIdeStatewith an old version, and the new compilation would pick up this old version and keep using it. The notification publisher would then not send any updates because it would consider them to be for an old version. The old compilation being able to setlatestIdeStatewhen it should not was caused by a call toobserverSubscription.Dispose();being done too late, and this PR resolves that.How has this been tested?
I don't know how to reproduce the issue, but this PR should greatly reduce the amount of random test failures. We could rerun the XUnit tests on this PR a few times to get more confidence.
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.