mirror of https://github.com/openai/codex.git synced 2026-08-31 14:28:48 +00:00

Files

viyatb-oai bf3eb2ec91 Prevent Unix PTY I/O from blocking runtime shutdown (#40460 )

## Why

Blocking PTY reads and output-channel sends can keep Tokio runtime shutdown
waiting when a detached child retains the terminal or output backpressure fills
the channel.

## What changed

- Drive Unix PTY reads and writes through nonblocking `AsyncFd` readiness so
  their tasks can be cancelled during shutdown.
- Keep draining child output after its receiver closes, and preserve queued
  input plus EOF delivery when portable PTY stdin closes.
- Return a descriptive error when PTY spawning uses a Tokio runtime without an
  I/O driver.

## Testing

Add Unix coverage for detached children, full and dropped output channels,
large input with EOF, inherited file descriptors, and runtimes without I/O.

GitOrigin-RevId: f7f1f58abebf8bf1d39285cd61b8d69946d54155

2026-08-24 19:25:32 +00:00

src

Prevent Unix PTY I/O from blocking runtime shutdown (#40460 )

2026-08-24 19:25:32 +00:00

tests

Prevent ConPTY DLL loading from the current directory (#39262 )

2026-08-18 19:09:33 +00:00

BUILD.bazel

…

Cargo.toml

Prevent Unix PTY I/O from blocking runtime shutdown (#40460 )

2026-08-24 19:25:32 +00:00

README.md

Prefer just test over cargo test in docs (#23910 )

2026-05-22 16:58:14 +00:00

README.md

codex-utils-pty

Lightweight helpers for spawning interactive processes either under a PTY (pseudo terminal) or regular pipes. The public API is minimal and mirrors both backends so callers can switch based on their needs (e.g., enabling or disabling TTY).

API surface

spawn_pty_process(program, args, cwd, env, arg0, size) → SpawnedProcess
spawn_pipe_process(program, args, cwd, env, arg0) → SpawnedProcess
spawn_pipe_process_no_stdin(program, args, cwd, env, arg0) → SpawnedProcess
combine_output_receivers(stdout_rx, stderr_rx) → broadcast::Receiver<Vec<u8>>
conpty_supported() → bool (Windows only; always true elsewhere)
TerminalSize { rows, cols } selects PTY dimensions in character cells.
ProcessHandle exposes:
- writer_sender() → mpsc::Sender<Vec<u8>> (stdin)
- resize(TerminalSize)
- close_stdin()
- has_exited(), exit_code(), terminate()
SpawnedProcess bundles session, stdout_rx, stderr_rx, and exit_rx (oneshot exit code).

Usage examples

use std::collections::HashMap;
use std::path::Path;
use codex_utils_pty::combine_output_receivers;
use codex_utils_pty::spawn_pty_process;
use codex_utils_pty::TerminalSize;

# tokio_test::block_on(async {
let env_map: HashMap<String, String> = std::env::vars().collect();
let spawned = spawn_pty_process(
    "bash",
    &["-lc".into(), "echo hello".into()],
    Path::new("."),
    &env_map,
    &None,
    TerminalSize::default(),
).await?;

let writer = spawned.session.writer_sender();
writer.send(b"exit\n".to_vec()).await?;

// Collect output until the process exits.
let mut output_rx = combine_output_receivers(spawned.stdout_rx, spawned.stderr_rx);
let mut collected = Vec::new();
while let Ok(chunk) = output_rx.try_recv() {
    collected.extend_from_slice(&chunk);
}
let exit_code = spawned.exit_rx.await.unwrap_or(-1);
# let _ = (collected, exit_code);
# anyhow::Ok(())
# });

Swap in spawn_pipe_process for a non-TTY subprocess; the rest of the API stays the same. Use spawn_pipe_process_no_stdin to force stdin closed (commands that read stdin will see EOF immediately).

Tests

Unit tests live in src/lib.rs and cover both backends (PTY Python REPL and pipe-based stdin roundtrip). Run with:

just test -p codex-utils-pty --no-capture