forked from outline/outline
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enhance server side error handling (outline#4537)
* fix: server side error handling * fix: push only unknown 500 errors to sentry * fix: use in-house onerror in favor of errorHandling middleware * fix: split error template into dev and prod envs * fix: check Error instance * fix: error routes in test env * fix: review comments * Remove koa-onerror Co-authored-by: Tom Moor <tom.moor@gmail.com>
- Loading branch information
1 parent
4f67437
commit 053d10d
Showing
17 changed files
with
319 additions
and
78 deletions.
There are no files selected for viewing
This file contains 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 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 was deleted.
Oops, something went wrong.
This file contains 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,194 @@ | ||
| import fs from "fs"; | ||
| import http from "http"; | ||
| import path from "path"; | ||
| import Koa, { Context } from "koa"; | ||
| import { isNil, escape, snakeCase } from "lodash"; | ||
| import { ValidationError, EmptyResultError } from "sequelize"; | ||
| import env from "@server/env"; | ||
| import { InternalError } from "@server/errors"; | ||
| import { requestErrorHandler } from "@server/logging/sentry"; | ||
|
|
||
| const isDev = env.ENVIRONMENT === "development"; | ||
| const isProd = env.ENVIRONMENT === "production"; | ||
| let errorHtmlCache: Buffer | undefined; | ||
|
|
||
| const readErrorFile = (): Buffer => { | ||
| if (isDev) { | ||
| return ( | ||
| errorHtmlCache ?? | ||
| (errorHtmlCache = fs.readFileSync(path.join(__dirname, "error.dev.html"))) | ||
| ); | ||
| } | ||
|
|
||
| if (isProd) { | ||
| return ( | ||
| errorHtmlCache ?? | ||
| (errorHtmlCache = fs.readFileSync( | ||
| path.join(__dirname, "error.prod.html") | ||
| )) | ||
| ); | ||
| } | ||
|
|
||
| return ( | ||
| errorHtmlCache ?? | ||
| (errorHtmlCache = fs.readFileSync( | ||
| path.join(__dirname, "static/error.dev.html") | ||
| )) | ||
| ); | ||
| }; | ||
|
|
||
| export default function onerror(app: Koa) { | ||
| app.context.onerror = function (err: any) { | ||
| // Don't do anything if there is no error, this allows you to pass `this.onerror` to node-style callbacks. | ||
| if (isNil(err)) { | ||
| return; | ||
| } | ||
|
|
||
| // When dealing with cross-globals a normal `instanceof` check doesn't work properly. | ||
| // See https://github.com/koajs/koa/issues/1466 | ||
| // We can probably remove it once jest fixes https://github.com/facebook/jest/issues/2549. | ||
| const isNativeError = | ||
| Object.prototype.toString.call(err) === "[object Error]" || | ||
| err instanceof Error; | ||
|
|
||
| // wrap non-error object | ||
| if (!isNativeError) { | ||
| let errMsg = err; | ||
| if (typeof err === "object") { | ||
| try { | ||
| errMsg = JSON.stringify(err); | ||
| // eslint-disable-next-line no-empty | ||
| } catch (e) {} | ||
| } | ||
| const newError = InternalError(`non-error thrown: ${errMsg}`); | ||
| // err maybe an object, try to copy the name, message and stack to the new error instance | ||
| if (err) { | ||
| if (err.name) { | ||
| newError.name = err.name; | ||
| } | ||
| if (err.message) { | ||
| newError.message = err.message; | ||
| } | ||
| if (err.stack) { | ||
| newError.stack = err.stack; | ||
| } | ||
| if (err.status) { | ||
| newError.status = err.status; | ||
| } | ||
| if (err.headers) { | ||
| newError.headers = err.headers; | ||
| } | ||
| } | ||
| err = newError; | ||
| } | ||
|
|
||
| if (err.code === "ENOENT") { | ||
| err.status = 404; | ||
| } | ||
|
|
||
| if (typeof err.status !== "number" || !http.STATUS_CODES[err.status]) { | ||
| err.status = 500; | ||
| } | ||
|
|
||
| // Push only unknown 500 errors to sentry | ||
| if (err.status === 500) { | ||
| requestErrorHandler(err, this); | ||
| } | ||
|
|
||
| const headerSent = this.headerSent || !this.writable; | ||
| if (headerSent) { | ||
| err.headerSent = true; | ||
| } | ||
|
|
||
| // Nothing we can do here other than delegate to the app-level handler and log. | ||
| if (headerSent) { | ||
| return; | ||
| } | ||
|
|
||
| this.status = err.status; | ||
|
|
||
| this.set(err.headers); | ||
| const type = this.accepts("json", "html") || "json"; | ||
| if (type === "html") { | ||
| html.call(this, err, this); | ||
| } else { | ||
| json.call(this, err, this); | ||
| } | ||
| this.type = type; | ||
|
|
||
| if (type === "json") { | ||
| this.body = JSON.stringify(this.body); | ||
| } | ||
| this.res.end(this.body); | ||
| }; | ||
|
|
||
| return app; | ||
| } | ||
|
|
||
| /** | ||
| * Handle errors for json requests. | ||
| * | ||
| * @param err The error being handled. | ||
| * @param ctx The request context. | ||
| */ | ||
|
|
||
| function json(err: any, ctx: Context) { | ||
| ctx.status = err.status; | ||
| let message = err.message || err.name; | ||
| let error; | ||
|
|
||
| if (err instanceof ValidationError) { | ||
| // super basic form error handling | ||
| ctx.status = 400; | ||
|
|
||
| if (err.errors && err.errors[0]) { | ||
| message = `${err.errors[0].message} (${err.errors[0].path})`; | ||
| } | ||
| } | ||
|
|
||
| if (err instanceof EmptyResultError || /Not found/i.test(message)) { | ||
| message = "Resource not found"; | ||
| ctx.status = 404; | ||
| error = "not_found"; | ||
| } | ||
|
|
||
| if (/Authorization error/i.test(message)) { | ||
| ctx.status = 403; | ||
| error = "authorization_error"; | ||
| } | ||
|
|
||
| if (ctx.status === 500) { | ||
| message = "Internal server error"; | ||
| error = "internal_server_error"; | ||
| } | ||
|
|
||
| ctx.body = { | ||
| ok: false, | ||
| error: snakeCase(err.id || error), | ||
| status: ctx.status, | ||
| message, | ||
| data: err.errorData, | ||
| }; | ||
|
|
||
| // @ts-expect-error ts-migrate(2571) FIXME: Object is of type 'unknown'. | ||
| if (!ctx.body.data) { | ||
| // @ts-expect-error ts-migrate(2571) FIXME: Object is of type 'unknown'. | ||
| delete ctx.body.data; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Handle errors for html requests. | ||
| * | ||
| * @param err The error being handled. | ||
| * @param ctx The request context. | ||
| */ | ||
|
|
||
| function html(err: any, ctx: Context) { | ||
| const page = readErrorFile(); | ||
| ctx.body = page | ||
| .toString() | ||
| .replace(/\/\/inject-status\/\//g, escape(err.status)) | ||
| .replace(/\/\/inject-stack\/\//g, escape(err.stack)); | ||
| ctx.type = "html"; | ||
| } |
This file contains 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 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 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 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.