Merge pull request #198 from graphql-dotnet/remove-default-serializer

rose-a · web-flow · commit 6e3879863a3e · 2020-03-23T11:27:54.000+01:00
Remove default serializer
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ Be careful when using `byte[]` in your variables object, as most JSON serializer
 ### Execute Query/Mutation:
 
 ```csharp
-var graphQLClient = new GraphQLHttpClient("https://swapi.apis.guru/");
+var graphQLClient = new GraphQLHttpClient("https://swapi.apis.guru/", new NewtonsoftJsonSerializer());
 
 public class PersonAndFilmsResponse {
     public PersonContent Person { get; set; }
diff --git a/examples/GraphQL.Client.Example/GraphQL.Client.Example.csproj b/examples/GraphQL.Client.Example/GraphQL.Client.Example.csproj
@@ -7,6 +7,7 @@
 	</PropertyGroup>
 
 	<ItemGroup>
+		<ProjectReference Include="..\..\src\GraphQL.Client.Serializer.Newtonsoft\GraphQL.Client.Serializer.Newtonsoft.csproj" />
 		<ProjectReference Include="..\..\src\GraphQL.Client\GraphQL.Client.csproj" />
 	</ItemGroup>
 
diff --git a/examples/GraphQL.Client.Example/Program.cs b/examples/GraphQL.Client.Example/Program.cs
@@ -3,6 +3,7 @@
 using System.Text.Json;
 using System.Threading.Tasks;
 using GraphQL.Client.Http;
+using GraphQL.Client.Serializer.Newtonsoft;
 
 namespace GraphQL.Client.Example
 {
@@ -13,7 +14,7 @@ public class Program
         public static async Task Main(string[] args)
         {
             _ = args;
-            using var graphQLClient = new GraphQLHttpClient("https://swapi.apis.guru/");
+            using var graphQLClient = new GraphQLHttpClient("https://swapi.apis.guru/", new NewtonsoftJsonSerializer());
 
             var personAndFilmsRequest = new GraphQLRequest
             {
diff --git a/src/GraphQL.Client.Serializer.Newtonsoft/MapConverter.cs b/src/GraphQL.Client.Serializer.Newtonsoft/MapConverter.cs
@@ -61,8 +61,6 @@ private IEnumerable<object> ReadArray(JToken element)
             }
         }
 
-        private object ReadNumber(JToken token) => ((JValue) token).Value;
-
         private bool IsUnsupportedJTokenType(JTokenType type) => type == JTokenType.Constructor || type == JTokenType.Property || type == JTokenType.Comment;
     }
 }
diff --git a/src/GraphQL.Client/GraphQL.Client.csproj b/src/GraphQL.Client/GraphQL.Client.csproj
@@ -36,7 +36,6 @@
 	<ItemGroup>
 	  <ProjectReference Include="..\GraphQL.Client.Abstractions.Websocket\GraphQL.Client.Abstractions.Websocket.csproj" />
 	  <ProjectReference Include="..\GraphQL.Client.Abstractions\GraphQL.Client.Abstractions.csproj" />
-	  <ProjectReference Include="..\GraphQL.Client.Serializer.Newtonsoft\GraphQL.Client.Serializer.Newtonsoft.csproj" />
 	</ItemGroup>
 
 	
diff --git a/src/GraphQL.Client/GraphQLHttpClient.cs b/src/GraphQL.Client/GraphQLHttpClient.cs
@@ -8,7 +8,6 @@
 using GraphQL.Client.Abstractions;
 using GraphQL.Client.Abstractions.Websocket;
 using GraphQL.Client.Http.Websocket;
-using GraphQL.Client.Serializer.Newtonsoft;
 
 namespace GraphQL.Client.Http
 {
@@ -19,7 +18,11 @@ public class GraphQLHttpClient : IGraphQLClient
         private readonly GraphQLHttpWebSocket _graphQlHttpWebSocket;
         private readonly CancellationTokenSource _cancellationTokenSource = new CancellationTokenSource();
         private readonly ConcurrentDictionary<Tuple<GraphQLRequest, Type>, object> _subscriptionStreams = new ConcurrentDictionary<Tuple<GraphQLRequest, Type>, object>();
-        private IGraphQLWebsocketJsonSerializer JsonSerializer => Options.JsonSerializer;
+
+        /// <summary>
+        /// the json serializer
+        /// </summary>
+        public IGraphQLWebsocketJsonSerializer JsonSerializer { get; }
 
         /// <summary>
         /// the instance of <see cref="HttpClient"/> which is used internally
@@ -44,20 +47,18 @@ public class GraphQLHttpClient : IGraphQLClient
 
         #region Constructors
 
-        public GraphQLHttpClient(string endPoint) : this(new Uri(endPoint)) { }
-
-        public GraphQLHttpClient(Uri endPoint) : this(o => o.EndPoint = endPoint) { }
-
-        public GraphQLHttpClient(Action<GraphQLHttpClientOptions> configure) : this(configure.New()) { }
+        public GraphQLHttpClient(string endPoint, IGraphQLWebsocketJsonSerializer serializer) : this(new Uri(endPoint), serializer) { }
 
-        public GraphQLHttpClient(GraphQLHttpClientOptions options) : this(options, new HttpClient(options.HttpMessageHandler)) { }
+        public GraphQLHttpClient(Uri endPoint, IGraphQLWebsocketJsonSerializer serializer) : this(o => o.EndPoint = endPoint, serializer) { }
 
-        public GraphQLHttpClient(GraphQLHttpClientOptions options, HttpClient httpClient) : this(options, httpClient, new NewtonsoftJsonSerializer()) { }
+        public GraphQLHttpClient(Action<GraphQLHttpClientOptions> configure, IGraphQLWebsocketJsonSerializer serializer) : this(configure.New(), serializer) { }
 
-        public GraphQLHttpClient(GraphQLHttpClientOptions options, HttpClient httpClient, IGraphQLWebsocketJsonSerializer serializer)
+        public GraphQLHttpClient(GraphQLHttpClientOptions options, IGraphQLWebsocketJsonSerializer serializer) : this(options, serializer, new HttpClient(options.HttpMessageHandler)) { }
+        
+        public GraphQLHttpClient(GraphQLHttpClientOptions options, IGraphQLWebsocketJsonSerializer serializer, HttpClient httpClient)
         {
             Options = options ?? throw new ArgumentNullException(nameof(options));
-            Options.JsonSerializer = serializer ?? throw new ArgumentNullException(nameof(serializer));
+            JsonSerializer = serializer ?? throw new ArgumentNullException(nameof(serializer));
             HttpClient = httpClient ?? throw new ArgumentNullException(nameof(httpClient));
             _graphQlHttpWebSocket = new GraphQLHttpWebSocket(GetWebSocketUri(), this);
         }
diff --git a/src/GraphQL.Client/GraphQLHttpClientOptions.cs b/src/GraphQL.Client/GraphQLHttpClientOptions.cs
@@ -2,7 +2,6 @@
 using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Threading.Tasks;
-using GraphQL.Client.Abstractions.Websocket;
 
 namespace GraphQL.Client.Http
 {
@@ -18,11 +17,6 @@ public class GraphQLHttpClientOptions
         /// </summary>
         public Uri EndPoint { get; set; }
 
-        /// <summary>
-        /// the json serializer
-        /// </summary>
-        public IGraphQLWebsocketJsonSerializer JsonSerializer { get; set; }
-
         /// <summary>
         /// The <see cref="System.Net.Http.HttpMessageHandler"/> that is going to be used
         /// </summary>
diff --git a/src/GraphQL.Client/HttpClientExtensions.cs b/src/GraphQL.Client/HttpClientExtensions.cs
diff --git a/src/GraphQL.Client/Websocket/GraphQLHttpWebSocket.cs b/src/GraphQL.Client/Websocket/GraphQLHttpWebSocket.cs
@@ -139,7 +139,7 @@ public IObservable<GraphQLResponse<TResponse>> CreateSubscriptionStream<TRespons
                                         // post the GraphQLResponse to the stream (even if a GraphQL error occurred)
                                         Debug.WriteLine($"received payload on subscription {startRequest.Id} (thread {Thread.CurrentThread.ManagedThreadId})");
                                         var typedResponse =
-                                            _client.Options.JsonSerializer.DeserializeToWebsocketResponse<TResponse>(
+                                            _client.JsonSerializer.DeserializeToWebsocketResponse<TResponse>(
                                                 response.MessageBytes);
                                         o.OnNext(typedResponse.Payload);
 
@@ -296,7 +296,7 @@ public Task<GraphQLResponse<TResponse>> SendRequest<TResponse>(GraphQLRequest re
                         {
                             Debug.WriteLine($"received response for request {websocketRequest.Id}");
                             var typedResponse =
-                                _client.Options.JsonSerializer.DeserializeToWebsocketResponse<TResponse>(
+                                _client.JsonSerializer.DeserializeToWebsocketResponse<TResponse>(
                                     response.MessageBytes);
                             return typedResponse.Payload;
                         });
@@ -353,7 +353,7 @@ private async Task SendWebSocketRequestAsync(GraphQLWebSocketRequest request)
                 }
 
                 await InitializeWebSocket();
-                var requestBytes = Options.JsonSerializer.SerializeToBytes(request);
+                var requestBytes = _client.JsonSerializer.SerializeToBytes(request);
                 await _clientWebSocket.SendAsync(
                     new ArraySegment<byte>(requestBytes),
                     WebSocketMessageType.Text,
@@ -554,7 +554,7 @@ private async Task<WebsocketMessageWrapper> ReceiveWebsocketMessagesAsync()
 
                 if (webSocketReceiveResult.MessageType == WebSocketMessageType.Text)
                 {
-                    var response = await Options.JsonSerializer.DeserializeToWebsocketResponseWrapperAsync(ms);
+                    var response = await _client.JsonSerializer.DeserializeToWebsocketResponseWrapperAsync(ms);
                     response.MessageBytes = ms.ToArray();
                     Debug.WriteLine($"{response.MessageBytes.Length} bytes received for id {response.Id} on websocket {_clientWebSocket.GetHashCode()} (thread {Thread.CurrentThread.ManagedThreadId})...");
                     return response;
diff --git a/tests/GraphQL.Integration.Tests/Extensions/WebApplicationFactoryExtensions.cs b/tests/GraphQL.Integration.Tests/Extensions/WebApplicationFactoryExtensions.cs
diff --git a/tests/GraphQL.Integration.Tests/GraphQL.Integration.Tests.csproj b/tests/GraphQL.Integration.Tests/GraphQL.Integration.Tests.csproj
@@ -28,4 +28,5 @@
     <ProjectReference Include="..\IntegrationTestServer\IntegrationTestServer.csproj" />
   </ItemGroup>
 
+
 </Project>
diff --git a/tests/GraphQL.Integration.Tests/Helpers/WebHostHelpers.cs b/tests/GraphQL.Integration.Tests/Helpers/WebHostHelpers.cs
@@ -41,9 +41,9 @@ public static GraphQLHttpClient GetGraphQLClient(int port, string endpoint, bool
             => new GraphQLHttpClient(new GraphQLHttpClientOptions
             {
                 EndPoint = new Uri($"http://localhost:{port}{endpoint}"),
-                UseWebSocketForQueriesAndMutations = requestsViaWebsocket,
-                JsonSerializer = serializer ?? new NewtonsoftJsonSerializer()
-            });
+                UseWebSocketForQueriesAndMutations = requestsViaWebsocket
+            },
+                serializer ?? new NewtonsoftJsonSerializer());
     }
 
     public class TestServerSetup : IDisposable
diff --git a/tests/GraphQL.Integration.Tests/QueryAndMutationTests/Base.cs b/tests/GraphQL.Integration.Tests/QueryAndMutationTests/Base.cs
@@ -73,7 +73,7 @@ public async void QueryAsHttpResponseTheory(int id, string name)
             httpResponse.ResponseHeaders.Date.Should().BeCloseTo(DateTimeOffset.Now, TimeSpan.FromMinutes(1));
         }
 
-        [Theory]
+        [Theory(Skip = "System.Json.Net deserializes 'dynamic' as JsonElement.")]
         [ClassData(typeof(StarWarsHumans))]
         public async void QueryWithDynamicReturnTypeTheory(int id, string name)
         {

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using System.Text.Json;`
`4`	`4`	`using System.Threading.Tasks;`
`5`	`5`	`using GraphQL.Client.Http;`
	`6`	`+using GraphQL.Client.Serializer.Newtonsoft;`
`6`	`7`
`7`	`8`	`namespace GraphQL.Client.Example`
`8`	`9`	`{`
`@@ -13,7 +14,7 @@ public class Program`
`13`	`14`	`public static async Task Main(string[] args)`
`14`	`15`	`{`
`15`	`16`	`_ = args;`
`16`		`- using var graphQLClient = new GraphQLHttpClient("https://swapi.apis.guru/");`
	`17`	`+ using var graphQLClient = new GraphQLHttpClient("https://swapi.apis.guru/", new NewtonsoftJsonSerializer());`
`17`	`18`
`18`	`19`	`var personAndFilmsRequest = new GraphQLRequest`
`19`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,8 +61,6 @@ private IEnumerable<object> ReadArray(JToken element)`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`64`		`- private object ReadNumber(JToken token) => ((JValue) token).Value;`
`65`		`-`
`66`	`64`	`private bool IsUnsupportedJTokenType(JTokenType type) => type == JTokenType.Constructor \|\| type == JTokenType.Property \|\| type == JTokenType.Comment;`
`67`	`65`	`}`
`68`	`66`	`}`