Merge pull request #48 from futurum-dev/feature/improvements-to-errors-with-ProblemDetails

futurum-dev · web-flow · commit d0972c74e326 · 2022-03-19T18:30:15.000Z
Improvements to errors with ProblemDetails
diff --git a/src/Futurum.WebApiEndpoint/Internal/WebApiEndpointExecutorService.cs b/src/Futurum.WebApiEndpoint/Internal/WebApiEndpointExecutorService.cs
@@ -21,17 +21,15 @@ public static async Task ExecuteAsync(HttpContext httpContext, MetadataDefinitio
         }
         catch (Exception exception)
         {
-            var failedStatusCode = (int)HttpStatusCode.InternalServerError;
-            
-            var errorData = new IWebApiEndpointLogger.WebApiRouteErrorData(routePath, httpContext.Request.Path, "Internal Server Error", failedStatusCode, exception.Message);
+            var errorData = new IWebApiEndpointLogger.WebApiRouteErrorData(routePath, httpContext.Request.Path, "Internal Server Error", (int)HttpStatusCode.InternalServerError, exception.Message);
 
             var webApiEndpointLogger = httpContext.RequestServices.GetService<IWebApiEndpointLogger>();
             webApiEndpointLogger.Error(exception, errorData);
 
-            var errorResponse = exception.ToResultError("WebApiEndpoint - Internal Server Error")
-                                         .ToProblemDetails(failedStatusCode, httpContext.Request.Path);
+            var errorResponse = HttpStatusCode.InternalServerError.ToResultError(exception.ToResultError())
+                                         .ToProblemDetails((int)HttpStatusCode.InternalServerError, httpContext.Request.Path);
 
-            httpContext.Response.StatusCode = failedStatusCode;
+            httpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
 
             httpContext.Response.ContentType = WebApiEndpointContentType.ProblemJson;
 
diff --git a/src/Futurum.WebApiEndpoint/ResultErrorProblemDetailsExtensions.cs b/src/Futurum.WebApiEndpoint/ResultErrorProblemDetailsExtensions.cs
@@ -34,10 +34,10 @@ private static ProblemDetails FluentValidationResultError(FluentValidationResult
     private static ProblemDetails WebApiEndpointResultError(WebApiEndpointResultError webApiEndpointResultError, string requestPath) =>
         new()
         {
-            Detail = webApiEndpointResultError.DetailErrorMessage,
+            Detail = webApiEndpointResultError.GetChildrenErrorString(";"),
             Instance = requestPath,
             Status = (int)webApiEndpointResultError.HttpStatusCode,
-            Title = ReasonPhrases.GetReasonPhrase((int)webApiEndpointResultError.HttpStatusCode)
+            Title = webApiEndpointResultError.Parent.Switch(parent => parent.ToErrorString(), () => "Unknown error")
         };
 
     private static ProblemDetails GeneralError(IResultError resultError, int failedStatusCode, string requestPath) =>
@@ -46,6 +46,6 @@ private static ProblemDetails GeneralError(IResultError resultError, int failedS
             Detail = resultError.ToErrorString(),
             Instance = requestPath,
             Status = failedStatusCode,
-            Title = resultError.ToErrorStructure().Message,
+            Title = ReasonPhrases.GetReasonPhrase(failedStatusCode),
         };
 }
diff --git a/src/Futurum.WebApiEndpoint/WebApiEndpointResultError.cs b/src/Futurum.WebApiEndpoint/WebApiEndpointResultError.cs
@@ -1,25 +1,68 @@
 using System.Net;
 
+using Futurum.Core.Linq;
+using Futurum.Core.Option;
 using Futurum.Core.Result;
 
 using Microsoft.AspNetCore.WebUtilities;
 
 namespace Futurum.WebApiEndpoint;
 
-public class WebApiEndpointResultError : IResultErrorNonComposite
+public class WebApiEndpointResultError : IResultErrorComposite
 {
     public WebApiEndpointResultError(HttpStatusCode httpStatusCode, string detailErrorMessage)
     {
         HttpStatusCode = httpStatusCode;
-        DetailErrorMessage = detailErrorMessage;
+        Parent = ReasonPhrases.GetReasonPhrase((int)HttpStatusCode).ToResultError().ToOption();
+        Children = EnumerableExtensions.Return(detailErrorMessage.ToResultError());
     }
 
+    public WebApiEndpointResultError(HttpStatusCode httpStatusCode, IResultError error)
+    {
+        HttpStatusCode = httpStatusCode;
+        Parent = ReasonPhrases.GetReasonPhrase((int)HttpStatusCode).ToResultError().ToOption();
+        Children = EnumerableExtensions.Return(error);
+    }
+
+    /// <inheritdoc />
+    public Option<IResultErrorNonComposite> Parent { get; }
+
+    /// <inheritdoc />
+    public IEnumerable<IResultError> Children { get; }
+
     public HttpStatusCode HttpStatusCode { get; }
-    public string DetailErrorMessage { get; }
 
-    public string GetErrorString() =>
-        $"{ReasonPhrases.GetReasonPhrase((int)HttpStatusCode)} - {DetailErrorMessage}";
+    /// <inheritdoc />
+    public string GetErrorString(string seperator)
+    {
+        string Transform(IResultError resultError) =>
+            resultError.ToErrorString(seperator);
+
+        string GetChildrenErrorString() =>
+            Children.Select(Transform)
+                    .StringJoin(seperator);
+
+        string GetParentErrorString(IResultErrorNonComposite parent) =>
+            parent.GetErrorString();
+
+        return Parent.Switch(parent => $"{GetParentErrorString(parent)}{seperator}{GetChildrenErrorString()}",
+                             GetChildrenErrorString);
+    }
+
+    public string GetChildrenErrorString(string seperator)
+    {
+        string Transform(IResultError resultError) =>
+            resultError.ToErrorString(seperator);
+
+        string GetChildrenErrorString() =>
+            Children.Select(Transform)
+                    .StringJoin(seperator);
+
+        return GetChildrenErrorString();
+    }
 
-    public ResultErrorStructure GetErrorStructure() => 
-        new($"{ReasonPhrases.GetReasonPhrase((int)HttpStatusCode)} - {DetailErrorMessage}", Enumerable.Empty<ResultErrorStructure>());
+    /// <inheritdoc />
+    public ResultErrorStructure GetErrorStructure() =>
+        Parent.Switch(parent => ResultErrorStructureExtensions.ToResultErrorStructure(parent.GetErrorString(), Children.Select(ResultErrorStructureExtensions.ToErrorStructure)),
+                      () => ResultErrorStructureExtensions.ToResultErrorStructure(Children.Select(ResultErrorStructureExtensions.ToErrorStructure)));
 }
diff --git a/src/Futurum.WebApiEndpoint/WebApiEndpointResultErrorExtensions.cs b/src/Futurum.WebApiEndpoint/WebApiEndpointResultErrorExtensions.cs
@@ -7,8 +7,11 @@ namespace Futurum.WebApiEndpoint;
 public static class WebApiEndpointResultErrorExtensions
 {
     public static IResultError ToResultError(this HttpStatusCode httpStatusCode) =>
-        new WebApiEndpointResultError(httpStatusCode, string.Empty);
+        new WebApiEndpointResultError(httpStatusCode, ResultErrorEmpty.Value);
 
     public static IResultError ToResultError(this HttpStatusCode httpStatusCode, string detailErrorMessage) =>
         new WebApiEndpointResultError(httpStatusCode, detailErrorMessage);
+
+    public static IResultError ToResultError(this HttpStatusCode httpStatusCode, IResultError error) =>
+        new WebApiEndpointResultError(httpStatusCode, error);
 }
diff --git a/test/Futurum.WebApiEndpoint.EndToEndTests/SamplesEndToEndFeaturesErrorsTests.cs b/test/Futurum.WebApiEndpoint.EndToEndTests/SamplesEndToEndFeaturesErrorsTests.cs
@@ -10,6 +10,7 @@
 
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Testing;
+using Microsoft.AspNetCore.WebUtilities;
 
 using Xunit;
 
@@ -26,10 +27,12 @@ public async Task ErrorResult()
         var commandDto = new ErrorResultScenario.CommandDto(Guid.NewGuid().ToString());
         var json = JsonSerializer.Serialize(commandDto);
 
+        var requestPath = "/api/1.0/error-result";
+        
         var request = new HttpRequestMessage
         {
             Method = HttpMethod.Post,
-            RequestUri = new Uri("/api/1.0/error-result"),
+            RequestUri = new Uri(requestPath),
             Content = new StringContent(json, Encoding.UTF8, MediaTypeNames.Application.Json)
         };
 
@@ -38,7 +41,10 @@ public async Task ErrorResult()
         httpResponseMessage.StatusCode.Should().Be(HttpStatusCode.BadRequest);
         var response = await httpResponseMessage.Content.ReadFromJsonAsync<ProblemDetails>();
 
-        response.Title.Should().Be($"An result error has occured - {commandDto.Id}");
+        response.Title.Should().Be(ReasonPhrases.GetReasonPhrase((int)HttpStatusCode.BadRequest));
+        response.Detail.Should().Be($"An result error has occured - {commandDto.Id}");
+        response.Status.Should().Be((int)HttpStatusCode.BadRequest);
+        response.Instance.Should().Be(requestPath);
     }
     
     [Fact]
