Merge pull request #53 from joadan/copilot/get-http-response-message-options

Add builder-level tests for `ExecuteResponseAsync` response metadata

Author: joadan

src/Linq2OData.Core/Builders/CreateBuilder.cs

@@ -1,4 +1,6 @@
-namespace Linq2OData.Core.Builders;
+using Linq2OData.Core.ODataResponse;
+
+namespace Linq2OData.Core.Builders;
 
 
 
@@ -21,6 +23,15 @@ public async Task<T> ExecuteAsync(ODataInputBase input)
       return  await odataClient.CreateEntityAsync<T>(entityPath,  input);
     }
 
+    /// <summary>
+    /// Executes the create request and returns the full <see cref="ODataResponse{T}"/> including
+    /// HTTP status code and response headers.
+    /// </summary>
+    public async Task<ODataResponse<T>> ExecuteResponseAsync(ODataInputBase input)
+    {
+        return await odataClient.CreateEntityWithResponseAsync<T>(entityPath, input);
+    }
+
 
 
 

src/Linq2OData.Core/Builders/DeleteBuilder.cs

@@ -1,4 +1,6 @@
-namespace Linq2OData.Core.Builders;
+using Linq2OData.Core.ODataResponse;
+
+namespace Linq2OData.Core.Builders;
 
 
 
@@ -23,6 +25,15 @@ public async Task<bool> ExecuteAsync()
       return  await odataClient.DeleteEntityAsync(entityPath, keyExpression);
     }
 
+    /// <summary>
+    /// Executes the delete request and returns the full <see cref="ODataResponse{T}"/> including
+    /// HTTP status code and response headers.
+    /// </summary>
+    public async Task<ODataResponse<bool>> ExecuteResponseAsync()
+    {
+        return await odataClient.DeleteEntityWithResponseAsync(entityPath, keyExpression);
+    }
+
 
 
 

src/Linq2OData.Core/Builders/GetBuilder.cs

@@ -1,7 +1,6 @@
 using Linq2OData.Core.Expressions;
+using Linq2OData.Core.ODataResponse;
 using System.Linq.Expressions;
-using System.Reflection.PortableExecutable;
-using static System.Net.WebRequestMethods;
 
 namespace Linq2OData.Core.Builders;
 
@@ -39,6 +38,15 @@ public GetBuilder(ODataClient odataClient, Action<T> keySetter)
         return result.Data;
     }
 
+    /// <summary>
+    /// Executes the request and returns the full <see cref="ODataResponse{T}"/> including
+    /// HTTP status code and response headers.
+    /// </summary>
+    public async Task<ODataResponse<T>?> ExecuteResponseAsync(CancellationToken cancellationToken = default)
+    {
+        return await odataClient.QueryEntityAsync<T>(EntityPath, keyExpression, select, expand, cancellationToken);
+    }
+
     internal QueryNode MergeExpression<TResult>(Expression<Func<T, TResult>> selector)
     {
         var visitor = new QueryNodeVisitor();

src/Linq2OData.Core/Builders/OrderByBuilder.cs

@@ -1,4 +1,5 @@
 using Linq2OData.Core.Expressions;
+using Linq2OData.Core.ODataResponse;
 using System;
 using System.Linq.Expressions;
 
@@ -126,6 +127,15 @@ public QueryBuilder<TEntity> Expand(string? expand = null)
             return queryBuilder.ExecuteAsync(cancellationToken);
         }
 
+        /// <summary>
+        /// Executes the query and returns the full <see cref="ODataResponse{T}"/> including
+        /// HTTP status code and response headers.
+        /// </summary>
+        public Task<ODataResponse<List<TEntity>>> ExecuteResponseAsync(CancellationToken cancellationToken = default)
+        {
+            return queryBuilder.ExecuteResponseAsync(cancellationToken);
+        }
+
         /// <summary>
         /// Configures the select clause with a custom selector expression.
         /// </summary>

src/Linq2OData.Core/Builders/QueryBuilder.cs

@@ -1,4 +1,5 @@
 using Linq2OData.Core.Expressions;
+using Linq2OData.Core.ODataResponse;
 using System.Linq.Expressions;
 
 namespace Linq2OData.Core.Builders;
@@ -161,6 +162,15 @@ internal void AppendOrderBy(string propertyName, bool descending)
         return result?.Data;
     }
 
+    /// <summary>
+    /// Executes the query and returns the full <see cref="ODataResponse{T}"/> including
+    /// HTTP status code and response headers.
+    /// </summary>
+    public async Task<ODataResponse<List<T>>> ExecuteResponseAsync(CancellationToken cancellationToken = default)
+    {
+        return await odataClient.QueryEntitySetAsync<T>(EntityPath, select, expand, filter, count, top, skip, orderby, cancellationToken);
+    }
+
 
 
     public QueryProjectionBuilder<T, TResult> Select<TResult>(Expression<Func<List<T>, TResult>> selector)

src/Linq2OData.Core/Builders/SingletonBuilder.cs

