Merge pull request #61 from marcominerva/develop

marcominerva · web-flow · commit aec8879853ce · 2024-09-23T15:36:44.000+02:00
Update dependencies and refactor error handling
diff --git a/samples/Controllers/OperationResults.Sample/OperationResults.Sample.csproj b/samples/Controllers/OperationResults.Sample/OperationResults.Sample.csproj
@@ -6,9 +6,9 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.7" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
-        <PackageReference Include="TinyHelpers.AspNetCore" Version="3.1.6" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.8" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.8.0" />
+        <PackageReference Include="TinyHelpers.AspNetCore" Version="3.1.9" />
     </ItemGroup>
 
     <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.7" />
-        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.7" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.8" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.8" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="6.8.0" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/OperationResults.Sample.BusinessLayer/Services/PeopleService.cs b/samples/OperationResults.Sample.BusinessLayer/Services/PeopleService.cs
@@ -123,19 +123,19 @@ public async Task<Result> DeleteAsync(Guid id)
     {
         var dbPerson = await dbContext.People.FirstOrDefaultAsync(p => p.Id == id);
 
-        if (dbPerson is not null)
+        if (dbPerson is null)
         {
-            if (dbPerson.FirstName == "Admin")
-            {
-                return Result.Fail(FailureReasons.Forbidden, "You cannot delete the Admin user");
-            }
-
-            dbContext.Remove(dbPerson);
-            await dbContext.SaveChangesAsync();
+            return Result.Fail(FailureReasons.ItemNotFound);
+        }
 
-            return Result.Ok();
+        if (dbPerson.FirstName == "Admin")
+        {
+            return Result.Fail(FailureReasons.Forbidden, "You cannot delete the Admin user");
         }
 
-        return Result.Fail(FailureReasons.ItemNotFound);
+        dbContext.Remove(dbPerson);
+        await dbContext.SaveChangesAsync();
+
+        return Result.Ok();
     }
 }
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.7" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.8" />
     </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.139"  PrivateAssets="All" />
+        <PackageReference Include="Nerdbank.GitVersioning" Version="3.6.143"  PrivateAssets="All" />
     </ItemGroup>
 
 </Project>
diff --git a/src/OperationResults.AspNetCore.Http/HttpContextExtensions.cs b/src/OperationResults.AspNetCore.Http/HttpContextExtensions.cs
@@ -7,8 +7,8 @@ public static class HttpContextExtensions
     public static IResult CreateResponse(this HttpContext httpContext, Result result, int? successStatusCode = null)
         => result.ToResponse(httpContext, successStatusCode);
 
-    public static IResult CreateResponse(this HttpContext httpContext, Result result, string? routeName, object? routeValues = null, int? successStatusCode = null)
-        => result.ToResponse(httpContext, routeName, routeValues, successStatusCode);
+    public static IResult CreateResponse(this HttpContext httpContext, Result result, string? routeName, object? routeValues = null)
+        => result.ToResponse(httpContext, routeName, routeValues);
 
     public static IResult CreateResponse<T>(this HttpContext httpContext, Result<T> result, int? successStatusCode = null)
         => result.ToResponse(httpContext, null, null, successStatusCode);
diff --git a/src/OperationResults.AspNetCore.Http/OperationResultExtensions.cs b/src/OperationResults.AspNetCore.Http/OperationResultExtensions.cs
@@ -23,7 +23,7 @@ public static IResult ToResponse(this Result result, HttpContext httpContext, in
         return Problem(httpContext, result.FailureReason, null, result.ErrorMessage, result.ErrorDetail, result.ValidationErrors);
     }
 
