Make RazorProjectService operations atomic (#10322)

The work I did to make all of the public entry points on
`RazorProjectService` async did so by breaking up the operations in
multiple tasks. The operations themselves can't interleave because a
semaphore gates just one operation at a time. However, the updates to
the `ProjectSnapshotManager` made by each operation _can_ interleave
with other updates to the `ProjectSnapshotManager`.

This change ensures that all of the `RazorProjectService` operations are
atomic WRT to the `ProjectSnapshotManger` by running each operation
within a call to `ProjectSnapshotManager.UpdateAsync(...)`. In addition,
I've taken a suggestion from @ryzngard to change when the miscellaneous
files project is added to the `ProjectSnapshotManager` in the language
server. Before this change, the misc files project would be added by the
first call to `ISnapshotResolver.GetMiscellaneousProjectAsync(...)`.
Now, it's added during `SnapshotResolver` initialization. This allows
`GetMiscellaneousProjectAsync(...)` to become a synchronous method,
which has the positive effect allowing many of the downstream callers to
be synchronous as well. Ultimately, this allows all of the
`RazorProjectService` operations to be implemented synchronously, which
helps ensure that they are actually atomic.

Author: DustinCampbell

src/Razor/benchmarks/Microsoft.AspNetCore.Razor.Microbenchmarks/LanguageServer/RazorLanguageServerBenchmarkBase.cs

@@ -87,7 +87,7 @@ await projectManager.UpdateAsync(
 
     private class NoopClientNotifierService : IClientConnection, IOnInitialized
     {
-        public Task OnInitializedAsync(VSInternalClientCapabilities clientCapabilities, CancellationToken cancellationToken)
+        public Task OnInitializedAsync(ILspServices services, CancellationToken cancellationToken)
         {
             return Task.CompletedTask;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ClientConnection.cs

@@ -5,6 +5,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor.LanguageServer.Hosting;
+using Microsoft.CommonLanguageServerProtocol.Framework;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 using StreamJsonRpc;
 
@@ -47,7 +48,7 @@ public async Task SendNotificationAsync(string method, CancellationToken cancell
     /// <summary>
     /// Fires when the language server is set to "Started".
     /// </summary>
-    public Task OnInitializedAsync(VSInternalClientCapabilities clientCapabilities, CancellationToken cancellationToken)
+    public Task OnInitializedAsync(ILspServices services, CancellationToken cancellationToken)
     {
         _initializedCompletionSource.TrySetResult(true);
         return Task.CompletedTask;

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/CodeActions/CSharp/DefaultCSharpCodeActionResolver.cs

@@ -73,8 +73,7 @@ public async override Task<CodeAction> ResolveAsync(
             throw new ArgumentNullException(nameof(codeAction));
         }
 
-        var documentContext = await _documentContextFactory.TryCreateForOpenDocumentAsync(csharpParams.RazorFileIdentifier, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreateForOpenDocument(csharpParams.RazorFileIdentifier, out var documentContext))
         {
             return codeAction;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/CodeActions/CSharp/UnformattedRemappingCSharpCodeActionResolver.cs

@@ -54,8 +54,7 @@ public async override Task<CodeAction> ResolveAsync(
 
         cancellationToken.ThrowIfCancellationRequested();
 
-        var documentContext = await _documentContextFactory.TryCreateForOpenDocumentAsync(csharpParams.RazorFileIdentifier, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreateForOpenDocument(csharpParams.RazorFileIdentifier, out var documentContext))
         {
             return codeAction;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/CodeActions/Html/DefaultHtmlCodeActionResolver.cs

@@ -55,8 +55,7 @@ public async override Task<CodeAction> ResolveAsync(
             throw new ArgumentNullException(nameof(codeAction));
         }
 
-        var documentContext = await _documentContextFactory.TryCreateForOpenDocumentAsync(resolveParams.RazorFileIdentifier, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreateForOpenDocument(resolveParams.RazorFileIdentifier, out var documentContext))
         {
             return codeAction;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/CodeActions/Razor/AddUsingsCodeActionResolver.cs

@@ -45,8 +45,7 @@ public AddUsingsCodeActionResolver(IDocumentContextFactory documentContextFactor
             return null;
         }
 
-        var documentContext = await _documentContextFactory.TryCreateAsync(actionParams.Uri, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreate(actionParams.Uri, out var documentContext))
         {
             return null;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/CodeActions/Razor/CreateComponentCodeActionResolver.cs

@@ -43,8 +43,7 @@ public CreateComponentCodeActionResolver(IDocumentContextFactory documentContext
             return null;
         }
 
-        var documentContext = await _documentContextFactory.TryCreateAsync(actionParams.Uri, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreate(actionParams.Uri, out var documentContext))
         {
             return null;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/CodeActions/Razor/ExtractToCodeBehindCodeActionResolver.cs

@@ -60,8 +60,7 @@ public ExtractToCodeBehindCodeActionResolver(
 
         var path = FilePathNormalizer.Normalize(actionParams.Uri.GetAbsoluteOrUNCPath());
 
-        var documentContext = await _documentContextFactory.TryCreateAsync(actionParams.Uri, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreate(actionParams.Uri, out var documentContext))
         {
             return null;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/CodeActions/Razor/GenerateMethodCodeActionResolver.cs

@@ -72,8 +72,7 @@ public GenerateMethodCodeActionResolver(
             return null;
         }
 
-        var documentContext = await _documentContextFactory.TryCreateForOpenDocumentAsync(actionParams.Uri, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreateForOpenDocument(actionParams.Uri, out var documentContext))
         {
             return null;
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Completion/Delegation/DelegatedCompletionItemResolver.cs

@@ -100,8 +100,7 @@ private async Task<VSInternalCompletionItem> PostProcessCompletionItemAsync(
         }
 
         var identifier = context.OriginalRequestParams.Identifier.TextDocumentIdentifier;
-        var documentContext = await _documentContextFactory.TryCreateForOpenDocumentAsync(identifier, cancellationToken).ConfigureAwait(false);
-        if (documentContext is null)
+        if (!_documentContextFactory.TryCreateForOpenDocument(identifier, out var documentContext))
         {
             return resolvedCompletionItem;
         }