Merge pull request #57 from marcominerva/develop

marcominerva · web-flow · commit 53c30618a74f · 2024-06-17T09:42:48.000+02:00
Update Failure Reasons
diff --git a/samples/Controllers/OperationResults.Sample/OperationResults.Sample.csproj b/samples/Controllers/OperationResults.Sample/OperationResults.Sample.csproj
@@ -6,8 +6,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.4" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.1" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.6" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
         <PackageReference Include="TinyHelpers.AspNetCore" Version="3.1.4" />
     </ItemGroup>
 
diff --git a/samples/MinimalApis/OperationResults.Sample/OperationResults.Sample.csproj b/samples/MinimalApis/OperationResults.Sample/OperationResults.Sample.csproj
@@ -6,9 +6,9 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4" />
-        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.4" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.1" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.6" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.6" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/OperationResults.Sample.DataAccessLayer/OperationResults.Sample.DataAccessLayer.csproj b/samples/OperationResults.Sample.DataAccessLayer/OperationResults.Sample.DataAccessLayer.csproj
@@ -6,6 +6,6 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.4" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.6" />
     </ItemGroup>
 </Project>
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -9,7 +9,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.133"  PrivateAssets="All" />
+        <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.139"  PrivateAssets="All" />
     </ItemGroup>
 
 </Project>
diff --git a/src/OperationResults.AspNetCore.Http/OperationResultOptions.cs b/src/OperationResults.AspNetCore.Http/OperationResultOptions.cs
@@ -10,6 +10,10 @@ public class OperationResultOptions
 
     public bool UseHttpStatusCodes { get; set; }
 
+    public UnmappedFailureReasonBehavior UnmappedFailureReasonBehavior { get; set; }
+
+    public int UnmappedFailureReasonStatusCode { get; set; } = StatusCodes.Status500InternalServerError;
+
     public OperationResultOptions()
     {
         StatusCodesMapping = new Dictionary<int, int>
@@ -30,7 +34,11 @@ internal int GetStatusCode(int failureReason, int? defaultStatusCode = null)
     {
         if (!StatusCodesMapping.TryGetValue(failureReason, out var statusCode))
         {
-            statusCode = defaultStatusCode.GetValueOrDefault(StatusCodes.Status501NotImplemented);
+            statusCode = UnmappedFailureReasonBehavior switch
+            {
+                UnmappedFailureReasonBehavior.UseDefaultStatusCode => defaultStatusCode.GetValueOrDefault(UnmappedFailureReasonStatusCode),
+                _ => failureReason
+            };
         }
 
         return statusCode;
diff --git a/src/OperationResults.AspNetCore.Http/UnmappedFailureReasonBehavior.cs b/src/OperationResults.AspNetCore.Http/UnmappedFailureReasonBehavior.cs
@@ -0,0 +1,7 @@
+﻿namespace OperationResults.AspNetCore.Http;
+
+public enum UnmappedFailureReasonBehavior
+{
+    UseFailureReason,
+    UseDefaultStatusCode,
+}
diff --git a/src/OperationResults.AspNetCore/OperationResultOptions.cs b/src/OperationResults.AspNetCore/OperationResultOptions.cs
@@ -10,6 +10,10 @@ public class OperationResultOptions
 
     public bool UseHttpStatusCodes { get; set; }
 
+    public UnmappedFailureReasonBehavior UnmappedFailureReasonBehavior { get; set; }
+
+    public int UnmappedFailureReasonStatusCode { get; set; } = StatusCodes.Status500InternalServerError;
+
     public OperationResultOptions()
     {
         StatusCodesMapping = new Dictionary<int, int>
@@ -30,7 +34,11 @@ internal int GetStatusCode(int failureReason, int? defaultStatusCode = null)
     {
         if (!StatusCodesMapping.TryGetValue(failureReason, out var statusCode))
         {
-            statusCode = defaultStatusCode.GetValueOrDefault(StatusCodes.Status501NotImplemented);
+            statusCode = UnmappedFailureReasonBehavior switch
+            {
+                UnmappedFailureReasonBehavior.UseDefaultStatusCode => defaultStatusCode.GetValueOrDefault(UnmappedFailureReasonStatusCode),
+                _ => failureReason
+            };
         }
 
         return statusCode;
diff --git a/src/OperationResults.AspNetCore/UnmappedFailureReasonBehavior.cs b/src/OperationResults.AspNetCore/UnmappedFailureReasonBehavior.cs
@@ -0,0 +1,7 @@
+﻿namespace OperationResults.AspNetCore;
+
+public enum UnmappedFailureReasonBehavior
+{
+    UseFailureReason,
+    UseDefaultStatusCode,
+}
diff --git a/src/OperationResults/FailureReasons.cs b/src/OperationResults/FailureReasons.cs
@@ -3,12 +3,17 @@
 public static class FailureReasons
 {
     public const int None = 0;
-    public const int ItemNotFound = 1;
-    public const int Forbidden = 2;
-    public const int DatabaseError = 3;
-    public const int ClientError = 4;
-    public const int InvalidFile = 5;
-    public const int Conflict = 6;
-    public const int Unauthorized = 7;
-    public const int GenericError = 8;
+    public const int ClientError = 1;
+    public const int Unauthorized = 2;
+    public const int Forbidden = 3;
+    public const int ItemNotFound = 4;
+    public const int InvalidRequest = 5;
+    public const int Timeout = 6;
+    public const int Conflict = 7;
+    public const int InvalidFile = 8;
+    public const int InvalidContent = 9;
+    public const int DatabaseError = 10;
+    public const int NetworkError = 11;
+    public const int ServiceUnavailable = 12;
+    public const int GenericError = 1000;
 }

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,10 @@ public class OperationResultOptions`
`10`	`10`
`11`	`11`	`public bool UseHttpStatusCodes { get; set; }`
`12`	`12`
	`13`	`+ public UnmappedFailureReasonBehavior UnmappedFailureReasonBehavior { get; set; }`
	`14`	`+`
	`15`	`+ public int UnmappedFailureReasonStatusCode { get; set; } = StatusCodes.Status500InternalServerError;`
	`16`	`+`
`13`	`17`	`public OperationResultOptions()`
`14`	`18`	`{`
`15`	`19`	`StatusCodesMapping = new Dictionary<int, int>`
`@@ -30,7 +34,11 @@ internal int GetStatusCode(int failureReason, int? defaultStatusCode = null)`
`30`	`34`	`{`
`31`	`35`	`if (!StatusCodesMapping.TryGetValue(failureReason, out var statusCode))`
`32`	`36`	`{`
`33`		`- statusCode = defaultStatusCode.GetValueOrDefault(StatusCodes.Status501NotImplemented);`
	`37`	`+ statusCode = UnmappedFailureReasonBehavior switch`
	`38`	`+ {`
	`39`	`+ UnmappedFailureReasonBehavior.UseDefaultStatusCode => defaultStatusCode.GetValueOrDefault(UnmappedFailureReasonStatusCode),`
	`40`	`+ _ => failureReason`
	`41`	`+ };`
`34`	`42`	`}`
`35`	`43`
`36`	`44`	`return statusCode;`