@eggjs/cluster 4.0.0-beta.36 → 4.0.1-beta.0

package/dist/app_worker.js

@@ -1,6 +1,7 @@
 import { AppProcessWorker } from "./utils/mode/impl/process/app.js";
 import { AppThreadWorker } from "./utils/mode/impl/worker_threads/app.js";
 import fs from "node:fs";
+import os from "node:os";
 import { debuglog } from "node:util";
 import { EggConsoleLogger } from "egg-logger";
 import { importModule } from "@eggjs/utils";
@@ -9,6 +10,12 @@ import { createServer as createServer$1 } from "node:https";
 
 //#region src/app_worker.ts
 const debug = debuglog("egg/cluster/app_worker");
+const REUSE_PORT_SUPPORTED_PLATFORMS = [
+	"linux",
+	"freebsd",
+	"sunos",
+	"aix"
+];
 async function main() {
 	const options = JSON.parse(process.argv[2]);
 	if (options.require) for (const mod of options.require) await importModule(mod, { paths: [options.baseDir] });
@@ -50,7 +57,12 @@ async function main() {
 		const port = app.options.port = options.port || listenConfig.port;
 		const debugPort = options.debugPort;
 		const protocol = httpsOptions.key && httpsOptions.cert ? "https" : "http";
-		debug("[app_worker:%s] listenConfig: %j, real port: %o, protocol: %o, debugPort: %o", process.pid, listenConfig, port, protocol, debugPort);
+		let reusePort = options.reusePort ?? listenConfig.reusePort ?? false;
+		if (reusePort && !REUSE_PORT_SUPPORTED_PLATFORMS.includes(os.platform())) {
+			reusePort = false;
+			debug("[app_worker:%s] platform %s is not supported for reusePort, set reusePort to false", process.pid, os.platform());
+		}
+		debug("[app_worker:%s] listenConfig: %j, real port: %o, protocol: %o, debugPort: %o, reusePort: %o", process.pid, listenConfig, port, protocol, debugPort, reusePort);
 		AppWorker.send({
 			to: "master",
 			action: "realport",
@@ -92,10 +104,20 @@ async function main() {
 					exitProcess();
 					return;
 				}
-				const args = [port];
-				if (listenConfig.hostname) args.push(listenConfig.hostname);
-				debug("listen options %j", args);
-				server.listen(...args);
+				if (reusePort) {
+					const listenOptions = {
+						port,
+						reusePort
+					};
+					if (listenConfig.hostname) listenOptions.host = listenConfig.hostname;
+					debug("[app_worker:%s] listen with reusePort options %j", process.pid, listenOptions);
+					server.listen(listenOptions);
+				} else {
+					const args = [port];
+					if (listenConfig.hostname) args.push(listenConfig.hostname);
+					debug("listen options %j", args);
+					server.listen(...args);
+				}
 			}
 			if (debugPortServer) {
 				debug("listen on debug port: %s", debugPort);
@@ -108,14 +130,15 @@ async function main() {
 				address,
 				addressType: -1
 			};
-			debug("[app_worker:%s] listening at %j", process.pid, address);
+			debug("[app_worker:%s] listening at %j, reusePort: %o", process.pid, address, reusePort);
 			AppWorker.send({
 				to: "master",
 				action: "app-start",
 				data: {
 					address,
 					workerId: AppWorker.workerId
-				}
+				},
+				reusePort
 			});
 		});
 	}

package/dist/utils/messenger.d.ts