@@ -1,4 +1,6 @@
-namespace Linq2OData.Core.Builders;
+using Linq2OData.Core.ODataResponse;
+
+namespace Linq2OData.Core.Builders;
 
 public class SingletonBuilder<T> where T : new()
 {
@@ -32,4 +34,13 @@ public SingletonBuilder<T> Select(string? select = null)
         if (result == null) { return default; }
         return result.Data;
     }
+
+    /// <summary>
+    /// Executes the request and returns the full <see cref="ODataResponse{T}"/> including
+    /// HTTP status code and response headers.
+    /// </summary>
+    public async Task<ODataResponse<T>?> ExecuteResponseAsync(CancellationToken cancellationToken = default)
+    {
+        return await odataClient.QueryEntityAsync<T>(singletonPath, string.Empty, select, expand, cancellationToken);
+    }
 }

src/Linq2OData.Core/Builders/UpdateBuilder.cs

@@ -1,4 +1,6 @@
-namespace Linq2OData.Core.Builders;
+using Linq2OData.Core.ODataResponse;
+
+namespace Linq2OData.Core.Builders;
 
 
 
@@ -23,6 +25,15 @@ public async Task<bool> ExecuteAsync(ODataInputBase input)
       return  await odataClient.UpdateEntityAsync(entityPath, keyExpression, input);
     }
 
+    /// <summary>
+    /// Executes the update request and returns the full <see cref="ODataResponse{T}"/> including
+    /// HTTP status code and response headers.
+    /// </summary>
+    public async Task<ODataResponse<bool>> ExecuteResponseAsync(ODataInputBase input)
+    {
+        return await odataClient.UpdateEntityWithResponseAsync(entityPath, keyExpression, input);
+    }
+
 
 
 

src/Linq2OData.Core/ODataClient.cs

@@ -63,6 +63,19 @@ public async Task<bool> DeleteEntityAsync(string entitysetName, string keyExpres
             return true;
         }
 
