@midwayjs/koa 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

@@ -2,9 +2,15 @@
  * koa server options
  */
 export declare const koa: {
-    contextLoggerFormat: (info: any) => string;
     serverTimeout: number;
 };
+export declare const midwayLogger: {
+    clients: {
+        appLogger: {
+            contextLoggerFormat: (info: any) => string;
+        };
+    };
+};
 /**
  * The key that signing cookies. It can contain multiple keys seperated by `,`.
  * @member {String} Config#keys
@@ -18,6 +24,12 @@ export declare const keys = "";
  * @property {Boolean} httpOnly - httpOnly property, defaults is true
  */
 export declare const cookies: {};
+/**
+ * default cookie get options
+ */
+export declare const cookiesExtra: {
+    defaultGetOptions: {};
+};
 export declare const onerror: {};
 /**
  * @member Config#bodyParser

package/dist/config/config.default.js

@@ -1,31 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.siteFile = exports.bodyParser = exports.onerror = exports.cookies = exports.keys = exports.koa = void 0;
+exports.siteFile = exports.bodyParser = exports.onerror = exports.cookiesExtra = exports.cookies = exports.keys = exports.midwayLogger = exports.koa = void 0;
 /**
  * koa server options
  */
 exports.koa = {
-    contextLoggerFormat: info => {
-        const ctx = info.ctx;
-        // format: '[$userId/$ip/$traceId/$use_ms $method $url]'
-        const userId = ctx.userId || '-';
-        const traceId = ctx.traceId ?? ctx.tracer?.traceId ?? '-';
-        const use = Date.now() - ctx.startTime;
-        const label = userId +
-            '/' +
-            ctx.ip +
-            '/' +
-            traceId +
-            '/' +
-            use +
-            'ms ' +
-            ctx.method +
-            ' ' +
-            ctx.url;
-        return `${info.timestamp} ${info.LEVEL} ${info.pid} [${label}] ${info.message}`;
-    },
     serverTimeout: 2 * 60 * 1000,
 };
+exports.midwayLogger = {
+    clients: {
+        appLogger: {
+            contextLoggerFormat: info => {
+                const ctx = info.ctx;
+                // format: '[$userId/$ip/$traceId/$use_ms $method $url]'
+                const userId = ctx.userId || '-';
+                const traceId = ctx.traceId ?? ctx.tracer?.traceId ?? '-';
+                const use = Date.now() - ctx.startTime;
+                const label = userId +
+                    '/' +
+                    ctx.ip +
+                    '/' +
+                    traceId +
+                    '/' +
+                    use +
+                    'ms ' +
+                    ctx.method +
+                    ' ' +
+                    ctx.url;
+                return `${info.timestamp} ${info.LEVEL} ${info.pid} [${label}] ${info.message}`;
+            },
+        },
+    },
+};
 /**
  * The key that signing cookies. It can contain multiple keys seperated by `,`.
  * @member {String} Config#keys
@@ -42,6 +48,14 @@ exports.cookies = {
 // httpOnly: true | false,
 // sameSite: 'none|lax|strict',
 };
+/**
+ * default cookie get options
+ */
+exports.cookiesExtra = {
+    defaultGetOptions: {
+    // sign: false,
+    },
+};
 exports.onerror = {};
 /**
  * @member Config#bodyParser

package/dist/configuration.js

@@ -17,6 +17,9 @@ const DefaultConfig = require("./config/config.default");
 const bodyparser_middleware_1 = require("./middleware/bodyparser.middleware");
 const fav_middleware_1 = require("./middleware/fav.middleware");
 let KoaConfiguration = class KoaConfiguration {
+    decoratorService;
+    koaFramework;
+    configService;
     init() {
         // register param decorator
         this.decoratorService.registerParameterHandler(core_1.WEB_ROUTER_PARAM_KEY, options => {

package/dist/framework.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { BaseFramework, CommonFilterUnion, CommonMiddlewareUnion, IMidwayBootstrapOptions, RouterInfo } from '@midwayjs/core';
 import { IMidwayKoaApplication, IMidwayKoaConfigurationOptions, IMidwayKoaContext } from './interface';
 import type { DefaultState, Middleware, Next } from 'koa';
@@ -14,11 +13,6 @@ export declare class MidwayKoaFramework extends BaseFramework<IMidwayKoaApplicat
      * wrap controller string to middleware function
      */
     generateController(routeInfo: RouterInfo): Middleware<DefaultState, IMidwayKoaContext>;