@@ -14,6 +14,12 @@ interface MessageBody {
   receiverPid?: string;
   receiverWorkerId?: string;
   senderWorkerId?: string;
+  /**
+  * Whether reusePort is enabled for server listen.
+  * When reusePort is true, cluster won't get `listening` event,
+  * so we need to use cluster `message` event instead.
+  */
+  reusePort?: boolean;
 }
 /**
 * master messenger, provide communication between parent, master, agent and app.

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

@@ -1,11 +1,13 @@
 import { terminate } from "../../../terminate.js";
 import { BaseAppUtils, BaseAppWorker } from "../../base/app.js";
+import { debuglog } from "node:util";
 import { graceful } from "graceful-process";
 import { sendmessage } from "sendmessage";
 import cluster from "node:cluster";
 import { cfork } from "cfork";
 
 //#region src/utils/mode/impl/process/app.ts
+const debug = debuglog("egg/cluster/utils/mode/impl/process/app");
 var AppProcessWorker = class extends BaseAppWorker {
 	get id() {
 		return this.instance.id;
@@ -33,6 +35,11 @@ var AppProcessWorker = class extends BaseAppWorker {
 	}
 	static send(message) {
 		message.senderWorkerId = String(process.pid);
+		if (message.action === "app-start" && message.reusePort) {
+			debug("send app-start message with reusePort, use cluster.worker.send()");
+			cluster.worker.send(message);
+			return;
+		}
 		process.send(message);
 	}
 	static kill() {

package/dist/utils/mode/impl/worker_threads/app.js

@@ -103,15 +103,23 @@ var AppThreadUtils = class extends BaseAppUtils {
 	fork() {
 		this.startTime = Date.now();
 		this.startSuccessCount = 0;
-		const ports = this.options.ports ?? [];
-		if (!ports.length) ports.push(this.options.port);
-		this.options.workers = ports.length;
-		let i = 0;
-		do {
-			const options = Object.assign({}, this.options, { port: ports[i] });
-			const argv = [JSON.stringify(options)];
-			this.#forkSingle(this.getAppWorkerFile(), { argv }, ++i);
-		} while (i < ports.length);
+		if (this.options.reusePort) {
+			if (!this.options.port) throw new Error("options.port must be specified when reusePort is enabled");
+			for (let i = 0; i < this.options.workers; i++) {
+				const argv = [JSON.stringify(this.options)];
+				this.#forkSingle(this.getAppWorkerFile(), { argv }, i + 1);
+			}
+		} else {
+			const ports = this.options.ports ?? [];
+			if (!ports.length) ports.push(this.options.port);
+			this.options.workers = ports.length;
+			let i = 0;
+			do {
+				const options = Object.assign({}, this.options, { port: ports[i] });
+				const argv = [JSON.stringify(options)];
+				this.#forkSingle(this.getAppWorkerFile(), { argv }, ++i);
+			} while (i < ports.length);
+		}
 		return this;
 	}
 	async kill() {

package/dist/utils/options.d.ts

@@ -68,6 +68,12 @@ interface ClusterOptions {
   * sticky mode server
   */
   sticky?: boolean;
+  /**
+  * enable SO_REUSEPORT socket option for server listen, default is `false`.
+  * Only available on Linux 3.9+, DragonFlyBSD 3.6+, FreeBSD 12.0+, Solaris 11.4, and AIX 7.2.5+.
+  * @see https://nodejs.org/api/net.html#serverlistenoptions-callback
+  */
+  reusePort?: boolean;
   /** customized plugins, for unittest */
   plugins?: object;
   isDebug?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/cluster",
-  "version": "4.0.0-beta.36",
+  "version": "4.0.1-beta.0",
   "description": "cluster manager for egg",
   "keywords": [
     "cluster",
@@ -45,7 +45,7 @@
     "sendmessage": "^3.0.1",
     "terminal-link": "^5.0.0",
     "utility": "^2.5.0",
-    "@eggjs/utils": "5.0.0-beta.36"
+    "@eggjs/utils": "5.0.1-beta.0"
   },
   "devDependencies": {
     "address": "2",
@@ -54,10 +54,10 @@
     "typescript": "^5.9.3",
     "urllib": "^4.8.2",
     "vitest": "^4.0.15",
-    "@eggjs/mock": "7.0.0-beta.36",
-    "@eggjs/errors": "3.0.0-beta.36",
-    "@eggjs/supertest": "9.0.0-beta.36",
-    "@eggjs/tsconfig": "3.1.0-beta.36"
+    "@eggjs/errors": "3.0.1-beta.0",
+    "@eggjs/mock": "7.0.1-beta.0",
+    "@eggjs/supertest": "9.0.1-beta.0",
+    "@eggjs/tsconfig": "3.1.1-beta.0"
   },
   "engines": {
     "node": ">=22.18.0"