refactor: Add new ProblemDetails DTO ErrorProblemDetails extended from ProblemDetails;

BREAKING CHANGE: Change `ProblemDetailsResponse` to `ErrorProblemDetails`

Author: NelsonBN

src/ApiProblemDetailsFactory.cs

@@ -22,31 +22,17 @@ IOptions<ErrorHandlerOptions> errorHandlerOptions
             _errorHandlerOptions = errorHandlerOptions?.Value ?? throw new ArgumentNullException(nameof(errorHandlerOptions));
         }
 
-        internal ProblemDetailsResponse Create(HttpContext httpContext)
+        internal ErrorProblemDetails Create(HttpContext httpContext)
         {
-            var result = new ProblemDetailsResponse();
+            var problemDetails = new ErrorProblemDetails();
 
-            result.Status = httpContext.GetStatusCode() ?? 0; // Default value is 0
-            if(_apiBehaviorOptions.ClientErrorMapping.TryGetValue(result.Status, out var clientErrorData))
-            {
-                result.Type = clientErrorData.Link;
-                result.Title = clientErrorData.Title;
-            }
-            else
-            {
-                result.Type = ProblemDetailsDefaults.Defaults[0].Link;
-                result.Title = ProblemDetailsDefaults.Defaults[0].Title;
-            }
-
-            result.Instance = httpContext.GetRequestEndpoint();
-
-            result.TraceId = httpContext.GetCorrelationId();
+            _applyDefaults(httpContext, problemDetails);
 
-            return result;
+            return problemDetails;
         }
 
 