-    public static IResult ToResponse(this Result result, HttpContext httpContext, string? routeName, object? routeValues = null, int? successStatusCode = null)
+    public static IResult ToResponse(this Result result, HttpContext httpContext, string? routeName, object? routeValues = null)
     {
         if (result.Success)
         {
@@ -109,7 +109,6 @@ private static IResult Problem(HttpContext httpContext, int failureReason, objec
         var problemDetails = new ProblemDetails
         {
             Status = statusCode,
-            Type = $"https://httpstatuses.io/{statusCode}",
             Title = title ?? ReasonPhrases.GetReasonPhrase(statusCode),
             Detail = detail,
             Instance = httpContext.Request.Path
@@ -131,9 +130,12 @@ private static IResult Problem(HttpContext httpContext, int failureReason, objec
         }
 
 #if NET6_0
-        return Results.Json(problemDetails, statusCode: statusCode, contentType: "application/problem+json; charset=utf-8");
+        return Results.Problem(problemDetails);
 #else
-        return TypedResults.Json(problemDetails, statusCode: statusCode, contentType: "application/problem+json; charset=utf-8");
+        var problemResult = TypedResults.Problem(problemDetails);
+        problemResult.ProblemDetails.Type ??= $"https://httpstatuses.io/{statusCode}";
+
+        return problemResult;
 #endif
     }
 }
diff --git a/src/OperationResults.AspNetCore/OperationResultExtensions.cs b/src/OperationResults.AspNetCore/OperationResultExtensions.cs
@@ -1,6 +1,6 @@
-﻿using System.Diagnostics;
-using Microsoft.AspNetCore.Http;
+﻿using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Infrastructure;
 using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -99,16 +99,10 @@ private static IActionResult Problem(HttpContext httpContext, int failureReason,
             return objectResult;
         }
 
-        var problemDetails = new ProblemDetails
-        {
-            Status = statusCode,
-            Type = $"https://httpstatuses.io/{statusCode}",
-            Title = title ?? ReasonPhrases.GetReasonPhrase(statusCode),
-            Detail = detail,
-            Instance = httpContext.Request.Path
-        };
-
-        problemDetails.Extensions.Add("traceId", Activity.Current?.Id ?? httpContext.TraceIdentifier);
+        var problemDetailsFactory = httpContext.RequestServices.GetRequiredService<ProblemDetailsFactory>();
+        var problemDetails = problemDetailsFactory.CreateProblemDetails(httpContext, statusCode, title ?? ReasonPhrases.GetReasonPhrase(statusCode),
+            detail: detail, instance: httpContext.Request.Path);
+        problemDetails.Type ??= $"https://httpstatuses.io/{statusCode}";
 
         if (validationErrors?.Any() ?? false)
         {
@@ -123,12 +117,12 @@ private static IActionResult Problem(HttpContext httpContext, int failureReason,
             }
         }
 
-        var problemDetailsResults = new JsonResult(problemDetails)
+        var problemDetailsResult = new JsonResult(problemDetails)
         {
             StatusCode = statusCode,
-            ContentType = "application/problem+json; charset=utf-8"
+            ContentType = "application/problem+json"
         };
 
-        return problemDetailsResults;
+        return problemDetailsResult;
     }
 }
diff --git a/src/OperationResults.AspNetCore/ServiceCollectionExtensions.cs b/src/OperationResults.AspNetCore/ServiceCollectionExtensions.cs
@@ -1,6 +1,6 @@
-﻿using System.Diagnostics;
-using Microsoft.AspNetCore.Http;
+﻿using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Infrastructure;
 using Microsoft.AspNetCore.Mvc.ModelBinding;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
@@ -45,15 +45,11 @@ private static IServiceCollection AddOperationResult(this IServiceCollection ser
                 {
                     var httpContext = actionContext.HttpContext;
                     var statusCode = operationResultOptions.GetStatusCode(FailureReasons.ClientError, StatusCodes.Status400BadRequest);
-                    var problemDetails = new ProblemDetails
-                    {
-                        Status = statusCode,
-                        Title = validationErrorMessageProvider?.Invoke(actionContext.ModelState) ?? "One or more validation errors occurred",
-                        Type = $"https://httpstatuses.io/{statusCode}",
-                        Instance = httpContext.Request.Path
-                    };
 
-                    problemDetails.Extensions.Add("traceId", Activity.Current?.Id ?? httpContext.TraceIdentifier);
+                    var problemDetailsFactory = httpContext.RequestServices.GetRequiredService<ProblemDetailsFactory>();
+                    var problemDetails = problemDetailsFactory.CreateProblemDetails(httpContext, statusCode, validationErrorMessageProvider?.Invoke(actionContext.ModelState) ?? "One or more validation errors occurred",
+                        instance: httpContext.Request.Path);
+                    problemDetails.Type ??= $"https://httpstatuses.io/{statusCode}";
 
                     if (operationResultOptions.ErrorResponseFormat == ErrorResponseFormat.Default)
                     {
@@ -72,12 +68,13 @@ private static IServiceCollection AddOperationResult(this IServiceCollection ser
                         problemDetails.Extensions.Add("errors", errors);
                     }
 
-                    var result = new ObjectResult(problemDetails)
+                    var problemDetailsResult = new JsonResult(problemDetails)
                     {
-                        StatusCode = statusCode
+                        StatusCode = statusCode,
+                        ContentType = "application/problem+json"
                     };
 
-                    return result;
+                    return problemDetailsResult;
                 };
             });
         }

Original file line number	Diff line number	Diff line change
`@@ -123,19 +123,19 @@ public async Task<Result> DeleteAsync(Guid id)`
`123`	`123`	`{`
`124`	`124`	`var dbPerson = await dbContext.People.FirstOrDefaultAsync(p => p.Id == id);`
`125`	`125`
`126`		`- if (dbPerson is not null)`
	`126`	`+ if (dbPerson is null)`
`127`	`127`	`{`
`128`		`- if (dbPerson.FirstName == "Admin")`
`129`		`- {`
`130`		`- return Result.Fail(FailureReasons.Forbidden, "You cannot delete the Admin user");`
`131`		`- }`
`132`		`-`
`133`		`- dbContext.Remove(dbPerson);`
`134`		`- await dbContext.SaveChangesAsync();`
	`128`	`+ return Result.Fail(FailureReasons.ItemNotFound);`
	`129`	`+ }`
`135`	`130`
`136`		`- return Result.Ok();`
	`131`	`+ if (dbPerson.FirstName == "Admin")`
	`132`	`+ {`
	`133`	`+ return Result.Fail(FailureReasons.Forbidden, "You cannot delete the Admin user");`