@@ -49,10 +55,12 @@ public async Task ErrorException()
         var commandDto = new ErrorExceptionScenario.CommandDto(Guid.NewGuid().ToString());
         var json = JsonSerializer.Serialize(commandDto);
 
+        var requestPath = "/api/1.0/error-exception";
+        
         var request = new HttpRequestMessage
         {
             Method = HttpMethod.Post,
-            RequestUri = new Uri("/api/1.0/error-exception"),
+            RequestUri = new Uri(requestPath),
             Content = new StringContent(json, Encoding.UTF8, MediaTypeNames.Application.Json)
         };
 
@@ -61,8 +69,10 @@ public async Task ErrorException()
         httpResponseMessage.StatusCode.Should().Be(HttpStatusCode.InternalServerError);
         var response = await httpResponseMessage.Content.ReadFromJsonAsync<ProblemDetails>();
 
-        response.Title.Should().Be("WebApiEndpoint - Internal Server Error");
+        response.Title.Should().Be("Internal Server Error");
         response.Detail.Should().Contain($"An exception has occured - {commandDto.Id}");
+        response.Status.Should().Be((int)HttpStatusCode.InternalServerError);
+        response.Instance.Should().Be(requestPath);
     }
 
     private static HttpClient CreateClient() =>
diff --git a/test/Futurum.WebApiEndpoint.EndToEndTests/SamplesEndToEndTests.Features.Responses.cs b/test/Futurum.WebApiEndpoint.EndToEndTests/SamplesEndToEndTests.Features.Responses.cs
@@ -13,6 +13,7 @@
 
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Testing;
+using Microsoft.AspNetCore.WebUtilities;
 
 using Xunit;
 
