Perform generator retry logic when there are multiple projects in the solution (#12338)

Fixes #12337

Turns out we shouldn't have ever had the notion of "retry projects", but
rather "retry solutions". Or maybe I just thought the requests would
come in linearly enough that the lock in the manager would be
sufficient? 🤷‍♂️

Sadly, whilst this fixes the error bars, it doesn't do anything about
the errors that are reported when we lose the race. That will either
come later in another fix (for
#12316 perhaps???), or we can just
turn on the generator by default which makes this fix, and the whole
retry notion, redundant.

Author: davidwengier

src/Razor/src/Microsoft.CodeAnalysis.Remote.Razor/ProjectSystem/RemoteProjectSnapshot.cs

@@ -73,7 +73,8 @@ public RemoteDocumentSnapshot GetDocument(TextDocument document)
             // of re-running the generator (a "retry project") and the document they passed in is from the original project
             // because it comes from the devenv side, so we can be a little lenient here. Since retry projects only exist
             // early in a session, we should still catch coding errors with even basic manual testing.
-            document = _project.IsRetryProject() && _project.GetAdditionalDocument(document.Id) is { } retryDocument
+            document = _project.Solution.Projects.Any(p => p.IsRetryProject()) &&
+                _project.GetAdditionalDocument(document.Id) is { } retryDocument
                     ? retryDocument
                     : throw new ArgumentException(SR.Document_does_not_belong_to_this_project, nameof(document));
         }

src/Razor/src/Microsoft.CodeAnalysis.Remote.Razor/ProjectSystem/RemoteSolutionSnapshot.cs

@@ -30,7 +30,8 @@ public RemoteProjectSnapshot GetProject(Project project)
         {
             // It might look like we don't know about this project, but we might have actually seen it before but been forced
             // to retry running source generators in it, so we handle that specific case here.
-            project = _solution.GetProject(project.Id) is { } retryProject && retryProject.IsRetryProject()
+            project = _solution.GetProject(project.Id) is { } retryProject &&
+                retryProject.Solution.Projects.Any(p => p.IsRetryProject())
                     ? retryProject
                     : throw new ArgumentException(SR.Project_does_not_belong_to_this_solution, nameof(project));
         }

src/Razor/test/Microsoft.AspNetCore.Razor.Test.Common.Cohosting/CohostTestBase.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Text;
@@ -140,9 +141,14 @@ protected virtual TextDocument CreateProjectAndRazorDocument(
     }
 
     protected static TextDocument CreateProjectAndRazorDocument(CodeAnalysis.Workspace workspace, ProjectId projectId, bool miscellaneousFile, DocumentId documentId, string documentFilePath, string contents, (string fileName, string contents)[]? additionalFiles, bool inGlobalNamespace)
+    {
+        return AddProjectAndRazorDocument(workspace.CurrentSolution, TestProjectData.SomeProject.FilePath, projectId, miscellaneousFile, documentId, documentFilePath, contents, additionalFiles, inGlobalNamespace);
+    }
+
+    protected static TextDocument AddProjectAndRazorDocument(Solution solution, [DisallowNull] string? projectFilePath, ProjectId projectId, bool miscellaneousFile, DocumentId documentId, string documentFilePath, string contents, (string fileName, string contents)[]? additionalFiles, bool inGlobalNamespace)
     {
         // We simulate a miscellaneous file project by not having a project file path.
-        var projectFilePath = miscellaneousFile ? null : TestProjectData.SomeProject.FilePath;
+        projectFilePath = miscellaneousFile ? null : projectFilePath;
         var projectName = miscellaneousFile ? "" : Path.GetFileNameWithoutExtension(projectFilePath).AssumeNotNull();
 
         var sgAssembly = typeof(RazorSourceGenerator).Assembly;
@@ -167,7 +173,7 @@ protected static TextDocument CreateProjectAndRazorDocument(CodeAnalysis.Workspa
             projectInfo = projectInfo.WithDefaultNamespace(TestProjectData.SomeProject.RootNamespace);
         }
 
-        var solution = workspace.CurrentSolution.AddProject(projectInfo);
+        solution = solution.AddProject(projectInfo);
 
         solution = solution
             .AddAdditionalDocument(
@@ -221,7 +227,7 @@ @using Microsoft.AspNetCore.Components.Web
 
             var projectBasePath = Path.GetDirectoryName(projectFilePath).AssumeNotNull();
             // Normally MS Build targets do this for us, but we're on our own!
-            foreach (var razorDocument in solution.Projects.Single().AdditionalDocuments)
+            foreach (var razorDocument in solution.GetRequiredProject(projectId).AdditionalDocuments)
             {
                 if (razorDocument.FilePath is not null &&
                     razorDocument.FilePath.StartsWith(projectBasePath))

src/Razor/test/Microsoft.VisualStudio.LanguageServices.Razor.Test/Cohost/CohostEndpointTestBase.cs

@@ -15,6 +15,7 @@
 using Microsoft.CodeAnalysis.Razor.Workspaces;
 using Microsoft.CodeAnalysis.Razor.Workspaces.Settings;
 using Microsoft.VisualStudio.Composition;
+using Microsoft.VisualStudio.Language.CodeCleanUp;
 using Microsoft.VisualStudio.Razor.Settings;
 using Xunit;
 using Xunit.Abstractions;
@@ -87,6 +88,18 @@ private protected override RemoteClientLSPInitializationOptions GetRemoteClientL
     private protected virtual TestComposition ConfigureRoslynDevenvComposition(TestComposition composition)
         => composition;
 
+    protected TextDocument CreateProjectAndRazorDocument(
+        string contents,
+        bool remoteOnly)
+    {
+        if (remoteOnly)
+        {
+            return base.CreateProjectAndRazorDocument(contents, fileKind: null, documentFilePath: null, additionalFiles: null, inGlobalNamespace: false, miscellaneousFile: false);
+        }
+
+        return this.CreateProjectAndRazorDocument(contents);
+    }
+
     protected override TextDocument CreateProjectAndRazorDocument(
         string contents,
         RazorFileKind? fileKind = null,

src/Razor/test/Microsoft.VisualStudio.LanguageServices.Razor.Test/Cohost/RetryProjectTest.cs

@@ -3,8 +3,10 @@
 
 using System;
 using System.Threading.Tasks;
+using Microsoft.AspNetCore.Razor;
 using Microsoft.AspNetCore.Razor.Language;
 using Microsoft.AspNetCore.Razor.Test.Common;
+using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.ExternalAccess.Razor;
 using Microsoft.CodeAnalysis.Remote.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Remote.Razor.Resources;
@@ -29,7 +31,6 @@ public async Task HoverRequest_ReturnsResults()
         var document = CreateProjectAndRazorDocument(input.Text, RazorFileKind.Component);
 
         // Make sure the source generator has been run while cohosting is off, to simular Roslyn winning the initialization race
-        //var compilation = await document.Project.GetCompilationAsync(DisposalToken);
         Assert.Empty(await document.Project.GetSourceGeneratedDocumentsAsync(DisposalToken));
 
         // Now turn the source generator on, to simulate Razor starting up and initializing OOP
@@ -51,6 +52,62 @@ public async Task HoverRequest_ReturnsResults()
         Assert.NotNull(hoverResult);
     }
 
+    [Fact]
+    public async Task HoverRequest_MultipleProjects_ReturnsResults()
+    {
+        RazorCohostingOptions.UseRazorCohostServer = false;
+
+        TestCode input = """
+            <div></div>
+            @System.DateTi$$me.Now
+            """;
+        // Specify remoteOnly because our test infrastructure isn't set up to mutate solutions otherwise
+        var document = CreateProjectAndRazorDocument(input.Text, remoteOnly: true);
+
+        // Now we create another document, in another project
+        TestCode otherInput = """
+            @System.DateTi$$me.Now
+            <div></div>
+            """;
+        var projectId = ProjectId.CreateNewId(debugName: TestProjectData.SomeProject.DisplayName);
+        var documentFilePath = TestProjectData.AnotherProjectComponentFile1.FilePath;
+        var documentId = DocumentId.CreateNewId(projectId, debugName: documentFilePath);
+        var otherDocument = AddProjectAndRazorDocument(document.Project.Solution, TestProjectData.AnotherProject.FilePath, projectId, miscellaneousFile: false, documentId, documentFilePath, otherInput.Text, additionalFiles: null, inGlobalNamespace: false);
+
+        // Make sure we have the document from our new fork
+        document = otherDocument.Project.Solution.GetAdditionalDocument(document.Id).AssumeNotNull();
+
+        // Make sure the source generator has been run while cohosting is off, to simular Roslyn winning the initialization race
+        Assert.Empty(await document.Project.GetSourceGeneratedDocumentsAsync(DisposalToken));
+        Assert.Empty(await otherDocument.Project.GetSourceGeneratedDocumentsAsync(DisposalToken));
+
+        // Now turn the source generator on, to simulate Razor starting up and initializing OOP
+        RazorCohostingOptions.UseRazorCohostServer = true;
+
+        var requestInvoker = new TestHtmlRequestInvoker();
+        var endpoint = new CohostHoverEndpoint(IncompatibleProjectService, RemoteServiceInvoker, requestInvoker);
+
+        // Making this request will cause our solution to be redirected, and project 1 to be a retry project
+        await MakeHoverRequestAsync(input, document);
+
+        // Making this request will use our redirect solution, but project 2 is not a retry project, so would fail normally
+        await MakeHoverRequestAsync(otherInput, otherDocument);
+
+        async Task MakeHoverRequestAsync(TestCode input, TextDocument document)
+        {
+            var inputText = await document.GetTextAsync(DisposalToken);
+            var linePosition = inputText.GetLinePosition(input.Position);
+            var textDocumentPositionParams = new TextDocumentPositionParams
+            {
+                Position = LspFactory.CreatePosition(linePosition),
+                TextDocument = new TextDocumentIdentifier { DocumentUri = document.CreateDocumentUri() },
+            };
+
+            var hoverResult = await endpoint.GetTestAccessor().HandleRequestAsync(textDocumentPositionParams, document, DisposalToken);
+            Assert.NotNull(hoverResult);
+        }
+    }
+
     [Fact]
     public async Task GetRequiredCodeDocument_SucceedsAndReturnsRetryProject()
     {
@@ -62,7 +119,6 @@ public async Task GetRequiredCodeDocument_SucceedsAndReturnsRetryProject()
         var document = CreateProjectAndRazorDocument(input.Text, RazorFileKind.Component);
 
         // Make sure the source generator has been run while cohosting is off, to simulate Roslyn winning the initialization race
-        //var compilation = await document.Project.GetCompilationAsync(DisposalToken);
         Assert.Empty(await document.Project.GetSourceGeneratedDocumentsAsync(DisposalToken));
 
         // Now turn the source generator on, to simulate Razor starting up and initializing OOP
@@ -89,7 +145,6 @@ public async Task GetSnapshot_ReturnsDifferentSolutionSnapshots()
         var document = CreateProjectAndRazorDocument(input.Text, RazorFileKind.Component);
 
         // Make sure the source generator has been run while cohosting is off, to simular Roslyn winning the initialization race
-        //var compilation = await document.Project.GetCompilationAsync(DisposalToken);
         Assert.Empty(await document.Project.GetSourceGeneratedDocumentsAsync(DisposalToken));
 
         var snapshotManager = OOPExportProvider.GetExportedValue<RemoteSnapshotManager>();
@@ -119,7 +174,6 @@ public async Task CohostingOff_Throws()
         var document = CreateProjectAndRazorDocument(input.Text, RazorFileKind.Component);
 
         // Make sure the source generator has been run while cohosting is off, to simular Roslyn winning the initialization race
-        //var compilation = await document.Project.GetCompilationAsync(DisposalToken);
         Assert.Empty(await document.Project.GetSourceGeneratedDocumentsAsync(DisposalToken));
 
         var snapshotManager = OOPExportProvider.GetExportedValue<RemoteSnapshotManager>();
@@ -143,7 +197,6 @@ public async Task ProjectChanges_NotRetryProject()
         var document = CreateProjectAndRazorDocument(input.Text, RazorFileKind.Component);
 
         // Make sure the source generator has been run while cohosting is off, to simular Roslyn winning the initialization race
-        //var compilation = await document.Project.GetCompilationAsync(DisposalToken);
         Assert.Empty(await document.Project.GetSourceGeneratedDocumentsAsync(DisposalToken));
 
         var snapshotManager = OOPExportProvider.GetExportedValue<RemoteSnapshotManager>();