Add an option on the ExceptionHandlerOptions to select status codes based on exceptions
#56616
Conversation
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
…tionHandlerOptions
ghost
added
the
area-middleware
dotnet-policy-service
bot
added
the
community-contribution
|
@dotnet-policy-service agree |
dotnet-policy-service
bot
added
the
pending-ci-rerun
|
@latonz Thanks for the contribution! We'll review this soon. |
| } | ||
|
|
||
| [Fact] | ||
| public async Task ExceptionHandler_SelectsStatusCode404_When404ThrowedAndNotNotAllowed() |
There was a problem hiding this comment.
This test name should be changed for clarity (and for the typo 😄)... maybe just StatusCodeSelector_CanSelect404?
There was a problem hiding this comment.
Renamed the test as you suggested 👍
BrennanConroy
approved these changes
Jul 17, 2024
src/Middleware/Diagnostics/src/ExceptionHandler/ExceptionHandlerMiddlewareImpl.cs
Show resolved
Hide resolved
… a functional test
| @@ -34,4 +35,21 @@ public async Task ExceptionHandlerPage_ProducesProblemDetails() | |||
| Assert.NotNull(body); | |||
| Assert.Equal(500, body.Status); | |||
| } | |||
|
|
|||
| [Fact] | |||
| public async Task StatusCodeSelector_ProducesProblemDetailsWith403() | |||
There was a problem hiding this comment.
Suggested change
| public async Task StatusCodeSelector_ProducesProblemDetailsWith403() | |
| public async Task StatusCodeSelector_ProducesProblemDetailsWithCustomStatusCode() |
There was a problem hiding this comment.
Renamed the test as requested.
| @@ -17,12 +17,22 @@ public void ConfigureServices(IServiceCollection services) | |||
| public void Configure(IApplicationBuilder app) | |||
| { | |||
| // Configure the error handler to produces a ProblemDetails. | |||
| app.UseExceptionHandler(); | |||
| app.UseExceptionHandler(new ExceptionHandlerOptions | |||
There was a problem hiding this comment.
Technically this makes the other test in ExceptionHandlderTest.cs not test the default behavior. Could we change it to something like
app.Map("/throw", throwApp =>
{
throwApp.UseExceptionHandler();
throwApp.Map("/conflict", throwConflictApp =>
{
throwConflictApp.Run(_ => throw new Exception("Conflict Exception"));
});
throwApp.Run(_ => throw new Exception("Application Exception"));
});
app.Map("/throw2", throwApp =>
{
throwApp.UseExceptionHandler(new ExceptionHandlerOptions
{
StatusCodeSelector = ex => ex is ConflictException
? StatusCodes.Status409Conflict
: StatusCodes.Status500InternalServerError,
});
throwApp.Map("/conflict", throwConflictApp =>
{
throwConflictApp.Run(_ => throw new Exception("Conflict Exception"));
});
});So the tests can use different usages of UseExceptionHandler?
There was a problem hiding this comment.
Thanks for pointing out, improved the isolation of the test as suggested.
latonz
force-pushed
the
44156-exception-handler-status-code-selector
branch
from
7f94943 to
247a948
Compare
BrennanConroy
removed
the
pending-ci-rerun
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
Thanks @latonz ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add an option on the
ExceptionHandlerOptionsto select status codes based on exceptionsAdds
Func<Exception, int>? StatusCodeSelectorto theExceptionHandlerOptionswhich allows users to easily map an exception to a status code. TheExceptionHandlerMiddlewareImpluses that new status code selector whenever the default status code of 500 was used and only falls back to 500 if no status code selector is set on the options.If a status code selector is set, 404 status codes are allowed (
AllowStatusCode404Responseis ignored).Fixes #44156