Pass CancellationToken to RazorFileChangeDetectorManager.InitializedAsync(...)

Author: DustinCampbell

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

@@ -3,47 +3,30 @@
 
 using System;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
-internal class RazorFileChangeDetectorManager : IDisposable
+internal class RazorFileChangeDetectorManager(
+    WorkspaceDirectoryPathResolver workspaceDirectoryPathResolver,
+    IEnumerable<IFileChangeDetector> fileChangeDetectors) : IDisposable
 {
-    private readonly WorkspaceDirectoryPathResolver _workspaceDirectoryPathResolver;
-    private readonly IReadOnlyList<IFileChangeDetector> _fileChangeDetectors;
-    private readonly object _disposeLock = new object();
+    private readonly WorkspaceDirectoryPathResolver _workspaceDirectoryPathResolver = workspaceDirectoryPathResolver;
+    private readonly ImmutableArray<IFileChangeDetector> _fileChangeDetectors = fileChangeDetectors.ToImmutableArray();
+    private readonly object _disposeLock = new();
     private bool _disposed;
 
-    public RazorFileChangeDetectorManager(
-        WorkspaceDirectoryPathResolver workspaceDirectoryPathResolver,
-        IEnumerable<IFileChangeDetector> fileChangeDetectors)
-    {
-        if (workspaceDirectoryPathResolver is null)
-        {
-            throw new ArgumentNullException(nameof(workspaceDirectoryPathResolver));
-        }
-
-        if (fileChangeDetectors is null)
-        {
-            throw new ArgumentNullException(nameof(fileChangeDetectors));
-        }
-
-        _workspaceDirectoryPathResolver = workspaceDirectoryPathResolver;
-        _fileChangeDetectors = fileChangeDetectors.ToArray();
-    }
-
-    public async Task InitializedAsync()
+    public async Task InitializedAsync(CancellationToken cancellationToken)
     {
         // Initialized request, this occurs once the server and client have agreed on what sort of features they both support. It only happens once.
 
         var workspaceDirectoryPath = _workspaceDirectoryPathResolver.Resolve();
 
         foreach (var fileChangeDetector in _fileChangeDetectors)
         {
-            // We create a dummy cancellation token for now. Have an issue to pass through the cancellation token in the O# lib: https://github.com/OmniSharp/csharp-language-server-protocol/issues/200
-            var cancellationToken = CancellationToken.None;
             await fileChangeDetector.StartAsync(workspaceDirectoryPath, cancellationToken).ConfigureAwait(false);
         }
 

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

@@ -21,7 +21,7 @@ public async Task HandleNotificationAsync(InitializedParams request, RazorReques
         var capabilitiesService = requestContext.GetRequiredService<IClientCapabilitiesService>();
 
         var fileChangeDetectorManager = requestContext.LspServices.GetRequiredService<RazorFileChangeDetectorManager>();
-        await fileChangeDetectorManager.InitializedAsync().ConfigureAwait(false);
+        await fileChangeDetectorManager.InitializedAsync(cancellationToken).ConfigureAwait(false);
 
         foreach (var onStartedItem in onStartedItems)
         {

src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/RazorFileChangeDetectorManagerTest.cs

@@ -1,19 +1,19 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
-#nullable disable
-
 using System;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.AspNetCore.Razor.Test.Common;
 using Microsoft.CommonLanguageServerProtocol.Framework;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 using Moq;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
-public class RazorFileChangeDetectorManagerTest
+public class RazorFileChangeDetectorManagerTest(ITestOutputHelper testOutput) : ToolingTestBase(testOutput)
 {
     [Fact]
     public async Task InitializedAsync_StartsFileChangeDetectors()
@@ -32,30 +32,41 @@ public async Task InitializedAsync_StartsFileChangeDetectors()
         {
             RootUri = uriBuilder.Uri,
         };
-        var languageServer = new Mock<IInitializeManager<InitializeParams, InitializeResult>>(MockBehavior.Strict);
-        languageServer.Setup(s => s.GetInitializeParams())
+
+        var languageServerMock = new StrictMock<IInitializeManager<InitializeParams, InitializeResult>>();
+        languageServerMock
+            .Setup(s => s.GetInitializeParams())
             .Returns(clientSettings);
-        var detector1 = new Mock<IFileChangeDetector>(MockBehavior.Strict);
+
         var expectedWorkspaceDirectory = $"\\\\{initialWorkspaceDirectory}";
-        detector1
+
+        var detectorMock1 = new StrictMock<IFileChangeDetector>();
+        detectorMock1
             .Setup(detector => detector.StartAsync(expectedWorkspaceDirectory, It.IsAny<CancellationToken>()))
             .Returns(Task.CompletedTask)
             .Verifiable();
-        var detector2 = new Mock<IFileChangeDetector>(MockBehavior.Strict);
-        detector2
+
+        detectorMock1.Setup(x => x.Stop());
+
+        var detectorMock2 = new StrictMock<IFileChangeDetector>();
+        detectorMock2
             .Setup(detector => detector.StartAsync(expectedWorkspaceDirectory, It.IsAny<CancellationToken>()))
             .Returns(Task.CompletedTask)
             .Verifiable();
-        var workspaceDirectoryPathResolver = new DefaultWorkspaceDirectoryPathResolver(languageServer.Object);
-        var detectorManager = new RazorFileChangeDetectorManager(workspaceDirectoryPathResolver, new[] { detector1.Object, detector2.Object });
 
-        // Act
-        await detectorManager.InitializedAsync();
+        detectorMock2.Setup(x => x.Stop());
+
+        var workspaceDirectoryPathResolver = new DefaultWorkspaceDirectoryPathResolver(languageServerMock.Object);
+        using (var detectorManager = new RazorFileChangeDetectorManager(workspaceDirectoryPathResolver, [detectorMock1.Object, detectorMock2.Object]))
+        {
+            // Act
+            await detectorManager.InitializedAsync(DisposalToken);
+        }
 
         // Assert
-        detector1.VerifyAll();
-        detector2.VerifyAll();
-        languageServer.VerifyAll();
+        detectorMock1.VerifyAll();
+        detectorMock2.VerifyAll();
+        languageServerMock.VerifyAll();
     }
 
     [Fact]
@@ -67,22 +78,27 @@ public async Task InitializedAsync_Disposed_ReStopsFileChangeDetectors()
         {
             RootUri = new Uri(expectedWorkspaceDirectory),
         };
-        var languageServer = new Mock<IInitializeManager<InitializeParams, InitializeResult>>(MockBehavior.Strict);
-        languageServer
+
+        var languageServerMock = new StrictMock<IInitializeManager<InitializeParams, InitializeResult>>();
+        languageServerMock
             .Setup(s => s.GetInitializeParams())
             .Returns(clientSettings);
 
-        var detector = new Mock<IFileChangeDetector>(MockBehavior.Strict);
+        var detectorMock = new StrictMock<IFileChangeDetector>();
         var cts = new TaskCompletionSource<bool>();
-        detector.Setup(d => d.StartAsync(It.IsAny<string>(), It.IsAny<CancellationToken>()))
+        detectorMock
+            .Setup(d => d.StartAsync(It.IsAny<string>(), It.IsAny<CancellationToken>()))
             .Returns(cts.Task);
         var stopCount = 0;
-        detector.Setup(d => d.Stop()).Callback(() => stopCount++);
-        var workspaceDirectoryPathResolver = new DefaultWorkspaceDirectoryPathResolver(languageServer.Object);
-        var detectorManager = new RazorFileChangeDetectorManager(workspaceDirectoryPathResolver, new[] { detector.Object });
+        detectorMock
+            .Setup(d => d.Stop())
+            .Callback(() => stopCount++);
+
+        var workspaceDirectoryPathResolver = new DefaultWorkspaceDirectoryPathResolver(languageServerMock.Object);
+        using var detectorManager = new RazorFileChangeDetectorManager(workspaceDirectoryPathResolver, [detectorMock.Object]);
 
         // Act
-        var initializeTask = detectorManager.InitializedAsync();
+        var initializeTask = detectorManager.InitializedAsync(DisposalToken);
         detectorManager.Dispose();
 
         // Unblock the detector start
@@ -92,6 +108,6 @@ public async Task InitializedAsync_Disposed_ReStopsFileChangeDetectors()
         // Assert
         Assert.Equal(2, stopCount);
 
-        languageServer.VerifyAll();
+        languageServerMock.VerifyAll();
     }
 }