@@ -123,7 +124,8 @@ public async Task not_set()
                     httpResponseMessage.StatusCode.Should().Be(HttpStatusCode.NotFound);
                     var response = await httpResponseMessage.Content.ReadFromJsonAsync<ProblemDetails>();
 
-                    response.Title.Should().Be("Unable to get range");
+                    response.Title.Should().Be(ReasonPhrases.GetReasonPhrase((int)HttpStatusCode.NotFound));
+                    response.Detail.Should().Be("Unable to get range");
                 }
 
                 [Theory]
@@ -238,7 +240,8 @@ public async Task not_set()
                     httpResponseMessage.StatusCode.Should().Be(HttpStatusCode.ServiceUnavailable);
                     var response = await httpResponseMessage.Content.ReadFromJsonAsync<ProblemDetails>();
 
-                    response.Title.Should()
+                    response.Title.Should().Be(ReasonPhrases.GetReasonPhrase((int)HttpStatusCode.ServiceUnavailable));
+                    response.Detail.Should()
                             .Be($"Failed to MapFromHeader for {typeof(WebApiEndpoint.Range).FullName} for property : '{nameof(QueryWithRequestParameterMapFromWithResponseBytesRangeScenario.RequestDto.Range)}'");
                 }
 
diff --git a/test/Futurum.WebApiEndpoint.Tests/Internal/WebApiEndpointExecutorServiceTests.cs b/test/Futurum.WebApiEndpoint.Tests/Internal/WebApiEndpointExecutorServiceTests.cs
@@ -14,6 +14,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 
@@ -92,7 +93,9 @@ public async Task when_MetadataDefinition_is_null()
 
         var problemDetails = JsonSerializer.Deserialize<ProblemDetails>(requestBody, new JsonSerializerOptions(JsonSerializerDefaults.Web));
 
-        problemDetails.Title.Should().StartWith("WebApiEndpoint - Unable to find WebApiEndpoint for route");
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase((int)HttpStatusCode.BadRequest));
+        problemDetails.Detail.Should().StartWith("WebApiEndpoint - Unable to find WebApiEndpoint for route");
+        problemDetails.Status.Should().Be((int)HttpStatusCode.BadRequest);
     }
 
     [Fact]
@@ -195,8 +198,9 @@ public async Task when_ApiEndpoint_call_fails()
 
         var problemDetails = JsonSerializer.Deserialize<ProblemDetails>(requestBody, new JsonSerializerOptions(JsonSerializerDefaults.Web));
 
-        problemDetails.Title.Should().Be(FailedApiEndpoint.ERROR_MESSAGE);
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase(metadataRouteDefinition.FailedStatusCode));
         problemDetails.Detail.Should().Be(FailedApiEndpoint.ERROR_MESSAGE);
