forked from openclaw/openclaw
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathentry.respawn.ts
More file actions
243 lines (221 loc) · 6.92 KB
/
Copy pathentry.respawn.ts
File metadata and controls
243 lines (221 loc) · 6.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
import { spawn, type ChildProcess } from "node:child_process";
import path from "node:path";
import { resolveNodeStartupTlsEnvironment } from "./bootstrap/node-startup-env.js";
import {
shouldSkipRespawnForArgv,
shouldSkipStartupEnvironmentRespawnForArgv,
} from "./cli/respawn-policy.js";
import { normalizeWindowsArgv } from "./cli/windows-argv.js";
import { isTruthyEnvValue } from "./infra/env.js";
import { attachChildProcessBridge } from "./process/child-process-bridge.js";
export const EXPERIMENTAL_WARNING_FLAG = "--disable-warning=ExperimentalWarning";
export const OPENCLAW_NODE_OPTIONS_READY = "OPENCLAW_NODE_OPTIONS_READY";
export const OPENCLAW_NODE_EXTRA_CA_CERTS_READY = "OPENCLAW_NODE_EXTRA_CA_CERTS_READY";
const WINDOWS_STACK_SIZE_FLAG = "--stack-size=8192";
const CLI_RESPAWN_SIGNAL_EXIT_GRACE_MS = 1_000;
const CLI_RESPAWN_SIGNAL_FORCE_KILL_GRACE_MS = 1_000;
const CLI_RESPAWN_SIGNAL_HARD_EXIT_GRACE_MS = 1_000;
type CliRespawnPlan = {
command: string;
argv: string[];
env: NodeJS.ProcessEnv;
};
type CliRespawnRuntime = {
spawn: typeof spawn;
attachChildProcessBridge: typeof attachChildProcessBridge;
exit: (code?: number) => never;
writeError: (message: string, error?: unknown) => void;
};
function pathModuleForPlatform(platform: NodeJS.Platform): typeof path.posix {
return platform === "win32" ? path.win32 : path.posix;
}
export function resolveCliRespawnCommand(params: {
execPath: string;
platform?: NodeJS.Platform;
}): string {
const platform = params.platform ?? process.platform;
const basename = pathModuleForPlatform(platform).basename(params.execPath).toLowerCase();
if (basename === "volta-shim" || basename === "volta-shim.exe") {
return "node";
}
return params.execPath;
}
function hasExperimentalWarningSuppressed(
params: {
env?: NodeJS.ProcessEnv;
execArgv?: string[];
} = {},
): boolean {
const env = params.env ?? process.env;
const execArgv = params.execArgv ?? process.execArgv;
const nodeOptions = env.NODE_OPTIONS ?? "";
if (nodeOptions.includes(EXPERIMENTAL_WARNING_FLAG) || nodeOptions.includes("--no-warnings")) {
return true;
}
return execArgv.some((arg) => arg === EXPERIMENTAL_WARNING_FLAG || arg === "--no-warnings");
}
function hasStackSizeConfigured(execArgv: string[]): boolean {
return execArgv.some(
(arg) =>
arg === "--stack-size" ||
arg.startsWith("--stack-size=") ||
arg === "--stack_size" ||
arg.startsWith("--stack_size="),
);
}
export function buildCliRespawnPlan(
params: {
argv?: string[];
env?: NodeJS.ProcessEnv;
execArgv?: string[];
execPath?: string;
autoNodeExtraCaCerts?: string | undefined;
platform?: NodeJS.Platform;
} = {},
): CliRespawnPlan | null {
const argv = params.argv ?? process.argv;
const env = params.env ?? process.env;
const execArgv = params.execArgv ?? process.execArgv;
const execPath = params.execPath ?? process.execPath;
const platform = params.platform ?? process.platform;
const normalizedArgv =
platform === "win32" ? normalizeWindowsArgv(argv, { platform, execPath }) : argv;
if (
shouldSkipStartupEnvironmentRespawnForArgv(normalizedArgv) ||
isTruthyEnvValue(env.OPENCLAW_NO_RESPAWN)
) {
return null;
}
const childEnv: NodeJS.ProcessEnv = { ...env };
const childExecArgv = [...execArgv];
let needsRespawn = false;
if (platform === "win32") {
if (!hasStackSizeConfigured(childExecArgv)) {
childExecArgv.unshift(WINDOWS_STACK_SIZE_FLAG);
needsRespawn = true;
}
if (!needsRespawn) {
return null;
}
return {
command: resolveCliRespawnCommand({ execPath, platform }),
argv: [...childExecArgv, ...normalizedArgv.slice(1)],
env: childEnv,
};
}
const autoNodeExtraCaCerts =
params.autoNodeExtraCaCerts ??
resolveNodeStartupTlsEnvironment({
env,
execPath,
includeDarwinDefaults: false,
}).NODE_EXTRA_CA_CERTS;
if (
autoNodeExtraCaCerts &&
!isTruthyEnvValue(env[OPENCLAW_NODE_EXTRA_CA_CERTS_READY]) &&
!env.NODE_EXTRA_CA_CERTS
) {
childEnv.NODE_EXTRA_CA_CERTS = autoNodeExtraCaCerts;
childEnv[OPENCLAW_NODE_EXTRA_CA_CERTS_READY] = "1";
needsRespawn = true;
}
if (
!shouldSkipRespawnForArgv(argv) &&
!isTruthyEnvValue(env[OPENCLAW_NODE_OPTIONS_READY]) &&
!hasExperimentalWarningSuppressed({ env, execArgv })
) {
childEnv[OPENCLAW_NODE_OPTIONS_READY] = "1";
childExecArgv.unshift(EXPERIMENTAL_WARNING_FLAG);
needsRespawn = true;
}
if (!needsRespawn) {
return null;
}
return {
command: resolveCliRespawnCommand({ execPath, platform }),
argv: [...childExecArgv, ...argv.slice(1)],
env: childEnv,
};
}
export function runCliRespawnPlan(
plan: CliRespawnPlan,
runtime: CliRespawnRuntime = {
spawn,
attachChildProcessBridge,
exit: process.exit.bind(process) as (code?: number) => never,
writeError: (message, error) => console.error(message, error),
},
): ChildProcess {
const child = runtime.spawn(plan.command, plan.argv, {
stdio: "inherit",
env: plan.env,
});
let signalExitTimer: NodeJS.Timeout | undefined;
let signalForceKillTimer: NodeJS.Timeout | undefined;
let signalHardExitTimer: NodeJS.Timeout | undefined;
const clearSignalTimers = (): void => {
if (signalExitTimer) {
clearTimeout(signalExitTimer);
signalExitTimer = undefined;
}
if (signalForceKillTimer) {
clearTimeout(signalForceKillTimer);
signalForceKillTimer = undefined;
}
if (signalHardExitTimer) {
clearTimeout(signalHardExitTimer);
signalHardExitTimer = undefined;
}
};
const forceKillChild = (): void => {
try {
child.kill(process.platform === "win32" ? "SIGTERM" : "SIGKILL");
} catch {
// Best-effort shutdown fallback.
}
};
const requestChildTermination = (): void => {
try {
child.kill("SIGTERM");
} catch {
// Best-effort shutdown fallback.
}
signalForceKillTimer = setTimeout(() => {
forceKillChild();
signalHardExitTimer = setTimeout(() => {
runtime.exit(1);
}, CLI_RESPAWN_SIGNAL_HARD_EXIT_GRACE_MS);
signalHardExitTimer.unref?.();
}, CLI_RESPAWN_SIGNAL_FORCE_KILL_GRACE_MS);
signalForceKillTimer.unref?.();
};
const scheduleParentExit = (): void => {
if (signalExitTimer) {
return;
}
signalExitTimer = setTimeout(() => {
requestChildTermination();
}, CLI_RESPAWN_SIGNAL_EXIT_GRACE_MS);
signalExitTimer.unref?.();
};
runtime.attachChildProcessBridge(child, {
onSignal: scheduleParentExit,
});
child.once("exit", (code, signal) => {
clearSignalTimers();
if (signal) {
runtime.exit(1);
return;
}
runtime.exit(code ?? 1);
});
child.once("error", (error) => {
clearSignalTimers();
runtime.writeError(
"[openclaw] Failed to respawn CLI:",
error instanceof Error ? (error.stack ?? error.message) : error,
);
runtime.exit(1);
});
return child;
}