Move completion resolve code to common layer (dotnet#11156)

alexgav · web-flow · commit aeebb01d00e8 · 2024-11-11T14:37:48.000-08:00
* Move completion resolve code to common layer

* Undo move of IProjectSnapshotManagerExtensions and MiscFilesHostProject per PR feedback

* Undo unnecessary changes in tests

* Refactor the code to remove usage of IProjectSnapshotManager
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
@@ -32,6 +32,7 @@ internal class DelegatedCompletionItemResolver(
         VSInternalCompletionList containingCompletionList,
         object? originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
+        ISolutionQueryOperations solutionQueryOperations,
         CancellationToken cancellationToken)
     {
         if (originalRequestContext is not DelegatedCompletionResolutionContext resolutionContext)
diff --git a/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Completion/RazorCompletionResolveEndpoint.cs b/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Completion/RazorCompletionResolveEndpoint.cs
@@ -5,7 +5,9 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor.LanguageServer.EndpointContracts;
+using Microsoft.AspNetCore.Razor.LanguageServer.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.Completion;
+using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer.Completion;
@@ -17,14 +19,17 @@ internal class RazorCompletionResolveEndpoint
 {
     private readonly AggregateCompletionItemResolver _completionItemResolver;
     private readonly CompletionListCache _completionListCache;
+    private readonly IProjectSnapshotManager _projectSnapshotManager;
     private VSInternalClientCapabilities? _clientCapabilities;
 
     public RazorCompletionResolveEndpoint(
         AggregateCompletionItemResolver completionItemResolver,
-        CompletionListCache completionListCache)
+        CompletionListCache completionListCache,
+        IProjectSnapshotManager projectSnapshotManager)
     {
         _completionItemResolver = completionItemResolver;
         _completionListCache = completionListCache;
+        _projectSnapshotManager = projectSnapshotManager;
     }
 
     public bool MutatesSolutionState => false;
@@ -74,6 +79,7 @@ public async Task<VSInternalCompletionItem> HandleRequestAsync(VSInternalComplet
             containingCompletionList,
             originalRequestContext,
             _clientCapabilities,
+            _projectSnapshotManager.GetQueryOperations(),
             cancellationToken).ConfigureAwait(false);
         resolvedCompletionItem ??= completionItem;
 
diff --git a/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ProjectSystem/IProjectSnapshotManagerExtensions.SolutionQueryOperations.cs b/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ProjectSystem/IProjectSnapshotManagerExtensions.SolutionQueryOperations.cs
@@ -4,7 +4,6 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using Microsoft.AspNetCore.Razor.PooledObjects;
-using Microsoft.AspNetCore.Razor.Utilities;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer.ProjectSystem;
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/AggregateCompletionItemResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/AggregateCompletionItemResolver.cs
@@ -9,9 +9,10 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor.PooledObjects;
 using Microsoft.CodeAnalysis.Razor.Logging;
+using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 
-namespace Microsoft.AspNetCore.Razor.LanguageServer.Completion;
+namespace Microsoft.CodeAnalysis.Razor.Completion;
 
 internal class AggregateCompletionItemResolver
 {
@@ -29,6 +30,7 @@ public AggregateCompletionItemResolver(IEnumerable<CompletionItemResolver> compl
         VSInternalCompletionList containingCompletionList,
         object? originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
+        ISolutionQueryOperations solutionQueryOperations,
         CancellationToken cancellationToken)
     {
         using var completionItemResolverTasks = new PooledArrayBuilder<Task<VSInternalCompletionItem?>>(_completionItemResolvers.Count);
@@ -37,7 +39,7 @@ public AggregateCompletionItemResolver(IEnumerable<CompletionItemResolver> compl
         {
             try
             {
-                var task = completionItemResolver.ResolveAsync(item, containingCompletionList, originalRequestContext, clientCapabilities, cancellationToken);
+                var task = completionItemResolver.ResolveAsync(item, containingCompletionList, originalRequestContext, clientCapabilities, solutionQueryOperations, cancellationToken);
                 completionItemResolverTasks.Add(task);
             }
             catch (Exception ex) when (ex is not TaskCanceledException)
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/CompletionItemResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/CompletionItemResolver.cs
@@ -3,16 +3,18 @@
 
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 
-namespace Microsoft.AspNetCore.Razor.LanguageServer.Completion;
+namespace Microsoft.CodeAnalysis.Razor.Completion;
 
 internal abstract class CompletionItemResolver
 {
     public abstract Task<VSInternalCompletionItem?> ResolveAsync(
         VSInternalCompletionItem item,
-        VSInternalCompletionList containingCompletionlist,
+        VSInternalCompletionList containingCompletionList,
         object? originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
+        ISolutionQueryOperations solutionQueryOperations,
         CancellationToken cancellationToken);
 }
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/RazorCompletionItemResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Completion/RazorCompletionItemResolver.cs
@@ -5,25 +5,22 @@
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
-using Microsoft.AspNetCore.Razor.LanguageServer.ProjectSystem;
 using Microsoft.CodeAnalysis;
-using Microsoft.CodeAnalysis.Razor.Completion;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.Tooltip;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 using Microsoft.VisualStudio.Text.Adornments;
 
-namespace Microsoft.AspNetCore.Razor.LanguageServer.Completion;
+namespace Microsoft.CodeAnalysis.Razor.Completion;
 
-internal class RazorCompletionItemResolver(IProjectSnapshotManager projectManager) : CompletionItemResolver
+internal class RazorCompletionItemResolver : CompletionItemResolver
 {
-    private readonly IProjectSnapshotManager _projectManager = projectManager;
-
     public override async Task<VSInternalCompletionItem?> ResolveAsync(
         VSInternalCompletionItem completionItem,
         VSInternalCompletionList containingCompletionList,
         object? originalRequestContext,
         VSInternalClientCapabilities? clientCapabilities,
+        ISolutionQueryOperations solutionQueryOperations,
         CancellationToken cancellationToken)
     {
         if (originalRequestContext is not RazorCompletionResolveContext razorCompletionResolveContext)
@@ -122,13 +119,13 @@ internal class RazorCompletionItemResolver(IProjectSnapshotManager projectManage
                     if (useDescriptionProperty)
                     {
                         tagHelperClassifiedTextTooltip = await ClassifiedTagHelperTooltipFactory
-                            .TryCreateTooltipAsync(razorCompletionResolveContext.FilePath, descriptionInfo, _projectManager.GetQueryOperations(), cancellationToken)
+                            .TryCreateTooltipAsync(razorCompletionResolveContext.FilePath, descriptionInfo, solutionQueryOperations, cancellationToken)
                             .ConfigureAwait(false);
                     }
                     else
                     {
                         tagHelperMarkupTooltip = await MarkupTagHelperTooltipFactory
-                            .TryCreateTooltipAsync(razorCompletionResolveContext.FilePath, descriptionInfo, _projectManager.GetQueryOperations(), documentationKind, cancellationToken)
+                            .TryCreateTooltipAsync(razorCompletionResolveContext.FilePath, descriptionInfo, solutionQueryOperations, documentationKind, cancellationToken)
                             .ConfigureAwait(false);
                     }
 
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
@@ -10,6 +10,7 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor.Language;
 using Microsoft.AspNetCore.Razor.LanguageServer.Formatting;
+using Microsoft.AspNetCore.Razor.LanguageServer.ProjectSystem;
 using Microsoft.AspNetCore.Razor.LanguageServer.Test;
 using Microsoft.AspNetCore.Razor.Test.Common.LanguageServer;
 using Microsoft.CodeAnalysis.Razor.Completion;
@@ -34,6 +35,7 @@ public class DelegatedCompletionItemResolverTest : LanguageServerTestBase
     private readonly IDocumentContextFactory _documentContextFactory;
     private readonly AsyncLazy<IRazorFormattingService> _formattingService;
     private readonly RazorCompletionOptions _defaultRazorCompletionOptions;
+    private readonly ISolutionQueryOperations _solutionQueryOperations;
 
     public DelegatedCompletionItemResolverTest(ITestOutputHelper testOutput)
         : base(testOutput)
@@ -77,6 +79,7 @@ public DelegatedCompletionItemResolverTest(ITestOutputHelper testOutput)
             SnippetsSupported: true,
             AutoInsertAttributeQuotes: true,
             CommitElementsWithSpace: true);
+        _solutionQueryOperations = CreateProjectSnapshotManager().GetQueryOperations();
     }
 
     [Fact]
@@ -92,7 +95,7 @@ public async Task ResolveAsync_CanNotFindCompletionItem_Noops()
 
         // Act
         var resolvedItem = await resolver.ResolveAsync(
-            item, notContainingCompletionList, originalRequestContext, _clientCapabilities, DisposalToken);
+            item, notContainingCompletionList, originalRequestContext, _clientCapabilities, _solutionQueryOperations, DisposalToken);
 
         // Assert
         Assert.Null(resolvedItem);
@@ -111,7 +114,7 @@ public async Task ResolveAsync_UnknownRequestContext_Noops()
 
         // Act
         var resolvedItem = await resolver.ResolveAsync(
-            item, containingCompletionList, originalRequestContext, _clientCapabilities, DisposalToken);
+            item, containingCompletionList, originalRequestContext, _clientCapabilities, _solutionQueryOperations, DisposalToken);
 
         // Assert
         Assert.Null(resolvedItem);
@@ -134,7 +137,7 @@ public async Task ResolveAsync_UsesItemsData()
 
         // Act
         await resolver.ResolveAsync(
-            item, containingCompletionList, originalRequestContext, _clientCapabilities, DisposalToken);
+            item, containingCompletionList, originalRequestContext, _clientCapabilities, _solutionQueryOperations, DisposalToken);
 
         // Assert
         Assert.Same(expectedData, server.DelegatedParams.CompletionItem.Data);
@@ -153,7 +156,7 @@ public async Task ResolveAsync_InheritsOriginalCompletionListData()
         var originalRequestContext = new DelegatedCompletionResolutionContext(_csharpCompletionParams, expectedData);
 
         // Act
-        await resolver.ResolveAsync(item, containingCompletionList, originalRequestContext, _clientCapabilities, DisposalToken);
+        await resolver.ResolveAsync(item, containingCompletionList, originalRequestContext, _clientCapabilities, _solutionQueryOperations, DisposalToken);
 
         // Assert
         Assert.Same(expectedData, server.DelegatedParams.CompletionItem.Data);
@@ -217,7 +220,7 @@ public async Task ResolveAsync_Html_Resolves()
 
         // Act
         var resolvedItem = await resolver.ResolveAsync(
-            item, containingCompletionList, originalRequestContext, _clientCapabilities, DisposalToken);
+            item, containingCompletionList, originalRequestContext, _clientCapabilities, _solutionQueryOperations, DisposalToken);
 
         // Assert
         Assert.Same(_htmlCompletionParams.Identifier, server.DelegatedParams.Identifier);
@@ -247,7 +250,7 @@ private async Task<VSInternalCompletionItem> ResolveCompletionItemAsync(string c
         }
 
         var resolvedItem = await resolver.ResolveAsync(
-            item, containingCompletionList, originalRequestContext, _clientCapabilities, cancellationToken);
+            item, containingCompletionList, originalRequestContext, _clientCapabilities, _solutionQueryOperations, cancellationToken);
 
         return resolvedItem;
     }
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
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

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ internal class DelegatedCompletionItemResolver(`
`32`	`32`	`VSInternalCompletionList containingCompletionList,`
`33`	`33`	`object? originalRequestContext,`
`34`	`34`	`VSInternalClientCapabilities? clientCapabilities,`
	`35`	`+ ISolutionQueryOperations solutionQueryOperations,`
`35`	`36`	`CancellationToken cancellationToken)`
`36`	`37`	`{`
`37`	`38`	`if (originalRequestContext is not DelegatedCompletionResolutionContext resolutionContext)`
Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,10 @@`
`9`	`9`	`using System.Threading.Tasks;`
`10`	`10`	`using Microsoft.AspNetCore.Razor.PooledObjects;`
`11`	`11`	`using Microsoft.CodeAnalysis.Razor.Logging;`
	`12`	`+using Microsoft.CodeAnalysis.Razor.ProjectSystem;`
`12`	`13`	`using Microsoft.VisualStudio.LanguageServer.Protocol;`
`13`	`14`
`14`		`-namespace Microsoft.AspNetCore.Razor.LanguageServer.Completion;`
	`15`	`+namespace Microsoft.CodeAnalysis.Razor.Completion;`
`15`	`16`
`16`	`17`	`internal class AggregateCompletionItemResolver`
`17`	`18`	`{`
`@@ -29,6 +30,7 @@ public AggregateCompletionItemResolver(IEnumerable<CompletionItemResolver> compl`
`29`	`30`	`VSInternalCompletionList containingCompletionList,`
`30`	`31`	`object? originalRequestContext,`
`31`	`32`	`VSInternalClientCapabilities? clientCapabilities,`
	`33`	`+ ISolutionQueryOperations solutionQueryOperations,`
`32`	`34`	`CancellationToken cancellationToken)`
`33`	`35`	`{`
`34`	`36`	`using var completionItemResolverTasks = new PooledArrayBuilder<Task<VSInternalCompletionItem?>>(_completionItemResolvers.Count);`
`@@ -37,7 +39,7 @@ public AggregateCompletionItemResolver(IEnumerable<CompletionItemResolver> compl`
`37`	`39`	`{`
`38`	`40`	`try`
`39`	`41`	`{`
`40`		`- var task = completionItemResolver.ResolveAsync(item, containingCompletionList, originalRequestContext, clientCapabilities, cancellationToken);`
	`42`	`+ var task = completionItemResolver.ResolveAsync(item, containingCompletionList, originalRequestContext, clientCapabilities, solutionQueryOperations, cancellationToken);`
`41`	`43`	`completionItemResolverTasks.Add(task);`
`42`	`44`	`}`
`43`	`45`	`catch (Exception ex) when (ex is not TaskCanceledException)`