winx_code_agent/state/pty.rs
1//! Real PTY implementation using portable-pty
2//!
3//! This module provides a true pseudo-terminal interface for interactive
4//! shell sessions, enabling proper handling of:
5//! - ANSI escape sequences and colors
6//! - Interactive programs (sudo, vim, less, etc.)
7//! - Terminal resize events
8//! - Job control signals (Ctrl+C, Ctrl+Z, etc.)
9
10use anyhow::{anyhow, Context, Result};
11use portable_pty::{native_pty_system, Child, CommandBuilder, MasterPty, PtySize};
12use std::collections::hash_map::DefaultHasher;
13use std::hash::{Hash, Hasher};
14use std::io::{Read, Write};
15use std::path::{Path, PathBuf};
16use std::process::Command;
17use std::sync::mpsc::{self, TryRecvError};
18use std::sync::{Arc, Mutex as StdMutex};
19use std::thread;
20use std::time::{Duration, Instant};
21use tokio::sync::Mutex;
22use tracing::{debug, info, warn};
23
24use crate::state::line_ring::LineRing;
25use crate::state::live_terminal::{LiveTerminal, ScreenUpdate};
26
27/// Default terminal dimensions (columns x rows)
28pub const DEFAULT_COLS: u16 = 200;
29pub const DEFAULT_ROWS: u16 = 50;
30
31/// Maximum output buffer size to prevent memory issues
32const MAX_OUTPUT_SIZE: usize = 1_000_000;
33
34/// Cap on bytes streamed to one command's output-offload scratch file, so a
35/// command emitting gigabytes cannot fill the disk. The head beyond this is
36/// dropped (the agent still gets the first 50 MB plus the live tail).
37const SCRATCH_MAX_BYTES: u64 = 50 * 1024 * 1024;
38
39/// How many fully-formed lines to keep in the per-shell ringbuffer. Callers can
40/// ask for at most this many lines of historical context via
41/// `StatusCheck.scrollback_lines`.
42pub const RING_BUFFER_LINES: usize = 2_000;
43
44/// Cap on the unterminated tail held in `line_ring_partial`. Bounds memory when
45/// a program emits megabytes without ever printing a newline (a `\r`-redrawn
46/// progress bar, a binary blob). Generous enough to hold any real terminal line.
47const MAX_PARTIAL_LINE_BYTES: usize = 64 * 1024;
48
49/// WCGW-style prompt pattern for command completion detection
50const WCGW_PROMPT_PATTERN: &str = "◉";
51const WCGW_PROMPT_END: &str = "──➤";
52
53fn attachable_command(restricted_mode: bool) -> (CommandBuilder, Option<String>, bool) {
54 let requested = crate::config::env_text("WINX_ATTACH_TERMINAL")
55 .or_else(|| crate::config::env_text("WINX_USE_SCREEN"))
56 .unwrap_or_default();
57 if requested == "tmux"
58 || requested == "screen"
59 || crate::config::parse_bool(&requested) == Some(true)
60 {
61 let session = format!("winx-{}-{}", std::process::id(), timestamp_millis());
62 if requested == "tmux" && command_available("tmux") {
63 let mut cmd = CommandBuilder::new("tmux");
64 cmd.args(["new-session", "-A", "-s", &session, "bash"]);
65 if restricted_mode {
66 cmd.arg("-r");
67 }
68 return (cmd, Some(format!("tmux attach -t {session}")), false);
69 }
70 if command_available("screen") {
71 // Parity with wcgw: ensure a sane ~/.screenrc and reap sessions whose
72 // creating winx process has died before spawning a fresh one.
73 ensure_screenrc();
74 cleanup_orphaned_screens();
75 let mut cmd = CommandBuilder::new("screen");
76 cmd.args(["-q", "-S", &session, "bash"]);
77 if restricted_mode {
78 cmd.arg("-r");
79 }
80 return (cmd, Some(format!("screen -x {session}")), false);
81 }
82 }
83
84 let shell = preferred_shell(restricted_mode);
85 let is_zsh = shell == "zsh";
86 let mut cmd = CommandBuilder::new(&shell);
87 // zsh's restricted mode isn't the `-r` flag, so restricted always uses bash -r.
88 if restricted_mode && !is_zsh {
89 cmd.arg("-r");
90 }
91 (cmd, None, is_zsh)
92}
93
94/// Shell to spawn directly. Defaults to bash; honors `WINX_SHELL=zsh` when zsh is
95/// on PATH and we're not in restricted mode (zsh's restricted mode differs from
96/// `bash -r`, so restricted falls back to bash).
97fn preferred_shell(restricted_mode: bool) -> String {
98 if !restricted_mode {
99 if let Ok(requested) = std::env::var("WINX_SHELL") {
100 if requested == "zsh" && command_available("zsh") {
101 return "zsh".to_string();
102 }
103 }
104 }
105 "bash".to_string()
106}
107
108fn command_available(command: &str) -> bool {
109 Command::new("sh")
110 .args(["-c", &format!("command -v {command}")])
111 .output()
112 .is_ok_and(|output| output.status.success())
113}
114
115/// Create `~/.screenrc` with a large scrollback if the user has none, matching
116/// wcgw's `check_if_screen_command_available`. Never overwrites an existing file.
117fn ensure_screenrc() {
118 let Some(home) = home::home_dir() else {
119 return;
120 };
121 let screenrc = home.join(".screenrc");
122 if screenrc.exists() {
123 return;
124 }
125 let _ = std::fs::write(
126 &screenrc,
127 "defscrollback 10000\ntermcapinfo xterm* ti@:te@\nstartup_message off\n",
128 );
129}
130
131/// Reap detached `winx-*` screen sessions whose creating process is gone.
132///
133/// The session name embeds the creator PID (`winx-<pid>-<ts>`), so an orphan is
134/// simply a session whose `<pid>` no longer exists — the wcgw equivalent of
135/// detecting `parent_pid == 1`. Best-effort: any failure is silently ignored.
136fn cleanup_orphaned_screens() {
137 let Ok(output) = Command::new("screen").arg("-ls").output() else {
138 return;
139 };
140 // `screen -ls` exits non-zero when sessions exist, so we parse stdout regardless.
141 let listing = String::from_utf8_lossy(&output.stdout);
142 for line in listing.lines() {
143 let Some(session) = line.split_whitespace().next() else {
144 continue;
145 };
146 // session token looks like "<screen_pid>.winx-<creator_pid>-<ts>"
147 let Some((_, name)) = session.split_once('.') else {
148 continue;
149 };
150 if let Some(creator_pid) = winx_creator_pid(name) {
151 if !process_exists(creator_pid) {
152 let _ = Command::new("screen").args(["-S", session, "-X", "quit"]).output();
153 }
154 }
155 }
156}
157
158/// Extract the creator PID from a `winx-<pid>-<ts>` screen session name.
159fn winx_creator_pid(name: &str) -> Option<u32> {
160 name.strip_prefix("winx-")?.split('-').next()?.parse::<u32>().ok()
161}
162
163/// Whether a process with `pid` is currently alive. `kill(pid, 0)` is portable
164/// across supported Unix platforms and sends no signal.
165#[cfg(unix)]
166fn process_exists(pid: u32) -> bool {
167 crate::os::unix::process_exists(pid)
168}
169
170#[cfg(not(unix))]
171fn process_exists(pid: u32) -> bool {
172 std::path::Path::new("/proc").join(pid.to_string()).exists()
173}
174
175fn timestamp_millis() -> u128 {
176 std::time::SystemTime::now()
177 .duration_since(std::time::UNIX_EPOCH)
178 .map_or(0, |duration| duration.as_millis())
179}
180
181/// Real PTY-based interactive shell
182///
183/// Uses portable-pty for true pseudo-terminal functionality,
184/// enabling proper handling of interactive programs like sudo, vim, etc.
185pub struct PtyShell {
186 /// The PTY master handle for resize operations
187 master: Box<dyn MasterPty + Send>,
188 /// Child process running the shell
189 child: Box<dyn Child + Send + Sync>,
190 /// Writer for PTY input (taken from master)
191 writer: Box<dyn Write + Send>,
192 /// Channel receiver for output from reader thread
193 output_rx: mpsc::Receiver<String>,
194 /// Current terminal size
195 size: PtySize,
196 /// Last command executed
197 pub last_command: String,
198 /// Accumulated output buffer
199 pub output_buffer: String,
200 /// Whether a command is currently running
201 pub command_running: bool,
202 /// Last cwd observed in this shell's nonce-bearing prompt.
203 current_cwd: PathBuf,
204 /// Monotonic start time of the current or most recently completed command.
205 /// Status polling uses this instead of restarting the clock per tool call.
206 command_started_at: Option<Instant>,
207 /// Monotonic command generation used by daemon journals to distinguish two
208 /// consecutive commands whose terminal bytes happen to be identical.
209 command_generation: u64,
210 /// Random identity of this PTY instance. Unlike the numeric generation it
211 /// changes when a shell is reset and generations start again at zero.
212 incarnation: u64,
213 /// Exit code of the last completed foreground command, parsed from the prompt
214 /// marker (`──➤<nonce>:<code>`). `None` until a command finishes, and reset
215 /// to `None` while one is running.
216 pub last_exit_code: Option<i32>,
217 /// Maximum output size before truncation
218 max_output_size: usize,
219 /// Flag for output truncation
220 pub output_truncated: bool,
221 /// Bounded scrollback ring of raw PTY lines (newest at the back) plus the
222 /// in-flight partial line, with drop accounting so a truncated scrollback is
223 /// reported to the caller instead of silently shrinking. See `LineRing`.
224 ring: LineRing,
225 /// Hash of the last rendered output we shipped to the caller. Used by the
226 /// delta path in `status_check` to elide repeats when the screen is idle.
227 pub last_returned_hash: Option<u64>,
228 /// Cumulative PTY snapshot already delivered to the caller. Incremental
229 /// status polling diffs against this value, then advances it after rendering.
230 delivered_output: String,
231 /// Optional command a human can run to attach to the same terminal session.
232 pub attach_hint: Option<String>,
233 /// The exact suffix that ends this shell's prompt: `──➤<nonce>`. The nonce is
234 /// a per-shell random value embedded in `PROMPT_COMMAND`, so command output
235 /// can't impersonate the prompt (printing `◉ x──➤` no longer ends a command
236 /// early). Anchoring completion on this instead of the bare glyphs removes
237 /// the false-positive that truncated output when a program echoed them.
238 prompt_end_marker: String,
239 /// Live terminal emulator (fixed-viewport, `vt100`-backed) fed continuously
240 /// by the reader thread. Unlike the scrollback ring (raw lines), it keeps a
241 /// consolidated screen grid — cursor moves, redraws, alternate-screen
242 /// applied — so a TUI yields a stable, non-stacked snapshot. The fixed
243 /// viewport is what lets inline-rendering TUIs (the `agy`/Antigravity CLI,
244 /// which redraws with cursor-up + erase-line in the main screen) consolidate
245 /// instead of ghosting. See `live_snapshot`.
246 live: Arc<StdMutex<LiveTerminal>>,
247 /// Workspace root under which output-offload scratch files are written.
248 /// `None` until a caller sets it (the workspace is only known after
249 /// Initialize, and `execute_command` sets it per command). See
250 /// `crate::utils::scratch_file`.
251 scratch_workspace_root: Option<PathBuf>,
252 /// Scratch file holding the CURRENT command's dropped output head, created
253 /// lazily on the first truncation and reset per command.
254 scratch_path: Option<PathBuf>,
255 /// Bytes already streamed to `scratch_path`, used to enforce `SCRATCH_MAX_BYTES`.
256 scratch_bytes: u64,
257}
258
259impl std::fmt::Debug for PtyShell {
260 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
261 f.debug_struct("PtyShell")
262 .field("size", &format!("{}x{}", self.size.cols, self.size.rows))
263 .field("last_command", &self.last_command)
264 .field("command_running", &self.command_running)
265 .field("current_cwd", &self.current_cwd)
266 .field("output_truncated", &self.output_truncated)
267 .field("output_buffer_len", &self.output_buffer.len())
268 .field("attach_hint", &self.attach_hint)
269 .finish_non_exhaustive()
270 }
271}
272
273/// Resolve the process group to signal for a PTY child, but ONLY when it is
274/// safe: the pid must be a real child (`> 1`) that leads its own group
275/// (`getpgid(pid) == pid`). portable-pty `setsid`s the shell, so a live PTY
276/// child is always its own group leader; if that ever stopped holding,
277/// `kill(-pgid, ...)` would hit some unrelated group, so we refuse instead of
278/// guessing.
279///
280/// The `pid > 1` check is load-bearing: `kill(-1, ...)` means "every process I
281/// may signal" and `kill(0, ...)` means "my own group" - either would be
282/// catastrophic from a teardown path.
283#[cfg(unix)]
284fn killable_group(pid: u32) -> Option<i32> {
285 crate::os::unix::owned_process_group(pid)
286}
287
288/// Send `signal` to the whole process group `pgid` (group-kill via negative
289/// pid). `pgid` must be one vetted by [`killable_group`].
290#[cfg(unix)]
291fn signal_group(pgid: i32, signal: i32) {
292 let _ = crate::os::unix::signal_group(pgid, signal);
293}
294
295impl Drop for PtyShell {
296 /// Kill and reap the shell child **and its whole process group** so neither
297 /// the shell nor anything it spawned leaks.
298 ///
299 /// `std::process::Child::drop` neither kills nor waits, and even
300 /// `Child::kill` signals only the shell itself: a background job it started
301 /// (`npm run dev &`, a `nohup`'d server) would be reparented to init and live
302 /// on. Because portable-pty runs the shell as a session/group leader, we can
303 /// signal the whole group with a negative pid - SIGTERM first so well-behaved
304 /// children can clean up, then `Child::kill` (SIGKILL on the leader, which
305 /// closes the PTY slave so the reader thread's `read()` returns EOF and the
306 /// thread exits), then SIGKILL the group to sweep anything still alive, then
307 /// reap. The pgid is captured while the leader is alive and reused: it stays
308 /// valid until we `wait()`, even after the leader dies. All best-effort.
309 fn drop(&mut self) {
310 // Only group-kill the direct bash/zsh path. Under screen/tmux (`attach_hint`
311 // is `Some`) the `Child` is a multiplexer *client*; the real shell runs in
312 // a detached daemon in another process group, so a group-kill here would
313 // miss the shell entirely and could disturb unrelated sessions of the same
314 // multiplexer. Let the multiplexer own its lifecycle in that case.
315 #[cfg(unix)]
316 let pgid = if self.attach_hint.is_some() {
317 None
318 } else {
319 self.child.process_id().and_then(killable_group)
320 };
321
322 #[cfg(unix)]
323 if let Some(pgid) = pgid {
324 signal_group(pgid, libc::SIGTERM);
325 }
326
327 // SIGKILL the leader and close the PTY slave (unblocks the reader thread).
328 let _ = self.child.kill();
329
330 #[cfg(unix)]
331 if let Some(pgid) = pgid {
332 signal_group(pgid, libc::SIGKILL);
333 }
334
335 let _ = self.child.wait();
336 }
337}
338
339impl PtyShell {
340 /// Create a new PTY shell session
341 ///
342 /// # Arguments
343 /// * `initial_dir` - Starting directory for the shell
344 /// * `restricted_mode` - Whether to use bash restricted mode (-r)
345 ///
346 /// # Returns
347 /// A new `PtyShell` instance with an active bash session
348 pub fn new(initial_dir: &Path, restricted_mode: bool) -> Result<Self> {
349 Self::new_with_agent_paths(initial_dir, restricted_mode, None, None)
350 }
351
352 /// Create a PTY with Winx's stable workspace and managed helper paths in
353 /// the child environment. Direct callers keep using [`Self::new`].
354 pub(crate) fn new_with_agent_paths(
355 initial_dir: &Path,
356 restricted_mode: bool,
357 workspace_root: Option<&Path>,
358 temporary_artifact_dir: Option<&Path>,
359 ) -> Result<Self> {
360 info!(
361 "Creating new PTY shell (restricted: {}) in {}",
362 restricted_mode,
363 initial_dir.display()
364 );
365
366 // Initialize the native PTY system
367 let pty_system = native_pty_system();
368
369 // Configure terminal size
370 let size =
371 PtySize { rows: DEFAULT_ROWS, cols: DEFAULT_COLS, pixel_width: 0, pixel_height: 0 };
372
373 // Open the PTY pair (master + slave)
374 let pair = pty_system.openpty(size).context("Failed to open PTY pair")?;
375
376 // Build the command
377 let (mut cmd, attach_hint, is_zsh) = attachable_command(restricted_mode);
378
379 // Set up environment for proper terminal behavior
380 cmd.env("TERM", "xterm-256color");
381 cmd.env("COLORTERM", "truecolor");
382 cmd.env("PAGER", "cat");
383 cmd.env("GIT_PAGER", "cat");
384 cmd.env("COLUMNS", DEFAULT_COLS.to_string());
385 cmd.env("ROWS", DEFAULT_ROWS.to_string());
386 if let Some(workspace_root) = workspace_root {
387 cmd.env("WINX_WORKSPACE_ROOT", workspace_root);
388 }
389 if let Some(temporary_artifact_dir) = temporary_artifact_dir {
390 cmd.env("WINX_TEMP_DIR", temporary_artifact_dir);
391 }
392 // Per-shell random nonce embedded in the prompt so command output can't
393 // forge the completion marker. 64 bits of entropy in hex.
394 let nonce = format!("{:016x}", rand::random::<u64>());
395 // WCGW-style prompt for command completion detection
396 // Note: removed \r\e[2K which was erasing the prompt before it could be detected
397 // `__winx_ec=$?` captures the user command's exit status as the very
398 // first thing PROMPT_COMMAND does, then we print it after the marker.
399 cmd.env(
400 "PROMPT_COMMAND",
401 format!(r#"__winx_ec=$?; printf "◉ %s──➤{nonce}:%s " "$PWD" "$__winx_ec""#),
402 );
403 cmd.cwd(initial_dir);
404
405 // Spawn bash in the PTY slave
406 let child = pair.slave.spawn_command(cmd).context("Failed to spawn bash in PTY")?;
407
408 // Get reader and writer from master
409 let mut reader = pair.master.try_clone_reader().context("Failed to clone PTY reader")?;
410 let writer = pair.master.take_writer().context("Failed to take PTY writer")?;
411
412 // Bounded channel: if the consumer stalls, the reader thread blocks on
413 // send (natural backpressure via the PTY OS buffer) instead of growing
414 // memory without bound on a runaway producer like `yes`.
415 let (output_tx, output_rx) = mpsc::sync_channel::<String>(1024);
416
417 // Live terminal emulator, shared with the reader thread so the screen
418 // grid stays current without any consumer needing to poll.
419 let live = Arc::new(StdMutex::new(LiveTerminal::new(DEFAULT_ROWS, DEFAULT_COLS)));
420 let live_reader = Arc::clone(&live);
421
422 // Spawn a background thread to read from the PTY
423 // This prevents blocking the main thread
424 thread::spawn(move || {
425 let mut buf = [0u8; 4096];
426 // Bytes of an incomplete trailing UTF-8 char held back for the next
427 // read. Without this, a multibyte glyph split across a 4096-byte read
428 // boundary would decode to two U+FFFDs — corrupting the output buffer
429 // and the prompt/CWD detection that runs over it.
430 let mut carry: Vec<u8> = Vec::new();
431 loop {
432 match reader.read(&mut buf) {
433 Ok(0) => {
434 // EOF - PTY closed. Flush any held bytes lossily.
435 if !carry.is_empty() {
436 let _ = output_tx.send(String::from_utf8_lossy(&carry).into_owned());
437 }
438 break;
439 }
440 Ok(n) => {
441 // Tap the raw bytes into the live emulator first (brief
442 // lock; feed is O(chunk len)). Feeding bytes — not the
443 // lossy String — keeps the persistent VTE parser exact
444 // across chunk boundaries. Recover from a poisoned lock
445 // instead of dropping the feed silently.
446 {
447 let mut emu = live_reader
448 .lock()
449 .unwrap_or_else(std::sync::PoisonError::into_inner);
450 emu.feed(&buf[..n]);
451 }
452 // Decode the longest valid prefix; carry an incomplete
453 // trailing char into the next read.
454 carry.extend_from_slice(&buf[..n]);
455 let (chunk, rest) = decode_keep_incomplete(&carry);
456 carry = rest;
457 if !chunk.is_empty() && output_tx.send(chunk).is_err() {
458 // Receiver dropped, exit thread
459 break;
460 }
461 }
462 Err(e) => {
463 debug!("PTY reader thread error: {}", e);
464 break;
465 }
466 }
467 }
468 debug!("PTY reader thread exiting");
469 });
470
471 // Create the shell instance
472 let mut shell = Self {
473 master: pair.master,
474 child,
475 writer,
476 output_rx,
477 size,
478 last_command: String::new(),
479 output_buffer: String::new(),
480 command_running: false,
481 current_cwd: initial_dir.to_path_buf(),
482 command_started_at: None,
483 command_generation: 0,
484 incarnation: rand::random::<u64>().max(1),
485 last_exit_code: None,
486 max_output_size: MAX_OUTPUT_SIZE,
487 output_truncated: false,
488 ring: LineRing::new(RING_BUFFER_LINES, MAX_PARTIAL_LINE_BYTES),
489 last_returned_hash: None,
490 delivered_output: String::new(),
491 attach_hint,
492 prompt_end_marker: format!("{WCGW_PROMPT_END}{nonce}"),
493 live,
494 scratch_workspace_root: None,
495 scratch_path: None,
496 scratch_bytes: 0,
497 };
498
499 // Initialize the shell with WCGW-style prompt
500 shell.initialize_prompt(is_zsh, &nonce)?;
501
502 debug!("PTY shell created successfully");
503 Ok(shell)
504 }
505
506 /// Initialize the shell prompt for WCGW compatibility
507 fn initialize_prompt(&mut self, is_zsh: bool, nonce: &str) -> Result<()> {
508 // Set up the dynamic prompt - matches WCGW Python PROMPT_STATEMENT.
509 // zsh ignores PROMPT_COMMAND, so it gets a precmd hook with a blanked
510 // default prompt instead.
511 // Blank the shell's own PS1/PROMPT so the line ends exactly at our `──➤`
512 // marker. Otherwise a user's ~/.bashrc/~/.zshrc PS1 (e.g. `[user@host]$`)
513 // is appended after the marker, and prompt detection — which anchors on a
514 // trailing `──➤` — only fires when the chunk happens to fragment right
515 // before the PS1, making command-completion detection flaky.
516 let prompt_statement = if is_zsh {
517 // Clear precmd_functions too: frameworks (oh-my-zsh/p10k) register the
518 // prompt via that array, so redefining `precmd` alone leaves their
519 // prompt in place and our `──➤` marker never ends the line.
520 format!(
521 r#"export GIT_PAGER=cat PAGER=cat; precmd_functions=(); preexec_functions=(); PROMPT=''; RPROMPT=''; precmd() {{ local __winx_ec=$?; printf "◉ %s──➤{nonce}:%s " "$PWD" "$__winx_ec" }}"#
522 )
523 } else {
524 format!(
525 r#"export GIT_PAGER=cat PAGER=cat PROMPT_COMMAND='__winx_ec=$?; printf "◉ %s──➤{nonce}:%s " "$PWD" "$__winx_ec"'; PS1=''"#
526 )
527 };
528
529 self.write_command(&prompt_statement)?;
530
531 // Wait for prompt to be ready
532 std::thread::sleep(Duration::from_millis(100));
533 let _ = self.drain_output();
534
535 Ok(())
536 }
537
538 /// Write a command to the PTY, submitting it with a carriage return.
539 fn write_command(&mut self, command: &str) -> Result<()> {
540 // Submit with `\r`, matching the foreground path (`send_special_key("Enter")`
541 // also sends `\r`) and a real terminal's Enter key. The two paths used to
542 // disagree — background sent `\n` here, foreground sent `\r` — which is a
543 // real difference for readline-based TUIs. bash's canonical line discipline
544 // maps CR to NL (ICRNL), so plain commands behave identically.
545 let cmd_with_newline = format!("{command}\r");
546 self.writer.write_all(cmd_with_newline.as_bytes()).context("Failed to write to PTY")?;
547 self.writer.flush().context("Failed to flush PTY")?;
548 Ok(())
549 }
550
551 /// Drain any pending output from the PTY channel
552 fn drain_output(&mut self) -> String {
553 let mut output = String::new();
554 let deadline = Instant::now() + Duration::from_millis(200);
555
556 // Drain all available output from the channel
557 while Instant::now() < deadline {
558 match self.output_rx.try_recv() {
559 Ok(chunk) => {
560 output.push_str(&chunk);
561
562 // Prevent runaway reads
563 if output.len() > self.max_output_size {
564 self.output_truncated = true;
565 break;
566 }
567 }
568 Err(TryRecvError::Empty) => {
569 // No more data, wait briefly for more
570 thread::sleep(Duration::from_millis(10));
571 }
572 Err(TryRecvError::Disconnected) => {
573 // Reader thread died
574 break;
575 }
576 }
577 }
578
579 output
580 }
581
582 /// Send a command to the shell and start reading output
583 pub fn send_command(&mut self, command: &str) -> Result<()> {
584 debug!(bytes = command.len(), "PTY sending command");
585
586 // Clear previous state
587 self.output_buffer.clear();
588 self.output_truncated = false;
589 self.reset_scratch();
590 self.last_command = command.to_string();
591 self.command_running = true;
592 self.mark_command_started();
593 self.last_exit_code = None;
594 // A new command means the next status_check should return whatever
595 // shows up — drop the dedup hash so we don't elide the first response.
596 self.last_returned_hash = None;
597 self.delivered_output.clear();
598
599 // Write the command
600 self.write_command(command)?;
601
602 Ok(())
603 }
604
605 /// Start the monotonic runtime clock for a newly submitted command.
606 pub fn mark_command_started(&mut self) {
607 self.command_generation = self.command_generation.saturating_add(1);
608 self.command_started_at = Some(Instant::now());
609 }
610
611 pub fn command_generation(&self) -> u64 {
612 self.command_generation
613 }
614
615 pub fn incarnation(&self) -> u64 {
616 self.incarnation
617 }
618
619 /// Elapsed runtime since the current command was submitted.
620 pub fn command_elapsed(&self) -> Option<Duration> {
621 self.command_started_at.map(|started_at| started_at.elapsed())
622 }
623
624 /// Current working directory last reported by this shell's prompt.
625 pub fn current_cwd(&self) -> &Path {
626 &self.current_cwd
627 }
628
629 /// Snapshot used as the left-hand side of incremental output rendering.
630 pub fn delivered_output(&self) -> String {
631 self.delivered_output.clone()
632 }
633
634 /// Mark the cumulative output snapshot as delivered after rendering it.
635 pub fn mark_output_delivered(&mut self, output: &str) {
636 self.delivered_output.clear();
637 self.delivered_output.push_str(output);
638 }
639
640 /// Return up to `lines` recent lines from the scrollback ring, oldest
641 /// first. When older lines were evicted or a long unterminated line was
642 /// clipped, a `[winx: …]` notice is prepended so the caller knows the
643 /// scrollback is incomplete rather than silently receiving less than asked.
644 pub fn collect_scrollback(&self, lines: usize) -> String {
645 // The ring holds raw PTY lines. Replay them through the terminal
646 // emulator so cursor movements (readline echo, in-place redraws) are
647 // *applied* — not merely stripped — yielding what the screen actually
648 // showed. A plain strip can't undo a `\x1b[D`, so it would leave
649 // `>>> p>>> pr>>> pri...` echo noise behind; the emulator collapses it.
650 let rendered =
651 crate::state::terminal::render_terminal_output(&self.ring.raw(lines)).join("\n");
652 match self.ring.scrollback_notice(lines) {
653 Some(notice) => format!("{notice}\n{rendered}"),
654 None => rendered,
655 }
656 }
657
658 /// Hash arbitrary rendered output into a u64 dedup key.
659 pub fn fingerprint(text: &str) -> u64 {
660 let mut hasher = DefaultHasher::new();
661 text.hash(&mut hasher);
662 hasher.finish()
663 }
664
665 /// Read output from the PTY with timeout
666 ///
667 /// Returns (output, `is_complete`) tuple where `is_complete` indicates
668 /// whether the command has finished (prompt detected)
669 pub fn read_output(&mut self, timeout_secs: f32) -> Result<(String, bool)> {
670 let timeout = Duration::from_secs_f32(timeout_secs.clamp(0.1, 60.0));
671 let start = Instant::now();
672 let mut complete = false;
673 let mut no_data_count = 0;
674 let mut prompt_detected_at: Option<Instant> = None;
675
676 while start.elapsed() < timeout {
677 match self.output_rx.try_recv() {
678 Ok(chunk) => {
679 self.output_buffer.push_str(&chunk);
680 self.ring.push_chunk(&chunk);
681 no_data_count = 0;
682
683 // Check for WCGW prompt indicating command completion
684 if prompt_detected_at.is_none()
685 && (Self::check_prompt_complete(&chunk, &self.prompt_end_marker)
686 || Self::check_prompt_complete(
687 &self.output_buffer,
688 &self.prompt_end_marker,
689 ))
690 {
691 prompt_detected_at = Some(Instant::now());
692 debug!("Prompt detected, draining remaining output...");
693 }
694
695 // Truncate if too large (offloads the dropped head to scratch).
696 self.truncate_output_buffer_with_offload();
697 }
698 Err(TryRecvError::Empty) => {
699 // No data available, wait briefly
700 thread::sleep(Duration::from_millis(10));
701 no_data_count += 1;
702
703 // If prompt was detected, check if we've drained long enough
704 if let Some(detected_time) = prompt_detected_at {
705 // Wait 100ms after prompt detection to capture any trailing output
706 if detected_time.elapsed() > Duration::from_millis(100) {
707 complete = true;
708 debug!("Command completed - prompt detected and drained");
709 break;
710 }
711 } else if no_data_count > 10
712 && Self::check_prompt_complete(&self.output_buffer, &self.prompt_end_marker)
713 {
714 // Prompt detected during empty reads
715 prompt_detected_at = Some(Instant::now());
716 debug!("Prompt detected after wait, draining...");
717 }
718 }
719 Err(TryRecvError::Disconnected) => {
720 // Reader thread died - PTY closed
721 warn!("PTY reader disconnected");
722 complete = true;
723 break;
724 }
725 }
726 }
727
728 if complete || prompt_detected_at.is_some() {
729 self.command_running = false;
730 self.last_exit_code =
731 Self::parse_prompt_exit_code(&self.output_buffer, &self.prompt_end_marker);
732 self.update_current_cwd_from_prompt();
733 complete = true;
734 }
735
736 Ok((self.output_buffer.clone(), complete))
737 }
738
739 /// Non-blocking drain of whatever the reader thread has already queued.
740 ///
741 /// Unlike [`read_output`](Self::read_output), this never sleeps: it consumes
742 /// every chunk currently available, updates prompt/completion state, and
743 /// returns immediately. `prune_finished_shells` uses it so the global
744 /// background-shell lock is never held across a blocking 100ms `read_output`.
745 /// Returns `true` if the command has completed (prompt seen or PTY closed).
746 pub fn poll_output_nonblocking(&mut self) -> bool {
747 let mut prompt_seen = false;
748 loop {
749 match self.output_rx.try_recv() {
750 Ok(chunk) => {
751 let chunk_has_prompt =
752 Self::check_prompt_complete(&chunk, &self.prompt_end_marker);
753 self.output_buffer.push_str(&chunk);
754 self.ring.push_chunk(&chunk);
755 if chunk_has_prompt
756 || Self::check_prompt_complete(&self.output_buffer, &self.prompt_end_marker)
757 {
758 prompt_seen = true;
759 }
760 self.truncate_output_buffer_with_offload();
761 }
762 Err(TryRecvError::Empty) => break,
763 Err(TryRecvError::Disconnected) => {
764 self.command_running = false;
765 return true;
766 }
767 }
768 }
769 if prompt_seen {
770 self.command_running = false;
771 self.last_exit_code =
772 Self::parse_prompt_exit_code(&self.output_buffer, &self.prompt_end_marker);
773 self.update_current_cwd_from_prompt();
774 }
775 // Completion is state, not an edge. Another consumer (notably the
776 // background reaper) may have drained the prompt first; a later poll
777 // must still report the already-idle shell as complete even when this
778 // particular drain saw no new prompt bytes.
779 !self.command_running
780 }
781
782 fn update_current_cwd_from_prompt(&mut self) {
783 let Some(last) =
784 self.output_buffer.lines().rev().find(|line| line.contains(&self.prompt_end_marker))
785 else {
786 return;
787 };
788 let clean = crate::state::terminal::strip_ansi_codes(last);
789 let Some((before_marker, _)) = clean.rsplit_once(&self.prompt_end_marker) else {
790 return;
791 };
792 let Some((_, cwd)) = before_marker.rsplit_once("◉ ") else {
793 return;
794 };
795 let cwd = cwd.trim();
796 if !cwd.is_empty() {
797 self.current_cwd = PathBuf::from(cwd);
798 }
799 }
800
801 /// Snapshot of the accumulated output buffer — the same text `read_output`
802 /// returns. Lets callers poll non-blocking (`poll_output_nonblocking`) and
803 /// grab the buffer once at the end instead of cloning it on every slice.
804 pub fn output_snapshot(&self) -> String {
805 self.output_buffer.clone()
806 }
807
808 /// Check if the output ends with this shell's prompt.
809 ///
810 /// `prompt_end` is the per-shell `──➤<nonce>` suffix. Anchoring on the LAST
811 /// non-empty line (not a global `contains`) plus the random nonce means
812 /// command output that happens to print the prompt glyphs mid-stream — or
813 /// even a forged `◉ x──➤ ` at end of line — can't be mistaken for the prompt
814 /// and truncate output or end the command early.
815 fn check_prompt_complete(text: &str, prompt_end: &str) -> bool {
816 Self::parse_prompt_exit_code(text, prompt_end).is_some()
817 }
818
819 /// If the last non-empty line is this shell's completion prompt
820 /// (`◉ <pwd>──➤<nonce>:<code>`), return the exit code that follows the
821 /// marker. Returns `None` when the prompt isn't present — which is exactly
822 /// "the command is still running". The per-shell nonce plus the structured
823 /// `:<digits>` suffix keep command output from forging completion.
824 fn parse_prompt_exit_code(text: &str, prompt_end: &str) -> Option<i32> {
825 let last = text.lines().rev().find(|line| !line.trim().is_empty())?;
826 // Strip ANSI so a trailing erase/cursor sequence after the code
827 // (e.g. ":0 \x1b[K") doesn't defeat the suffix check.
828 let clean = crate::state::terminal::strip_ansi_codes(last);
829 let clean = clean.trim_end();
830 if !clean.contains(WCGW_PROMPT_PATTERN) {
831 return None;
832 }
833 // Everything after the last "──➤<nonce>" must be ":<digits>" and nothing
834 // else — this confirms the prompt ends the line AND yields the code.
835 let after = clean.rsplit_once(prompt_end)?.1;
836 after.strip_prefix(':')?.trim().parse::<i32>().ok()
837 }
838
839 /// Point output-offload scratch files at `root` (the workspace). Idempotent;
840 /// callers set it per command so it always tracks the current workspace.
841 pub fn set_scratch_root(&mut self, root: &Path) {
842 self.scratch_workspace_root = Some(root.to_path_buf());
843 }
844
845 /// The scratch file holding the current command's dropped output head, if any
846 /// was offloaded this command.
847 pub fn scratch_path(&self) -> Option<&Path> {
848 self.scratch_path.as_deref()
849 }
850
851 /// Forget the current command's scratch file so the next command starts a
852 /// fresh one. Does not delete the file (pruned later by age).
853 pub fn reset_scratch(&mut self) {
854 self.scratch_path = None;
855 self.scratch_bytes = 0;
856 }
857
858 /// Append a just-dropped output `head` to the per-command scratch file so the
859 /// agent can recover it via `ReadFiles`. Best-effort: needs a known workspace
860 /// root, stops at `SCRATCH_MAX_BYTES`, and swallows IO errors.
861 fn offload_dropped_head(&mut self, head: &str) {
862 let Some(root) = self.scratch_workspace_root.clone() else {
863 return;
864 };
865 // Clamp to the remaining byte budget so the file honors SCRATCH_MAX_BYTES
866 // exactly (a single head can be up to keep_size, ~500 KB). Snap to a char
867 // boundary so we never slice mid-UTF-8.
868 let remaining = SCRATCH_MAX_BYTES.saturating_sub(self.scratch_bytes);
869 if remaining == 0 {
870 return;
871 }
872 let head = match usize::try_from(remaining) {
873 Ok(rem) if rem < head.len() => &head[..crate::utils::floor_char_boundary(head, rem)],
874 _ => head,
875 };
876 if self.scratch_path.is_none() {
877 self.scratch_path = crate::utils::scratch_file::new_scratch_path(&root);
878 }
879 let Some(path) = self.scratch_path.clone() else {
880 return;
881 };
882 match crate::utils::scratch_file::append_scratch(&path, head.as_bytes()) {
883 Ok(0) if self.scratch_bytes == 0 => self.scratch_path = None,
884 Ok(written) => {
885 self.scratch_bytes = self.scratch_bytes.saturating_add(written as u64);
886 }
887 Err(e) => debug!("scratch: append to {} failed: {e}", path.display()),
888 }
889 }
890
891 /// Once `output_buffer` exceeds the cap, offload the head about to be dropped
892 /// to the scratch file, then keep only the tail with a truncation marker.
893 /// Shared by the blocking and non-blocking drain paths so the offload and the
894 /// char-boundary handling live in one place.
895 fn truncate_output_buffer_with_offload(&mut self) {
896 if self.output_buffer.len() <= self.max_output_size {
897 return;
898 }
899 self.output_truncated = true;
900 let keep_size = self.max_output_size / 2;
901 // Snap to a char boundary: a raw byte offset can land mid-UTF-8
902 // (CJK/emoji/box-drawing/the prompt glyphs) and slicing there would panic.
903 let cut = crate::utils::floor_char_boundary(
904 &self.output_buffer,
905 self.output_buffer.len() - keep_size,
906 );
907 let head = self.output_buffer[..cut].to_owned();
908 self.offload_dropped_head(&head);
909 // Replace the dropped head in place instead of `format!`-ing a brand-new
910 // String: `replace_range` shifts the kept tail down once and reuses the
911 // buffer's allocation. `cut` is already a char boundary (above), and 0 is
912 // always one, so the range is valid.
913 self.output_buffer.replace_range(..cut, "\n(...output truncated...)\n");
914 }
915
916 /// Send Ctrl+C (interrupt) to the PTY
917 pub fn send_interrupt(&mut self) -> Result<()> {
918 debug!("PTY sending Ctrl+C");
919 self.writer
920 .write_all(&[0x03]) // ASCII ETX (Ctrl+C)
921 .context("Failed to send Ctrl+C")?;
922 self.writer.flush()?;
923 Ok(())
924 }
925
926 /// Send Ctrl+D (EOF) to the PTY
927 pub fn send_eof(&mut self) -> Result<()> {
928 debug!("PTY sending Ctrl+D");
929 self.writer
930 .write_all(&[0x04]) // ASCII EOT (Ctrl+D)
931 .context("Failed to send Ctrl+D")?;
932 self.writer.flush()?;
933 Ok(())
934 }
935
936 /// Send Ctrl+Z (suspend) to the PTY
937 pub fn send_suspend(&mut self) -> Result<()> {
938 debug!("PTY sending Ctrl+Z");
939 self.writer
940 .write_all(&[0x1A]) // ASCII SUB (Ctrl+Z)
941 .context("Failed to send Ctrl+Z")?;
942 self.writer.flush()?;
943 Ok(())
944 }
945
946 /// Send text directly to the PTY (for interactive input)
947 pub fn send_text(&mut self, text: &str) -> Result<()> {
948 debug!(bytes = text.len(), "PTY sending text");
949 self.send_bytes(text.as_bytes()).context("Failed to send text")?;
950 Ok(())
951 }
952
953 /// Send raw bytes directly to the PTY.
954 pub fn send_bytes(&mut self, bytes: &[u8]) -> Result<()> {
955 self.writer.write_all(bytes).context("Failed to send bytes")?;
956 self.writer.flush()?;
957 Ok(())
958 }
959
960 /// Send a special key sequence
961 pub fn send_special_key(&mut self, key: &str) -> Result<()> {
962 let bytes: &[u8] = match key {
963 "Enter" => b"\r",
964 "Tab" => b"\t",
965 "Backspace" => b"\x7F",
966 "Escape" => b"\x1B",
967 "Up" | "KeyUp" => b"\x1B[A",
968 "Down" | "KeyDown" => b"\x1B[B",
969 "Right" | "KeyRight" => b"\x1B[C",
970 "Left" | "KeyLeft" => b"\x1B[D",
971 "Home" => b"\x1B[H",
972 "End" => b"\x1B[F",
973 "PageUp" => b"\x1B[5~",
974 "PageDown" => b"\x1B[6~",
975 "Delete" => b"\x1B[3~",
976 "Insert" => b"\x1B[2~",
977 "CtrlC" | "Ctrl-C" => b"\x03",
978 "CtrlD" | "Ctrl-D" => b"\x04",
979 "CtrlZ" | "Ctrl-Z" => b"\x1A",
980 "CtrlL" | "Ctrl-L" => b"\x0C",
981 _ => return Err(anyhow!("Unknown special key: {key}")),
982 };
983
984 debug!("PTY sending special key: {} ({:?})", key, bytes);
985 self.send_bytes(bytes)?;
986 Ok(())
987 }
988
989 /// Snapshot the live terminal screen — a stable, consolidated view of what a
990 /// human would currently see, with cursor moves/redraws applied and ANSI
991 /// stripped. `max_lines` of 0 returns the full screen buffer. This is the
992 /// foundation for piloting interactive TUIs (the `claude` CLI, vim, ...).
993 pub fn live_snapshot(&self, max_lines: usize) -> Vec<String> {
994 // Recover from a poisoned lock instead of returning a blank screen
995 // forever — a single panic while holding `live` would otherwise wedge
996 // every future snapshot (and `wait_for_turn`/`screen` with it).
997 self.live.lock().unwrap_or_else(std::sync::PoisonError::into_inner).snapshot(max_lines)
998 }
999
1000 /// Whether the live terminal is currently on the alternate screen buffer
1001 /// (a full-screen app like vim/htop/less is running).
1002 pub fn live_in_alt_screen(&self) -> bool {
1003 self.live.lock().unwrap_or_else(std::sync::PoisonError::into_inner).in_alt_screen()
1004 }
1005
1006 /// Cursor position `(row, col)` on the live screen (0-based), so a piloting
1007 /// agent knows where focus is in a menu/form. `(0, 0)` if the lock is poisoned.
1008 pub fn live_cursor_position(&self) -> (u16, u16) {
1009 self.live.lock().unwrap_or_else(std::sync::PoisonError::into_inner).cursor_position()
1010 }
1011
1012 /// Diff the live screen against what the client last saw, returning only the
1013 /// changed lines when the change is small (huge token savings over many
1014 /// polls). Updates the baseline as a side effect. See [`ScreenUpdate`].
1015 pub fn live_snapshot_diff(&self, max_lines: usize, threshold: usize) -> ScreenUpdate {
1016 self.live
1017 .lock()
1018 .unwrap_or_else(std::sync::PoisonError::into_inner)
1019 .snapshot_diff(max_lines, threshold)
1020 }
1021
1022 /// Resize the terminal
1023 pub fn resize(&mut self, cols: u16, rows: u16) -> Result<()> {
1024 debug!("PTY resizing to {}x{}", cols, rows);
1025
1026 let new_size = PtySize { rows, cols, pixel_width: 0, pixel_height: 0 };
1027
1028 self.master.resize(new_size).context("Failed to resize PTY")?;
1029
1030 // Keep the live emulator's viewport in lockstep with the PTY size.
1031 self.live.lock().unwrap_or_else(std::sync::PoisonError::into_inner).resize(rows, cols);
1032
1033 self.size = new_size;
1034 Ok(())
1035 }
1036
1037 /// Get current terminal size
1038 pub fn get_size(&self) -> (u16, u16) {
1039 (self.size.cols, self.size.rows)
1040 }
1041
1042 /// OS process id of the shell that owns this PTY.
1043 pub fn process_id(&self) -> Option<u32> {
1044 self.child.process_id()
1045 }
1046
1047 /// Check if the shell is still alive
1048 pub fn is_alive(&mut self) -> bool {
1049 self.child.try_wait().is_ok_and(|status| status.is_none())
1050 }
1051}
1052
1053/// Thread-safe wrapper for `PtyShell`
1054pub type SharedPtyShell = Arc<Mutex<Option<PtyShell>>>;
1055
1056/// Create a new shared PTY shell
1057pub fn create_shared_pty(initial_dir: &Path, restricted_mode: bool) -> Result<SharedPtyShell> {
1058 let shell = PtyShell::new(initial_dir, restricted_mode)?;
1059 Ok(Arc::new(Mutex::new(Some(shell))))
1060}
1061
1062/// Split a byte slice into the longest valid-UTF-8 prefix (decoded) and the
1063/// trailing bytes of an incomplete final char (to carry into the next read).
1064/// Genuinely invalid sequences become a single U+FFFD and are consumed, so the
1065/// carry only ever holds a recoverable incomplete tail and never grows unbounded.
1066///
1067/// Iterative on purpose: a recursive version blows the reader thread's stack on
1068/// a burst of invalid bytes (e.g. `cat`-ing a binary), which aborts under
1069/// `panic = "abort"`. This stays O(1) in stack depth regardless of input.
1070fn decode_keep_incomplete(bytes: &[u8]) -> (String, Vec<u8>) {
1071 let mut decoded = String::new();
1072 let mut rest = bytes;
1073 loop {
1074 match std::str::from_utf8(rest) {
1075 Ok(text) => {
1076 decoded.push_str(text);
1077 return (decoded, Vec::new());
1078 }
1079 Err(error) => {
1080 let valid = error.valid_up_to();
1081 // `rest[..valid]` is valid UTF-8 by construction (no allocation
1082 // for the borrowed case).
1083 decoded.push_str(&String::from_utf8_lossy(&rest[..valid]));
1084 match error.error_len() {
1085 // Incomplete final char: keep the tail for the next read.
1086 None => return (decoded, rest[valid..].to_vec()),
1087 // Genuinely invalid run: emit one replacement and skip past it.
1088 Some(bad) => {
1089 decoded.push('\u{FFFD}');
1090 rest = &rest[valid + bad..];
1091 }
1092 }
1093 }
1094 }
1095 }
1096}
1097
1098#[cfg(test)]
1099mod tests {
1100 use super::*;
1101 use tempfile::TempDir;
1102
1103 #[test]
1104 fn decode_passes_clean_utf8_through() {
1105 let (text, carry) = decode_keep_incomplete("hello ✓ café".as_bytes());
1106 assert_eq!(text, "hello ✓ café");
1107 assert!(carry.is_empty());
1108 }
1109
1110 #[test]
1111 fn decode_carries_incomplete_trailing_char_across_reads() {
1112 // "é" is 0xC3 0xA9; a read boundary splits it. The first half must NOT
1113 // turn into U+FFFD — it's held and completed on the next read.
1114 let (text1, carry1) = decode_keep_incomplete(&[b'a', 0xC3]);
1115 assert_eq!(text1, "a");
1116 assert_eq!(carry1, vec![0xC3]);
1117
1118 let mut next = carry1;
1119 next.push(0xA9); // continuation byte arrives in the next read
1120 let (text2, carry2) = decode_keep_incomplete(&next);
1121 assert_eq!(text2, "é");
1122 assert!(carry2.is_empty());
1123 }
1124
1125 #[test]
1126 fn decode_replaces_genuinely_invalid_bytes() {
1127 // 0xFF is never valid UTF-8 and is not an incomplete prefix.
1128 let (text, carry) = decode_keep_incomplete(&[b'x', 0xFF, b'y']);
1129 assert_eq!(text, "x\u{FFFD}y");
1130 assert!(carry.is_empty());
1131 }
1132
1133 #[test]
1134 fn decode_handles_large_invalid_burst_without_overflow() {
1135 // Regression: the first (recursive) version blew the stack — one frame
1136 // per invalid byte — and aborted under panic="abort" on a binary dump.
1137 // The iterative version must handle far more than the 4KB reader buffer.
1138 let big = vec![0xFFu8; 200_000];
1139 let (text, carry) = decode_keep_incomplete(&big);
1140 assert!(carry.is_empty());
1141 assert_eq!(text.chars().filter(|&c| c == '\u{FFFD}').count(), 200_000);
1142 }
1143
1144 #[test]
1145 fn screen_session_name_parser_is_strict() {
1146 assert_eq!(super::winx_creator_pid("winx-123-456"), Some(123));
1147 assert_eq!(super::winx_creator_pid("winx-nope-456"), None);
1148 assert_eq!(super::winx_creator_pid("other-123-456"), None);
1149 }
1150
1151 #[cfg(unix)]
1152 #[test]
1153 fn process_probe_recognizes_current_process_and_rejects_reserved_pids() {
1154 assert!(super::process_exists(std::process::id()));
1155 assert!(!super::process_exists(0));
1156 assert!(!super::process_exists(1));
1157 }
1158
1159 #[test]
1160 fn prompt_detection_is_suffix_anchored() {
1161 // Per-shell nonce + exit code after the arrow: `──➤<nonce>:<code>`.
1162 let end = "──➤deadbeefcafe0001";
1163 // real prompt on the last line -> complete
1164 assert!(PtyShell::check_prompt_complete("out\nmore\n◉ /home/x──➤deadbeefcafe0001:0 ", end));
1165 // prompt with trailing ANSI erase -> still complete
1166 assert!(PtyShell::check_prompt_complete("◉ /home/x──➤deadbeefcafe0001:0 \u{1b}[K", end));
1167 // the bug: ◉ and ──➤ appear MID-output, last line is normal -> NOT complete
1168 assert!(!PtyShell::check_prompt_complete(
1169 "menu: ◉ start ──➤deadbeefcafe0001 stop\nstill running",
1170 end
1171 ));
1172 // command echoed after the prompt (not the waiting prompt) -> not complete
1173 assert!(!PtyShell::check_prompt_complete("◉ /home/x──➤deadbeefcafe0001:0 ls -la", end));
1174 // no prompt at all
1175 assert!(!PtyShell::check_prompt_complete("just some output\n", end));
1176 // the nonce's payoff: output that forges the bare glyphs but NOT the
1177 // nonce (or omits the exit code) must not be mistaken for the prompt.
1178 assert!(!PtyShell::check_prompt_complete("◉ /fake──➤ ", end));
1179 assert!(!PtyShell::check_prompt_complete("◉ /fake──➤wrongnonce:0 ", end));
1180 assert!(!PtyShell::check_prompt_complete("◉ /home/x──➤deadbeefcafe0001 ", end));
1181 }
1182
1183 #[test]
1184 fn parses_exit_code_from_prompt_marker() {
1185 let end = "──➤cafe1234";
1186 assert_eq!(PtyShell::parse_prompt_exit_code("ok\n◉ /x──➤cafe1234:0 ", end), Some(0));
1187 assert_eq!(PtyShell::parse_prompt_exit_code("oops\n◉ /x──➤cafe1234:1 ", end), Some(1));
1188 assert_eq!(PtyShell::parse_prompt_exit_code("◉ /x──➤cafe1234:42 ", end), Some(42));
1189 // still running (no completion prompt yet) -> None
1190 assert_eq!(PtyShell::parse_prompt_exit_code("building...", end), None);
1191 // forged with the wrong nonce -> None
1192 assert_eq!(PtyShell::parse_prompt_exit_code("◉ /x──➤wrong:0 ", end), None);
1193 }
1194
1195 use proptest::prelude::*;
1196
1197 proptest! {
1198 // Exit-code parsing runs on untrusted program output — arbitrary text
1199 // (and a forgeable marker) must never panic, only ever return None or a
1200 // parsed i32.
1201 #[test]
1202 fn parse_prompt_exit_code_never_panics(
1203 text in prop::collection::vec(any::<char>(), 0..256),
1204 nonce in "[0-9a-f]{0,16}",
1205 ) {
1206 let s: String = text.into_iter().collect();
1207 let end = format!("{WCGW_PROMPT_END}{nonce}");
1208 // Must not panic; any Option<i32> is acceptable.
1209 let _ = PtyShell::parse_prompt_exit_code(&s, &end);
1210 }
1211
1212 // A well-formed marker round-trips the embedded code for any i32.
1213 #[test]
1214 fn parse_prompt_exit_code_round_trips(code in any::<i32>(), nonce in "[0-9a-f]{1,16}") {
1215 let end = format!("{WCGW_PROMPT_END}{nonce}");
1216 let line = format!("output line\n{WCGW_PROMPT_PATTERN} /home/x{end}:{code} ");
1217 prop_assert_eq!(PtyShell::parse_prompt_exit_code(&line, &end), Some(code));
1218 }
1219 }
1220
1221 #[test]
1222 fn test_pty_shell_creation() -> Result<()> {
1223 let temp_dir = TempDir::new()?;
1224 let result = PtyShell::new(temp_dir.path(), false);
1225 assert!(result.is_ok(), "Failed to create PTY shell: {:?}", result.err());
1226 Ok(())
1227 }
1228
1229 #[test]
1230 fn test_pty_shell_echo() -> Result<()> {
1231 let temp_dir = TempDir::new()?;
1232 let mut shell = PtyShell::new(temp_dir.path(), false)?;
1233
1234 shell.send_command("echo 'hello pty'")?;
1235 let (output, _complete) = shell.read_output(2.0)?;
1236
1237 assert!(output.contains("hello pty"), "Output should contain 'hello pty': {output}");
1238 Ok(())
1239 }
1240
1241 #[test]
1242 fn agent_paths_are_exported_to_the_pty() -> Result<()> {
1243 let workspace = TempDir::new()?;
1244 let temporary_artifact_dir = workspace.path().join(".winx/tmp/session-test");
1245 let mut shell = PtyShell::new_with_agent_paths(
1246 workspace.path(),
1247 false,
1248 Some(workspace.path()),
1249 Some(&temporary_artifact_dir),
1250 )?;
1251
1252 shell.send_command("printf '%s\\n%s\\n' \"$WINX_WORKSPACE_ROOT\" \"$WINX_TEMP_DIR\"")?;
1253 let (output, _complete) = shell.read_output(2.0)?;
1254
1255 assert!(output.contains(&workspace.path().to_string_lossy().to_string()), "{output}");
1256 assert!(output.contains(&temporary_artifact_dir.to_string_lossy().to_string()), "{output}");
1257 Ok(())
1258 }
1259
1260 #[test]
1261 fn completed_nonblocking_poll_is_level_triggered() -> Result<()> {
1262 let temp_dir = TempDir::new()?;
1263 let mut shell = PtyShell::new(temp_dir.path(), false)?;
1264
1265 shell.send_command("true")?;
1266 let deadline = Instant::now() + Duration::from_secs(2);
1267 while Instant::now() < deadline && !shell.poll_output_nonblocking() {
1268 std::thread::sleep(Duration::from_millis(10));
1269 }
1270
1271 assert!(!shell.command_running, "shell did not complete before the deadline");
1272 assert!(
1273 shell.poll_output_nonblocking(),
1274 "a later consumer must still observe the completed state"
1275 );
1276 Ok(())
1277 }
1278
1279 #[test]
1280 fn test_pty_shell_pwd() -> Result<()> {
1281 let temp_dir = TempDir::new()?;
1282 let mut shell = PtyShell::new(temp_dir.path(), false)?;
1283
1284 // Simply verify shell responds to pwd command
1285 // Use single quotes like echo test for consistency
1286 shell.send_command("pwd && echo 'pwd_done'")?;
1287 let (output, _complete) = shell.read_output(2.0)?;
1288
1289 // Verify the echo marker appears (proves command executed)
1290 assert!(output.contains("pwd_done"), "Output should contain 'pwd_done': {output}");
1291 Ok(())
1292 }
1293
1294 #[test]
1295 fn test_pty_resize() -> Result<()> {
1296 let temp_dir = TempDir::new()?;
1297 let mut shell = PtyShell::new(temp_dir.path(), false)?;
1298
1299 let result = shell.resize(120, 40);
1300 assert!(result.is_ok());
1301
1302 let (cols, rows) = shell.get_size();
1303 assert_eq!(cols, 120);
1304 assert_eq!(rows, 40);
1305 Ok(())
1306 }
1307
1308 /// `kill(pid, 0)` probes existence without sending a signal: 0 = the pid
1309 /// exists, -1 (ESRCH) = it's gone. A freshly-killed orphan lingers briefly
1310 /// as a zombie under init until reaped, so callers poll.
1311 #[cfg(unix)]
1312 fn pid_alive(pid: i32) -> bool {
1313 u32::try_from(pid).is_ok_and(crate::os::unix::process_exists)
1314 }
1315
1316 #[cfg(unix)]
1317 #[test]
1318 fn dropping_shell_kills_orphaned_background_child() -> Result<()> {
1319 // A background job the shell starts must not outlive the shell. Spawn a
1320 // long `sleep` in the background, record its pid, drop the shell, and
1321 // confirm the sleep is gone - proving the group-kill reached past the
1322 // shell to a child `Child::kill` alone would have orphaned.
1323 let dir = TempDir::new()?;
1324 let pidfile = dir.path().join("child.pid");
1325 let mut shell = PtyShell::new(dir.path(), false)?;
1326
1327 shell
1328 .send_command(&format!("sleep 300 & echo $! > {} ; echo spawned", pidfile.display()))?;
1329
1330 // The PTY echoes the input line, so `out` containing "spawned" only proves
1331 // the line was sent - not that bash ran it. Under CI load bash can lag, so
1332 // poll the pidfile (it only appears once `echo $! > pidfile` executes) while
1333 // draining the PTY, instead of trusting the echo and racing the redirect.
1334 let mut child_pid = None;
1335 for _ in 0..150 {
1336 let _ = shell.read_output(0.1);
1337 if let Some(pid) =
1338 std::fs::read_to_string(&pidfile).ok().and_then(|c| c.trim().parse::<i32>().ok())
1339 {
1340 child_pid = Some(pid);
1341 break;
1342 }
1343 thread::sleep(Duration::from_millis(20));
1344 }
1345 let child_pid =
1346 child_pid.ok_or_else(|| anyhow!("background child pid never materialized"))?;
1347 assert!(pid_alive(child_pid), "background child should be running before drop");
1348
1349 drop(shell);
1350
1351 // The group-kill plus init reaping the orphan are async w.r.t. us; poll.
1352 let mut gone = false;
1353 for _ in 0..150 {
1354 if !pid_alive(child_pid) {
1355 gone = true;
1356 break;
1357 }
1358 thread::sleep(Duration::from_millis(20));
1359 }
1360 assert!(gone, "background child {child_pid} survived shell teardown (orphan leak)");
1361 Ok(())
1362 }
1363}