Strongly type the completion resolve context object

davidwengier · davidwengier · commit 803a7dd962ab · 2025-03-12T17:14:11.000+11:00
diff --git a/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Completion/Delegation/DelegatedCompletionItemResolver.cs b/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Completion/Delegation/DelegatedCompletionItemResolver.cs
@@ -31,7 +31,7 @@ internal class DelegatedCompletionItemResolver(
     public override async Task<VSInternalCompletionItem?> ResolveAsync(
         VSInternalCompletionItem item,
         VSInternalCompletionList containingCompletionList,
-        object? originalRequestContext,
+        ICompletionResolveContext originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
         IComponentAvailabilityService componentAvailabilityService,
         CancellationToken cancellationToken)
diff --git a/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Completion/RazorCompletionResolveEndpoint.cs b/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Completion/RazorCompletionResolveEndpoint.cs
@@ -39,7 +39,7 @@ public async Task<VSInternalCompletionItem> HandleRequestAsync(VSInternalComplet
             return completionItem;
         }
 
-        object? originalRequestContext = null;
+        ICompletionResolveContext? originalRequestContext = null;
         VSInternalCompletionList? containingCompletionList = null;
         foreach (var resultId in resultIds)
         {
@@ -61,7 +61,7 @@ public async Task<VSInternalCompletionItem> HandleRequestAsync(VSInternalComplet
             }
         }
 
-        if (containingCompletionList is null)
+        if (containingCompletionList is null || originalRequestContext is null)
         {
             // Couldn't find an associated completion list
             return completionItem;
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/AggregateCompletionItemResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/AggregateCompletionItemResolver.cs
@@ -28,7 +28,7 @@ public AggregateCompletionItemResolver(IEnumerable<CompletionItemResolver> compl
     public async Task<VSInternalCompletionItem?> ResolveAsync(
         VSInternalCompletionItem item,
         VSInternalCompletionList containingCompletionList,
-        object? originalRequestContext,
+        ICompletionResolveContext originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
         IComponentAvailabilityService componentAvailabilityService,
         CancellationToken cancellationToken)
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/CompletionItemResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/CompletionItemResolver.cs
@@ -13,7 +13,7 @@ internal abstract class CompletionItemResolver
     public abstract Task<VSInternalCompletionItem?> ResolveAsync(
         VSInternalCompletionItem item,
         VSInternalCompletionList containingCompletionList,
-        object? originalRequestContext,
+        ICompletionResolveContext originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
         IComponentAvailabilityService componentAvailabilityService,
         CancellationToken cancellationToken);
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/CompletionListCache.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/CompletionListCache.cs
@@ -8,7 +8,7 @@ namespace Microsoft.CodeAnalysis.Razor.Completion;
 
 internal class CompletionListCache
 {
-    private record struct Slot(int Id, VSInternalCompletionList CompletionList, object? Context);
+    private record struct Slot(int Id, VSInternalCompletionList CompletionList, ICompletionResolveContext Context);
 
     // Internal for testing
     internal const int MaxCacheSize = 10;
@@ -21,7 +21,7 @@ private record struct Slot(int Id, VSInternalCompletionList CompletionList, obje
     private int _nextIndex;
     private int _nextId;
 
-    public int Add(VSInternalCompletionList completionList, object? context)
+    public int Add(VSInternalCompletionList completionList, ICompletionResolveContext context)
     {
         if (completionList is null)
         {
@@ -48,7 +48,7 @@ public int Add(VSInternalCompletionList completionList, object? context)
         }
     }
 
-    public bool TryGet(int id, out (VSInternalCompletionList CompletionList, object? Context) result)
+    public bool TryGet(int id, out (VSInternalCompletionList CompletionList, ICompletionResolveContext Context) result)
     {
         lock (_accessLock)
         {
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/ICompletionResolveContext.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/ICompletionResolveContext.cs
@@ -0,0 +1,11 @@
+﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+namespace Microsoft.CodeAnalysis.Razor.Completion;
+
+/// <summary>
+/// Marker interface to make the CompletionListCache API easier to use
+/// </summary>
+internal interface ICompletionResolveContext
+{
+}
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/RazorCompletionItemResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/RazorCompletionItemResolver.cs
@@ -17,7 +17,7 @@ internal class RazorCompletionItemResolver : CompletionItemResolver
     public override async Task<VSInternalCompletionItem?> ResolveAsync(
         VSInternalCompletionItem completionItem,
         VSInternalCompletionList containingCompletionList,
-        object? originalRequestContext,
+        ICompletionResolveContext originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
         IComponentAvailabilityService componentAvailabilityService,
         CancellationToken cancellationToken)
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/RazorCompletionResolveContext.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/RazorCompletionResolveContext.cs
@@ -5,4 +5,4 @@
 
 namespace Microsoft.CodeAnalysis.Razor.Completion;
 
-internal record RazorCompletionResolveContext(string FilePath, ImmutableArray<RazorCompletionItem> CompletionItems);
+internal record RazorCompletionResolveContext(string FilePath, ImmutableArray<RazorCompletionItem> CompletionItems) : ICompletionResolveContext;
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Protocol/DelegatedTypes.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Protocol/DelegatedTypes.cs
@@ -10,6 +10,7 @@
 
 namespace Microsoft.CodeAnalysis.Razor.Protocol;
 
+using Microsoft.CodeAnalysis.Razor.Completion;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 
 internal record DelegatedSpellCheckParams(
@@ -70,7 +71,7 @@ internal record DelegatedMapCodeParams(
 
 internal record DelegatedCompletionResolutionContext(
     [property: JsonPropertyName("originalRequestParams")] DelegatedCompletionParams OriginalRequestParams,
-    [property: JsonPropertyName("originalCompletionListData")] object? OriginalCompletionListData);
+    [property: JsonPropertyName("originalCompletionListData")] object? OriginalCompletionListData) : ICompletionResolveContext;
 
 internal record DelegatedCompletionItemResolveParams(
     [property: JsonPropertyName("identifier")] TextDocumentIdentifierAndVersion Identifier,
diff --git a/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Completion/Delegation/DelegatedCompletionItemResolverTest.NetFx.cs b/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Completion/Delegation/DelegatedCompletionItemResolverTest.NetFx.cs
@@ -12,6 +12,7 @@
 using Microsoft.AspNetCore.Razor.LanguageServer.Formatting;
 using Microsoft.AspNetCore.Razor.LanguageServer.Hover;
 using Microsoft.AspNetCore.Razor.LanguageServer.Test;
+using Microsoft.AspNetCore.Razor.Test.Common;
 using Microsoft.AspNetCore.Razor.Test.Common.LanguageServer;
 using Microsoft.CodeAnalysis.Razor.Completion;
 using Microsoft.CodeAnalysis.Razor.Formatting;
@@ -94,7 +95,7 @@ public async Task ResolveAsync_CanNotFindCompletionItem_Noops()
         var resolver = new DelegatedCompletionItemResolver(_documentContextFactory, _formattingService.GetValue(), optionsMonitor, server);
         var item = new VSInternalCompletionItem();
         var notContainingCompletionList = new VSInternalCompletionList();
-        var originalRequestContext = new object();
+        var originalRequestContext = StrictMock.Of<ICompletionResolveContext>();
 
         // Act
         var resolvedItem = await resolver.ResolveAsync(
@@ -113,7 +114,7 @@ public async Task ResolveAsync_UnknownRequestContext_Noops()
         var resolver = new DelegatedCompletionItemResolver(_documentContextFactory, _formattingService.GetValue(), optionsMonitor, server);
         var item = new VSInternalCompletionItem();
         var containingCompletionList = new VSInternalCompletionList() { Items = new[] { item, } };
-        var originalRequestContext = new object();
+        var originalRequestContext = StrictMock.Of<ICompletionResolveContext>();
 
         // Act
         var resolvedItem = await resolver.ResolveAsync(
diff --git a/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Completion/RazorCompletionItemResolverTest.cs b/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Completion/RazorCompletionItemResolverTest.cs
@@ -3,7 +3,6 @@
 
 #nullable disable
 
-using System;
 using System.Collections.Immutable;
 using System.Linq;
 using System.Threading;
@@ -297,7 +296,7 @@ public async Task ResolveAsync_NonTagHelperCompletion_Noops()
 
         // Act
         var resolvedCompletionItem = await resolver.ResolveAsync(
-            completionItem, completionList, Array.Empty<RazorCompletionItem>(), _defaultClientCapability, _componentAvailabilityService, DisposalToken);
+            completionItem, completionList, StrictMock.Of<ICompletionResolveContext>(), _defaultClientCapability, _componentAvailabilityService, DisposalToken);
 
         // Assert
         Assert.Null(resolvedCompletionItem);
diff --git a/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Completion/RazorCompletionResolveEndpointTest.cs b/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Completion/RazorCompletionResolveEndpointTest.cs
@@ -9,6 +9,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor.LanguageServer.Hover;
+using Microsoft.AspNetCore.Razor.Test.Common;
 using Microsoft.AspNetCore.Razor.Test.Common.LanguageServer;
 using Microsoft.CodeAnalysis.Razor.Completion;
 using Microsoft.CodeAnalysis.Razor.Tooltip;
@@ -92,7 +93,7 @@ public async Task Handle_CachedCompletionItem_Resolves()
         // Arrange
         var completionItem = new VSInternalCompletionItem() { Label = "Test" };
         var completionList = new VSInternalCompletionList() { Items = new[] { completionItem } };
-        var resultId = _completionListCache.Add(completionList, context: null);
+        var resultId = _completionListCache.Add(completionList, StrictMock.Of<ICompletionResolveContext>());
         completionList.SetResultId(resultId, completionSetting: null);
         var parameters = ConvertToBridgedItem(completionItem);
         var requestContext = CreateRazorRequestContext(documentContext: null);
@@ -112,7 +113,7 @@ public async Task Handle_MultipleResultIdsIgnoresEvictedResultIds_Resolves()
         var completionItem = new VSInternalCompletionItem() { Label = "Test" };
         var completionList = new VSInternalCompletionList() { Items = new[] { completionItem } };
         completionList.SetResultId(/* Invalid */ 1337, completionSetting: null);
-        var resultId = _completionListCache.Add(completionList, context: null);
+        var resultId = _completionListCache.Add(completionList, StrictMock.Of<ICompletionResolveContext>());
         completionList.SetResultId(resultId, completionSetting: null);
         var parameters = ConvertToBridgedItem(completionItem);
         var requestContext = CreateRazorRequestContext(documentContext: null);
@@ -131,13 +132,13 @@ public async Task Handle_MergedCompletionListFindsProperCompletionList_Resolves(
         await InitializeAsync();
         var completionSetting = new VSInternalCompletionSetting() { CompletionList = new VSInternalCompletionListSetting() { Data = true } };
         var completionList1 = new VSInternalCompletionList() { Items = Array.Empty<CompletionItem>() };
-        var completion1Context = new object();
+        var completion1Context = StrictMock.Of<ICompletionResolveContext>();
         var resultId1 = _completionListCache.Add(completionList1, completion1Context);
         completionList1.SetResultId(resultId1, completionSetting);
 
         var completionItem = new VSInternalCompletionItem() { Label = "Test" };
         var completionList2 = new VSInternalCompletionList() { Items = new[] { completionItem } };
-        var completion2Context = new object();
+        var completion2Context = StrictMock.Of<ICompletionResolveContext>();
         var resultId2 = _completionListCache.Add(completionList2, completion2Context);
         completionList2.SetResultId(resultId2, completionSetting);
         var mergedCompletionList = CompletionListMerger.Merge(completionList1, completionList2);
@@ -166,7 +167,7 @@ private class TestCompletionItemResolver : CompletionItemResolver
         public override Task<VSInternalCompletionItem> ResolveAsync(
             VSInternalCompletionItem item,
             VSInternalCompletionList containingCompletionList,
-            object originalRequestContext,
+            ICompletionResolveContext originalRequestContext,
             VSInternalClientCapabilities clientCapabilities,
             IComponentAvailabilityService componentAvailabilityService,
             CancellationToken cancellationToken)
diff --git a/src/Razor/test/Microsoft.CodeAnalysis.Razor.Workspaces.Test/Completion/CompletionListCacheTest.cs b/src/Razor/test/Microsoft.CodeAnalysis.Razor.Workspaces.Test/Completion/CompletionListCacheTest.cs
@@ -8,17 +8,10 @@
 
 namespace Microsoft.CodeAnalysis.Razor.Completion;
 
-public class CompletionListCacheTest : ToolingTestBase
+public class CompletionListCacheTest(ITestOutputHelper testOutput) : ToolingTestBase(testOutput)
 {
-    private readonly CompletionListCache _completionListCache;
-    private readonly object _context;
-
-    public CompletionListCacheTest(ITestOutputHelper testOutput)
-        : base(testOutput)
-    {
-        _completionListCache = new CompletionListCache();
-        _context = new object();
-    }
+    private readonly CompletionListCache _completionListCache = new CompletionListCache();
+    private readonly ICompletionResolveContext _context = StrictMock.Of<ICompletionResolveContext>();
 
     [Fact]
     public void TryGet_SetCompletionList_ReturnsTrue()

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public async Task<VSInternalCompletionItem> HandleRequestAsync(VSInternalComplet`
`39`	`39`	`return completionItem;`
`40`	`40`	`}`
`41`	`41`
`42`		`- object? originalRequestContext = null;`
	`42`	`+ ICompletionResolveContext? originalRequestContext = null;`
`43`	`43`	`VSInternalCompletionList? containingCompletionList = null;`
`44`	`44`	`foreach (var resultId in resultIds)`
`45`	`45`	`{`
`@@ -61,7 +61,7 @@ public async Task<VSInternalCompletionItem> HandleRequestAsync(VSInternalComplet`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`64`		`- if (containingCompletionList is null)`
	`64`	`+ if (containingCompletionList is null \|\| originalRequestContext is null)`
`65`	`65`	`{`
`66`	`66`	`// Couldn't find an associated completion list`
`67`	`67`	`return completionItem;`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace Microsoft.CodeAnalysis.Razor.Completion;`
`8`	`8`
`9`	`9`	`internal class CompletionListCache`
`10`	`10`	`{`
`11`		`- private record struct Slot(int Id, VSInternalCompletionList CompletionList, object? Context);`
	`11`	`+ private record struct Slot(int Id, VSInternalCompletionList CompletionList, ICompletionResolveContext Context);`
`12`	`12`
`13`	`13`	`// Internal for testing`
`14`	`14`	`internal const int MaxCacheSize = 10;`
`@@ -21,7 +21,7 @@ private record struct Slot(int Id, VSInternalCompletionList CompletionList, obje`
`21`	`21`	`private int _nextIndex;`
`22`	`22`	`private int _nextId;`
`23`	`23`
`24`		`- public int Add(VSInternalCompletionList completionList, object? context)`
	`24`	`+ public int Add(VSInternalCompletionList completionList, ICompletionResolveContext context)`
`25`	`25`	`{`
`26`	`26`	`if (completionList is null)`
`27`	`27`	`{`
`@@ -48,7 +48,7 @@ public int Add(VSInternalCompletionList completionList, object? context)`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
`51`		`- public bool TryGet(int id, out (VSInternalCompletionList CompletionList, object? Context) result)`
	`51`	`+ public bool TryGet(int id, out (VSInternalCompletionList CompletionList, ICompletionResolveContext Context) result)`
`52`	`52`	`{`
`53`	`53`	`lock (_accessLock)`
`54`	`54`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@`
`5`	`5`
`6`	`6`	`namespace Microsoft.CodeAnalysis.Razor.Completion;`
`7`	`7`
`8`		`-internal record RazorCompletionResolveContext(string FilePath, ImmutableArray<RazorCompletionItem> CompletionItems);`
	`8`	`+internal record RazorCompletionResolveContext(string FilePath, ImmutableArray<RazorCompletionItem> CompletionItems) : ICompletionResolveContext;`