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

@@ -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/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) {
@@ -41,6 +42,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 +53,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];
             },
@@ -190,9 +192,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 +217,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() {

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,14 @@ export interface IMidwayKoaConfigurationOptions extends IConfigurationOptions {
      * qs options
      */
     queryParseOptions?: qs.IParseOptions;
+    /**
+     * https/https/http2 server options
+     */
     serverOptions?: Record<string, any>;
+    /**
+     * listen options
+     */
+    listenOptions?: ListenOptions;
 }
 export type MiddlewareParamArray = Array<Middleware<DefaultState, IMidwayKoaContext>>;
 export interface IWebMiddleware {

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-alpha.1",
+  "version": "4.0.0-beta.2",
   "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",
+    "@midwayjs/core": "^4.0.0-beta.2",
+    "@midwayjs/mock": "^4.0.0-beta.2",
     "@types/koa-router": "7.4.8",
-    "fs-extra": "11.2.0"
+    "axios": "1.12.0",
+    "fs-extra": "11.3.0"
   },
   "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.2",
+    "@types/koa": "3.0.0",
+    "@types/qs": "6.9.18",
+    "koa": "3.0.1",
     "koa-bodyparser": "4.4.1",
-    "qs": "6.13.1"
+    "qs": "6.14.0"
   },
   "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": "53bfef4c5279da5f09025e4610bdbf64f94f60bd"
 }