Problem details /2 by Rick-Anderson · Pull Request #27009 · dotnet/AspNetCore.Docs

Rick-Anderson · 2022-09-15T01:22:20Z

contributes to #26685
Fixes #25107

Internal review URL
sample code

Add Diagnostics middleware updates to What's new

…into nMonPrep

Rick-Anderson · 2022-09-21T02:51:43Z

Public review of the doc build:

download the HTML files
unzip
view HTML file in a browser.
For links outside the doc, remove the review. from URL.
@sammychinedu2ky start at

Client error response

sammychinedu2ky · 2022-09-21T06:46:00Z

Public review of the doc build:

download the HTML files

unzip

view HTML file in a browser.

For links outside the doc, remove the review. from URL.
@sammychinedu2ky start at

Client error response

Thanks @Rick-Anderson 😅, but I wasn't able to see how the problem was resolved since the controller writes the problem details to stream before the middleware handles it.

Since there is no way around it than changing the controller like this:

Should I leave the code in the issue as it is since you explained why in the post?

Rick-Anderson · 2022-09-21T19:07:05Z

Should I leave the https://github.com/dotnet/AspNetCore.Docs.Samples/issues/60as it is since you explained why in the post?

No, do a PR and create a 3rd controller named Values3Controller. After explaining the problem we'll show the work around.

sammychinedu2ky · 2022-09-21T19:09:27Z

Should I leave the https://github.com/dotnet/AspNetCore.Docs.Samples/issues/60as it is since you explained why in the post?

No, do a PR and create a 3rd controller named Values3Controller. After explaining the problem we'll show the work around.

I can only see one controller from my end or am I mistaken?

sammychinedu2ky · 2022-09-21T19:13:55Z

@Rick-Anderson

Rick-Anderson · 2022-09-21T19:42:26Z

https://github.com/dotnet/AspNetCore.Docs.Samples/blob/main/fundamentals/middleware/problem-details-service/Controllers/ValuesController.cs#L39

2 controllers, one file. Put the 3rd controller in the same file.

sammychinedu2ky · 2022-09-21T20:05:07Z

https://github.com/dotnet/AspNetCore.Docs.Samples/blob/main/fundamentals/middleware/problem-details-service/Controllers/ValuesController.cs#L39

2 controllers, one file. Put the 3rd controller in the same file.

Ooh I need to pull, I don't have this locally 😅

Rick-Anderson · 2022-09-21T21:26:21Z

Ooh I need to pull, I don't have this locally 😅

Never do a PR from your old branch.

sammychinedu2ky · 2022-09-21T21:32:36Z

Ooh I need to pull, I don't have this locally 😅

Never do a PR from your old branch.

Sure thanks

tdykstra

LGTM, I noted just a couple of nits.

Co-authored-by: Tom Dykstra <tdykstra@microsoft.com>

brunolins16

Looks good! I have some suggestions. Also, not directly related to your changes but will be great if we could:

Remove this topic ## Custom Middleware to handle exceptions
Update Produce a ProblemDetails payload for exceptions to keep mentioning the community middleware as an addition to what we have now.

Rick-Anderson · 2022-09-23T21:20:19Z

The sample app ~~also~~ contains the following database context class:

dead wood

brunolins16 · 2022-09-23T21:26:26Z

The sample app ~~also~~ contains the following database context class:

dead wood

Does "dead wood" mean something special here? 😂

Co-authored-by: Bruno Oliveira <brunolins16@users.noreply.github.com>

Rick-Anderson

@brunolins16 start at Internal review URL
sample code
I changed it to say

The automatic creation of a ProblemDetails for error status codes is enabled by default, but error responses can be configured in one of the following ways:

Then I added a new section just below

Default problem details response

I think I responded to most of your suggestions. Let me know what else. We might need to do a 15 minute teams meeting.

