feat: add biz handler

.gitignore

@@ -3,3 +3,4 @@ npm-debug.log
 node_modules/
 coverage/
 run/
+.nyc_output/

agent.js

@@ -1,8 +1,13 @@
 'use strict';
 
-module.exports = agent => {
-  // should watch error event
-  agent.on('error', err => {
-    agent.coreLogger.error(err);
-  });
+module.exports = class {
+  constructor(agent) {
+    this.agent = agent;
+  }
+  configDidLoad() {
+    // should watch error event
+    this.agent.on('error', err => {
+      this.agent.coreLogger.error(err);
+    });
+  }
 };

app.js

@@ -11,140 +11,149 @@ const {
   accepts,
 } = require('./lib/utils');
 
-module.exports = app => {
-  // logging error
-  const config = app.config.onerror;
-  const viewTemplate = fs.readFileSync(config.templatePath, 'utf8');
-
-  app.on('error', (err, ctx) => {
-    ctx = ctx || app.createAnonymousContext();
-    if (config.appErrorFilter && !config.appErrorFilter(err, ctx)) return;
-
-    const status = detectStatus(err);
-    // 5xx
-    if (status >= 500) {
+module.exports = class {
+  constructor(app) {
+    this.app = app;
+  }
+  configDidLoad() {
+    const app = this.app;
+
+    app.config.coreMiddleware.push('eggOnerrorHandler');
+
+    // logging error
+    const config = app.config.onerror;
+    const viewTemplate = fs.readFileSync(config.templatePath, 'utf8');
+
+    app.on('error', (err, ctx) => {
+      ctx = ctx || app.createAnonymousContext();
+      if (config.appErrorFilter && !config.appErrorFilter(err, ctx)) return;
+
+      const status = detectStatus(err);
+      // 5xx
+      if (status >= 500) {
+        try {
+          ctx.logger.error(err);
+        } catch (ex) {
+          app.logger.error(err);
+          app.logger.error(ex);
+        }
+        return;
+      }
+
+      // 4xx
       try {
-        ctx.logger.error(err);
+        ctx.logger.warn(err);
       } catch (ex) {
-        app.logger.error(err);
+        app.logger.warn(err);
         app.logger.error(ex);
       }
-      return;
-    }
-
-    // 4xx
-    try {
-      ctx.logger.warn(err);
-    } catch (ex) {
-      app.logger.warn(err);
-      app.logger.error(ex);
-    }
-  });
-
-  const errorOptions = {
-    // support customize accepts function
-    accepts() {
-      const fn = config.accepts || accepts;
-      return fn(this);
-    },
-
-    html(err) {
-      const status = detectStatus(err);
-      const errorPageUrl = typeof config.errorPageUrl === 'function'
-        ? config.errorPageUrl(err, this)
-        : config.errorPageUrl;
-
-      // keep the real response status
-      this.realStatus = status;
-      // don't respond any error message in production env
-      if (isProd(app)) {
-        // 5xx
-        if (status >= 500) {
-          if (errorPageUrl) {
-            const statusQuery =
-              (errorPageUrl.indexOf('?') > 0 ? '&' : '?') +
-              `real_status=${status}`;
-            return this.redirect(errorPageUrl + statusQuery);
+    });
+
+    const errorOptions = {
+      // support customize accepts function
+      accepts(...args) {
+        const fn = config.accepts || accepts;
+        return fn(this, ...args);
+      },
+
+      html(err) {
+        const status = detectStatus(err);
+        const errorPageUrl = typeof config.errorPageUrl === 'function'
+          ? config.errorPageUrl(err, this)
+          : config.errorPageUrl;
+
+        // keep the real response status
+        this.realStatus = status;
+        // don't respond any error message in production env
+        if (isProd(app)) {
+          // 5xx
+          if (status >= 500) {
+            if (errorPageUrl) {
+              const statusQuery =
+                (errorPageUrl.indexOf('?') > 0 ? '&' : '?') +
+                `real_status=${status}`;
+              return this.redirect(errorPageUrl + statusQuery);
+            }
+            this.status = 500;
+            this.body = `<h2>Internal Server Error, real status: ${status}</h2>`;
+            return;
           }
-          this.status = 500;
-          this.body = `<h2>Internal Server Error, real status: ${status}</h2>`;
+          // 4xx
+          this.status = status;
+          this.body = `<h2>${status} ${http.STATUS_CODES[status]}</h2>`;
+          return;
+        }
+        // show simple error format for unittest
+        if (app.config.env === 'unittest') {
+          this.status = status;
+          this.body = `${err.name}: ${err.message}\n${err.stack}`;
           return;
         }
-        // 4xx
-        this.status = status;
-        this.body = `<h2>${status} ${http.STATUS_CODES[status]}</h2>`;
-        return;
-      }
-      // show simple error format for unittest
-      if (app.config.env === 'unittest') {
-        this.status = status;
-        this.body = `${err.name}: ${err.message}\n${err.stack}`;
-        return;
-      }
-
-      const errorView = new ErrorView(this, err, viewTemplate);
-      this.body = errorView.toHTML();
-    },
 
-    json(err) {
-      const status = detectStatus(err);
-      let errorJson = {};
+        const errorView = new ErrorView(this, err, viewTemplate);
+        this.body = errorView.toHTML();
+      },
 
-      this.status = status;
-      const code = err.code || err.type;
-      const message = detectErrorMessage(this, err);
+      json(err) {
+        const status = detectStatus(err);
+        let errorJson = {};
 
-      if (isProd(app)) {
-        // 5xx server side error
-        if (status >= 500) {
-          errorJson = {
-            code,
-            // don't respond any error message in production env
-            message: http.STATUS_CODES[status],
-          };
+        this.status = status;
+        const code = err.code || err.type;
+        const message = detectErrorMessage(this, err);
+
+        if (isProd(app)) {
+          // 5xx server side error
+          if (status >= 500) {
+            errorJson = {
+              code,
+              // don't respond any error message in production env
+              message: http.STATUS_CODES[status],
+            };
+          } else {
+            // 4xx client side error
+            // addition `errors`
+            errorJson = {
+              code,
+              message,
+              errors: err.errors,
+            };
+          }
         } else {
-          // 4xx client side error
-          // addition `errors`
           errorJson = {
             code,
             message,
             errors: err.errors,
           };
-        }
-      } else {
-        errorJson = {
-          code,
-          message,
-          errors: err.errors,
-        };
-
-        if (status >= 500) {
-          // provide detail error stack in local env
-          errorJson.stack = err.stack;
-          errorJson.name = err.name;
-          for (const key in err) {
-            if (!errorJson[key]) {
-              errorJson[key] = err[key];
+
+          if (status >= 500) {
+            // provide detail error stack in local env
+            errorJson.stack = err.stack;
+            errorJson.name = err.name;
+            for (const key in err) {
+              if (!errorJson[key]) {
+                errorJson[key] = err[key];
+              }
             }
           }
         }
-      }
 
-      this.body = errorJson;
-    },
+        this.body = errorJson;
+      },
 
-    js(err) {
-      errorOptions.json.call(this, err, this);
+      js(err) {
+        errorOptions.json.call(this, err, this);
 
-      if (this.createJsonpBody) {
-        this.createJsonpBody(this.body);
-      }
-    },
-  };
-
-  // support customize error response
-  [ 'all', 'html', 'json', 'text', 'js' ].forEach(type => {
-    if (config[type]) errorOptions[type] = config[type];
-  });
-  onerror(app, errorOptions);
+        if (this.createJsonpBody) {
+          this.createJsonpBody(this.body);
+        }
+      },
+    };
+
+    // support customize error response
+    [ 'all', 'html', 'json', 'text', 'js' ].forEach(type => {
+      if (config[type]) errorOptions[type] = config[type];
+    });
+    onerror(app, errorOptions);
+  }
 };

app/middleware/egg_onerror_handler.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const { EggError, ErrorType, InternalServerError } = require('egg-errors');
+const accepts = require('accepts');
+
+class UnknownError extends InternalServerError {
+  constructor(message) {
+    super(message);
+    this.message = message;
+    this.code = 'UNKNOWN_ERROR';
+  }
+}
+
+module.exports = (_, app) => {
+  const errorHandler = app.config.onerror.errorHandler;
+  const acceptContentType = app.config.onerror.accepts ||
+    ((ctx, ...args) => accepts(ctx.req).type(args));
+
+  return async function bizErrorHandler(ctx, next) {
+    if (errorHandler.enable !== true) return next();
+
+    try {
+      await next();
+    } catch (e) {
+      let err = e;
+      const errorType = EggError.getType(err);
+      switch (errorType) {
+        case ErrorType.ERROR: break;
+
+        // if error is an EggError Exception, it will pring error log
+        case ErrorType.EXCEPTION: {
+          ctx.logger.error(err);
+          // force set error status
+          err.status = 500;
+          break;
+        }
+
+        // if error is not recognized by EggError,
+        // it will be converted to UnknownError
+        case ErrorType.BUILTIN: {
+          err = UnknownError.from(err);
+          ctx.logger.error(err);
+          break;
+        }
+
+        // getType not work
+        default:
+      }
+
+      // handle the error
+      const contentType = acceptContentType(ctx, 'html', 'text', 'json');
+
+      if (contentType === 'json' && errorHandler.json) {
+        await errorHandler.json(ctx, err);
+      } else if (contentType === 'text' && errorHandler.text) {
+        await errorHandler.text(ctx, err);
+      } else if (contentType === 'html' && errorHandler.html) {
+        await errorHandler.html(ctx, err);
+      } else if (errorHandler.any) {
+        await errorHandler.any(ctx, err);
+      } else {
+        throw err;
+      }
+    }
+  };
+};

config/config.default.js

@@ -11,4 +11,12 @@ exports.onerror = {
   appErrorFilter: null,
   // default template path
   templatePath: path.join(__dirname, '../lib/onerror_page.mustache'),
+  // handler your error response
+  errorHandler: {
+    enable: false,
+    json: null,
+    text: null,
+    html: null,
+    any: null,
+  },
 };

package.json

@@ -24,19 +24,21 @@
     "onerror"
   ],
   "dependencies": {
+    "accepts": "^1.3.5",
     "cookie": "^0.3.1",
-    "koa-onerror": "^4.0.0",
-    "mustache": "^2.3.0",
+    "egg-errors": "^2.1.0",
+    "koa-onerror": "^4.1.0",
+    "mustache": "^3.0.1",
     "stack-trace": "^0.0.10"
   },
   "devDependencies": {
-    "autod": "^3.0.0",
+    "autod": "^3.0.1",
     "egg": "next",
-    "egg-bin": "^4.3.5",
-    "egg-ci": "^1.8.0",
-    "egg-mock": "^3.13.1",
-    "eslint": "^4.11.0",
-    "eslint-config-egg": "^5.1.1",
+    "egg-bin": "^4.9.0",
+    "egg-ci": "^1.11.0",
+    "egg-mock": "^3.21.0",
+    "eslint": "^5.11.1",
+    "eslint-config-egg": "^7.1.0",
     "pedding": "^1.1.0",
     "rimraf": "^2.6.2"
   },