Files
oh-my-opencode/src/features/background-agent/process-cleanup.ts
T
YeonGyu-Kim 0e49767a3e Merge pull request #4026 from dihak/fix/graceful-shutdown-exit
fix(process-cleanup): call process.exit() after SIGTERM cleanup
2026-05-21 00:43:32 +09:00

228 lines
7.7 KiB
TypeScript

import { log } from "../../shared"
type ProcessCleanupSignal = NodeJS.Signals | "beforeExit" | "exit"
type ProcessCleanupErrorEvent = "uncaughtException" | "unhandledRejection"
/**
* When set to a truthy value (1/true/yes/on), skips registering the global
* uncaughtException / unhandledRejection log listeners entirely.
*
* The listeners are log-only by default and no longer force-exit the host
* (originally a fix for issue #3856 that previously turned every transient
* streaming rejection into a `process.exit(1)`; reverified during the ulw
* `/init-deep` hang investigation that motivated the log-only rewrite).
* Setting this env var still makes the plugin silent on those events; leave
* it unset whenever you want the diagnostic line and the `name/message/stack`
* payload from `describeProcessCleanupError`.
*
* Signal handlers (SIGINT/SIGTERM/SIGBREAK/beforeExit/exit) remain registered
* because they are the real shutdown path and run `cleanupAll()` before the
* host actually terminates.
*/
const PROCESS_CLEANUP_DISABLE_ENV = "OMO_DISABLE_PROCESS_CLEANUP"
const TRUTHY_ENV_VALUES = new Set(["1", "true", "yes", "on"])
function isProcessCleanupErrorHandlersDisabled(): boolean {
const raw = process.env[PROCESS_CLEANUP_DISABLE_ENV]
if (!raw) return false
return TRUTHY_ENV_VALUES.has(raw.trim().toLowerCase())
}
/** @internal test-only seam: prevents process.exitCode from contaminating bun test runner */
let _scheduleForcedExitEnabled = true
/** @internal test-only */
export function __disableScheduledForcedExitForTesting(): void {
_scheduleForcedExitEnabled = false
}
/** @internal test-only */
export function __enableScheduledForcedExitForTesting(): void {
_scheduleForcedExitEnabled = true
}
function scheduleForcedExit(
cleanupResult: void | Promise<void>,
exitCode: number,
exitAfterCleanup = false,
): void {
if (!_scheduleForcedExitEnabled) return
process.exitCode = exitCode
const exitTimeout = setTimeout(() => process.exit(), 6000)
void Promise.resolve(cleanupResult).finally(() => {
clearTimeout(exitTimeout)
if (exitAfterCleanup) {
process.exit(exitCode)
}
})
}
function registerProcessSignal(
signal: ProcessCleanupSignal,
handler: () => void | Promise<void>,
exitAfter: boolean
): () => void {
const listener = () => {
const cleanupResult = handler()
if (exitAfter) {
scheduleForcedExit(cleanupResult, 0, true)
}
}
process.on(signal, listener)
return listener
}
/** @internal test-only seam: exposes the error normalizer used by registerErrorEvent. */
export function describeProcessCleanupError(error: unknown): Record<string, unknown> {
if (error instanceof Error) {
return {
name: error.name,
message: error.message,
stack: error.stack,
}
}
if (typeof error === "object" && error !== null) {
try {
const json = JSON.stringify(error)
if (json !== "{}") return { raw: json }
} catch {
}
return { raw: String(error) }
}
return { raw: String(error) }
}
function registerErrorEvent(
signal: ProcessCleanupErrorEvent,
): (error: unknown) => void {
// Log-only listener. We deliberately DO NOT run cleanup or force-exit on
// transient errors.
//
// History: earlier this listener invoked `scheduleForcedExit(handler(error),
// 1, true)` so every unhandled promise rejection ran the registered cleanup
// (BackgroundManager shutdown, tmux pane closure, team-mode teardown) and
// then `process.exit(1)`'d the host. With OpenCode bundled under Bun, our
// listener already suppresses the default crash behavior, so the host was
// surviving the error itself but we were tearing it down ourselves. During
// heavy slash commands like `/init-deep` running in ulw mode that turned a
// single transient streaming error (e.g. a mid-stream socket reset or
// `session.processor` Aborted-process condition) into a frozen TUI for the
// user.
//
// The signal handlers (SIGINT / SIGTERM / SIGBREAK / beforeExit / exit)
// still cover real shutdown paths and run `cleanupAll()` before process
// termination. `exit` in particular fires for every controlled exit
// regardless of cause, so cleanup is not skipped when the host genuinely
// dies.
//
// We still detach the listener before logging so a re-emit from inside
// `log()` (e.g. EPIPE while writing to a broken pipe during shutdown)
// cannot recurse and produce the 100+ GB log explosion that #3856-era
// regressions caused.
const listener = (error: unknown) => {
process.off(signal, listener)
log(
`[background-agent] ${signal} observed; keeping host alive and skipping cleanup (signal handlers run on real shutdown)`,
describeProcessCleanupError(error),
)
}
process.on(signal, listener)
return listener
}
interface CleanupTarget {
shutdown(): void | Promise<void>
}
const cleanupManagers = new Set<CleanupTarget>()
let cleanupRegistered = false
const cleanupSignalHandlers = new Map<ProcessCleanupSignal, () => void>()
const cleanupErrorHandlers = new Map<ProcessCleanupErrorEvent, (error: unknown) => void>()
export function registerManagerForCleanup(manager: CleanupTarget): void {
cleanupManagers.add(manager)
if (cleanupRegistered) return
cleanupRegistered = true
let cleanupPromise: Promise<void> | undefined
const cleanupAll = (): Promise<void> => {
if (cleanupPromise) return cleanupPromise
const promises: Promise<void>[] = []
for (const m of cleanupManagers) {
try {
promises.push(
Promise.resolve(m.shutdown()).catch((error) => {
log("[background-agent] Error during async shutdown cleanup:", error)
})
)
} catch (error) {
log("[background-agent] Error during shutdown cleanup:", error)
}
}
cleanupPromise = Promise.allSettled(promises).then(() => {})
cleanupPromise.then(() => {
log("[background-agent] All shutdown cleanup completed")
})
return cleanupPromise
}
const registerSignal = (signal: ProcessCleanupSignal, exitAfter: boolean): void => {
const listener = registerProcessSignal(signal, cleanupAll, exitAfter)
cleanupSignalHandlers.set(signal, listener)
}
registerSignal("SIGINT", true)
registerSignal("SIGTERM", true)
if (process.platform === "win32") {
registerSignal("SIGBREAK", true)
}
registerSignal("beforeExit", false)
registerSignal("exit", false)
if (isProcessCleanupErrorHandlersDisabled()) {
log(
`[background-agent] ${PROCESS_CLEANUP_DISABLE_ENV} is set; skipping global uncaughtException/unhandledRejection handler registration. `
+ "Signal handlers (SIGINT/SIGTERM/beforeExit/exit) remain active.",
)
return
}
cleanupErrorHandlers.set("uncaughtException", registerErrorEvent("uncaughtException"))
cleanupErrorHandlers.set("unhandledRejection", registerErrorEvent("unhandledRejection"))
}
export function unregisterManagerForCleanup(manager: CleanupTarget): void {
cleanupManagers.delete(manager)
if (cleanupManagers.size > 0) return
for (const [signal, listener] of cleanupSignalHandlers.entries()) {
process.off(signal, listener)
}
for (const [signal, listener] of cleanupErrorHandlers.entries()) {
process.off(signal, listener)
}
cleanupSignalHandlers.clear()
cleanupErrorHandlers.clear()
cleanupRegistered = false
}
/** @internal - test-only reset for module-level singleton state */
export function _resetForTesting(): void {
for (const manager of [...cleanupManagers]) {
cleanupManagers.delete(manager)
}
for (const [signal, listener] of cleanupSignalHandlers.entries()) {
process.off(signal, listener)
}
for (const [signal, listener] of cleanupErrorHandlers.entries()) {
process.off(signal, listener)
}
cleanupSignalHandlers.clear()
cleanupErrorHandlers.clear()
cleanupRegistered = false
}