@eggjs/cluster 3.0.1 → 3.1.0-beta.11

package/dist/utils/options.d.ts

@@ -0,0 +1,83 @@
+import { SecureContextOptions } from "node:tls";
+
+//#region src/utils/options.d.ts
+interface ClusterHTTPSSecureOptions {
+  key: SecureContextOptions['key'];
+  cert: SecureContextOptions['cert'];
+  ca?: SecureContextOptions['ca'];
+  passphrase?: SecureContextOptions['passphrase'];
+}
+type ClusterStartMode = 'process' | 'worker_threads';
+/** Cluster start options */
+interface ClusterOptions {
+  /**
+   * specify framework that can be absolute path or npm package
+   */
+  framework?: string;
+  /**
+   * @deprecated please use framework instead
+   */
+  customEgg?: string;
+  /** directory of application, default to `process.cwd()` */
+  baseDir?: string;
+  /**
+   * numbers of app workers, default to `os.cpus().length`
+   */
+  workers?: number | string;
+  /**
+   * listening port, default to `7001`(http) or `8443`(https)
+   */
+  port?: number | string | null;
+  /**
+   * listening a debug port on http protocol
+   */
+  debugPort?: number;
+  /**
+   * https options, { key, cert, ca }, full path
+   */
+  https?: ClusterHTTPSSecureOptions | boolean;
+  /**
+   * @deprecated please use `options.https.key` instead
+   */
+  key?: ClusterHTTPSSecureOptions['key'];
+  /**
+   * @deprecated please use `options.https.cert` instead
+   */
+  cert?: ClusterHTTPSSecureOptions['cert'];
+  /**
+   * will inject into worker/agent process
+   */
+  require?: string | string[];
+  /**
+   * will save master pid to this file
+   */
+  pidFile?: string;
+  /**
+   * custom env, default is `process.env.EGG_SERVER_ENV`
+   */
+  env?: string;
+  /**
+   * default is `'process'`, use `'worker_threads'` to start the app & agent worker by worker_threads
+   */
+  startMode?: ClusterStartMode;
+  /**
+   * startup port of each app worker, such as: `[7001, 7002, 7003]`, only effects when the startMode is `'worker_threads'`
+   */
+  ports?: number[];
+  /**
+   * sticky mode server
+   */
+  sticky?: boolean;
+  /** customized plugins, for unittest */
+  plugins?: object;
+  isDebug?: boolean;
+}
+interface ParsedClusterOptions extends ClusterOptions {
+  port?: number;
+  baseDir: string;
+  workers: number;
+  framework: string;
+  startMode: ClusterStartMode;
+}
+//#endregion
+export { ClusterHTTPSSecureOptions, ClusterOptions, ClusterStartMode, ParsedClusterOptions };

package/dist/utils/options.js

@@ -0,0 +1,56 @@
+import os from "node:os";
+import { debuglog } from "node:util";
+import path from "node:path";
+import fs from "node:fs";
+import assert from "node:assert";
+import { getFrameworkPath, importModule } from "@eggjs/utils";
+
+//#region src/utils/options.ts
+const debug = debuglog("egg/cluster/utils/options");
+async function parseOptions(options) {
+	options = {
+		baseDir: process.cwd(),
+		port: options?.https ? 8443 : void 0,
+		startMode: "process",
+		env: process.env.EGG_SERVER_ENV,
+		...options
+	};
+	const pkgPath = path.join(options.baseDir, "package.json");
+	assert(fs.existsSync(pkgPath), `${pkgPath} should exist`);
+	options.framework = getFrameworkPath({
+		baseDir: options.baseDir,
+		framework: options.framework ?? options.customEgg
+	});
+	debug("[parseOptions] %o", options);
+	const egg = await importModule(options.framework, { paths: [options.baseDir] });
+	assert(egg.Application, `should define Application in ${options.framework}`);
+	assert(egg.Agent, `should define Agent in ${options.framework}`);
+	if (options.https === true) {
+		console.warn("[@eggjs/cluster:deprecated] [master] Please use `https: { key, cert, ca }` instead of `https: true`");
+		options.https = {
+			key: options.key,
+			cert: options.cert
+		};
+	}
+	if (options.https) {
+		assert(options.https.key, "options.https.key should exists");
+		if (typeof options.https.key === "string") assert(fs.existsSync(options.https.key), "options.https.key file should exists");
+		assert(options.https.cert, "options.https.cert should exists");
+		if (typeof options.https.cert === "string") assert(fs.existsSync(options.https.cert), "options.https.cert file should exists");
+		if (typeof options.https.ca === "string") assert(fs.existsSync(options.https.ca), "options.https.ca file should exists");
+	}
+	if (options.port && typeof options.port === "string") options.port = parseInt(options.port);
+	if (options.port === null) options.port = void 0;
+	if (options.workers && typeof options.workers === "string") options.workers = parseInt(options.workers);
+	if (!options.workers) options.workers = os.cpus().length;
+	if (options.require) {
+		if (typeof options.require === "string") options.require = [options.require];
+	}
+	if (process.env.NODE_ENV === "production") process.env.NO_DEPRECATION = "*";
+	const isDebug = process.execArgv.some((argv) => argv.includes("--debug") || argv.includes("--inspect"));
+	if (isDebug) options.isDebug = isDebug;
+	return options;
+}
+
+//#endregion
+export { parseOptions };

