fix(subprocess): clean managed processes on host exit
This commit is contained in:
169
packages/subprocess/subprocess-local/tests/process-exit.spec.ts
Normal file
169
packages/subprocess/subprocess-local/tests/process-exit.spec.ts
Normal file
@@ -0,0 +1,169 @@
|
||||
import { mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'
|
||||
import { tmpdir } from 'node:os'
|
||||
import { join } from 'node:path'
|
||||
import { fileURLToPath } from 'node:url'
|
||||
import { execa } from 'execa'
|
||||
import { describe, expect, it, vi } from 'vitest'
|
||||
import { resolveExampleLaunch } from '@deepseek-ai/dsh-loader-smoke'
|
||||
import { createProcessInspector } from '../src/process-inspector.ts'
|
||||
import type { ProcessIdentity, ProcessInspector } from '../src/process-inspector.ts'
|
||||
import { taskkillProcessTree } from '../src/spawn.ts'
|
||||
|
||||
type ExitTrigger = 'direct' | 'uncaught-exception' | 'unhandled-rejection' | 'dispose'
|
||||
type ManagedKind = 'ordinary' | 'terminal'
|
||||
interface TreeState { root: number; descendant: number }
|
||||
|
||||
const repoRoot = fileURLToPath(new URL('../../../../', import.meta.url))
|
||||
const hostScript = fileURLToPath(new URL('./fixtures/process-exit-host.ts', import.meta.url))
|
||||
const scenarioTimeoutMs = 30_000
|
||||
|
||||
function processExists(pid: number): boolean {
|
||||
try {
|
||||
process.kill(pid, 0)
|
||||
return true
|
||||
} catch (error: unknown) {
|
||||
if ((error as NodeJS.ErrnoException).code === 'ESRCH') return false
|
||||
throw error
|
||||
}
|
||||
}
|
||||
|
||||
async function readTree(path: string): Promise<TreeState> {
|
||||
return vi.waitFor(async () => {
|
||||
const text = await readFile(path, 'utf8')
|
||||
const state = JSON.parse(text) as Partial<TreeState>
|
||||
if (!Number.isSafeInteger(state.root) || !Number.isSafeInteger(state.descendant)
|
||||
|| (state.root ?? 0) <= 0 || (state.descendant ?? 0) <= 0 || state.root === state.descendant) {
|
||||
throw new Error(`invalid managed-tree state: ${text}`)
|
||||
}
|
||||
return state as TreeState
|
||||
}, { interval: 10, timeout: scenarioTimeoutMs })
|
||||
}
|
||||
|
||||
async function captureIdentities(inspector: ProcessInspector, state: TreeState): Promise<ProcessIdentity[]> {
|
||||
return vi.waitFor(() => {
|
||||
const expected = new Set([state.root, state.descendant])
|
||||
const identities = inspector.processTree(state.root).filter(identity => expected.has(identity.pid))
|
||||
if (identities.length !== expected.size) throw new Error('managed tree is not fully observable yet')
|
||||
return identities
|
||||
}, { interval: 10, timeout: scenarioTimeoutMs })
|
||||
}
|
||||
|
||||
async function waitForGone(state: TreeState): Promise<void> {
|
||||
await Promise.all([state.root, state.descendant].map(pid => vi.waitFor(() => {
|
||||
if (processExists(pid)) throw new Error(`managed pid ${pid} is still alive`)
|
||||
}, { interval: 25, timeout: 10_000 })))
|
||||
}
|
||||
|
||||
function cleanupTree(state: TreeState | undefined, identities: ProcessIdentity[]): void {
|
||||
if (state === undefined) return
|
||||
if (process.platform === 'win32') {
|
||||
taskkillProcessTree(state.root)
|
||||
for (const pid of [state.descendant, state.root]) {
|
||||
try {
|
||||
process.kill(pid, 'SIGKILL')
|
||||
} catch (_alreadyGone) {
|
||||
// The exact recorded process already exited.
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
const inspector = createProcessInspector()
|
||||
for (const identity of identities) {
|
||||
try {
|
||||
inspector.signalProcess(identity, 'SIGKILL')
|
||||
} catch (_alreadyGone) {
|
||||
// Exact start identity prevents PID-reuse cleanup from reaching another process.
|
||||
}
|
||||
}
|
||||
if (identities.length === 0) {
|
||||
for (const pid of [state.descendant, state.root]) {
|
||||
try {
|
||||
process.kill(pid, 'SIGKILL')
|
||||
} catch (_alreadyGone) {
|
||||
// The scenario failed before process identities became observable.
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function runScenario(kind: ManagedKind, trigger: ExitTrigger) {
|
||||
const root = await mkdtemp(join(tmpdir(), `dsh-subprocess-host-exit-${kind}-${trigger}-`))
|
||||
const launch = resolveExampleLaunch({
|
||||
srcBin: hostScript,
|
||||
mode: 'src',
|
||||
tsconfigPath: join(repoRoot, 'tsconfig.json'),
|
||||
configArgs: [kind, trigger, root],
|
||||
})
|
||||
const child = execa(launch.command, launch.args, {
|
||||
cwd: repoRoot,
|
||||
env: launch.env,
|
||||
stdin: 'ignore',
|
||||
reject: false,
|
||||
timeout: scenarioTimeoutMs,
|
||||
})
|
||||
let state: TreeState | undefined
|
||||
let identities: ProcessIdentity[] = []
|
||||
let settled = false
|
||||
try {
|
||||
state = await readTree(join(root, 'tree.json'))
|
||||
await vi.waitFor(() => readFile(join(root, 'ready'), 'utf8'), {
|
||||
interval: 10,
|
||||
timeout: scenarioTimeoutMs,
|
||||
})
|
||||
if (process.platform !== 'win32') identities = await captureIdentities(createProcessInspector(), state)
|
||||
await writeFile(join(root, 'proceed'), 'proceed')
|
||||
const outcome = await child
|
||||
settled = true
|
||||
await waitForGone(state)
|
||||
const disposeCounts = trigger === 'dispose'
|
||||
? JSON.parse(await readFile(join(root, 'dispose.json'), 'utf8')) as {
|
||||
listenersBefore: number
|
||||
listenersAfterLoad: number
|
||||
listenersAfterDispose: number
|
||||
}
|
||||
: undefined
|
||||
return { outcome, disposeCounts }
|
||||
} finally {
|
||||
if (!settled) {
|
||||
child.kill('SIGKILL')
|
||||
await child.catch(() => {})
|
||||
}
|
||||
cleanupTree(state, identities)
|
||||
if (state !== undefined) await waitForGone(state).catch(() => {})
|
||||
await rm(root, { recursive: true, force: true })
|
||||
}
|
||||
}
|
||||
|
||||
describe('synchronous cleanup on host exit', () => {
|
||||
it.each([
|
||||
{ trigger: 'direct' as const, expectedCode: 23, diagnostic: undefined },
|
||||
{ trigger: 'uncaught-exception' as const, expectedCode: 1, diagnostic: 'host-exit-uncaught-exception' },
|
||||
{ trigger: 'unhandled-rejection' as const, expectedCode: 1, diagnostic: 'host-exit-unhandled-rejection' },
|
||||
])('removes an ordinary managed tree after $trigger', { timeout: 45_000 }, async ({
|
||||
trigger,
|
||||
expectedCode,
|
||||
diagnostic,
|
||||
}) => {
|
||||
const { outcome } = await runScenario('ordinary', trigger)
|
||||
expect(outcome.exitCode).toBe(expectedCode)
|
||||
expect(outcome.signal).toBeUndefined()
|
||||
if (diagnostic !== undefined) expect(outcome.stderr).toContain(diagnostic)
|
||||
})
|
||||
|
||||
it.skipIf(process.platform === 'win32')(
|
||||
'removes a terminal root and descendant after direct exit',
|
||||
{ timeout: 45_000 },
|
||||
async () => {
|
||||
const { outcome } = await runScenario('terminal', 'direct')
|
||||
expect(outcome.exitCode).toBe(23)
|
||||
expect(outcome.signal).toBeUndefined()
|
||||
},
|
||||
)
|
||||
|
||||
it('preserves normal terminate-and-join disposal and removes the exit listener', { timeout: 45_000 }, async () => {
|
||||
const { outcome, disposeCounts } = await runScenario('ordinary', 'dispose')
|
||||
expect(outcome.exitCode).toBe(0)
|
||||
expect(disposeCounts?.listenersAfterLoad).toBe((disposeCounts?.listenersBefore ?? 0) + 1)
|
||||
expect(disposeCounts?.listenersAfterDispose).toBe(disposeCounts?.listenersBefore)
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user