feat(error): Server error handler (DSP-710) #355

kilchenmann · 2021-01-09T16:27:37Z

resolves DSP-710 (s. discussion)

closes #311

Implementation of error handler service with following job:
- depending on error status show message from dsp-ui notification service (mat snackbar) or show full-size error page (case 500 and 503 / server error)
Add error handler to all components and services where we do api requests (incl. refactoring of Imports)
Error test page /teapot with status 418 (easteregg)
- shows the default app error; default means it's not one of the most common error we have: 403, 404, 500 or 503
- change the status number in app-routing.module.ts from 418 to another one (e.g. 403, 404, 500 or 503) to see the different error pages
Test the implementation of error handler:
- run the app and turn off knora-stack (error 500) or at least fuseki (error 503): it should show a full-size "Service unavailable" error message
- turn on knora-stack or fuseki again and press "reload page" link in the error message and it should load the page again
- with turned-off fuseki the only page that works is the /help page because there we do not do db-relevant requests.

Comment: We could add a link to https://status.dasch.swiss in one of the error 5xx page. So, user will see what's going on on the server. At the moment this service is only implemented for the prod server and not yet for the test (or staging) server which would be https://status.test.dasch.swiss (https://status.staging.dasch.swiss). Btw with this status page the ops-developer team will be informed when a service doesn't run anymore. So, we don't need a contact button anymore on the server error page to send this kind of error report.

mpro7 · 2021-01-11T14:25:35Z

Before you get the error page it is possible to see for milliseconds the page under it, with loading animation and snackbar initiated too I think. Here is the recording:

Screen.Recording.2021-01-11.at.15.20.51.copy.mov

mpro7

Seems ok for me. Only that blinking thing while loading the error page I've mentioned in previous comment. If not easy thing to fix, might be moved to another task/bug.

mpro7 · 2021-01-11T14:49:32Z

src/assets/style/_elements.scss

