@midwayjs/koa 3.0.0-beta.6 → 3.0.0

package/dist/onerror.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupOnerror = void 0;
+const http = require("http");
+const utils_1 = require("./utils");
+function setupOnerror(app, config, logger) {
+    const errorOptions = Object.assign({
+        // support customize accepts function
+        accepts() {
+            const fn = config.accepts || utils_1.accepts;
+            return fn(this);
+        },
+        /**
+         * default text error handler
+         * @param {Error} err
+         * @param ctx
+         */
+        text(err, ctx) {
+            // unset all headers, and set those specified
+            ctx.res._headers = {};
+            ctx.set(err.headers);
+            if ((0, utils_1.isProduction)(app)) {
+                ctx.body = http.STATUS_CODES[ctx.status];
+            }
+            else {
+                ctx.body = err.message;
+            }
+        },
+        /**
+         * default html error handler
+         * @param {Error} err
+         */
+        html(err, ctx) {
+            const status = (0, utils_1.detectStatus)(err);
+            if ((0, utils_1.isProduction)(app)) {
+                // 5xx
+                if (status >= 500) {
+                    ctx.status = 500;
+                    ctx.body = `<h2>Internal Server Error, real status: ${status}</h2>`;
+                    return;
+                }
+                else {
+                    // 4xx
+                    ctx.status = status;
+                    ctx.body = `<h2>${status} ${http.STATUS_CODES[status]}</h2>`;
+                    return;
+                }
+            }
+            // show simple error format for unittest
+            if (app.getEnv() === 'unittest' || app.getEnv() === 'test') {
+                ctx.status = status;
+                ctx.body = `${err.name}: ${err.message}\n${err.stack}`;
+                return;
+            }
+            ctx.body = utils_1.tpl
+                .replace('{{status}}', (0, utils_1.escapeHtml)(err.status))
+                .replace('{{stack}}', (0, utils_1.escapeHtml)(err.stack));
+            ctx.type = 'html';
+        },
+        /**
+         * default json error handler
+         * @param {Error} err
+         * @param ctx
+         */
+        json(err, ctx) {
+            const status = (0, utils_1.detectStatus)(err);
+            const code = err.code || err.type;
+            if ((0, utils_1.isProduction)(app)) {
+                if (status >= 500) {
+                    ctx.body = { code, message: http.STATUS_CODES[status] };
+                }
+                else {
+                    ctx.body = { code, message: err.message };
+                }
+            }
+            else {
+                ctx.body = { code, message: err.message, stack: err.stack };
+            }
+        },
+    }, config);
+    app.on('error', (err, ctx) => {
+        ctx = ctx || app.createAnonymousContext();
+        const status = (0, utils_1.detectStatus)(err);
+        // 5xx
+        if (status >= 500) {
+            try {
+                ctx.logger.error(err);
+            }
+            catch (ex) {
+                logger.error(err);
+                logger.error(ex);
+            }
+            return;
+        }
+        // 4xx
+        try {
+            ctx.logger.warn(err);
+        }
+        catch (ex) {
+            logger.warn(err);
+            logger.error(ex);
+        }
+    });
+    app.context.onerror = function (err) {
+        // don't do anything if there is no error.
+        // this allows you to pass `this.onerror`
+        // to node-style callbacks.
+        if (err == null)
+            return;
+        // ignore all pedding request stream
+        if (this.req)
+            (0, utils_1.sendToWormhole)(this.req);
+        // wrap non-error object
+        if (!(err instanceof Error)) {
+            const newError = new Error('non-error thrown: ' + err);
+            // 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;
+        }
+        const headerSent = this.headerSent || !this.writable;
+        if (headerSent)
+            err.headerSent = true;
+        // delegate
+        app.emit('error', err, this);
+        // nothing we can do here other
+        // than delegate to the app-level
+        // handler and log.
+        if (headerSent)
+            return;
+        // ENOENT support
+        if (err.code === 'ENOENT')
+            err.status = 404;
+        if (typeof err.status !== 'number' || !http.STATUS_CODES[err.status]) {
+            err.status = 500;
+        }
+        this.status = err.status;
+        this.set(err.headers);
+        let type = 'text';
+        if (errorOptions.accepts) {
+            type = errorOptions.accepts.call(this, 'html', 'text', 'json');
+        }
+        else {
+            type = this.accepts('html', 'text', 'json');
+        }
+        type = type || 'text';
+        if (errorOptions.all) {
+            errorOptions.all.call(this, err, this);
+        }
+        else {
+            if (errorOptions.redirect && type !== 'json') {
+                this.redirect(errorOptions.redirect);
+            }
+            else {
+                errorOptions[type].call(this, err, this);
+                this.type = type;
+            }
+        }
+        if (type === 'json') {
+            this.body = JSON.stringify(this.body);
+        }
+        this.res.end(this.body);
+    };
+}
+exports.setupOnerror = setupOnerror;
+//# sourceMappingURL=onerror.js.map

