@midwayjs/express 4.0.0-alpha.1 → 4.0.0-beta.2

package/README.md

@@ -9,4 +9,4 @@ Document: [https://midwayjs.org](https://midwayjs.org)
 
 ## License
 
-[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))
+[MIT]((https://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/config/config.default.d.ts

@@ -1,7 +1,12 @@
 import { Options, OptionsJson, OptionsText, OptionsUrlencoded } from 'body-parser';
 import { CookieOptions } from 'express';
-export declare const express: {
-    contextLoggerFormat: (info: any) => string;
+export declare const express: {};
+export declare const midwayLogger: {
+    clients: {
+        appLogger: {
+            contextFormat: (info: any) => string;
+        };
+    };
 };
 export declare const cookieParser: {
     enable?: boolean;

package/dist/config/config.default.js

@@ -1,25 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bodyParser = exports.cookieParser = exports.express = void 0;
-exports.express = {
-    contextLoggerFormat: info => {
-        const req = info.ctx;
-        // format: '[$userId/$ip/$traceId/$use_ms $method $url]'
-        const userId = req?.['session']?.['userId'] || '-';
-        const traceId = req.traceId ?? '-';
-        const use = Date.now() - info.ctx.startTime;
-        const label = userId +
-            '/' +
-            req.ip +
-            '/' +
-            traceId +
-            '/' +
-            use +
-            'ms ' +
-            req.method +
-            ' ' +
-            req.url;
-        return `${info.timestamp} ${info.LEVEL} ${info.pid} [${label}] ${info.message}`;
+exports.bodyParser = exports.cookieParser = exports.midwayLogger = exports.express = void 0;
+exports.express = {};
+exports.midwayLogger = {
+    clients: {
+        appLogger: {
+            contextFormat: info => {
+                const req = info.ctx;
+                // format: '[$userId/$ip/$traceId/$use_ms $method $url]'
+                const userId = req?.['session']?.['userId'] || '-';
+                const traceId = req.traceId ?? '-';
+                const use = Date.now() - info.ctx.startTime;
+                const label = userId +
+                    '/' +
+                    req.ip +
+                    '/' +
+                    traceId +
+                    '/' +
+                    use +
+                    'ms ' +
+                    req.method +
+                    ' ' +
+                    req.url;
+                return `${info.timestamp} ${info.LEVEL} ${info.pid} [${label}] ${info.message}`;
+            },
+        },
     },
 };
 exports.cookieParser = {

package/dist/framework.js

@@ -118,9 +118,9 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         };
         // https config
         if (serverOptions.key && serverOptions.cert) {
-            serverOptions.key = core_1.PathFileUtil.getFileContentSync(serverOptions.key);
-            serverOptions.cert = core_1.PathFileUtil.getFileContentSync(serverOptions.cert);
-            serverOptions.ca = core_1.PathFileUtil.getFileContentSync(serverOptions.ca);
+            serverOptions.key = core_1.PathFileUtils.getFileContentSync(serverOptions.key);
+            serverOptions.cert = core_1.PathFileUtils.getFileContentSync(serverOptions.cert);
+            serverOptions.ca = core_1.PathFileUtils.getFileContentSync(serverOptions.ca);
             process.env.MIDWAY_HTTP_SSL = 'true';
             if (serverOptions.http2) {
                 this.server = require('http2').createSecureServer(serverOptions, this.app);
@@ -139,18 +139,27 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         }
         // register httpServer to applicationContext
         this.applicationContext.registerObject(core_1.HTTP_SERVER_KEY, this.server);
-        const customPort = process.env.MIDWAY_HTTP_PORT ?? this.configurationOptions.port;
-        if (customPort) {
+        this.configurationOptions.listenOptions = {
+            port: this.configurationOptions.port,
+            host: this.configurationOptions.hostname,
+            ...this.configurationOptions.listenOptions,
+        };
+        // set port and listen server
+        let customPort = process.env.MIDWAY_HTTP_PORT ||
+            this.configurationOptions.listenOptions.port;
+        if (customPort === 0 || customPort === '0') {
+            customPort = await (0, util_2.getFreePort)();
+            this.logger.info(`[midway:express] detect available port: ${customPort}`);
+        }
+        this.configurationOptions.listenOptions.port = Number(customPort);
+        if (this.configurationOptions.listenOptions.port) {
             new Promise(resolve => {
-                const args = [customPort];
-                if (this.configurationOptions.hostname) {
-                    args.push(this.configurationOptions.hostname);
-                }
-                args.push(() => {
+                // 使用 ListenOptions 对象启动服务器
+                this.server.listen(this.configurationOptions.listenOptions, () => {
                     resolve();
                 });
-                this.server.listen(...args);
-                process.env.MIDWAY_HTTP_PORT = String(customPort);
+                process.env.MIDWAY_HTTP_PORT = String(this.configurationOptions.listenOptions.port);
+                this.logger.debug(`[midway:express] Server listening on http://${this.configurationOptions.hostname || 'localhost'}:${customPort}`);
             });
         }
     }
@@ -221,7 +230,7 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         for (const routerInfo of routerList) {
             // bind controller first
             this.getApplicationContext().bindClass(routerInfo.routerModule);
-            this.logger.debug(`Load Controller "${routerInfo.controllerId}", prefix=${routerInfo.prefix}`);
+            this.logger.debug(`[midway:express] Load Controller "${routerInfo.controllerId}", prefix=${routerInfo.prefix}`);
             // new router
             const newRouter = this.createRouter(routerInfo.routerOptions);
             routerInfo.middleware = routerInfo.middleware ?? [];
@@ -240,9 +249,9 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
                     const routeMiddlewareFn = await this.expressMiddlewareService.compose(routeInfo.middleware, this.app);
                     routeMiddlewareList.push(routeMiddlewareFn);
                 }
-                this.logger.debug(`Load Router "${routeInfo.requestMethod.toUpperCase()} ${routeInfo.url}"`);
+                this.logger.debug(`[midway:express] Load Router "${routeInfo.requestMethod.toUpperCase()} ${routeInfo.url}"`);
                 // apply controller from request context
-                newRouter[routeInfo.requestMethod].call(newRouter, routeInfo.url, ...routeMiddlewareList, this.generateController(routeInfo));
+                newRouter[routeInfo.requestMethod.toLowerCase()].call(newRouter, routeInfo.url, ...routeMiddlewareList, this.generateController(routeInfo));
             }
             routerMiddlewares.push({
                 prefix: routerInfo.prefix,
@@ -271,7 +280,9 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
         if (this.server) {
             new Promise(resolve => {
                 this.server.close(resolve);
+                process.env.MIDWAY_HTTP_PORT = '';
             });
+            this.logger.debug('[midway:express] server close');
         }
     }
     getServer() {

package/dist/interface.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { CommonMiddlewareUnion, ContextMiddlewareManager, FunctionMiddleware, IConfigurationOptions, IMiddleware, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
 import { Application as ExpressApplication, NextFunction as ExpressNextFunction, Request as ExpressRequest, Response as ExpressResponse } from 'express';
+import { ListenOptions } from 'net';
 type Request = IMidwayContext<ExpressRequest>;
 export type Response = ExpressResponse;
 export type NextFunction = ExpressNextFunction;
@@ -70,6 +72,10 @@ export interface IMidwayExpressConfigurationOptions extends IConfigurationOption
      * https/https/http2 server options
      */
     serverOptions?: Record<string, any>;
+    /**
+     * listen options
+     */
+    listenOptions?: ListenOptions;
 }
 export type Application = IMidwayExpressApplication;
 export {};

package/dist/util.d.ts

@@ -1,2 +1,3 @@
 export declare function sendData(res: any, data: any): void;
+export declare function getFreePort(): Promise<number>;
 //# sourceMappingURL=util.d.ts.map

package/dist/util.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendData = void 0;
+exports.getFreePort = exports.sendData = void 0;
+const net_1 = require("net");
 function sendData(res, data) {
     if (typeof data === 'number') {
         res.status(res.statusCode).send('' + data);
@@ -10,4 +11,20 @@ function sendData(res, data) {
     }
 }
 exports.sendData = sendData;
+async function getFreePort() {
+    return new Promise((resolve, reject) => {
+        const server = (0, net_1.createServer)();
+        server.listen(0, () => {
+            try {
+                const port = server.address().port;
+                server.close();
+                resolve(port);
+            }
+            catch (err) {
+                reject(err);
+            }
+        });
+    });
+}
+exports.getFreePort = getFreePort;
 //# sourceMappingURL=util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/express",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.2",
   "description": "Midway Web Framework for Express",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,14 +24,14 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-alpha.1",
-    "@midwayjs/mock": "^4.0.0-alpha.1",
+    "@midwayjs/core": "^4.0.0-beta.2",
+    "@midwayjs/mock": "^4.0.0-beta.2",
     "@types/body-parser": "1.19.5",
-    "@types/express": "4.17.21",
-    "fs-extra": "11.2.0"
+    "@types/express": "4.17.23",
+    "fs-extra": "11.3.0"
   },
   "dependencies": {
-    "@midwayjs/express-session": "^4.0.0-alpha.1",
+    "@midwayjs/express-session": "^4.0.0-beta.2",
     "body-parser": "1.20.3",
     "cookie-parser": "^1.4.6",
     "express": "4.21.2"
@@ -42,7 +42,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "53bfef4c5279da5f09025e4610bdbf64f94f60bd"
 }