egg 3.29.0 → 4.0.0-beta.10

package/dist/commonjs/lib/core/base_context_logger.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseContextLogger = void 0;
+class BaseContextLogger {
+    #ctx;
+    #pathName;
+    /**
+     * @class
+     * @param {Context} ctx - context instance
+     * @param {String} pathName - class path name
+     * @since 1.0.0
+     */
+    constructor(ctx, pathName) {
+        /**
+         * @member {Context} BaseContextLogger#ctx
+         * @since 1.2.0
+         */
+        this.#ctx = ctx;
+        this.#pathName = pathName;
+    }
+    _log(method, args) {
+        // add `[${pathName}]` in log
+        if (this.#pathName && typeof args[0] === 'string') {
+            args[0] = `[${this.#pathName}] ${args[0]}`;
+        }
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        this.#ctx.app.logger[method](...args);
+    }
+    /**
+     * @member {Function} BaseContextLogger#debug
+     * @param {...any} args - log msg
+     * @since 1.2.0
+     */
+    debug(...args) {
+        this._log('debug', args);
+    }
+    /**
+     * @member {Function} BaseContextLogger#info
+     * @param {...any} args - log msg
+     * @since 1.2.0
+     */
+    info(...args) {
+        this._log('info', args);
+    }
+    /**
+     * @member {Function} BaseContextLogger#warn
+     * @param {...any} args - log msg
+     * @since 1.2.0
+     */
+    warn(...args) {
+        this._log('warn', args);
+    }
+    /**
+     * @member {Function} BaseContextLogger#error
+     * @param {...any} args - log msg
+     * @since 1.2.0
+     */
+    error(...args) {
+        this._log('error', args);
+    }
+}
+exports.BaseContextLogger = BaseContextLogger;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZV9jb250ZXh0X2xvZ2dlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvY29yZS9iYXNlX2NvbnRleHRfbG9nZ2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUVBLE1BQWEsaUJBQWlCO0lBQ25CLElBQUksQ0FBYTtJQUNqQixTQUFTLENBQVU7SUFFNUI7Ozs7O09BS0c7SUFDSCxZQUFZLEdBQWUsRUFBRSxRQUFpQjtRQUM1Qzs7O1dBR0c7UUFDSCxJQUFJLENBQUMsSUFBSSxHQUFHLEdBQUcsQ0FBQztRQUNoQixJQUFJLENBQUMsU0FBUyxHQUFHLFFBQVEsQ0FBQztJQUM1QixDQUFDO0lBRVMsSUFBSSxDQUFDLE1BQTJDLEVBQUUsSUFBVztRQUNyRSw2QkFBNkI7UUFDN0IsSUFBSSxJQUFJLENBQUMsU0FBUyxJQUFJLE9BQU8sSUFBSSxDQUFDLENBQUMsQ0FBQyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ2xELElBQUksQ0FBQyxDQUFDLENBQUMsR0FBRyxJQUFJLElBQUksQ0FBQyxTQUFTLEtBQUssSUFBSSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDN0MsQ0FBQztRQUNELDZEQUE2RDtRQUM3RCxhQUFhO1FBQ2IsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDeEMsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxLQUFLLENBQUMsR0FBRyxJQUFXO1FBQ2xCLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzNCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxDQUFDLEdBQUcsSUFBVztRQUNqQixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztJQUMxQixDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILElBQUksQ0FBQyxHQUFHLElBQVc7UUFDakIsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDMUIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxLQUFLLENBQUMsR0FBRyxJQUFXO1FBQ2xCLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzNCLENBQUM7Q0FDRjtBQWhFRCw4Q0FnRUMifQ==

package/dist/commonjs/lib/core/base_hook_class.d.ts

@@ -0,0 +1,11 @@
+import type { ILifecycleBoot } from '@eggjs/core';
+import type { Application, Agent } from '../../index.js';
+export declare class BaseHookClass implements ILifecycleBoot {
+    #private;
+    fullPath?: string;
+    constructor(instance: Application | Agent);
+    get logger(): any;
+    get config(): import("../type.js").EggAppConfig;
+    get app(): Application;
+    get agent(): Agent;
+}

