Update LSP Protocol Types

.vscode/settings.json

@@ -36,5 +36,12 @@
     "dotnet.defaultSolution": "Roslyn.sln",
     "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true,
     "dotnet.testWindow.disableAutoDiscovery": true,
-    "dotnet.testWindow.disableBuildOnRefresh": true
+    "dotnet.testWindow.disableBuildOnRefresh": true,
+    "cSpell.words": [
+        "Nerdbank",
+        "NETCOREAPP",
+        "Unregistration",
+        "Unregistrations",
+        "Xunit"
+    ]
 }

.vscode/tasks.json

@@ -145,7 +145,7 @@
         "build",
         "-c",
         "Debug",
-        "src/Features/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/Microsoft.CodeAnalysis.LanguageServer.csproj"
+        "src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/Microsoft.CodeAnalysis.LanguageServer.csproj"
       ],
       "problemMatcher": "$msCompile",
       "group": "build"

src/EditorFeatures/Core/LanguageServer/AlwaysActivateInProcLanguageClient.cs

@@ -70,8 +70,8 @@ public override ServerCapabilities GetCapabilities(ClientCapabilities clientCapa
 
         serverCapabilities.SupportsDiagnosticRequests = true;
 
-        serverCapabilities.DiagnosticOptions ??= new();
-        serverCapabilities.DiagnosticOptions.WorkspaceDiagnostics = true;
+        var diagnosticOptions = (serverCapabilities.DiagnosticOptions ??= new DiagnosticOptions());
+        diagnosticOptions.Unify().WorkspaceDiagnostics = true;
 
         serverCapabilities.DiagnosticProvider ??= new();
 

src/EditorFeatures/Core/LanguageServer/EditorLspSymbolInformationCreationService.cs

@@ -24,6 +24,7 @@ public EditorLspSymbolInformationCreationService()
     public SymbolInformation Create(string name, string? containerName, LSP.SymbolKind kind, LSP.Location location, Glyph glyph)
     {
         var imageId = glyph.GetImageId();
+#pragma warning disable CS0618 // SymbolInformation is obsolete, need to switch to DocumentSymbol/WorkspaceSymbol
         return new VSSymbolInformation
         {
             Name = name,
@@ -32,5 +33,6 @@ public SymbolInformation Create(string name, string? containerName, LSP.SymbolKi
             Location = location,
             Icon = new VSImageId { Guid = imageId.Guid, Id = imageId.Id },
         };
+#pragma warning restore CS0618
     }
 }

src/EditorFeatures/TestUtilities/LanguageServer/AbstractLanguageServerProtocolTests.cs

@@ -181,6 +181,7 @@ internal static LSP.SymbolInformation CreateSymbolInformation(LSP.SymbolKind kin
         {
             var imageId = glyph.GetImageId();
 
+#pragma warning disable CS0618 // SymbolInformation is obsolete, need to switch to DocumentSymbol/WorkspaceSymbol
             var info = new LSP.VSSymbolInformation()
             {
                 Kind = kind,
@@ -191,6 +192,7 @@ internal static LSP.SymbolInformation CreateSymbolInformation(LSP.SymbolKind kin
 
             if (containerName != null)
                 info.ContainerName = containerName;
+#pragma warning restore CS0618
 
             return info;
         }

src/Features/Lsif/Generator/ResultSetTracking/IResultSetTrackerExtensions.cs

@@ -4,6 +4,7 @@
 
 using Microsoft.CodeAnalysis.LanguageServerIndexFormat.Generator.Graph;
 using Roslyn.LanguageServer.Protocol;
+using Moniker = Microsoft.CodeAnalysis.LanguageServerIndexFormat.Generator.Graph.Moniker;
 
 namespace Microsoft.CodeAnalysis.LanguageServerIndexFormat.Generator.ResultSetTracking
 {

src/Features/Lsif/GeneratorTest/HoverTests.vb

@@ -36,7 +36,7 @@ class C
             Dim rangeVertex = Await lsif.GetSelectedRangeAsync()
             Dim resultSetVertex = lsif.GetLinkedVertices(Of Graph.ResultSet)(rangeVertex, "next").Single()
             Dim hoverVertex = lsif.GetLinkedVertices(Of Graph.HoverResult)(resultSetVertex, Methods.TextDocumentHoverName).SingleOrDefault()
-            Dim hoverMarkupContent = DirectCast(hoverVertex.Result.Contents.Value.Fourth, MarkupContent)
+            Dim hoverMarkupContent = DirectCast(hoverVertex.Result.Contents.Fourth, MarkupContent)
 
             Dim expectedHoverContents As String
             Select Case code
@@ -110,7 +110,7 @@ class C
             Dim rangeVertex = Await lsif.GetSelectedRangeAsync()
             Dim resultSetVertex = lsif.GetLinkedVertices(Of Graph.ResultSet)(rangeVertex, "next").Single()
             Dim hoverVertex = lsif.GetLinkedVertices(Of Graph.HoverResult)(resultSetVertex, Methods.TextDocumentHoverName).SingleOrDefault()
-            Dim hoverMarkupContent = DirectCast(hoverVertex.Result.Contents.Value.Fourth, MarkupContent)
+            Dim hoverMarkupContent = DirectCast(hoverVertex.Result.Contents.Fourth, MarkupContent)
 
             Dim expectedHoverContents As String
             Select Case code
@@ -196,7 +196,7 @@ void C.M()
                 End If
             Next
 
-            Dim hoverMarkupContent = DirectCast(hoverVertex.Result.Contents.Value.Fourth, MarkupContent)
+            Dim hoverMarkupContent = DirectCast(hoverVertex.Result.Contents.Fourth, MarkupContent)
             Assert.Equal(MarkupKind.Markdown, hoverMarkupContent.Kind)
             Assert.Equal("```csharp
 class System.String

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer.UnitTests/LspFileChangeWatcherTests.cs

@@ -20,7 +20,7 @@ public class LspFileChangeWatcherTests : AbstractLanguageServerHostTests
     {
         Workspace = new WorkspaceClientCapabilities
         {
-            DidChangeWatchedFiles = new DynamicRegistrationSetting { DynamicRegistration = true }
+            DidChangeWatchedFiles = new DidChangeWatchedFilesClientCapabilities { DynamicRegistration = true }
         }
     };
 
@@ -66,8 +66,8 @@ public async Task CreatingDirectoryWatchRequestsDirectoryWatch()
 
         var watcher = GetSingleFileWatcher(dynamicCapabilitiesRpcTarget);
 
-        Assert.Equal(tempDirectory.Path, watcher.GlobPattern.BaseUri.LocalPath);
-        Assert.Equal("**/*", watcher.GlobPattern.Pattern);
+        Assert.Equal(tempDirectory.Path, watcher.GlobPattern.Second.BaseUri.First.LocalPath);
+        Assert.Equal("**/*", watcher.GlobPattern.Second.Pattern);
 
         // Get rid of the registration and it should be gone again
         context.Dispose();
@@ -98,8 +98,8 @@ public async Task CreatingFileWatchRequestsFileWatch()
 
         var watcher = GetSingleFileWatcher(dynamicCapabilitiesRpcTarget);
 
-        Assert.Equal("Z:\\", watcher.GlobPattern.BaseUri.LocalPath);
-        Assert.Equal("SingleFile.txt", watcher.GlobPattern.Pattern);
+        Assert.Equal("Z:\\", watcher.GlobPattern.Second.BaseUri.First.LocalPath);
+        Assert.Equal("SingleFile.txt", watcher.GlobPattern.Second.Pattern);
 
         // Get rid of the registration and it should be gone again
         watchedFile.Dispose();
@@ -134,7 +134,7 @@ public Task RegisterCapabilityAsync(RegistrationParams registrationParams, Cance
         }
 
         [JsonRpcMethod("client/unregisterCapability", UseSingleObjectParameterDeserialization = true)]
-        public Task UnregisterCapabilityAsync(UnregistrationParamsWithMisspelling unregistrationParams, CancellationToken _)
+        public Task UnregisterCapabilityAsync(UnregistrationParams unregistrationParams, CancellationToken _)
         {
             foreach (var unregistration in unregistrationParams.Unregistrations)
                 Assert.True(Registrations.TryRemove(unregistration.Id, out var _));

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/FileWatching/LspFileChangeWatcher.cs

@@ -232,7 +232,7 @@ public void Dispose()
 
             _registrationTask.ContinueWith(async _ =>
             {
-                var unregistrationParams = new UnregistrationParamsWithMisspelling()
+                var unregistrationParams = new UnregistrationParams()
                 {
                     Unregistrations =
                     [

src/LanguageServer/Microsoft.CommonLanguageServerProtocol.Framework.UnitTests/ExampleTests.cs

@@ -53,7 +53,7 @@ public async Task InitializeServer_SerializesCorrectly()
         var server = TestExampleLanguageServer.CreateLanguageServer(logger);
 
         var result = await server.InitializeServerAsync();
-        Assert.True(result.Capabilities.SemanticTokensOptions!.Range!.Value.First);
+        Assert.True(result.Capabilities.SemanticTokensOptions!.Value.Unify().Range!.Value.First);
     }
 
     [Fact]

src/LanguageServer/Protocol/Extensions/ProtocolConversions.cs

@@ -453,7 +453,7 @@ public static LSP.Range TextSpanToRange(TextSpan textSpan, SourceText text)
                 }
             }
 
-            var documentEdits = uriToTextEdits.GroupBy(uriAndEdit => uriAndEdit.Uri, uriAndEdit => uriAndEdit.TextEdit, (uri, edits) => new LSP.TextDocumentEdit
+            var documentEdits = uriToTextEdits.GroupBy(uriAndEdit => uriAndEdit.Uri, uriAndEdit => new LSP.SumType<LSP.TextEdit, LSP.AnnotatedTextEdit>(uriAndEdit.TextEdit), (uri, edits) => new LSP.TextDocumentEdit
             {
                 TextDocument = new LSP.OptionalVersionedTextDocumentIdentifier { Uri = uri },
                 Edits = edits.ToArray(),

src/LanguageServer/Protocol/Handler/BufferedProgress.cs

@@ -5,6 +5,7 @@
 using System;
 using System.Linq;
 using Microsoft.CodeAnalysis.PooledObjects;
+using Roslyn.LanguageServer.Protocol;
 using Roslyn.Utilities;
 
 namespace Microsoft.CodeAnalysis.LanguageServer.Handler
@@ -69,6 +70,12 @@ internal static class BufferedProgress
         public static BufferedProgress<T> Create<T>(IProgress<T>? progress)
             => new BufferedProgress<T>(progress);
 
+        public static BufferedProgress<TIn> Create<TIn, TOut>(IProgress<TOut>? progress, Func<TIn, TOut> transform)
+            => Create(progress?.Transform(transform));
+
+        static IProgress<TIn> Transform<TIn, TOut>(this IProgress<TOut> progress, Func<TIn, TOut> transform)
+            => new ProgressTransformer<TIn, TOut>(progress, transform);
+
         public static void Report<T>(this BufferedProgress<T[]> progress, T item)
         {
             progress.Report([item]);
@@ -78,5 +85,10 @@ public static void Report<T>(this BufferedProgress<T[]> progress, T item)
         {
             return progress.GetValues()?.Flatten().ToArray();
         }
+
+        class ProgressTransformer<TIn, TOut>(IProgress<TOut> inner, Func<TIn, TOut> transform) : IProgress<TIn>
+        {
+            public void Report(TIn value) => inner.Report(transform(value));
+        }
     }
 }

src/LanguageServer/Protocol/Handler/CodeActions/CodeActionResolveHelper.cs

@@ -278,7 +278,7 @@ async Task AddTextDocumentEditsAsync<TTextDocument>(
                             textChanges = newText.GetTextChanges(oldText);
                         }
 
-                        var edits = textChanges.Select(tc => ProtocolConversions.TextChangeToTextEdit(tc, oldText)).ToArray();
+                        var edits = textChanges.Select(tc => new LSP.SumType<LSP.TextEdit, LSP.AnnotatedTextEdit>(ProtocolConversions.TextChangeToTextEdit(tc, oldText))).ToArray();
 
                         if (edits.Length > 0)
                         {

src/LanguageServer/Protocol/Handler/MapCode/MapCodeHandler.cs

@@ -42,12 +42,12 @@ public MapCodeHandler()
             throw new NotImplementedException("mapCode Request failed: additional workspace 'Update' is currently not supported");
         }
 
-        using var _ = PooledDictionary<Uri, TextEdit[]>.GetInstance(out var uriToEditsMap);
+        using var _ = PooledDictionary<Uri, LSP.TextEdit[]>.GetInstance(out var uriToEditsMap);
         foreach (var codeMapping in request.Mappings)
         {
             var mappingResult = await MapCodeAsync(codeMapping).ConfigureAwait(false);
 
-            if (mappingResult is not (Uri uri, TextEdit[] textEdits))
+            if (mappingResult is not (Uri uri, LSP.TextEdit[] textEdits))
             {
                 // Failed the entire request if any of the sub-requests failed
                 return null;
@@ -65,7 +65,7 @@ public MapCodeHandler()
                 DocumentChanges = uriToEditsMap.Select(kvp => new TextDocumentEdit
                 {
                     TextDocument = new OptionalVersionedTextDocumentIdentifier { Uri = kvp.Key },
-                    Edits = kvp.Value,
+                    Edits = kvp.Value.Select(v => new SumType<LSP.TextEdit, LSP.AnnotatedTextEdit>(v)).ToArray(),
                 }).ToArray()
             };
         }
@@ -77,7 +77,7 @@ public MapCodeHandler()
             };
         }
 
-        async Task<(Uri, TextEdit[])?> MapCodeAsync(LSP.VSInternalMapCodeMapping codeMapping)
+        async Task<(Uri, LSP.TextEdit[])?> MapCodeAsync(LSP.VSInternalMapCodeMapping codeMapping)
         {
             var textDocument = codeMapping.TextDocument
                 ?? throw new ArgumentException($"mapCode sub-request failed: MapCodeMapping.TextDocument not expected to be null.");

src/LanguageServer/Protocol/Handler/References/FindAllReferencesHandler.cs

@@ -22,7 +22,7 @@ namespace Microsoft.CodeAnalysis.LanguageServer.Handler
 {
     [ExportCSharpVisualBasicStatelessLspService(typeof(FindAllReferencesHandler)), Shared]
     [Method(LSP.Methods.TextDocumentReferencesName)]
-    internal sealed class FindAllReferencesHandler : ILspServiceDocumentRequestHandler<LSP.ReferenceParams, LSP.SumType<LSP.VSInternalReferenceItem, LSP.Location>[]?>
+    internal sealed class FindAllReferencesHandler : ILspServiceDocumentRequestHandler<VSInternalReferenceParams, LSP.SumType<VSInternalReferenceItem, LSP.Location>[]?>
     {
         private readonly IMetadataAsSourceFileService _metadataAsSourceFileService;
         private readonly IAsynchronousOperationListener _asyncListener;
@@ -43,10 +43,10 @@ public FindAllReferencesHandler(
         public bool MutatesSolutionState => false;
         public bool RequiresLSPSolution => true;
 
-        public TextDocumentIdentifier GetTextDocumentIdentifier(ReferenceParams request) => request.TextDocument;
+        public TextDocumentIdentifier GetTextDocumentIdentifier(VSInternalReferenceParams request) => request.TextDocument;
 
-        public async Task<LSP.SumType<LSP.VSInternalReferenceItem, LSP.Location>[]?> HandleRequestAsync(
-            ReferenceParams referenceParams,
+        public async Task<LSP.SumType<VSInternalReferenceItem, LSP.Location>[]?> HandleRequestAsync(
+            VSInternalReferenceParams referenceParams,
             RequestContext context,
             CancellationToken cancellationToken)
         {
@@ -55,7 +55,7 @@ public FindAllReferencesHandler(
             Contract.ThrowIfNull(document);
             Contract.ThrowIfNull(workspace);
 
-            using var progress = BufferedProgress.Create<SumType<VSInternalReferenceItem, LSP.Location>[]>(referenceParams.PartialResultToken);
+            using var progress = BufferedProgress.Create(referenceParams.PartialResultToken);
 
             var findUsagesService = document.GetRequiredLanguageService<IFindUsagesLSPService>();
             var position = await document.GetPositionFromLinePositionAsync(

src/LanguageServer/Protocol/Handler/Symbols/DocumentSymbolsHandler.cs

@@ -118,7 +118,9 @@ public async Task<object[]> HandleRequestAsync(RoslynDocumentSymbolParams reques
                 Detail = item.Text,
                 Kind = ProtocolConversions.GlyphToSymbolKind(item.Glyph),
                 Glyph = (int)item.Glyph,
+#pragma warning disable CS0618 // SymbolInformation.Deprecated is obsolete, use Tags
                 Deprecated = symbolItem.IsObsolete,
+#pragma warning restore CS0618
                 Range = ProtocolConversions.TextSpanToRange(spans.First(), text),
                 SelectionRange = ProtocolConversions.TextSpanToRange(navigationSpan, text),
                 Children = GetChildren(item.ChildItems, text, cancellationToken),

src/LanguageServer/Protocol/Handler/Symbols/ILspSymbolInformationCreationService.cs

@@ -28,11 +28,13 @@ public DefaultLspSymbolInformationCreationService()
 
         public SymbolInformation Create(string name, string? containerName, LSP.SymbolKind kind, LSP.Location location, Glyph glyph)
             => new()
+#pragma warning disable CS0618 // SymbolInformation is obsolete, need to switch to DocumentSymbol/WorkspaceSymbol
             {
                 Name = name,
                 ContainerName = containerName,
                 Kind = kind,
                 Location = location,
             };
+#pragma warning restore CS0618
     }
 }

src/LanguageServer/Protocol/Handler/Symbols/WorkspaceSymbolsHandler.cs

@@ -5,6 +5,7 @@
 using System;
 using System.Collections.Immutable;
 using System.Composition;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis.Host.Mef;
@@ -24,7 +25,7 @@ namespace Microsoft.CodeAnalysis.LanguageServer.Handler
     [method: ImportingConstructor]
     [method: Obsolete(MefConstruction.ImportingConstructorMessage, error: true)]
     internal sealed class WorkspaceSymbolsHandler(IAsynchronousOperationListenerProvider listenerProvider)
-        : ILspServiceRequestHandler<WorkspaceSymbolParams, SymbolInformation[]?>
+        : ILspServiceRequestHandler<WorkspaceSymbolParams, SumType<SymbolInformation[], WorkspaceSymbol[]>?>
     {
         private static readonly IImmutableSet<string> s_supportedKinds = [
             NavigateToItemKind.Class,
@@ -46,13 +47,16 @@ internal sealed class WorkspaceSymbolsHandler(IAsynchronousOperationListenerProv
         public bool MutatesSolutionState => false;
         public bool RequiresLSPSolution => true;
 
-        public async Task<SymbolInformation[]?> HandleRequestAsync(WorkspaceSymbolParams request, RequestContext context, CancellationToken cancellationToken)
+        public async Task<SumType<SymbolInformation[], WorkspaceSymbol[]>?> HandleRequestAsync(WorkspaceSymbolParams request, RequestContext context, CancellationToken cancellationToken)
         {
             Contract.ThrowIfNull(context.Solution);
 
             var solution = context.Solution;
 
-            using var progress = BufferedProgress.Create(request.PartialResultToken);
+            using var progress = BufferedProgress.Create(
+                request.PartialResultToken,
+                (SymbolInformation[] t) => new SumType<SymbolInformation[], WorkspaceSymbol[]>(t));
+
             var searcher = NavigateToSearcher.Create(
                 solution,
                 _asyncListener,
@@ -62,7 +66,7 @@ internal sealed class WorkspaceSymbolsHandler(IAsynchronousOperationListenerProv
                 cancellationToken);
 
             await searcher.SearchAsync(NavigateToSearchScope.Solution, cancellationToken).ConfigureAwait(false);
-            return progress.GetFlattenedValues();
+            return progress.GetValues()?.Flatten().ToArray();
         }
 
         private sealed class LSPNavigateToCallback(