-    /**
-     * @deprecated
-     * @param middlewareId
-     */
-    generateMiddleware(middlewareId: any): Promise<Middleware<DefaultState, IMidwayKoaContext, any>>;
     run(): Promise<void>;
     beforeStop(): Promise<void>;
     getFrameworkName(): string;
@@ -26,5 +20,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,8 +14,11 @@ 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 {
+    app;
+    webRouterService;
     constructor(app, webRouterService) {
         super(app, webRouterService);
         this.app = app;
@@ -31,6 +34,9 @@ class KoaControllerGenerator extends core_1.WebControllerGenerator {
     }
 }
 let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
+    server;
+    generator;
+    webRouterService;
     configure() {
         return this.configService.getConfiguration('koa');
     }
@@ -41,6 +47,7 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
             throw new core_1.MidwayConfigMissingError('config.keys');
         }
         const cookieOptions = this.configService.getConfiguration('cookies');
+        const cookieGetOptions = this.configService.getConfiguration('cookiesExtra.defaultGetOptions');
         this.app = new koa({
             keys: [].concat(appKeys),
             proxy: this.configurationOptions.proxy,
@@ -51,7 +58,7 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
         Object.defineProperty(this.app.context, 'cookies', {
             get() {
                 if (!this[COOKIES]) {
-                    this[COOKIES] = new cookies_1.Cookies(this, this.app.keys, cookieOptions);
+                    this[COOKIES] = new cookies_1.Cookies(this, this.app.keys, cookieOptions, cookieGetOptions);
                 }
                 return this[COOKIES];
             },
@@ -108,7 +115,13 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
                     return c[str];
                 if (self.configurationOptions.queryParseMode) {
                     // use qs module to parse query
-                    c[str] = qs.parse(str, self.configurationOptions.queryParseOptions || {});
+                    const parseOptions = {
+                        ...self.configurationOptions.queryParseOptions,
+                        ...(self.configurationOptions.queryParseMode === 'first'
+                            ? { duplicates: 'first' }
+                            : {}),
+                    };
+                    c[str] = qs.parse(str, parseOptions);
                 }
                 else {
                     // use querystring to parse query by default
@@ -135,10 +148,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) {
@@ -153,7 +172,10 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
             },
         ]);
         this.generator = new KoaControllerGenerator(this.app, this.webRouterService);
-        this.defineApplicationProperties();
+        this.defineApplicationProperties({
+            generateController: this.generateController.bind(this),
+            getPort: this.getPort.bind(this),
+        });
         // hack use method
         this.app.originUse = this.app.use;
         this.app.use = this.app.useMiddleware;
@@ -171,14 +193,6 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
     generateController(routeInfo) {
         return this.generator.generateKoaController(routeInfo);
     }
-    /**
-     * @deprecated
-     * @param middlewareId
-     */
-    async generateMiddleware(middlewareId) {
-        const mwIns = await this.getApplicationContext().getAsync(middlewareId);
-        return mwIns.resolve();
-    }
     async run() {
         // load controller
         await this.loadMidwayController();
@@ -190,9 +204,9 @@ let MidwayKoaFramework = class MidwayKoaFramework extends core_1.BaseFramework {
         };
         // 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.callback());
@@ -215,27 +229,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() {
@@ -253,6 +278,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,20 +1,18 @@
-/// <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>;
 export type IMidwayKoaApplication = IMidwayApplication<IMidwayKoaContext, koa<State, IMidwayKoaContext> & {
     generateController(controllerMapping: string, routeArgsInfo?: RouterParamValue[], routerResponseData?: any[]): Middleware<State, IMidwayKoaContext>;
     /**
-     * @deprecated
-     * @param middlewareId
+     * Get the port that the application is listening on
      */
-    generateMiddleware(middlewareId: any): Promise<Middleware<State, IMidwayKoaContext>>;
+    getPort(): string;
 }>;
 /**
  * @deprecated use NextFunction definition
@@ -86,7 +84,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 +133,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/middleware/bodyparser.middleware.js

@@ -13,6 +13,7 @@ exports.BodyParserMiddleware = void 0;
 const koaBodyParser = require("koa-bodyparser");
 const core_1 = require("@midwayjs/core");
 let BodyParserMiddleware = class BodyParserMiddleware {
+    bodyparserConfig;
     resolve() {
         // use bodyparser middleware
         if (this.bodyparserConfig.enable) {

package/dist/middleware/fav.middleware.js

@@ -14,6 +14,7 @@ const core_1 = require("@midwayjs/core");
 const path = require('path');
 const MAX_AGE = 'public, max-age=2592000'; // 30 days
 let SiteFileMiddleware = class SiteFileMiddleware {
+    siteFileConfig;
     resolve() {
         // use bodyparser middleware
         if (this.siteFileConfig.enable) {

package/dist/onerror.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupOnError = void 0;
+exports.setupOnError = setupOnError;
 const http = require("http");
 const utils_1 = require("./utils");
 const core_1 = require("@midwayjs/core");
@@ -182,5 +182,4 @@ function setupOnError(app, config, logger) {
         this.res.end(this.body);
     };
 }
-exports.setupOnError = setupOnError;
 //# sourceMappingURL=onerror.js.map

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,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapeHtml = exports.tpl = exports.isProduction = exports.sendToWormhole = exports.accepts = exports.detectStatus = void 0;
+exports.tpl = void 0;
+exports.detectStatus = detectStatus;
+exports.accepts = accepts;
+exports.sendToWormhole = sendToWormhole;
+exports.isProduction = isProduction;
+exports.escapeHtml = escapeHtml;
+exports.getFreePort = getFreePort;
+const net_1 = require("net");
 function detectStatus(err) {
     // detect status
     let status = err.status || 500;
@@ -10,13 +17,11 @@ function detectStatus(err) {
     }
     return status;
 }
-exports.detectStatus = detectStatus;
 function accepts(ctx) {
     if (acceptJSON(ctx))
         return 'json';
     return 'html';
 }
-exports.accepts = accepts;
 function acceptJSON(ctx) {
     if (ctx.path.endsWith('.json'))
         return true;
@@ -59,11 +64,9 @@ function sendToWormhole(stream) {
         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>
@@ -152,5 +155,19 @@ 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);
+            }
+        });
+    });
+}
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/koa",
-  "version": "4.0.0-alpha.1",
+  "version": "4.0.0-beta.10",
   "description": "Midway Web Framework for KOA",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,20 +24,21 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^4.0.0-alpha.1",
-    "@midwayjs/mock": "^4.0.0-alpha.1",
-    "@types/koa-router": "7.4.8",
-    "fs-extra": "11.2.0"
+    "@midwayjs/core": "^4.0.0-beta.10",
+    "@midwayjs/mock": "^4.0.0-beta.10",
+    "@types/koa-router": "7.4.9",
+    "axios": "1.12.0",
+    "fs-extra": "11.3.3"
   },
   "dependencies": {
     "@koa/router": "^12.0.0",
-    "@midwayjs/cookies": "^1.0.2",
-    "@midwayjs/session": "^4.0.0-alpha.1",
-    "@types/koa": "2.15.0",
-    "@types/qs": "6.9.17",
-    "koa": "2.15.3",
+    "@midwayjs/cookies": "^1.3.0",
+    "@midwayjs/session": "^4.0.0-beta.10",
+    "@types/koa": "3.0.0",
+    "@types/qs": "6.9.18",
+    "koa": "3.0.3",
     "koa-bodyparser": "4.4.1",
-    "qs": "6.13.1"
+    "qs": "6.14.1"
   },
   "author": "Harry Chen <czy88840616@gmail.com>",
   "repository": {
@@ -45,7 +46,7 @@
     "url": "https://github.com/midwayjs/midway.git"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   },
-  "gitHead": "14bb4da91805a1cf52f190c0d37a74b395dd6372"
+  "gitHead": "1b1856629913703f67304155aaf611ec936a81ac"
 }