Only monitor individual configuration paths, rather than the whole workspace, in Visual Studio

Author: davidwengier

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Extensions/IServiceCollectionExtensions.cs

@@ -210,8 +210,13 @@ public static void AddDocumentManagementServices(this IServiceCollection service
         services.AddSingleton<IProjectConfigurationFileChangeListener, ProjectConfigurationStateSynchronizer>();
         services.AddSingleton<IRazorFileChangeListener, RazorFileSynchronizer>();
 
-        // File Change detectors
-        services.AddSingleton<IFileChangeDetector, ProjectConfigurationFileChangeDetector>();
+        // If we're not monitoring the whole workspace folder for configuration changes, then we don't actually need the the file change
+        // detector wired up via DI, as the razor/monitorProjectConfigurationFilePath endpoint will directly construct one. This means
+        // it can be a little simpler, and doesn't need to worry about which folders it's told to listen to.
+        if (featureOptions.MonitorWorkspaceFolderForConfigurationFiles)
+        {
+            services.AddSingleton<IFileChangeDetector, ProjectConfigurationFileChangeDetector>();
+        }
         services.AddSingleton<IFileChangeDetector, RazorFileChangeDetector>();
 
         // Document processed listeners

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/ProjectSystem/MonitorProjectConfigurationFilePathEndpoint.cs

@@ -84,28 +84,31 @@ public async Task HandleNotificationAsync(MonitorProjectConfigurationFilePathPar
         }
 
         var configurationDirectory = Path.GetDirectoryName(request.ConfigurationFilePath);
-        var normalizedConfigurationDirectory = FilePathNormalizer.NormalizeDirectory(configurationDirectory);
-        var workspaceDirectory = _workspaceDirectoryPathResolver.Resolve();
-        var normalizedWorkspaceDirectory = FilePathNormalizer.NormalizeDirectory(workspaceDirectory);
-
         Assumes.NotNull(configurationDirectory);
 
         var previousMonitorExists = _outputPathMonitors.TryGetValue(request.ProjectKeyId, out var entry);
 
-        if (normalizedConfigurationDirectory.StartsWith(normalizedWorkspaceDirectory, FilePathComparison.Instance))
+        if (_options.MonitorWorkspaceFolderForConfigurationFiles)
         {
-            if (previousMonitorExists)
-            {
-                _logger.LogInformation("Configuration directory changed from external directory -> internal directory for project '{0}, terminating existing monitor'.", request.ProjectKeyId);
-                RemoveMonitor(request.ProjectKeyId);
-            }
-            else
+            var normalizedConfigurationDirectory = FilePathNormalizer.NormalizeDirectory(configurationDirectory);
+            var workspaceDirectory = _workspaceDirectoryPathResolver.Resolve();
+            var normalizedWorkspaceDirectory = FilePathNormalizer.NormalizeDirectory(workspaceDirectory);
+
+            if (normalizedConfigurationDirectory.StartsWith(normalizedWorkspaceDirectory, FilePathComparison.Instance))
             {
-                _logger.LogInformation("No custom configuration directory required. The workspace directory is sufficient for '{0}'.", request.ProjectKeyId);
+                if (previousMonitorExists)
+                {
+                    _logger.LogInformation("Configuration directory changed from external directory -> internal directory for project '{0}, terminating existing monitor'.", request.ProjectKeyId);
+                    RemoveMonitor(request.ProjectKeyId);
+                }
+                else
+                {
+                    _logger.LogInformation("No custom configuration directory required. The workspace directory is sufficient for '{0}'.", request.ProjectKeyId);
+                }
+
+                // Configuration directory is already in the workspace directory. We already monitor everything in the workspace directory.
+                return;
             }
-
-            // Configuration directory is already in the workspace directory. We already monitor everything in the workspace directory.
-            return;
         }
 
         if (previousMonitorExists)

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

@@ -11,6 +11,7 @@
 using Microsoft.AspNetCore.Razor.LanguageServer.ProjectSystem;
 using Microsoft.AspNetCore.Razor.Test.Common;
 using Microsoft.CodeAnalysis.Razor;
+using Microsoft.CodeAnalysis.Razor.Workspaces;
 using Microsoft.Extensions.Logging;
 using Moq;
 using Xunit;
@@ -135,6 +136,32 @@ public async Task Handle_InWorkspaceDirectory_Noops()
         Assert.Equal(0, detector.StartCount);
     }
 
