@eggjs/cluster 3.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +92 -0
  3. package/dist/commonjs/agent_worker.d.ts +1 -0
  4. package/dist/commonjs/agent_worker.js +65 -0
  5. package/dist/commonjs/app_worker.d.ts +1 -0
  6. package/dist/commonjs/app_worker.js +151 -0
  7. package/dist/commonjs/dirname.d.ts +1 -0
  8. package/dist/commonjs/dirname.js +17 -0
  9. package/dist/commonjs/error/ClusterAgentWorkerError.d.ts +10 -0
  10. package/dist/commonjs/error/ClusterAgentWorkerError.js +23 -0
  11. package/dist/commonjs/error/ClusterWorkerExceptionError.d.ts +7 -0
  12. package/dist/commonjs/error/ClusterWorkerExceptionError.js +18 -0
  13. package/dist/commonjs/error/index.d.ts +2 -0
  14. package/dist/commonjs/error/index.js +19 -0
  15. package/dist/commonjs/index.d.ts +17 -0
  16. package/dist/commonjs/index.js +37 -0
  17. package/dist/commonjs/master.d.ts +90 -0
  18. package/dist/commonjs/master.js +544 -0
  19. package/dist/commonjs/package.json +3 -0
  20. package/dist/commonjs/utils/messenger.d.ts +87 -0
  21. package/dist/commonjs/utils/messenger.js +183 -0
  22. package/dist/commonjs/utils/mode/base/agent.d.ts +38 -0
  23. package/dist/commonjs/utils/mode/base/agent.js +68 -0
  24. package/dist/commonjs/utils/mode/base/app.d.ts +48 -0
  25. package/dist/commonjs/utils/mode/base/app.js +81 -0
  26. package/dist/commonjs/utils/mode/impl/process/agent.d.ts +18 -0
  27. package/dist/commonjs/utils/mode/impl/process/agent.js +107 -0
  28. package/dist/commonjs/utils/mode/impl/process/app.d.ts +20 -0
  29. package/dist/commonjs/utils/mode/impl/process/app.js +134 -0
  30. package/dist/commonjs/utils/mode/impl/worker_threads/agent.d.ts +18 -0
  31. package/dist/commonjs/utils/mode/impl/worker_threads/agent.js +90 -0
  32. package/dist/commonjs/utils/mode/impl/worker_threads/app.d.ts +25 -0
  33. package/dist/commonjs/utils/mode/impl/worker_threads/app.js +156 -0
  34. package/dist/commonjs/utils/options.d.ts +80 -0
  35. package/dist/commonjs/utils/options.js +81 -0
  36. package/dist/commonjs/utils/terminate.d.ts +6 -0
  37. package/dist/commonjs/utils/terminate.js +89 -0
  38. package/dist/commonjs/utils/worker_manager.d.ts +25 -0
  39. package/dist/commonjs/utils/worker_manager.js +76 -0
  40. package/dist/esm/agent_worker.d.ts +1 -0
  41. package/dist/esm/agent_worker.js +63 -0
  42. package/dist/esm/app_worker.d.ts +1 -0
  43. package/dist/esm/app_worker.js +146 -0
  44. package/dist/esm/dirname.d.ts +1 -0
  45. package/dist/esm/dirname.js +11 -0
  46. package/dist/esm/error/ClusterAgentWorkerError.d.ts +10 -0
  47. package/dist/esm/error/ClusterAgentWorkerError.js +19 -0
  48. package/dist/esm/error/ClusterWorkerExceptionError.d.ts +7 -0
  49. package/dist/esm/error/ClusterWorkerExceptionError.js +14 -0
  50. package/dist/esm/error/index.d.ts +2 -0
  51. package/dist/esm/error/index.js +3 -0
  52. package/dist/esm/index.d.ts +17 -0
  53. package/dist/esm/index.js +19 -0
  54. package/dist/esm/master.d.ts +90 -0
  55. package/dist/esm/master.js +537 -0
  56. package/dist/esm/package.json +3 -0
  57. package/dist/esm/utils/messenger.d.ts +87 -0
  58. package/dist/esm/utils/messenger.js +176 -0
  59. package/dist/esm/utils/mode/base/agent.d.ts +38 -0
  60. package/dist/esm/utils/mode/base/agent.js +60 -0
  61. package/dist/esm/utils/mode/base/app.d.ts +48 -0
  62. package/dist/esm/utils/mode/base/app.js +73 -0
  63. package/dist/esm/utils/mode/impl/process/agent.d.ts +18 -0
  64. package/dist/esm/utils/mode/impl/process/agent.js +102 -0
  65. package/dist/esm/utils/mode/impl/process/app.d.ts +20 -0
  66. package/dist/esm/utils/mode/impl/process/app.js +126 -0
  67. package/dist/esm/utils/mode/impl/worker_threads/agent.d.ts +18 -0
  68. package/dist/esm/utils/mode/impl/worker_threads/agent.js +82 -0
  69. package/dist/esm/utils/mode/impl/worker_threads/app.d.ts +25 -0
  70. package/dist/esm/utils/mode/impl/worker_threads/app.js +151 -0
  71. package/dist/esm/utils/options.d.ts +80 -0
  72. package/dist/esm/utils/options.js +75 -0
  73. package/dist/esm/utils/terminate.d.ts +6 -0
  74. package/dist/esm/utils/terminate.js +86 -0
  75. package/dist/esm/utils/worker_manager.d.ts +25 -0
  76. package/dist/esm/utils/worker_manager.js +72 -0
  77. package/dist/package.json +4 -0
  78. package/package.json +94 -0
  79. package/src/agent_worker.ts +75 -0
  80. package/src/app_worker.ts +170 -0
  81. package/src/dirname.ts +11 -0
  82. package/src/error/ClusterAgentWorkerError.ts +19 -0
  83. package/src/error/ClusterWorkerExceptionError.ts +17 -0
  84. package/src/error/index.ts +2 -0
  85. package/src/index.ts +26 -0
  86. package/src/master.ts +641 -0
  87. package/src/utils/messenger.ts +199 -0
  88. package/src/utils/mode/base/agent.ts +90 -0
  89. package/src/utils/mode/base/app.ts +115 -0
  90. package/src/utils/mode/impl/process/agent.ts +118 -0
  91. package/src/utils/mode/impl/process/app.ts +146 -0
  92. package/src/utils/mode/impl/worker_threads/agent.ts +98 -0
  93. package/src/utils/mode/impl/worker_threads/app.ts +180 -0
  94. package/src/utils/options.ts +169 -0
  95. package/src/utils/terminate.ts +97 -0
  96. package/src/utils/worker_manager.ts +87 -0