@@ -540,7 +540,7 @@ $gc-small: $form-width - $gc-large - 4;

 .cdk-overlay-pane {
  .mat-dialog-container {
-    max-height: 80vh !important;
+    // max-height: 80vh !important;


why not to remove?

wasn't sure if we still need it and we have to fix the height in another way. But yes, let's delete this line 😉

done in 924fc3d

…thub.com/dasch-swiss/dsp-app into wip/dsp-710-handle-internal-server-error

kilchenmann · 2021-01-12T05:02:51Z

Before you get the error page it is possible to see for milliseconds the page under it, with loading animation and snackbar initiated too I think. Here is the recording:

Screen.Recording.2021-01-11.at.15.20.51.copy.mov

Yes, I know this issue. For the moment we have to live with it. As you written above, it would be complicated to solve it in a quick way. This full-screen error page opens only in case of server errors. I hope, that we'll not have too many server errors 😆🙈
We should solve it in a separate task...

flavens

it looks good but I strongly suggest that Mike checks the error messages.

mpro7 · 2021-01-12T08:04:59Z

Before you get the error page it is possible to see for milliseconds the page under it, with loading animation and snackbar initiated too I think. Here is the recording:
Screen.Recording.2021-01-11.at.15.20.51.copy.mov

Yes, I know this issue. For the moment we have to live with it. As you written above, it would be complicated to solve it in a quick way. This full-screen error page opens only in case of server errors. I hope, that we'll not have too many server errors 😆🙈
We should solve it in a separate task...

Ok, could you please create the task if not already did.

kilchenmann · 2021-01-12T08:10:15Z

it looks good but I strongly suggest that Mike checks the error messages.

As @flavens suggested: @mdelez can you check the error messages? Thanks!
Btw. the messages:
500: "An error has occured in a server side script, a no more specific message is suitable"
and
503: "The server is currently unavailable (overloaded or down)"
are taken from our http status codes from dsp-ui-lib. I downloaded this list a few years ago from Wikipedia. Maybe using this description doesn't make much sense.

kilchenmann · 2021-01-12T08:26:04Z

src/app/main/error/error.component.ts

+    errorMessages: ErrorMsg[] = [
+        {
+            status: 0,
+            message: "Undefined Error",
+            description: `Maybe I'm a teapot, maybe not.<br>
+            But anyway, something undefined went wrong.`,
+            action: 'goback',
+            image: 'dsp-error.svg'
+        },
+        {
+            status: 403,
+            message: "Forbidden",
+            description: `This is not the content you were looking for.<br>
+            Your request was valid but you do not have the<br>
+            necessary permissions to access it.`,
+            action: 'goback',
+            image: 'dsp-error-403.svg'
+        },
+        {
+            status: 404,
+            message: "Not found",
+            description: `This is not the content you were looking for.<br>
+            But we couldn't find anything with this request.`,
+            action: 'goback',
+            image: 'dsp-error-404.svg'
+        },
+        {
+            status: 500,
+            message: "Internal Server Error",
+            description: `The DaSCH Service Platform is not available at the moment.<br>
+            An error has occured in a server side script, a no more specific message is suitable.`,
+            action: 'reload',
+            image: 'dsp-error-500.svg'
+        },
+        {
+            status: 503,
+            message: "Service unavailable",
+            description: `The DaSCH Service Platform is not available at the moment.<br>
+            The server is currently unavailable (overloaded or down).`,
+            action: 'reload',
+            image: 'dsp-error-503.svg'
+        }
+    ];


@mdelez Here are the error messages defined...

mdelez

Wording improvements :)

src/app/main/error/error.component.ts

kilchenmann · 2021-01-12T09:17:57Z

It seems that the tests failing from time to time. The problem is the dialog box:
Error: Found the synthetic listener @dialogContainer.start. Please include either "BrowserAnimationsModule" or "NoopAnimationsModule" in your application. I'll add the suggested module now.

mpro7 · 2021-01-12T09:38:29Z

@kilchenmann did adding the module in a49b63f help? Because it seems test failed again.
EDIT:
Ok. I see new task to solve this issue: DSP-1202. Thanks!

kilchenmann added 9 commits January 9, 2021 11:14

chore: Update package-lock.json

2b37432

chore(error): Add fake error page (easteregg)

df7e361

feat(error): Clean up error component

dea147f

style(error): New (and renamed) error status images

7045a37

feat(error): Error handler to switch between error notifications

da5be31

chore(error): Use new error handler

1fb926c

refactor(error): Add new errorhandler everywhere

f85faa1

test(error): Fix tests to use new error handler

deafb13

test(error): Fix tests to use new error handler

32122c6

kilchenmann self-assigned this Jan 9, 2021

kilchenmann added enhancement New feature or request refactor Refactor or redesign labels Jan 9, 2021

kilchenmann mentioned this pull request Jan 9, 2021

DSP-710 Show service unavailable in case of api error #311

Closed

fix: Increase maximum budget for initial-es5

d98a310

kilchenmann requested review from flavens and mpro7 January 10, 2021 07:59

mpro7 approved these changes Jan 11, 2021

View reviewed changes

mpro7 and others added 4 commits January 11, 2021 16:43

chore: fix pr template

16b7519

refactor(style): delete commented line

924fc3d

Merge branch 'wip/dsp-710-handle-internal-server-error' of https://gi…

d3e678b

…thub.com/dasch-swiss/dsp-app into wip/dsp-710-handle-internal-server-error

Merge branch 'main' into wip/dsp-710-handle-internal-server-error

e89e3af

flavens approved these changes Jan 12, 2021

View reviewed changes

kilchenmann requested a review from mdelez January 12, 2021 08:08

kilchenmann commented Jan 12, 2021

View reviewed changes

mdelez requested changes Jan 12, 2021

View reviewed changes

src/app/main/error/error.component.ts Outdated Show resolved Hide resolved

src/app/main/error/error.component.ts Outdated Show resolved Hide resolved

src/app/main/error/error.component.ts Outdated Show resolved Hide resolved

chore(error): Update error messages

686f1ce

test(error): Add missing modules

a49b63f

kilchenmann requested review from mdelez and mpro7 January 12, 2021 09:34

Merge branch 'main' into wip/dsp-710-handle-internal-server-error

e2254ec

mpro7 approved these changes Jan 12, 2021

View reviewed changes

mdelez approved these changes Jan 12, 2021

View reviewed changes

kilchenmann merged commit d5b77bf into main Jan 12, 2021

kilchenmann deleted the wip/dsp-710-handle-internal-server-error branch January 12, 2021 12:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(error): Server error handler (DSP-710) #355

feat(error): Server error handler (DSP-710) #355

kilchenmann commented Jan 9, 2021 •

edited

mpro7 commented Jan 11, 2021 •

edited

mpro7 left a comment

mpro7 Jan 11, 2021

kilchenmann Jan 12, 2021

kilchenmann Jan 12, 2021

kilchenmann commented Jan 12, 2021

flavens left a comment •

edited

mpro7 commented Jan 12, 2021

kilchenmann commented Jan 12, 2021 •

edited

kilchenmann Jan 12, 2021

mdelez left a comment

kilchenmann commented Jan 12, 2021

mpro7 commented Jan 12, 2021 •

edited

feat(error): Server error handler (DSP-710) #355

feat(error): Server error handler (DSP-710) #355

Conversation

kilchenmann commented Jan 9, 2021 • edited

mpro7 commented Jan 11, 2021 • edited

mpro7 left a comment

Choose a reason for hiding this comment

mpro7 Jan 11, 2021

Choose a reason for hiding this comment

kilchenmann Jan 12, 2021

Choose a reason for hiding this comment

kilchenmann Jan 12, 2021

Choose a reason for hiding this comment

kilchenmann commented Jan 12, 2021

flavens left a comment • edited

Choose a reason for hiding this comment

mpro7 commented Jan 12, 2021

kilchenmann commented Jan 12, 2021 • edited

kilchenmann Jan 12, 2021

Choose a reason for hiding this comment

mdelez left a comment

Choose a reason for hiding this comment

kilchenmann commented Jan 12, 2021

mpro7 commented Jan 12, 2021 • edited

kilchenmann commented Jan 9, 2021 •

edited

mpro7 commented Jan 11, 2021 •

edited

flavens left a comment •

edited

kilchenmann commented Jan 12, 2021 •

edited

mpro7 commented Jan 12, 2021 •

edited