Add project information to razor diagnostics (#9595)

Author: Andrew Hall

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Diagnostics/DocumentPullDiagnosticsEndpoint.cs

@@ -126,7 +126,7 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(VSInternalDocumentDiagno
             return null;
         }
 
-        var convertedDiagnostics = RazorDiagnosticConverter.Convert(diagnostics, sourceText);
+        var convertedDiagnostics = RazorDiagnosticConverter.Convert(diagnostics, sourceText, documentContext.Snapshot);
 
         return
         [

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Diagnostics/RazorDiagnosticConverter.cs

@@ -5,14 +5,15 @@
 using System.Collections.Generic;
 using System.Globalization;
 using Microsoft.AspNetCore.Razor.Language;
+using Microsoft.CodeAnalysis.Razor.ProjectSystem;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer.Diagnostics;
 
 internal static class RazorDiagnosticConverter
 {
-    public static Diagnostic Convert(RazorDiagnostic razorDiagnostic, SourceText sourceText)
+    public static VSDiagnostic Convert(RazorDiagnostic razorDiagnostic, SourceText sourceText, IDocumentSnapshot? documentSnapshot)
     {
         if (razorDiagnostic is null)
         {
@@ -24,7 +25,18 @@ public static Diagnostic Convert(RazorDiagnostic razorDiagnostic, SourceText sou
             throw new ArgumentNullException(nameof(sourceText));
         }
 
-        var diagnostic = new Diagnostic()
+        var projects = documentSnapshot is null
+            ? Array.Empty<VSDiagnosticProjectInformation>()
+            : [
+                new VSDiagnosticProjectInformation()
+                {
+                    Context = null,
+                    ProjectIdentifier = documentSnapshot.Project.Key.Id,
+                    ProjectName = documentSnapshot.Project.DisplayName
+                }
+            ];
+
+        var diagnostic = new VSDiagnostic()
         {
             Message = razorDiagnostic.GetMessage(CultureInfo.InvariantCulture),
             Code = razorDiagnostic.Id,
@@ -33,19 +45,20 @@ public static Diagnostic Convert(RazorDiagnostic razorDiagnostic, SourceText sou
             // This is annotated as not null, but we have tests that validate the behaviour when
             // we pass in null here
             Range = ConvertSpanToRange(razorDiagnostic.Span, sourceText)!,
+            Projects = projects
         };
 
         return diagnostic;
     }
 
-    internal static Diagnostic[] Convert(IReadOnlyList<RazorDiagnostic> diagnostics, SourceText sourceText)
+    internal static Diagnostic[] Convert(IReadOnlyList<RazorDiagnostic> diagnostics, SourceText sourceText, IDocumentSnapshot documentSnapshot)
     {
         var convertedDiagnostics = new Diagnostic[diagnostics.Count];
 
         var i = 0;
         foreach (var diagnostic in diagnostics)
         {
-            convertedDiagnostics[i++] = Convert(diagnostic, sourceText);
+            convertedDiagnostics[i++] = Convert(diagnostic, sourceText, documentSnapshot);
         }
 
         return convertedDiagnostics;

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Diagnostics/RazorDiagnosticsPublisher.cs

@@ -264,7 +264,7 @@ fullDiagnostics.Items is not null &&
             return;
         }
 
-        var convertedDiagnostics = razorDiagnostics.Select(razorDiagnostic => RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText));
+        var convertedDiagnostics = razorDiagnostics.Select(razorDiagnostic => RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText, document));
         var combinedDiagnostics = csharpDiagnostics == null ? convertedDiagnostics : convertedDiagnostics.Concat(csharpDiagnostics);
         PublishDiagnosticsForFilePath(document.FilePath, combinedDiagnostics);
 

src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Diagnostics/RazorDiagnosticConverterTest.cs

@@ -22,7 +22,7 @@ public void Convert_Converts()
         var sourceText = SourceText.From(string.Empty);
 
         // Act
-        var diagnostic = RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText);
+        var diagnostic = RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText, documentSnapshot: null);
 
         // Assert
         Assert.Equal(razorDiagnostic.Id, diagnostic.Code);

src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/Diagnostics/RazorDiagnosticsPublisherTest.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
 using System;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Razor.Language;
@@ -193,10 +194,17 @@ public async Task PublishDiagnosticsAsync_NewDocumentDiagnosticsGetPublished(boo
                     var resultRazorDiagnostic = @params.Diagnostics[0];
                     var razorDiagnostic = s_singleRazorDiagnostic[0];
                     Assert.True(processedOpenDocument.TryGetText(out var sourceText));
-                    var expectedRazorDiagnostic = RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText);
+                    var expectedRazorDiagnostic = RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText, _openedDocument);
                     Assert.Equal(expectedRazorDiagnostic.Message, resultRazorDiagnostic.Message);
                     Assert.Equal(expectedRazorDiagnostic.Severity, resultRazorDiagnostic.Severity);
                     Assert.Equal(expectedRazorDiagnostic.Range, resultRazorDiagnostic.Range);
+                    Assert.NotNull(expectedRazorDiagnostic.Projects);
+                    Assert.Single(expectedRazorDiagnostic.Projects);
+
+                    var project = expectedRazorDiagnostic.Projects.Single();
+                    Assert.Equal(_openedDocument.Project.DisplayName, project.ProjectName);
+                    Assert.Equal(_openedDocument.Project.Key.Id, project.ProjectIdentifier);
+
                 }
             })
             .Returns(Task.CompletedTask);
@@ -247,10 +255,15 @@ public async Task PublishDiagnosticsAsync_NewRazorDiagnosticsGetPublished()
                 var diagnostic = Assert.Single(@params.Diagnostics);
                 var razorDiagnostic = s_singleRazorDiagnostic[0];
                 Assert.True(processedOpenDocument.TryGetText(out var sourceText));
-                var expectedDiagnostic = RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText);
+                var expectedDiagnostic = RazorDiagnosticConverter.Convert(razorDiagnostic, sourceText, _openedDocument);
                 Assert.Equal(expectedDiagnostic.Message, diagnostic.Message);
                 Assert.Equal(expectedDiagnostic.Severity, diagnostic.Severity);
                 Assert.Equal(expectedDiagnostic.Range, diagnostic.Range);
+
+                Assert.NotNull(expectedDiagnostic.Projects);
+                var project = expectedDiagnostic.Projects.Single();
+                Assert.Equal(_openedDocument.Project.DisplayName, project.ProjectName);
+                Assert.Equal(_openedDocument.Project.Key.Id, project.ProjectIdentifier);
             })
             .Returns(Task.CompletedTask);