1fea9b149f
Custom tool/extension/hook/plugin modules under ~/.claude/tools are evaluated with live side effects during createAgentSession. A module that attaches a stdin consumer at import time — an MCP StdioServerTransport built at module top level, or a bare process.stdin.resume() — steals Bun's single stdin reader, so the TUI receives exactly one data event and goes permanently deaf after the first keypress. Under tmux the terminal's automatic DA1 reply is that one event, so the first user keystroke is already dead: the input-deafness reported in #5378/#5618. Broadened the loader's withExitGuard (renamed withHostGuard) to also snapshot and restore process.stdin around third-party module evaluation: any data/readable/end/close/error listener the module adds is removed, and the stream's paused and raw-mode state is restored to the pre-load snapshot. The exit guard already fenced process.exit; stdin is the same class of host-state hijack. Fixes #5618
147 lines
5.4 KiB
TypeScript
147 lines
5.4 KiB
TypeScript
/**
|
|
* Regression test for #3680: third-party extension / hook modules that call
|
|
* `process.exit()` at the top level must not terminate the host OMP process.
|
|
*
|
|
* The harness intercepts the load via `withHostGuard`; this test pins that the
|
|
* intercepted error surfaces as a per-module load failure (so OMP keeps going)
|
|
* instead of crashing the test runner.
|
|
*/
|
|
import { afterEach, beforeEach, describe, expect, it } from "bun:test";
|
|
import * as fs from "node:fs";
|
|
import * as path from "node:path";
|
|
import { loadExtensions } from "@oh-my-pi/pi-coding-agent/extensibility/extensions/loader";
|
|
import { loadHooks } from "@oh-my-pi/pi-coding-agent/extensibility/hooks/loader";
|
|
import { ExtensionExitError, withHostGuard } from "@oh-my-pi/pi-coding-agent/extensibility/utils";
|
|
import { TempDir } from "@oh-my-pi/pi-utils";
|
|
|
|
describe("extension/hook loader process.exit guard (#3680)", () => {
|
|
let project: TempDir | undefined;
|
|
|
|
beforeEach(() => {
|
|
project = TempDir.createSync("@omp-exit-guard-");
|
|
});
|
|
|
|
afterEach(() => {
|
|
project?.removeSync();
|
|
project = undefined;
|
|
});
|
|
|
|
const writeModule = (relativePath: string, source: string): string => {
|
|
expect(project).toBeDefined();
|
|
const filePath = path.join(project!.path(), relativePath);
|
|
fs.mkdirSync(path.dirname(filePath), { recursive: true });
|
|
fs.writeFileSync(filePath, source);
|
|
return filePath;
|
|
};
|
|
|
|
it("converts a top-level process.exit in an extension into a load error", async () => {
|
|
const ext = writeModule("rogue-extension.ts", "process.exit(0)\n");
|
|
const cwd = project!.path();
|
|
const originalExit = process.exit;
|
|
|
|
const result = await loadExtensions([ext], cwd);
|
|
|
|
expect(process.exit).toBe(originalExit);
|
|
expect(result.extensions).toEqual([]);
|
|
expect(result.errors).toHaveLength(1);
|
|
expect(result.errors[0].path).toBe(ext);
|
|
expect(result.errors[0].error).toContain("process.exit(0)");
|
|
});
|
|
|
|
it("converts a top-level process.exit in a hook into a load error", async () => {
|
|
const hook = writeModule("rogue-hook.ts", "process.exit(42)\n");
|
|
const cwd = project!.path();
|
|
const originalExit = process.exit;
|
|
|
|
const result = await loadHooks([hook], cwd);
|
|
|
|
expect(process.exit).toBe(originalExit);
|
|
expect(result.hooks).toEqual([]);
|
|
expect(result.errors).toHaveLength(1);
|
|
expect(result.errors[0].path).toBe(hook);
|
|
expect(result.errors[0].error).toContain("process.exit(42)");
|
|
});
|
|
|
|
it("converts hard exits from extension and hook factories into load errors", async () => {
|
|
const extension = writeModule("factory-exit-extension.ts", "export default function(pi) { process.exit(31); }\n");
|
|
const hook = writeModule("factory-exit-hook.ts", "export default function(pi) { process.exit(32); }\n");
|
|
const reallyExitExtension = writeModule(
|
|
"factory-really-exit-extension.ts",
|
|
"export default function(pi) { process.reallyExit(33); }\n",
|
|
);
|
|
const cwd = project!.path();
|
|
const originalExit = process.exit;
|
|
const originalReallyExit = process.reallyExit;
|
|
|
|
const extensionResult = await loadExtensions([extension], cwd);
|
|
const hookResult = await loadHooks([hook], cwd);
|
|
const reallyExitResult = await loadExtensions([reallyExitExtension], cwd);
|
|
|
|
expect(process.exit).toBe(originalExit);
|
|
expect(process.reallyExit).toBe(originalReallyExit);
|
|
expect(extensionResult.extensions).toEqual([]);
|
|
expect(extensionResult.errors).toHaveLength(1);
|
|
expect(extensionResult.errors[0].path).toBe(extension);
|
|
expect(extensionResult.errors[0].error).toContain("process.exit(31)");
|
|
expect(hookResult.hooks).toEqual([]);
|
|
expect(hookResult.errors).toHaveLength(1);
|
|
expect(hookResult.errors[0].path).toBe(hook);
|
|
expect(hookResult.errors[0].error).toContain("process.exit(32)");
|
|
expect(reallyExitResult.extensions).toEqual([]);
|
|
expect(reallyExitResult.errors).toHaveLength(1);
|
|
expect(reallyExitResult.errors[0].path).toBe(reallyExitExtension);
|
|
expect(reallyExitResult.errors[0].error).toContain("process.reallyExit(33)");
|
|
});
|
|
|
|
it("loads sibling modules even when one of them tries to exit", async () => {
|
|
const bad = writeModule("rogue-extension.ts", "process.exit(0)\n");
|
|
const good = writeModule(
|
|
"good-extension.ts",
|
|
"export default function(pi) { pi.registerCommand('ok', { handler: async () => {} }); }\n",
|
|
);
|
|
const cwd = project!.path();
|
|
|
|
const result = await loadExtensions([bad, good], cwd);
|
|
|
|
expect(result.errors.map(e => e.path)).toEqual([bad]);
|
|
expect(result.extensions.map(e => path.basename(e.path))).toEqual(["good-extension.ts"]);
|
|
});
|
|
|
|
it("restores process.exit after a synchronous throw inside the guarded callback", async () => {
|
|
const originalExit = process.exit;
|
|
|
|
await expect(
|
|
withHostGuard(async () => {
|
|
throw new Error("boom");
|
|
}),
|
|
).rejects.toThrow("boom");
|
|
|
|
expect(process.exit).toBe(originalExit);
|
|
});
|
|
|
|
it("raises ExtensionExitError when the guarded callback calls process.exit", async () => {
|
|
const originalExit = process.exit;
|
|
|
|
await expect(withHostGuard(async () => process.exit(7))).rejects.toBeInstanceOf(ExtensionExitError);
|
|
|
|
expect(process.exit).toBe(originalExit);
|
|
});
|
|
|
|
it("only the outermost guard restores process.exit when guards nest", async () => {
|
|
const originalExit = process.exit;
|
|
|
|
await withHostGuard(async () => {
|
|
const outer = process.exit;
|
|
expect(outer).not.toBe(originalExit);
|
|
|
|
await withHostGuard(async () => {
|
|
expect(process.exit).toBe(outer);
|
|
});
|
|
|
|
expect(process.exit).toBe(outer);
|
|
});
|
|
|
|
expect(process.exit).toBe(originalExit);
|
|
});
|
|
});
|