+        problemDetails.Status.Should().Be(metadataRouteDefinition.FailedStatusCode);
     }
 
     [Fact]
@@ -235,6 +239,8 @@ public async Task when_unknown_error()
 
         var problemDetails = JsonSerializer.Deserialize<ProblemDetails>(requestBody, new JsonSerializerOptions(JsonSerializerDefaults.Web));
 
-        problemDetails.Title.Should().StartWith("WebApiEndpoint - Internal Server Error");
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase((int)HttpStatusCode.InternalServerError));
+        problemDetails.Detail.Should().StartWith("Failed to resolve Type");
+        problemDetails.Status.Should().Be((int)HttpStatusCode.InternalServerError);
     }
 }
diff --git a/test/Futurum.WebApiEndpoint.Tests/Internal/WebApiEndpointHttpContextDispatcherTests.cs b/test/Futurum.WebApiEndpoint.Tests/Internal/WebApiEndpointHttpContextDispatcherTests.cs
@@ -1,3 +1,4 @@
+using System.Net;
 using System.Text.Json;
 
 using FluentAssertions;
@@ -11,6 +12,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.Options;
 
 using Xunit;
@@ -49,7 +51,8 @@ public async Task success()
 
         var problemDetails = JsonSerializer.Deserialize<ProblemDetails>(requestBody, new JsonSerializerOptions(JsonSerializerDefaults.Web));
 
-        problemDetails.Title.Should().Be(ErrorMessage);
-        problemDetails.Title.Should().Be(ErrorMessage);
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase(metadataRouteDefinition.FailedStatusCode));
+        problemDetails.Detail.Should().Be(ErrorMessage);
+        problemDetails.Status.Should().Be(metadataRouteDefinition.FailedStatusCode);
     }
 }
diff --git a/test/Futurum.WebApiEndpoint.Tests/ResultErrorProblemDetailsExtensionsTests.cs b/test/Futurum.WebApiEndpoint.Tests/ResultErrorProblemDetailsExtensionsTests.cs
@@ -25,7 +25,7 @@ public void when_ResultErrorEmpty()
 
         var problemDetails = resultError.ToProblemDetails(failedStatusCode, requestPath);
 
-        problemDetails.Title.Should().BeEmpty();
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase(failedStatusCode));
         problemDetails.Detail.Should().BeEmpty();
         problemDetails.Instance.Should().Be(requestPath);
         problemDetails.Status.Should().Be(failedStatusCode);
@@ -42,7 +42,7 @@ public void when_ResultErrorMessage()
 
         var problemDetails = resultError.ToProblemDetails(failedStatusCode, requestPath);
 
-        problemDetails.Title.Should().Be(errorMessage);
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase(failedStatusCode));
         problemDetails.Detail.Should().Be(errorMessage);
         problemDetails.Instance.Should().Be(requestPath);
         problemDetails.Status.Should().Be(failedStatusCode);
@@ -59,7 +59,7 @@ public void when_ResultErrorException()
 
         var problemDetails = resultError.ToProblemDetails(failedStatusCode, requestPath);
 
-        problemDetails.Title.Should().Be(errorMessage);
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase(failedStatusCode));
         problemDetails.Detail.Should().Be(errorMessage);
         problemDetails.Instance.Should().Be(requestPath);
         problemDetails.Status.Should().Be(failedStatusCode);
@@ -80,7 +80,7 @@ public void when_ResultErrorComposite()
 
         var problemDetails = resultError.ToProblemDetails(failedStatusCode, requestPath);
 
-        problemDetails.Title.Should().Be(errorMessage1);
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase(failedStatusCode));
         problemDetails.Detail.Should().Be($"{errorMessage1};{errorMessage2}");
         problemDetails.Instance.Should().Be(requestPath);
         problemDetails.Status.Should().Be(failedStatusCode);
diff --git a/test/Futurum.WebApiEndpoint.Tests/WebApiEndpointDispatcherTests.cs b/test/Futurum.WebApiEndpoint.Tests/WebApiEndpointDispatcherTests.cs
@@ -15,6 +15,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.Options;
 
 using Moq;
@@ -81,7 +82,7 @@ public async Task failure()
 
         var problemDetails = JsonSerializer.Deserialize<ProblemDetails>(requestBody, new JsonSerializerOptions(JsonSerializerDefaults.Web));
 
