@midwayjs/koa 4.0.0-beta.1 → 4.0.0-beta.3

package/README.md

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

package/dist/framework.d.ts

@@ -26,5 +26,7 @@ export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplicat
     getPort(): string;
     useMiddleware(Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>): void;
     useFilter(Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>): void;
+    private createVersioningMiddleware;
+    private extractVersion;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -14,6 +14,7 @@ const koa = require("koa");
 const onerror_1 = require("./onerror");
 const qs = require("qs");
 const querystring = require("querystring");
+const utils_1 = require("./utils");
 const COOKIES = Symbol('context#cookies');
 class KoaControllerGenerator extends core_1.WebControllerGenerator {
     constructor(app, webRouterService) {
@@ -136,10 +137,16 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
                 throw new core_1.httpError.NotFoundError(`${ctx.path} Not Found`);
             }
         };
+        const applyMiddlewares = [notFound];
+        // versioning middleware
+        const versioningConfig = this.configurationOptions.versioning;
+        if (versioningConfig?.enabled) {
+            applyMiddlewares.push(this.createVersioningMiddleware(versioningConfig));
+        }
         // root middleware
         const midwayRootMiddleware = async (ctx, next) => {
             this.app.createAnonymousContext(ctx);
-            await (await this.applyMiddleware(notFound))(ctx, next);
+            await (await this.applyMiddleware(applyMiddlewares))(ctx, next);
             if (ctx.body === undefined &&
                 !ctx.response._explicitStatus &&
                 ctx._matchedRoute) {
@@ -216,27 +223,38 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
         if (core_1.Types.isNumber(this.configurationOptions.serverTimeout)) {
             this.server.setTimeout(this.configurationOptions.serverTimeout);
         }
+        this.configurationOptions.listenOptions = {
+            port: this.configurationOptions.port,
+            host: this.configurationOptions.hostname,
+            ...this.configurationOptions.listenOptions,
+        };
         // set port and listen server
-        const customPort = process.env.MIDWAY_HTTP_PORT ?? this.configurationOptions.port;
-        if (customPort) {
+        let customPort = process.env.MIDWAY_HTTP_PORT ||
+            this.configurationOptions.listenOptions.port;
+        if (customPort === 0 || customPort === '0') {
+            customPort = await (0, utils_1.getFreePort)();
+            this.logger.info(`[midway:koa] server has auto-assigned 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:koa] server is listening on port ${customPort}`);
         }
     }
     async beforeStop() {
         if (this.server) {
             new Promise(resolve => {
                 this.server.close(resolve);
+                process.env.MIDWAY_HTTP_PORT = '';
             });
+            this.logger.debug('[midway:koa] server is stopped!');
         }
     }
     getFrameworkName() {
@@ -254,6 +272,52 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
     useFilter(Filter) {
         this.filterManager.useFilter(Filter);
     }
+    createVersioningMiddleware(config) {
+        return async (ctx, next) => {
+            // 提取版本信息
+            const version = this.extractVersion(ctx, config);
+            ctx.apiVersion = version;
+            // 对于 URI 版本控制，重写路径
+            if (config.type === 'URI' && version) {
+                const versionPrefix = `/${config.prefix || 'v'}${version}`;
+                if (ctx.path.startsWith(versionPrefix)) {
+                    ctx.originalPath = ctx.path;
+                    ctx.path = ctx.path.replace(versionPrefix, '') || '/';
+                }
+            }
+            await next();
+        };
+    }
+    extractVersion(ctx, config) {
+        // 自定义提取函数优先
+        if (config.extractVersionFn) {
+            return config.extractVersionFn(ctx);
+        }
+        const type = config.type || 'URI';
+        switch (type) {
+            case 'HEADER': {
+                const headerName = config.header || 'x-api-version';
+                const headerValue = ctx.headers[headerName];
+                if (typeof headerValue === 'string') {
+                    return headerValue.replace(/^v/, '');
+                }
+                return undefined;
+            }
+            case 'MEDIA_TYPE': {
+                const accept = ctx.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 = ctx.path.match(new RegExp(`^/${prefix}(\\d+)`));
+                return uriMatch ? uriMatch[1] : undefined;
+            }
+            default:
+                return config.defaultVersion;
+        }
+    }
 };
 exports.MidwayKoaFramework = MidwayKoaFramework;
 exports.MidwayKoaFramework = MidwayKoaFramework = __decorate([

package/dist/interface.d.ts

@@ -1,10 +1,12 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { IConfigurationOptions, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
 import * as koa from 'koa';
 import { Context as KoaContext, DefaultState, Middleware, Next } from 'koa';
 import { RouterParamValue } from '@midwayjs/core';
 import * as qs from 'qs';
+import { ListenOptions } from 'net';
 export interface State extends DefaultState {
 }
 export type IMidwayKoaContext = IMidwayContext<KoaContext>;
@@ -15,6 +17,10 @@ export type IMidwayKoaApplication = IMidwayApplication<IMidwayKoaContext, koa<St
      * @param middlewareId
      */
     generateMiddleware(middlewareId: any): Promise<Middleware<State, IMidwayKoaContext>>;
+    /**
+     * Get the port that the application is listening on
+     */
+    getPort(): string;
 }>;
 /**
  * @deprecated use NextFunction definition
@@ -86,7 +92,47 @@ export interface IMidwayKoaConfigurationOptions extends IConfigurationOptions {
      * qs options
      */
     queryParseOptions?: qs.IParseOptions;
+    /**
+     * https/https/http2 server options
+     */
     serverOptions?: Record<string, any>;
+    /**
+     * listen options
+     */
+    listenOptions?: ListenOptions;
+    /**
+     * 版本控制配置
+     */
+    versioning?: {
+        /**
+         * 是否启用版本控制
+         */
+        enabled?: boolean;
+        /**
+         * 默认版本控制类型
+         */
+        type?: 'URI' | 'HEADER' | 'MEDIA_TYPE' | 'CUSTOM';
+        /**
+         * 默认版本
+         */
+        defaultVersion?: string;
+        /**
+         * URI 版本前缀，默认为 'v'
+         */
+        prefix?: string;
+        /**
+         * Header 版本控制时的 header 名称
+         */
+        header?: string;
+        /**
+         * Media Type 版本控制时的参数名
+         */
+        mediaTypeParam?: string;
+        /**
+         * 自定义版本提取函数
+         */
+        extractVersionFn?: (ctx: IMidwayKoaContext) => string | undefined;
+    };
 }
 export type MiddlewareParamArray = Array<Middleware<DefaultState, IMidwayKoaContext>>;
 export interface IWebMiddleware {
@@ -95,6 +141,8 @@ export interface IWebMiddleware {
 export type Application = IMidwayKoaApplication;
 export interface Context extends IMidwayKoaContext {
     state: State;
+    apiVersion?: string;
+    originalPath?: string;
 }
 export interface BodyParserOptions {
     enable?: boolean;

package/dist/utils.d.ts

@@ -11,4 +11,5 @@ export declare const tpl = "\n<!DOCTYPE html>\n<html>\n  <head>\n    <title>Erro
  * @public
  */
 export declare function escapeHtml(string: any): string;
+export declare function getFreePort(): Promise<number>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeHtml = exports.tpl = exports.isProduction = exports.sendToWormhole = exports.accepts = exports.detectStatus = void 0;
+exports.getFreePort = exports.escapeHtml = exports.tpl = exports.isProduction = exports.sendToWormhole = exports.accepts = exports.detectStatus = void 0;
+const net_1 = require("net");
 function detectStatus(err) {
     // detect status
     let status = err.status || 500;
@@ -153,4 +154,20 @@ function escapeHtml(string) {
     return lastIndex !== index ? html + str.substring(lastIndex, index) : html;
 }
 exports.escapeHtml = escapeHtml;
+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=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/koa",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.3",
   "description": "Midway Web Framework for KOA",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,18 +24,19 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-beta.1",
-    "@midwayjs/mock": "^4.0.0-beta.1",
+    "@midwayjs/core": "^4.0.0-beta.3",
+    "@midwayjs/mock": "^4.0.0-beta.3",
     "@types/koa-router": "7.4.8",
+    "axios": "1.12.0",
     "fs-extra": "11.3.0"
   },
   "dependencies": {
     "@koa/router": "^12.0.0",
     "@midwayjs/cookies": "^1.3.0",
-    "@midwayjs/session": "^4.0.0-beta.1",
-    "@types/koa": "2.15.0",
+    "@midwayjs/session": "^4.0.0-beta.3",
+    "@types/koa": "3.0.0",
     "@types/qs": "6.9.18",
-    "koa": "2.16.1",
+    "koa": "3.0.1",
     "koa-bodyparser": "4.4.1",
     "qs": "6.14.0"
   },
@@ -45,7 +46,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
-  "gitHead": "832961ec3aff123c033197d8c00cb2bc9bad7ff8"
+  "gitHead": "b5b7dfaafb81823cdba5fd10ad2709b3e495c6b4"
 }