Rick-Anderson · 2022-09-23T21:35:58Z


 ASP.NET Core doesn't produce a standardized error payload when an unhandled exception occurs. For scenarios where it's desirable to return a standardized [ProblemDetails response](https://datatracker.ietf.org/doc/html/rfc7807) to the client, the [ProblemDetails middleware](https://www.nuget.org/packages/Hellang.Middleware.ProblemDetails/) can be used to map exceptions and 404 responses to a [ProblemDetails](xref:web-api/handle-errors#pd) payload. The exception handling middleware can also be used to return a <xref:Microsoft.AspNetCore.Mvc.ProblemDetails> payload for unhandled exceptions.

+<!-- TODO UPDATE •	Update Produce a ProblemDetails payload for exceptions to keep mentioning the community middleware as an addition to what we have now.-->


Update Produce a ProblemDetails payload for exceptions to keep mentioning the community middleware as an addition to what we have now.

@brunolins16 what updates are needed?

@Rick-Anderson This statement is not true ASP.NET Core doesn't produce a standardized error payload when an unhandled exception occurs. For scenarios where it's desirable to return a standardized [ProblemDetails response] anymore. Maybe we can update to say that with the AddProblemDetails + middleware (StatusCodeMiddleware and ExceptionHandlerMiddleware) we will produce the ProblemDetails response but they can continue using the ProblemDetails middleware or configure manually the ExceptionHandler to write the PR. make sense?

@brunolins16 can you take a quick look at Produce a ProblemDetails payload for exceptions ?

LGTM. I have feedback about one single statement but other than that it is pretty good.

brunolins16

@Rick-Anderson the content is pretty good, thanks a lot.

Co-authored-by: Bruno Oliveira <brunolins16@users.noreply.github.com>

Rick-Anderson · 2022-09-27T23:47:18Z

+}
+```
+
+For most apps, the preceding code is all that is needed as unhandled exceptions are rare.


@brunolins16 can I stay that? All that's needed?

Do you mean the sample code? If yes, the lines that you need to highlight for a non-dev environment are:

builder.Services.AddProblemDetails();

app.UseExceptionHandler();

I am not sure why exactly, but this statement does not sound good to me For most apps, the preceding code is all that is needed as unhandled exceptions are rare. Maybe you could say something like For most apps, the preceding code is all that is needed, however, if you want to customize [point to the customization topic]

brunolins16 · 2022-09-28T00:03:24Z

+
+For most apps, the preceding code is all that is needed as unhandled exceptions are rare.
+
+An alternative to a [custom exception handler page](xref:fundamentals/error-handling#exception-handler-page) is to provide a lambda to <xref:Microsoft.AspNetCore.Builder.ExceptionHandlerExtensions.UseExceptionHandler%2A>. Using a lambda allows access to the error and writing a problem details response with [`IProblemDetailsService.WriteAsync`](/dotnet/api/microsoft.aspnetcore.http.iproblemdetailsservice.writeasync?view=aspnetcore-7.0&preserve-view=true):


What is the strategy for to content duplication?

Rick-Anderson added 14 commits September 8, 2022 16:52

moniker prep

57155d6

Problem details service /2

f082a15

Merge branch 'main' into nMonPrep

a17a7d0

Problem details service /2

32196f9

work

23e2041

work

092e444

Update docker-compose-https.md

9bc9ba0

work

7178277

Merge branch 'nMonPrep' of https://github.com/dotnet/AspNetCore.Docs …

954bc2f

…into nMonPrep

work

c251998

work

8465f6d

work

102a9c9

work

9b91236

work

e143b0c

Rick-Anderson closed this Sep 20, 2022

Rick-Anderson reopened this Sep 20, 2022

Rick-Anderson added 5 commits September 20, 2022 11:55

work

4d46420

work

8294896

work

456bcd7

work

adab4de

work

9e14ac2

Rick-Anderson added 2 commits September 21, 2022 12:38

work

cfd0f8a

work

e2d0b67

Rick-Anderson requested a review from brunolins16 September 21, 2022 23:05

tdykstra approved these changes Sep 22, 2022

View reviewed changes

Comment thread aspnetcore/web-api/handle-errors.md Outdated

Comment thread aspnetcore/web-api/handle-errors.md Outdated

Apply suggestions from code review

3850735

Co-authored-by: Tom Dykstra <tdykstra@microsoft.com>

Rick-Anderson marked this pull request as ready for review September 22, 2022 21:52

brunolins16 reviewed Sep 22, 2022

View reviewed changes

Rick-Anderson added 3 commits September 22, 2022 16:12

react to feedback

d293e41

react to feedback

d439c24

react to feedback

1a5d61c

Rick-Anderson and others added 3 commits September 23, 2022 11:30

react to feedback

f6ea501

Update aspnetcore/web-api/handle-errors.md

70e65ff

Co-authored-by: Bruno Oliveira <brunolins16@users.noreply.github.com>

react to feedback

4acc412

Rick-Anderson commented Sep 23, 2022

View reviewed changes

react to feedback

eb561a5

brunolins16 approved these changes Sep 26, 2022

View reviewed changes

Comment thread aspnetcore/web-api/handle-errors.md Outdated

Comment thread aspnetcore/web-api/handle-errors.md

Comment thread aspnetcore/web-api/handle-errors.md Outdated

Rick-Anderson and others added 7 commits September 26, 2022 09:21

Apply suggestions from code review

02db364

Co-authored-by: Bruno Oliveira <brunolins16@users.noreply.github.com>

react to feedback

584825c

react to feedback

1120a9f

react to feedback

e3163b0

react to feedback

05e1fa2

react to feedback

302ba16

react to feedback

b11dc6d

Rick-Anderson commented Sep 27, 2022

View reviewed changes

brunolins16 reviewed Sep 28, 2022

View reviewed changes

react to feedback

ac27e7f

Rick-Anderson merged commit cdc26d9 into main Sep 28, 2022

Rick-Anderson deleted the nMonPrep branch September 28, 2022 00:25


		ASP.NET Core doesn't produce a standardized error payload when an unhandled exception occurs. For scenarios where it's desirable to return a standardized [ProblemDetails response](https://datatracker.ietf.org/doc/html/rfc7807) to the client, the [ProblemDetails middleware](https://www.nuget.org/packages/Hellang.Middleware.ProblemDetails/) can be used to map exceptions and 404 responses to a [ProblemDetails](xref:web-api/handle-errors#pd) payload. The exception handling middleware can also be used to return a <xref:Microsoft.AspNetCore.Mvc.ProblemDetails> payload for unhandled exceptions.

		<!-- TODO UPDATE • Update Produce a ProblemDetails payload for exceptions to keep mentioning the community middleware as an addition to what we have now.-->


		For most apps, the preceding code is all that is needed as unhandled exceptions are rare.

		An alternative to a [custom exception handler page](xref:fundamentals/error-handling#exception-handler-page) is to provide a lambda to <xref:Microsoft.AspNetCore.Builder.ExceptionHandlerExtensions.UseExceptionHandler%2A>. Using a lambda allows access to the error and writing a problem details response with [`IProblemDetailsService.WriteAsync`](/dotnet/api/microsoft.aspnetcore.http.iproblemdetailsservice.writeasync?view=aspnetcore-7.0&preserve-view=true):

Conversation

Rick-Anderson commented Sep 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rick-Anderson commented Sep 21, 2022

Public review of the doc build:

Client error response

Uh oh!

sammychinedu2ky commented Sep 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Public review of the doc build:

Client error response

Uh oh!

Rick-Anderson commented Sep 21, 2022

Uh oh!

sammychinedu2ky commented Sep 21, 2022

Uh oh!

sammychinedu2ky commented Sep 21, 2022

Uh oh!

Rick-Anderson commented Sep 21, 2022

Uh oh!

sammychinedu2ky commented Sep 21, 2022

Uh oh!

Rick-Anderson commented Sep 21, 2022

Uh oh!

sammychinedu2ky commented Sep 21, 2022

Uh oh!

tdykstra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

brunolins16 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rick-Anderson commented Sep 23, 2022

Uh oh!

brunolins16 commented Sep 23, 2022

Uh oh!

Rick-Anderson left a comment

Choose a reason for hiding this comment

Default problem details response

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brunolins16 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Rick-Anderson commented Sep 15, 2022 •

edited

Loading

sammychinedu2ky commented Sep 21, 2022 •

edited

Loading