@midwayjs/express 3.0.0-beta.11 → 3.0.0-beta.15

package/CHANGELOG.md

@@ -3,6 +3,57 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.15](https://github.com/midwayjs/midway/compare/v3.0.0-beta.14...v3.0.0-beta.15) (2022-01-07)
+
+
+### Bug Fixes
+
+* serverless app run ([#1523](https://github.com/midwayjs/midway/issues/1523)) ([5a25eb7](https://github.com/midwayjs/midway/commit/5a25eb7ebb17bf9b0e2ba4feee5bc1649f70d56f))
+
+
+### Features
+
+* add info middleware ([#1530](https://github.com/midwayjs/midway/issues/1530)) ([7077f1d](https://github.com/midwayjs/midway/commit/7077f1d84355633a1c2fced35bfcc2152f42a7ac))
+* add secret filter ([#1531](https://github.com/midwayjs/midway/issues/1531)) ([ce77e48](https://github.com/midwayjs/midway/commit/ce77e4804aaffc18a0a091d3726e36d7ec1514b2))
+
+
+
+
+
+# [3.0.0-beta.14](https://github.com/midwayjs/midway/compare/v3.0.0-beta.13...v3.0.0-beta.14) (2022-01-04)
+
+
+### Bug Fixes
+
+* cos config definition & 3.x doc update ([#1515](https://github.com/midwayjs/midway/issues/1515)) ([0ac7ac5](https://github.com/midwayjs/midway/commit/0ac7ac5805b7ab8873f8792fc1712a74e3223172))
+
+
+
+
+
+# [3.0.0-beta.13](https://github.com/midwayjs/midway/compare/v3.0.0-beta.12...v3.0.0-beta.13) (2021-12-30)
+
+
+### Features
+
+* 404 error ([#1465](https://github.com/midwayjs/midway/issues/1465)) ([e7e8a9d](https://github.com/midwayjs/midway/commit/e7e8a9dedfa7198ac05b161b41024c2871f93965))
+
+
+
+
+
+# [3.0.0-beta.12](https://github.com/midwayjs/midway/compare/v3.0.0-beta.11...v3.0.0-beta.12) (2021-12-28)
+
+
+### Features
+
+* custom error code & add @Files/@Fields ([#1438](https://github.com/midwayjs/midway/issues/1438)) ([b0032af](https://github.com/midwayjs/midway/commit/b0032afd2fa9ea0416fe69f4bd0c1a58bea5314e))
+* support throw err status ([#1440](https://github.com/midwayjs/midway/issues/1440)) ([7b98110](https://github.com/midwayjs/midway/commit/7b98110d65c5287a8fcb3eb5356dea2d7a32cee9))
+
+
+
+
+
 # [3.0.0-beta.11](https://github.com/midwayjs/midway/compare/v3.0.0-beta.10...v3.0.0-beta.11) (2021-12-21)
 
 **Note:** Version bump only for package @midwayjs/express

package/README.md

@@ -1,6 +1,6 @@
-# midway-web
+# midway for express
 
-[![Package Quality](http://npm.packagequality.com/shield/midway-web.svg)](http://packagequality.com/#?package=midway-web)
+[![Package Quality](http://npm.packagequality.com/shield/@midwayjs/express.svg)](http://packagequality.com/#?package=@midwayjs/express)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/midwayjs/midway/pulls)
 
 this is a sub package for midway.

package/dist/framework.d.ts

@@ -16,7 +16,10 @@ export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpress
      * wrap controller string to middleware function
      */
     protected generateController(routeInfo: RouterInfo): IRouterHandler<any>;
-    loadMidwayController(): Promise<void>;
+    loadMidwayController(): Promise<Array<{
+        prefix: string;
+        middleware: any;
+    }>>;
     /**
      * @param routerOptions
      */
@@ -28,6 +31,5 @@ export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpress
     getServer(): Server;
     getFrameworkName(): string;
     getDefaultContextLoggerClass(): typeof MidwayExpressContextLogger;
-    protected sendData(res: any, data: any): void;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -12,13 +12,19 @@ const decorator_1 = require("@midwayjs/decorator");
 const express = require("express");
 const logger_1 = require("./logger");
 const middlewareService_1 = require("./middlewareService");
+const util_1 = require("util");
+const util_2 = require("./util");
+const debug = (0, util_1.debuglog)('midway:debug');
 let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFramework {
     configure() {
         return this.configService.getConfiguration('express');
     }
     async applicationInitialize(options) {
         this.expressMiddlewareService = await this.applicationContext.getAsync(middlewareService_1.MidwayExpressMiddlewareService, [this.applicationContext]);
+        debug('[express]: create express app');
         this.app = express();
+        debug('[express]: use root middleware');
+        // use root middleware
         this.app.use((req, res, next) => {
             const ctx = req;
             this.app.createAnonymousContext(ctx);
@@ -27,25 +33,71 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
             ctx.requestContext.registerObject('res', res);
             next();
         });
+        this.defineApplicationProperties();
+        // hack use method
+        this.app.originUse = this.app.use;
+        this.app.use = this.app.useMiddleware;
     }
     async run() {
         var _a;
+        debug(`[express]: use middlewares = "${this.getMiddleware().getNames()}"`);
+        // restore use method
+        this.app.use = this.app.originUse;
+        debug('[express]: use user router middleware');
+        // load controller，must apply router filter here
+        const routerMiddlewares = await this.loadMidwayController();
         // use global middleware
         const globalMiddleware = await this.applyMiddleware();
+        debug('[express]: use and apply all framework and global middleware');
         this.app.use(globalMiddleware);
-        // load controller
-        await this.loadMidwayController();
+        // load router after global middleware
+        for (const info of routerMiddlewares) {
+            this.app.use(info.prefix, info.middleware);
+        }
+        debug('[express]: use 404 not found middleware');
+        // eslint-disable-next-line
+        this.app.use(function notFound(req, res, next) {
+            next(new core_1.httpError.NotFoundError());
+        });
+        debug('[express]: use global error handler middleware');
         // use global error handler
-        this.app.use(async (err, req, res, next) => {
-            if (err) {
-                const { result, error } = await this.filterManager.runErrorFilter(err, req, res, next);
+        this.app.use((err, req, res, next) => {
+            this.filterManager
+                .runErrorFilter(err, req, res, next)
+                .then(data => {
+                var _a, _b;
+                const { result, error } = data;
                 if (error) {
+                    const status = (_b = (_a = error.status) !== null && _a !== void 0 ? _a : res.statusCode) !== null && _b !== void 0 ? _b : 500;
+                    // 5xx
+                    if (status >= 500) {
+                        try {
+                            req.logger.error(err);
+                        }
+                        catch (ex) {
+                            this.logger.error(err);
+                            this.logger.error(ex);
+                        }
+                        return;
+                    }
+                    // 4xx
+                    try {
+                        req.logger.warn(err);
+                    }
+                    catch (ex) {
+                        this.logger.warn(err);
+                        this.logger.error(ex);
+                    }
+                    res.status(status);
                     next(error);
                 }
                 else {
-                    this.sendData(res, result);
+                    (0, util_2.sendData)(res, result);
                 }
-            }
+            })
+                .catch(err => {
+                next(err);
+            });
         });
         // https config
         if (this.configurationOptions.key && this.configurationOptions.cert) {
@@ -72,7 +124,7 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         const customPort = (_a = process.env.MIDWAY_HTTP_PORT) !== null && _a !== void 0 ? _a : this.configurationOptions.port;
         if (customPort) {
             new Promise(resolve => {
-                const args = [this.configurationOptions.port];
+                const args = [customPort];
                 if (this.configurationOptions.hostname) {
                     args.push(this.configurationOptions.hostname);
                 }
@@ -91,16 +143,9 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
      * wrap controller string to middleware function
      */
     generateController(routeInfo) {
-        return async (req, res, next) => {
+        return (0, middlewareService_1.wrapAsyncHandler)(async (req, res, next) => {
             const controller = await req.requestContext.getAsync(routeInfo.id);
-            let result;
-            try {
-                result = await controller[routeInfo.method].call(controller, req, res, next);
-            }
-            catch (err) {
-                next(err);
-                return;
-            }
+            const result = await controller[routeInfo.method].call(controller, req, res, next);
             if (res.headersSent) {
                 // return when response send
                 return;
@@ -132,21 +177,24 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
             if (error) {
                 throw error;
             }
-            this.sendData(res, returnValue);
-        };
+            (0, util_2.sendData)(res, returnValue);
+        });
     }
     async loadMidwayController() {
+        var _a, _b;
         const collector = new core_1.WebRouterCollector('', {
             globalPrefix: this.configurationOptions.globalPrefix,
         });
         const routerTable = await collector.getRouterTable();
         const routerList = await collector.getRoutePriorityList();
+        const routerMiddlewares = [];
         for (const routerInfo of routerList) {
             // bind controller first
             this.getApplicationContext().bindClass(routerInfo.routerModule);
             this.logger.debug(`Load Controller "${routerInfo.controllerId}", prefix=${routerInfo.prefix}`);
             // new router
             const newRouter = this.createRouter(routerInfo.routerOptions);
+            routerInfo.middleware = (_a = routerInfo.middleware) !== null && _a !== void 0 ? _a : [];
             // add router middleware
             if (routerInfo.middleware.length) {
                 const routerMiddlewareFn = await this.expressMiddlewareService.compose(routerInfo.middleware, this.app);
@@ -157,6 +205,7 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
             for (const routeInfo of routes) {
                 const routeMiddlewareList = [];
                 // routeInfo middleware
+                routeInfo.middleware = (_b = routeInfo.middleware) !== null && _b !== void 0 ? _b : [];
                 if (routeInfo.middleware.length) {
                     const routeMiddlewareFn = await this.expressMiddlewareService.compose(routeInfo.middleware, this.app);
                     routeMiddlewareList.push(routeMiddlewareFn);
@@ -165,8 +214,12 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
                 // apply controller from request context
                 newRouter[routeInfo.requestMethod].call(newRouter, routeInfo.url, ...routeMiddlewareList, this.generateController(routeInfo));
             }
-            this.app.use(routerInfo.prefix, newRouter);
+            routerMiddlewares.push({
+                prefix: routerInfo.prefix,
+                middleware: newRouter,
+            });
         }
+        return routerMiddlewares;
     }
     /**
      * @param routerOptions
@@ -193,14 +246,6 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
     getDefaultContextLoggerClass() {
         return logger_1.MidwayExpressContextLogger;
     }
-    sendData(res, data) {
-        if (typeof data === 'number') {
-            res.status(res.statusCode).send('' + data);
-        }
-        else {
-            res.status(res.statusCode).send(data);
-        }
-    }
 };
 MidwayExpressFramework = __decorate([
     (0, decorator_1.Framework)()

package/dist/middlewareService.d.ts

@@ -1,11 +1,12 @@
 import { IMidwayContainer, CommonMiddleware, FunctionMiddleware } from '@midwayjs/core';
 import { IMidwayExpressContext, Application } from './interface';
 import { NextFunction, Response } from 'express';
+export declare function wrapAsyncHandler(fn: any): any;
 export declare class MidwayExpressMiddlewareService {
     readonly applicationContext: IMidwayContainer;
     constructor(applicationContext: IMidwayContainer);
     compose(middleware: Array<CommonMiddleware<IMidwayExpressContext, Response, NextFunction> | string>, app: Application, name?: string): Promise<{
-        (req: IMidwayExpressContext, res: Response, next: NextFunction): void;
+        (req: IMidwayExpressContext, res: Response, nextFunction: NextFunction): any;
         _name: string;
     }>;
 }

package/dist/middlewareService.js

@@ -9,9 +9,23 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapMiddleware = exports.MidwayExpressMiddlewareService = void 0;
+exports.wrapMiddleware = exports.MidwayExpressMiddlewareService = exports.wrapAsyncHandler = void 0;
 const decorator_1 = require("@midwayjs/decorator");
 const core_1 = require("@midwayjs/core");
+const util_1 = require("./util");
+function wrapAsyncHandler(fn) {
+    if ((0, decorator_1.isAsyncFunction)(fn)) {
+        return (req, res, next) => {
+            return fn(req, res, next).catch(err => {
+                next(err);
+            });
+        };
+    }
+    else {
+        return fn;
+    }
+}
+exports.wrapAsyncHandler = wrapAsyncHandler;
 let MidwayExpressMiddlewareService = class MidwayExpressMiddlewareService {
     constructor(applicationContext) {
         this.applicationContext = applicationContext;
@@ -30,6 +44,8 @@ let MidwayExpressMiddlewareService = class MidwayExpressMiddlewareService {
                 const classMiddleware = await this.applicationContext.getAsync(fn);
                 if (classMiddleware) {
                     fn = classMiddleware.resolve(app);
+                    // wrap async middleware
+                    fn = wrapAsyncHandler(fn);
                     if (!classMiddleware.match && !classMiddleware.ignore) {
                         fn._name = classMiddleware.constructor.name;
                         // just got fn
@@ -56,16 +72,40 @@ let MidwayExpressMiddlewareService = class MidwayExpressMiddlewareService {
                 }
             }
             else {
+                // wrap async middleware
+                fn = wrapAsyncHandler(fn);
                 newMiddlewareArr.push(fn);
             }
         }
-        const composeFn = (req, res, next) => {
-            (function iter(i, max) {
-                if (i === max) {
-                    return next();
+        const composeFn = (req, res, nextFunction) => {
+            let index = -1;
+            function dispatch(pos, err) {
+                const handler = newMiddlewareArr[pos];
+                index = pos;
+                if (err || index === newMiddlewareArr.length) {
+                    return nextFunction(err);
                 }
-                newMiddlewareArr[i](req, res, iter.bind(this, i + 1, max));
-            })(0, newMiddlewareArr.length);
+                function next(err) {
+                    if (pos < index) {
+                        throw new TypeError('`next()` called multiple times');
+                    }
+                    return dispatch(pos + 1, err);
+                }
+                try {
+                    Promise.resolve(handler(req, res, next)).then(result => {
+                        if (result) {
+                            (0, util_1.sendData)(res, result);
+                        }
+                    });
+                }
+                catch (err) {
+                    // Avoid future errors that could diverge stack execution.
+                    if (index > pos)
+                        throw err;
+                    return next(err);
+                }
+            }
+            return dispatch(0);
         };
         if (name) {
             composeFn._name = name;

package/dist/util.d.ts

@@ -0,0 +1,2 @@
+export declare function sendData(res: any, data: any): void;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendData = void 0;
+function sendData(res, data) {
+    if (typeof data === 'number') {
+        res.status(res.statusCode).send('' + data);
+    }
+    else {
+        res.status(res.statusCode).send(data);
+    }
+}
+exports.sendData = sendData;
+//# sourceMappingURL=util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/express",
-  "version": "3.0.0-beta.11",
+  "version": "3.0.0-beta.15",
   "description": "Midway Web Framework for Express",
   "main": "dist/index",
   "typings": "dist/index.d.ts",
@@ -23,19 +23,19 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.0.0-beta.11",
-    "@midwayjs/logger": "^3.0.0-beta.11",
-    "@midwayjs/mock": "^3.0.0-beta.11",
-    "@types/body-parser": "^1.19.2",
-    "@types/express": "^4.17.8",
-    "fs-extra": "^8.0.1"
+    "@midwayjs/decorator": "^3.0.0-beta.15",
+    "@midwayjs/logger": "2.14.0",
+    "@midwayjs/mock": "^3.0.0-beta.15",
+    "@types/body-parser": "1.19.2",
+    "@types/express": "4.17.13",
+    "fs-extra": "10.0.0"
   },
   "dependencies": {
-    "@midwayjs/core": "^3.0.0-beta.11",
-    "@midwayjs/express-session": "^3.0.0-beta.11",
-    "body-parser": "^1.19.0",
+    "@midwayjs/core": "^3.0.0-beta.15",
+    "@midwayjs/express-session": "^3.0.0-beta.15",
+    "body-parser": "1.19.1",
     "cookie-parser": "^1.4.6",
-    "express": "^4.17.1"
+    "express": "4.17.2"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
   "repository": {
@@ -45,5 +45,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "a2b066fd500e815e799e7f421cd216f12e0e9f8e"
+  "gitHead": "6b9778557289d9e8b562c7ce6127736db1248973"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2013 - Now midwayjs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.