Fix error closing source link documents in VSCode #74862
Merged
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 https://devdiv.visualstudio.com/DevDiv/_workitems/edit/2222267/ where closing a sourcelink document would crash the server.
There were two changes that led to this issue
IMetadataAsSourceFileService.TryAddDocumentToWorkspaceandIMetadataAsSourceFileService.TryRemoveDocumentFromWorkspaceactually added and removed documents from the workspace - which was true for metadata and decompilation. This meant if the document was already found in a workspace, we would skip callingTryAddDocumentToWorkspacein LSP.PdbSourceDocumentMetadataAsSourceFileProvider.TryAddDocumentToWorkspaceandPdbSourceDocumentMetadataAsSourceFileProvider.TryRemoveDocumentFromWorkspacedid not actually add/remove from the workspace - that happened inGetGeneratedFileAsync.So what happened was that
TryAddDocumentToWorkspacewas sometimes not called because the sourcelink document was already added to to theMetadataAsSourceworkspace when the original go to definition request was made. So closing the document would throw because the document was never opened.There were a couple ways to fix this. I chose modifying
PdbSourceDocumentMetadataAsSourceFileProviderto match the contract to add and remove the document from the WS inTryAddDocumentToWorkspaceTryRemoveDocumentFromWorkspace.