fix(coding-agent): reserve stdout in print and json mode closes #2482
This commit is contained in:
74
packages/coding-agent/src/core/output-guard.ts
Normal file
74
packages/coding-agent/src/core/output-guard.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
interface StdoutTakeoverState {
|
||||
rawStdoutWrite: (chunk: string, callback?: (error?: Error | null) => void) => boolean;
|
||||
rawStderrWrite: (chunk: string, callback?: (error?: Error | null) => void) => boolean;
|
||||
originalStdoutWrite: typeof process.stdout.write;
|
||||
}
|
||||
|
||||
let stdoutTakeoverState: StdoutTakeoverState | undefined;
|
||||
|
||||
export function takeOverStdout(): void {
|
||||
if (stdoutTakeoverState) {
|
||||
return;
|
||||
}
|
||||
|
||||
const rawStdoutWrite = process.stdout.write.bind(process.stdout) as StdoutTakeoverState["rawStdoutWrite"];
|
||||
const rawStderrWrite = process.stderr.write.bind(process.stderr) as StdoutTakeoverState["rawStderrWrite"];
|
||||
const originalStdoutWrite = process.stdout.write;
|
||||
|
||||
process.stdout.write = ((
|
||||
chunk: string | Uint8Array,
|
||||
encodingOrCallback?: BufferEncoding | ((error?: Error | null) => void),
|
||||
callback?: (error?: Error | null) => void,
|
||||
): boolean => {
|
||||
if (typeof encodingOrCallback === "function") {
|
||||
return rawStderrWrite(String(chunk), encodingOrCallback);
|
||||
}
|
||||
return rawStderrWrite(String(chunk), callback);
|
||||
}) as typeof process.stdout.write;
|
||||
|
||||
stdoutTakeoverState = {
|
||||
rawStdoutWrite,
|
||||
rawStderrWrite,
|
||||
originalStdoutWrite,
|
||||
};
|
||||
}
|
||||
|
||||
export function restoreStdout(): void {
|
||||
if (!stdoutTakeoverState) {
|
||||
return;
|
||||
}
|
||||
|
||||
process.stdout.write = stdoutTakeoverState.originalStdoutWrite;
|
||||
stdoutTakeoverState = undefined;
|
||||
}
|
||||
|
||||
export function isStdoutTakenOver(): boolean {
|
||||
return stdoutTakeoverState !== undefined;
|
||||
}
|
||||
|
||||
export function writeRawStdout(text: string): void {
|
||||
if (stdoutTakeoverState) {
|
||||
stdoutTakeoverState.rawStdoutWrite(text);
|
||||
return;
|
||||
}
|
||||
process.stdout.write(text);
|
||||
}
|
||||
|
||||
export async function flushRawStdout(): Promise<void> {
|
||||
if (stdoutTakeoverState) {
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
stdoutTakeoverState?.rawStdoutWrite("", (err) => {
|
||||
if (err) reject(err);
|
||||
else resolve();
|
||||
});
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
process.stdout.write("", (err) => {
|
||||
if (err) reject(err);
|
||||
else resolve();
|
||||
});
|
||||
});
|
||||
}
|
||||
@@ -7,6 +7,7 @@ import ignore from "ignore";
|
||||
import { minimatch } from "minimatch";
|
||||
import { CONFIG_DIR_NAME } from "../config.js";
|
||||
import { type GitSource, parseGitUrl } from "../utils/git.js";
|
||||
import { isStdoutTakenOver } from "./output-guard.js";
|
||||
import type { PackageSource, SettingsManager } from "./settings-manager.js";
|
||||
|
||||
const NETWORK_TIMEOUT_MS = 10000;
|
||||
@@ -2091,7 +2092,7 @@ export class DefaultPackageManager implements PackageManager {
|
||||
return new Promise((resolvePromise, reject) => {
|
||||
const child = spawn(command, args, {
|
||||
cwd: options?.cwd,
|
||||
stdio: "inherit",
|
||||
stdio: isStdoutTakenOver() ? ["ignore", 2, 2] : "inherit",
|
||||
shell: process.platform === "win32",
|
||||
});
|
||||
child.on("error", reject);
|
||||
|
||||
@@ -21,6 +21,7 @@ import type { LoadExtensionsResult } from "./core/extensions/index.js";
|
||||
import { migrateKeybindingsConfigFile } from "./core/keybindings.js";
|
||||
import { ModelRegistry } from "./core/model-registry.js";
|
||||
import { resolveCliModel, resolveModelScope, type ScopedModel } from "./core/model-resolver.js";
|
||||
import { restoreStdout, takeOverStdout } from "./core/output-guard.js";
|
||||
import { DefaultPackageManager } from "./core/package-manager.js";
|
||||
import { DefaultResourceLoader } from "./core/resource-loader.js";
|
||||
import { type CreateAgentSessionOptions, createAgentSession } from "./core/sdk.js";
|
||||
@@ -635,11 +636,15 @@ export async function main(args: string[]) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Run migrations (pass cwd for project-local migrations)
|
||||
const { migratedAuthProviders: migratedProviders, deprecationWarnings } = runMigrations(process.cwd());
|
||||
|
||||
// First pass: parse args to get --extension paths
|
||||
const firstPass = parseArgs(args);
|
||||
const shouldTakeOverStdout = firstPass.mode !== undefined || firstPass.print || !process.stdin.isTTY;
|
||||
if (shouldTakeOverStdout) {
|
||||
takeOverStdout();
|
||||
}
|
||||
|
||||
// Run migrations (pass cwd for project-local migrations)
|
||||
const { migratedAuthProviders: migratedProviders, deprecationWarnings } = runMigrations(process.cwd());
|
||||
|
||||
// Early load extensions to discover their CLI flags
|
||||
const cwd = process.cwd();
|
||||
@@ -884,9 +889,7 @@ export async function main(args: string[]) {
|
||||
initialImages,
|
||||
});
|
||||
stopThemeWatcher();
|
||||
if (process.stdout.writableLength > 0) {
|
||||
await new Promise<void>((resolve) => process.stdout.once("drain", resolve));
|
||||
}
|
||||
process.exit(0);
|
||||
restoreStdout();
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
|
||||
import type { AssistantMessage, ImageContent } from "@mariozechner/pi-ai";
|
||||
import type { AgentSession } from "../core/agent-session.js";
|
||||
import { flushRawStdout, writeRawStdout } from "../core/output-guard.js";
|
||||
|
||||
/**
|
||||
* Options for print mode.
|
||||
@@ -32,7 +33,7 @@ export async function runPrintMode(session: AgentSession, options: PrintModeOpti
|
||||
if (mode === "json") {
|
||||
const header = session.sessionManager.getHeader();
|
||||
if (header) {
|
||||
console.log(JSON.stringify(header));
|
||||
writeRawStdout(`${JSON.stringify(header)}\n`);
|
||||
}
|
||||
}
|
||||
// Set up extensions for print mode (no UI)
|
||||
@@ -76,7 +77,7 @@ export async function runPrintMode(session: AgentSession, options: PrintModeOpti
|
||||
session.subscribe((event) => {
|
||||
// In JSON mode, output all events
|
||||
if (mode === "json") {
|
||||
console.log(JSON.stringify(event));
|
||||
writeRawStdout(`${JSON.stringify(event)}\n`);
|
||||
}
|
||||
});
|
||||
|
||||
@@ -107,7 +108,7 @@ export async function runPrintMode(session: AgentSession, options: PrintModeOpti
|
||||
// Output text content
|
||||
for (const content of assistantMsg.content) {
|
||||
if (content.type === "text") {
|
||||
console.log(content.text);
|
||||
writeRawStdout(`${content.text}\n`);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -115,10 +116,5 @@ export async function runPrintMode(session: AgentSession, options: PrintModeOpti
|
||||
|
||||
// Ensure stdout is fully flushed before returning
|
||||
// This prevents race conditions where the process exits before all output is written
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
process.stdout.write("", (err) => {
|
||||
if (err) reject(err);
|
||||
else resolve();
|
||||
});
|
||||
});
|
||||
await flushRawStdout();
|
||||
}
|
||||
|
||||
@@ -18,6 +18,7 @@ import type {
|
||||
ExtensionUIDialogOptions,
|
||||
ExtensionWidgetOptions,
|
||||
} from "../../core/extensions/index.js";
|
||||
import { takeOverStdout, writeRawStdout } from "../../core/output-guard.js";
|
||||
import { type Theme, theme } from "../interactive/theme/theme.js";
|
||||
import { attachJsonlLineReader, serializeJsonLine } from "./jsonl.js";
|
||||
import type {
|
||||
@@ -43,15 +44,10 @@ export type {
|
||||
* Listens for JSON commands on stdin, outputs events and responses on stdout.
|
||||
*/
|
||||
export async function runRpcMode(session: AgentSession): Promise<never> {
|
||||
const rawStdoutWrite = process.stdout.write.bind(process.stdout);
|
||||
const rawStderrWrite = process.stderr.write.bind(process.stderr);
|
||||
|
||||
process.stdout.write = ((
|
||||
...args: Parameters<typeof process.stdout.write>
|
||||
): ReturnType<typeof process.stdout.write> => rawStderrWrite(...args)) as typeof process.stdout.write;
|
||||
takeOverStdout();
|
||||
|
||||
const output = (obj: RpcResponse | RpcExtensionUIRequest | object) => {
|
||||
rawStdoutWrite(serializeJsonLine(obj));
|
||||
writeRawStdout(serializeJsonLine(obj));
|
||||
};
|
||||
|
||||
const success = <T extends RpcCommand["type"]>(
|
||||
|
||||
Reference in New Issue
Block a user