@eggjs/cluster 4.0.0-beta.19 → 4.0.0-beta.20

package/dist/utils/messenger.d.ts

@@ -1,96 +0,0 @@
-import { WorkerManager } from "./worker_manager.js";
-import { Master } from "../master.js";
-
-//#region src/utils/messenger.d.ts
-type MessageCharacter = 'agent' | 'app' | 'master' | 'parent';
-interface MessageBody {
-  action: string;
-  data?: unknown;
-  to?: MessageCharacter;
-  from?: MessageCharacter;
-  /**
-   * @deprecated Keep compatible, please use receiverWorkerId instead
-   */
-  receiverPid?: string;
-  receiverWorkerId?: string;
-  senderWorkerId?: string;
-}
-/**
- * master messenger, provide communication between parent, master, agent and app.
- *
- *             ┌────────┐
- *             │ parent │
- *            /└────────┘\
- *           /     |      \
- *          /  ┌────────┐  \
- *         /   │ master │   \
- *        /    └────────┘    \
- *       /     /         \    \
- *     ┌───────┐         ┌───────┐
- *     │ agent │ ------- │  app  │
- *     └───────┘         └───────┘
- *
- *
- * in app worker
- *
- * ```js
- * process.send({
- *   action: 'xxx',
- *   data: '',
- *   to: 'agent/master/parent', // default to agent
- * });
- * ```
- *
- * in agent worker
- *
- * ```js
- * process.send({
- *   action: 'xxx',
- *   data: '',
- *   to: 'app/master/parent', // default to app
- * });
- * ```
- *
- * in parent
- *
- * ```js
- * process.send({
- *   action: 'xxx',
- *   data: '',
- *   to: 'app/agent/master', // default to master
- * });
- * ```
- */
-declare class Messenger {
-  #private;
-  constructor(master: Master, workerManager: WorkerManager);
-  /**
-   * send message
-   * @param {Object} data message body
-   *  - {String} from from who
-   *  - {String} to to who
-   */
-  send(data: MessageBody): void;
-  /**
-   * send message to master self
-   * @param {Object} data message body
-   */
-  sendToMaster(data: MessageBody): void;
-  /**
-   * send message to parent process
-   * @param {Object} data message body
-   */
-  sendToParent(data: MessageBody): void;
-  /**
-   * send message to app worker
-   * @param {Object} data message body
-   */
-  sendToAppWorker(data: MessageBody): void;
-  /**
-   * send message to agent worker
-   * @param {Object} data message body
-   */
-  sendToAgentWorker(data: MessageBody): void;
-}
-//#endregion
-export { MessageBody, Messenger };

package/dist/utils/messenger.js

