Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix resolving import completion item in LSP #69454

Merged
merged 1 commit into from
Aug 10, 2023
Merged

Fix resolving import completion item in LSP #69454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/Features/LanguageServer/Protocol/Handler/Completion/CompletionResolveHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,11 @@ await creationService.ResolveAsync(

private static bool MatchesLSPCompletionItem(LSP.CompletionItem lspCompletionItem, CompletionItem completionItem)
{
// We want to make sure we are resolving the same unimported item in case we have multiple with same name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of doing this, we could consider adding information to the completion item resolve data that would definitively indicate which one we're resolving. Fine whichever you think is best.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That does have the advantage of immune to change client might make to the resolve request in the future, with the cost of extra data on each unimported item. Let's take this fix for now, assuming such change would be very rare, but if it turns out not to be the case, we can switch to your proposal.

// but from different namespaces. However, VSCode doesn't include labelDetails in the resolve request, so we
// compare SortText instead when it's set (which is when label != SortText)
return lspCompletionItem.Label == completionItem.GetEntireDisplayText()
&& (lspCompletionItem.LabelDetails?.Description ?? string.Empty) == completionItem.InlineDescription;
&& (lspCompletionItem.SortText is null || lspCompletionItem.SortText == completionItem.SortText);
}

private CompletionListCache.CacheEntry? GetCompletionListCacheEntry(LSP.CompletionItem request)
Expand Down
4 changes: 4 additions & 0 deletions src/Features/LanguageServer/ProtocolUnitTests/Completion/CompletionFeaturesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,10 @@ void M()
itemFromNS1.Data = completionResult.ItemDefaults.Data;
itemFromNS2.Data = completionResult.ItemDefaults.Data;

// Remove the label details as this is the behavior of the VSCode client when resolving completion items.
itemFromNS1.LabelDetails = null;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this is why the unit tests didn't catch it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea. And I blame jetlag as the reason why it's not caught by manual testing

itemFromNS2.LabelDetails = null;

var resolvedItem1 = await testLspServer.ExecuteRequestAsync<LSP.CompletionItem, LSP.CompletionItem>(LSP.Methods.TextDocumentCompletionResolveName, itemFromNS1, CancellationToken.None).ConfigureAwait(false);
Assert.Equal("Namespace1", resolvedItem1.LabelDetails.Description);
Assert.Equal("~MyClass Namespace1", resolvedItem1.SortText);
Expand Down
Loading