package/dist/utils.d.ts

@@ -0,0 +1,14 @@
+export declare function detectStatus(err: any): any;
+export declare function accepts(ctx: any): "json" | "js" | "html";
+export declare function sendToWormhole(stream: any): Promise<void>;
+export declare function isProduction(app: any): boolean;
+export declare const tpl = "\n<!DOCTYPE html>\n<html>\n  <head>\n    <title>Error - {{status}}</title>\n    <meta name=\"viewport\" content=\"user-scalable=no, width=device-width, initial-scale=1.0, maximum-scale=1.0\">\n\n    <style>\n      body {\n        padding: 50px 80px;\n        font: 14px \"Helvetica Neue\", Helvetica, sans-serif;\n      }\n\n      h1 {\n        font-size: 2em;\n        margin-bottom: 5px;\n      }\n\n      pre {\n        font-size: .8em;\n      }\n    </style>\n  </head>\n  <body>\n    <div id=\"error\">\n      <h1>Error</h1>\n      <p>Looks like something broke!</p>\n      <pre>\n        <code>\n{{stack}}\n        </code>\n      </pre>\n    </div>\n  </body>\n</html>";
+/**
+ * Escape special characters in the given string of text.
+ *
+ * @param  {string} string The string to escape for inserting into HTML
+ * @return {string}
+ * @public
+ */
+export declare function escapeHtml(string: any): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeHtml = exports.tpl = exports.isProduction = exports.sendToWormhole = exports.accepts = exports.detectStatus = void 0;
+function detectStatus(err) {
+    // detect status
+    let status = err.status || 500;
+    if (status < 200) {
+        // invalid status consider as 500, like urllib will return -1 status
+        status = 500;
+    }
+    return status;
+}
+exports.detectStatus = detectStatus;
+function accepts(ctx) {
+    if (ctx.acceptJSON)
+        return 'json';
+    if (ctx.acceptJSONP)
+        return 'js';
+    return 'html';
+}
+exports.accepts = accepts;
+function sendToWormhole(stream) {
+    return new Promise(resolve => {
+        if (typeof stream.resume !== 'function') {
+            return resolve();
+        }
+        // unpipe it
+        stream.unpipe && stream.unpipe();
+        // enable resume first
+        stream.resume();
+        if (stream._readableState && stream._readableState.ended) {
+            return resolve();
+        }
+        if (!stream.readable || stream.destroyed) {
+            return resolve();
+        }
+        function cleanup() {
+            stream.removeListener('end', onEnd);
+            stream.removeListener('close', onEnd);
+            stream.removeListener('error', onError);
+        }
+        function onEnd() {
+            cleanup();
+            resolve();
+        }
+        function onError() {
+            cleanup();
+            resolve();
+        }
+        stream.on('end', onEnd);
+        stream.on('close', onEnd);
+        stream.on('error', onError);
+    });
+}
+exports.sendToWormhole = sendToWormhole;
+function isProduction(app) {
+    return app.getEnv() !== 'local' && app.getEnv() !== 'unittest';
+}
+exports.isProduction = isProduction;
+exports.tpl = `
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Error - {{status}}</title>
+    <meta name="viewport" content="user-scalable=no, width=device-width, initial-scale=1.0, maximum-scale=1.0">
+
+    <style>
+      body {
+        padding: 50px 80px;
+        font: 14px "Helvetica Neue", Helvetica, sans-serif;
+      }
+
+      h1 {
+        font-size: 2em;
+        margin-bottom: 5px;
+      }
+
+      pre {
+        font-size: .8em;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="error">
+      <h1>Error</h1>
+      <p>Looks like something broke!</p>
+      <pre>
+        <code>
+{{stack}}
+        </code>
+      </pre>
+    </div>
+  </body>
+</html>`;
+const matchHtmlRegExp = /["'&<>]/;
+/**
+ * Escape special characters in the given string of text.
+ *
+ * @param  {string} string The string to escape for inserting into HTML
+ * @return {string}
+ * @public
+ */
+function escapeHtml(string) {
+    const str = '' + string;
+    const match = matchHtmlRegExp.exec(str);
+    if (!match) {
+        return str;
+    }
+    let escape;
+    let html = '';
+    let index = 0;
+    let lastIndex = 0;
+    for (index = match.index; index < str.length; index++) {
+        switch (str.charCodeAt(index)) {
+            case 34: // "
+                escape = '&quot;';
+                break;
+            case 38: // &
+                escape = '&amp;';
+                break;
+            case 39: // '
+                escape = '&#39;';
+                break;
+            case 60: // <
+                escape = '&lt;';
+                break;
+            case 62: // >
+                escape = '&gt;';
+                break;
+            default:
+                continue;
+        }
+        if (lastIndex !== index) {
+            html += str.substring(lastIndex, index);
+        }
+        lastIndex = index + 1;
+        html += escape;
+    }
+    return lastIndex !== index ? html + str.substring(lastIndex, index) : html;
+}
+exports.escapeHtml = escapeHtml;
+//# sourceMappingURL=utils.js.map

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@midwayjs/koa",
-  "version": "3.0.0-beta.6",
+  "version": "3.0.0",
   "description": "Midway Web Framework for KOA",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
-    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
     "ci": "npm run test"
   },
   "keywords": [
@@ -23,21 +23,20 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.0.0-beta.6",
-    "@midwayjs/mock": "^3.0.0-beta.6",
-    "@midwayjs/validate": "^3.0.0-beta.6",
-    "@types/koa": "^2.11.4",
-    "@types/koa-router": "^7.4.1",
-    "fs-extra": "^8.0.1",
-    "koa-bodyparser": "^4.3.0",
-    "koa-qs": "^3.0.0"
+    "@midwayjs/decorator": "^3.0.0",
+    "@midwayjs/logger": "2.14.0",
+    "@midwayjs/mock": "^3.0.0",
+    "@types/koa": "2.13.4",
+    "@types/koa-router": "7.4.4",
+    "fs-extra": "10.0.0"
   },
   "dependencies": {
     "@koa/router": "^10.0.0",
-    "@midwayjs/core": "^3.0.0-beta.6",
-    "@midwayjs/logger": "^3.0.0-beta.6",
-    "koa": "^2.13.0",
-    "koa-onerror": "^4.1.0"
+    "@midwayjs/cookies": "1.0.1",
+    "@midwayjs/core": "^3.0.0",
+    "@midwayjs/session": "^3.0.0",
+    "koa": "2.13.4",
+    "koa-bodyparser": "4.3.0"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
   "repository": {
@@ -47,5 +46,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "e4595d30b369e36bef21b36f2b3737d8bc2f802d"
+  "gitHead": "55c26029bccf7bbb739fa1597e8f418dafa2caa0"
 }