src/LanguageServer/ProtocolUnitTests/InlayHint/CSharpInlayHintTests.cs - main - githubmirror/roslyn

src/LanguageServer/ProtocolUnitTests/InlayHint/CSharpInlayHintTests.cs
167 строк7 KB
David Barbet
Refactor LSP server logging to remove singleton lsp instance (#84001)
16 июн 2026, 05:04
16 июн 2026, 05:0482e81e5
// 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.Linq;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.InlineHints;
using Microsoft.CodeAnalysis.LanguageServer.Handler.InlayHint;
using Microsoft.CodeAnalysis.Text;
using Roslyn.LanguageServer.Protocol;
using Roslyn.Test.Utilities;
using Xunit;
using Xunit.Abstractions;
using LSP = Roslyn.LanguageServer.Protocol;

namespace Microsoft.CodeAnalysis.LanguageServer.UnitTests.InlayHint;

public sealed class CSharpInlayHintTests : AbstractInlayHintTests
{
    public CSharpInlayHintTests(ITestOutputHelper testOutputHelper) : base(testOutputHelper)
    {
    }

    [Theory, CombinatorialData]
    public Task TestOneInlayParameterHintAsync(bool mutatingLspWorkspace)
        => RunVerifyInlayHintAsync("""
            class A
            {
                void M(int x)
                {
                }

                void M2()
                {
                    M({|x:|}5);
                }
            }
            """, mutatingLspWorkspace);

    [Theory, CombinatorialData]
    public Task TestMultipleInlayParameterHintsAsync(bool mutatingLspWorkspace)
        => RunVerifyInlayHintAsync("""
            class A
            {
                void M(int a, double b, bool c)
                {
                }

                void M2()
                {
                    M({|a:|}5, {|b:|}5.5, {|c:|}true);
                }
            }
            """, mutatingLspWorkspace);

    [Theory, CombinatorialData]
    public Task TestOneInlayTypeHintAsync(bool mutatingLspWorkspace)
        => RunVerifyInlayHintAsync("""
            class A
            {
                void M()
                {
                    var {|int:|}x = 5;
                }
            }
            """, mutatingLspWorkspace);

    [Theory, CombinatorialData]
    public Task TestMultipleInlayTypeHintsAsync(bool mutatingLspWorkspace)
        => RunVerifyInlayHintAsync("""
            using System;
            class A
            {
                void M()
                {
                    var {|int:|}x = 5;
                    var {|object:|}obj = new Object();
                }
            }
            """, mutatingLspWorkspace);

    [Theory, CombinatorialData]
    public Task TestInlayTypeHintsDeconstructAsync(bool mutatingLspWorkspace)
        => RunVerifyInlayHintAsync("""
            class A
            {
                void X((int, bool) d)
                {
                    var (i, b) = d;
                }
            }
            """, mutatingLspWorkspace, hasTextEdits: false);

    [Theory, CombinatorialData]
    public async Task TestReturnsInlayHintsEvenIfCacheMisses(bool mutatingLspWorkspace)
    {
        var markup =
            """
            class A
            {
                void M()
                {
                    var {|int:|}x = 5;
                }
            }
            """;
        await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace, CapabilitiesWithVSExtensions);
        testLspServer.TestWorkspace.GlobalOptions.SetGlobalOption(InlineHintsOptionsStorage.EnabledForParameters, LanguageNames.CSharp, true);
        testLspServer.TestWorkspace.GlobalOptions.SetGlobalOption(InlineHintsOptionsStorage.EnabledForTypes, LanguageNames.CSharp, true);
        var document = testLspServer.GetCurrentSolution().Projects.Single().Documents.Single();
        var textDocument = CreateTextDocumentIdentifier(document.GetURI());
        var sourceText = await document.GetTextAsync();
        var span = TextSpan.FromBounds(0, sourceText.Length);

        var inlayHintParams = new LSP.InlayHintParams
        {
            TextDocument = textDocument,
            Range = ProtocolConversions.TextSpanToRange(span, sourceText)
        };

        var actualInlayHints = await testLspServer.ExecuteRequestAsync<LSP.InlayHintParams, LSP.InlayHint[]?>(LSP.Methods.TextDocumentInlayHintName, inlayHintParams, CancellationToken.None);
        Assert.NotNull(actualInlayHints);
        var firstInlayHint = actualInlayHints.First();
        var data = JsonSerializer.Deserialize<InlayHintResolveData>(firstInlayHint.Data!.ToString()!, ProtocolConversions.LspJsonSerializerOptions);
        Assert.NotNull(data);
        var firstResultId = data.ResultId;

        // Verify the inlay hint item is in the cache.
        var cache = testLspServer.GetRequiredLspService<InlayHintCache>();
        Assert.NotNull(cache.GetCachedEntry(firstResultId));

        // Execute a few more requests to ensure the first request is removed from the cache.
        await testLspServer.ExecuteRequestAsync<LSP.InlayHintParams, LSP.InlayHint[]?>(LSP.Methods.TextDocumentInlayHintName, inlayHintParams, CancellationToken.None);
        await testLspServer.ExecuteRequestAsync<LSP.InlayHintParams, LSP.InlayHint[]?>(LSP.Methods.TextDocumentInlayHintName, inlayHintParams, CancellationToken.None);
        var lastInlayHints = await testLspServer.ExecuteRequestAsync<LSP.InlayHintParams, LSP.InlayHint[]?>(LSP.Methods.TextDocumentInlayHintName, inlayHintParams, CancellationToken.None);
        Assert.NotNull(lastInlayHints);
        Assert.True(lastInlayHints.Any());

        // Assert that the first result id is no longer in the cache.
        Assert.Null(cache.GetCachedEntry(firstResultId));

        // Assert that the resolve request returns the inlay hint even if not in the cache.
        var firstResolvedHint = await testLspServer.ExecuteRequestAsync<LSP.InlayHint, LSP.InlayHint>(LSP.Methods.InlayHintResolveName, firstInlayHint, CancellationToken.None);
        Assert.NotNull(firstResolvedHint?.ToolTip);
    }

    private async Task RunVerifyInlayHintAsync(string markup, bool mutatingLspWorkspace, bool hasTextEdits = true)
    {
        await using var testLspServer = await CreateTestLspServerAsync(markup, mutatingLspWorkspace,
            new LSP.VSInternalClientCapabilities
            {
                SupportsVisualStudioExtensions = true,
                Workspace = new WorkspaceClientCapabilities
                {
                    InlayHint = new InlayHintWorkspaceSetting
                    {
                        RefreshSupport = true
                    }
                }
            });
        testLspServer.TestWorkspace.GlobalOptions.SetGlobalOption(InlineHintsOptionsStorage.EnabledForParameters, LanguageNames.CSharp, true);
        testLspServer.TestWorkspace.GlobalOptions.SetGlobalOption(InlineHintsOptionsStorage.EnabledForTypes, LanguageNames.CSharp, true);
        await VerifyInlayHintAsync(testLspServer, hasTextEdits);
    }
}