allow access to HttpResponseHeaders

Author: rose-a

src/GraphQL.Client/GraphQLHttpClient.cs

@@ -2,6 +2,7 @@
 using System.Collections.Concurrent;
 using System.Diagnostics;
 using System.Net.Http;
+using System.Net.Http.Headers;
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
@@ -64,10 +65,12 @@ public GraphQLHttpClient(GraphQLHttpClientOptions options, HttpClient httpClient
 		#region IGraphQLClient
 
 		/// <inheritdoc />
-		public Task<GraphQLResponse<TResponse>> SendQueryAsync<TResponse>(GraphQLRequest request, CancellationToken cancellationToken = default) {
-			return Options.UseWebSocketForQueriesAndMutations
-				? this.graphQlHttpWebSocket.SendRequest<TResponse>(request, cancellationToken)
-				: this.SendHttpPostRequestAsync<TResponse>(request, cancellationToken);
+		public async Task<GraphQLResponse<TResponse>> SendQueryAsync<TResponse>(GraphQLRequest request, CancellationToken cancellationToken = default) {
+			if(Options.UseWebSocketForQueriesAndMutations)
+				return await this.graphQlHttpWebSocket.SendRequest<TResponse>(request, cancellationToken);
+			
+			var response = await this.SendHttpPostRequestAsync<TResponse>(request, cancellationToken);
+			return response.Response;
 		}
 
 		/// <inheritdoc />
@@ -114,18 +117,64 @@ public IObservable<GraphQLResponse<TResponse>> CreateSubscriptionStream<TRespons
 		/// <returns></returns>
 		public Task InitializeWebsocketConnection() => graphQlHttpWebSocket.InitializeWebSocket();
 
+		/// <summary>
+		/// Sends a query to the GraphQL server and deserializes the response. Provides access to the HTTP response headers. This method will never utilize the websocket connection!
+		/// </summary>
+		/// <typeparam name="TResponse"></typeparam>
+		/// <param name="request"></param>
+		/// <param name="cancellationToken"></param>
+		/// <returns></returns>
+		public Task<GraphQLHttpResponse<TResponse>> SendQueryHttpAsync<TResponse>(GraphQLRequest request, CancellationToken cancellationToken = default) {
+			return this.SendHttpPostRequestAsync<TResponse>(request, cancellationToken);
+		}
+		/// <inheritdoc cref="SendQueryHttpAsync{TResponse}(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
+		public Task<GraphQLHttpResponse<TResponse>> SendQueryHttpAsync<TResponse>(GraphQLRequest request,
+			Func<TResponse> defineResponseType, CancellationToken cancellationToken = default)
+			=> SendQueryHttpAsync<TResponse>(request, cancellationToken);
+		/// <inheritdoc cref="SendQueryHttpAsync{TResponse}(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
+		public Task<GraphQLHttpResponse<TResponse>> SendQueryHttpAsync<TResponse>(string query, object? variables = null,
+			string? operationName = null, Func<TResponse> defineResponseType = null, CancellationToken cancellationToken = default) {
+			return SendQueryHttpAsync<TResponse>(new GraphQLRequest(query, variables, operationName), cancellationToken: cancellationToken);
+		}
+
+		/// <summary>
+		/// Sends a mutation to the GraphQL server and deserializes the response. Provides access to the HTTP response headers. This method will never utilize the websocket connection!
+		/// </summary>
+		/// <typeparam name="TResponse"></typeparam>
+		/// <param name="request"></param>
+		/// <param name="cancellationToken"></param>
+		/// <returns></returns>
+		public Task<GraphQLHttpResponse<TResponse>> SendMutationHttpAsync<TResponse>(GraphQLRequest request,
+			CancellationToken cancellationToken = default)
+			=> SendQueryHttpAsync<TResponse>(request, cancellationToken);
+		/// <inheritdoc cref="SendMutationHttpAsync{TResponse}(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
+		public Task<GraphQLHttpResponse<TResponse>> SendMutationHttpAsync<TResponse>(GraphQLRequest request,
+			Func<TResponse> defineResponseType, CancellationToken cancellationToken = default)
+			=> SendQueryHttpAsync<TResponse>(request, cancellationToken);
+		/// <inheritdoc cref="SendMutationHttpAsync{TResponse}(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
+		public Task<GraphQLHttpResponse<TResponse>> SendMutationHttpAsync<TResponse>(string query, object? variables = null,
+			string? operationName = null, Func<TResponse> defineResponseType = null, CancellationToken cancellationToken = default) {
+			return SendQueryHttpAsync<TResponse>(new GraphQLRequest(query, variables, operationName), cancellationToken: cancellationToken);
+		}
+
 		#region Private Methods
 
-		private async Task<GraphQLResponse<TResponse>> SendHttpPostRequestAsync<TResponse>(GraphQLRequest request, CancellationToken cancellationToken = default) {
+		private async Task<GraphQLHttpResponse<TResponse>> SendHttpPostRequestAsync<TResponse>(GraphQLRequest request, CancellationToken cancellationToken = default) {
 			var preprocessedRequest = await Options.PreprocessRequest(request, this);
 			using var httpRequestMessage = this.GenerateHttpRequestMessage(preprocessedRequest);
 			using var httpResponseMessage = await this.HttpClient.SendAsync(httpRequestMessage, cancellationToken);
 			if (!httpResponseMessage.IsSuccessStatusCode) {
 				throw new GraphQLHttpException(httpResponseMessage);
 			}
+			
+			var response = new GraphQLHttpResponse<TResponse> {
+				ResponseHeaders = httpResponseMessage.Headers,
+				StatusCode = httpResponseMessage.StatusCode
+			};
 
 			var bodyStream = await httpResponseMessage.Content.ReadAsStreamAsync();
-			return await JsonSerializer.DeserializeFromUtf8StreamAsync<TResponse>(bodyStream, cancellationToken);
+			response.Response = await JsonSerializer.DeserializeFromUtf8StreamAsync<TResponse>(bodyStream, cancellationToken);
+			return response;
 		}
 
 		private HttpRequestMessage GenerateHttpRequestMessage(GraphQLRequest request) {

src/GraphQL.Client/GraphQLHttpResponse.cs

@@ -1,5 +1,15 @@
+using System.Net;
+using System.Net.Http.Headers;
+
 namespace GraphQL.Client.Http {
 
-	public class GraphQLHttpResponse<T> : GraphQLResponse<T> {
+	public class GraphQLHttpResponse<T> {
+		public GraphQLHttpResponse()
+		{
+		}
+		
+		public GraphQLResponse<T> Response { get; set; }
+		public HttpResponseHeaders ResponseHeaders { get; set; }
+		public HttpStatusCode StatusCode { get; set; }
 	}
 }

tests/GraphQL.Integration.Tests/QueryAndMutationTests/Base.cs

@@ -1,3 +1,5 @@
+using System;
+using System.Net;
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
@@ -46,6 +48,19 @@ public async void QueryTheory(int id, string name) {
 			Assert.Equal(name, response.Data.Human.Name);
 		}
 
+		[Theory]
+		[ClassData(typeof(StarWarsHumans))]
+		public async void QueryHttpTheory(int id, string name) {
+			var graphQLRequest = new GraphQLRequest($"{{ human(id: \"{id}\") {{ name }} }}");
+			var httpResponse = await StarWarsClient.SendQueryHttpAsync(graphQLRequest, () => new { Human = new { Name = string.Empty } });
+
+			httpResponse.Response.Errors.Should().BeNull();
+			httpResponse.Response.Data.Human.Name.Should().Be(name);
+
+			httpResponse.StatusCode.Should().BeEquivalentTo(HttpStatusCode.OK);
+			httpResponse.ResponseHeaders.Date.Should().BeCloseTo(DateTimeOffset.Now, TimeSpan.FromMinutes(1));
+		}
+
 		[Theory]
 		[ClassData(typeof(StarWarsHumans))]
 		public async void QueryWithDynamicReturnTypeTheory(int id, string name) {