src/LanguageServer/Protocol/Handler/Completion/CompletionResolveHandler.cs - main - githubmirror/roslyn

src/LanguageServer/Protocol/Handler/Completion/CompletionResolveHandler.cs
137 строк6 KB
Cyrus Najmabadi
Reapply "Update methods to be `async`." (#81808)
31 дек 2025, 21:23
31 дек 2025, 21:23da211b4
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Composition;
using System.Linq;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Completion;
using Microsoft.CodeAnalysis.Host.Mef;
using Microsoft.CodeAnalysis.LanguageServer.Handler.Completion;
using Microsoft.CodeAnalysis.LanguageService;
using Microsoft.CodeAnalysis.Options;
using Microsoft.CommonLanguageServerProtocol.Framework;
using Roslyn.Utilities;
using LSP = Roslyn.LanguageServer.Protocol;

namespace Microsoft.CodeAnalysis.LanguageServer.Handler;

/// <summary>
/// Handle a completion resolve request to add description.
/// </summary>
/// <remarks>
/// This isn't a <see cref="ILspServiceDocumentRequestHandler{TRequest, TResponse}" /> because it could return null.
/// </remarks>
[ExportCSharpVisualBasicStatelessLspService(typeof(CompletionResolveHandler)), Shared]
[Method(LSP.Methods.TextDocumentCompletionResolveName)]
internal sealed class CompletionResolveHandler : ILspServiceRequestHandler<LSP.CompletionItem, LSP.CompletionItem>, ITextDocumentIdentifierHandler<LSP.CompletionItem, LSP.TextDocumentIdentifier?>
{
    private readonly IGlobalOptionService _globalOptions;

    public bool MutatesSolutionState => false;
    public bool RequiresLSPSolution => true;

    [ImportingConstructor]
    [Obsolete(MefConstruction.ImportingConstructorMessage, error: true)]
    public CompletionResolveHandler(IGlobalOptionService globalOptions)
    {
        _globalOptions = globalOptions;
    }

    public LSP.TextDocumentIdentifier? GetTextDocumentIdentifier(LSP.CompletionItem request)
        => GetTextDocumentCacheEntry(request);

    public async Task<LSP.CompletionItem> HandleRequestAsync(LSP.CompletionItem completionItem, RequestContext context, CancellationToken cancellationToken)
    {
        var completionListCache = context.GetRequiredLspService<CompletionListCache>();

        if (!completionListCache.TryGetCompletionListCacheEntry(completionItem, out var cacheEntry))
        {
            // Don't have a cache associated with this completion item, cannot resolve.
            context.TraceWarning("No cache entry found for the provided completion item at resolve time.");
            return completionItem;
        }

        var document = context.GetRequiredDocument();
        var capabilityHelper = new CompletionCapabilityHelper(context.GetRequiredClientCapabilities());

        return await ResolveCompletionItemAsync(
            completionItem, cacheEntry.CompletionList, document, _globalOptions, capabilityHelper, cancellationToken).ConfigureAwait(false);
    }

    public static async Task<LSP.CompletionItem> ResolveCompletionItemAsync(
        LSP.CompletionItem completionItem,
        Document document,
        IGlobalOptionService globalOptions,
        CompletionCapabilityHelper capabilityHelper,
        CompletionListCache completionListCache,
        CancellationToken cancellationToken)
    {
        if (!completionListCache.TryGetCompletionListCacheEntry(completionItem, out var cacheEntry))
        {
            // Don't have a cache associated with this completion item, cannot resolve.
            return completionItem;
        }

        return await ResolveCompletionItemAsync(
            completionItem, cacheEntry.CompletionList, document, globalOptions, capabilityHelper, cancellationToken).ConfigureAwait(false);
    }

    private static async Task<LSP.CompletionItem> ResolveCompletionItemAsync(
        LSP.CompletionItem completionItem,
        CompletionList cachedCompletionList,
        Document document,
        IGlobalOptionService globalOptions,
        CompletionCapabilityHelper capabilityHelper,
        CancellationToken cancellationToken)
    {
        // Find the matching completion item in the completion list
        var roslynItem = cachedCompletionList.ItemsList
            .FirstOrDefault(cachedCompletionItem => MatchesLSPCompletionItem(completionItem, cachedCompletionItem));

        if (roslynItem is null)
        {
            return completionItem;
        }

        var completionOptions = globalOptions.GetCompletionOptions(document.Project.Language);
        var symbolDescriptionOptions = globalOptions.GetSymbolDescriptionOptions(document.Project.Language);
        var completionService = document.Project.Services.GetRequiredService<CompletionService>();

        return await CompletionResultFactory.ResolveAsync(
            completionItem,
            roslynItem,
            ProtocolConversions.DocumentToTextDocumentIdentifier(document),
            document,
            capabilityHelper,
            completionService,
            completionOptions,
            symbolDescriptionOptions,
            cancellationToken).ConfigureAwait(false);
    }

    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
        // 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.Label == completionItem.SortText || lspCompletionItem.SortText?.EndsWith(completionItem.SortText) == true);
    }

    private static LSP.TextDocumentIdentifier? GetTextDocumentCacheEntry(LSP.CompletionItem request)
    {
        Contract.ThrowIfNull(request.Data);
        var resolveData = JsonSerializer.Deserialize<DocumentResolveData>((JsonElement)request.Data);
        if (resolveData is null)
        {
            Contract.Fail("Document should always be provided when resolving a completion item request.");
            return null;
        }

        return resolveData.TextDocument;
    }
}