Do not seralize unsupported items for textdocumentclientcapabilites and workspaceclientcapabilites

Author: david-driscoll

src/Lsp/Capabilities/Client/Supports.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using Newtonsoft.Json;
 using OmniSharp.Extensions.LanguageServer.Converters;
 
@@ -38,8 +38,9 @@ public static implicit operator Supports<T>(T value)
     public static class Supports
     {
         public static Supports<T> OfValue<T>(T value)
+            where T : class
         {
-            return new Supports<T>(true, value);
+            return new Supports<T>(value != null, value);
         }
 
         public static Supports<T> OfBoolean<T>(bool isSupported)

src/Lsp/Capabilities/Client/TextDocumentClientCapabilities.cs

@@ -1,3 +1,4 @@
+using System.ComponentModel;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 
@@ -8,74 +9,119 @@ public class TextDocumentClientCapabilities
     {
         public Supports<SynchronizationCapability> Synchronization { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeSynchronization() => Synchronization.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/completion`
         /// </summary>
         public Supports<CompletionCapability> Completion { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeCompletion() => Completion.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/hover`
         /// </summary>
         public Supports<HoverCapability> Hover { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeHover() => Hover.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/signatureHelp`
         /// </summary>
         public Supports<SignatureHelpCapability> SignatureHelp { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeSignatureHelp() => SignatureHelp.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/references`
         /// </summary>
         public Supports<ReferencesCapability> References { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeReferences() => References.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/documentHighlight`
         /// </summary>
         public Supports<DocumentHighlightCapability> DocumentHighlight { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeDocumentHighlight() => DocumentHighlight.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/documentSymbol`
         /// </summary>
         public Supports<DocumentSymbolCapability> DocumentSymbol { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeDocumentSymbol() => DocumentSymbol.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/formatting`
         /// </summary>
         public Supports<DocumentFormattingCapability> Formatting { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeFormatting() => Formatting.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/rangeFormatting`
         /// </summary>
         public Supports<DocumentRangeFormattingCapability> RangeFormatting { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeRangeFormatting() => RangeFormatting.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/onTypeFormatting`
         /// </summary>
         public Supports<DocumentOnTypeFormattingCapability> OnTypeFormatting { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeOnTypeFormatting() => OnTypeFormatting.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/definition`
         /// </summary>
         public Supports<DefinitionCapability> Definition { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeDefinition() => Definition.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/codeAction`
         /// </summary>
         public Supports<CodeActionCapability> CodeAction { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeCodeAction() => CodeAction.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/codeLens`
         /// </summary>
         public Supports<CodeLensCapability> CodeLens { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeCodeLens() => CodeLens.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/documentLink`
         /// </summary>
         public Supports<DocumentLinkCapability> DocumentLink { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeDocumentLink() => DocumentLink.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `textDocument/rename`
         /// </summary>
         public Supports<RenameCapability> Rename { get; set; }
+
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeRename() => Rename.IsSupported;
     }
 }

src/Lsp/Capabilities/Client/WorkspaceClientCapabilites.cs

@@ -1,3 +1,4 @@
+using System.ComponentModel;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 
@@ -10,30 +11,46 @@ public class WorkspaceClientCapabilites
         /// The client supports applying batch edits
         /// to the workspace.
         /// </summary>
-        public bool ApplyEdit { get; set; }
+        public Supports<bool> ApplyEdit { get; set; }
+
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeApplyEdit() => ApplyEdit.IsSupported;
 
         public Supports<WorkspaceEditCapability> WorkspaceEdit { get; set; }
 
-        private bool ShouldSerializeWorkspaceEdit() => WorkspaceEdit.IsSupported;
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeWorkspaceEdit() => WorkspaceEdit.IsSupported;
 
         /// <summary>
         /// Capabilities specific to the `workspace/didChangeConfiguration` notification.
         /// </summary>
         public Supports<DidChangeConfigurationCapability> DidChangeConfiguration { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeDidChangeConfiguration() => DidChangeConfiguration.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
         /// </summary>
         public Supports<DidChangeWatchedFilesCapability> DidChangeWatchedFiles { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeDidChangeWatchedFiles() => DidChangeWatchedFiles.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `workspace/symbol` request.
         /// </summary>
         public Supports<WorkspaceSymbolCapability> Symbol { get; set; }
 
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeSymbol() => Symbol.IsSupported;
+
         /// <summary>
         /// Capabilities specific to the `workspace/executeCommand` request.
         /// </summary>
         public Supports<ExecuteCommandCapability> ExecuteCommand { get; set; }
+
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public bool ShouldSerializeExecuteCommand() => ExecuteCommand.IsSupported;
     }
 }

src/Lsp/Converters/SupportsConverter.cs

@@ -44,6 +44,10 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             var targetType = objectType.GetTypeInfo().GetGenericArguments()[0];
             if (reader.TokenType == JsonToken.Boolean)
             {
+                if (targetType == typeof(bool))
+                {
+                    return new Supports<bool>(true, (bool)reader.Value);
+                }
                 return OfBooleanMethod
                     .MakeGenericMethod(targetType)
                     .Invoke(null, new [] { reader.Value });

test/Lsp.Tests/Capabilities/Client/TextDocumentClientCapabilitiesTests.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using FluentAssertions;
 using Newtonsoft.Json;
 using OmniSharp.Extensions.LanguageServer.Capabilities.Client;
@@ -45,5 +45,17 @@ public void SimpleTest(string expected)
             var deresult = JsonConvert.DeserializeObject<TextDocumentClientCapabilities>(expected);
             deresult.ShouldBeEquivalentTo(model);
         }
+
+        [Theory, JsonFixture]
+        public void EmptyTest(string expected)
+        {
+            var model = new TextDocumentClientCapabilities();
+            var result = Fixture.SerializeObject(model);
+
+            result.Should().Be(expected);
+
+            var deresult = JsonConvert.DeserializeObject<TextDocumentClientCapabilities>(expected);
+            deresult.ShouldBeEquivalentTo(model);
+        }
     }
 }

test/Lsp.Tests/Capabilities/Client/TextDocumentClientCapabilitiesTests_$EmptyTest.json

@@ -0,0 +1 @@
+{}

test/Lsp.Tests/Capabilities/Client/WorkspaceClientCapabilitesTests.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using FluentAssertions;
 using Newtonsoft.Json;
 using OmniSharp.Extensions.LanguageServer.Capabilities.Client;
@@ -13,7 +13,7 @@ public void SimpleTest(string expected)
         {
             var model = new WorkspaceClientCapabilites() {
                 ApplyEdit = true,
-                WorkspaceEdit = new WorkspaceEditCapability() { DocumentChanges = true},
+                WorkspaceEdit = new WorkspaceEditCapability() { DocumentChanges = true },
                 DidChangeConfiguration = new DidChangeConfigurationCapability() { DynamicRegistration = true },
                 DidChangeWatchedFiles = new DidChangeWatchedFilesCapability() { DynamicRegistration = true },
                 ExecuteCommand = new ExecuteCommandCapability() { DynamicRegistration = true },
@@ -27,5 +27,18 @@ public void SimpleTest(string expected)
             var deresult = JsonConvert.DeserializeObject<WorkspaceClientCapabilites>(expected);
             deresult.ShouldBeEquivalentTo(model);
         }
+
+        [Theory, JsonFixture]
+        public void EmptyTest(string expected)
+        {
+            var model = new WorkspaceClientCapabilites();
+
+            var result = Fixture.SerializeObject(model);
+
+            result.Should().Be(expected);
+
+            var deresult = JsonConvert.DeserializeObject<WorkspaceClientCapabilites>(expected);
+            deresult.ShouldBeEquivalentTo(model);
+        }
     }
 }

test/Lsp.Tests/Capabilities/Client/WorkspaceClientCapabilitesTests_$EmptyTest.json

@@ -0,0 +1 @@
+{}

test/Lsp.Tests/Models/InitializeParamsTests_$SimpleTest.json

@@ -6,7 +6,6 @@
     "capabilities": {
         "workspace": {
             "applyEdit": true,
-            "workspaceEdit": null,
             "didChangeConfiguration": {
                 "dynamicRegistration": true
             },