@@ -1,144 +0,0 @@
-import { debuglog } from "node:util";
-import workerThreads from "node:worker_threads";
-
-//#region src/utils/messenger.ts
-const debug = debuglog("egg/cluster/messenger");
-/**
-* master messenger, provide communication between parent, master, agent and app.
-*
-*             ┌────────┐
-*             │ parent │
-*            /└────────┘\
-*           /     |      \
-*          /  ┌────────┐  \
-*         /   │ master │   \
-*        /    └────────┘    \
-*       /     /         \    \
-*     ┌───────┐         ┌───────┐
-*     │ agent │ ------- │  app  │
-*     └───────┘         └───────┘
-*
-*
-* in app worker
-*
-* ```js
-* process.send({
-*   action: 'xxx',
-*   data: '',
-*   to: 'agent/master/parent', // default to agent
-* });
-* ```
-*
-* in agent worker
-*
-* ```js
-* process.send({
-*   action: 'xxx',
-*   data: '',
-*   to: 'app/master/parent', // default to app
-* });
-* ```
-*
-* in parent
-*
-* ```js
-* process.send({
-*   action: 'xxx',
-*   data: '',
-*   to: 'app/agent/master', // default to master
-* });
-* ```
-*/
-var Messenger = class {
-	#master;
-	#workerManager;
-	#hasParent;
-	constructor(master, workerManager) {
-		this.#master = master;
-		this.#workerManager = workerManager;
-		this.#hasParent = !!workerThreads.parentPort || !!process.send;
-		process.on("message", (msg) => {
-			msg.from = "parent";
-			this.send(msg);
-		});
-		process.once("disconnect", () => {
-			this.#hasParent = false;
-		});
-	}
-	/**
-	* send message
-	* @param {Object} data message body
-	*  - {String} from from who
-	*  - {String} to to who
-	*/
-	send(data) {
-		if (!data.from) data.from = "master";
-		const receiverWorkerId = data.receiverWorkerId ?? data.receiverPid;
-		if (receiverWorkerId) if (receiverWorkerId === String(process.pid)) data.to = "master";
-		else if (receiverWorkerId === String(this.#workerManager.getAgent().workerId)) data.to = "agent";
-		else data.to = "app";
-		if (!data.to) {
-			if (data.from === "agent") data.to = "app";
-			if (data.from === "app") data.to = "agent";
-			if (data.from === "parent") data.to = "master";
-		}
-		if (data.to === "master") {
-			debug("%s -> master, data: %j", data.from, data);
-			this.sendToMaster(data);
-			return;
-		}
-		if (data.to === "parent") {
-			debug("%s -> parent, data: %j", data.from, data);
-			this.sendToParent(data);
-			return;
-		}
-		if (data.to === "app") {
-			debug("%s -> %s, data: %j", data.from, data.to, data);
-			this.sendToAppWorker(data);
-			return;
-		}
-		if (data.to === "agent") {
-			debug("%s -> %s, data: %j", data.from, data.to, data);
-			this.sendToAgentWorker(data);
-			return;
-		}
-	}
-	/**
-	* send message to master self
-	* @param {Object} data message body
-	*/
-	sendToMaster(data) {
-		this.#master.emit(data.action, data.data);
-	}
-	/**
-	* send message to parent process
-	* @param {Object} data message body
-	*/
-	sendToParent(data) {
-		if (!this.#hasParent) return;
-		process.send(data);
-	}
-	/**
-	* send message to app worker
-	* @param {Object} data message body
-	*/
-	sendToAppWorker(data) {
-		for (const worker of this.#workerManager.listWorkers()) {
-			if (worker.state === "disconnected") continue;
-			const receiverWorkerId = data.receiverWorkerId ?? data.receiverPid;
-			if (receiverWorkerId && receiverWorkerId !== String(worker.workerId)) continue;
-			worker.send(data);
-		}
-	}
-	/**
-	* send message to agent worker
-	* @param {Object} data message body
-	*/
-	sendToAgentWorker(data) {
-		const agent = this.#workerManager.getAgent();
-		if (agent) agent.send(data);
-	}
-};
-
-//#endregion
-export { Messenger };

package/dist/utils/mode/base/agent.d.ts

@@ -1,45 +0,0 @@
-import { MessageBody, Messenger } from "../../messenger.js";
-import { MasterOptions } from "../../../master.js";
-import { Logger } from "egg-logger";
-import { EventEmitter } from "node:events";
-import { Worker } from "node:worker_threads";
-import { ChildProcess } from "node:child_process";
-
-//#region src/utils/mode/base/agent.d.ts
-declare abstract class BaseAgentWorker<T = ChildProcess | Worker> {
-  #private;
-  instance: T;
-  constructor(instance: T);
-  abstract get workerId(): number;
-  get id(): number;
-  set id(id: number);
-  get status(): string;
-  set status(status: string);
-  abstract send(message: MessageBody): void;
-  static send(_message: MessageBody): void;
-  static kill(): void;
-  static gracefulExit(_options: any): void;
-}
-type LogFun = (msg: any, ...args: any[]) => void;
-declare abstract class BaseAgentUtils extends EventEmitter {
-  protected options: MasterOptions;
-  protected messenger: Messenger;
-  protected log: LogFun;
-  protected logger: Logger;
-  startTime: number;
-  constructor(options: MasterOptions, {
-    log,
-    logger,
-    messenger
-  }: {
-    log: LogFun;
-    logger: Logger;
-    messenger: Messenger;
-  });
-  getAgentWorkerFile(): string;
-  fork(): void;
-  clean(): void;
-  abstract kill(timeout: number): Promise<void>;
-}
-//#endregion
-export { BaseAgentUtils, BaseAgentWorker };

package/dist/utils/mode/base/agent.js

@@ -1,63 +0,0 @@
-import { getSrcDirname } from "../../../dirname.js";
-import path from "node:path";
-import { existsSync } from "node:fs";
-import { EventEmitter } from "node:events";
-
-//#region src/utils/mode/base/agent.ts
-var BaseAgentWorker = class {
-	instance;
-	#instanceId;
-	#instanceStatus;
-	constructor(instance) {
-		this.instance = instance;
-	}
-	get id() {
-		return this.#instanceId;
-	}
-	set id(id) {
-		this.#instanceId = id;
-	}
-	get status() {
-		return this.#instanceStatus;
-	}
-	set status(status) {
-		this.#instanceStatus = status;
-	}
-	static send(_message) {
-		throw new Error("BaseAgentWorker should implement send.");
-	}
-	static kill() {
-		throw new Error("BaseAgentWorker should implement kill.");
-	}
-	static gracefulExit(_options) {
-		throw new Error("BaseAgentWorker should implement gracefulExit.");
-	}
-};
-var BaseAgentUtils = class extends EventEmitter {
-	options;
-	messenger;
-	log;
-	logger;
-	startTime = 0;
-	constructor(options, { log, logger, messenger }) {
-		super();
-		this.options = options;
-		this.log = log;
-		this.logger = logger;
-		this.messenger = messenger;
-	}
-	getAgentWorkerFile() {
-		let agentWorkerFile = path.join(getSrcDirname(), "agent_worker.js");
-		if (!existsSync(agentWorkerFile)) agentWorkerFile = path.join(getSrcDirname(), "agent_worker.ts");
-		return agentWorkerFile;
-	}
-	fork() {
-		throw new Error("BaseAgent should implement fork.");
-	}
-	clean() {
-		throw new Error("BaseAgent should implement clean.");
-	}
-};
-
-//#endregion
-export { BaseAgentUtils, BaseAgentWorker };

package/dist/utils/mode/base/app.d.ts

@@ -1,56 +0,0 @@
-import { MessageBody, Messenger } from "../../messenger.js";
-import { MasterOptions } from "../../../master.js";
-import { Logger } from "egg-logger";
-import { EventEmitter } from "node:events";
-import { Worker } from "node:worker_threads";
-import { Worker as Worker$1 } from "node:cluster";
-
-//#region src/utils/mode/base/app.d.ts
-declare abstract class BaseAppWorker<T = Worker | Worker$1> {
-  instance: T;
-  constructor(instance: T);
-  abstract get workerId(): number;
-  abstract get id(): number;
-  get state(): string;
-  set state(state: string);
-  abstract get exitedAfterDisconnect(): boolean;
-  abstract get exitCode(): number;
-  get disableRefork(): boolean;
-  set disableRefork(disableRefork: boolean);
-  get isDevReload(): boolean;
-  set isDevReload(isDevReload: boolean);
-  abstract send(data: MessageBody): void;
-  clean(): void;
-  static get workerId(): number;
-  static on(..._args: any[]): void;
-  static send(_message: MessageBody): void;
-  static kill(): void;
-  static gracefulExit(_options: any): void;
-}
-type LogFun = (msg: any, ...args: any[]) => void;
-declare abstract class BaseAppUtils extends EventEmitter {
-  options: MasterOptions;
-  protected messenger: Messenger;
-  protected log: LogFun;
-  protected logger: Logger;
-  protected isProduction: boolean;
-  startTime: number;
-  startSuccessCount: number;
-  isAllWorkerStarted: boolean;
-  constructor(options: MasterOptions, {
-    log,
-    logger,
-    messenger,
-    isProduction
-  }: {
-    log: LogFun;
-    logger: Logger;
-    messenger: Messenger;
-    isProduction: boolean;
-  });
-  getAppWorkerFile(): string;
-  fork(): void;
-  abstract kill(timeout: number): Promise<void>;
-}
-//#endregion
-export { BaseAppUtils, BaseAppWorker };

package/dist/utils/mode/base/app.js

@@ -1,77 +0,0 @@
-import { getSrcDirname } from "../../../dirname.js";
-import path from "node:path";
-import { existsSync } from "node:fs";
-import { EventEmitter } from "node:events";
-
-//#region src/utils/mode/base/app.ts
-var BaseAppWorker = class {
-	instance;
-	constructor(instance) {
-		this.instance = instance;
-	}
-	get state() {
-		return Reflect.get(this.instance, "state");
-	}
-	set state(state) {
-		Reflect.set(this.instance, "state", state);
-	}
-	get disableRefork() {
-		return Reflect.get(this.instance, "disableRefork");
-	}
-	set disableRefork(disableRefork) {
-		Reflect.set(this.instance, "disableRefork", disableRefork);
-	}
-	get isDevReload() {
-		return Reflect.get(this.instance, "isDevReload");
-	}
-	set isDevReload(isDevReload) {
-		Reflect.set(this.instance, "isDevReload", isDevReload);
-	}
-	clean() {
-		throw new Error("BaseAppWorker should implement clean.");
-	}
-	static get workerId() {
-		throw new Error("BaseAppWorker should implement workerId.");
-	}
-	static on(..._args) {
-		throw new Error("BaseAppWorker should implement on.");
-	}
-	static send(_message) {
-		throw new Error("BaseAgentWorker should implement send.");
-	}
-	static kill() {
-		throw new Error("BaseAppWorker should implement kill.");
-	}
-	static gracefulExit(_options) {
-		throw new Error("BaseAgentWorker should implement gracefulExit.");
-	}
-};
-var BaseAppUtils = class extends EventEmitter {
-	options;
-	messenger;
-	log;
-	logger;
-	isProduction;
-	startTime = 0;
-	startSuccessCount = 0;
-	isAllWorkerStarted = false;
-	constructor(options, { log, logger, messenger, isProduction }) {
-		super();
-		this.options = options;
-		this.log = log;
-		this.logger = logger;
-		this.messenger = messenger;
-		this.isProduction = isProduction;
-	}
-	getAppWorkerFile() {
-		let appWorkerFile = path.join(getSrcDirname(), "app_worker.js");
-		if (!existsSync(appWorkerFile)) appWorkerFile = path.join(getSrcDirname(), "app_worker.ts");
-		return appWorkerFile;
-	}
-	fork() {
-		throw new Error("BaseApp should implement fork.");
-	}
-};
-
-//#endregion
-export { BaseAppUtils, BaseAppWorker };

package/dist/utils/mode/impl/process/agent.d.ts

@@ -1,22 +0,0 @@
-import { BaseAgentUtils, BaseAgentWorker } from "../../base/agent.js";
-import { MessageBody } from "../../../messenger.js";
-import { ChildProcess } from "node:child_process";
-import { Options } from "graceful-process";
-
-//#region src/utils/mode/impl/process/agent.d.ts
-declare class AgentProcessWorker extends BaseAgentWorker<ChildProcess> {
-  get workerId(): number;
-  send(message: MessageBody): void;
-  static send(message: MessageBody): void;
-  static kill(): void;
-  static gracefulExit(options: Options): void;
-}
-declare class AgentProcessUtils extends BaseAgentUtils {
-  #private;
-  instance: AgentProcessWorker;
-  fork(): this;
-  clean(): void;
-  kill(timeout: number): Promise<void>;
-}
-//#endregion
-export { AgentProcessUtils };

package/dist/utils/mode/impl/process/agent.js

@@ -1,93 +0,0 @@
-import { BaseAgentUtils, BaseAgentWorker } from "../../base/agent.js";
-import { terminate } from "../../../terminate.js";
-import { ClusterAgentWorkerError } from "../../../../error/ClusterAgentWorkerError.js";
-import { fork } from "node:child_process";
-import { sendmessage } from "sendmessage";
-import { graceful } from "graceful-process";
-
-//#region src/utils/mode/impl/process/agent.ts
-var AgentProcessWorker = class extends BaseAgentWorker {
-	get workerId() {
-		return this.instance.pid;
-	}
-	send(message) {
-		sendmessage(this.instance, message);
-	}
-	static send(message) {
-		message.senderWorkerId = String(process.pid);
-		process.send(message);
-	}
-	static kill() {
-		process.exitCode = 1;
-		process.kill(process.pid);
-	}
-	static gracefulExit(options) {
-		graceful(options);
-	}
-};
-var AgentProcessUtils = class extends BaseAgentUtils {
-	#agentProcess;
-	#id = 0;
-	instance;
-	fork() {
-		this.startTime = Date.now();
-		const args = [JSON.stringify(this.options)];
-		const forkOptions = {};
-		if (process.platform === "win32") forkOptions.windowsHide = true;
-		const debugPort = process.env.EGG_AGENT_DEBUG_PORT ?? 5800;
-		if (this.options.isDebug) forkOptions.execArgv = process.execArgv.concat([`--inspect-port=${debugPort}`]);
-		const agentProcess = this.#agentProcess = fork(this.getAgentWorkerFile(), args, forkOptions);
-		const agentWorker = this.instance = new AgentProcessWorker(agentProcess);
-		agentWorker.status = "starting";
-		agentWorker.id = ++this.#id;
-		this.emit("agent_forked", agentWorker);
-		this.log("[master] agent_worker#%s:%s start with clusterPort:%s", agentWorker.id, agentWorker.workerId, this.options.clusterPort);
-		if (this.options.isDebug) this.messenger.send({
-			to: "parent",
-			from: "agent",
-			action: "debug",
-			data: {
-				debugPort,
-				pid: agentWorker.workerId,
-				workerId: agentWorker.workerId
-			}
-		});
-		agentProcess.on("message", (msg) => {
-			if (typeof msg === "string") msg = {
-				action: msg,
-				data: msg
-			};
-			msg.from = "agent";
-			this.messenger.send(msg);
-		});
-		agentProcess.on("error", (err) => {
-			err.name = "AgentWorkerError";
-			this.logger.error(new ClusterAgentWorkerError(agentWorker.id, agentWorker.workerId, agentWorker.status, err));
-		});
-		agentProcess.once("exit", (code, signal) => {
-			this.messenger.send({
-				action: "agent-exit",
-				data: {
-					code,
-					signal
-				},
-				to: "master",
-				from: "agent"
-			});
-		});
-		return this;
-	}
-	clean() {
-		this.#agentProcess.removeAllListeners();
-	}
-	async kill(timeout) {
-		if (this.#agentProcess) {
-			this.log("[master] kill agent worker with signal SIGTERM");
-			this.clean();
-			await terminate(this.#agentProcess, timeout);
-		}
-	}
-};
-
-//#endregion
-export { AgentProcessUtils, AgentProcessWorker };

package/dist/utils/mode/impl/process/app.d.ts

@@ -1,12 +0,0 @@
-import { BaseAppUtils } from "../../base/app.js";
-import { Options } from "graceful-process";
-import { Worker } from "node:cluster";
-
-//#region src/utils/mode/impl/process/app.d.ts
-
-declare class AppProcessUtils extends BaseAppUtils {
-  fork(): this;
-  kill(timeout: number): Promise<void>;
-}
-//#endregion
-export { AppProcessUtils };