Added JsonConverter attributes where appropriate to allow for more ad… (#271)

david-driscoll · web-flow · commit a0f0bcb1aaa4 · 2020-08-02T01:15:13.000-04:00
* Added JsonConverter attributes where appropriate to allow for more adhoc serialziation in things like commands for example

* Updated converters
diff --git a/src/Protocol/DocumentUri.cs b/src/Protocol/DocumentUri.cs
@@ -1,7 +1,9 @@
 ﻿using System;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
+using Newtonsoft.Json;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol
 {
@@ -25,6 +27,7 @@ namespace OmniSharp.Extensions.LanguageServer.Protocol
     /// This class describes a document uri as defined by https://microsoft.github.io/language-server-protocol/specifications/specification-current/#uri
     /// </summary>
     /// <remarks>This exists because of some non-standard serialization in vscode around uris and .NET's behavior when deserializing those uris</remarks>
+    [JsonConverter(typeof(DocumentUriConverter))]
     public partial class DocumentUri : IEquatable<DocumentUri>
     {
         /// <summary>
diff --git a/src/Protocol/Models/BooleanNumberString.cs b/src/Protocol/Models/BooleanNumberString.cs
@@ -1,5 +1,9 @@
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
+
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(BooleanNumberStringConverter))]
     public struct BooleanNumberString
     {
         private long? _long;
diff --git a/src/Protocol/Models/BooleanString.cs b/src/Protocol/Models/BooleanString.cs
@@ -1,5 +1,9 @@
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
+
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(BooleanStringConverter))]
     public struct BooleanString
     {
         private string _string;
diff --git a/src/Protocol/Models/CommandOrCodeAction.cs b/src/Protocol/Models/CommandOrCodeAction.cs
@@ -1,7 +1,10 @@
 using System.Diagnostics;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(CommandOrCodeActionConverter))]
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     public struct CommandOrCodeAction
     {
diff --git a/src/Protocol/Models/CompletionList.cs b/src/Protocol/Models/CompletionList.cs
@@ -2,14 +2,17 @@
 using System.Collections.ObjectModel;
 using System.ComponentModel;
 using System.Linq;
+using Newtonsoft.Json;
 using OmniSharp.Extensions.LanguageServer.Protocol.Serialization;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
     /// <summary>
     /// Represents a collection of [completion items](#CompletionItem) to be presented
     /// in the editor.
     /// </summary>
+    [JsonConverter(typeof(CompletionListConverter))]
     public class CompletionList : Container<CompletionItem>
     {
         public CompletionList() : base(Enumerable.Empty<CompletionItem>()) { }
diff --git a/src/Protocol/Models/DiagnosticCode.cs b/src/Protocol/Models/DiagnosticCode.cs
@@ -1,5 +1,9 @@
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
+
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(DiagnosticCodeConverter))]
     public struct DiagnosticCode
     {
         public DiagnosticCode(long value)
diff --git a/src/Protocol/Models/LocationOrLocationLink.cs b/src/Protocol/Models/LocationOrLocationLink.cs
@@ -1,5 +1,9 @@
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
+
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(LocationOrLocationLinkConverter))]
     public struct LocationOrLocationLink {
 
         public LocationOrLocationLink(Location location)
diff --git a/src/Protocol/Models/LocationOrLocationLinks.cs b/src/Protocol/Models/LocationOrLocationLinks.cs
@@ -1,9 +1,12 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Linq;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(LocationOrLocationLinksConverter))]
     public class LocationOrLocationLinks : Container<LocationOrLocationLink>
     {
         public LocationOrLocationLinks() : this(Enumerable.Empty<LocationOrLocationLink>())
diff --git a/src/Protocol/Models/MarkedString.cs b/src/Protocol/Models/MarkedString.cs
@@ -1,5 +1,7 @@
 using System.Diagnostics;
+using Newtonsoft.Json;
 using OmniSharp.Extensions.LanguageServer.Protocol.Serialization;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
@@ -16,6 +18,7 @@ namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
     ///
     /// Note that markdown strings will be sanitized - that means html will be escaped.
     /// </summary>
+    [JsonConverter(typeof(MarkedStringConverter))]
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     public class MarkedString
     {
diff --git a/src/Protocol/Models/MarkedStringsOrMarkupContent.cs b/src/Protocol/Models/MarkedStringsOrMarkupContent.cs
@@ -1,9 +1,12 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(MarkedStringsOrMarkupContentConverter))]
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     public class MarkedStringsOrMarkupContent
     {
diff --git a/src/Protocol/Models/ParameterInformationLabel.cs b/src/Protocol/Models/ParameterInformationLabel.cs
@@ -1,7 +1,10 @@
 using System.Diagnostics;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(ParameterInformationLabelConverter))]
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     public class ParameterInformationLabel
     {
diff --git a/src/Protocol/Models/ProgressToken.cs b/src/Protocol/Models/ProgressToken.cs
@@ -2,9 +2,11 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(ProgressTokenConverter))]
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     public class ProgressToken : IEquatable<ProgressToken>, IEquatable<long>, IEquatable<string>
     {
diff --git a/src/Protocol/Models/Proposals/SemanticTokensFullOrDelta.cs b/src/Protocol/Models/Proposals/SemanticTokensFullOrDelta.cs
@@ -1,8 +1,11 @@
 ﻿using System;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models.Proposals
 {
     [Obsolete(Constants.Proposal)]
+    [JsonConverter(typeof(SemanticTokensFullOrDeltaConverter))]
     public struct SemanticTokensFullOrDelta
     {
         public SemanticTokensFullOrDelta(SemanticTokensDelta delta)
diff --git a/src/Protocol/Models/Proposals/SemanticTokensFullOrDeltaPartialResult.cs b/src/Protocol/Models/Proposals/SemanticTokensFullOrDeltaPartialResult.cs
@@ -1,8 +1,11 @@
 ﻿using System;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models.Proposals
 {
     [Obsolete(Constants.Proposal)]
+    [JsonConverter(typeof(SemanticTokensFullOrDeltaPartialResultConverter))]
     public struct SemanticTokensFullOrDeltaPartialResult
     {
         public SemanticTokensFullOrDeltaPartialResult(
diff --git a/src/Protocol/Models/RangeOrPlaceholderRange.cs b/src/Protocol/Models/RangeOrPlaceholderRange.cs
@@ -1,5 +1,9 @@
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
+
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(RangeOrPlaceholderRangeConverter))]
     public class RangeOrPlaceholderRange
     {
 
diff --git a/src/Protocol/Models/StringOrMarkupContent.cs b/src/Protocol/Models/StringOrMarkupContent.cs
@@ -1,7 +1,10 @@
 using System.Diagnostics;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(StringOrMarkupContentConverter))]
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     public class StringOrMarkupContent
     {
diff --git a/src/Protocol/Models/SymbolInformationOrDocumentSymbol.cs b/src/Protocol/Models/SymbolInformationOrDocumentSymbol.cs
@@ -1,7 +1,10 @@
 using System.Diagnostics;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
 
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(SymbolInformationOrDocumentSymbolConverter))]
     [DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]
     public struct SymbolInformationOrDocumentSymbol
     {
diff --git a/src/Protocol/Models/WorkspaceEditDocumentChange.cs b/src/Protocol/Models/WorkspaceEditDocumentChange.cs
@@ -1,5 +1,9 @@
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
+
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Models
 {
+    [JsonConverter(typeof(WorkspaceEditDocumentChangeConverter))]
     public struct WorkspaceEditDocumentChange
     {
         public WorkspaceEditDocumentChange(TextDocumentEdit textDocumentEdit)
diff --git a/src/Protocol/Serialization/Converters/DiagnosticCodeConverter.cs b/src/Protocol/Serialization/Converters/DiagnosticCodeConverter.cs
@@ -30,38 +30,4 @@ public override DiagnosticCode ReadJson(JsonReader reader, Type objectType, Diag
 
         public override bool CanRead => true;
     }
-
-    class NullableDiagnosticCodeConverter : JsonConverter<DiagnosticCode?>
-    {
-        public override void WriteJson(JsonWriter writer, DiagnosticCode? value, JsonSerializer serializer)
-        {
-            if (!value.HasValue)
-            {
-                writer.WriteNull();
-            }
-            else
-            {
-                if (value.Value.IsLong) serializer.Serialize(writer, value.Value.Long);
-                if (value.Value.IsString) serializer.Serialize(writer, value.Value.String);
-            }
-        }
-
-        public override DiagnosticCode? ReadJson(JsonReader reader, Type objectType, DiagnosticCode? existingValue,
-            bool hasExistingValue, JsonSerializer serializer)
-        {
-            if (reader.TokenType == JsonToken.String)
-            {
-                return new DiagnosticCode((string) reader.Value);
-            }
-
-            if (reader.TokenType == JsonToken.Integer)
-            {
-                return new DiagnosticCode((long) reader.Value);
-            }
-
-            return null;
-        }
-
-        public override bool CanRead => true;
-    }
 }
diff --git a/src/Protocol/Serialization/Converters/EnumLikeStringConverter.cs b/src/Protocol/Serialization/Converters/EnumLikeStringConverter.cs
diff --git a/src/Protocol/Serialization/Converters/NullableDiagnosticCodeConverter.cs b/src/Protocol/Serialization/Converters/NullableDiagnosticCodeConverter.cs
@@ -0,0 +1,40 @@
+﻿using System;
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
+
+namespace OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters
+{
+    class NullableDiagnosticCodeConverter : JsonConverter<DiagnosticCode?>
+    {
+        public override void WriteJson(JsonWriter writer, DiagnosticCode? value, JsonSerializer serializer)
+        {
+            if (!value.HasValue)
+            {
+                writer.WriteNull();
+            }
+            else
+            {
+                if (value.Value.IsLong) serializer.Serialize(writer, value.Value.Long);
+                if (value.Value.IsString) serializer.Serialize(writer, value.Value.String);
+            }
+        }
+
+        public override DiagnosticCode? ReadJson(JsonReader reader, Type objectType, DiagnosticCode? existingValue,
+            bool hasExistingValue, JsonSerializer serializer)
+        {
+            if (reader.TokenType == JsonToken.String)
+            {
+                return new DiagnosticCode((string) reader.Value);
+            }
+
+            if (reader.TokenType == JsonToken.Integer)
+            {
+                return new DiagnosticCode((long) reader.Value);
+            }
+
+            return null;
+        }
+
+        public override bool CanRead => true;
+    }
+}
diff --git a/src/Protocol/Serialization/Converters/ValueTupleContractResolver.cs b/src/Protocol/Serialization/Converters/ValueTupleContractResolver.cs
@@ -0,0 +1,20 @@
+﻿using System;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters
+{
+    class ValueTupleContractResolver<T1, T2> : JsonConverter<(T1, T2)>
+    {
+        public override void WriteJson(JsonWriter writer, (T1, T2) value, JsonSerializer serializer)
+        {
+            serializer.Serialize(writer, new object[] { value.Item1, value.Item2 });
+        }
+
+        public override (T1, T2) ReadJson(JsonReader reader, Type objectType, (T1, T2) existingValue, bool hasExistingValue, JsonSerializer serializer)
+        {
+            var a = JArray.Load(reader);
+            return (a.ToObject<T1>(), a.ToObject<T2>());
+        }
+    }
+}
diff --git a/src/Protocol/Serialization/Converters/WorkspaceEditDocumentChangeConverter.cs b/src/Protocol/Serialization/Converters/WorkspaceEditDocumentChangeConverter.cs
@@ -41,18 +41,4 @@ public override WorkspaceEditDocumentChange ReadJson(JsonReader reader, Type obj
 
         public override bool CanRead => true;
     }
-
-    class ValueTupleContractResolver<T1, T2> : JsonConverter<ValueTuple<T1, T2>>
-    {
-        public override void WriteJson(JsonWriter writer, (T1, T2) value, JsonSerializer serializer)
-        {
-            serializer.Serialize(writer, new object[] { value.Item1, value.Item2 });
-        }
-
-        public override (T1, T2) ReadJson(JsonReader reader, Type objectType, (T1, T2) existingValue, bool hasExistingValue, JsonSerializer serializer)
-        {
-            var a = JArray.Load(reader);
-            return (a.ToObject<T1>(), a.ToObject<T2>());
-        }
-    }
 }
diff --git a/src/Protocol/Server/Capabilities/TextDocumentSync.cs b/src/Protocol/Server/Capabilities/TextDocumentSync.cs
@@ -1,5 +1,9 @@
+using Newtonsoft.Json;
+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;
+
 namespace OmniSharp.Extensions.LanguageServer.Protocol.Server.Capabilities
 {
+    [JsonConverter(typeof(TextDocumentSyncConverter))]
     public class TextDocumentSync
     {
         public TextDocumentSync(TextDocumentSyncKind kind)

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
	`1`	`+using Newtonsoft.Json;`
	`2`	`+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;`
	`3`	`+`
`1`	`4`	`namespace OmniSharp.Extensions.LanguageServer.Protocol.Models`
`2`	`5`	`{`
	`6`	`+ [JsonConverter(typeof(BooleanNumberStringConverter))]`
`3`	`7`	`public struct BooleanNumberString`
`4`	`8`	`{`
`5`	`9`	`private long? _long;`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,10 @@`
`1`	`1`	`using System.Diagnostics;`
	`2`	`+using Newtonsoft.Json;`
	`3`	`+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;`
`2`	`4`
`3`	`5`	`namespace OmniSharp.Extensions.LanguageServer.Protocol.Models`
`4`	`6`	`{`
	`7`	`+ [JsonConverter(typeof(CommandOrCodeActionConverter))]`
`5`	`8`	`[DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]`
`6`	`9`	`public struct CommandOrCodeAction`
`7`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,12 @@`
`1`	`1`	`using System.Collections.Generic;`
`2`	`2`	`using System.Collections.ObjectModel;`
`3`	`3`	`using System.Linq;`
	`4`	`+using Newtonsoft.Json;`
	`5`	`+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;`
`4`	`6`
`5`	`7`	`namespace OmniSharp.Extensions.LanguageServer.Protocol.Models`
`6`	`8`	`{`
	`9`	`+ [JsonConverter(typeof(LocationOrLocationLinksConverter))]`
`7`	`10`	`public class LocationOrLocationLinks : Container<LocationOrLocationLink>`
`8`	`11`	`{`
`9`	`12`	`public LocationOrLocationLinks() : this(Enumerable.Empty<LocationOrLocationLink>())`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`using System.Diagnostics;`
	`2`	`+using Newtonsoft.Json;`
`2`	`3`	`using OmniSharp.Extensions.LanguageServer.Protocol.Serialization;`
	`4`	`+using OmniSharp.Extensions.LanguageServer.Protocol.Serialization.Converters;`
`3`	`5`
`4`	`6`	`namespace OmniSharp.Extensions.LanguageServer.Protocol.Models`
`5`	`7`	`{`
`@@ -16,6 +18,7 @@ namespace OmniSharp.Extensions.LanguageServer.Protocol.Models`
`16`	`18`	`///`
`17`	`19`	`/// Note that markdown strings will be sanitized - that means html will be escaped.`
`18`	`20`	`/// </summary>`
	`21`	`+ [JsonConverter(typeof(MarkedStringConverter))]`
`19`	`22`	`[DebuggerDisplay("{" + nameof(DebuggerDisplay) + ",nq}")]`
`20`	`23`	`public class MarkedString`
`21`	`24`	`{`