Fix a race condition in IDE diagnostic service for stale diagnostics #60365
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
Fixes [AB#1487574](https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1487574/) If you edit a document, which either fixes or introduces compiler diagnostics in another open document, but you do a tab switch to that open document before diagnostic computation kicked off by prior edit finishes, than we end up cancelling existing tasks queued for diagnostic computation from that prior edit. We kick off new tasks for diagnostic computation for the new active document, but the newly active document did not have any code change, so has identical text and semantic version and we end up skipping diagnostics computation for it, leaving behind stale diagnostics OR not showing new diagnostics that were introduced from the edit in prior active document. Fix is to always recompute the active document diagnostics on switching active documents and avoid any possible race conditions
CyrusNajmabadi
approved these changes
Mar 24, 2022
This was referenced Mar 24, 2022
ryzngard
approved these changes
Mar 24, 2022
|
@dotnet/roslyn-infrastructure Can someone please help force merge this? Integration test failures seem to be unrelated known failures. Thanks! |
|
Ping @dotnet/roslyn-infrastructure for help in force merge |
ghost
modified the milestones:
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.
Fixes AB#1487574
If you edit a document, which either fixes or introduces compiler diagnostics in another open document, but you do a tab switch to that open document before diagnostic computation kicked off by prior edit finishes, than we end up cancelling existing tasks queued for diagnostic computation from that prior edit. We kick off new tasks for diagnostic computation for the new active document, but the newly active document did not have any code change, so has identical text and semantic version and we end up skipping diagnostics computation for it, leaving behind stale diagnostics OR not showing new diagnostics that were introduced from the edit in prior active document.
Fix is to always recompute the active document diagnostics on switching active documents and avoid any possible race conditions
Before fix - stale diagnostics
After fix - up-to-date diagnostics