fix #12516 by cleaning up Hosting error page #12545

analogrelay · 2019-07-24T23:58:28Z

When detailed errors is off (because Environment is not Development) and you have a startup error and .CaptureStartupErrors is one, this is what you get now:

I checked IIS and the Diagnostics error page. They look good already. IIS shares the page but only ever renders it if detailed errors are enabled (via Environment or the environment variable override).

Fixes #12516

jkotalik · 2019-07-25T00:00:10Z

src/Shared/ErrorPage/README.md

@@ -0,0 +1,14 @@
+# Error Page
+
+This folder is shared among multiple projects. The `ErrorPage.Designer.cs` and `ErrorPageModel.cs` files are used to render this view. The `ErrorPage.Designer.cs` file is generated by rendering `src/Views/ErrorPage.cshtml` using the [RazorPageGenerator](https://github.com/aspnet/AspNetCore-Tooling/tree/master/src/Razor/src/RazorPageGenerator) tool.


Nice! Always nice to make the grass greener for the next person to work with the error page!

Agreed. Even on platforms without powershell, you can look at the script to see how the generator is supposed to be invoked.

analogrelay · 2019-07-25T00:00:49Z

src/Shared/ErrorPage/Views/ErrorPage.cshtml

@@ -31,12 +31,11 @@
        @foreach (var errorDetail in Model.ErrorDetails)
        {
            <div class="titleerror">@errorDetail.Error.GetType().Name: @{ Output.Write(HtmlEncodeAndReplaceLineBreaks(errorDetail.Error.Message)); }</div>
-            @{


This wasn't valid Razor syntax, it spit out errors generating the code. I think Razor is nice and decides to work around the error but it's not actually correct.

The </div> ended the markup block so you're back in the body of the foreach which is a code context, and @{ isn't needed.

Did it give an error when you compiled it?

Yep. It throws an error but still generates the output. But errors are bad :).

analogrelay · 2019-07-25T00:04:54Z

src/Servers/IIS/IIS/src/StartupHook.cs

+            // The startup hook is only present when detailed errors are allowed, so
+            // we can turn on all the details.
            model.ErrorDetails = exceptionDetailProvider.GetDetails(exception);
+            model.ShowRuntimeDetails = true;


This is necessary since the property defaults to false. I thought about defaulting it to true but I think it's better for users of the page to opt-in to detailed information.

There may be one more place we do this. IIRC we have a hosting startup error page and a detailed errors error page. Can you check these and make sure we set ShowRuntimeDetails appropriately:

https://github.com/aspnet/AspNetCore/blob/cc1f23c5f8afb7d2a00405f19811d2372c4fcec2/src/Middleware/Diagnostics/src/DeveloperExceptionPage/DeveloperExceptionPageMiddleware.cs

https://github.com/aspnet/AspNetCore/blob/f3f9a1cdbcd06b298035b523732b9f45b1408461/src/Hosting/Hosting/src/GenericHost/GenericWebHostedService.cs

https://github.com/aspnet/AspNetCore/blob/f3f9a1cdbcd06b298035b523732b9f45b1408461/src/Hosting/Hosting/src/Internal/WebHost.cs

I checked the diagnostics one. It's a little deceptive because it's actually a different error page because it's even more detailed (query strings, headers, etc.) and the middleware is only enabled in Development mode.

I did miss GenericWebHostedService. Looking at that now.

Actually it was the other way around :). I missed the WebHost one. Updated.

Sorry, clarify why you don't need to updat ethe GenericWebHostedService model?

Because I already did: https://github.com/aspnet/AspNetCore/pull/12545/files#diff-712c8e185558d5014acb35f2f2b86786

analogrelay · 2019-07-25T15:08:25Z

Ping. Would like re-review after some changes.

Tratcher · 2019-07-25T16:01:41Z

src/Middleware/Diagnostics/Diagnostics.slnf

@@ -0,0 +1,45 @@
+{
+  "solution": {
+    "path": "C:\\Code\\aspnet\\AspNetCore\\src\\Middleware\\Middleware.sln",


Make relative

Oof, good catch.

It's unfortunate that the default VS experience for this doesn't use relative paths, even though they are supported. I may file a VS feedback item for that ;).

analogrelay added 2 commits July 24, 2019 14:51

fix #12516 by cleaning up error page

fcb06fc

add a Diagnostics.slnf because I was there

27ebca8

analogrelay requested review from Tratcher, blowdart and jkotalik July 24, 2019 23:58

analogrelay added the area-hosting label Jul 24, 2019

analogrelay added this to the 3.0.0-preview8 milestone Jul 24, 2019

analogrelay changed the title ~~fix #12516 by cleaning up error page~~ fix #12516 by cleaning up capturestartuperrors error page Jul 24, 2019

analogrelay changed the title ~~fix #12516 by cleaning up capturestartuperrors error page~~ fix #12516 by cleaning up Hosting error page Jul 24, 2019

jkotalik reviewed Jul 25, 2019

View reviewed changes

jkotalik approved these changes Jul 25, 2019

View reviewed changes

analogrelay commented Jul 25, 2019

View reviewed changes

missed the IIS update

ee5581a

analogrelay requested a review from halter73 as a code owner July 25, 2019 00:04

analogrelay commented Jul 25, 2019

View reviewed changes

analogrelay added the tell-mode Indicates a PR which is being merged during tell-mode label Jul 25, 2019

update WebHost's error page

fa8b350

analogrelay requested a review from jkotalik July 25, 2019 00:29

Tratcher approved these changes Jul 25, 2019

View reviewed changes

jkotalik approved these changes Jul 25, 2019

View reviewed changes

Fix slnf path

78c6dff

halter73 approved these changes Jul 25, 2019

View reviewed changes

analogrelay merged commit cac5184 into master Jul 25, 2019

analogrelay deleted the anurse/12516-error-page-clean-up branch July 25, 2019 20:01

amcasey added the area-hosting Includes Hosting label Jun 1, 2023

		@@ -0,0 +1,14 @@
		# Error Page

		This folder is shared among multiple projects. The `ErrorPage.Designer.cs` and `ErrorPageModel.cs` files are used to render this view. The `ErrorPage.Designer.cs` file is generated by rendering `src/Views/ErrorPage.cshtml` using the [RazorPageGenerator](https://github.com/aspnet/AspNetCore-Tooling/tree/master/src/Razor/src/RazorPageGenerator) tool.

fix #12516 by cleaning up Hosting error page #12545

fix #12516 by cleaning up Hosting error page #12545

Uh oh!

Conversation

analogrelay commented Jul 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

analogrelay Jul 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

analogrelay commented Jul 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

analogrelay commented Jul 24, 2019 •

edited

Loading

analogrelay Jul 25, 2019 •

edited

Loading

analogrelay commented Jul 25, 2019 •

edited

Loading