ptywright 0.1.0 → 0.2.0

package/src/session/session_manager.ts

@@ -1,145 +0,0 @@
-import { BunPtyAdapter } from "../pty/bun_pty_adapter";
-import { BunTerminalAdapter } from "../pty/bun_terminal_adapter";
-import type { PtyAdapter } from "../pty/pty_adapter";
-import { TerminalSession } from "./terminal_session";
-
-import type { LaunchSessionArgs, SessionId } from "../types";
-
-export type SessionManagerOptions = {
-  ptyAdapter?: PtyAdapter;
-  snapshotRingSize?: number;
-};
-
-export class SessionManager {
-  private readonly ptyAdapter: PtyAdapter;
-  private readonly snapshotRingSize: number;
-  private readonly sessions = new Map<SessionId, TerminalSession>();
-
-  constructor(options?: SessionManagerOptions) {
-    this.ptyAdapter = options?.ptyAdapter ?? createDefaultPtyAdapter();
-    this.snapshotRingSize = options?.snapshotRingSize ?? 50;
-  }
-
-  listSessionIds(): SessionId[] {
-    return [...this.sessions.keys()];
-  }
-
-  listSessions(): TerminalSession[] {
-    return [...this.sessions.values()];
-  }
-
-  getSession(sessionId: SessionId): TerminalSession | undefined {
-    return this.sessions.get(sessionId);
-  }
-
-  launchSession(args: LaunchSessionArgs): TerminalSession {
-    const sessionId = crypto.randomUUID();
-    const cols = clampInt(args.cols ?? 80, 1, 500);
-    const rows = clampInt(args.rows ?? 24, 1, 300);
-    const cwd = args.cwd ?? process.cwd();
-    const term = args.env?.TERM ?? args.name ?? "xterm-256color";
-
-    const env = mergeEnv(
-      {
-        TERM: term,
-        COLORTERM: "truecolor",
-      },
-      args.env,
-    );
-
-    const pty = this.ptyAdapter.spawn(args.command, args.args ?? [], {
-      cols,
-      rows,
-      cwd,
-      name: term,
-      env,
-    });
-
-    const traceEnv = pickTraceEnv(env);
-    const traceCommand = [args.command, ...(args.args ?? [])].join(" ").trim();
-
-    const session = new TerminalSession({
-      id: sessionId,
-      pty,
-      cols,
-      rows,
-      snapshotRingSize: this.snapshotRingSize,
-      trace: {
-        command: traceCommand,
-        args: args.args ?? [],
-        cwd,
-        env: traceEnv,
-      },
-    });
-
-    this.sessions.set(sessionId, session);
-    return session;
-  }
-
-  closeSession(sessionId: SessionId): boolean {
-    const session = this.sessions.get(sessionId);
-    if (!session) return false;
-    session.close();
-    this.sessions.delete(sessionId);
-    return true;
-  }
-
-  closeAll(): void {
-    for (const [id, session] of this.sessions) {
-      session.close();
-      this.sessions.delete(id);
-    }
-  }
-}
-
-function createDefaultPtyAdapter(): PtyAdapter {
-  const backend = (process.env.TUI_TEST_PTY_BACKEND ?? "auto").toLowerCase();
-
-  if (backend === "bun-pty") return new BunPtyAdapter();
-  if (backend === "bun-terminal") return new BunTerminalAdapter();
-
-  // auto
-  return process.platform === "win32" ? new BunPtyAdapter() : new BunTerminalAdapter();
-}
-
-function clampInt(value: number, min: number, max: number): number {
-  if (!Number.isFinite(value)) return min;
-  const int = Math.trunc(value);
-  if (int < min) return min;
-  if (int > max) return max;
-  return int;
-}
-
-function mergeEnv(
-  base: Record<string, string>,
-  override?: Record<string, string>,
-): Record<string, string> {
-  const env: Record<string, string> = {};
-
-  for (const [k, v] of Object.entries(process.env)) {
-    if (typeof v === "string") {
-      env[k] = v;
-    }
-  }
-
-  for (const [k, v] of Object.entries(base)) {
-    env[k] = v;
-  }
-
-  if (override) {
-    for (const [k, v] of Object.entries(override)) {
-      env[k] = v;
-    }
-  }
-
-  return env;
-}
-
-function pickTraceEnv(env: Record<string, string>): Record<string, string> {
-  const picked: Record<string, string> = {};
-  for (const key of ["TERM", "COLORTERM", "LANG", "LC_ALL"]) {
-    const value = env[key];
-    if (value) picked[key] = value;
-  }
-  return picked;
-}

