Chinesezjc
18e3f39ff6
Review follow-ups: the Electron payload smoke allocates the way the product does on Windows, so the packaged tree resolves the console host assets it now depends on; the README states that dependency and its loud failure as a known limitation; the terminal handle takes the platform this method already resolved; and the note links the earlier tail-grace note, records why that grace cannot cover a malformed tail, and drops the claim that the smoke exercises the operating system host.
347 lines
15 KiB
TypeScript
347 lines
15 KiB
TypeScript
/**
|
|
* Local Service Provider for the subprocess capability seam. Each spawn owns a
|
|
* platform-selected managed range with the spec's per-stream stdio dispositions.
|
|
* Normal disposal terminates and joins live ranges; Node's synchronous exit
|
|
* phase force-stops any ranges the service still owns. It has no config: every
|
|
* disposition and limit arrives on the spec, so deployment-varying choices
|
|
* stay with the caller's config (the bash executor's, the LSP host's, …).
|
|
* @module @deepseek-ai/dsh-subprocess-local
|
|
*/
|
|
|
|
import { constants } from 'node:fs'
|
|
import { access, stat } from 'node:fs/promises'
|
|
import { userInfo } from 'node:os'
|
|
import { delimiter, extname, isAbsolute, resolve } from 'node:path'
|
|
import type { Duplex } from 'node:stream'
|
|
import { Context } from '@deepseek-ai/cordis'
|
|
import type * as NodePty from 'node-pty'
|
|
import type { IPtyForkOptions, IWindowsPtyForkOptions } from 'node-pty'
|
|
import { createLazyRequire } from '@deepseek-ai/dsh-lazy-require'
|
|
import { SubprocessRuntime, SubprocessExecutableNotFoundError } from '@deepseek-ai/dsh-subprocess'
|
|
import type {
|
|
SubprocessHandle,
|
|
SubprocessSpawnSpec,
|
|
SubprocessTerminalHandle,
|
|
SubprocessTerminalEnvironment,
|
|
SubprocessTerminalSpawnSpec,
|
|
} from '@deepseek-ai/dsh-subprocess'
|
|
import {
|
|
bindManagedProcess,
|
|
childEnv,
|
|
spawnSubprocess,
|
|
validateSubprocessSpec,
|
|
} from './spawn.ts'
|
|
import { logSpillFailure, prepareManagedProcessBinding } from './output.ts'
|
|
import type { LocalSubprocessHandle, SpawnInternals } from './spawn.ts'
|
|
import {
|
|
launchLinuxScope,
|
|
prepareLinuxTerminalScope,
|
|
probeLinuxManager,
|
|
probeLinuxNative,
|
|
signalLinuxDirectProcess,
|
|
} from './linux-scope.ts'
|
|
import { launchWindowsJob, probeWindowsJob } from './windows-job.ts'
|
|
import { targetEnvironment } from './runner-launch.ts'
|
|
import { createProcessInspector } from './process-inspector.ts'
|
|
import type { ProcessInspector } from './process-inspector.ts'
|
|
import { LocalTerminalHandle } from './terminal.ts'
|
|
import { prepareShellActivity } from './shell-activity.ts'
|
|
|
|
const requireNodePty = createLazyRequire<typeof NodePty>('node-pty', import.meta.url)
|
|
|
|
/**
|
|
* Local subprocess service: platform-selected managed ranges, Node-shaped stdio
|
|
* dispositions (raw pipes, inherit, bounded tail-keep collection with spill
|
|
* files), credential-scrubbed environment, and provider-owned range signalling.
|
|
* POSIX paths stage TERM before KILL; Windows paths terminate immediately.
|
|
* JavaScript-observable host exit also performs synchronous final termination.
|
|
*/
|
|
export class LocalSubprocessRuntime extends SubprocessRuntime {
|
|
/** Live handles retained for normal disposal and synchronous host-exit finalization. */
|
|
private live = new Set<LocalSubprocessHandle>()
|
|
/** Live terminals retained through normal quiescence or host-exit finalization. */
|
|
private terminals = new Set<LocalTerminalHandle>()
|
|
/** Caller endpoints retained until close, independently of managed process lifetime. */
|
|
private controlChannels = new Set<Duplex>()
|
|
/** Test hook: process, spill, and platform operations forwarded to spawnSubprocess. */
|
|
internals: SpawnInternals = {}
|
|
/** Provider-lifetime latch suppressing repeated weaker-containment warnings. */
|
|
private fallbackWarningIssued = false
|
|
/** Positive-only cache for the expensive Linux bootstrap and scope probe. */
|
|
private linuxDeepProbePassed = false
|
|
/** Test hook for platform process inspection; production resolves lazily on terminal spawn. */
|
|
terminalInspector: ProcessInspector | undefined
|
|
|
|
constructor(ctx: Context) {
|
|
super(ctx)
|
|
ctx.effect(() => {
|
|
const onHostExit = (): void => { this.terminateForHostExit() }
|
|
process.prependListener('exit', onHostExit)
|
|
return async () => {
|
|
await this.disposeManagedProcesses()
|
|
process.off('exit', onHostExit)
|
|
}
|
|
}, 'local subprocess teardown')
|
|
}
|
|
|
|
/** Spill failures reach the plugin logger; the log line is the only trace of why a result has no spill path. */
|
|
private readonly reportSpillFailure = logSpillFailure(this.ctx.logger, 'subprocess-local')
|
|
|
|
private terminateForHostExit(): void {
|
|
for (const handle of this.live) {
|
|
try {
|
|
handle.terminateForHostExit()
|
|
} catch (_ordinaryRangeTerminationFailed) {
|
|
// Host exit cannot await or report one target; continue with the rest.
|
|
}
|
|
}
|
|
for (const terminal of this.terminals) {
|
|
try {
|
|
terminal.terminateForHostExit()
|
|
} catch (_terminalTerminationFailed) {
|
|
// One terminal must not prevent final termination of another target.
|
|
}
|
|
}
|
|
}
|
|
|
|
private async disposeManagedProcesses(): Promise<void> {
|
|
// Request termination, then await MANAGED-RANGE exit — not just the
|
|
// direct command's settlement — so even a surviving descendant cannot
|
|
// outlive the fiber. Keep both sets authoritative while these waits are
|
|
// pending so a shorter process-level exit bound can still force-kill them.
|
|
const pending: Promise<unknown>[] = []
|
|
for (const handle of this.live) {
|
|
handle.terminate()
|
|
// Direct result and range observation are independent. Start both so an
|
|
// unreadable owner cannot hide behind a result that never settles.
|
|
pending.push(Promise.all([
|
|
handle.done.catch(() => {}),
|
|
handle.waitForExit(),
|
|
]).then(() => { this.live.delete(handle) }))
|
|
}
|
|
for (const terminal of this.terminals) {
|
|
pending.push(terminal.terminate().then(() => { this.terminals.delete(terminal) }))
|
|
}
|
|
const outcomes = await Promise.allSettled(pending)
|
|
await Promise.all([...this.controlChannels].map(control => new Promise<void>((resolveClose) => {
|
|
control.once('close', () => { resolveClose() })
|
|
control.destroy()
|
|
})))
|
|
this.controlChannels.clear()
|
|
const failures: unknown[] = []
|
|
for (const outcome of outcomes) {
|
|
if (outcome.status === 'rejected') failures.push(outcome.reason)
|
|
}
|
|
if (failures.length > 0) this.terminateForHostExit()
|
|
if (failures.length === 1) throw failures[0]
|
|
if (failures.length > 1) throw new AggregateError(failures, 'local subprocess teardown failed')
|
|
}
|
|
|
|
async resolveExecutable(
|
|
command: string,
|
|
env?: Readonly<Record<string, string>>,
|
|
signal?: AbortSignal,
|
|
): Promise<string> {
|
|
if (command.length === 0) throw new Error('subprocess-local: executable must be non-empty')
|
|
signal?.throwIfAborted()
|
|
const environment = childEnv(env)
|
|
const absolute = isAbsolute(command)
|
|
if (!absolute && (command.includes('/') || (process.platform === 'win32' && command.includes('\\')))) {
|
|
throw new Error(
|
|
`subprocess-local: command ${JSON.stringify(command)} is a relative path; use an absolute path or a bare PATH name`,
|
|
)
|
|
}
|
|
const candidates = absolute ? [command] : this.executableCandidates(command, environment)
|
|
for (const candidate of candidates) {
|
|
signal?.throwIfAborted()
|
|
try {
|
|
const info = await stat(candidate)
|
|
if (!info.isFile()) continue
|
|
await access(candidate, constants.X_OK)
|
|
signal?.throwIfAborted()
|
|
return candidate
|
|
} catch {
|
|
// Try the next PATH candidate; the final miss receives one stable error.
|
|
}
|
|
}
|
|
signal?.throwIfAborted()
|
|
throw new SubprocessExecutableNotFoundError(absolute
|
|
? `subprocess-local: command ${JSON.stringify(command)} is not an executable file`
|
|
: `subprocess-local: command ${JSON.stringify(command)} was not found on PATH`)
|
|
}
|
|
|
|
private executableCandidates(command: string, env: NodeJS.ProcessEnv): string[] {
|
|
const path = environmentValue(env, 'PATH') ?? ''
|
|
const extensions = process.platform === 'win32' && extname(command) === ''
|
|
? (environmentValue(env, 'PATHEXT') ?? '.COM;.EXE;.BAT;.CMD').split(';')
|
|
: ['']
|
|
return path.split(delimiter).flatMap(directory =>
|
|
extensions.map(extension => resolve(process.cwd(), directory, command + extension)))
|
|
}
|
|
|
|
spawn(spec: SubprocessSpawnSpec): SubprocessHandle {
|
|
validateSubprocessSpec(spec)
|
|
const env = targetEnvironment(spec)
|
|
const containmentMode = this.selectContainmentMode('ordinary')
|
|
let handle: LocalSubprocessHandle
|
|
const internals: SpawnInternals = { ...this.internals, onSpillFailure: this.reportSpillFailure }
|
|
if (containmentMode === 'fallback') {
|
|
handle = spawnSubprocess(spec, internals)
|
|
} else {
|
|
const binding = prepareManagedProcessBinding(internals)
|
|
const launch = containmentMode === 'linux-scope'
|
|
? launchLinuxScope(spec, env)
|
|
: launchWindowsJob(spec, env)
|
|
handle = bindManagedProcess(spec, launch, binding)
|
|
}
|
|
this.live.add(handle)
|
|
const control = handle.control
|
|
if (control !== undefined) {
|
|
this.controlChannels.add(control)
|
|
control.once('close', () => { this.controlChannels.delete(control) })
|
|
}
|
|
// Release ownership only once the whole managed range is gone, not at direct-child
|
|
// settlement — a TERM-trapping helper that outlives the leader must stay
|
|
// owned so teardown can still escalate it. For the common no-survivor
|
|
// case waitForExit resolves immediately after settlement.
|
|
const release = (): Promise<void> =>
|
|
handle.waitForExit().then(() => { this.live.delete(handle) })
|
|
void handle.done.then(release, release).catch(() => {})
|
|
return handle
|
|
}
|
|
|
|
private selectContainmentMode(
|
|
kind: 'ordinary' | 'terminal',
|
|
): 'linux-scope' | 'windows-job' | 'fallback' {
|
|
const platform = this.internals.platform ?? process.platform
|
|
let fallbackReason: string | undefined
|
|
if (platform === 'linux') {
|
|
const available = this.linuxDeepProbePassed
|
|
? probeLinuxManager()
|
|
: probeLinuxNative()
|
|
if (available) this.linuxDeepProbePassed = true
|
|
if (available) return 'linux-scope'
|
|
fallbackReason = 'the current user-systemd scope or private bootstrap is unavailable'
|
|
}
|
|
if (kind === 'ordinary' && platform === 'win32') {
|
|
const available = probeWindowsJob()
|
|
if (available) return 'windows-job'
|
|
}
|
|
this.warnFallback(platform, kind, fallbackReason)
|
|
return 'fallback'
|
|
}
|
|
|
|
private warnFallback(
|
|
platform: NodeJS.Platform,
|
|
kind: 'ordinary' | 'terminal',
|
|
selectedReason?: string,
|
|
): void {
|
|
if (this.fallbackWarningIssued) return
|
|
this.fallbackWarningIssued = true
|
|
const reason = selectedReason ?? (platform === 'darwin'
|
|
? 'macOS has no supported persistent process-range owner'
|
|
: platform === 'win32'
|
|
? kind === 'terminal'
|
|
? 'Windows ConPTY remains outside Job containment'
|
|
: 'the Win32 Job runner is unavailable'
|
|
: `platform ${platform} has no native managed range`)
|
|
this.ctx.logger.warn(
|
|
`subprocess-local is using weaker process-tree containment because ${reason}; descendants that escape the process group or direct-parent tree are not guaranteed to terminate or delay waitForExit()`,
|
|
)
|
|
}
|
|
|
|
/** @inheritdoc */
|
|
// oxlint-disable-next-line typescript/require-await -- Keep the provider promise rejection semantics for cancelled inspection.
|
|
async terminalEnvironment(signal?: AbortSignal): Promise<SubprocessTerminalEnvironment> {
|
|
signal?.throwIfAborted()
|
|
const platform = process.platform === 'win32' ? 'windows' : 'posix'
|
|
const defaultShell = platform === 'windows' ? process.env.ComSpec || undefined : process.env.SHELL || userInfo().shell || undefined
|
|
return { platform, ...defaultShell === undefined ? {} : { defaultShell } }
|
|
}
|
|
|
|
// Local PTY allocation is synchronous, but the provider contract permits remote asynchronous allocation.
|
|
// oxlint-disable-next-line typescript/require-await -- Preserve promise rejection semantics at the async provider contract.
|
|
async spawnTerminal(spec: SubprocessTerminalSpawnSpec): Promise<SubprocessTerminalHandle> {
|
|
const file = spec.argv[0]
|
|
if (file === undefined || file.length === 0) {
|
|
throw new Error('subprocess-local: terminal argv must contain a program')
|
|
}
|
|
spec.signal?.throwIfAborted()
|
|
const inspector = this.terminalInspector ?? createProcessInspector()
|
|
const containmentMode = this.selectContainmentMode('terminal')
|
|
const env = targetEnvironment(spec)
|
|
const platform = this.internals.platform ?? process.platform
|
|
const activity = prepareShellActivity(spec, env, platform)
|
|
const launch = activity === undefined ? spec : { ...spec, argv: activity.argv, env: activity.env }
|
|
const options: IPtyForkOptions | IWindowsPtyForkOptions = {
|
|
name: spec.terminalType,
|
|
rows: spec.rows,
|
|
cols: spec.cols,
|
|
cwd: spec.cwd,
|
|
env: { ...activity?.env ?? env, TERM: spec.terminalType },
|
|
// Windows' own console host (the standby pool runs Server 2022 and
|
|
// Windows 10 22H2) renders the persistent-pwsh prompt tail in a form the
|
|
// readiness path cannot match; the console host node-pty ships emits it
|
|
// verbatim, see [Agent Note](../../../../.agents/notes/implemented/bug-fix/2026-09-28-pty-bundled-console-host.md).
|
|
...(platform === 'win32' ? { useConptyDll: true } : {}),
|
|
}
|
|
let scope: ReturnType<typeof prepareLinuxTerminalScope> | undefined
|
|
let terminal: NodePty.IPty
|
|
try {
|
|
scope = containmentMode === 'linux-scope'
|
|
? prepareLinuxTerminalScope(launch, { ...activity?.env ?? env, PWD: spec.cwd, TERM: spec.terminalType })
|
|
: undefined
|
|
if (scope !== undefined) { options.cwd = scope.cwd; options.env = scope.env }
|
|
terminal = requireNodePty().spawn(
|
|
scope?.command ?? file,
|
|
scope?.args ?? [...launch.argv.slice(1)],
|
|
options,
|
|
)
|
|
} catch (error) {
|
|
scope?.cleanup()
|
|
activity?.dispose()
|
|
throw error
|
|
}
|
|
// oxlint-disable-next-line eslint/prefer-const -- The owner can query readiness before the handle is published.
|
|
let handle: LocalTerminalHandle | undefined
|
|
const directSettlement = Promise.withResolvers<void>()
|
|
const owner = scope?.bindOwner({
|
|
running: () => handle?.running ?? true,
|
|
settled: directSettlement.promise,
|
|
// node-pty swallows signal errors; the scope owner requires their delivery result.
|
|
signal: signal => signalLinuxDirectProcess(terminal.pid, () => process.kill(terminal.pid, signal)),
|
|
})
|
|
handle = new LocalTerminalHandle(
|
|
terminal,
|
|
inspector,
|
|
spec.graceMs,
|
|
platform,
|
|
owner,
|
|
scope?.resolveOutcome,
|
|
activity,
|
|
() => { this.terminals.delete(handle as LocalTerminalHandle) },
|
|
spec.shellActivity === true,
|
|
)
|
|
this.terminals.add(handle)
|
|
const release = async (): Promise<void> => {
|
|
// terminate() can wait on this direct-exit promise.
|
|
directSettlement.resolve()
|
|
if (spec.shellActivity === true) return
|
|
await handle.terminate()
|
|
this.terminals.delete(handle)
|
|
}
|
|
void handle.done.then(release, release).catch(() => {})
|
|
return handle
|
|
}
|
|
}
|
|
|
|
/** Read a Windows environment key using the platform's case-insensitive semantics. */
|
|
function environmentValue(env: NodeJS.ProcessEnv, name: 'PATH' | 'PATHEXT'): string | undefined {
|
|
const exact = env[name]
|
|
if (exact !== undefined || process.platform !== 'win32') return exact
|
|
const normalized = name.toUpperCase()
|
|
return Object.entries(env).find(([key]) => key.toUpperCase() === normalized)?.[1]
|
|
}
|
|
|
|
export default LocalSubprocessRuntime
|