[release/dev17.10] Avoid force-creating the project snapshot manager off the dispatcher

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

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using Microsoft.CodeAnalysis.Razor;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.Workspaces;
@@ -39,4 +40,10 @@ public ProjectSnapshotManagerBase Instance
             return _instance;
         }
     }
+
+    public bool TryGetInstance([NotNullWhen(true)] out ProjectSnapshotManagerBase? instance)
+    {
+        instance = _instance;
+        return instance is not null;
+    }
 }

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/IProjectSnapshotManagerAccessor.cs

@@ -1,11 +1,18 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
+using System.Diagnostics.CodeAnalysis;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 
 namespace Microsoft.CodeAnalysis.Razor.Workspaces;
 
 internal interface IProjectSnapshotManagerAccessor
 {
     ProjectSnapshotManagerBase Instance { get; }
+
+    /// <summary>
+    ///  Retrieves the <see cref="ProjectSnapshotManagerBase"/> instance. Returns <see langword="true"/>
+    ///  if the instance has been created; otherwise, <see langword="false"/>.
+    /// </summary>
+    bool TryGetInstance([NotNullWhen(true)] out ProjectSnapshotManagerBase? instance);
 }

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/ProjectSystem/FallbackProjectManager.cs

@@ -44,7 +44,8 @@ internal async Task DynamicFileAddedAsync(
     {
         try
         {
-            if (_projectManagerAccessor.Instance.TryGetLoadedProject(razorProjectKey, out var project))
+            if (_projectManagerAccessor.TryGetInstance(out var projectSnapshotManager) &&
+                projectSnapshotManager.TryGetLoadedProject(razorProjectKey, out var project))
             {
                 if (project is ProjectSnapshot { HostProject: FallbackHostProject })
                 {
@@ -76,7 +77,8 @@ internal async Task DynamicFileRemovedAsync(
     {
         try
         {
-            if (_projectManagerAccessor.Instance.TryGetLoadedProject(razorProjectKey, out var project) &&
+            if (_projectManagerAccessor.TryGetInstance(out var projectSnapshotManager) &&
+                projectSnapshotManager.TryGetLoadedProject(razorProjectKey, out var project) &&
                 project is ProjectSnapshot { HostProject: FallbackHostProject })
             {
                 // If this is a fallback project, then Roslyn may not track documents in the project, so these dynamic file notifications

src/Razor/src/Microsoft.VisualStudio.LanguageServerClient.Razor/CSharpVirtualDocumentFactory.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.ComponentModel.Composition;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
@@ -192,7 +193,9 @@ private IEnumerable<ProjectKey> GetProjectKeys(Uri hostDocumentUri)
             yield break;
         }
 
-        var projects = _projectSnapshotManagerAccessor.Instance.GetProjects();
+        var projects = _projectSnapshotManagerAccessor.TryGetInstance(out var projectSnapshotManager)
+            ? projectSnapshotManager.GetProjects()
+            : ImmutableArray<IProjectSnapshot>.Empty;
 
         var inAny = false;
         var normalizedDocumentPath = FilePathService.GetProjectSystemFilePath(hostDocumentUri);

src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/VisualStudioProjectSnapshotManagerAccessor.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
 using System.ComponentModel.Composition;
+using System.Diagnostics.CodeAnalysis;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Razor;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
@@ -59,4 +60,10 @@ ProjectSnapshotManagerBase Create()
             }
         }
     }
+
+    public bool TryGetInstance([NotNullWhen(true)] out ProjectSnapshotManagerBase? instance)
+    {
+        instance = _projectManager;
+        return instance is not null;
+    }
 }

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

@@ -5,6 +5,7 @@
 
 using System;
 using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc.Razor.Extensions.Version2_X;
@@ -180,6 +181,14 @@ internal static IProjectSnapshotManagerAccessor CreateProjectSnapshotManagerAcce
 
     internal class TestProjectSnapshotManagerAccessor(ProjectSnapshotManagerBase instance) : IProjectSnapshotManagerAccessor
     {
-        public ProjectSnapshotManagerBase Instance => instance;
+        private readonly ProjectSnapshotManagerBase _instance = instance;
+
+        public ProjectSnapshotManagerBase Instance => _instance;
+
+        public bool TryGetInstance([NotNullWhen(true)] out ProjectSnapshotManagerBase instance)
+        {
+            instance = _instance;
+            return instance is not null;
+        }
     }
 }

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

@@ -1,12 +1,21 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
+using System.Diagnostics.CodeAnalysis;
 using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.Workspaces;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer.Test;
 
 internal class TestProjectSnapshotManagerAccessor(ProjectSnapshotManagerBase instance) : IProjectSnapshotManagerAccessor
 {
-    public ProjectSnapshotManagerBase Instance => instance;
+    private readonly ProjectSnapshotManagerBase _instance = instance;
+
+    public ProjectSnapshotManagerBase Instance => _instance;
+
+    public bool TryGetInstance([NotNullWhen(true)] out ProjectSnapshotManagerBase? instance)
+    {
+        instance = _instance;
+        return instance is not null;
+    }
 }

src/Razor/test/Microsoft.VisualStudio.LanguageServerClient.Razor.Test/CSharpVirtualDocumentFactoryTest.cs

@@ -10,6 +10,7 @@
 using Microsoft.AspNetCore.Razor.Test.Common.LanguageServer;
 using Microsoft.AspNetCore.Razor.Test.Common.Workspaces;
 using Microsoft.CodeAnalysis.Razor;
+using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Razor.Workspaces;
 using Microsoft.VisualStudio.Editor.Razor;
 using Microsoft.VisualStudio.LanguageServer.ContainedLanguage;
@@ -78,6 +79,40 @@ public void TryCreateMultipleFor_NonRazorLSPBuffer_ReturnsFalse()
         Assert.Null(virtualDocuments);
     }
 
+    [Fact]
+    public void TryCreateMultipleFor_NoProjectSnapshotManager_ReturnsFalse()
+    {
+        // Arrange
+        var uri = new Uri("C:/path/to/file.razor");
+        var uriProvider = StrictMock.Of<FileUriProvider>(x =>
+            x.GetOrCreate(It.IsAny<ITextBuffer>()) == uri);
+
+        var projectManagerAccessorMock = new StrictMock<IProjectSnapshotManagerAccessor>();
+
+        ProjectSnapshotManagerBase instance = null;
+        projectManagerAccessorMock
+            .Setup(x => x.TryGetInstance(out instance))
+            .Returns(false);
+
+        var factory = new CSharpVirtualDocumentFactory(
+            _contentTypeRegistryService,
+            _textBufferFactoryService,
+            StrictMock.Of<ITextDocumentFactoryService>(),
+            uriProvider,
+            _filePathService,
+            projectManagerAccessorMock.Object,
+            TestLanguageServerFeatureOptions.Instance,
+            LoggerFactory,
+            telemetryReporter: null!);
+
+        // Act
+        var result = factory.TryCreateMultipleFor(_nonRazorLSPBuffer, out var virtualDocuments);
+
+        // Assert
+        Assert.False(result);
+        Assert.Null(virtualDocuments);
+    }
+
     [Fact]
     public void TryCreateMultipleFor_RazorLSPBuffer_ReturnsCSharpVirtualDocumentAndTrue()
     {
@@ -117,7 +152,18 @@ public void TryCreateMultipleFor_RazorLSPBuffer_ReturnsMultipleCSharpVirtualDocu
         project = TestProjectSnapshot.Create(@"C:\path\to\project2.csproj", @"C:\path\to\obj2", Array.Empty<string>(), RazorConfiguration.Default, projectWorkspaceState: null);
         projectSnapshotManager.ProjectAdded(project.HostProject);
         projectSnapshotManager.CreateAndAddDocument(project, @"C:\path\to\file.razor");
-        var projectSnapshotManagerAccessor = Mock.Of<IProjectSnapshotManagerAccessor>(a => a.Instance == projectSnapshotManager, MockBehavior.Strict);
+
+        var projectManagerAccessorMock = new StrictMock<IProjectSnapshotManagerAccessor>();
+        projectManagerAccessorMock
+            .SetupGet(x => x.Instance)
+            .Returns(projectSnapshotManager);
+
+        ProjectSnapshotManagerBase instance = projectSnapshotManager;
+        projectManagerAccessorMock
+            .Setup(x => x.TryGetInstance(out instance))
+            .Returns(true);
+
+        var projectSnapshotManagerAccessor = projectManagerAccessorMock.Object;
 
         var languageServerFeatureOptions = new TestLanguageServerFeatureOptions(includeProjectKeyInGeneratedFilePath: true);
         var filePathService = new FilePathService(languageServerFeatureOptions);

src/Razor/test/Microsoft.VisualStudio.LanguageServices.Razor.Test/ProjectSystem/FallbackProjectManagerTest.cs

@@ -34,13 +34,21 @@ public FallbackProjectManagerTest(ITestOutputHelper testOutputHelper)
 
         _projectManager = new TestProjectSnapshotManager(ProjectEngineFactoryProvider, Dispatcher);
 
-        var projectManagerAccessor = StrictMock.Of<IProjectSnapshotManagerAccessor>(a =>
-            a.Instance == _projectManager);
+        var projectManagerAccessorMock = new StrictMock<IProjectSnapshotManagerAccessor>();
+
+        projectManagerAccessorMock
+            .SetupGet(x => x.Instance)
+            .Returns(_projectManager);
+
+        ProjectSnapshotManagerBase? instanceResult = _projectManager;
+        projectManagerAccessorMock
+            .Setup(x => x.TryGetInstance(out instanceResult))
+            .Returns(true);
 
         _fallbackProjectManger = new FallbackProjectManager(
             _projectConfigurationFilePathStore,
             languageServerFeatureOptions,
-            projectManagerAccessor,
+            projectManagerAccessorMock.Object,
             Dispatcher,
             WorkspaceProvider,
             NoOpTelemetryReporter.Instance);