Merge pull request #58 from marcominerva/develop

Refactor HTTP status code handling

README.md

@@ -43,7 +43,7 @@ _Note: This is the library to use if you're working with Minimal APIs._
 
 This library provides HttpContext extension methods to automatically map Operation Results (that may come, for example, from a business layer) to HTTP responses, along with the appropriate status codes.
 
-A full example is available in the [Samples](https://github.com/marcominerva/OperationResults/tree/master/samples) folder. Search for the [registration](https://github.com/marcominerva/OperationResults/blob/master/samples/MinimalApis/OperationResults.Sample/Program.cs#L23-L25) and the [usage](https://github.com/marcominerva/OperationResults/blob/master/samples/MinimalApis/OperationResults.Sample/Program.cs#L51-L106) in [Program.cs](https://github.com/marcominerva/OperationResults/blob/master/samples/MinimalApis/OperationResults.Sample/Program.cs) file.
+A full example is available in the [Samples](https://github.com/marcominerva/OperationResults/tree/master/samples) folder. Search for the [registration](https://github.com/marcominerva/OperationResults/blob/master/samples/MinimalApis/OperationResults.Sample/Program.cs#L23-L35) and the [usage](https://github.com/marcominerva/OperationResults/blob/master/samples/MinimalApis/OperationResults.Sample/Program.cs#L51-L106) in [Program.cs](https://github.com/marcominerva/OperationResults/blob/master/samples/MinimalApis/OperationResults.Sample/Program.cs) file.
 
 **Installation**
 

samples/Controllers/OperationResults.Sample/Program.cs

@@ -30,9 +30,9 @@
     // for the Operation Results of our Business Logic methods.
     options.StatusCodesMapping.Add(CustomFailureReasons.NotAvailable, StatusCodes.Status501NotImplemented);
 
-    // If you just want to directly use HTTP status codes as failure reasons, set the following property to true.
+    // If you just want to directly use HTTP status codes as failure reasons, set the following property to false.
     // In this way, the code you use with Result.Fail() will be used as response status code with no further mapping.
-    // options.UseHttpStatusCodes = true;
+    // options.MapStatusCodes = false;
 },
 //updateModelStateResponseFactory: true);
 // Passing a validation error default message or a validation error message provider automatically update the ModelStateResponseFactory.

samples/MinimalApis/OperationResults.Sample/Program.cs

@@ -29,9 +29,9 @@
     // for the Operation Results of our Business Logic methods.
     options.StatusCodesMapping.Add(CustomFailureReasons.NotAvailable, StatusCodes.Status501NotImplemented);
 
-    // If you just want to directly use HTTP status codes as failure reasons, set the following property to true.
+    // If you just want to directly use HTTP status codes as failure reasons, set the following property to false.
     // In this way, the code you use with Result.Fail() will be used as response status code with no further mapping.
-    //options.UseHttpStatusCodes = true;
+    options.MapStatusCodes = false;
 });
 
 builder.Services.AddEndpointsApiExplorer();

samples/OperationResults.Sample.BusinessLayer/CustomFailureReasons.cs

@@ -2,5 +2,5 @@
 
 public static class CustomFailureReasons
 {
-    public const int NotAvailable = 1001;
+    public const int NotAvailable = FailureReasons.GenericError + 1;
 }

src/OperationResults.AspNetCore.Http/OperationResultExtensions.cs

