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

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/configuration.js

@@ -17,6 +17,9 @@ const cookieParser = require("cookie-parser");
 const DefaultConfig = require("./config/config.default");
 const framework_1 = require("./framework");
 let ExpressConfiguration = class ExpressConfiguration {
+    decoratorService;
+    expressFramework;
+    configService;
     init() {
         this.decoratorService.registerParameterHandler(core_1.WEB_ROUTER_PARAM_KEY, options => {
             return (0, core_1.extractExpressLikeValue)(options.metadata.type, options.metadata.propertyData, options.originParamType)(options.originArgs[0], options.originArgs[1], options.originArgs[2]);

package/dist/framework.d.ts

@@ -1,10 +1,8 @@
-/// <reference types="node" />
 import { BaseFramework, IMidwayBootstrapOptions, MiddlewareRespond, RouterInfo } from '@midwayjs/core';
 import { IMidwayExpressApplication, IMidwayExpressConfigurationOptions, Context } from './interface';
 import type { IRouter, IRouterHandler, Response, NextFunction } from 'express';
 import { Server } from 'net';
 export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpressApplication, Context, IMidwayExpressConfigurationOptions, Response, NextFunction> {
-    app: IMidwayExpressApplication;
     private server;
     private expressMiddlewareService;
     private webRouterService;
@@ -31,5 +29,7 @@ export declare class MidwayExpressFramework extends BaseFramework<IMidwayExpress
     getServer(): Server;
     getPort(): string;
     getFrameworkName(): string;
+    private createVersioningMiddleware;
+    private extractVersion;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -14,6 +14,9 @@ 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 {
+    server;
+    expressMiddlewareService;
+    webRouterService;
     configure() {
         return this.configService.getConfiguration('express');
     }
@@ -31,6 +34,12 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
             ctx.requestContext.registerObject('res', res);
             next();
         });
+        // 版本控制配置
+        const versioningConfig = this.configurationOptions.versioning;
+        // 如果启用版本控制，添加版本处理中间件
+        if (versioningConfig?.enabled) {
+            this.app.use(this.createVersioningMiddleware(versioningConfig));
+        }
         this.defineApplicationProperties({
             useMiddleware: (routerPath, ...middleware) => {
                 if (typeof routerPath === 'string' && middleware) {
@@ -118,9 +127,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 +148,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 +239,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 +258,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 +289,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() {
@@ -283,6 +303,53 @@ let MidwayExpressFramework = class MidwayExpressFramework extends core_1.BaseFra
     getFrameworkName() {
         return 'express';
     }
+    createVersioningMiddleware(config) {
+        return (req, res, next) => {
+            // 提取版本信息
+            const version = this.extractVersion(req, config);
+            req.apiVersion = version;
+            // 对于 URI 版本控制，重写路径
+            if (config.type === 'URI' && version) {
+                const versionPrefix = `/${config.prefix || 'v'}${version}`;
+                if (req.path.startsWith(versionPrefix)) {
+                    req.originalPath = req.path;
+                    // Express 中需要修改 url 而不是 path
+                    req.url = req.url.replace(versionPrefix, '') || '/';
+                }
+            }
+            next();
+        };
+    }
+    extractVersion(req, config) {
+        // 自定义提取函数优先
+        if (config.extractVersionFn) {
+            return config.extractVersionFn(req);
+        }
+        const type = config.type || 'URI';
+        switch (type) {
+            case 'HEADER': {
+                const headerName = config.header || 'x-api-version';
+                const headerValue = req.headers[headerName];
+                if (typeof headerValue === 'string') {
+                    return headerValue.replace(/^v/, '');
+                }
+                return undefined;
+            }
+            case 'MEDIA_TYPE': {
+                const accept = req.headers.accept;
+                const paramName = config.mediaTypeParam || 'version';
+                const match = accept?.match(new RegExp(`${paramName}=(\\\\d+)`));
+                return match ? match[1] : undefined;
+            }
+            case 'URI': {
+                const prefix = config.prefix || 'v';
+                const uriMatch = req.path.match(new RegExp(`^/${prefix}(\\\\d+)`));
+                return uriMatch ? uriMatch[1] : undefined;
+            }
+            default:
+                return config.defaultVersion;
+        }
+    }
 };
 exports.MidwayExpressFramework = MidwayExpressFramework;
 exports.MidwayExpressFramework = MidwayExpressFramework = __decorate([

package/dist/interface.d.ts

@@ -1,11 +1,18 @@
-/// <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;
 export interface Context extends Request {
+    /**
+     * API version extracted from request
+     */
+    apiVersion?: string;
+    /**
+     * Original path before version processing
+     */
+    originalPath?: string;
 }
 /**
  * @deprecated use Context
@@ -70,6 +77,43 @@ export interface IMidwayExpressConfigurationOptions extends IConfigurationOption
      * https/https/http2 server options
      */
     serverOptions?: Record<string, any>;
+    /**
+     * listen options
+     */
+    listenOptions?: ListenOptions;
+    /**
+     * API versioning configuration
+     */
+    versioning?: {
+        /**
+         * Enable versioning
+         */
+        enabled: boolean;
+        /**
+         * Versioning type
+         */
+        type?: 'URI' | 'HEADER' | 'MEDIA_TYPE' | 'CUSTOM';
+        /**
+         * Default version if none is specified
+         */
+        defaultVersion?: string;
+        /**
+         * Version prefix for URI versioning (default: 'v')
+         */
+        prefix?: string;
+        /**
+         * Header name for HEADER versioning (default: 'x-api-version')
+         */
+        header?: string;
+        /**
+         * Media type parameter name for MEDIA_TYPE versioning (default: 'version')
+         */
+        mediaTypeParam?: string;
+        /**
+         * Custom version extraction function
+         */
+        extractVersionFn?: (ctx: Context) => string | undefined;
+    };
 }
 export type Application = IMidwayExpressApplication;
 export {};

package/dist/middlewareService.js

@@ -9,7 +9,9 @@ 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 = exports.wrapAsyncHandler = void 0;
+exports.MidwayExpressMiddlewareService = void 0;
+exports.wrapAsyncHandler = wrapAsyncHandler;
+exports.wrapMiddleware = wrapMiddleware;
 const core_1 = require("@midwayjs/core");
 const util_1 = require("./util");
 function wrapAsyncHandler(fn) {
@@ -24,8 +26,8 @@ function wrapAsyncHandler(fn) {
         return fn;
     }
 }
-exports.wrapAsyncHandler = wrapAsyncHandler;
 let MidwayExpressMiddlewareService = class MidwayExpressMiddlewareService {
+    applicationContext;
     constructor(applicationContext) {
         this.applicationContext = applicationContext;
     }
@@ -139,5 +141,4 @@ function wrapMiddleware(mw, options) {
     fn._name = mw._name + 'middlewareWrapper';
     return fn;
 }
-exports.wrapMiddleware = wrapMiddleware;
 //# sourceMappingURL=middlewareService.js.map

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,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendData = void 0;
+exports.sendData = sendData;
+exports.getFreePort = getFreePort;
+const net_1 = require("net");
 function sendData(res, data) {
     if (typeof data === 'number') {
         res.status(res.statusCode).send('' + data);
@@ -9,5 +11,19 @@ function sendData(res, data) {
         res.status(res.statusCode).send(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);
+            }
+        });
+    });
+}
 //# 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.10",
   "description": "Midway Web Framework for Express",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,17 +24,17 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-alpha.1",
-    "@midwayjs/mock": "^4.0.0-alpha.1",
-    "@types/body-parser": "1.19.5",
-    "@types/express": "4.17.21",
-    "fs-extra": "11.2.0"
+    "@midwayjs/core": "^4.0.0-beta.10",
+    "@midwayjs/mock": "^4.0.0-beta.10",
+    "@types/body-parser": "1.19.6",
+    "@types/express": "4.17.25",
+    "fs-extra": "11.3.3"
   },
   "dependencies": {
-    "@midwayjs/express-session": "^4.0.0-alpha.1",
-    "body-parser": "1.20.3",
+    "@midwayjs/express-session": "^4.0.0-beta.10",
+    "body-parser": "2.2.2",
     "cookie-parser": "^1.4.6",
-    "express": "4.21.2"
+    "express": "4.22.1"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
   "repository": {
@@ -42,7 +42,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "1b1856629913703f67304155aaf611ec936a81ac"
 }