Fix issue where RemoteServiceInvoker never initializes

The first time that a remote service call is made by RemoteServiceInvoker, it calls into Roslyn OOP to initialize itself. However, the CancellationToken that's passed for initialization is the same one that is passed by the original service caller. If that token is cancelled by the caller during initialization, RemoteServiceInvoker will get stuck and never actually make a remote service call because the initialization task will forever be in a cancelled state. The fix for this issue is to make RemoteServiceInvoker disposable, and add a CancellationTokenSource that is cancelled when the invoker itself is dispose. Then, pass that CancellationTokenSource's token to initialization.

Author: DustinCampbell

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/Remote/RemoteServiceInvoker.cs

@@ -26,8 +26,7 @@ internal sealed class RemoteServiceInvoker(
  IClientCapabilitiesService clientCapabilitiesService,
  ISemanticTokensLegendService semanticTokensLegendService,
  ITelemetryReporter telemetryReporter,
- ILoggerFactory loggerFactory)
- : IRemoteServiceInvoker
+ ILoggerFactory loggerFactory) : IRemoteServiceInvoker, IDisposable
 {
  private readonly IWorkspaceProvider _workspaceProvider = workspaceProvider;
  private readonly LanguageServerFeatureOptions _languageServerFeatureOptions = languageServerFeatureOptions;
@@ -36,11 +35,24 @@ internal sealed class RemoteServiceInvoker(
  private readonly ITelemetryReporter _telemetryReporter = telemetryReporter;
  private readonly ILogger _logger = loggerFactory.GetOrCreateLogger<RemoteServiceInvoker>();
 
+ private readonly CancellationTokenSource _disposeTokenSource = new();
+
  private readonly object _gate = new();
  private ValueTask<bool>? _isInitializedTask;
  private ValueTask<bool>? _isLSPInitializedTask;
  private bool _fullyInitialized;
 
+ public void Dispose()
+ {
+ if (_disposeTokenSource.IsCancellationRequested)
+ {
+ return;
+ }
+
+ _disposeTokenSource.Cancel();
+ _disposeTokenSource.Dispose();
+ }
+
  public async ValueTask<TResult?> TryInvokeAsync<TService, TResult>(
  Solution solution,
  Func<TService, RazorPinnedSolutionInfoWrapper, CancellationToken, ValueTask<TResult>> invocation,
@@ -94,7 +106,7 @@ internal sealed class RemoteServiceInvoker(
  return null;
  }
 
- await InitializeRemoteClientAsync(remoteClient, cancellationToken).ConfigureAwait(false);
+ await InitializeRemoteClientAsync(remoteClient).ConfigureAwait(false);
 
  return remoteClient;
  }
@@ -117,7 +129,7 @@ internal sealed class RemoteServiceInvoker(
  cancellationToken).ConfigureAwait(false);
  }
 
- private async Task InitializeRemoteClientAsync(RazorRemoteHostClient remoteClient, CancellationToken cancellationToken)
+ private async Task InitializeRemoteClientAsync(RazorRemoteHostClient remoteClient)
  {
  if (_fullyInitialized)
  {
@@ -142,7 +154,7 @@ private async Task InitializeRemoteClientAsync(RazorRemoteHostClient remoteClien
 
  _isInitializedTask = remoteClient.TryInvokeAsync<IRemoteClientInitializationService>(
  (s, ct) => s.InitializeAsync(initParams, ct),
- cancellationToken);
+ _disposeTokenSource.Token);
  }
  }
 
@@ -164,7 +176,7 @@ private async Task InitializeRemoteClientAsync(RazorRemoteHostClient remoteClien
 
  _isLSPInitializedTask = remoteClient.TryInvokeAsync<IRemoteClientInitializationService>(
  (s, ct) => s.InitializeLSPAsync(initParams, ct),
- cancellationToken);
+ _disposeTokenSource.Token);
  }
  }