package/src/session/terminal_session.ts

@@ -1,473 +0,0 @@
-import { Terminal } from "@xterm/headless";
-
-import type { Disposable, PtyProcess } from "../pty/pty_adapter";
-import { encodeKey } from "../terminal/keys";
-import { renderAnsiLines } from "../terminal/ansi";
-import { encodeSgrMouse } from "../terminal/mouse";
-import type { MouseEvent } from "../terminal/mouse";
-import type { AnsiRenderedLine } from "../terminal/ansi";
-import { snapshotGrid, snapshotLines } from "../terminal/snapshot";
-import type { TerminalSnapshotGrid } from "../terminal/snapshot";
-import type { SnapshotScope } from "../terminal/snapshot";
-import type { TerminalMeta } from "../terminal/view";
-import { applyTextMaskRules } from "../terminal/mask";
-import type { TextMaskRule } from "../terminal/mask";
-import { fnv1a32 } from "../util/hash";
-import { sleep } from "../util/sleep";
-import { TraceRecorder } from "../trace/recorder";
-import type { TraceSnapshot } from "../trace/recorder";
-
-export type TerminalSessionOptions = {
-  id: string;
-  pty: PtyProcess;
-  cols: number;
-  rows: number;
-  snapshotRingSize: number;
-  trace?: {
-    command?: string;
-    args?: string[];
-    cwd?: string;
-    env?: Record<string, string>;
-    title?: string;
-  };
-};
-
-export type SnapshotFrame = {
-  atMs: number;
-  hash: string;
-  text: string;
-};
-
-export type TerminalSessionCloseReason =
-  | { type: "closed_by_user" }
-  | { type: "process_exit"; exitCode: number; signal?: number | string };
-
-const ESC = "\x1b";
-
-export class TerminalSession {
-  readonly id: string;
-
-  private readonly pty: PtyProcess;
-  private readonly terminal: Terminal;
-  private readonly snapshotRingSize: number;
-  private readonly trace: TraceRecorder;
-
-  private writeChain: Promise<void> = Promise.resolve();
-  private readonly disposables: Disposable[] = [];
-  private readonly rawOutputRing: string[] = [];
-  private readonly snapshotRing: SnapshotFrame[] = [];
-
-  private closed: TerminalSessionCloseReason | null = null;
-
-  constructor(options: TerminalSessionOptions) {
-    this.id = options.id;
-    this.pty = options.pty;
-    this.snapshotRingSize = options.snapshotRingSize;
-
-    this.terminal = new Terminal({
-      cols: options.cols,
-      rows: options.rows,
-      allowProposedApi: true,
-      scrollback: 2000,
-      convertEol: true,
-    });
-
-    this.trace = new TraceRecorder({
-      version: 2,
-      width: options.cols,
-      height: options.rows,
-      timestamp: Math.floor(Date.now() / 1000),
-      env: options.trace?.env,
-      title: options.trace?.title ?? options.id,
-      command: options.trace?.command,
-      term: options.trace?.env?.TERM,
-    });
-
-    this.disposables.push(
-      this.terminal.parser.registerCsiHandler({ final: "n" }, (params) =>
-        this.handleCsiDsr(params),
-      ),
-    );
-
-    this.disposables.push(
-      this.terminal.parser.registerCsiHandler({ final: "c" }, (params) => this.handleCsiDa(params)),
-    );
-
-    this.disposables.push(
-      this.pty.onData((data) => {
-        this.appendRawOutput(data);
-        this.trace.recordOutput(data);
-        this.enqueueWrite(data);
-      }),
-    );
-
-    this.disposables.push(
-      this.pty.onExit((event) => {
-        this.closed = { type: "process_exit", exitCode: event.exitCode, signal: event.signal };
-      }),
-    );
-  }
-
-  get cols(): number {
-    return this.terminal.cols;
-  }
-
-  get rows(): number {
-    return this.terminal.rows;
-  }
-
-  isClosed(): boolean {
-    return this.closed !== null;
-  }
-
-  getCloseReason(): TerminalSessionCloseReason | null {
-    return this.closed;
-  }
-
-  resize(cols: number, rows: number): void {
-    this.trace.recordResize(cols, rows);
-    this.pty.resize(cols, rows);
-    this.terminal.resize(cols, rows);
-  }
-
-  sendText(text: string, options?: { enter?: boolean }): void {
-    const enter = options?.enter ?? false;
-    const payload = enter ? `${text}\r` : text;
-    this.trace.recordInput(payload);
-    this.pty.write(payload);
-  }
-
-  pressKey(key: string): void {
-    const encoded = encodeKey(key);
-    this.trace.recordInput(encoded);
-    this.pty.write(encoded);
-  }
-
-  sendMouse(event: MouseEvent): void {
-    const encoded = encodeSgrMouse(event);
-    this.trace.recordInput(encoded);
-    this.pty.write(encoded);
-  }
-
-  async flush(): Promise<void> {
-    await this.writeChain;
-  }
-
-  getMeta(): TerminalMeta {
-    const buffer = this.terminal.buffer.active;
-    return {
-      cols: this.terminal.cols,
-      rows: this.terminal.rows,
-      bufferType: buffer.type,
-      viewportY: buffer.viewportY,
-      baseY: buffer.baseY,
-      length: buffer.length,
-      cursorX: buffer.cursorX,
-      cursorY: buffer.cursorY,
-    };
-  }
-
-  async snapshotText(options?: SnapshotTextOptions): Promise<{
-    text: string;
-    hash: string;
-  }> {
-    await this.flush();
-    if (options?.maxLines !== undefined && options.tailLines !== undefined) {
-      throw new Error("snapshotText: maxLines and tailLines are mutually exclusive");
-    }
-
-    let lines = snapshotLines(this.terminal, {
-      scope: options?.scope,
-      trimRight: options?.trimRight,
-    });
-
-    const trimBottom = options?.trimBottom ?? true;
-    if (trimBottom) {
-      lines = trimBottomEmptyLines(lines);
-    }
-
-    if (options?.maxLines !== undefined) {
-      const max = Math.max(0, Math.trunc(options.maxLines));
-      lines = lines.slice(0, max);
-    }
-
-    if (options?.tailLines !== undefined) {
-      const tail = Math.max(0, Math.trunc(options.tailLines));
-      lines = lines.slice(Math.max(0, lines.length - tail));
-    }
-
-    lines = applyTextMaskRules(lines, options?.mask);
-
-    const text = lines.join("\n");
-    const hash = fnv1a32(text);
-    if (options?.captureFrame ?? true) {
-      this.captureFrame(text, hash);
-    }
-    return { text, hash };
-  }
-
-  async snapshotAnsi(options?: SnapshotAnsiOptions): Promise<{
-    ansi: string;
-    plain: string;
-    hash: string;
-    lines: AnsiRenderedLine[];
-  }> {
-    await this.flush();
-    if (options?.maxLines !== undefined && options.tailLines !== undefined) {
-      throw new Error("snapshotAnsi: maxLines and tailLines are mutually exclusive");
-    }
-
-    let lines = renderAnsiLines(this.terminal, {
-      scope: options?.scope,
-      trimRight: options?.trimRight,
-    });
-
-    const trimBottom = options?.trimBottom ?? true;
-    if (trimBottom) {
-      lines = trimBottomEmptyAnsiLines(lines);
-    }
-
-    if (options?.maxLines !== undefined) {
-      const max = Math.max(0, Math.trunc(options.maxLines));
-      lines = lines.slice(0, max);
-    }
-
-    if (options?.tailLines !== undefined) {
-      const tail = Math.max(0, Math.trunc(options.tailLines));
-      lines = lines.slice(Math.max(0, lines.length - tail));
-    }
-
-    if (options?.mask && options.mask.length > 0) {
-      const maskedPlain = applyTextMaskRules(
-        lines.map((line) => line.plain),
-        options.mask,
-      );
-      const maskedAnsi = applyTextMaskRules(
-        lines.map((line) => line.ansi),
-        options.mask,
-      );
-
-      lines = lines.map((line, idx) => ({
-        ...line,
-        plain: maskedPlain[idx] ?? "",
-        ansi: maskedAnsi[idx] ?? "",
-      }));
-    }
-
-    const ansi = lines.map((l) => l.ansi).join("\n");
-    const plain = lines.map((l) => l.plain).join("\n");
-    const hash = fnv1a32(ansi);
-    return { ansi, plain, hash, lines };
-  }
-
-  async snapshotGrid(options?: {
-    trimRight?: boolean;
-    includeStyles?: boolean;
-    captureFrame?: boolean;
-  }): Promise<{
-    grid: TerminalSnapshotGrid;
-    hash: string;
-  }> {
-    await this.flush();
-
-    const grid = snapshotGrid(this.terminal, {
-      trimRight: options?.trimRight,
-      includeStyles: options?.includeStyles,
-    });
-
-    const hash = fnv1a32(JSON.stringify(grid));
-    if (options?.captureFrame ?? true) {
-      this.captureFrame(grid.lines.join("\n"), hash);
-    }
-
-    return { grid, hash };
-  }
-
-  async snapshotCast(options?: { tailEvents?: number }): Promise<TraceSnapshot> {
-    await this.flush();
-    return this.trace.snapshot({ tailEvents: options?.tailEvents });
-  }
-
-  mark(label?: string): void {
-    this.trace.mark(label);
-  }
-
-  getSnapshotFrames(): SnapshotFrame[] {
-    return [...this.snapshotRing];
-  }
-
-  getRawOutputChunks(): string[] {
-    return [...this.rawOutputRing];
-  }
-
-  async waitForText(args: {
-    scope?: SnapshotScope;
-    text?: string;
-    regex?: RegExp;
-    timeoutMs: number;
-    intervalMs: number;
-  }): Promise<{ found: boolean; text: string; hash: string }> {
-    const startedAt = Date.now();
-    let closedSince: number | null = null;
-    while (Date.now() - startedAt <= args.timeoutMs) {
-      const snapshot = await this.snapshotText({ captureFrame: true, scope: args.scope });
-      if (args.text && snapshot.text.includes(args.text)) {
-        return { found: true, ...snapshot };
-      }
-      if (args.regex && args.regex.test(snapshot.text)) {
-        return { found: true, ...snapshot };
-      }
-
-      if (this.isClosed()) {
-        closedSince ??= Date.now();
-        const drainMs = Math.max(500, args.intervalMs * 4);
-        if (Date.now() - closedSince >= drainMs) {
-          break;
-        }
-      }
-
-      await sleep(args.intervalMs);
-    }
-
-    const snapshot = await this.snapshotText({ captureFrame: true, scope: args.scope });
-    return { found: false, ...snapshot };
-  }
-
-  async waitForStableScreen(args: {
-    quietMs: number;
-    timeoutMs: number;
-    intervalMs: number;
-  }): Promise<{ stable: boolean; text: string; hash: string }> {
-    const startedAt = Date.now();
-    let stableSince: number | null = null;
-    let lastHash: string | null = null;
-
-    while (Date.now() - startedAt <= args.timeoutMs) {
-      const snapshot = await this.snapshotText({ captureFrame: true });
-      if (snapshot.hash === lastHash) {
-        stableSince ??= Date.now();
-      } else {
-        stableSince = null;
-        lastHash = snapshot.hash;
-      }
-
-      if (stableSince !== null && Date.now() - stableSince >= args.quietMs) {
-        return { stable: true, ...snapshot };
-      }
-
-      await sleep(args.intervalMs);
-    }
-
-    const snapshot = await this.snapshotText({ captureFrame: true });
-    return { stable: false, ...snapshot };
-  }
-
-  close(): void {
-    if (this.closed === null) {
-      this.closed = { type: "closed_by_user" };
-    }
-    this.pty.kill();
-    for (const d of this.disposables) d.dispose();
-    this.terminal.dispose();
-  }
-
-  private enqueueWrite(data: string): void {
-    this.writeChain = this.writeChain.then(
-      () =>
-        new Promise<void>((resolve) => {
-          this.terminal.write(data, resolve);
-        }),
-    );
-  }
-
-  private appendRawOutput(data: string): void {
-    this.rawOutputRing.push(data);
-    if (this.rawOutputRing.length > 2000) {
-      this.rawOutputRing.splice(0, this.rawOutputRing.length - 2000);
-    }
-  }
-
-  private captureFrame(text: string, hash: string): void {
-    this.snapshotRing.push({ atMs: Date.now(), hash, text });
-    if (this.snapshotRing.length > this.snapshotRingSize) {
-      this.snapshotRing.splice(0, this.snapshotRing.length - this.snapshotRingSize);
-    }
-  }
-
-  private writePtySafely(data: string): void {
-    if (this.isClosed()) return;
-    try {
-      this.pty.write(data);
-    } catch {
-      // Ignore: PTY may have closed between trigger and response.
-    }
-  }
-
-  private handleCsiDsr(params: (number | number[])[]): boolean {
-    if (params.length !== 1) return false;
-
-    const raw = params[0];
-    const value = Array.isArray(raw) ? raw[0] : raw;
-    if (value === 5) {
-      this.writePtySafely(`${ESC}[0n`);
-      return true;
-    }
-
-    if (value !== 6) return false;
-
-    const meta = this.getMeta();
-    const row = meta.baseY + meta.cursorY - meta.viewportY + 1;
-    const col = meta.cursorX + 1;
-    this.writePtySafely(`${ESC}[${row};${col}R`);
-    return true;
-  }
-
-  private handleCsiDa(params: (number | number[])[]): boolean {
-    if (params.length > 1) return false;
-
-    const raw = params[0];
-    const value = raw === undefined ? 0 : Array.isArray(raw) ? raw[0] : raw;
-    if (value !== 0) return false;
-
-    this.writePtySafely(`${ESC}[?1;2c`);
-    return true;
-  }
-}
-
-type SnapshotTextOptions = {
-  scope?: SnapshotScope;
-  trimRight?: boolean;
-  trimBottom?: boolean;
-  maxLines?: number;
-  tailLines?: number;
-  captureFrame?: boolean;
-  mask?: TextMaskRule[];
-};
-
-function trimBottomEmptyLines(lines: string[]): string[] {
-  let end = lines.length;
-  while (end > 0 && lines[end - 1] === "") {
-    end -= 1;
-  }
-  return end === lines.length ? lines : lines.slice(0, end);
-}
-
-type SnapshotAnsiOptions = {
-  scope?: SnapshotScope;
-  trimRight?: boolean;
-  trimBottom?: boolean;
-  maxLines?: number;
-  tailLines?: number;
-  mask?: TextMaskRule[];
-};
-
-function trimBottomEmptyAnsiLines(lines: AnsiRenderedLine[]): AnsiRenderedLine[] {
-  let end = lines.length;
-  while (end > 0) {
-    const line = lines[end - 1];
-    const isBlank = !line?.hasStyle && (line?.plain ?? "").trim() === "";
-    if (!isBlank) break;
-    end -= 1;
-  }
-  return end === lines.length ? lines : lines.slice(0, end);
-}