package/dist/utils/terminate.js

@@ -0,0 +1,62 @@
+import { debuglog } from "node:util";
+import { once } from "node:events";
+import { ChildProcess } from "node:child_process";
+import { setTimeout } from "node:timers/promises";
+import { pstree } from "@fengmk2/ps-tree";
+
+//#region src/utils/terminate.ts
+const debug = debuglog("egg/cluster/utils/terminate");
+async function terminate(subProcess, timeout) {
+	const pid = subProcess.process?.pid ?? subProcess.pid;
+	const childPids = await getChildPids(pid);
+	await Promise.all([killProcess(subProcess, timeout), killChildren(childPids, timeout)]);
+}
+async function killProcess(subProcess, timeout) {
+	(subProcess.process ?? subProcess).kill("SIGTERM");
+	await Promise.race([once(subProcess, "exit"), setTimeout(timeout)]);
+	if (subProcess.killed) return;
+	(subProcess.process ?? subProcess).kill("SIGKILL");
+}
+async function killChildren(childrenPids, timeout) {
+	if (childrenPids.length === 0) return;
+	kill(childrenPids, "SIGTERM");
+	const start = Date.now();
+	const checkInterval = 400;
+	let unterminated = [];
+	while (Date.now() - start < timeout - checkInterval) {
+		await setTimeout(checkInterval);
+		unterminated = getUnterminatedProcesses(childrenPids);
+		if (unterminated.length === 0) return;
+	}
+	kill(unterminated, "SIGKILL");
+}
+async function getChildPids(pid) {
+	let childrenPids = [];
+	try {
+		childrenPids = (await pstree(pid)).map((c) => parseInt(c.PID));
+	} catch (err) {
+		debug("pstree %s error: %s, ignore it", pid, err);
+	}
+	return childrenPids;
+}
+function kill(pids, signal) {
+	for (const pid of pids) try {
+		process.kill(pid, signal);
+	} catch (err) {
+		debug("kill %s error: %s, signal: %s, ignore it", pid, err, signal);
+	}
+}
+function getUnterminatedProcesses(pids) {
+	return pids.filter((pid) => {
+		try {
+			process.kill(pid, 0);
+			return true;
+		} catch (err) {
+			debug("kill %s error: %s, it still alive", pid, err);
+			return false;
+		}
+	});
+}
+
+//#endregion
+export { terminate };

package/dist/utils/worker_manager.d.ts

@@ -0,0 +1,32 @@
+import { BaseAgentWorker } from "./mode/base/agent.js";
+import { BaseAppWorker } from "./mode/base/app.js";
+import { EventEmitter } from "node:events";
+import * as worker_threads0 from "worker_threads";
+import * as cluster0 from "cluster";
+import * as child_process0 from "child_process";
+
+//#region src/utils/worker_manager.d.ts
+declare class WorkerManager extends EventEmitter {
+  agent: BaseAgentWorker | null;
+  workers: Map<number, BaseAppWorker<worker_threads0.Worker | cluster0.Worker>>;
+  exception: number;
+  timer: NodeJS.Timeout;
+  constructor();
+  getWorkers(): number[];
+  setAgent(agent: BaseAgentWorker): void;
+  getAgent(): BaseAgentWorker<worker_threads0.Worker | child_process0.ChildProcess> | null;
+  deleteAgent(): void;
+  setWorker(worker: BaseAppWorker): void;
+  getWorker(workerId: number): BaseAppWorker<worker_threads0.Worker | cluster0.Worker> | undefined;
+  deleteWorker(workerId: number): void;
+  listWorkerIds(): number[];
+  listWorkers(): BaseAppWorker<worker_threads0.Worker | cluster0.Worker>[];
+  getListeningWorkerIds(): number[];
+  count(): {
+    agent: number;
+    worker: number;
+  };
+  startCheck(): void;
+}
+//#endregion
+export { WorkerManager };