-        public ProblemDetailsResponse Create(HttpContext httpContext, IEnumerable<KeyValuePair<string, string>> errors)
+        public ErrorProblemDetails Create(HttpContext httpContext, IEnumerable<KeyValuePair<string, string>> errors)
         {
             var result = Create(httpContext);
 
@@ -62,7 +48,7 @@ public ProblemDetailsResponse Create(HttpContext httpContext, IEnumerable<KeyVal
             return result;
         }
 
-        internal ProblemDetailsResponse Create(ActionContext actionContext)
+        internal ErrorProblemDetails Create(ActionContext actionContext)
         {
             var payloadTooLargeError = actionContext.ModelState.CheckPayloadTooLargeAndReturnError();
             if(payloadTooLargeError.Count == 1)
@@ -93,7 +79,7 @@ public override ProblemDetails CreateProblemDetails(
             string instance = null
         )
         {
-            statusCode ??= httpContext.GetStatusCode() ?? 0;
+            statusCode ??= httpContext.GetStatusCode();
 
             var problemDetails = new ProblemDetails
             {
@@ -124,7 +110,7 @@ public override ValidationProblemDetails CreateValidationProblemDetails(
                 throw new ArgumentNullException(nameof(modelStateDictionary));
             }
 
-            statusCode ??= httpContext.GetStatusCode() ?? 400;
+            statusCode ??= httpContext.GetStatusCode();
 
             var problemDetails = new ValidationProblemDetails(modelStateDictionary)
             {
@@ -147,6 +133,8 @@ public override ValidationProblemDetails CreateValidationProblemDetails(
 
         private void _applyDefaults(HttpContext httpContext, ProblemDetails problemDetails)
         {
+            problemDetails.Status ??= httpContext.GetStatusCode();
+
             if(_apiBehaviorOptions.ClientErrorMapping.TryGetValue(problemDetails.Status.Value, out var clientErrorData))
             {
                 problemDetails.Type ??= clientErrorData.Link;
@@ -179,7 +167,7 @@ private static void _applyDetails(ProblemDetails problemDetails)
                 404 => "The entity was not found.",
                 409 => "The entity already exists.",
 
-                _ when problemDetails.Status >= 400 && problemDetails.Status < 500 => "A validation error has occurred.",
+                _ when problemDetails.Status >= 400 && problemDetails.Status < 500 => "One or more validation errors occurred.",
 
                 _ => "An unexpected error has occurred."
             };

src/ErrorProblemDetails.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Microsoft.AspNetCore.Mvc;
+using PowerUtils.AspNetCore.ErrorHandler.Serializers;
+
+namespace PowerUtils.AspNetCore.ErrorHandler
+{
+    [JsonConverter(typeof(ErrorProblemDetailsJsonConverter))]
+    public class ErrorProblemDetails : ProblemDetails
+    {
+        /// <summary>
+        /// ID generated by the problem to track logs
+        /// </summary>
+        [JsonPropertyName("traceId")]
+        public string TraceId { get; set; }
+
+        /// <summary>
+        /// Error property list
+        /// </summary>
+        /// <example>
+        /// { "Property": "Error" }
+        /// </example>
+        public IDictionary<string, string> Errors { get; set; } = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase);
+
+        /// <summary>
+        /// Initializes a new instance of <see cref="ErrorProblemDetails"/>.
+        /// </summary>
+        public ErrorProblemDetails() { }
+
+        /// <summary>
+        /// Serialize problem details to JSON
+        /// </summary>
+        public override string ToString()
+            => JsonSerializer.Serialize(this);
+
+        public static implicit operator string(ErrorProblemDetails problemDetailsResponse)
+            => problemDetailsResponse.ToString();
+    }
+}

src/Handlers/ErrorHandlerMiddleware.cs

@@ -46,7 +46,7 @@ private Task _handleProblem(HttpContext httpContext)
 
             var problemDetails = _problemDetailsFactory.Create(httpContext);
 
-            _logger.LogDebug(problemDetails);
+            _logger.Debug(problemDetails);
 
             return httpContext.WriteProblemDetailsResponseAsync(problemDetails);
         }

src/Handlers/ExceptionHandlerMiddleware.cs

@@ -27,7 +27,7 @@ internal static IApplicationBuilder UseExceptionHandlerMiddleware(this IApplicat
                             .Features
                             .Get<IExceptionHandlerFeature>()?.Error;
 
-                        ProblemDetailsResponse problemDetails;
+                        ErrorProblemDetails problemDetails;
                         if(exception == null)
                         {
                             httpContext.ResetResponse(StatusCodes.Status500InternalServerError);

src/Handlers/ModelStateMiddleware.cs

@@ -20,7 +20,7 @@ internal static IServiceCollection AddModelStateMiddleware(this IServiceCollecti
 
 
                     actionContext.HttpContext.ResetResponse();
-                    actionContext.HttpContext.Response.StatusCode = problemDetails.Status;
+                    actionContext.HttpContext.Response.StatusCode = problemDetails.Status ?? ProblemDetailsDefaults.FALLBACK_STATUS_CODE;
 
 
                     return new ObjectResult(problemDetails)

src/HttpContextExtensions.cs

@@ -61,8 +61,8 @@ internal static string GetRequestEndpoint(this HttpContext httpContext)
          * Client error responses  ( 400 – 499 )
          * Server error responses  ( 500 – 599 )
         */
-        internal static int? GetStatusCode(this HttpContext httpContext)
-            => httpContext?.Response?.StatusCode;
+        internal static int GetStatusCode(this HttpContext httpContext)
+            => httpContext?.Response?.StatusCode ?? 0;
 
         internal static bool IsNotSuccess(this HttpContext httpContext)
         {
@@ -72,7 +72,7 @@ internal static bool IsNotSuccess(this HttpContext httpContext)
                 return true;
             }
 
-            if(statusCode is null)
+            if(statusCode == 0)
             {
                 return true;
             }
@@ -121,11 +121,11 @@ internal static void ResetResponse(this HttpContext httpContext, int statusCode)
             httpContext.Response.StatusCode = statusCode;
         }
 
-        internal static async Task WriteProblemDetailsResponseAsync(this HttpContext httpContext, ProblemDetailsResponse response)
+        internal static async Task WriteProblemDetailsResponseAsync(this HttpContext httpContext, ErrorProblemDetails response)
         {
             httpContext.ResetResponse();
 
-            httpContext.Response.StatusCode = response.Status; // It is required because was a `ResetResponse()`
+            httpContext.Response.StatusCode = response.Status ?? ProblemDetailsDefaults.FALLBACK_STATUS_CODE; // It is required because was a `ResetResponse()`
 
             // Serialize the problem details object to the Response as JSON (using System.Text.Json)
             await JsonSerializer.SerializeAsync(httpContext.Response.Body, response);

src/LoggerExtensions.cs

@@ -6,7 +6,7 @@ namespace PowerUtils.AspNetCore.ErrorHandler
 {
     internal static class LoggerExtensions
     {
-        public static void Error(this ILogger logger, Exception exception, string request, int statusCode)
+        public static void Error(this ILogger logger, Exception exception, string request, int? statusCode)
             => logger.LogError(
                 exception,
                 $"[ERROR HANDLER] > Request: '{request}', StatusCode: '{statusCode}'"

src/ProblemDetailsDefaults.cs

@@ -5,6 +5,7 @@ namespace PowerUtils.AspNetCore.ErrorHandler
     internal static class ProblemDetailsDefaults
     {
         public const string PROBLEM_MEDIA_TYPE_JSON = "application/problem+json";
+        public const int FALLBACK_STATUS_CODE = 500;
 
         public static readonly Dictionary<int, (string Title, string Link)> Defaults = new()
         {