@@ -95,7 +95,7 @@ public static IResult ToResponse<T>(this Result<T> result, HttpContext httpConte
     private static IResult Problem(HttpContext httpContext, int failureReason, object? content = null, string? title = null, string? detail = null, IEnumerable<ValidationError>? validationErrors = null)
     {
         var options = httpContext.RequestServices.GetService<OperationResultOptions>() ?? new OperationResultOptions();
-        var statusCode = options.UseHttpStatusCodes ? failureReason : options.GetStatusCode(failureReason);
+        var statusCode = options.MapStatusCodes ? options.GetStatusCode(failureReason) : failureReason;
 
         if (content is not null)
         {

src/OperationResults.AspNetCore.Http/OperationResultOptions.cs

@@ -4,28 +4,33 @@ namespace OperationResults.AspNetCore.Http;
 
 public class OperationResultOptions
 {
-    public ErrorResponseFormat ErrorResponseFormat { get; set; }
+    public ErrorResponseFormat ErrorResponseFormat { get; set; } = ErrorResponseFormat.Default;
 
     public Dictionary<int, int> StatusCodesMapping { get; }
 
-    public bool UseHttpStatusCodes { get; set; }
+    public bool MapStatusCodes { get; set; } = true;
 
-    public UnmappedFailureReasonBehavior UnmappedFailureReasonBehavior { get; set; }
+    public UnmappedFailureReasonBehavior UnmappedFailureReasonBehavior { get; set; } = UnmappedFailureReasonBehavior.UseDefaultStatusCode;
 
-    public int UnmappedFailureReasonStatusCode { get; set; } = StatusCodes.Status500InternalServerError;
+    public int UnmappedFailureReasonStatusCode { get; set; } = StatusCodes.Status501NotImplemented;
 
     public OperationResultOptions()
     {
         StatusCodesMapping = new Dictionary<int, int>
         {
             [FailureReasons.None] = StatusCodes.Status200OK,
-            [FailureReasons.ItemNotFound] = StatusCodes.Status404NotFound,
-            [FailureReasons.Forbidden] = StatusCodes.Status403Forbidden,
-            [FailureReasons.DatabaseError] = StatusCodes.Status500InternalServerError,
             [FailureReasons.ClientError] = StatusCodes.Status400BadRequest,
-            [FailureReasons.InvalidFile] = StatusCodes.Status415UnsupportedMediaType,
-            [FailureReasons.Conflict] = StatusCodes.Status409Conflict,
             [FailureReasons.Unauthorized] = StatusCodes.Status401Unauthorized,
+            [FailureReasons.Forbidden] = StatusCodes.Status403Forbidden,
+            [FailureReasons.ItemNotFound] = StatusCodes.Status404NotFound,
+            [FailureReasons.InvalidRequest] = StatusCodes.Status406NotAcceptable,
+            [FailureReasons.Timeout] = StatusCodes.Status408RequestTimeout,
+            [FailureReasons.Conflict] = StatusCodes.Status409Conflict,
+            [FailureReasons.InvalidFile] = StatusCodes.Status415UnsupportedMediaType,
+            [FailureReasons.InvalidContent] = StatusCodes.Status422UnprocessableEntity,
+            [FailureReasons.DatabaseError] = StatusCodes.Status500InternalServerError,
+            [FailureReasons.NetworkError] = StatusCodes.Status500InternalServerError,
+            [FailureReasons.ServiceUnavailable] = StatusCodes.Status503ServiceUnavailable,
             [FailureReasons.GenericError] = StatusCodes.Status500InternalServerError
         };
     }

src/OperationResults.AspNetCore.Http/OperationResults.AspNetCore.Http.csproj

@@ -25,7 +25,7 @@
     </ItemGroup>
 
     <ItemGroup>        
-        <PackageReference Include="OperationResultTools" Version="1.0.25" />
+        <PackageReference Include="OperationResultTools" Version="1.0.26" />
     </ItemGroup>
 
     <ItemGroup>

src/OperationResults.AspNetCore.Http/UnmappedFailureReasonBehavior.cs

@@ -2,6 +2,6 @@
 
 public enum UnmappedFailureReasonBehavior
 {
-    UseFailureReason,
     UseDefaultStatusCode,
+    UseFailureReason
 }

src/OperationResults.AspNetCore/OperationResultExtensions.cs

@@ -87,7 +87,7 @@ public static IActionResult ToResponse<T>(this Result<T> result, HttpContext htt
     private static IActionResult Problem(HttpContext httpContext, int failureReason, object? content = null, string? title = null, string? detail = null, IEnumerable<ValidationError>? validationErrors = null)
     {
         var options = httpContext.RequestServices.GetService<OperationResultOptions>() ?? new OperationResultOptions();
-        var statusCode = options.UseHttpStatusCodes ? failureReason : options.GetStatusCode(failureReason);
+        var statusCode = options.MapStatusCodes ? options.GetStatusCode(failureReason) : failureReason;
 
         if (content is not null)
         {

src/OperationResults.AspNetCore/OperationResultOptions.cs

@@ -4,28 +4,33 @@ namespace OperationResults.AspNetCore;
 
 public class OperationResultOptions
 {
-    public ErrorResponseFormat ErrorResponseFormat { get; set; }
+    public ErrorResponseFormat ErrorResponseFormat { get; set; } = ErrorResponseFormat.Default;
 
     public Dictionary<int, int> StatusCodesMapping { get; }
 
-    public bool UseHttpStatusCodes { get; set; }
+    public bool MapStatusCodes { get; set; } = true;
 
-    public UnmappedFailureReasonBehavior UnmappedFailureReasonBehavior { get; set; }
+    public UnmappedFailureReasonBehavior UnmappedFailureReasonBehavior { get; set; } = UnmappedFailureReasonBehavior.UseDefaultStatusCode;
 
-    public int UnmappedFailureReasonStatusCode { get; set; } = StatusCodes.Status500InternalServerError;
+    public int UnmappedFailureReasonStatusCode { get; set; } = StatusCodes.Status501NotImplemented;
 
     public OperationResultOptions()
     {
         StatusCodesMapping = new Dictionary<int, int>
         {
             [FailureReasons.None] = StatusCodes.Status200OK,
-            [FailureReasons.ItemNotFound] = StatusCodes.Status404NotFound,
-            [FailureReasons.Forbidden] = StatusCodes.Status403Forbidden,
-            [FailureReasons.DatabaseError] = StatusCodes.Status500InternalServerError,
             [FailureReasons.ClientError] = StatusCodes.Status400BadRequest,
-            [FailureReasons.InvalidFile] = StatusCodes.Status415UnsupportedMediaType,
-            [FailureReasons.Conflict] = StatusCodes.Status409Conflict,
             [FailureReasons.Unauthorized] = StatusCodes.Status401Unauthorized,
+            [FailureReasons.Forbidden] = StatusCodes.Status403Forbidden,
+            [FailureReasons.ItemNotFound] = StatusCodes.Status404NotFound,
+            [FailureReasons.InvalidRequest] = StatusCodes.Status406NotAcceptable,
+            [FailureReasons.Timeout] = StatusCodes.Status408RequestTimeout,
+            [FailureReasons.Conflict] = StatusCodes.Status409Conflict,
+            [FailureReasons.InvalidFile] = StatusCodes.Status415UnsupportedMediaType,
+            [FailureReasons.InvalidContent] = StatusCodes.Status422UnprocessableEntity,
+            [FailureReasons.DatabaseError] = StatusCodes.Status500InternalServerError,
+            [FailureReasons.NetworkError] = StatusCodes.Status500InternalServerError,
+            [FailureReasons.ServiceUnavailable] = StatusCodes.Status503ServiceUnavailable,
             [FailureReasons.GenericError] = StatusCodes.Status500InternalServerError
         };
     }

src/OperationResults.AspNetCore/OperationResults.AspNetCore.csproj

@@ -25,7 +25,7 @@
     </ItemGroup>
 
     <ItemGroup>        
-        <PackageReference Include="OperationResultTools" Version="1.0.25" />
+        <PackageReference Include="OperationResultTools" Version="1.0.26" />
     </ItemGroup>
 
     <ItemGroup>

src/OperationResults.AspNetCore/UnmappedFailureReasonBehavior.cs

@@ -2,6 +2,6 @@
 
 public enum UnmappedFailureReasonBehavior
 {
-    UseFailureReason,
     UseDefaultStatusCode,
+    UseFailureReason
 }