Workaround for #15972 (#15982)

Author: vzarytovskii

vsintegration/src/FSharp.Editor/Diagnostics/DocumentDiagnosticAnalyzer.fs

@@ -76,6 +76,8 @@ type internal FSharpDocumentDiagnosticAnalyzer [<ImportingConstructor>] () =
 
             let! parseResults = document.GetFSharpParseResultsAsync("GetDiagnostics")
 
+            // Old logic, rollback once https://github.com/dotnet/fsharp/issues/15972 is fixed (likely on Roslyn side, since we're returning diagnostics, but they're not getting to VS).
+            (*
             match diagnosticType with
             | DiagnosticsType.Syntax ->
                 for diagnostic in parseResults.Diagnostics do
@@ -88,6 +90,23 @@ type internal FSharpDocumentDiagnosticAnalyzer [<ImportingConstructor>] () =
                     errors.Add(diagnostic) |> ignore
 
                 errors.ExceptWith(parseResults.Diagnostics)
+            *)
+
+            // TODO: see comment above, this is a workaround for issue we have in current VS/Roslyn
+            match diagnosticType with
+            | DiagnosticsType.Syntax ->
+                for diagnostic in parseResults.Diagnostics do
+                    errors.Add(diagnostic) |> ignore
+
+            // We always add syntactic, and do not exclude them when semantic is requested
+            | DiagnosticsType.Semantic ->
+                for diagnostic in parseResults.Diagnostics do
+                    errors.Add(diagnostic) |> ignore
+
+                let! _, checkResults = document.GetFSharpParseAndCheckResultsAsync("GetDiagnostics")
+
+                for diagnostic in checkResults.Diagnostics do
+                    errors.Add(diagnostic) |> ignore
 
             if errors.Count = 0 then
                 return ImmutableArray.Empty

vsintegration/tests/FSharp.Editor.Tests/DocumentDiagnosticAnalyzerTests.fs

@@ -91,6 +91,72 @@ type DocumentDiagnosticAnalyzerTests() =
         actualError.Location.SourceSpan.End
         |> Assert.shouldBeEqualWith expectedEnd "Error end positions should match"
 
+    member private this.VerifyDiagnosticBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE
+        (
+            fileContents: string,
+            expectedMessage: string,
+            expectedSeverity: DiagnosticSeverity
+        ) =
+        // TODO: once workaround (https://github.com/dotnet/fsharp/pull/15982) will not be needed, this should be reverted back to normal method (see PR)
+        let errors =
+            getDiagnostics fileContents
+            |> Seq.filter (fun e -> e.Severity = expectedSeverity)
+            |> Seq.toArray
+
+        errors.Length
+        |> Assert.shouldBeEqualWith 2 "There should be two errors generated"
+
+        let actualError = errors.[0]
+        Assert.Equal(expectedSeverity, actualError.Severity)
+
+        actualError.GetMessage()
+        |> Assert.shouldBeEqualWith expectedMessage "Error messages should match"
+
+        let expectedStart = fileContents.IndexOf(startMarker) + startMarker.Length
+
+        actualError.Location.SourceSpan.Start
+        |> Assert.shouldBeEqualWith expectedStart "Error start positions should match"
+
+        let expectedEnd = fileContents.IndexOf(endMarker)
+
+        actualError.Location.SourceSpan.End
+        |> Assert.shouldBeEqualWith expectedEnd "Error end positions should match"
+
+    member private this.VerifyErrorBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(fileContents: string, expectedMessage: string) =
+        // TODO: once workaround (https://github.com/dotnet/fsharp/pull/15982) will not be needed, this should be reverted back to normal method (see PR)
+        this.VerifyDiagnosticBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(fileContents, expectedMessage, DiagnosticSeverity.Error)
+
+    member private this.VerifyErrorAtMarker_HACK_PLEASE_REFER_TO_COMMENT_INSIDE
+        (
+            fileContents: string,
+            expectedMarker: string,
+            ?expectedMessage: string
+        ) =
+        let errors =
+            getDiagnostics fileContents
+            |> Seq.filter (fun e -> e.Severity = DiagnosticSeverity.Error)
+            |> Seq.toArray
+
+        errors.Length
+        |> Assert.shouldBeEqualWith 2 "There should be exactly two errors generated"
+
+        let actualError = errors.[0]
+
+        if expectedMessage.IsSome then
+            actualError.GetMessage()
+            |> Assert.shouldBeEqualWith expectedMessage.Value "Error messages should match"
+
+        Assert.Equal(DiagnosticSeverity.Error, actualError.Severity)
+        let expectedStart = fileContents.IndexOf(expectedMarker)
+
+        actualError.Location.SourceSpan.Start
+        |> Assert.shouldBeEqualWith expectedStart "Error start positions should match"
+
+        let expectedEnd = expectedStart + expectedMarker.Length
+
+        actualError.Location.SourceSpan.End
+        |> Assert.shouldBeEqualWith expectedEnd "Error end positions should match"
+
     member private this.VerifyErrorBetweenMarkers(fileContents: string, expectedMessage: string) =
         this.VerifyDiagnosticBetweenMarkers(fileContents, expectedMessage, DiagnosticSeverity.Error)
 
