Improve API Error Handling #169
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| using Elzik.Breef.Domain; | ||
| using Microsoft.AspNetCore.Diagnostics; | ||
|
|
||
| namespace Elzik.Breef.Api.ExceptionHandling; | ||
|
|
||
| public static class ExceptionHandlingExtensions | ||
| { | ||
| public static void AddExceptionHandling(this IServiceCollection services) | ||
| { | ||
| services.AddProblemDetails(); | ||
| } | ||
|
|
||
| public static void UseExceptionHandling(this WebApplication app) | ||
| { | ||
| app.UseExceptionHandler(errorApp => | ||
| { | ||
| errorApp.Run(async context => | ||
| { | ||
| var exceptionHandlerFeature = context.Features.Get<IExceptionHandlerFeature>(); | ||
| var exception = exceptionHandlerFeature?.Error; | ||
| int statusCode; | ||
| string title; | ||
| string detail; | ||
|
|
||
| if (exception is ICallerFixableException) | ||
| { | ||
| if (string.IsNullOrWhiteSpace(exception?.Message)) | ||
|
Check warning on line 27 in src/Elzik.Breef.Api/ExceptionHandling/ExceptionHandlingExtensions.cs
|
||
| { | ||
| throw new InvalidOperationException( | ||
| "Caller-fixable exception must have a non-empty message for the caller to fix.", | ||
| exception); | ||
| } | ||
| statusCode = StatusCodes.Status400BadRequest; | ||
| title = "There was a problem with your request"; | ||
| detail = exception.Message; | ||
| } | ||
| else | ||
| { | ||
| statusCode = StatusCodes.Status500InternalServerError; | ||
| title = "An error occurred while processing your request"; | ||
| detail = "Contact your Breef administrator for a solution."; | ||
| } | ||
|
|
||
| var problemDetails = new Microsoft.AspNetCore.Mvc.ProblemDetails | ||
| { | ||
| Status = statusCode, | ||
| Title = title, | ||
| Detail = detail | ||
| }; | ||
|
|
||
| context.Response.StatusCode = statusCode; | ||
| context.Response.ContentType = "application/problem+json"; | ||
| await context.Response.WriteAsJsonAsync(problemDetails); | ||
| }); | ||
| }); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| namespace Elzik.Breef.Domain | ||
| { | ||
| /// <summary> | ||
| /// Marker interface for exceptions that can be fixed by the requester/user. | ||
| /// </summary> | ||
| public interface ICallerFixableException | ||
| { | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| using Elzik.Breef.Domain; | ||
|
|
||
| namespace Elzik.Breef.Infrastructure | ||
| { | ||
| public class CallerFixableHttpRequestException : HttpRequestException, ICallerFixableException | ||
| { | ||
| public CallerFixableHttpRequestException(string message, Exception? innerException = null) | ||
| : base(message, innerException) | ||
| { | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| using Microsoft.AspNetCore.Hosting; | ||
| using Microsoft.AspNetCore.Mvc.Testing; | ||
| using Microsoft.Extensions.Hosting; | ||
|
|
||
| namespace Elzik.Breef.Api.Tests.Functional; | ||
|
|
||
| public class DevelopmentWebApplicationFactory : WebApplicationFactory<Program> | ||
| { | ||
| protected override IHost CreateHost(IHostBuilder builder) | ||
| { | ||
| builder.UseEnvironment("Development"); | ||
| return base.CreateHost(builder); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.