+    [Fact]
+    public async Task Handle_InWorkspaceDirectory_MonitorsIfLanguageFeatureOptionSet()
+    {
+        // Arrange
+        var detector = new TestFileChangeDetector();
+        var configurationFileEndpoint = new TestMonitorProjectConfigurationFilePathEndpoint(
+            () => detector,
+            LegacyDispatcher,
+            _directoryPathResolver,
+            Enumerable.Empty<IProjectConfigurationFileChangeListener>(),
+            LoggerFactory,
+            options: new TestLanguageServerFeatureOptions(monitorWorkspaceFolderForConfigurationFiles: false));
+        var startRequest = new MonitorProjectConfigurationFilePathParams()
+        {
+            ProjectKeyId = TestProjectKey.Create("C:/dir/obj").Id,
+            ConfigurationFilePath = "C:/dir/obj/Debug/project.razor.bin",
+        };
+        var requestContext = CreateRazorRequestContext(documentContext: null);
+
+        // Act
+        await configurationFileEndpoint.HandleNotificationAsync(startRequest, requestContext, DisposalToken);
+
+        // Assert
+        Assert.Equal(1, detector.StartCount);
+    }
+
     [Fact]
     public async Task Handle_DuplicateMonitors_Noops()
     {
@@ -323,31 +350,18 @@ private class TestMonitorProjectConfigurationFilePathEndpoint : MonitorProjectCo
     {
         private readonly Func<IFileChangeDetector> _fileChangeDetectorFactory;
 
-        public TestMonitorProjectConfigurationFilePathEndpoint(
-            ProjectSnapshotManagerDispatcher projectSnapshotManagerDispatcher,
-            WorkspaceDirectoryPathResolver workspaceDirectoryPathResolver,
-            IEnumerable<IProjectConfigurationFileChangeListener> listeners,
-            ILoggerFactory loggerFactory)
-            : this(
-                fileChangeDetectorFactory: null,
-                projectSnapshotManagerDispatcher,
-                workspaceDirectoryPathResolver,
-                listeners,
-                loggerFactory)
-        {
-        }
-
         public TestMonitorProjectConfigurationFilePathEndpoint(
             Func<IFileChangeDetector> fileChangeDetectorFactory,
             ProjectSnapshotManagerDispatcher projectSnapshotManagerDispatcher,
             WorkspaceDirectoryPathResolver workspaceDirectoryPathResolver,
             IEnumerable<IProjectConfigurationFileChangeListener> listeners,
-            ILoggerFactory loggerFactory)
+            ILoggerFactory loggerFactory,
+            LanguageServerFeatureOptions? options = null)
             : base(
                 projectSnapshotManagerDispatcher,
                 workspaceDirectoryPathResolver,
                 listeners,
-                TestLanguageServerFeatureOptions.Instance,
+                options ?? TestLanguageServerFeatureOptions.Instance,
                 loggerFactory)
         {
             _fileChangeDetectorFactory = fileChangeDetectorFactory ?? (() => Mock.Of<IFileChangeDetector>(MockBehavior.Strict));

src/Razor/test/Microsoft.CodeAnalysis.Razor.Workspaces.Test.Common/TestLanguageServerFeatureOptions.cs

@@ -9,12 +9,15 @@ internal class TestLanguageServerFeatureOptions : LanguageServerFeatureOptions
 {
     public static readonly LanguageServerFeatureOptions Instance = new TestLanguageServerFeatureOptions();
 
-    private bool _includeProjectKeyInGeneratedFilePath;
+    private readonly bool _includeProjectKeyInGeneratedFilePath;
+    private readonly bool _monitorWorkspaceFolderForConfigurationFiles;
 
     public TestLanguageServerFeatureOptions(
-        bool includeProjectKeyInGeneratedFilePath = false)
+        bool includeProjectKeyInGeneratedFilePath = false,
+        bool monitorWorkspaceFolderForConfigurationFiles = true)
     {
         _includeProjectKeyInGeneratedFilePath = includeProjectKeyInGeneratedFilePath;
+        _monitorWorkspaceFolderForConfigurationFiles = monitorWorkspaceFolderForConfigurationFiles;
     }
 
     public override bool SupportsFileManipulation => false;
@@ -41,5 +44,5 @@ public TestLanguageServerFeatureOptions(
 
     public override bool IncludeProjectKeyInGeneratedFilePath => _includeProjectKeyInGeneratedFilePath;
 
-    public override bool MonitorWorkspaceFolderForConfigurationFiles => true;
+    public override bool MonitorWorkspaceFolderForConfigurationFiles => _monitorWorkspaceFolderForConfigurationFiles;
 }