@@ -99,7 +165,7 @@ type DocumentDiagnosticAnalyzerTests() =
 
     [<Fact>]
     member public this.Error_Expression_IllegalIntegerLiteral() =
-        this.VerifyErrorBetweenMarkers(
+        this.VerifyErrorBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 let _ = 1
@@ -110,7 +176,7 @@ let a = 0.1(*start*).(*end*)0
 
     [<Fact>]
     member public this.Error_Expression_IncompleteDefine() =
-        this.VerifyErrorBetweenMarkers(
+        this.VerifyErrorBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 let a = (*start*);(*end*)
@@ -120,7 +186,7 @@ let a = (*start*);(*end*)
 
     [<Fact>]
     member public this.Error_Expression_KeywordAsValue() =
-        this.VerifyErrorBetweenMarkers(
+        this.VerifyErrorBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 let b =
@@ -255,7 +321,7 @@ let f () =
 
     [<Fact>]
     member public this.Error_Identifer_IllegalFloatPointLiteral() =
-        this.VerifyErrorBetweenMarkers(
+        this.VerifyErrorBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 let x: float = 1.2(*start*).(*end*)3
@@ -368,7 +434,7 @@ async { if true then return 1 } |> ignore
 
     [<Fact>]
     member public this.ExtraEndif() =
-        this.VerifyErrorBetweenMarkers(
+        this.VerifyErrorBetweenMarkers_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 #if UNDEFINED
@@ -383,7 +449,7 @@ async { if true then return 1 } |> ignore
 
     [<Fact>]
     member public this.Squiggles_HashNotFirstSymbol_If() =
-        this.VerifyErrorAtMarker(
+        this.VerifyErrorAtMarker_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 (*comment*) #if UNDEFINED
@@ -398,7 +464,7 @@ async { if true then return 1 } |> ignore
 
     [<Fact>]
     member public this.Squiggles_HashNotFirstSymbol_Endif() =
-        this.VerifyErrorAtMarker(
+        this.VerifyErrorAtMarker_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 #if DEBUG
@@ -413,7 +479,7 @@ async { if true then return 1 } |> ignore
 
     [<Fact>]
     member public this.Squiggles_HashIfWithMultilineComment() =
-        this.VerifyErrorAtMarker(
+        this.VerifyErrorAtMarker_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 #if DEBUG (*comment*)
@@ -425,7 +491,7 @@ async { if true then return 1 } |> ignore
 
     [<Fact>]
     member public this.Squiggles_HashIfWithUnexpected() =
-        this.VerifyErrorAtMarker(
+        this.VerifyErrorAtMarker_HACK_PLEASE_REFER_TO_COMMENT_INSIDE(
             fileContents =
                 """
 #if DEBUG TEST