+        public async Task<ODataResponse<bool>> DeleteEntityWithResponseAsync(string entitysetName, string keyExpression)
+        {
+            var response = await httpClient.DeleteAsync($"{entitysetName}({keyExpression})");
+            var headers = CopyResponseHeaders(response);
+            var statusCode = response.StatusCode;
+            if (statusCode == System.Net.HttpStatusCode.NotFound)
+            {
+                return new ODataResponse<bool> { Data = false, StatusCode = statusCode, ResponseHeaders = headers };
+            }
+            await ValidateResponseAsync(response);
+            return new ODataResponse<bool> { Data = true, StatusCode = statusCode, ResponseHeaders = headers };
+        }
+
         public async Task<T> CreateEntityAsync<T>(string entitysetName, ODataInputBase input)
         {
             string json = JsonSerializer.Serialize(input, jsonOptions);
@@ -82,6 +95,29 @@ public async Task<T> CreateEntityAsync<T>(string entitysetName, ODataInputBase i
             return odataResponse!.Data!;
         }
 
+        public async Task<ODataResponse<T>> CreateEntityWithResponseAsync<T>(string entitysetName, ODataInputBase input)
+        {
+            string json = JsonSerializer.Serialize(input, jsonOptions);
+            var content = new StringContent(json, Encoding.UTF8, "application/json");
+            var response = await httpClient.PostAsync($"{entitysetName}", content);
+
+            await ValidateResponseAsync(response);
+
+            var headers = CopyResponseHeaders(response);
+            var statusCode = response.StatusCode;
+            var rawResponse = await response.Content.ReadAsStringAsync();
+            var odataResponse = ProcessQueryResponse<T>(rawResponse);
+
+            if (odataResponse == null || odataResponse.Data == null)
+            {
+                throw new Exception("Create entity reported success but the response is null.");
+            }
+
+            odataResponse.StatusCode = statusCode;
+            odataResponse.ResponseHeaders = headers;
+            return odataResponse;
+        }
+
         public async Task InvokeActionAsync(string actionPath, object? parameters = null, CancellationToken token = default)
         {
             string json = parameters != null ? JsonSerializer.Serialize(parameters, jsonOptions) : "{}";
@@ -96,17 +132,27 @@ public async Task InvokeActionAsync(string actionPath, object? parameters = null
             var content = new StringContent(json, Encoding.UTF8, "application/json");
             var response = await httpClient.PostAsync(actionPath, content, token);
             await ValidateResponseAsync(response);
+            var headers = CopyResponseHeaders(response);
+            var statusCode = response.StatusCode;
             var rawResponse = await response.Content.ReadAsStringAsync(token);
-            return ProcessQueryResponse<T>(rawResponse);
+            var result = ProcessQueryResponse<T>(rawResponse);
+            result.StatusCode = statusCode;
+            result.ResponseHeaders = headers;
+            return result;
         }
 
         public async Task<ODataResponse<T>?> InvokeFunctionAsync<T>(string functionPath, CancellationToken token = default)
         {
             using var response = await httpClient.GetAsync(functionPath, token);
             if (response.StatusCode == System.Net.HttpStatusCode.NotFound) { return null; }
             await ValidateResponseAsync(response);
+            var headers = CopyResponseHeaders(response);
+            var statusCode = response.StatusCode;
             var rawResponse = await response.Content.ReadAsStringAsync(token);
-            return ProcessQueryResponse<T>(rawResponse);
+            var result = ProcessQueryResponse<T>(rawResponse);
+            result.StatusCode = statusCode;
+            result.ResponseHeaders = headers;
+            return result;
         }
 
         public async Task<bool> UpdateEntityAsync(string entitysetName, string keyExpression, ODataInputBase input)
@@ -126,6 +172,27 @@ public async Task<bool> UpdateEntityAsync(string entitysetName, string keyExpres
             return true;
         }
 
+        public async Task<ODataResponse<bool>> UpdateEntityWithResponseAsync(string entitysetName, string keyExpression, ODataInputBase input)
+        {
+            string json = JsonSerializer.Serialize(input, jsonOptions);
+            var request = new HttpRequestMessage(HttpMethod.Patch, $"{entitysetName}({keyExpression})")
+            {
+                Content = new StringContent(json, Encoding.UTF8, "application/json")
+            };
+
+            var response = await httpClient.SendAsync(request);
+            var headers = CopyResponseHeaders(response);
+            var statusCode = response.StatusCode;
+            if (statusCode == System.Net.HttpStatusCode.NotFound)
+            {
+                return new ODataResponse<bool> { Data = false, StatusCode = statusCode, ResponseHeaders = headers };
+            }
+
+            await ValidateResponseAsync(response);
+
+            return new ODataResponse<bool> { Data = true, StatusCode = statusCode, ResponseHeaders = headers };
+        }
+
 
         public async Task<ODataResponse<List<T>>> QueryEntitySetAsync<T>(string entitySetName, string? select, string? expand = null, string? filter = null, bool? count = null, int? top = null, int? skip = null, string? orderby = null, CancellationToken token = default)
         {
@@ -138,8 +205,13 @@ public async Task<ODataResponse<List<T>>> QueryEntitySetAsync<T>(string entitySe
                 await ValidateResponseAsync(response);
             }
 
+            var headers = CopyResponseHeaders(response);
+            var statusCode = response.StatusCode;
             var rawResponse = await response.Content.ReadAsStringAsync(token);
-            return ProcessQueryResponse<List<T>>(rawResponse);
+            var result = ProcessQueryResponse<List<T>>(rawResponse);
+            result.StatusCode = statusCode;
+            result.ResponseHeaders = headers;
+            return result;
         }
 
 
@@ -159,8 +231,13 @@ public async Task<ODataResponse<List<T>>> QueryEntitySetAsync<T>(string entitySe
                 await ValidateResponseAsync(response);
             }
 
+            var headers = CopyResponseHeaders(response);
+            var statusCode = response.StatusCode;
             var rawResponse = await response.Content.ReadAsStringAsync(token);
-            return ProcessQueryResponse<T>(rawResponse);
+            var result = ProcessQueryResponse<T>(rawResponse);
+            result.StatusCode = statusCode;
+            result.ResponseHeaders = headers;
+            return result;
         }
 
         private string GenerateUrl(string entitySetName, string? keyString = null, string? select = null, string? expand = null, string? filter = null, bool? count = null, int? top = null, int? skip = null, string? orderby = null)
@@ -392,6 +469,16 @@ private async Task ValidateResponseAsync(HttpResponseMessage response)
 
             throw new ODataRequestException($"OData request failed. Status code:{(int)response.StatusCode}. Error:{odataError?.Message}", response.RequestMessage, odataError);
         }
+
+        private static IDictionary<string, IEnumerable<string>> CopyResponseHeaders(HttpResponseMessage response)
+        {
+            var headers = new Dictionary<string, IEnumerable<string>>(StringComparer.OrdinalIgnoreCase);
+            foreach (var header in response.Headers)
+                headers[header.Key] = header.Value.ToList();
+            foreach (var header in response.Content.Headers)
+                headers[header.Key] = header.Value.ToList();
+            return headers;
+        }
     }
 
 }

src/Linq2OData.Core/ODataResponse/ODataResponse.cs

@@ -1,4 +1,4 @@
-using System.Diagnostics;
+using System.Net;
 using System.Text.Json.Serialization;
 
 namespace Linq2OData.Core.ODataResponse;
@@ -11,5 +11,17 @@ public class ODataResponse<T>
     [JsonPropertyName("__count")]
     public long? Count { get; set; }
 
+    /// <summary>
+    /// The HTTP status code returned by the server.
+    /// Populated when using <c>ExecuteResponseAsync</c> or the lower-level <c>ODataClient</c> methods.
+    /// </summary>
+    public HttpStatusCode? StatusCode { get; set; }
+
+    /// <summary>
+    /// Combined response and content headers returned by the server.
+    /// Populated when using <c>ExecuteResponseAsync</c> or the lower-level <c>ODataClient</c> methods.
+    /// Values are captured before the <see cref="HttpResponseMessage"/> is disposed.
+    /// </summary>
+    public IDictionary<string, IEnumerable<string>>? ResponseHeaders { get; set; }
 }