package/dist/utils/worker_manager.js

@@ -0,0 +1,68 @@
+import { EventEmitter } from "node:events";
+
+//#region src/utils/worker_manager.ts
+var WorkerManager = class extends EventEmitter {
+	agent;
+	workers = /* @__PURE__ */ new Map();
+	exception = 0;
+	timer;
+	constructor() {
+		super();
+		this.agent = null;
+	}
+	getWorkers() {
+		return Array.from(this.workers.keys());
+	}
+	setAgent(agent) {
+		this.agent = agent;
+	}
+	getAgent() {
+		return this.agent;
+	}
+	deleteAgent() {
+		this.agent = null;
+	}
+	setWorker(worker) {
+		this.workers.set(worker.workerId, worker);
+	}
+	getWorker(workerId) {
+		return this.workers.get(workerId);
+	}
+	deleteWorker(workerId) {
+		this.workers.delete(workerId);
+	}
+	listWorkerIds() {
+		return Array.from(this.workers.keys());
+	}
+	listWorkers() {
+		return Array.from(this.workers.values());
+	}
+	getListeningWorkerIds() {
+		const keys = [];
+		for (const [id, worker] of this.workers.entries()) if (worker.state === "listening") keys.push(id);
+		return keys;
+	}
+	count() {
+		return {
+			agent: this.agent?.status === "started" ? 1 : 0,
+			worker: this.listWorkerIds().length
+		};
+	}
+	startCheck() {
+		this.timer = setInterval(() => {
+			const count = this.count();
+			if (count.agent > 0 && count.worker > 0) {
+				this.exception = 0;
+				return;
+			}
+			this.exception++;
+			if (this.exception >= 3) {
+				this.emit("exception", count);
+				clearInterval(this.timer);
+			}
+		}, 1e4);
+	}
+};
+
+//#endregion
+export { WorkerManager };

package/package.json

@@ -1,25 +1,27 @@
 {
   "name": "@eggjs/cluster",
-  "version": "3.0.1",
+  "version": "3.1.0-beta.11",
   "publishConfig": {
     "access": "public"
   },
-  "description": "cluster manager for egg",
-  "scripts": {
-    "lint": "eslint --cache src test --ext .ts",
-    "pretest": "npm run lint -- --fix && npm run prepublishOnly",
-    "test": "egg-bin test",
-    "preci": "npm run lint && npm run prepublishOnly",
-    "ci": "egg-bin test",
-    "prepublishOnly": "tshy && tshy-after && attw --pack"
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./agent_worker": "./dist/agent_worker.js",
+    "./app_worker": "./dist/app_worker.js",
+    "./package.json": "./package.json"
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "description": "cluster manager for egg",
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/eggjs/cluster.git"
+    "url": "git://github.com/eggjs/egg.git",
+    "directory": "packages/cluster"
   },
   "keywords": [
     "egg",
@@ -29,66 +31,42 @@
   "author": "dead-horse <dead_horse@qq.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/eggjs/cluster/issues"
+    "url": "https://github.com/eggjs/egg/issues"
   },
-  "homepage": "https://github.com/eggjs/cluster#readme",
+  "homepage": "https://github.com/eggjs/egg/tree/next/packages/cluster",
   "dependencies": {
-    "@eggjs/utils": "^4.2.1",
     "@fengmk2/ps-tree": "^2.0.1",
     "cfork": "^2.0.0",
     "cluster-reload": "^2.0.0",
-    "detect-port": "^2.0.1",
-    "egg-logger": "^3.6.0",
-    "get-ready": "^3.2.0",
+    "detect-port": "^2.1.0",
+    "egg-logger": "^3.5.0",
+    "get-ready": "^3.1.0",
     "graceful-process": "^2.0.0",
     "sendmessage": "^3.0.1",
-    "terminal-link": "^2.1.1",
-    "utility": "^2.2.0"
+    "terminal-link": "^5.0.0",
+    "utility": "^2.5.0",
+    "@eggjs/utils": "4.5.0-beta.11"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.1",
-    "@eggjs/bin": "^7.0.0",
-    "@eggjs/mock": "beta",
-    "@eggjs/supertest": "^8.1.1",
-    "@eggjs/tsconfig": "1",
-    "@types/mocha": "10",
-    "@types/node": "22",
-    "address": "^2.0.3",
-    "coffee": "^5.5.1",
-    "egg": "beta",
-    "egg-errors": "^2.2.0",
-    "eslint": "8",
-    "eslint-config-egg": "14",
-    "ts-node": "^10.9.1",
-    "tshy": "3",
-    "tshy-after": "1",
-    "typescript": "5",
-    "urllib": "^4.6.8"
+    "@types/node": "24.5.2",
+    "address": "2",
+    "coffee": "5",
+    "egg-errors": "^2.3.2",
+    "tsdown": "^0.15.4",
+    "typescript": "5.9.2",
+    "urllib": "^4.6.11",
+    "vitest": "4.0.0-beta.13",
+    "@eggjs/tsconfig": "3.1.0-beta.11",
+    "@eggjs/supertest": "8.3.0-beta.11",
+    "@eggjs/mock": "6.1.0-beta.11"
   },
   "engines": {
-    "node": ">= 18.19.0"
+    "node": ">= 20.19.0"
   },
-  "type": "module",
-  "tshy": {
-    "exports": {
-      ".": "./src/index.ts",
-      "./package.json": "./package.json"
-    }
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    },
-    "./package.json": "./package.json"
-  },
-  "types": "./dist/commonjs/index.d.ts",
-  "main": "./dist/commonjs/index.js",
-  "module": "./dist/esm/index.js"
-}
+  "scripts": {
+    "build": "tsdown",
+    "lint": "oxlint",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}

