Open-source Grok Bot alternative for named AI teammates. Local-first desktop, web, and mobile clients with per-bot tools, instructions, and memory. Independent fork of T3 Code.
[codex] Structure terminal PTY operation failures (#3364)
Julius Marminge58053d146b1e
diff --git a/apps/server/src/terminal/Manager.test.ts b/apps/server/src/terminal/Manager.test.tsindex c4c73ea74..3a1cabc4a 100644--- a/apps/server/src/terminal/Manager.test.ts+++ b/apps/server/src/terminal/Manager.test.ts@@ -39,6 +39,8 @@ class FakePtyProcess implements PtyAdapter.PtyProcess {readonly resizeCalls: Array<{ cols: number; rows: number }> = [];readonly killSignals: Array<string | undefined> = [];readonly pid: number;+ writeFailure: unknown | undefined;+ resizeFailure: unknown | undefined;private readonly dataListeners = new Set<(data: string) => void>();private readonly exitListeners = new Set<(event: PtyAdapter.PtyExitEvent) => void>();killed = false;@@ -48,10 +50,16 @@ class FakePtyProcess implements PtyAdapter.PtyProcess {}write(data: string): void {+ if (this.writeFailure !== undefined) {+ throw this.writeFailure;+ }this.writes.push(data);}resize(cols: number, rows: number): void {+ if (this.resizeFailure !== undefined) {+ throw this.resizeFailure;+ }this.resizeCalls.push({ cols, rows });}@@ -435,6 +443,39 @@ it.layer(fs.writeFileString(filePath, contents),);+ it.effect("reports a missing cwd without an artificial cause", () =>+ Effect.gen(function* () {+ const path = yield* Path.Path;++ const { manager, baseDir } = yield* createManager();+ const cwd = path.join(baseDir, "missing-cwd");+ const error = yield* Effect.flip(manager.open(openInput({ cwd })));++ expect(error).toMatchObject({+ _tag: "TerminalCwdNotFoundError",+ cwd,+ });+ expect("cause" in error).toBe(false);+ }),+ );++ it.effect("reports a cwd that is not a directory", () =>+ Effect.gen(function* () {+ const path = yield* Path.Path;++ const { manager, baseDir } = yield* createManager();+ const cwd = path.join(baseDir, "cwd-file");+ yield* writeFileString(cwd, "not a directory");+ const error = yield* Effect.flip(manager.open(openInput({ cwd })));++ expect(error).toMatchObject({+ _tag: "TerminalCwdNotDirectoryError",+ cwd,+ });+ expect("cause" in error).toBe(false);+ }),+ );+it.effect("preserves non-notFound cwd stat failures", () =>Effect.gen(function* () {if ((yield* HostProcessPlatform) === "win32") return;@@ -452,9 +493,11 @@ it.layer();expect(error).toMatchObject({- _tag: "TerminalCwdError",+ _tag: "TerminalCwdStatError",cwd: blockedCwd,- reason: "statFailed",+ cause: {+ _tag: "PlatformError",+ },});}),);@@ -498,6 +541,60 @@ it.layer(}),);+ it.effect("preserves structured context and causes for PTY I/O failures", () =>+ Effect.gen(function* () {+ const { manager, ptyAdapter } = yield* createManager();+ yield* manager.open(openInput());+ const process = ptyAdapter.processes[0];+ expect(process).toBeDefined();+ if (!process) return;++ const writeCause = new Error("PTY input handle is unavailable");+ process.writeFailure = writeCause;+ const writeError = yield* Effect.flip(+ manager.write({+ threadId: "thread-1",+ terminalId: DEFAULT_TERMINAL_ID,+ data: "secret input that must not be attached to the error",+ }),+ );++ expect(writeError).toMatchObject({+ _tag: "TerminalWriteError",+ threadId: "thread-1",+ terminalId: DEFAULT_TERMINAL_ID,+ terminalPid: process.pid,+ });+ expect(writeError.cause).toBe(writeCause);+ expect(writeError).not.toHaveProperty("data");++ const resizeCause = new Error("PTY resize handle is unavailable");+ process.resizeFailure = resizeCause;+ const resizeError = yield* Effect.flip(+ manager.resize({+ threadId: "thread-1",+ terminalId: DEFAULT_TERMINAL_ID,+ cols: 132,+ rows: 40,+ }),+ );++ expect(resizeError).toMatchObject({+ _tag: "TerminalResizeError",+ threadId: "thread-1",+ terminalId: DEFAULT_TERMINAL_ID,+ terminalPid: process.pid,+ cols: 132,+ rows: 40,+ });+ expect(resizeError.cause).toBe(resizeCause);++ process.resizeFailure = undefined;+ yield* manager.open(openInput({ cols: 132, rows: 40 }));+ expect(process.resizeCalls).toEqual([{ cols: 132, rows: 40 }]);+ }),+ );+it.effect("ignores delayed resize requests after a terminal closes", () =>Effect.gen(function* () {const { manager, ptyAdapter } = yield* createManager();diff --git a/apps/server/src/terminal/Manager.ts b/apps/server/src/terminal/Manager.tsindex 9fa9d07eb..6347fdfc6 100644--- a/apps/server/src/terminal/Manager.ts+++ b/apps/server/src/terminal/Manager.ts@@ -9,10 +9,15 @@import {DEFAULT_TERMINAL_ID,TerminalCwdError,+ TerminalCwdNotDirectoryError,+ TerminalCwdNotFoundError,+ TerminalCwdStatError,TerminalError,TerminalHistoryError,TerminalNotRunningError,+ TerminalResizeError,TerminalSessionLookupError,+ TerminalWriteError,type TerminalAttachInput,type TerminalAttachStreamEvent,type TerminalClearInput,@@ -58,10 +63,15 @@ import * as PtyAdapter from "./PtyAdapter.ts";export {TerminalCwdError,+ TerminalCwdNotDirectoryError,+ TerminalCwdNotFoundError,+ TerminalCwdStatError,TerminalError,TerminalHistoryError,TerminalNotRunningError,+ TerminalResizeError,TerminalSessionLookupError,+ TerminalWriteError,};const DEFAULT_HISTORY_LINE_LIMIT = 5_000;@@ -190,6 +200,25 @@ interface TerminalSubprocessInspector {): Effect.Effect<TerminalSubprocessInspectResult, TerminalSubprocessCheckError>;}+const resizePtyProcess = (+ session: TerminalSessionState,+ process: PtyAdapter.PtyProcess,+ cols: number,+ rows: number,+) =>+ Effect.try({+ try: () => process.resize(cols, rows),+ catch: (cause) =>+ new TerminalResizeError({+ threadId: session.threadId,+ terminalId: session.terminalId,+ terminalPid: process.pid,+ cols,+ rows,+ cause,+ }),+ });+export interface ShellCandidate {shell: string;args?: string[];@@ -1157,16 +1186,6 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(funcconst legacyHistoryPath = (threadId: string) =>path.join(logsDir, `${legacySafeThreadId(threadId)}.log`);- const toTerminalHistoryError =- (operation: "read" | "truncate" | "migrate", threadId: string, terminalId: string) =>- (cause: unknown) =>- new TerminalHistoryError({- operation,- threadId,- terminalId,- cause,- });-const readManagerState = SynchronizedRef.get(managerStateRef);const modifyManagerState = <A>(@@ -1250,7 +1269,7 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(functhreadId,terminalId,signal: "SIGTERM",- error: error.message,+ cause: error,}).pipe(Effect.as(false)),),);@@ -1274,7 +1293,7 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(functhreadId,terminalId,signal: "SIGKILL",- error: error.message,+ cause: error,}),),);@@ -1372,16 +1391,29 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(funcif (yield* fileSystem.exists(nextPath)- .pipe(Effect.mapError(toTerminalHistoryError("read", threadId, terminalId)))+ .pipe(+ Effect.mapError(+ (cause) => new TerminalHistoryError({ operation: "read", threadId, terminalId, cause }),+ ),+ )) {const raw = yield* fileSystem.readFileString(nextPath)- .pipe(Effect.mapError(toTerminalHistoryError("read", threadId, terminalId)));+ .pipe(+ Effect.mapError(+ (cause) => new TerminalHistoryError({ operation: "read", threadId, terminalId, cause }),+ ),+ );const capped = capHistory(raw, historyLineLimit);if (capped !== raw) {yield* fileSystem.writeFileString(nextPath, capped)- .pipe(Effect.mapError(toTerminalHistoryError("truncate", threadId, terminalId)));+ .pipe(+ Effect.mapError(+ (cause) =>+ new TerminalHistoryError({ operation: "truncate", threadId, terminalId, cause }),+ ),+ );}return capped;}@@ -1394,18 +1426,33 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(funcif (!(yield* fileSystem.exists(legacyPath)- .pipe(Effect.mapError(toTerminalHistoryError("migrate", threadId, terminalId))))+ .pipe(+ Effect.mapError(+ (cause) =>+ new TerminalHistoryError({ operation: "migrate", threadId, terminalId, cause }),+ ),+ ))) {return "";}const raw = yield* fileSystem.readFileString(legacyPath)- .pipe(Effect.mapError(toTerminalHistoryError("migrate", threadId, terminalId)));+ .pipe(+ Effect.mapError(+ (cause) =>+ new TerminalHistoryError({ operation: "migrate", threadId, terminalId, cause }),+ ),+ );const capped = capHistory(raw, historyLineLimit);yield* fileSystem.writeFileString(nextPath, capped)- .pipe(Effect.mapError(toTerminalHistoryError("migrate", threadId, terminalId)));+ .pipe(+ Effect.mapError(+ (cause) =>+ new TerminalHistoryError({ operation: "migrate", threadId, terminalId, cause }),+ ),+ );yield* fileSystem.remove(legacyPath, { force: true }).pipe(Effect.catch((cleanupError) =>Effect.logWarning("failed to remove legacy terminal history", {@@ -1472,20 +1519,15 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(funcconst assertValidCwd = Effect.fn("terminal.assertValidCwd")(function* (cwd: string) {const stats = yield* fileSystem.stat(cwd).pipe(- Effect.mapError(- (cause) =>- new TerminalCwdError({- cwd,- reason: cause.reason._tag === "NotFound" ? "notFound" : "statFailed",- cause,- }),- ),+ Effect.catchTags({+ PlatformError: (cause) =>+ cause.reason._tag === "NotFound"+ ? new TerminalCwdNotFoundError({ cwd })+ : new TerminalCwdStatError({ cwd, cause }),+ }),);if (stats.type !== "Directory") {- return yield* new TerminalCwdError({- cwd,- reason: "notDirectory",- });+ return yield* new TerminalCwdNotDirectoryError({ cwd });}});@@ -1881,7 +1923,7 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(funcyield* Effect.logError("failed to start terminal", {threadId: session.threadId,terminalId: session.terminalId,- error: message,+ cause: error,...(startedShell ? { shell: startedShell } : {}),});}@@ -2168,10 +2210,10 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(func}if (liveSession.cols !== targetCols || liveSession.rows !== targetRows) {+ yield* resizePtyProcess(liveSession, liveSession.process, targetCols, targetRows);liveSession.cols = targetCols;liveSession.rows = targetRows;liveSession.updatedAt = yield* nowIso;- liveSession.process.resize(targetCols, targetRows);}return snapshot(liveSession);@@ -2219,10 +2261,11 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(funcsession.status === "running" &&(session.cols !== targetCols || session.rows !== targetRows)) {+ const process = session.process;+ yield* resizePtyProcess(session, process, targetCols, targetRows);session.cols = targetCols;session.rows = targetRows;session.updatedAt = yield* nowIso;- yield* Effect.sync(() => session.process?.resize(targetCols, targetRows));}return snapshot(session);@@ -2409,7 +2452,16 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(functerminalId,});}- yield* Effect.sync(() => process.write(input.data));+ yield* Effect.try({+ try: () => process.write(input.data),+ catch: (cause) =>+ new TerminalWriteError({+ threadId: input.threadId,+ terminalId,+ terminalPid: process.pid,+ cause,+ }),+ });});const resizeLocked = Effect.fn("terminal.resize")(function* (input: TerminalResizeInput) {@@ -2422,10 +2474,10 @@ export const makeWithOptions = Effect.fn("TerminalManager.makeWithOptions")(funcif (!process || session.value.status !== "running") {return;}+ yield* resizePtyProcess(session.value, process, input.cols, input.rows);session.value.cols = input.cols;session.value.rows = input.rows;session.value.updatedAt = yield* nowIso;- yield* Effect.sync(() => process.resize(input.cols, input.rows));});const resize: TerminalManager["Service"]["resize"] = (input) =>diff --git a/packages/contracts/src/terminal.ts b/packages/contracts/src/terminal.tsindex a3c8e37e7..fa5f18211 100644--- a/packages/contracts/src/terminal.ts+++ b/packages/contracts/src/terminal.ts@@ -232,34 +232,47 @@ export const TerminalAttachStreamEvent = Schema.Union([]);export type TerminalAttachStreamEvent = typeof TerminalAttachStreamEvent.Type;-export class TerminalCwdError extends Schema.TaggedErrorClass<TerminalCwdError>()(- "TerminalCwdError",+export class TerminalCwdNotFoundError extends Schema.TaggedErrorClass<TerminalCwdNotFoundError>()(+ "TerminalCwdNotFoundError",+ {+ cwd: Schema.String,+ },+) {+ override get message() {+ return `Terminal cwd does not exist: ${this.cwd}`;+ }+}++export class TerminalCwdNotDirectoryError extends Schema.TaggedErrorClass<TerminalCwdNotDirectoryError>()(+ "TerminalCwdNotDirectoryError",{cwd: Schema.String,- reason: Schema.Literals(["notFound", "notDirectory", "statFailed"]),- cause: Schema.optional(Schema.Defect()),},) {override get message() {- if (this.reason === "notDirectory") {- return `Terminal cwd is not a directory: ${this.cwd}`;- }- if (this.reason === "notFound") {- return `Terminal cwd does not exist: ${this.cwd}`;- }- const causeMessage =- this.cause !== undefined &&- this.cause !== null &&- typeof this.cause === "object" &&- "message" in this.cause- ? this.cause.message- : undefined;- return typeof causeMessage === "string" && causeMessage.length > 0- ? `Failed to access terminal cwd: ${this.cwd} (${causeMessage})`- : `Failed to access terminal cwd: ${this.cwd}`;+ return `Terminal cwd is not a directory: ${this.cwd}`;}}+export class TerminalCwdStatError extends Schema.TaggedErrorClass<TerminalCwdStatError>()(+ "TerminalCwdStatError",+ {+ cwd: Schema.String,+ cause: Schema.Defect(),+ },+) {+ override get message() {+ return `Failed to access terminal cwd: ${this.cwd}`;+ }+}++export const TerminalCwdError = Schema.Union([+ TerminalCwdNotFoundError,+ TerminalCwdNotDirectoryError,+ TerminalCwdStatError,+]);+export type TerminalCwdError = typeof TerminalCwdError.Type;+export class TerminalHistoryError extends Schema.TaggedErrorClass<TerminalHistoryError>()("TerminalHistoryError",{@@ -298,10 +311,42 @@ export class TerminalNotRunningError extends Schema.TaggedErrorClass<TerminalNot}}+export class TerminalWriteError extends Schema.TaggedErrorClass<TerminalWriteError>()(+ "TerminalWriteError",+ {+ threadId: Schema.String,+ terminalId: Schema.String,+ terminalPid: Schema.Number,+ cause: Schema.Defect(),+ },+) {+ override get message() {+ return `Failed to write to terminal for thread: ${this.threadId}, terminal: ${this.terminalId}, PID: ${this.terminalPid}`;+ }+}++export class TerminalResizeError extends Schema.TaggedErrorClass<TerminalResizeError>()(+ "TerminalResizeError",+ {+ threadId: Schema.String,+ terminalId: Schema.String,+ terminalPid: Schema.Number,+ cols: TerminalColsSchema,+ rows: TerminalRowsSchema,+ cause: Schema.Defect(),+ },+) {+ override get message() {+ return `Failed to resize terminal for thread: ${this.threadId}, terminal: ${this.terminalId}, PID: ${this.terminalPid} to ${this.cols}x${this.rows}`;+ }+}+export const TerminalError = Schema.Union([TerminalCwdError,TerminalHistoryError,TerminalSessionLookupError,TerminalNotRunningError,+ TerminalWriteError,+ TerminalResizeError,]);export type TerminalError = typeof TerminalError.Type;