`137`	`134`	`}`
`138`	`135`
`139`		`- return Result.Fail(FailureReasons.ItemNotFound);`
	`136`	`+ dbContext.Remove(dbPerson);`
	`137`	`+ await dbContext.SaveChangesAsync();`
	`138`	`+`
	`139`	`+ return Result.Ok();`
`140`	`140`	`}`
`141`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public static IResult ToResponse(this Result result, HttpContext httpContext, in`
`23`	`23`	`return Problem(httpContext, result.FailureReason, null, result.ErrorMessage, result.ErrorDetail, result.ValidationErrors);`
`24`	`24`	`}`
`25`	`25`
`26`		`- public static IResult ToResponse(this Result result, HttpContext httpContext, string? routeName, object? routeValues = null, int? successStatusCode = null)`
	`26`	`+ public static IResult ToResponse(this Result result, HttpContext httpContext, string? routeName, object? routeValues = null)`
`27`	`27`	`{`
`28`	`28`	`if (result.Success)`
`29`	`29`	`{`
`@@ -109,7 +109,6 @@ private static IResult Problem(HttpContext httpContext, int failureReason, objec`
`109`	`109`	`var problemDetails = new ProblemDetails`
`110`	`110`	`{`
`111`	`111`	`Status = statusCode,`
`112`		`- Type = $"https://httpstatuses.io/{statusCode}",`
`113`	`112`	`Title = title ?? ReasonPhrases.GetReasonPhrase(statusCode),`
`114`	`113`	`Detail = detail,`
`115`	`114`	`Instance = httpContext.Request.Path`
`@@ -131,9 +130,12 @@ private static IResult Problem(HttpContext httpContext, int failureReason, objec`
`131`	`130`	`}`
`132`	`131`
`133`	`132`	`#if NET6_0`
`134`		`- return Results.Json(problemDetails, statusCode: statusCode, contentType: "application/problem+json; charset=utf-8");`
	`133`	`+ return Results.Problem(problemDetails);`
`135`	`134`	`#else`
`136`		`- return TypedResults.Json(problemDetails, statusCode: statusCode, contentType: "application/problem+json; charset=utf-8");`
	`135`	`+ var problemResult = TypedResults.Problem(problemDetails);`
	`136`	`+ problemResult.ProblemDetails.Type ??= $"https://httpstatuses.io/{statusCode}";`
	`137`	`+`
	`138`	`+ return problemResult;`
`137`	`139`	`#endif`
`138`	`140`	`}`
`139`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-using System.Diagnostics;`
`2`		`-using Microsoft.AspNetCore.Http;`
	`1`	`+using Microsoft.AspNetCore.Http;`
`3`	`2`	`using Microsoft.AspNetCore.Mvc;`
	`3`	`+using Microsoft.AspNetCore.Mvc.Infrastructure;`
`4`	`4`	`using Microsoft.AspNetCore.WebUtilities;`
`5`	`5`	`using Microsoft.Extensions.DependencyInjection;`
`6`	`6`
`@@ -99,16 +99,10 @@ private static IActionResult Problem(HttpContext httpContext, int failureReason,`
`99`	`99`	`return objectResult;`
`100`	`100`	`}`
`101`	`101`
`102`		`- var problemDetails = new ProblemDetails`
`103`		`- {`
`104`		`- Status = statusCode,`
`105`		`- Type = $"https://httpstatuses.io/{statusCode}",`
`106`		`- Title = title ?? ReasonPhrases.GetReasonPhrase(statusCode),`
`107`		`- Detail = detail,`
`108`		`- Instance = httpContext.Request.Path`
`109`		`- };`
`110`		`-`
`111`		`- problemDetails.Extensions.Add("traceId", Activity.Current?.Id ?? httpContext.TraceIdentifier);`
	`102`	`+ var problemDetailsFactory = httpContext.RequestServices.GetRequiredService<ProblemDetailsFactory>();`
	`103`	`+ var problemDetails = problemDetailsFactory.CreateProblemDetails(httpContext, statusCode, title ?? ReasonPhrases.GetReasonPhrase(statusCode),`
	`104`	`+ detail: detail, instance: httpContext.Request.Path);`
	`105`	`+ problemDetails.Type ??= $"https://httpstatuses.io/{statusCode}";`
`112`	`106`
`113`	`107`	`if (validationErrors?.Any() ?? false)`
`114`	`108`	`{`
`@@ -123,12 +117,12 @@ private static IActionResult Problem(HttpContext httpContext, int failureReason,`
`123`	`117`	`}`
`124`	`118`	`}`
`125`	`119`
`126`		`- var problemDetailsResults = new JsonResult(problemDetails)`
	`120`	`+ var problemDetailsResult = new JsonResult(problemDetails)`
`127`	`121`	`{`
`128`	`122`	`StatusCode = statusCode,`
`129`		`- ContentType = "application/problem+json; charset=utf-8"`
	`123`	`+ ContentType = "application/problem+json"`
`130`	`124`	`};`
`131`	`125`
`132`		`- return problemDetailsResults;`
	`126`	`+ return problemDetailsResult;`
`133`	`127`	`}`
`134`	`128`	`}`