package/dist/commonjs/agent_worker.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/commonjs/agent_worker.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_util_1 = require("node:util");
-const egg_logger_1 = require("egg-logger");
-const utils_1 = require("@eggjs/utils");
-const agent_js_1 = require("./utils/mode/impl/worker_threads/agent.js");
-const agent_js_2 = require("./utils/mode/impl/process/agent.js");
-const debug = (0, node_util_1.debuglog)('@eggjs/cluster/agent_worker');
-/**
- * agent worker is child_process forked by master.
- *
- * agent worker only exit in two cases:
- *  - receive signal SIGTERM, exit code 0 (exit gracefully)
- *  - receive disconnect event, exit code 110 (maybe master exit in accident)
- */
-async function main() {
-    // $ node agent_worker.js options
-    const options = JSON.parse(process.argv[2]);
-    if (options.require) {
-        // inject
-        for (const mod of options.require) {
-            await (0, utils_1.importModule)(mod, {
-                paths: [options.baseDir],
-            });
-        }
-    }
-    let AgentWorker;
-    if (options.startMode === 'worker_threads') {
-        AgentWorker = agent_js_1.AgentThreadWorker;
-    }
-    else {
-        AgentWorker = agent_js_2.AgentProcessWorker;
-    }
-    const consoleLogger = new egg_logger_1.EggConsoleLogger({ level: process.env.EGG_AGENT_WORKER_LOGGER_LEVEL });
-    const { Agent } = await (0, utils_1.importModule)(options.framework, {
-        paths: [options.baseDir],
-    });
-    debug('new Agent with options %j', options);
-    let agent;
-    try {
-        agent = new Agent(options);
-    }
-    catch (err) {
-        consoleLogger.error(err);
-        throw err;
-    }
-    function startErrorHandler(err) {
-        consoleLogger.error(err);
-        consoleLogger.error('[agent_worker] start error, exiting with code:1');
-        AgentWorker.kill();
-    }
-    agent.ready((err) => {
-        // don't send started message to master when start error
-        if (err) {
-            return;
-        }
-        agent.removeListener('error', startErrorHandler);
-        AgentWorker.send({ action: 'agent-start', to: 'master' });
-    });
-    // exit if agent start error
-    agent.once('error', startErrorHandler);
-    AgentWorker.gracefulExit({
-        logger: consoleLogger,
-        label: 'agent_worker',
-        beforeExit: () => agent.close(),
-    });
-}
-main();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnRfd29ya2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FnZW50X3dvcmtlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHlDQUFxQztBQUNyQywyQ0FBK0Q7QUFDL0Qsd0NBQTRDO0FBRTVDLHdFQUE4RTtBQUM5RSxpRUFBd0U7QUFFeEUsTUFBTSxLQUFLLEdBQUcsSUFBQSxvQkFBUSxFQUFDLDZCQUE2QixDQUFDLENBQUM7QUFFdEQ7Ozs7OztHQU1HO0FBQ0gsS0FBSyxVQUFVLElBQUk7SUFDakIsaUNBQWlDO0lBQ2pDLE1BQU0sT0FBTyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FLekMsQ0FBQztJQUNGLElBQUksT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQ3BCLFNBQVM7UUFDVCxLQUFLLE1BQU0sR0FBRyxJQUFJLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQztZQUNsQyxNQUFNLElBQUEsb0JBQVksRUFBQyxHQUFHLEVBQUU7Z0JBQ3RCLEtBQUssRUFBRSxDQUFFLE9BQU8sQ0FBQyxPQUFPLENBQUU7YUFDM0IsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUM7SUFFRCxJQUFJLFdBQW1DLENBQUM7SUFDeEMsSUFBSSxPQUFPLENBQUMsU0FBUyxLQUFLLGdCQUFnQixFQUFFLENBQUM7UUFDM0MsV0FBVyxHQUFHLDRCQUF3QixDQUFDO0lBQ3pDLENBQUM7U0FBTSxDQUFDO1FBQ04sV0FBVyxHQUFHLDZCQUF5QixDQUFDO0lBQzFDLENBQUM7SUFFRCxNQUFNLGFBQWEsR0FBRyxJQUFJLDZCQUFhLENBQUMsRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyw2QkFBNkIsRUFBRSxDQUFDLENBQUM7SUFDOUYsTUFBTSxFQUFFLEtBQUssRUFBRSxHQUFHLE1BQU0sSUFBQSxvQkFBWSxFQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUU7UUFDdEQsS0FBSyxFQUFFLENBQUUsT0FBTyxDQUFDLE9BQU8sQ0FBRTtLQUMzQixDQUFDLENBQUM7SUFDSCxLQUFLLENBQUMsMkJBQTJCLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDNUMsSUFBSSxLQUFVLENBQUM7SUFDZixJQUFJLENBQUM7UUFDSCxLQUFLLEdBQUcsSUFBSSxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDN0IsQ0FBQztJQUFDLE9BQU8sR0FBRyxFQUFFLENBQUM7UUFDYixhQUFhLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ3pCLE1BQU0sR0FBRyxDQUFDO0lBQ1osQ0FBQztJQUVELFNBQVMsaUJBQWlCLENBQUMsR0FBVTtRQUNuQyxhQUFhLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ3pCLGFBQWEsQ0FBQyxLQUFLLENBQUMsaURBQWlELENBQUMsQ0FBQztRQUN2RSxXQUFXLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDckIsQ0FBQztJQUVELEtBQUssQ0FBQyxLQUFLLENBQUMsQ0FBQyxHQUFXLEVBQUUsRUFBRTtRQUMxQix3REFBd0Q7UUFDeEQsSUFBSSxHQUFHLEVBQUUsQ0FBQztZQUNSLE9BQU87UUFDVCxDQUFDO1FBRUQsS0FBSyxDQUFDLGNBQWMsQ0FBQyxPQUFPLEVBQUUsaUJBQWlCLENBQUMsQ0FBQztRQUNqRCxXQUFXLENBQUMsSUFBSSxDQUFDLEVBQUUsTUFBTSxFQUFFLGFBQWEsRUFBRSxFQUFFLEVBQUUsUUFBUSxFQUFFLENBQUMsQ0FBQztJQUM1RCxDQUFDLENBQUMsQ0FBQztJQUVILDRCQUE0QjtJQUM1QixLQUFLLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxpQkFBaUIsQ0FBQyxDQUFDO0lBRXZDLFdBQVcsQ0FBQyxZQUFZLENBQUM7UUFDdkIsTUFBTSxFQUFFLGFBQWE7UUFDckIsS0FBSyxFQUFFLGNBQWM7UUFDckIsVUFBVSxFQUFFLEdBQUcsRUFBRSxDQUFDLEtBQUssQ0FBQyxLQUFLLEVBQUU7S0FDaEMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVELElBQUksRUFBRSxDQUFDIn0=

package/dist/commonjs/app_worker.d.ts

@@ -1 +0,0 @@
-export {};