-        problemDetails.Title.Should().Be(ApiEndpoint.ErrorMessage);
+        problemDetails.Title.Should().Be(ReasonPhrases.GetReasonPhrase(MetadataRouteDefinition.FailedStatusCode));
         problemDetails.Detail.Should().Be(ApiEndpoint.ErrorMessage);
         
         mockWebApiEndpointLogger.Verify(x => x.Error(MetadataRouteDefinition.RouteTemplate, It.IsAny<IResultError>()), Times.Once);
diff --git a/test/Futurum.WebApiEndpoint.Tests/WebApiEndpointResultErrorExtensionsTests.cs b/test/Futurum.WebApiEndpoint.Tests/WebApiEndpointResultErrorExtensionsTests.cs
@@ -2,6 +2,11 @@
 
 using FluentAssertions;
 
+using Futurum.Core.Result;
+using Futurum.Test.Option;
+
+using Microsoft.AspNetCore.WebUtilities;
+
 using Xunit;
 
 namespace Futurum.WebApiEndpoint.Tests;
@@ -19,7 +24,8 @@ public void without_DetailErrorMessage()
 
         var webApiEndpointResultError = resultError as WebApiEndpointResultError;
         webApiEndpointResultError.HttpStatusCode.Should().Be(httpStatusCode);
-        webApiEndpointResultError.DetailErrorMessage.Should().BeEmpty();
+        webApiEndpointResultError.Parent.ShouldBeHasValueWithValue(x => x.GetErrorString(),ReasonPhrases.GetReasonPhrase((int)httpStatusCode));
+        webApiEndpointResultError.Children.Single().Should().BeOfType<ResultErrorEmpty>();
     }
     
     [Fact]
@@ -34,6 +40,7 @@ public void with_DetailErrorMessage()
 
         var webApiEndpointResultError = resultError as WebApiEndpointResultError;
         webApiEndpointResultError.HttpStatusCode.Should().Be(httpStatusCode);
-        webApiEndpointResultError.DetailErrorMessage.Should().Be(detailErrorMessage);
+        webApiEndpointResultError.Parent.ShouldBeHasValueWithValue(x => x.GetErrorString(),ReasonPhrases.GetReasonPhrase((int)httpStatusCode));
+        webApiEndpointResultError.Children.Single().ToErrorString().Should().Be(detailErrorMessage);
     }
 }
diff --git a/test/Futurum.WebApiEndpoint.Tests/WebApiEndpointResultErrorTests.cs b/test/Futurum.WebApiEndpoint.Tests/WebApiEndpointResultErrorTests.cs
@@ -18,9 +18,9 @@ public void GetErrorString()
 
         var webApiEndpointResultError = new WebApiEndpointResultError(httpStatusCode, detailErrorMessage);
 
-        var errorString = webApiEndpointResultError.GetErrorString();
+        var errorString = webApiEndpointResultError.GetErrorString(";");
 
-        errorString.Should().Be($"{ReasonPhrases.GetReasonPhrase((int)httpStatusCode)} - {detailErrorMessage}");
+        errorString.Should().Be($"{ReasonPhrases.GetReasonPhrase((int)httpStatusCode)};{detailErrorMessage}");
     }
     
     [Fact]
@@ -33,7 +33,8 @@ public void GetErrorStructure()
 
         var errorStructure = webApiEndpointResultError.GetErrorStructure();
 
-        errorStructure.Message.Should().Be($"{ReasonPhrases.GetReasonPhrase((int)httpStatusCode)} - {detailErrorMessage}");
-        errorStructure.Children.Should().BeEmpty();
+        errorStructure.Message.Should().Be(ReasonPhrases.GetReasonPhrase((int)httpStatusCode));
+        errorStructure.Children.First().Message.Should().Be(detailErrorMessage);
+        errorStructure.Children.First().Children.Should().BeEmpty();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,11 @@ namespace Futurum.WebApiEndpoint;`
`7`	`7`	`public static class WebApiEndpointResultErrorExtensions`
`8`	`8`	`{`
`9`	`9`	`public static IResultError ToResultError(this HttpStatusCode httpStatusCode) =>`
`10`		`- new WebApiEndpointResultError(httpStatusCode, string.Empty);`
	`10`	`+ new WebApiEndpointResultError(httpStatusCode, ResultErrorEmpty.Value);`
`11`	`11`
`12`	`12`	`public static IResultError ToResultError(this HttpStatusCode httpStatusCode, string detailErrorMessage) =>`
`13`	`13`	`new WebApiEndpointResultError(httpStatusCode, detailErrorMessage);`
	`14`	`+`
	`15`	`+ public static IResultError ToResultError(this HttpStatusCode httpStatusCode, IResultError error) =>`
	`16`	`+ new WebApiEndpointResultError(httpStatusCode, error);`
`14`	`17`	`}`