mirror of https://github.com/openai/codex.git synced 2026-11-05 20:10:33 +00:00

Files

T

iceweasel-oai 9b33613db6 Terminate Windows process trees with job objects (#34624 )

## Why

Terminating a Windows execution session must also stop child processes, while a
normal root-process exit must continue to allow background descendants to run.

## What changed

- Assign Windows pipe, ConPTY, and sandbox processes to job objects and terminate
  the job when a session is cancelled, times out, or is explicitly stopped.
- Preserve descendants when the root process exits normally.
- Attach ConPTY and sandbox processes to their jobs atomically at creation; keep
  root-process termination as a fallback where job setup is unavailable.

## Testing

Added Windows coverage for descendant termination and preservation across pipe,
ConPTY, capture, cancellation, and legacy sandbox execution paths.

GitOrigin-RevId: 8f831f2fc4caaa7b79ce842a3ed7192bd02dd3b4

2026-07-21 22:07:09 +00:00

src

Terminate Windows process trees with job objects (#34624 )

2026-07-21 22:07:09 +00:00

BUILD.bazel

feat: add support for building with Bazel (#8875 )

2026-01-09 11:09:43 -08:00

Cargo.toml

Terminate Windows process trees with job objects (#34624 )

2026-07-21 22:07:09 +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