Files
automaker/libs/platform/src/subprocess.ts
Shirone c6d94d4bf4 fix: improve abort handling in spawnJSONLProcess
- Added immediate invocation of abort handler if the abort signal is already triggered, ensuring proper cleanup.
- Updated test to use setImmediate for aborting, allowing the generator to start processing before the abort is called, enhancing reliability.
2026-01-04 03:50:17 +01:00

247 lines
6.7 KiB
TypeScript

/**
* Subprocess management utilities for CLI providers
*/
import { spawn, type ChildProcess } from 'child_process';
import readline from 'readline';
export interface SubprocessOptions {
command: string;
args: string[];
cwd: string;
env?: Record<string, string>;
abortController?: AbortController;
timeout?: number; // Milliseconds of no output before timeout
/**
* Data to write to stdin after process spawns.
* Use this for passing prompts/content that may contain shell metacharacters.
* Avoids shell interpretation issues when passing data as CLI arguments.
*/
stdinData?: string;
}
export interface SubprocessResult {
stdout: string;
stderr: string;
exitCode: number | null;
}
/**
* Spawns a subprocess and streams JSONL output line-by-line
*/
export async function* spawnJSONLProcess(options: SubprocessOptions): AsyncGenerator<unknown> {
const { command, args, cwd, env, abortController, timeout = 30000, stdinData } = options;
const processEnv = {
...process.env,
...env,
};
// Log command without stdin data (which may be large/sensitive)
console.log(`[SubprocessManager] Spawning: ${command} ${args.join(' ')}`);
console.log(`[SubprocessManager] Working directory: ${cwd}`);
if (stdinData) {
console.log(`[SubprocessManager] Passing ${stdinData.length} bytes via stdin`);
}
const childProcess: ChildProcess = spawn(command, args, {
cwd,
env: processEnv,
// Use 'pipe' for stdin when we need to write data, otherwise 'ignore'
stdio: [stdinData ? 'pipe' : 'ignore', 'pipe', 'pipe'],
});
// Write stdin data if provided
if (stdinData && childProcess.stdin) {
childProcess.stdin.write(stdinData);
childProcess.stdin.end();
}
let stderrOutput = '';
let lastOutputTime = Date.now();
let timeoutHandle: NodeJS.Timeout | null = null;
// Collect stderr for error reporting
if (childProcess.stderr) {
childProcess.stderr.on('data', (data: Buffer) => {
const text = data.toString();
stderrOutput += text;
console.warn(`[SubprocessManager] stderr: ${text}`);
});
}
// Setup timeout detection
const resetTimeout = () => {
lastOutputTime = Date.now();
if (timeoutHandle) {
clearTimeout(timeoutHandle);
}
timeoutHandle = setTimeout(() => {
const elapsed = Date.now() - lastOutputTime;
if (elapsed >= timeout) {
console.error(`[SubprocessManager] Process timeout: no output for ${timeout}ms`);
childProcess.kill('SIGTERM');
}
}, timeout);
};
resetTimeout();
// Setup abort handling with cleanup
let abortHandler: (() => void) | null = null;
if (abortController) {
abortHandler = () => {
console.log('[SubprocessManager] Abort signal received, killing process');
if (timeoutHandle) {
clearTimeout(timeoutHandle);
}
childProcess.kill('SIGTERM');
};
// Check if already aborted, if so call handler immediately
if (abortController.signal.aborted) {
abortHandler();
} else {
abortController.signal.addEventListener('abort', abortHandler);
}
}
// Helper to clean up abort listener
const cleanupAbortListener = () => {
if (abortController && abortHandler) {
abortController.signal.removeEventListener('abort', abortHandler);
abortHandler = null;
}
};
// Parse stdout as JSONL (one JSON object per line)
if (childProcess.stdout) {
const rl = readline.createInterface({
input: childProcess.stdout,
crlfDelay: Infinity,
});
try {
for await (const line of rl) {
resetTimeout();
if (!line.trim()) continue;
try {
const parsed = JSON.parse(line);
yield parsed;
} catch (parseError) {
console.error(`[SubprocessManager] Failed to parse JSONL line: ${line}`, parseError);
// Yield error but continue processing
yield {
type: 'error',
error: `Failed to parse output: ${line}`,
};
}
}
} catch (error) {
console.error('[SubprocessManager] Error reading stdout:', error);
throw error;
} finally {
if (timeoutHandle) {
clearTimeout(timeoutHandle);
}
rl.close();
cleanupAbortListener();
}
} else {
// No stdout - still need to cleanup abort listener when process exits
cleanupAbortListener();
}
// Wait for process to exit
const exitCode = await new Promise<number | null>((resolve) => {
childProcess.on('exit', (code) => {
console.log(`[SubprocessManager] Process exited with code: ${code}`);
resolve(code);
});
childProcess.on('error', (error) => {
console.error('[SubprocessManager] Process error:', error);
resolve(null);
});
});
// Handle non-zero exit codes
if (exitCode !== 0 && exitCode !== null) {
const errorMessage = stderrOutput || `Process exited with code ${exitCode}`;
console.error(`[SubprocessManager] Process failed: ${errorMessage}`);
yield {
type: 'error',
error: errorMessage,
};
}
// Process completed successfully
if (exitCode === 0 && !stderrOutput) {
console.log('[SubprocessManager] Process completed successfully');
}
}
/**
* Spawns a subprocess and collects all output
*/
export async function spawnProcess(options: SubprocessOptions): Promise<SubprocessResult> {
const { command, args, cwd, env, abortController } = options;
const processEnv = {
...process.env,
...env,
};
return new Promise((resolve, reject) => {
const childProcess = spawn(command, args, {
cwd,
env: processEnv,
stdio: ['ignore', 'pipe', 'pipe'],
});
let stdout = '';
let stderr = '';
if (childProcess.stdout) {
childProcess.stdout.on('data', (data: Buffer) => {
stdout += data.toString();
});
}
if (childProcess.stderr) {
childProcess.stderr.on('data', (data: Buffer) => {
stderr += data.toString();
});
}
// Setup abort handling with cleanup
let abortHandler: (() => void) | null = null;
const cleanupAbortListener = () => {
if (abortController && abortHandler) {
abortController.signal.removeEventListener('abort', abortHandler);
abortHandler = null;
}
};
if (abortController) {
abortHandler = () => {
cleanupAbortListener();
childProcess.kill('SIGTERM');
reject(new Error('Process aborted'));
};
abortController.signal.addEventListener('abort', abortHandler);
}
childProcess.on('exit', (code) => {
cleanupAbortListener();
resolve({ stdout, stderr, exitCode: code });
});
childProcess.on('error', (error) => {
cleanupAbortListener();
reject(error);
});
});
}