File size: 62,808 Bytes
f778c12 | 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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 | // In-process gateway run loop, restart signaling, drain, and update respawn handling.
import type { ChildProcess } from "node:child_process";
import { randomUUID } from "node:crypto";
import net from "node:net";
import { performance } from "node:perf_hooks";
import { MessageChannel } from "node:worker_threads";
import { truncateUtf16Safe } from "@openclaw/normalization-core/utf16-slice";
import { clearRuntimeConfigSnapshot } from "../../config/runtime-snapshot.js";
import {
captureGatewayRestartTraceHandoff,
createGatewayRestartTraceHandoffEnv,
measureGatewayRestartTrace,
markGatewayRestartTrace,
startGatewayRestartTrace,
} from "../../gateway/restart-trace.js";
import type { GatewayHostLifecycle, GatewayStartupOperation } from "../../gateway/server-public.js";
import { GatewayStartupCleanupError } from "../../gateway/server-shutdown.js";
import type { startGatewayServer } from "../../gateway/server.js";
import { flushDiagnosticsTimeline } from "../../infra/diagnostics-timeline.js";
import { formatErrorMessage } from "../../infra/errors.js";
import type { GatewayActiveWorkSnapshot } from "../../infra/gateway-active-work.js";
import {
GATEWAY_BOOT_REASON_MAX_UTF16_CODE_UNITS,
GATEWAY_SIGNAL_REPEAT_WINDOW_MS,
formatGatewayRepeatedSignalHint,
type GatewayBootLifecycleCompletion,
} from "../../infra/gateway-boot-lifecycle.js";
import { acquireGatewayLock } from "../../infra/gateway-lock.js";
import { consumeGatewaySuspendHandoff } from "../../infra/gateway-suspend-coordinator.js";
import type { GatewayRestartIntent } from "../../infra/restart-intent.js";
import type { GatewayRestartEmitter } from "../../infra/restart.js";
import { SqliteIntegrityWorkerInterruptedError } from "../../infra/sqlite-integrity-worker-error.js";
import { findStartupMaintenanceRequiredError } from "../../infra/startup-maintenance-required.js";
import { flushLogger } from "../../logging/logger.js";
import { createSubsystemLogger } from "../../logging/subsystem.js";
import {
type GatewayDrainReason,
type GatewayShutdownTrigger,
runOutsideGatewayRootWorkAdmission,
} from "../../process/gateway-work-admission.js";
import type { RuntimeEnv } from "../../runtime.js";
import { AsyncWorkScope } from "../../shared/async-work-scope.js";
import { drainGlobalSingletonLifecycleState } from "../../shared/global-singleton.js";
import { createLazyImportLoader } from "../../shared/lazy-promise.js";
import { createGatewayHostLifecycle } from "./host-lifecycle.js";
import {
armShutdownHardExitWatchdog,
type ShutdownHardExitWatchdog,
} from "./shutdown-hard-exit.js";
const gatewayLog = createSubsystemLogger("gateway");
const LAUNCHD_SUPERVISED_RESTART_EXIT_DELAY_MS = 1500;
const DEFAULT_RESTART_DRAIN_TIMEOUT_MS = 300_000;
const RESTART_DRAIN_STILL_PENDING_WARN_MS = 30_000;
const RESTART_CLOSE_REPLY_DRAIN_SHUTDOWN_RESERVE_MS = 10_000;
const UPDATE_RESPAWN_HEALTH_TIMEOUT_MS = 10_000;
const UPDATE_RESPAWN_HEALTH_POLL_MS = 200;
const LOG_FLUSH_EXIT_TIMEOUT_MS = 4_000;
const HARD_EXIT_WATCHDOG_GRACE_MS = 2_000;
type GatewayRunSignalAction = "stop" | "restart" | "external-restart";
type GatewayRunSignalRequest = {
action: GatewayRunSignalAction;
signal: GatewayShutdownTrigger;
restartReason?: string;
restartIntent?: GatewayRestartIntent;
hostedStop?: ReturnType<typeof createGatewayHostLifecycle>;
};
function formatShutdownReason(request: GatewayRunSignalRequest): GatewayDrainReason {
const { action, signal, restartReason } = request;
const trigger =
restartReason && restartReason !== signal
? (`${signal}: ${truncateUtf16Safe(restartReason.replaceAll(/\s+/g, " "), 200)}` as const)
: signal;
return `${action === "stop" ? "stop" : "restart"} (${trigger})`;
}
type GatewayLifecycleRuntimeModule = typeof import("./lifecycle.runtime.js");
type ShutdownFailure = { step: string; error: unknown };
function isUpdateProcessRestartReason(reason: string | undefined): boolean {
return reason === "update.run" || reason === "update.auto";
}
const gatewayLifecycleRuntimeLoader = createLazyImportLoader<GatewayLifecycleRuntimeModule>(
() => import("./lifecycle.runtime.js"),
);
const loadGatewayLifecycleRuntimeModule = () => gatewayLifecycleRuntimeLoader.load();
// Blocker descriptions can contain task identities and request origins.
function formatDrainCounts(snapshot: GatewayActiveWorkSnapshot): string {
return Object.entries(snapshot.counts)
.filter(([name, count]) => name !== "totalActive" && count > 0)
.map(([name, count]) => `${name}=${count}`)
.join(" ");
}
async function waitForGatewayPortReady(host: string, port: number): Promise<boolean> {
return await new Promise<boolean>((resolve) => {
const socket = net.createConnection({ host, port });
const finish = (value: boolean) => {
socket.destroy();
resolve(value);
};
socket.setTimeout(UPDATE_RESPAWN_HEALTH_POLL_MS, () => finish(false));
socket.once("connect", () => finish(true));
socket.once("error", () => finish(false));
});
}
async function waitForHealthyGatewayChild(
port: number,
_pid?: number,
host = "127.0.0.1",
timeoutMs = UPDATE_RESPAWN_HEALTH_TIMEOUT_MS,
): Promise<boolean> {
const deadline = Date.now() + timeoutMs;
while (Date.now() < deadline) {
if (await waitForGatewayPortReady(host, port)) {
return true;
}
await new Promise<void>((resolve) => {
setTimeout(resolve, UPDATE_RESPAWN_HEALTH_POLL_MS);
});
}
return false;
}
function createGatewayStartupOperations(): {
run: GatewayStartupOperation;
close(): void;
cancelledWith(error: unknown): boolean;
failedWith(error: unknown): boolean;
stopCompletion?: Promise<void>;
drain(): Promise<void>;
} {
const scope = new AsyncWorkScope();
let failure: { error: unknown } | undefined;
// A process-group stop can kill a child before its separate admission owner is cancelled.
const cancelledWith = (error: unknown) =>
scope.signal.aborted &&
(error === scope.signal.reason ||
(error instanceof SqliteIntegrityWorkerInterruptedError &&
(error.signal === "SIGTERM" || error.signal === "SIGINT")));
const run: GatewayStartupOperation = async (operation) => {
if (scope.isClosing) {
throw scope.signal.reason;
}
return await scope.track(async () => {
try {
return await operation(scope.signal);
} catch (error) {
if (!cancelledWith(error)) {
failure ??= { error };
}
throw error;
}
});
};
return {
run,
close: () => scope.beginClose(),
cancelledWith,
failedWith: (error: unknown) => failure !== undefined && failure.error === error,
async drain() {
await scope.drain();
// AsyncWorkScope joins descendants with allSettled; failed cleanup must
// still make the accepted stop fail rather than certify a clean exit.
if (failure) {
throw failure.error;
}
},
};
}
export async function runGatewayLoop(params: {
start: (params?: {
processStartedAt?: number;
startupStartedAt?: number;
requestHotReloadRecovery?: GatewayRestartEmitter;
hostLifecycle?: GatewayHostLifecycle;
startupOperation?: GatewayStartupOperation;
}) => Promise<Awaited<ReturnType<typeof startGatewayServer>>>;
runtime: RuntimeEnv;
/** Grants this run loop authority over the process it exclusively owns. */
ownsProcessLifecycle?: boolean;
lockPort?: number;
lifecycleLockDeadlineMs?: number;
healthHost?: string;
waitForHealthyChild?: (port: number, pid?: number, host?: string) => Promise<boolean>;
beginBoot?: (startedAtMs: number) => void | Promise<void>;
completeBoot?: (completion: GatewayBootLifecycleCompletion) => void;
onRestartStartupFailure?: (error: unknown, signal: AbortSignal) => Promise<void>;
}) {
// macOS/BSD process inspection reports process.title instead of the original
// argv. Give the long-running Gateway a verifiable identity for lock readers.
if (process.title === "openclaw") {
process.title = "openclaw-gateway";
}
let startupStartedAt: number;
const processStartedAt = performance.timeOrigin;
// Eagerly resolve the lifecycle runtime module before installing signal
// listeners. Without this, every subsequent lifecycle path (SIGUSR1,
// SIGTERM-with-intent, restart iteration hook, stability bundle writer)
// depends on a dynamic import() call. After an in-place package upgrade
// (e.g. `npm install -g openclaw@latest` triggered via update.run),
// dist/ chunk hashes rotate while the process is still running. The next
// SIGUSR1 — including the one update.run schedules for itself — would
// hit ERR_MODULE_NOT_FOUND from inside its async IIFE, reject silently,
// and leave restart.ts's emittedRestartToken permanently unconsumed.
// From that point every scheduleGatewaySigusr1Restart() returns
// { coalesced: true } and the gateway never restarts. Priming the loader
// here pulls the lifecycle re-export graph into memory, immune to later disk
// rotation.
const eagerLifecycleRuntime = await loadGatewayLifecycleRuntimeModule();
const supervisor = eagerLifecycleRuntime.detectGatewayRespawnSupervisorIdentity(
process.env,
process.platform,
{ includeLinuxOpenClawGatewayServiceMarker: true },
);
const supervisorMode = supervisor?.kind ?? null;
let lock = await acquireGatewayLock({
port: params.lockPort,
listenerMode: supervisorMode ? "supervised" : "foreground",
supervisor,
...(params.lifecycleLockDeadlineMs !== undefined
? { lifecycleDeadlineMs: params.lifecycleLockDeadlineMs }
: {}),
});
// Process-owned signal handling must survive gaps with no listening server.
// Node's signal listeners and pending promises do not retain the event loop.
const processLifetime = params.ownsProcessLifecycle ? new MessageChannel() : undefined;
processLifetime?.port1.ref();
let server: Awaited<ReturnType<typeof startGatewayServer>> | null = null;
let hostLifecycle: ReturnType<typeof createGatewayHostLifecycle> | undefined;
let startupOperations = createGatewayStartupOperations();
let terminalHostedStop: ReturnType<typeof createGatewayHostLifecycle> | undefined;
let shuttingDown = false;
let forcedExitStarted = false;
let restartResolver: (() => void) | null = null;
// The HTTP server can report ready before params.start returns its close handle.
// Defer lifecycle signals from that window until the loop can close and advance.
let pendingStartupRequest: GatewayRunSignalRequest | null = null;
let activeRestartRequest: GatewayRunSignalRequest | null = null;
let committedGenericSuccessor: ChildProcess | true | null = null;
let forceActiveRestartExit: (() => void) | null = null;
let pendingStartupForceExitTimer: ReturnType<typeof setTimeout> | null = null;
let restartDrainingMarked = false;
const recentSignals = new Map<NodeJS.Signals, number[]>();
const observeSignal = (signal: NodeJS.Signals) => {
const now = Date.now();
const times = (recentSignals.get(signal) ?? []).filter(
(time) => now - time <= GATEWAY_SIGNAL_REPEAT_WINDOW_MS,
);
times.push(now);
recentSignals.set(signal, times.slice(-3));
if (times.length === 3) {
gatewayLog.warn(formatGatewayRepeatedSignalHint(signal, 3));
}
};
let startupFailedWithoutServerHandle = false;
let failureWork: { controller: AbortController; settled: Promise<void> } | undefined;
const processInstanceId = randomUUID();
const waitForHealthyChild = params.waitForHealthyChild ?? waitForHealthyGatewayChild;
const getManagedUpdateOwner = () =>
(pendingStartupRequest ?? activeRestartRequest)?.restartIntent?.successorOwner;
const sameManagedUpdateOwner = (
left: GatewayRestartIntent["successorOwner"],
right: GatewayRestartIntent["successorOwner"],
) =>
Boolean(
left && right && left.handoffId === right.handoffId && left.installRoot === right.installRoot,
);
const cleanupSignals = () => {
process.removeListener("SIGTERM", onSigterm);
process.removeListener("SIGINT", onSigint);
process.removeListener("SIGUSR1", onSigusr1);
processLifetime?.port1.close();
processLifetime?.port2.close();
};
const exitProcess = (code: number) => {
void hostLifecycle?.retire();
cleanupSignals();
params.runtime.exit(code);
};
const flushLogsBeforeExit = async (timeoutMs = LOG_FLUSH_EXIT_TIMEOUT_MS) => {
flushDiagnosticsTimeline();
let flushTimer: ReturnType<typeof setTimeout> | undefined;
const flushed = await Promise.race([
flushLogger().then(() => true),
new Promise<false>((resolve) => {
flushTimer = setTimeout(() => resolve(false), timeoutMs);
}),
]);
clearTimeout(flushTimer);
if (!flushed) {
gatewayLog.warn(`log flush did not settle within ${timeoutMs}ms; continuing shutdown`);
}
};
const exitProcessAfterLogFlush = async (
code: number,
initialOwner?: GatewayRestartIntent["successorOwner"],
initialOutcome: "update" | "restore" = "update",
hostStopOwner?: ReturnType<typeof createGatewayHostLifecycle>,
): Promise<void> => {
if (hostStopOwner && hostLifecycle !== hostStopOwner) {
return;
}
let ownerToCommit = initialOwner;
let commitOutcome = initialOutcome;
// Graceful signal/restart paths call process.exit(), which skips beforeExit.
await eagerLifecycleRuntime
.stopGatewayManagedProviderLocalServices()
.catch((error: unknown) => {
gatewayLog.warn(`managed local service shutdown failed: ${formatErrorMessage(error)}`);
});
if (hostStopOwner && hostLifecycle !== hostStopOwner) {
return;
}
await flushLogsBeforeExit();
for (;;) {
if (hostStopOwner && hostLifecycle !== hostStopOwner) {
return;
}
const owner = getManagedUpdateOwner();
if (!owner) {
if (!ownerToCommit) {
exitProcess(code);
}
return;
}
if (
sameManagedUpdateOwner(owner, ownerToCommit) &&
eagerLifecycleRuntime.claimManagedServiceUpdateHandoff(owner) &&
(await eagerLifecycleRuntime.commitManagedServiceUpdateHandoff(owner, commitOutcome)) &&
sameManagedUpdateOwner(getManagedUpdateOwner(), owner) &&
eagerLifecycleRuntime.claimManagedServiceUpdateHandoff(owner)
) {
// Keep exact request ownership live through the synchronous exit call.
exitProcess(code);
return;
}
await markRestartHandoffUnavailable();
const ownerToCancel = ownerToCommit ?? owner;
const restoration = await cancelManagedUpdateHandoffBeforeRecovery(ownerToCancel);
if (!restoration) {
const child = committedGenericSuccessor === true ? null : committedGenericSuccessor;
if (child && child.exitCode === null && child.signalCode === null) {
const exited = new Promise<void>((resolve) => {
child.once("exit", () => {
resolve();
});
});
try {
child.kill("SIGKILL");
await exited;
} catch {}
}
return;
}
if (restoration === "restart-after-exit") {
ownerToCommit = ownerToCancel;
commitOutcome = "restore";
const currentRequest = pendingStartupRequest ?? activeRestartRequest;
if (
currentRequest &&
!sameManagedUpdateOwner(currentRequest.restartIntent?.successorOwner, ownerToCancel)
) {
currentRequest.restartIntent = {
...currentRequest.restartIntent,
successorOwner: ownerToCancel,
};
}
continue;
}
// Restoring the helper does not make a failed generation reusable.
if (code === 0 && !forcedExitStarted && !committedGenericSuccessor && initialOwner) {
return reacquireAndResumeInProcessRestart(getManagedUpdateOwner() ?? owner);
}
exitProcess(code);
return;
}
};
const writeStabilityBundle = (reason: string, error?: unknown, shutdownStep?: string) => {
const result = eagerLifecycleRuntime.writeDiagnosticStabilityBundleForFailureSync(
reason,
error,
...(shutdownStep ? [{ shutdownStep }] : []),
);
if ("message" in result) {
gatewayLog.warn(result.message);
}
};
const releaseLockIfHeld = async (): Promise<void> => {
await lock?.release();
lock = null;
};
const cancelManagedUpdateHandoffBeforeRecovery = async (
initialOwner = getManagedUpdateOwner(),
): Promise<false | "restored-in-process" | "restart-after-exit"> => {
let owner = initialOwner;
let requiresParentExit = false;
try {
for (;;) {
if (!owner) {
return requiresParentExit ? "restart-after-exit" : "restored-in-process";
}
const restoration = await eagerLifecycleRuntime.cancelManagedServiceUpdateHandoff(owner);
if (!restoration) {
gatewayLog.error("managed update handoff cancellation unconfirmed; remaining draining");
return false;
}
requiresParentExit ||= restoration === "restart-after-exit";
const replacement = getManagedUpdateOwner();
if (!replacement || sameManagedUpdateOwner(owner, replacement)) {
return requiresParentExit ? "restart-after-exit" : "restored-in-process";
}
owner = replacement;
}
} catch (err) {
gatewayLog.error(`managed update handoff cancellation failed: ${formatErrorMessage(err)}`);
return false;
}
};
const forceExitAfterStabilityBundle = async (
reason: string,
exitCode = 1,
failure?: ShutdownFailure,
) => {
if (forcedExitStarted) {
return;
}
forcedExitStarted = true;
void hostLifecycle?.retire();
try {
writeStabilityBundle(reason, failure?.error, failure?.step);
} finally {
// Exit rescue cannot replay an issued file append; join it before final authority checks.
// Reserve half the hard-exit grace for final shutdown bookkeeping.
await flushLogsBeforeExit(HARD_EXIT_WATCHDOG_GRACE_MS / 2);
const owner = getManagedUpdateOwner();
if (owner) {
forceActiveRestartExit?.();
}
const restoration = await cancelManagedUpdateHandoffBeforeRecovery(owner);
if (restoration) {
params.completeBoot?.({ outcome: "forced_stop", reason });
if (restoration === "restart-after-exit") {
await exitProcessAfterLogFlush(exitCode, owner, "restore");
} else {
exitProcess(exitCode);
}
}
}
};
const reacquireAndResumeInProcessRestart = async (
alreadyCancelledOwner?: GatewayRestartIntent["successorOwner"],
): Promise<void> => {
for (;;) {
if (forcedExitStarted) {
return;
}
const restartRequest = activeRestartRequest;
const restartOwner = restartRequest?.restartIntent?.successorOwner;
const restoration = sameManagedUpdateOwner(restartOwner, alreadyCancelledOwner)
? "restored-in-process"
: await cancelManagedUpdateHandoffBeforeRecovery(restartOwner);
if (!restoration || forcedExitStarted) {
return;
}
if (restoration === "restart-after-exit") {
await releaseLockIfHeld();
return exitProcessAfterLogFlush(0, restartOwner, "restore");
}
if (activeRestartRequest !== restartRequest) {
continue;
}
try {
lock = await acquireGatewayLock({
port: params.lockPort,
listenerMode: supervisorMode ? "supervised" : "foreground",
supervisor,
});
} catch (err) {
if (forcedExitStarted) {
return;
}
if (activeRestartRequest !== restartRequest) {
continue;
}
gatewayLog.error(`failed to reacquire gateway lock for in-process restart: ${String(err)}`);
exitProcess(1);
return;
}
if (!forcedExitStarted && activeRestartRequest === restartRequest) {
activeRestartRequest = null;
shuttingDown = false;
restartResolver?.();
return;
}
await releaseLockIfHeld();
}
};
const markRestartHandoffUnavailable = async (reason = "restart-handoff-unavailable") => {
await eagerLifecycleRuntime.markUpdateRestartSentinelFailure(reason).catch((err: unknown) => {
gatewayLog.warn(`failed to mark update restart ${reason}: ${String(err)}`);
});
};
const handleRestartAfterServerClose = async (
expectedOwner?: GatewayRestartIntent["successorOwner"],
cancelled = false,
): Promise<void> => {
await releaseLockIfHeld();
if (forcedExitStarted) {
return;
}
// Lock release may yield while a managed update upgrades this restart.
const restartReason = activeRestartRequest?.restartReason;
params.completeBoot?.({
outcome: "planned_restart",
reason: activeRestartRequest ? formatShutdownReason(activeRestartRequest) : "gateway.restart",
});
const isUpdateRestart = isUpdateProcessRestartReason(restartReason);
if (cancelled) {
return reacquireAndResumeInProcessRestart(expectedOwner);
}
if (activeRestartRequest?.restartIntent?.successorOwner) {
if (!expectedOwner) {
gatewayLog.error("managed update handoff arrived after successor parking closed");
await markRestartHandoffUnavailable();
return reacquireAndResumeInProcessRestart();
}
gatewayLog.info("restart mode: managed update handoff owns successor");
return exitProcessAfterLogFlush(0, expectedOwner);
}
const respawnOptions = {
env: createGatewayRestartTraceHandoffEnv(captureGatewayRestartTraceHandoff()),
};
const isStandaloneUpdate = isUpdateRestart && !supervisorMode;
const respawn = isStandaloneUpdate
? eagerLifecycleRuntime.respawnGatewayProcessForUpdate(respawnOptions)
: eagerLifecycleRuntime.restartGatewayProcessWithFreshPid(respawnOptions);
if (respawn.mode === "spawned") {
const port = params.lockPort;
const healthy =
typeof port === "number"
? await waitForHealthyChild(port, respawn.pid, params.healthHost ?? "127.0.0.1")
: false;
if (healthy) {
committedGenericSuccessor = respawn.child ?? true;
gatewayLog.info(
`restart mode: update process respawn (spawned pid ${respawn.pid ?? "unknown"})`,
);
return exitProcessAfterLogFlush(0);
}
gatewayLog.warn(
`update respawn child did not become healthy (${respawn.pid ?? "unknown"}); falling back to in-process restart`,
);
try {
respawn.child?.kill();
} catch {
// Best-effort; parent fallback keeps the gateway reachable for recovery.
}
await markRestartHandoffUnavailable("restart-unhealthy");
return reacquireAndResumeInProcessRestart();
}
if (respawn.mode === "supervised") {
const restartKind = isUpdateRestart ? "update-process" : "full-process";
markGatewayRestartTrace("restart.full-process-handoff", [
["kind", restartKind],
["mode", respawn.mode],
["pid", "none"],
["supervisorMode", supervisorMode ?? "none"],
]);
const handoff = eagerLifecycleRuntime.writeGatewayRestartHandoffSync({
restartKind,
reason: restartReason,
processInstanceId,
supervisorMode: supervisorMode ?? "external",
restartTrace: captureGatewayRestartTraceHandoff(),
});
if (supervisorMode === "external" && !handoff) {
gatewayLog.warn(
"external supervisor restart handoff could not be persisted; falling back to in-process restart",
);
if (isUpdateRestart) {
await markRestartHandoffUnavailable();
}
return reacquireAndResumeInProcessRestart();
}
gatewayLog.info("restart mode: full process restart (supervisor restart)");
if (supervisorMode === "launchd") {
const delay = new Promise<void>((resolve) => {
setTimeout(resolve, LAUNCHD_SUPERVISED_RESTART_EXIT_DELAY_MS);
});
const spawned = respawn.handoffSpawned
? await Promise.race([respawn.handoffSpawned, delay.then(() => true)])
: false;
// Preserve the crash-loop throttle window even when spawn settles early.
await delay;
if (!spawned) {
writeStabilityBundle("gateway.restart_handoff_spawn_failed");
gatewayLog.warn(
"launchd restart handoff failed to spawn; falling back to in-process restart",
);
if (isUpdateRestart) {
await markRestartHandoffUnavailable();
}
return reacquireAndResumeInProcessRestart();
}
}
committedGenericSuccessor = true;
return exitProcessAfterLogFlush(respawn.exitCode ?? 0);
}
if (respawn.mode === "failed") {
if (!isStandaloneUpdate) {
writeStabilityBundle("gateway.restart_respawn_failed");
}
gatewayLog.warn(
`${isStandaloneUpdate ? "update respawn" : "full process restart"} failed (${respawn.detail ?? "unknown error"}); falling back to in-process restart`,
);
if (isUpdateRestart) {
await markRestartHandoffUnavailable("restart-unhealthy");
}
} else {
gatewayLog.info(
`restart mode: in-process restart (${respawn.detail ?? "OPENCLAW_NO_RESPAWN"})`,
);
}
if (!isUpdateRestart && isUpdateProcessRestartReason(activeRestartRequest?.restartReason)) {
return handleRestartAfterServerClose();
}
return reacquireAndResumeInProcessRestart();
};
// The managed unit grants this same budget to a graceful SIGTERM. A plain
// supervisor restart does not carry a gateway restart intent, but it can
// still interrupt an embedded model/tool turn; leave enough time for that
// turn to settle before systemd resorts to SIGKILL.
const SUPERVISOR_STOP_TIMEOUT_MS = 330_000;
const SHUTDOWN_TIMEOUT_MS = SUPERVISOR_STOP_TIMEOUT_MS - 5_000;
const nativeStopBudget = supervisorMode === "systemd" || supervisorMode === "launchd";
const acceptedShutdownTimeoutMs =
supervisorMode === "launchd"
? eagerLifecycleRuntime.LAUNCH_AGENT_EXIT_TIMEOUT_SECONDS * 1_000 - 5_000
: SHUTDOWN_TIMEOUT_MS;
const clearPendingStartupForceExitTimer = () => {
clearTimeout(pendingStartupForceExitTimer ?? undefined);
pendingStartupForceExitTimer = null;
};
const armPendingStartupForceExitTimer = () => {
if (pendingStartupForceExitTimer) {
return;
}
pendingStartupForceExitTimer = setTimeout(() => {
pendingStartupForceExitTimer = null;
gatewayLog.error(
"startup restart request timed out before gateway returned a close handle; exiting for supervisor recovery",
);
void forceExitAfterStabilityBundle("gateway.restart_startup_request_timeout");
}, SHUTDOWN_TIMEOUT_MS);
pendingStartupForceExitTimer.unref?.();
};
const resolveRestartDrainTimeoutMs = (
restartIntent?: GatewayRestartIntent,
): number | undefined => {
if (restartIntent?.force) {
return 0;
}
if (typeof restartIntent?.waitMs === "number" && Number.isFinite(restartIntent.waitMs)) {
return restartIntent.waitMs > 0 ? Math.floor(restartIntent.waitMs) : undefined;
}
try {
return eagerLifecycleRuntime.resolveGatewayRestartDeferralTimeoutMs();
} catch {
return DEFAULT_RESTART_DRAIN_TIMEOUT_MS;
}
};
const markRestartDraining = (reason: GatewayDrainReason) => {
if (restartDrainingMarked) {
return;
}
// The lifecycle module is primed before listeners are installed. Keep this
// transition synchronous so an accepted signal cannot yield between token
// handling and closing process-wide root admission.
eagerLifecycleRuntime.markGatewayDraining(reason);
restartDrainingMarked = true;
};
const handleHostedStopAfterServerClose = async (
owner: ReturnType<typeof createGatewayHostLifecycle>,
shutdownFailure: ShutdownFailure | undefined,
) => {
if (hostLifecycle !== owner) {
return;
}
terminalHostedStop = owner;
try {
if (shutdownFailure) {
await forceExitAfterStabilityBundle("gateway.stop_close_failed", 1, shutdownFailure);
return;
}
// This continuation belongs to the run loop, not to the closed kernel or
// requesting lane. Native stop starts only after the existing joins.
const result = await owner.finishStop();
if (result.outcome === "retired" || hostLifecycle !== owner) {
return;
}
if (result.outcome !== "accepted" && result.outcome !== "exit") {
gatewayLog.error(`Scheduled Gateway stop failed: ${result.detail}`);
if (result.outcome === "refused") {
params.completeBoot?.({ outcome: "planned_restart", reason: "gateway.stop_refused" });
await releaseLockIfHeld();
if (hostLifecycle === owner) {
await reacquireAndResumeInProcessRestart();
}
} else {
await forceExitAfterStabilityBundle("gateway.stop_native_unconfirmed");
}
return;
}
gatewayLog.info(
result.outcome === "accepted"
? "Native service manager accepted Gateway stop"
: "Gateway host completed graceful stop",
);
params.completeBoot?.({ outcome: "clean_stop", reason: "stop (hosted Gateway stop)" });
await releaseLockIfHeld();
await exitProcessAfterLogFlush(0, undefined, "update", owner);
} catch (error) {
gatewayLog.error(`Scheduled Gateway stop failed: ${formatErrorMessage(error)}`);
if (hostLifecycle === owner) {
await forceExitAfterStabilityBundle("gateway.stop_native_unconfirmed", 1, {
step: "hosted-gateway-stop",
error,
});
}
} finally {
if (terminalHostedStop === owner) {
terminalHostedStop = undefined;
}
}
};
const runAcceptedRequest = (acceptedRequest: GatewayRunSignalRequest) => {
const { action, restartIntent } = acceptedRequest;
const isRestart = action !== "stop";
const acceptedStartupOperations = startupOperations;
if (acceptedRequest.action === "stop") {
// A queued restart still needs startup's close handle. Only an effective
// stop cancels preflight, including a stop overriding that queued restart.
acceptedStartupOperations.close();
}
if (action === "restart") {
activeRestartRequest = acceptedRequest;
} else if (!isRestart) {
startGatewayRestartTrace("stop.signal.received", [["signal", acceptedRequest.signal]]);
}
let forceExitTimer: ReturnType<typeof setTimeout> | null = null;
let hardExitWatchdog: ShutdownHardExitWatchdog | null = null;
let lastDrainCounts = "not observed";
let shutdownFailure: ShutdownFailure | undefined;
const armForceExitTimer = (forceExitMs: number) => {
if (forceExitTimer) {
return;
}
forceExitTimer = setTimeout(() => {
const cleanExit = nativeStopBudget && !shutdownFailure;
gatewayLog.warn(
`shutdown deadline reached; abandoning unfinished cleanup and active work before ${action}; last observed: ${lastDrainCounts}; exiting ${cleanExit ? "cleanly" : "with incomplete cleanup"}`,
);
void forceExitAfterStabilityBundle(
isRestart ? "gateway.restart_shutdown_timeout" : "gateway.stop_shutdown_timeout",
cleanExit ? 0 : 1,
shutdownFailure,
);
}, forceExitMs);
if (params.ownsProcessLifecycle === true) {
hardExitWatchdog = armShutdownHardExitWatchdog({
delayMs: forceExitMs + HARD_EXIT_WATCHDOG_GRACE_MS,
onError: (error) => {
gatewayLog.warn(
`hard-exit watchdog failed; retaining main-thread shutdown timer: ${formatErrorMessage(error)}`,
);
},
});
}
};
const clearForceExitTimer = () => {
clearTimeout(forceExitTimer ?? undefined);
forceExitTimer = null;
hardExitWatchdog?.cancel();
hardExitWatchdog = null;
};
if (action === "restart") {
forceActiveRestartExit = () => {
clearForceExitTimer();
if (!getManagedUpdateOwner()) {
armForceExitTimer(acceptedShutdownTimeoutMs);
}
};
}
const completion = (async () => {
let managedUpdateOwner: GatewayRestartIntent["successorOwner"];
let managedUpdateCancellation:
| false
| "restored-in-process"
| "restart-after-exit"
| undefined;
const requestedRestartDrainTimeoutMs = isRestart
? resolveRestartDrainTimeoutMs(restartIntent)
: 0;
const restartDrainTimeoutMs = nativeStopBudget
? Math.min(
requestedRestartDrainTimeoutMs ?? Infinity,
acceptedShutdownTimeoutMs - RESTART_CLOSE_REPLY_DRAIN_SHUTDOWN_RESERVE_MS,
)
: requestedRestartDrainTimeoutMs;
const restartDrainDeadlineAt =
isRestart && restartDrainTimeoutMs !== undefined
? Date.now() + restartDrainTimeoutMs
: undefined;
// Managed helpers must reach native parking before either exit watchdog can arm.
if (!isRestart) {
armForceExitTimer(acceptedShutdownTimeoutMs);
} else if (restartDrainTimeoutMs !== undefined && !getManagedUpdateOwner()) {
armForceExitTimer(
restartDrainTimeoutMs +
(nativeStopBudget
? RESTART_CLOSE_REPLY_DRAIN_SHUTDOWN_RESERVE_MS
: SHUTDOWN_TIMEOUT_MS),
);
}
const drainTimeoutMs = isRestart
? restartDrainTimeoutMs
: Math.max(0, acceptedShutdownTimeoutMs - RESTART_CLOSE_REPLY_DRAIN_SHUTDOWN_RESERVE_MS);
const drainBudget =
drainTimeoutMs === undefined ? "without a timeout" : `with timeout ${drainTimeoutMs}ms`;
let lastPendingWarningAt: number | undefined;
const reportDrainSnapshot = (snapshot: GatewayActiveWorkSnapshot) => {
lastDrainCounts = formatDrainCounts(snapshot) || "no active work";
const now = Date.now();
if (lastPendingWarningAt === undefined) {
lastPendingWarningAt = now;
if (!snapshot.idle) {
gatewayLog.info(
`draining active work before ${action} ${drainBudget}: ${formatDrainCounts(snapshot)}`,
);
const requestTimeoutMs = Math.max(
0,
...eagerLifecycleRuntime
.listActiveEmbeddedRunSessionIds()
.map(
(sessionId) =>
eagerLifecycleRuntime.getDiagnosticSessionActivitySnapshot({ sessionId })
?.activeModelCallRequestTimeoutMs ?? 0,
),
);
if (requestTimeoutMs > 0) {
gatewayLog.info(
`largest observed model request timeout is ${requestTimeoutMs}ms; shutdown drain budget remains ${drainBudget}`,
);
}
}
} else if (
!snapshot.idle &&
now - lastPendingWarningAt >= RESTART_DRAIN_STILL_PENDING_WARN_MS
) {
lastPendingWarningAt = now;
gatewayLog.warn(
`still draining active work before ${action}: ${formatDrainCounts(snapshot)}`,
);
}
};
let shutdownStep = "restart-failure-recovery";
try {
// A stop/restart cancels triage at admission and joins its existing cleanup
// before process exit can strand an external fixing agent.
if (failureWork) {
await failureWork.settled;
}
shutdownStep = "active-work-drain";
// On restart, wait for the canonical process activity inventory before
// tearing down the server so active work can settle.
if (isRestart) {
let activeWorkAtDrainStart = 0;
let activeRunsAtDrainStart = 0;
let drainTimedOut = false;
await measureGatewayRestartTrace(
"restart.drain",
async () => {
const {
abortEmbeddedAgentRun,
createGatewayActiveWorkSnapshot,
waitForGatewayActiveWork,
} = await loadGatewayLifecycleRuntimeModule();
// Reject new enqueues immediately during the drain window so
// sessions get an explicit restart error instead of silent task loss.
markRestartDraining(formatShutdownReason(acceptedRequest));
const initialSnapshot = createGatewayActiveWorkSnapshot();
activeWorkAtDrainStart = initialSnapshot.counts.totalActive;
activeRunsAtDrainStart = initialSnapshot.counts.embeddedRuns;
if (activeRunsAtDrainStart > 0) {
abortEmbeddedAgentRun(undefined, { mode: "compacting", reason: "restart" });
}
reportDrainSnapshot(initialSnapshot);
if (restartIntent?.force) {
gatewayLog.warn("forced restart requested; skipping active work drain");
return;
}
const remainingDrainTimeoutMs =
restartDrainDeadlineAt === undefined
? undefined
: Math.max(0, restartDrainDeadlineAt - Date.now());
const drain = await waitForGatewayActiveWork(remainingDrainTimeoutMs, {
onSnapshot: reportDrainSnapshot,
});
if (drain.drained) {
if (!initialSnapshot.idle) {
gatewayLog.info("all active work drained");
}
return;
}
drainTimedOut = true;
eagerLifecycleRuntime.abortActiveCronTaskRuns("Gateway restarting.");
gatewayLog.warn(
`active-work drain timeout reached; proceeding with restart: ${formatDrainCounts(drain.snapshot)}`,
);
},
() => [
["activeWork", activeWorkAtDrainStart],
["activeRuns", activeRunsAtDrainStart],
["timedOut", drainTimedOut],
["force", restartIntent?.force === true],
],
);
} else {
// Keep all process-owned work alive without spending the shutdown reserve
// that server teardown and the supervisor watchdog need.
try {
markGatewayRestartTrace("stop.drain.begin");
const activeWorkDrain = await measureGatewayRestartTrace("stop.drain", () =>
eagerLifecycleRuntime.waitForGatewayActiveWork(drainTimeoutMs, {
onSnapshot: reportDrainSnapshot,
}),
);
if (!activeWorkDrain.drained) {
gatewayLog.warn(
`gateway active-work drain timeout reached; proceeding with shutdown: ${formatDrainCounts(activeWorkDrain.snapshot)}`,
);
eagerLifecycleRuntime.abortEmbeddedAgentRun(undefined, { mode: "all" });
eagerLifecycleRuntime.abortActiveCronTaskRuns("Gateway stopping.");
}
} catch (err) {
gatewayLog.warn(
`gateway active-work drain failed; proceeding with shutdown: ${formatErrorMessage(err)}`,
);
}
gatewayLog.info("active-work drain settled; beginning server close");
}
if (isRestart && activeRestartRequest?.restartIntent?.successorOwner) {
const owner = activeRestartRequest.restartIntent.successorOwner;
managedUpdateOwner = owner;
try {
if (
!sameManagedUpdateOwner(getManagedUpdateOwner(), owner) ||
!(await eagerLifecycleRuntime.requestManagedServiceUpdateHandoffPark(owner)) ||
!sameManagedUpdateOwner(getManagedUpdateOwner(), owner) ||
!eagerLifecycleRuntime.claimManagedServiceUpdateHandoff(owner)
) {
throw new Error("managed update helper lost exact ownership during service parking");
}
} catch (err) {
clearForceExitTimer();
gatewayLog.error(
`managed update handoff could not park ${supervisorMode}: ${String(err)}`,
);
await markRestartHandoffUnavailable();
managedUpdateCancellation = await cancelManagedUpdateHandoffBeforeRecovery(owner);
if (!managedUpdateCancellation) {
return;
}
if (managedUpdateCancellation === "restart-after-exit") {
await releaseLockIfHeld();
await exitProcessAfterLogFlush(0, owner, "restore");
return;
}
}
}
if (isRestart && !forceExitTimer) {
armForceExitTimer(
nativeStopBudget
? Math.max(0, (restartDrainDeadlineAt ?? Date.now()) - Date.now()) +
RESTART_CLOSE_REPLY_DRAIN_SHUTDOWN_RESERVE_MS
: SHUTDOWN_TIMEOUT_MS,
);
}
const closeDrainTimeoutMs = !isRestart
? null
: restartDrainTimeoutMs === undefined
? SHUTDOWN_TIMEOUT_MS - RESTART_CLOSE_REPLY_DRAIN_SHUTDOWN_RESERVE_MS
: Math.max(0, (restartDrainDeadlineAt ?? Date.now()) - Date.now());
if (acceptedRequest.action === "stop") {
shutdownStep = "startup-operations";
await acceptedStartupOperations.drain();
}
shutdownStep = "gateway-server-close";
await server?.close({
reason: isRestart ? "gateway restarting" : "gateway stopping",
restartExpectedMs: isRestart ? 1500 : null,
...(closeDrainTimeoutMs !== null ? { drainTimeoutMs: closeDrainTimeoutMs } : {}),
});
} catch (err) {
shutdownFailure = { step: shutdownStep, error: err };
gatewayLog.error(
`shutdown step failed (${shutdownStep.replaceAll("-", " ")}): ${formatErrorMessage(err)}`,
);
} finally {
const handoffClosed =
managedUpdateCancellation !== false && managedUpdateCancellation !== "restart-after-exit";
if (handoffClosed) {
server = null;
}
if (action === "restart") {
try {
await hostLifecycle?.retire();
if (shutdownFailure) {
await forceExitAfterStabilityBundle(
"gateway.restart_close_failed",
1,
shutdownFailure,
);
} else if (handoffClosed) {
await handleRestartAfterServerClose(
managedUpdateOwner,
managedUpdateCancellation === "restored-in-process",
);
}
} finally {
clearForceExitTimer();
forceActiveRestartExit = null;
}
} else if (acceptedRequest.hostedStop) {
try {
await handleHostedStopAfterServerClose(acceptedRequest.hostedStop, shutdownFailure);
} finally {
clearForceExitTimer();
}
} else {
await hostLifecycle?.retire();
if (isRestart && shutdownFailure) {
await forceExitAfterStabilityBundle("gateway.restart_close_failed", 1, shutdownFailure);
} else {
if (shutdownFailure) {
writeStabilityBundle(
"gateway.stop_close_failed",
shutdownFailure.error,
shutdownFailure.step,
);
}
params.completeBoot?.(
isRestart
? {
outcome: "planned_restart",
reason: formatShutdownReason(acceptedRequest),
}
: {
outcome: shutdownFailure ? "forced_stop" : "clean_stop",
reason: shutdownFailure
? "gateway.stop_close_failed"
: formatShutdownReason(acceptedRequest),
},
);
await releaseLockIfHeld();
await exitProcessAfterLogFlush(shutdownFailure ? 1 : 0);
}
clearForceExitTimer();
}
}
})();
if (acceptedRequest.action === "stop") {
acceptedStartupOperations.stopCompletion = completion;
}
// Startup can still be awaiting unrelated work; observe shutdown immediately
// while retaining its rejecting promise for the cancelled startup's join.
void completion.catch((error: unknown) => {
gatewayLog.error(`gateway lifecycle completion failed: ${formatErrorMessage(error)}`);
});
};
const flushPendingStartupRequest = (opts: { allowMissingServer?: boolean } = {}) => {
if (!pendingStartupRequest || !restartResolver) {
return;
}
if (!server && opts.allowMissingServer !== true) {
return;
}
const request = pendingStartupRequest;
pendingStartupRequest = null;
clearPendingStartupForceExitTimer();
startupFailedWithoutServerHandle = false;
runAcceptedRequest(request);
};
const request = (
action: GatewayRunSignalAction,
signal: GatewayRunSignalRequest["signal"],
restartReason?: string,
restartIntent?: GatewayRestartIntent,
hostedStop?: ReturnType<typeof createGatewayHostLifecycle>,
) => {
const acceptedRequest: GatewayRunSignalRequest = {
action,
signal,
restartReason,
restartIntent,
hostedStop,
};
failureWork?.controller.abort();
if (shuttingDown) {
const currentRestartRequest = pendingStartupRequest ?? activeRestartRequest;
if (
action === "restart" &&
isUpdateProcessRestartReason(restartReason) &&
currentRestartRequest?.action === "restart" &&
(!isUpdateProcessRestartReason(currentRestartRequest.restartReason) ||
(restartIntent?.successorOwner &&
!sameManagedUpdateOwner(
restartIntent.successorOwner,
currentRestartRequest.restartIntent?.successorOwner,
)))
) {
const upgradedRequest = {
...currentRestartRequest,
signal,
restartReason,
restartIntent: {
...currentRestartRequest.restartIntent,
...restartIntent,
force: true,
reason: restartReason,
},
};
if (pendingStartupRequest) {
pendingStartupRequest = upgradedRequest;
} else {
activeRestartRequest = upgradedRequest;
forceActiveRestartExit?.();
}
gatewayLog.info(`received ${signal} during shutdown; upgrading to ${restartReason}`);
return;
}
if (action === "stop" && pendingStartupRequest && !server) {
gatewayLog.info(`received ${signal}; overriding pending startup restart with shutdown`);
pendingStartupRequest = null;
clearPendingStartupForceExitTimer();
startupFailedWithoutServerHandle = false;
runAcceptedRequest(acceptedRequest);
return;
}
gatewayLog.info(`received ${signal} during shutdown; ignoring`);
return;
}
if (action === "stop" && signal === "SIGTERM") {
// Transfer the exact one-shot authority before host retirement and the
// one-way fence discard it; neither operation may precede consumption.
const handoff = consumeGatewaySuspendHandoff(hostLifecycle?.capability.externalRestart);
if (!handoff.ok) {
gatewayLog.warn(`external restart handoff refused: ${handoff.error}`);
} else if (handoff.value) {
acceptedRequest.action = "external-restart";
acceptedRequest.restartIntent = { force: true };
}
}
const isRestart = acceptedRequest.action !== "stop";
if (hostLifecycle !== hostedStop) {
void hostLifecycle?.retire();
}
// Fence new roots synchronously for stops as well as restarts so admitted
// detached finalizers can drain before the signal tears down the gateway.
markRestartDraining(formatShutdownReason(acceptedRequest));
shuttingDown = true;
gatewayLog.info(`received ${signal}; ${isRestart ? "restarting" : "shutting down"}`);
if (isRestart) {
startGatewayRestartTrace("restart.signal.received", [
["signal", signal],
["reason", restartReason ?? signal],
["force", acceptedRequest.restartIntent?.force === true],
["waitMs", restartIntent?.waitMs ?? "default"],
]);
}
if (action === "stop") {
runAcceptedRequest(acceptedRequest);
return;
}
if (!server && restartResolver && startupFailedWithoutServerHandle) {
startupFailedWithoutServerHandle = false;
runAcceptedRequest(acceptedRequest);
return;
}
if (!server || !restartResolver) {
pendingStartupRequest = acceptedRequest;
armPendingStartupForceExitTimer();
return;
}
runAcceptedRequest(acceptedRequest);
};
const onSigterm = () => {
observeSignal("SIGTERM");
// Debug-level: every accepted signal is announced by request()'s
// "received <signal>; ..." line, so an info pre-log would double up.
gatewayLog.debug("signal SIGTERM received");
if (terminalHostedStop && terminalHostedStop === hostLifecycle) {
// Kernel cleanup is already joined. A native stop signal belongs to this
// terminal continuation, not to restart-intent storage in the closed kernel.
terminalHostedStop.notifyStopSignal();
return;
}
void (async () => {
const { consumeGatewayRestartIntentPayloadSync } = await loadGatewayLifecycleRuntimeModule();
const restartIntent = consumeGatewayRestartIntentPayloadSync();
// SIGTERM hands replacement to the caller (e.g. systemctl restart).
// Drain as a restart, then exit even when in-process respawn is configured.
request(
restartIntent ? "external-restart" : "stop",
"SIGTERM",
restartIntent?.reason,
restartIntent ?? undefined,
);
})().catch((err: unknown) => {
gatewayLog.error(`failed to handle SIGTERM: ${String(err)}`);
request("stop", "SIGTERM");
});
};
const onSigint = () => {
observeSignal("SIGINT");
gatewayLog.debug("signal SIGINT received");
request("stop", "SIGINT");
};
const onSigusr1 = () => {
observeSignal("SIGUSR1");
gatewayLog.debug("signal SIGUSR1 received");
void (async () => {
const {
abortPendingChannelReloads,
consumeGatewayRestartIntentPayloadSync,
consumeGatewaySigusr1RestartIntent,
consumeGatewaySigusr1RestartAuthorization,
isGatewaySigusr1RestartExternallyAllowed,
markGatewaySigusr1RestartHandled,
peekGatewaySigusr1RestartReason,
scheduleGatewaySigusr1Restart,
} = await loadGatewayLifecycleRuntimeModule();
const restartIntent = consumeGatewayRestartIntentPayloadSync();
if (restartIntent) {
abortPendingChannelReloads();
const authorized = consumeGatewaySigusr1RestartAuthorization();
const processLocalIntent = authorized ? consumeGatewaySigusr1RestartIntent() : null;
if (processLocalIntent?.successorOwner) {
Object.assign(restartIntent, processLocalIntent);
}
markRestartDraining(
formatShutdownReason({
action: "restart",
signal: "SIGUSR1",
restartReason: restartIntent.reason ?? "gateway.restart",
}),
);
if (authorized) {
markGatewaySigusr1RestartHandled();
}
request("restart", "SIGUSR1", restartIntent.reason ?? "gateway.restart", restartIntent);
return;
}
const authorized = consumeGatewaySigusr1RestartAuthorization();
if (!authorized) {
markGatewaySigusr1RestartHandled();
if (!isGatewaySigusr1RestartExternallyAllowed()) {
gatewayLog.warn("SIGUSR1 restart ignored (not authorized; commands.restart=false).");
gatewayLog.warn(
"An unauthorized SIGUSR1 restart signal was received and ignored. " +
"If a pending gateway restart needs to be applied, run `openclaw gateway restart` " +
"or restart the gateway through your service manager.",
);
return;
}
if (shuttingDown) {
gatewayLog.info("received SIGUSR1 during shutdown; ignoring");
return;
}
// External SIGUSR1 requests should still reuse the in-process restart
// scheduler so idle drain and restart coalescing stay consistent.
abortPendingChannelReloads();
scheduleGatewaySigusr1Restart({ delayMs: 0, reason: "SIGUSR1" });
return;
}
abortPendingChannelReloads();
const sigusr1RestartIntent = consumeGatewaySigusr1RestartIntent();
const restartReason = peekGatewaySigusr1RestartReason();
markRestartDraining(
formatShutdownReason({
action: "restart",
signal: "SIGUSR1",
restartReason: sigusr1RestartIntent?.reason ?? restartReason,
}),
);
markGatewaySigusr1RestartHandled();
request(
"restart",
"SIGUSR1",
sigusr1RestartIntent?.reason ?? restartReason,
sigusr1RestartIntent ?? undefined,
);
})().catch((err: unknown) => {
// Defense in depth: if anything in the listener body rejects, the
// SIGUSR1 emit has already advanced emittedRestartToken but no one
// called markGatewaySigusr1RestartHandled. Without unsticking the
// token here, every subsequent scheduleGatewaySigusr1Restart() would
// silently coalesce into the dead in-flight signal and the gateway
// would never restart again until manually kickstarted.
gatewayLog.error(`SIGUSR1 handler failed: ${formatErrorMessage(err)}`);
try {
eagerLifecycleRuntime.markGatewaySigusr1RestartHandled();
} catch {
// Best-effort: the eager reference itself is the recovery path.
}
try {
eagerLifecycleRuntime.rollbackGatewayRestartSignalAdmission();
// A later signal must repeat the synchronous close transition even if
// this handler failed after marking the one-way drain.
restartDrainingMarked = false;
} catch {
// Keep admission recovery independent from restart-token recovery.
}
});
};
process.on("SIGTERM", onSigterm);
process.on("SIGINT", onSigint);
process.on("SIGUSR1", onSigusr1);
try {
const onRestart = async () => {
// After an in-process restart (SIGUSR1), reset command-queue lane state.
// Interrupted tasks from the previous lifecycle may have left `active`
// counts elevated (their finally blocks never ran), permanently blocking
// new work from draining. The same boundary also discards stale restart
// deferral timers and reloads the task registry from durable state so
// cancelled/completed work is not kept alive by old in-memory maps.
const {
abortActiveCronTaskRuns,
advanceCronActiveJobGeneration,
reloadTaskRuntimeStateFromStore,
retireActiveCronTaskRunTracking,
resetCronActiveJobs,
resetAllLanes,
resetGatewayRestartStateForInProcessRestart,
resetGatewaySuspendCoordinatorForLifecycleRestart,
rotateAgentEventLifecycleGeneration,
waitForActiveCronJobs,
waitForActiveCronTaskRuns,
} = await loadGatewayLifecycleRuntimeModule();
// Rotation aborts rootless stale owners before reset pumps preserved queues.
rotateAgentEventLifecycleGeneration();
advanceCronActiveJobGeneration();
abortActiveCronTaskRuns("Gateway restarting.");
const cronTaskDrain = await waitForActiveCronTaskRuns(1_000);
const cronDrain = await waitForActiveCronJobs(1_000);
if (!cronTaskDrain.drained || !cronDrain.drained) {
gatewayLog.warn(
`cron run drain timed out during restart lifecycle reset after retiring old cron admission; ${cronTaskDrain.active} task handle(s) and ${cronDrain.active} active marker(s) remain after aborting old cron runs`,
);
}
retireActiveCronTaskRunTracking();
resetCronActiveJobs();
// Resume the retired scheduler before resetAllLanes invalidates its
// suspension admission callback and discards the coordinator entry.
resetGatewaySuspendCoordinatorForLifecycleRestart();
resetAllLanes();
// resetAllLanes installs the next admission generation. Keep the local
// mirror aligned so a restart queued during cleanup closes that generation.
restartDrainingMarked = false;
clearRuntimeConfigSnapshot();
resetGatewayRestartStateForInProcessRestart();
// Rent: a failed startup has no server close handle, and restart hooks can
// recreate shared slots after close. Reset the same lifecycle before boot.
try {
await drainGlobalSingletonLifecycleState("restart");
} catch (error) {
gatewayLog.warn(`failed to reset ambient runtime state: ${formatErrorMessage(error)}`);
}
reloadTaskRuntimeStateFromStore();
markGatewayRestartTrace("restart.next-start");
};
// Keep process alive; SIGUSR1 triggers an in-process restart (no supervisor required).
// SIGTERM/SIGINT still exit after a graceful shutdown.
let isFirstIteration = true;
for (;;) {
const iterationStartupOperations = isFirstIteration
? startupOperations
: createGatewayStartupOperations();
startupOperations = iterationStartupOperations;
await hostLifecycle?.retire();
const iterationHost = createGatewayHostLifecycle({
processOwner: {
ownsProcessLifecycle: params.ownsProcessLifecycle === true,
supervisor: supervisorMode,
},
isCurrent: () => hostLifecycle === iterationHost,
isServing: () => server !== null && restartResolver !== null && !shuttingDown,
acceptStop: () =>
runOutsideGatewayRootWorkAdmission(() =>
request("stop", "hosted Gateway stop", undefined, undefined, iterationHost),
),
});
hostLifecycle = iterationHost;
let startupFailedBeforeServerHandle = false;
const isRestartIteration = !isFirstIteration;
isFirstIteration = false;
try {
if (isRestartIteration) {
await onRestart();
}
startupStartedAt = Date.now();
await params.beginBoot?.(startupStartedAt);
const startedServer = await params.start({
...(isRestartIteration ? {} : { processStartedAt }),
startupStartedAt,
requestHotReloadRecovery: eagerLifecycleRuntime.requestGatewayRestartWithSignalAdmission,
hostLifecycle: iterationHost.capability,
startupOperation: iterationStartupOperations.run,
});
iterationStartupOperations.close();
server = startedServer;
startupFailedWithoutServerHandle = false;
await new Promise<void>((resolve, reject) => {
restartResolver = () => {
restartResolver = null;
resolve();
};
void startedServer.startupSettled.then(undefined, reject);
flushPendingStartupRequest();
});
} catch (err) {
iterationStartupOperations.close();
if (
iterationStartupOperations.stopCompletion &&
(iterationStartupOperations.cancelledWith(err) ||
iterationStartupOperations.failedWith(err))
) {
await iterationStartupOperations.stopCompletion;
if (iterationStartupOperations.cancelledWith(err)) {
return;
}
throw err;
}
await iterationHost.retire();
const failedServer = server;
server = null;
const maintenanceRequired = findStartupMaintenanceRequiredError(err);
params.completeBoot?.({
outcome: "startup_failed",
reason: truncateUtf16Safe(
formatErrorMessage(err),
GATEWAY_BOOT_REASON_MAX_UTF16_CODE_UNITS,
),
...(maintenanceRequired ? { startupReason: maintenanceRequired.code } : {}),
});
try {
await failedServer?.close({ reason: "gateway startup failed" });
} catch (closeError) {
throw new GatewayStartupCleanupError(err, closeError);
}
// Keep TCC recovery after clean restart failures (#35862), but never reuse a
// generation whose startup cleanup failed. The outer CLI exits nonzero.
if (
maintenanceRequired ||
!isRestartIteration ||
err instanceof GatewayStartupCleanupError
) {
throw err;
}
startupFailedWithoutServerHandle = true;
startupFailedBeforeServerHandle = true;
if (!pendingStartupRequest) {
// Release the gateway lock so that `daemon restart/stop` (which
// discovers PIDs via the gateway port) can still manage the process.
// Without this, the process holds the lock but is not listening,
// forcing manual cleanup. (#35862)
await releaseLockIfHeld();
}
const errMsg = formatErrorMessage(err);
const errStack = err instanceof Error && err.stack ? `\n${err.stack}` : "";
writeStabilityBundle("gateway.restart_startup_failed", err);
gatewayLog.error(
`gateway startup failed: ${errMsg}. ` +
`Process will stay alive; fix the issue and restart.${errStack}`,
);
const onRestartStartupFailure = params.onRestartStartupFailure;
if (!shuttingDown && onRestartStartupFailure) {
const controller = new AbortController();
failureWork = {
controller,
settled: Promise.resolve().then(() => onRestartStartupFailure(err, controller.signal)),
};
try {
await failureWork.settled;
} finally {
failureWork = undefined;
}
}
}
if (startupFailedBeforeServerHandle) {
await new Promise<void>((resolve) => {
restartResolver = () => {
restartResolver = null;
resolve();
};
flushPendingStartupRequest({ allowMissingServer: true });
});
}
}
} finally {
await hostLifecycle?.retire();
await releaseLockIfHeld();
cleanupSignals();
}
}
/* oxlint-disable max-lines -- TODO: split this grandfathered oversized file. */
|