@@ -0,0 +1,86 @@
1
+ import { debuglog } from 'node:util';
2
+ import { setTimeout as sleep } from 'node:timers/promises';
3
+ import { once } from 'node:events';
4
+ import { pstree } from '@fengmk2/ps-tree';
5
+ const debug = debuglog('@eggjs/cluster/utils/terminate');
6
+ export async function terminate(subProcess, timeout) {
7
+ const pid = subProcess.process?.pid ?? subProcess.pid;
8
+ const childPids = await getChildPids(pid);
9
+ await Promise.all([
10
+ killProcess(subProcess, timeout),
11
+ killChildren(childPids, timeout),
12
+ ]);
13
+ }
14
+ // kill process, if SIGTERM not work, try SIGKILL
15
+ async function killProcess(subProcess, timeout) {
16
+ // https://github.com/nodejs/node/pull/34312
17
+ (subProcess.process ?? subProcess).kill('SIGTERM');
18
+ await Promise.race([
19
+ once(subProcess, 'exit'),
20
+ sleep(timeout),
21
+ ]);
22
+ if (subProcess.killed) {
23
+ return;
24
+ }
25
+ // SIGKILL: http://man7.org/linux/man-pages/man7/signal.7.html
26
+ // worker: https://github.com/nodejs/node/blob/master/lib/internal/cluster/worker.js#L22
27
+ // subProcess.kill is wrapped to subProcess.destroy, it will wait to disconnected.
28
+ (subProcess.process ?? subProcess).kill('SIGKILL');
29
+ }
30
+ // kill all children processes, if SIGTERM not work, try SIGKILL
31
+ async function killChildren(childrenPids, timeout) {
32
+ if (childrenPids.length === 0) {
33
+ return;
34
+ }
35
+ kill(childrenPids, 'SIGTERM');
36
+ const start = Date.now();
37
+ // if timeout is 1000, it will check twice.
38
+ const checkInterval = 400;
39
+ let unterminated = [];
40
+ while (Date.now() - start < timeout - checkInterval) {
41
+ await sleep(checkInterval);
42
+ unterminated = getUnterminatedProcesses(childrenPids);
43
+ if (unterminated.length === 0) {
44
+ return;
45
+ }
46
+ }
47
+ kill(unterminated, 'SIGKILL');
48
+ }
49
+ async function getChildPids(pid) {
50
+ let childrenPids = [];
51
+ try {
52
+ const children = await pstree(pid);
53
+ childrenPids = children.map(c => parseInt(c.PID));
54
+ }
55
+ catch (err) {
56
+ // if get children error, just ignore it
57
+ debug('pstree %s error: %s, ignore it', pid, err);
58
+ }
59
+ return childrenPids;
60
+ }
61
+ function kill(pids, signal) {
62
+ for (const pid of pids) {
63
+ try {
64
+ process.kill(pid, signal);
65
+ }
66
+ catch (err) {
67
+ // ignore
68
+ debug('kill %s error: %s, signal: %s, ignore it', pid, err, signal);
69
+ }
70
+ }
71
+ }
72
+ function getUnterminatedProcesses(pids) {
73
+ return pids.filter(pid => {
74
+ try {
75
+ // success means it's still alive
76
+ process.kill(pid, 0);
77
+ return true;
78
+ }
79
+ catch (err) {
80
+ // error means it's dead
81
+ debug('kill %s error: %s, it still alive', pid, err);
82
+ return false;
83
+ }
84
+ });
85
+ }
86
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVybWluYXRlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3V0aWxzL3Rlcm1pbmF0ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBQ3JDLE9BQU8sRUFBRSxVQUFVLElBQUksS0FBSyxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFDM0QsT0FBTyxFQUFFLElBQUksRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUVuQyxPQUFPLEVBQUUsTUFBTSxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFMUMsTUFBTSxLQUFLLEdBQUcsUUFBUSxDQUFDLGdDQUFnQyxDQUFDLENBQUM7QUFNekQsTUFBTSxDQUFDLEtBQUssVUFBVSxTQUFTLENBQUMsVUFBc0IsRUFBRSxPQUFlO0lBQ3JFLE1BQU0sR0FBRyxHQUFHLFVBQVUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxJQUFJLFVBQVUsQ0FBQyxHQUFHLENBQUM7SUFDdEQsTUFBTSxTQUFTLEdBQUcsTUFBTSxZQUFZLENBQUMsR0FBSSxDQUFDLENBQUM7SUFDM0MsTUFBTSxPQUFPLENBQUMsR0FBRyxDQUFDO1FBQ2hCLFdBQVcsQ0FBQyxVQUFVLEVBQUUsT0FBTyxDQUFDO1FBQ2hDLFlBQVksQ0FBQyxTQUFTLEVBQUUsT0FBTyxDQUFDO0tBQ2pDLENBQUMsQ0FBQztBQUNMLENBQUM7QUFFRCxpREFBaUQ7QUFDakQsS0FBSyxVQUFVLFdBQVcsQ0FBQyxVQUFzQixFQUFFLE9BQWU7SUFDaEUsNENBQTRDO0lBQzVDLENBQUMsVUFBVSxDQUFDLE9BQU8sSUFBSSxVQUFVLENBQUMsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDbkQsTUFBTSxPQUFPLENBQUMsSUFBSSxDQUFDO1FBQ2pCLElBQUksQ0FBQyxVQUFVLEVBQUUsTUFBTSxDQUFDO1FBQ3hCLEtBQUssQ0FBQyxPQUFPLENBQUM7S0FDZixDQUFDLENBQUM7SUFDSCxJQUFJLFVBQVUsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUN0QixPQUFPO0lBQ1QsQ0FBQztJQUNELDhEQUE4RDtJQUM5RCx3RkFBd0Y7SUFDeEYsa0ZBQWtGO0lBQ2xGLENBQUMsVUFBVSxDQUFDLE9BQU8sSUFBSSxVQUFVLENBQUMsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUM7QUFDckQsQ0FBQztBQUVELGdFQUFnRTtBQUNoRSxLQUFLLFVBQVUsWUFBWSxDQUFDLFlBQXNCLEVBQUUsT0FBZTtJQUNqRSxJQUFJLFlBQVksQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDOUIsT0FBTztJQUNULENBQUM7SUFDRCxJQUFJLENBQUMsWUFBWSxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBRTlCLE1BQU0sS0FBSyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztJQUN6QiwyQ0FBMkM7SUFDM0MsTUFBTSxhQUFhLEdBQUcsR0FBRyxDQUFDO0lBQzFCLElBQUksWUFBWSxHQUFhLEVBQUUsQ0FBQztJQUVoQyxPQUFPLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLEdBQUcsT0FBTyxHQUFHLGFBQWEsRUFBRSxDQUFDO1FBQ3BELE1BQU0sS0FBSyxDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQzNCLFlBQVksR0FBRyx3QkFBd0IsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUN0RCxJQUFJLFlBQVksQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDOUIsT0FBTztRQUNULENBQUM7SUFDSCxDQUFDO0lBQ0QsSUFBSSxDQUFDLFlBQVksRUFBRSxTQUFTLENBQUMsQ0FBQztBQUNoQyxDQUFDO0FBRUQsS0FBSyxVQUFVLFlBQVksQ0FBQyxHQUFXO0lBQ3JDLElBQUksWUFBWSxHQUFhLEVBQUUsQ0FBQztJQUNoQyxJQUFJLENBQUM7UUFDSCxNQUFNLFFBQVEsR0FBRyxNQUFNLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNuQyxZQUFZLEdBQUcsUUFBUyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUNyRCxDQUFDO0lBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztRQUNiLHdDQUF3QztRQUN4QyxLQUFLLENBQUMsZ0NBQWdDLEVBQUUsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQ3BELENBQUM7SUFDRCxPQUFPLFlBQVksQ0FBQztBQUN0QixDQUFDO0FBRUQsU0FBUyxJQUFJLENBQUMsSUFBYyxFQUFFLE1BQWM7SUFDMUMsS0FBSyxNQUFNLEdBQUcsSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUN2QixJQUFJLENBQUM7WUFDSCxPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUM1QixDQUFDO1FBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztZQUNiLFNBQVM7WUFDVCxLQUFLLENBQUMsMENBQTBDLEVBQUUsR0FBRyxFQUFFLEdBQUcsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUN0RSxDQUFDO0lBQ0gsQ0FBQztBQUNILENBQUM7QUFFRCxTQUFTLHdCQUF3QixDQUFDLElBQWM7SUFDOUMsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxFQUFFO1FBQ3ZCLElBQUksQ0FBQztZQUNILGlDQUFpQztZQUNqQyxPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsQ0FBQztZQUNyQixPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7UUFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO1lBQ2Isd0JBQXdCO1lBQ3hCLEtBQUssQ0FBQyxtQ0FBbUMsRUFBRSxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7WUFDckQsT0FBTyxLQUFLLENBQUM7UUFDZixDQUFDO0lBQ0gsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDIn0=
@@ -0,0 +1,25 @@
1
+ import { EventEmitter } from 'node:events';
2
+ import { BaseAgentWorker } from './mode/base/agent.js';
3
+ import { BaseAppWorker } from './mode/base/app.js';
4
+ export declare class WorkerManager extends EventEmitter {
5
+ agent: BaseAgentWorker | null;
6
+ workers: Map<number, BaseAppWorker<import("worker_threads").Worker | import("cluster").Worker>>;
7
+ exception: number;
8
+ timer: NodeJS.Timeout;
9
+ constructor();
10
+ getWorkers(): number[];
11
+ setAgent(agent: BaseAgentWorker): void;
12
+ getAgent(): BaseAgentWorker<import("child_process").ChildProcess | import("worker_threads").Worker> | null;
13
+ deleteAgent(): void;
14
+ setWorker(worker: BaseAppWorker): void;
15
+ getWorker(workerId: number): BaseAppWorker<import("worker_threads").Worker | import("cluster").Worker> | undefined;
16
+ deleteWorker(workerId: number): void;
17
+ listWorkerIds(): number[];
18
+ listWorkers(): BaseAppWorker<import("worker_threads").Worker | import("cluster").Worker>[];
19
+ getListeningWorkerIds(): number[];
20
+ count(): {
21
+ agent: number;
22
+ worker: number;
23
+ };
24
+ startCheck(): void;
25
+ }
@@ -0,0 +1,72 @@
1
+ import { EventEmitter } from 'node:events';
2
+ // worker manager to record agent and worker forked by egg-cluster
3
+ // can do some check stuff here to monitor the healthy
4
+ export class WorkerManager extends EventEmitter {
5
+ agent;
6
+ workers = new Map();
7
+ exception = 0;
8
+ timer;
9
+ constructor() {
10
+ super();
11
+ this.agent = null;
12
+ }
13
+ getWorkers() {
14
+ return Array.from(this.workers.keys());
15
+ }
16
+ setAgent(agent) {
17
+ this.agent = agent;
18
+ }
19
+ getAgent() {
20
+ return this.agent;
21
+ }
22
+ deleteAgent() {
23
+ this.agent = null;
24
+ }
25
+ setWorker(worker) {
26
+ this.workers.set(worker.workerId, worker);
27
+ }
28
+ getWorker(workerId) {
29
+ return this.workers.get(workerId);
30
+ }
31
+ deleteWorker(workerId) {
32
+ this.workers.delete(workerId);
33
+ }
34
+ listWorkerIds() {
35
+ return Array.from(this.workers.keys());
36
+ }
37
+ listWorkers() {
38
+ return Array.from(this.workers.values());
39
+ }
40
+ getListeningWorkerIds() {
41
+ const keys = [];
42
+ for (const [id, worker] of this.workers.entries()) {
43
+ if (worker.state === 'listening') {
44
+ keys.push(id);
45
+ }
46
+ }
47
+ return keys;
48
+ }
49
+ count() {
50
+ return {
51
+ agent: this.agent?.status === 'started' ? 1 : 0,
52
+ worker: this.listWorkerIds().length,
53
+ };
54
+ }
55
+ // check agent and worker must both alive
56
+ // if exception appear 3 times, emit an exception event
57
+ startCheck() {
58
+ this.timer = setInterval(() => {
59
+ const count = this.count();
60
+ if (count.agent > 0 && count.worker > 0) {
61
+ this.exception = 0;
62
+ return;
63
+ }
64
+ this.exception++;
65
+ if (this.exception >= 3) {
66
+ this.emit('exception', count);
67
+ clearInterval(this.timer);
68
+ }
69
+ }, 10000);
70
+ }
71
+ }
72
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid29ya2VyX21hbmFnZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdXRpbHMvd29ya2VyX21hbmFnZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUkzQyxrRUFBa0U7QUFDbEUsc0RBQXNEO0FBQ3RELE1BQU0sT0FBTyxhQUFjLFNBQVEsWUFBWTtJQUM3QyxLQUFLLENBQXlCO0lBQzlCLE9BQU8sR0FBRyxJQUFJLEdBQUcsRUFBeUIsQ0FBQztJQUMzQyxTQUFTLEdBQUcsQ0FBQyxDQUFDO0lBQ2QsS0FBSyxDQUFpQjtJQUV0QjtRQUNFLEtBQUssRUFBRSxDQUFDO1FBQ1IsSUFBSSxDQUFDLEtBQUssR0FBRyxJQUFJLENBQUM7SUFDcEIsQ0FBQztJQUVELFVBQVU7UUFDUixPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ3pDLENBQUM7SUFFRCxRQUFRLENBQUMsS0FBc0I7UUFDN0IsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUM7SUFDckIsQ0FBQztJQUVELFFBQVE7UUFDTixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUM7SUFDcEIsQ0FBQztJQUVELFdBQVc7UUFDVCxJQUFJLENBQUMsS0FBSyxHQUFHLElBQUksQ0FBQztJQUNwQixDQUFDO0lBRUQsU0FBUyxDQUFDLE1BQXFCO1FBQzdCLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDNUMsQ0FBQztJQUVELFNBQVMsQ0FBQyxRQUFnQjtRQUN4QixPQUFPLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ3BDLENBQUM7SUFFRCxZQUFZLENBQUMsUUFBZ0I7UUFDM0IsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDaEMsQ0FBQztJQUVELGFBQWE7UUFDWCxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBQ3pDLENBQUM7SUFFRCxXQUFXO1FBQ1QsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQztJQUMzQyxDQUFDO0lBRUQscUJBQXFCO1FBQ25CLE1BQU0sSUFBSSxHQUFHLEVBQUUsQ0FBQztRQUNoQixLQUFLLE1BQU0sQ0FBRSxFQUFFLEVBQUUsTUFBTSxDQUFFLElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDO1lBQ3BELElBQUksTUFBTSxDQUFDLEtBQUssS0FBSyxXQUFXLEVBQUUsQ0FBQztnQkFDakMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztZQUNoQixDQUFDO1FBQ0gsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztJQUVELEtBQUs7UUFDSCxPQUFPO1lBQ0wsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLLEVBQUUsTUFBTSxLQUFLLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQy9DLE1BQU0sRUFBRSxJQUFJLENBQUMsYUFBYSxFQUFFLENBQUMsTUFBTTtTQUNwQyxDQUFDO0lBQ0osQ0FBQztJQUVELHlDQUF5QztJQUN6Qyx1REFBdUQ7SUFDdkQsVUFBVTtRQUNSLElBQUksQ0FBQyxLQUFLLEdBQUcsV0FBVyxDQUFDLEdBQUcsRUFBRTtZQUM1QixNQUFNLEtBQUssR0FBRyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7WUFDM0IsSUFBSSxLQUFLLENBQUMsS0FBSyxHQUFHLENBQUMsSUFBSSxLQUFLLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO2dCQUN4QyxJQUFJLENBQUMsU0FBUyxHQUFHLENBQUMsQ0FBQztnQkFDbkIsT0FBTztZQUNULENBQUM7WUFDRCxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDakIsSUFBSSxJQUFJLENBQUMsU0FBUyxJQUFJLENBQUMsRUFBRSxDQUFDO2dCQUN4QixJQUFJLENBQUMsSUFBSSxDQUFDLFdBQVcsRUFBRSxLQUFLLENBQUMsQ0FBQztnQkFDOUIsYUFBYSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUM1QixDQUFDO1FBQ0gsQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ1osQ0FBQztDQUNGIn0=
@@ -0,0 +1,4 @@
1
+ {
2
+ "name": "@eggjs/cluster",
3
+ "version": "3.0.0-beta.0"
4
+ }
package/package.json ADDED
@@ -0,0 +1,94 @@
1
+ {
2
+ "name": "@eggjs/cluster",
3
+ "version": "3.0.0-beta.0",
4
+ "publishConfig": {
5
+ "access": "public"
6
+ },
7
+ "description": "cluster manager for egg",
8
+ "main": "./dist/commonjs/index.js",
9
+ "scripts": {
10
+ "lint": "eslint --cache src test --ext .ts",
11
+ "pretest": "npm run lint -- --fix && npm run prepublishOnly",
12
+ "test": "egg-bin test",
13
+ "preci": "npm run lint && npm run prepublishOnly",
14
+ "ci": "egg-bin cov && attw --pack",
15
+ "prepublishOnly": "tshy && tshy-after"
16
+ },
17
+ "files": [
18
+ "dist",
19
+ "src"
20
+ ],
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "git+https://github.com/eggjs/egg-cluster.git"
24
+ },
25
+ "keywords": [
26
+ "egg",
27
+ "cluster",
28
+ "process"
29
+ ],
30
+ "author": "dead-horse <dead_horse@qq.com>",
31
+ "license": "MIT",
32
+ "bugs": {
33
+ "url": "https://github.com/eggjs/egg-cluster/issues"
34
+ },
35
+ "homepage": "https://github.com/eggjs/egg-cluster#readme",
36
+ "dependencies": {
37
+ "@eggjs/utils": "^4.0.2",
38
+ "@fengmk2/ps-tree": "^2.0.1",
39
+ "cfork": "^2.0.0",
40
+ "cluster-reload": "^2.0.0",
41
+ "detect-port": "^2.0.1",
42
+ "egg-logger": "^3.6.0",
43
+ "get-ready": "^3.2.0",
44
+ "graceful-process": "^2.0.0",
45
+ "sendmessage": "^3.0.1",
46
+ "terminal-link": "^2.1.1",
47
+ "utility": "^2.2.0"
48
+ },
49
+ "devDependencies": {
50
+ "@arethetypeswrong/cli": "^0.17.1",
51
+ "@eggjs/tsconfig": "1",
52
+ "@types/mocha": "10",
53
+ "@types/node": "22",
54
+ "address": "^2.0.3",
55
+ "coffee": "^5.5.1",
56
+ "egg": "beta",
57
+ "egg-bin": "6",
58
+ "egg-errors": "^2.2.0",
59
+ "egg-mock": "beta",
60
+ "eslint": "8",
61
+ "eslint-config-egg": "14",
62
+ "supertest": "^7.0.0",
63
+ "ts-node": "^10.9.1",
64
+ "tshy": "3",
65
+ "tshy-after": "1",
66
+ "typescript": "5",
67
+ "urllib": "^4.6.8"
68
+ },
69
+ "engines": {
70
+ "node": ">= 18.19.0"
71
+ },
72
+ "type": "module",
73
+ "tshy": {
74
+ "exports": {
75
+ ".": "./src/index.ts",
76
+ "./package.json": "./package.json"
77
+ }
78
+ },
79
+ "exports": {
80
+ ".": {
81
+ "import": {
82
+ "types": "./dist/esm/index.d.ts",
83
+ "default": "./dist/esm/index.js"
84
+ },
85
+ "require": {
86
+ "types": "./dist/commonjs/index.d.ts",
87
+ "default": "./dist/commonjs/index.js"
88
+ }
89
+ },
90
+ "./package.json": "./package.json"
91
+ },
92
+ "types": "./dist/commonjs/index.d.ts",
93
+ "module": "./dist/esm/index.js"
94
+ }
@@ -0,0 +1,75 @@
1
+ import { debuglog } from 'node:util';
2
+ import { EggConsoleLogger as ConsoleLogger } from 'egg-logger';
3
+ import { importModule } from '@eggjs/utils';
4
+ import { BaseAgentWorker } from './utils/mode/base/agent.js';
5
+ import { AgentThreadWorker } from './utils/mode/impl/worker_threads/agent.js';
6
+ import { AgentProcessWorker } from './utils/mode/impl/process/agent.js';
7
+
8
+ const debug = debuglog('@eggjs/cluster/agent_worker');
9
+
10
+ /**
11
+ * agent worker is child_process forked by master.
12
+ *
13
+ * agent worker only exit in two cases:
14
+ * - receive signal SIGTERM, exit code 0 (exit gracefully)
15
+ * - receive disconnect event, exit code 110 (maybe master exit in accident)
16
+ */
17
+ async function main() {
18
+ // $ node agent_worker.js options
19
+ const options = JSON.parse(process.argv[2]) as {
20
+ framework: string;
21
+ require?: string[];
22
+ startMode?: 'process' | 'worker_threads';
23
+ };
24
+ if (options.require) {
25
+ // inject
26
+ options.require.forEach(mod => {
27
+ require(mod);
28
+ });
29
+ }
30
+
31
+ let AgentWorker: typeof BaseAgentWorker;
32
+ if (options.startMode === 'worker_threads') {
33
+ AgentWorker = AgentThreadWorker as any;
34
+ } else {
35
+ AgentWorker = AgentProcessWorker as any;
36
+ }
37
+
38
+ const consoleLogger = new ConsoleLogger({ level: process.env.EGG_AGENT_WORKER_LOGGER_LEVEL });
39
+ const { Agent } = await importModule(options.framework);
40
+ debug('new Agent with options %j', options);
41
+ let agent: any;
42
+ try {
43
+ agent = new Agent(options);
44
+ } catch (err) {
45
+ consoleLogger.error(err);
46
+ throw err;
47
+ }
48
+
49
+ function startErrorHandler(err: Error) {
50
+ consoleLogger.error(err);
51
+ consoleLogger.error('[agent_worker] start error, exiting with code:1');
52
+ AgentWorker.kill();
53
+ }
54
+
55
+ agent.ready((err?: Error) => {
56
+ // don't send started message to master when start error
57
+ if (err) {
58
+ return;
59
+ }
60
+
61
+ agent.removeListener('error', startErrorHandler);
62
+ AgentWorker.send({ action: 'agent-start', to: 'master' });
63
+ });
64
+
65
+ // exit if agent start error
66
+ agent.once('error', startErrorHandler);
67
+
68
+ AgentWorker.gracefulExit({
69
+ logger: consoleLogger,
70
+ label: 'agent_worker',
71
+ beforeExit: () => agent.close(),
72
+ });
73
+ }
74
+
75
+ main();
@@ -0,0 +1,170 @@
1
+ import fs from 'node:fs';
2
+ import { createServer as createHttpServer, type Server } from 'node:http';
3
+ import { createServer as createHttpsServer } from 'node:https';
4
+ import type { Socket } from 'node:net';
5
+ import { debuglog } from 'node:util';
6
+ import { EggConsoleLogger as ConsoleLogger } from 'egg-logger';
7
+ import { importModule } from '@eggjs/utils';
8
+ import { BaseAppWorker } from './utils/mode/base/app.js';
9
+ import { AppThreadWorker } from './utils/mode/impl/worker_threads/app.js';
10
+ import { AppProcessWorker } from './utils/mode/impl/process/app.js';
11
+
12
+ const debug = debuglog('@eggjs/cluster/app_worker');
13
+
14
+ async function main() {
15
+ // $ node app_worker.js options-json-string
16
+ const options = JSON.parse(process.argv[2]) as {
17
+ framework: string;
18
+ require?: string[];
19
+ startMode?: 'process' | 'worker_threads';
20
+ port?: number;
21
+ debugPort?: number;
22
+ https?: object;
23
+ sticky?: boolean;
24
+ stickyWorkerPort?: number;
25
+ };
26
+ if (options.require) {
27
+ // inject
28
+ for (const mod of options.require) {
29
+ await importModule(mod);
30
+ }
31
+ }
32
+
33
+ let AppWorker: typeof BaseAppWorker;
34
+ if (options.startMode === 'worker_threads') {
35
+ AppWorker = AppThreadWorker as any;
36
+ } else {
37
+ AppWorker = AppProcessWorker as any;
38
+ }
39
+
40
+ const consoleLogger = new ConsoleLogger({
41
+ level: process.env.EGG_APP_WORKER_LOGGER_LEVEL,
42
+ });
43
+ const { Application } = await importModule(options.framework);
44
+ debug('new Application with options %j', options);
45
+ let app: any;
46
+ try {
47
+ app = new Application(options);
48
+ } catch (err) {
49
+ consoleLogger.error(err);
50
+ throw err;
51
+ }
52
+
53
+ app.ready(startServer);
54
+
55
+ function exitProcess() {
56
+ // Use SIGTERM kill process, ensure trigger the gracefulExit
57
+ AppWorker.kill();
58
+ }
59
+
60
+ // exit if worker start timeout
61
+ app.once('startTimeout', startTimeoutHandler);
62
+
63
+ function startTimeoutHandler() {
64
+ consoleLogger.error('[app_worker] start timeout, exiting with code:1');
65
+ exitProcess();
66
+ }
67
+
68
+ function startServer(err?: Error) {
69
+ if (err) {
70
+ consoleLogger.error(err);
71
+ consoleLogger.error('[app_worker] start error, exiting with code:1');
72
+ exitProcess();
73
+ return;
74
+ }
75
+
76
+ const clusterConfig = app.config.cluster ?? {};
77
+ const listenConfig = clusterConfig.listen ?? {};
78
+ const httpsOptions = {
79
+ ...clusterConfig.https,
80
+ ...options.https,
81
+ };
82
+ const port = options.port = options.port ?? listenConfig.port;
83
+ const debugPort = options.debugPort;
84
+ const protocol = (httpsOptions.key && httpsOptions.cert) ? 'https' : 'http';
85
+
86
+ AppWorker.send({
87
+ to: 'master',
88
+ action: 'realport',
89
+ data: {
90
+ port,
91
+ protocol,
92
+ },
93
+ });
94
+
95
+ app.removeListener('startTimeout', startTimeoutHandler);
96
+
97
+ let server: Server;
98
+ let debugPortServer: Server | undefined;
99
+
100
+ // https config
101
+ if (protocol === 'https') {
102
+ httpsOptions.key = fs.readFileSync(httpsOptions.key);
103
+ httpsOptions.cert = fs.readFileSync(httpsOptions.cert);
104
+ httpsOptions.ca = httpsOptions.ca && fs.readFileSync(httpsOptions.ca);
105
+ server = createHttpsServer(httpsOptions, app.callback());
106
+ if (debugPort) {
107
+ debugPortServer = createHttpServer(app.callback());
108
+ }
109
+ } else {
110
+ server = createHttpServer(app.callback());
111
+ if (debugPort) {
112
+ debugPortServer = server;
113
+ }
114
+ }
115
+
116
+ server.once('error', (err: any) => {
117
+ consoleLogger.error('[app_worker] server got error: %s, code: %s', err.message, err.code);
118
+ exitProcess();
119
+ });
120
+
121
+ // emit `server` event in app
122
+ app.emit('server', server);
123
+
124
+ if (options.sticky && options.stickyWorkerPort) {
125
+ server.listen(options.stickyWorkerPort, '127.0.0.1');
126
+ // Listen to messages was sent from the master. Ignore everything else.
127
+ AppWorker.on('message', (message: string, connection: Socket) => {
128
+ if (message !== 'sticky-session:connection') {
129
+ return;
130
+ }
131
+ // Emulate a connection event on the server by emitting the
132
+ // event with the connection the master sent us.
133
+ server.emit('connection', connection);
134
+ connection.resume();
135
+ });
136
+ } else {
137
+ if (listenConfig.path) {
138
+ server.listen(listenConfig.path);
139
+ } else {
140
+ if (typeof port !== 'number') {
141
+ consoleLogger.error('[app_worker] port should be number, but got %s(%s)', port, typeof port);
142
+ exitProcess();
143
+ return;
144
+ }
145
+ const args = [ port ];
146
+ if (listenConfig.hostname) args.push(listenConfig.hostname);
147
+ debug('listen options %s', args);
148
+ server.listen(...args);
149
+ }
150
+ if (debugPortServer) {
151
+ debug('listen on debug port: %s', debugPort);
152
+ debugPortServer.listen(debugPort);
153
+ }
154
+ }
155
+
156
+ AppWorker.send({
157
+ to: 'master',
158
+ action: 'listening',
159
+ data: server.address() || { port },
160
+ });
161
+ }
162
+
163
+ AppWorker.gracefulExit({
164
+ logger: consoleLogger,
165
+ label: 'app_worker',
166
+ beforeExit: () => app.close(),
167
+ });
168
+ }
169
+
170
+ main();
package/src/dirname.ts ADDED
@@ -0,0 +1,11 @@
1
+ import { fileURLToPath } from 'node:url';
2
+ import path from 'node:path';
3
+
4
+ export function getSrcDirname() {
5
+ if (typeof __dirname !== 'undefined') {
6
+ return __dirname;
7
+ }
8
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
9
+ // @ts-ignore
10
+ return path.dirname(fileURLToPath(import.meta.url));
11
+ }
@@ -0,0 +1,19 @@
1
+ export class ClusterAgentWorkerError extends Error {
2
+ id: number;
3
+ /**
4
+ * pid in process mode
5
+ * tid in worker_threads mode
6
+ */
7
+ workerId: number;
8
+ status: string;
9
+
10
+ constructor(id: number, workerId: number, status: string, error: Error) {
11
+ const message = `Got agent worker error: ${error.message}`;
12
+ super(message, { cause: error });
13
+ this.name = this.constructor.name;
14
+ this.id = id;
15
+ this.workerId = workerId;
16
+ this.status = status;
17
+ Error.captureStackTrace(this, this.constructor);
18
+ }
19
+ }
@@ -0,0 +1,17 @@
1
+ export class ClusterWorkerExceptionError extends Error {
2
+ count: {
3
+ agent: number;
4
+ worker: number;
5
+ };
6
+
7
+ constructor(agent: number, worker: number) {
8
+ const message = `[master] ${agent} agent and ${worker} worker(s) alive, exit to avoid unknown state`;
9
+ super(message);
10
+ this.name = this.constructor.name;
11
+ this.count = {
12
+ agent,
13
+ worker,
14
+ };
15
+ Error.captureStackTrace(this, this.constructor);
16
+ }
17
+ }
@@ -0,0 +1,2 @@
1
+ export * from './ClusterAgentWorkerError.js';
2
+ export * from './ClusterWorkerExceptionError.js';
package/src/index.ts ADDED
@@ -0,0 +1,26 @@
1
+ import { Master, MasterOptions } from './master.js';
2
+ import { ClusterOptions, ClusterHTTPSSecureOptions, ClusterStartMode } from './utils/options.js';
3
+
4
+ /**
5
+ * cluster start flow:
6
+ *
7
+ * [startCluster] -> master -> agent_worker -> new [Agent] -> agentWorkerLoader
8
+ * `-> app_worker -> new [Application] -> appWorkerLoader
9
+ *
10
+ */
11
+
12
+ /**
13
+ * start egg app
14
+ * @function Egg#startCluster
15
+ * @param {Object} options {@link Master}
16
+ */
17
+ export async function startCluster(options: ClusterOptions) {
18
+ await new Master(options).ready();
19
+ }
20
+
21
+ export {
22
+ Master, MasterOptions,
23
+ ClusterOptions, ClusterHTTPSSecureOptions, ClusterStartMode,
24
+ };
25
+
26
+ export * from './error/index.js';