package/dist/commonjs/lib/core/base_hook_class.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseHookClass = void 0;
+const node_assert_1 = __importDefault(require("node:assert"));
+class BaseHookClass {
+    fullPath;
+    #instance;
+    constructor(instance) {
+        this.#instance = instance;
+    }
+    get logger() {
+        return this.#instance.logger;
+    }
+    get config() {
+        return this.#instance.config;
+    }
+    get app() {
+        (0, node_assert_1.default)(this.#instance.type === 'application', 'agent boot should not use app instance');
+        return this.#instance;
+    }
+    get agent() {
+        (0, node_assert_1.default)(this.#instance.type === 'agent', 'app boot should not use agent instance');
+        return this.#instance;
+    }
+}
+exports.BaseHookClass = BaseHookClass;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZV9ob29rX2NsYXNzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9jb3JlL2Jhc2VfaG9va19jbGFzcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSw4REFBaUM7QUFJakMsTUFBYSxhQUFhO0lBQ3hCLFFBQVEsQ0FBVTtJQUNsQixTQUFTLENBQXNCO0lBRS9CLFlBQVksUUFBNkI7UUFDdkMsSUFBSSxDQUFDLFNBQVMsR0FBRyxRQUFRLENBQUM7SUFDNUIsQ0FBQztJQUVELElBQUksTUFBTTtRQUNSLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUM7SUFDL0IsQ0FBQztJQUVELElBQUksTUFBTTtRQUNSLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUM7SUFDL0IsQ0FBQztJQUVELElBQUksR0FBRztRQUNMLElBQUEscUJBQU0sRUFBQyxJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksS0FBSyxhQUFhLEVBQUUsd0NBQXdDLENBQUMsQ0FBQztRQUN4RixPQUFPLElBQUksQ0FBQyxTQUF3QixDQUFDO0lBQ3ZDLENBQUM7SUFFRCxJQUFJLEtBQUs7UUFDUCxJQUFBLHFCQUFNLEVBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLEtBQUssT0FBTyxFQUFFLHdDQUF3QyxDQUFDLENBQUM7UUFDbEYsT0FBTyxJQUFJLENBQUMsU0FBa0IsQ0FBQztJQUNqQyxDQUFDO0NBQ0Y7QUF6QkQsc0NBeUJDIn0=

package/dist/commonjs/lib/core/context_httpclient.d.ts

@@ -0,0 +1,16 @@
+import type { ContextDelegation, EggApplicationCore } from '../egg.js';
+import type { HttpClientRequestURL, HttpClientRequestOptions } from './httpclient.js';
+export declare class ContextHttpClient {
+    ctx: ContextDelegation;
+    app: EggApplicationCore;
+    constructor(ctx: ContextDelegation);
+    /**
+     * http request helper base on {@link HttpClient}, it will auto save httpclient log.
+     * Keep the same api with {@link Application#curl}.
+     *
+     * @param {String|Object} url - request url address.
+     * @param {Object} [options] - options for request.
+     */
+    curl<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<import("./httpclient.js").HttpClientResponse<T>>;
+    request<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<import("./httpclient.js").HttpClientResponse<T>>;
+}

package/dist/commonjs/lib/core/context_httpclient.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextHttpClient = void 0;
+class ContextHttpClient {
+    ctx;
+    app;
+    constructor(ctx) {
+        this.ctx = ctx;
+        this.app = ctx.app;
+    }
+    /**
+     * http request helper base on {@link HttpClient}, it will auto save httpclient log.
+     * Keep the same api with {@link Application#curl}.
+     *
+     * @param {String|Object} url - request url address.
+     * @param {Object} [options] - options for request.
+     */
+    async curl(url, options) {
+        options = {
+            ...options,
+            ctx: this.ctx,
+        };
+        return await this.app.curl(url, options);
+    }
+    async request(url, options) {
+        return await this.curl(url, options);
+    }
+}
+exports.ContextHttpClient = ContextHttpClient;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dF9odHRwY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9jb3JlL2NvbnRleHRfaHR0cGNsaWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFLQSxNQUFhLGlCQUFpQjtJQUM1QixHQUFHLENBQW9CO0lBQ3ZCLEdBQUcsQ0FBcUI7SUFFeEIsWUFBWSxHQUFzQjtRQUNoQyxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztRQUNmLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDLEdBQUcsQ0FBQztJQUNyQixDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsS0FBSyxDQUFDLElBQUksQ0FBVSxHQUF5QixFQUFFLE9BQWtDO1FBQy9FLE9BQU8sR0FBRztZQUNSLEdBQUcsT0FBTztZQUNWLEdBQUcsRUFBRSxJQUFJLENBQUMsR0FBRztTQUNkLENBQUM7UUFDRixPQUFPLE1BQU0sSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUksR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQzlDLENBQUM7SUFFRCxLQUFLLENBQUMsT0FBTyxDQUFVLEdBQXlCLEVBQUUsT0FBa0M7UUFDbEYsT0FBTyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUksR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQzFDLENBQUM7Q0FDRjtBQTNCRCw4Q0EyQkMifQ==

package/dist/commonjs/lib/core/httpclient.d.ts

@@ -0,0 +1,13 @@
+import { HttpClient as RawHttpClient, RequestURL as HttpClientRequestURL, RequestOptions } from 'urllib';
+import type { EggApplicationCore, ContextDelegation } from '../egg.js';
+export type { HttpClientResponse, RequestURL as HttpClientRequestURL, } from 'urllib';
+export interface HttpClientRequestOptions extends RequestOptions {
+    ctx?: ContextDelegation;
+    tracer?: unknown;
+}
+export declare class HttpClient extends RawHttpClient {
+    #private;
+    constructor(app: EggApplicationCore);
+    request<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<import("urllib").HttpClientResponse<T>>;
+    curl<T = any>(url: HttpClientRequestURL, options?: HttpClientRequestOptions): Promise<import("urllib").HttpClientResponse<T>>;
+}

package/dist/commonjs/lib/core/httpclient.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = void 0;
+const urllib_1 = require("urllib");
+const humanize_ms_1 = require("humanize-ms");
+class HttpClient extends urllib_1.HttpClient {
+    #app;
+    constructor(app) {
+        normalizeConfig(app);
+        const config = app.config.httpclient;
+        super({
+            defaultArgs: config.request,
+        });
+        this.#app = app;
+    }
+    async request(url, options) {
+        options = options ?? {};
+        if (options.ctx?.tracer) {
+            options.tracer = options.ctx.tracer;
+        }
+        else {
+            options.tracer = options.tracer ?? this.#app.tracer;
+        }
+        return await super.request(url, options);
+    }
+    async curl(url, options) {
+        return await this.request(url, options);
+    }
+}
+exports.HttpClient = HttpClient;
+function normalizeConfig(app) {
+    const config = app.config.httpclient;
+    if (typeof config.request?.timeout === 'string') {
+        config.request.timeout = (0, humanize_ms_1.ms)(config.request.timeout);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaHR0cGNsaWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvY29yZS9odHRwY2xpZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLG1DQUlnQjtBQUNoQiw2Q0FBaUM7QUFhakMsTUFBYSxVQUFXLFNBQVEsbUJBQWE7SUFDbEMsSUFBSSxDQUE0QztJQUV6RCxZQUFZLEdBQXVCO1FBQ2pDLGVBQWUsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNyQixNQUFNLE1BQU0sR0FBRyxHQUFHLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQztRQUNyQyxLQUFLLENBQUM7WUFDSixXQUFXLEVBQUUsTUFBTSxDQUFDLE9BQU87U0FDNUIsQ0FBQyxDQUFDO1FBQ0gsSUFBSSxDQUFDLElBQUksR0FBRyxHQUFHLENBQUM7SUFDbEIsQ0FBQztJQUVELEtBQUssQ0FBQyxPQUFPLENBQVUsR0FBeUIsRUFBRSxPQUFrQztRQUNsRixPQUFPLEdBQUcsT0FBTyxJQUFJLEVBQUUsQ0FBQztRQUN4QixJQUFJLE9BQU8sQ0FBQyxHQUFHLEVBQUUsTUFBTSxFQUFFLENBQUM7WUFDeEIsT0FBTyxDQUFDLE1BQU0sR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQztRQUN0QyxDQUFDO2FBQU0sQ0FBQztZQUNOLE9BQU8sQ0FBQyxNQUFNLEdBQUcsT0FBTyxDQUFDLE1BQU0sSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQztRQUN0RCxDQUFDO1FBQ0QsT0FBTyxNQUFNLEtBQUssQ0FBQyxPQUFPLENBQUksR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQzlDLENBQUM7SUFFRCxLQUFLLENBQUMsSUFBSSxDQUFVLEdBQXlCLEVBQUUsT0FBa0M7UUFDL0UsT0FBTyxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUksR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQzdDLENBQUM7Q0FDRjtBQXpCRCxnQ0F5QkM7QUFFRCxTQUFTLGVBQWUsQ0FBQyxHQUF1QjtJQUM5QyxNQUFNLE1BQU0sR0FBRyxHQUFHLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQztJQUNyQyxJQUFJLE9BQU8sTUFBTSxDQUFDLE9BQU8sRUFBRSxPQUFPLEtBQUssUUFBUSxFQUFFLENBQUM7UUFDaEQsTUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEdBQUcsSUFBQSxnQkFBRSxFQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDdEQsQ0FBQztBQUNILENBQUMifQ==

package/dist/commonjs/lib/core/logger.d.ts

@@ -0,0 +1,3 @@
+import { EggLoggers } from 'egg-logger';
+import type { EggApplicationCore } from '../egg.js';
+export declare function createLoggers(app: EggApplicationCore): EggLoggers;

package/dist/commonjs/lib/core/logger.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLoggers = createLoggers;
+const egg_logger_1 = require("egg-logger");
+const onelogger_1 = require("onelogger");
+function createLoggers(app) {
+    const loggerOptions = {
+        ...app.config.logger,
+        type: app.type,
+        localStorage: app.ctxStorage,
+    };
+    // set DEBUG level into INFO on prod env
+    if (app.config.env === 'prod' && loggerOptions.level === 'DEBUG' && !app.config.logger.allowDebugAtProd) {
+        loggerOptions.level = 'INFO';
+    }
+    const loggers = new egg_logger_1.EggLoggers({
+        logger: loggerOptions,
+        customLogger: app.config.customLogger,
+    });
+    // won't print to console after started, except for local and unittest
+    app.ready(() => {
+        if (app.config.logger.disableConsoleAfterReady) {
+            loggers.disableConsole();
+            loggers.coreLogger.info('[egg:lib:core:logger] disable console log after app ready');
+        }
+    });
+    // set global logger
+    for (const loggerName of Object.keys(loggers)) {
+        (0, onelogger_1.setCustomLogger)(loggerName, loggers[loggerName]);
+    }
+    // reset global logger on beforeClose hook
+    app.lifecycle.registerBeforeClose(() => {
+        for (const loggerName of Object.keys(loggers)) {
+            (0, onelogger_1.setCustomLogger)(loggerName, undefined);
+        }
+    });
+    loggers.coreLogger.info('[egg:lib:core:logger] init all loggers with options: %j', loggerOptions);
+    return loggers;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9nZ2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9jb3JlL2xvZ2dlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUlBLHNDQXFDQztBQXpDRCwyQ0FBMkQ7QUFDM0QseUNBQTRDO0FBRzVDLFNBQWdCLGFBQWEsQ0FBQyxHQUF1QjtJQUNuRCxNQUFNLGFBQWEsR0FBRztRQUNwQixHQUFHLEdBQUcsQ0FBQyxNQUFNLENBQUMsTUFBTTtRQUNwQixJQUFJLEVBQUUsR0FBRyxDQUFDLElBQUk7UUFDZCxZQUFZLEVBQUUsR0FBRyxDQUFDLFVBQVU7S0FDUixDQUFDO0lBRXZCLHdDQUF3QztJQUN4QyxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxLQUFLLE1BQU0sSUFBSSxhQUFhLENBQUMsS0FBSyxLQUFLLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLGdCQUFnQixFQUFFLENBQUM7UUFDeEcsYUFBYSxDQUFDLEtBQUssR0FBRyxNQUFNLENBQUM7SUFDL0IsQ0FBQztJQUVELE1BQU0sT0FBTyxHQUFHLElBQUksdUJBQVUsQ0FBQztRQUM3QixNQUFNLEVBQUUsYUFBYTtRQUNyQixZQUFZLEVBQUUsR0FBRyxDQUFDLE1BQU0sQ0FBQyxZQUFZO0tBQ3RDLENBQUMsQ0FBQztJQUVILHNFQUFzRTtJQUN0RSxHQUFHLENBQUMsS0FBSyxDQUFDLEdBQUcsRUFBRTtRQUNiLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsd0JBQXdCLEVBQUUsQ0FBQztZQUMvQyxPQUFPLENBQUMsY0FBYyxFQUFFLENBQUM7WUFDekIsT0FBTyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsMkRBQTJELENBQUMsQ0FBQztRQUN2RixDQUFDO0lBQ0gsQ0FBQyxDQUFDLENBQUM7SUFFSCxvQkFBb0I7SUFDcEIsS0FBSyxNQUFNLFVBQVUsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7UUFDOUMsSUFBQSwyQkFBZSxFQUFDLFVBQVUsRUFBRSxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztJQUNuRCxDQUFDO0lBQ0QsMENBQTBDO0lBQzFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsbUJBQW1CLENBQUMsR0FBRyxFQUFFO1FBQ3JDLEtBQUssTUFBTSxVQUFVLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRSxDQUFDO1lBQzlDLElBQUEsMkJBQWUsRUFBQyxVQUFVLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDekMsQ0FBQztJQUNILENBQUMsQ0FBQyxDQUFDO0lBQ0gsT0FBTyxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMseURBQXlELEVBQUUsYUFBYSxDQUFDLENBQUM7SUFDbEcsT0FBTyxPQUFPLENBQUM7QUFDakIsQ0FBQyJ9

package/dist/commonjs/lib/core/messenger/IMessenger.d.ts

@@ -0,0 +1,50 @@
+import type { EventEmitter } from 'node:events';
+export interface IMessenger extends EventEmitter {
+    /**
+     * Send message to all agent and app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    broadcast(action: string, data?: unknown): IMessenger;
+    /**
+     * send message to the specified process
+     * @param {String} workerId - the workerId of the receiver
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendTo(workerId: string, action: string, data?: unknown): IMessenger;
+    /**
+     * send message to one app worker by random
+     * - if it's running in agent, it will send to one of app workers
+     * - if it's running in app, it will send to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendRandom(action: string, data?: unknown): IMessenger;
+    /**
+     * send message to app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToApp(action: string, data?: unknown): IMessenger;
+    /**
+     * send message to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToAgent(action: string, data?: unknown): IMessenger;
+    /**
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @param {String} to - let master know how to send message
+     * @return {Messenger} this
+     */
+    send(action: string, data: unknown | undefined, to?: string): IMessenger;
+    close(): void;
+    onMessage(message: any): void;
+}

package/dist/commonjs/lib/core/messenger/IMessenger.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiSU1lc3Nlbmdlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9saWIvY29yZS9tZXNzZW5nZXIvSU1lc3Nlbmdlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/dist/commonjs/lib/core/messenger/index.d.ts

@@ -0,0 +1,7 @@
+import type { IMessenger } from './IMessenger.js';
+import type { EggApplicationCore } from '../../egg.js';
+export type { IMessenger } from './IMessenger.js';
+/**
+ * @class Messenger
+ */
+export declare function create(egg: EggApplicationCore): IMessenger;

package/dist/commonjs/lib/core/messenger/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = create;
+const local_js_1 = require("./local.js");
+const ipc_js_1 = require("./ipc.js");
+/**
+ * @class Messenger
+ */
+function create(egg) {
+    return egg.options.mode === 'single'
+        ? new local_js_1.Messenger(egg)
+        : new ipc_js_1.Messenger(egg);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvbGliL2NvcmUvbWVzc2VuZ2VyL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBVUEsd0JBSUM7QUFkRCx5Q0FBeUQ7QUFDekQscUNBQXFEO0FBTXJEOztHQUVHO0FBQ0gsU0FBZ0IsTUFBTSxDQUFDLEdBQXVCO0lBQzVDLE9BQU8sR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEtBQUssUUFBUTtRQUNsQyxDQUFDLENBQUMsSUFBSSxvQkFBYyxDQUFDLEdBQUcsQ0FBQztRQUN6QixDQUFDLENBQUMsSUFBSSxrQkFBWSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQzVCLENBQUMifQ==

package/dist/commonjs/lib/core/messenger/ipc.d.ts

@@ -0,0 +1,59 @@
+import { EventEmitter } from 'node:events';
+import type { IMessenger } from './IMessenger.js';
+import type { EggApplicationCore } from '../../egg.js';
+/**
+ * Communication between app worker and agent worker by IPC channel
+ */
+export declare class Messenger extends EventEmitter implements IMessenger {
+    readonly pid: string;
+    readonly egg: EggApplicationCore;
+    opids: string[];
+    constructor(egg: EggApplicationCore);
+    /**
+     * Send message to all agent and app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    broadcast(action: string, data?: unknown): Messenger;
+    /**
+     * send message to the specified process
+     * @param {String} workerId - the workerId of the receiver
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendTo(workerId: string, action: string, data?: unknown): Messenger;
+    /**
+     * send message to one app worker by random
+     * - if it's running in agent, it will send to one of app workers
+     * - if it's running in app, it will send to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendRandom(action: string, data?: unknown): Messenger;
+    /**
+     * send message to app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToApp(action: string, data?: unknown): Messenger;
+    /**
+     * send message to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToAgent(action: string, data?: unknown): Messenger;
+    /**
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @param {String} to - let master know how to send message
+     * @return {Messenger} this
+     */
+    send(action: string, data: unknown | undefined, to?: string): Messenger;
+    onMessage(message: any): void;
+    close(): void;
+}

package/dist/commonjs/lib/core/messenger/ipc.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Messenger = void 0;
+const node_events_1 = require("node:events");
+const node_util_1 = require("node:util");
+const node_worker_threads_1 = __importDefault(require("node:worker_threads"));
+const sendmessage_1 = require("sendmessage");
+const debug = (0, node_util_1.debuglog)('egg/lib/core/messenger/ipc');
+/**
+ * Communication between app worker and agent worker by IPC channel
+ */
+class Messenger extends node_events_1.EventEmitter {
+    pid;
+    egg;
+    opids = [];
+    constructor(egg) {
+        super();
+        this.pid = String(process.pid);
+        this.egg = egg;
+        // pids of agent or app managed by master
+        // - retrieve app worker pids when it's an agent worker
+        // - retrieve agent worker pids when it's an app worker
+        this.on('egg-pids', workerIds => {
+            debug('[%s:%s] got egg-pids %j', this.egg.type, this.pid, workerIds);
+            this.opids = workerIds.map((workerId) => String(workerId));
+        });
+        this.onMessage = this.onMessage.bind(this);
+        process.on('message', this.onMessage);
+        if (!node_worker_threads_1.default.isMainThread) {
+            node_worker_threads_1.default.parentPort.on('message', this.onMessage);
+        }
+    }
+    /**
+     * Send message to all agent and app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    broadcast(action, data) {
+        debug('[%s:%s] broadcast %s with %j', this.egg.type, this.pid, action, data);
+        this.send(action, data, 'app');
+        this.send(action, data, 'agent');
+        return this;
+    }
+    /**
+     * send message to the specified process
+     * @param {String} workerId - the workerId of the receiver
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendTo(workerId, action, data) {
+        debug('[%s:%s] send %s with %j to workerId:%s', this.egg.type, this.pid, action, data, workerId);
+        (0, sendmessage_1.sendmessage)(process, {
+            action,
+            data,
+            /**
+             * @deprecated Keep compatible, please use receiverWorkerId instead
+             */
+            receiverPid: String(workerId),
+            receiverWorkerId: String(workerId),
+        });
+        return this;
+    }
+    /**
+     * send message to one app worker by random
+     * - if it's running in agent, it will send to one of app workers
+     * - if it's running in app, it will send to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendRandom(action, data) {
+        if (this.opids.length === 0) {
+            debug('[%s:%s] no pids, ignore sendRandom %s with %j', this.egg.type, this.pid, action, data);
+            return this;
+        }
+        const index = Math.floor(Math.random() * this.opids.length);
+        const workerId = this.opids[index];
+        this.sendTo(workerId, action, data);
+        return this;
+    }
+    /**
+     * send message to app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToApp(action, data) {
+        debug('[%s:%s] send %s with %j to all app', this.egg.type, this.pid, action, data);
+        this.send(action, data, 'app');
+        return this;
+    }
+    /**
+     * send message to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToAgent(action, data) {
+        debug('[%s:%s] send %s with %j to all agent', this.egg.type, this.pid, action, data);
+        this.send(action, data, 'agent');
+        return this;
+    }
+    /**
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @param {String} to - let master know how to send message
+     * @return {Messenger} this
+     */
+    send(action, data, to) {
+        (0, sendmessage_1.sendmessage)(process, {
+            action,
+            data,
+            to,
+        });
+        return this;
+    }
+    onMessage(message) {
+        if (typeof message?.action === 'string') {
+            debug('[%s:%s] got message %s with %j, receiverWorkerId: %s', this.egg.type, this.pid, message.action, message.data, message.receiverWorkerId ?? message.receiverPid);
+            this.emit(message.action, message.data);
+        }
+        else {
+            debug('[%s:%s] got an invalid message %j', this.egg.type, this.pid, message);
+        }
+    }
+    close() {
+        process.removeListener('message', this.onMessage);
+        this.removeAllListeners();
+    }
+}
+exports.Messenger = Messenger;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaXBjLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL2xpYi9jb3JlL21lc3Nlbmdlci9pcGMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsNkNBQTJDO0FBQzNDLHlDQUFxQztBQUNyQyw4RUFBZ0Q7QUFDaEQsNkNBQTBDO0FBSTFDLE1BQU0sS0FBSyxHQUFHLElBQUEsb0JBQVEsRUFBQyw0QkFBNEIsQ0FBQyxDQUFDO0FBRXJEOztHQUVHO0FBQ0gsTUFBYSxTQUFVLFNBQVEsMEJBQVk7SUFDaEMsR0FBRyxDQUFTO0lBQ1osR0FBRyxDQUFxQjtJQUNqQyxLQUFLLEdBQWEsRUFBRSxDQUFDO0lBRXJCLFlBQVksR0FBdUI7UUFDakMsS0FBSyxFQUFFLENBQUM7UUFDUixJQUFJLENBQUMsR0FBRyxHQUFHLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDL0IsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7UUFDZix5Q0FBeUM7UUFDekMsdURBQXVEO1FBQ3ZELHVEQUF1RDtRQUN2RCxJQUFJLENBQUMsRUFBRSxDQUFDLFVBQVUsRUFBRSxTQUFTLENBQUMsRUFBRTtZQUM5QixLQUFLLENBQUMseUJBQXlCLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxTQUFTLENBQUMsQ0FBQztZQUNyRSxJQUFJLENBQUMsS0FBSyxHQUFHLFNBQVMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxRQUFnQixFQUFFLEVBQUUsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQztRQUNyRSxDQUFDLENBQUMsQ0FBQztRQUNILElBQUksQ0FBQyxTQUFTLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDM0MsT0FBTyxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ3RDLElBQUksQ0FBQyw2QkFBYSxDQUFDLFlBQVksRUFBRSxDQUFDO1lBQ2hDLDZCQUFhLENBQUMsVUFBVyxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQzFELENBQUM7SUFDSCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxTQUFTLENBQUMsTUFBYyxFQUFFLElBQWM7UUFDdEMsS0FBSyxDQUFDLDhCQUE4QixFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsTUFBTSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQzdFLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQztRQUMvQixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDakMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsTUFBTSxDQUFDLFFBQWdCLEVBQUUsTUFBYyxFQUFFLElBQWM7UUFDckQsS0FBSyxDQUFDLHdDQUF3QyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxRQUFRLENBQUMsQ0FBQztRQUNqRyxJQUFBLHlCQUFXLEVBQUMsT0FBTyxFQUFFO1lBQ25CLE1BQU07WUFDTixJQUFJO1lBQ0o7O2VBRUc7WUFDSCxXQUFXLEVBQUUsTUFBTSxDQUFDLFFBQVEsQ0FBQztZQUM3QixnQkFBZ0IsRUFBRSxNQUFNLENBQUMsUUFBUSxDQUFDO1NBQ25DLENBQUMsQ0FBQztRQUNILE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7Ozs7O09BT0c7SUFDSCxVQUFVLENBQUMsTUFBYyxFQUFFLElBQWM7UUFDdkMsSUFBSSxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztZQUM1QixLQUFLLENBQUMsK0NBQStDLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7WUFDOUYsT0FBTyxJQUFJLENBQUM7UUFDZCxDQUFDO1FBQ0QsTUFBTSxLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUM1RCxNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ25DLElBQUksQ0FBQyxNQUFNLENBQUMsUUFBUSxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNwQyxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILFNBQVMsQ0FBQyxNQUFjLEVBQUUsSUFBYztRQUN0QyxLQUFLLENBQUMsb0NBQW9DLEVBQUUsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDbkYsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsSUFBSSxFQUFFLEtBQUssQ0FBQyxDQUFDO1FBQy9CLE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsV0FBVyxDQUFDLE1BQWMsRUFBRSxJQUFjO1FBQ3hDLEtBQUssQ0FBQyxzQ0FBc0MsRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNyRixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDakMsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxJQUFJLENBQUMsTUFBYyxFQUFFLElBQXlCLEVBQUUsRUFBVztRQUN6RCxJQUFBLHlCQUFXLEVBQUMsT0FBTyxFQUFFO1lBQ25CLE1BQU07WUFDTixJQUFJO1lBQ0osRUFBRTtTQUNILENBQUMsQ0FBQztRQUNILE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVELFNBQVMsQ0FBQyxPQUFZO1FBQ3BCLElBQUksT0FBTyxPQUFPLEVBQUUsTUFBTSxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ3hDLEtBQUssQ0FBQyxzREFBc0QsRUFDMUQsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxPQUFPLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLGdCQUFnQixJQUFJLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQztZQUMxRyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzFDLENBQUM7YUFBTSxDQUFDO1lBQ04sS0FBSyxDQUFDLG1DQUFtQyxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDL0UsQ0FBQztJQUNILENBQUM7SUFFRCxLQUFLO1FBQ0gsT0FBTyxDQUFDLGNBQWMsQ0FBQyxTQUFTLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ2xELElBQUksQ0FBQyxrQkFBa0IsRUFBRSxDQUFDO0lBQzVCLENBQUM7Q0FPRjtBQXZJRCw4QkF1SUMifQ==

package/dist/commonjs/lib/core/messenger/local.d.ts

@@ -0,0 +1,61 @@
+import EventEmitter from 'node:events';
+import type { IMessenger } from './IMessenger.js';
+import type { EggApplicationCore } from '../../egg.js';
+/**
+ * Communication between app worker and agent worker with EventEmitter
+ */
+export declare class Messenger extends EventEmitter implements IMessenger {
+    readonly pid: string;
+    readonly egg: EggApplicationCore;
+    constructor(egg: EggApplicationCore);
+    /**
+     * Send message to all agent and app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    broadcast(action: string, data?: unknown): Messenger;
+    /**
+     * send message to the specified process
+     * Notice: in single process mode, it only can send to self process,
+     * and it will send to both agent and app's messengers.
+     * @param {String} workerId - the workerId of the receiver
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendTo(workerId: string, action: string, data?: unknown): Messenger;
+    /**
+     * send message to one worker by random
+     * Notice: in single process mode, we only start one agent worker and one app worker
+     * - if it's running in agent, it will send to one of app workers
+     * - if it's running in app, it will send to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendRandom(action: string, data?: unknown): Messenger;
+    /**
+     * send message to app
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToApp(action: string, data?: unknown): Messenger;
+    /**
+     * send message to agent
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @return {Messenger} this
+     */
+    sendToAgent(action: string, data?: unknown): Messenger;
+    /**
+     * @param {String} action - message key
+     * @param {Object} data - message value
+     * @param {String} to - let master know how to send message
+     * @return {Messenger} this
+     */
+    send(action: string, data: unknown | undefined, to?: string): Messenger;
+    onMessage(message: any): void;
+    close(): void;
+}