Skip to content

progress: print rich status on long runners #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atagen merged 1 commit into from
Jun 9, 2026
Merged

progress: print rich status on long runners #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 38 additions & 15 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ codegen-units = 1

[dependencies]
anyhow = "1.0.99"
cognos = "1.0"
libc = "0.2"
microxdg = "0.2.0"
pound = "0.1.4"
Expand Down
153 changes: 43 additions & 110 deletions src/loaders.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
use crate::{
config,
nix_progress::NixProgress,
types::EnvSet,
verbosity::{self, Verbosity},
};
use anyhow::{Context, Result, bail};
use std::{
collections::VecDeque,
io::{IsTerminal, Read, Write},
path::Path,
process::{Command, Output, Stdio},
Expand All @@ -17,9 +17,6 @@ pub(crate) use crate::nix_dev_env::{load_flake, load_shell};

const DEFAULT_LONG_RUNNING_WARNING_AFTER: Duration = Duration::from_secs(5);
const LONG_RUNNING_POLL_INTERVAL: Duration = Duration::from_millis(100);
const RECENT_OUTPUT_LINES: usize = 5;
const RECENT_OUTPUT_LINE_BYTES: usize = 4 * 1024;
const DISPLAY_LINE_CHARS: usize = 200;

fn long_running_warning_after() -> Duration {
config::long_running_warning_ms()
Expand All @@ -38,77 +35,6 @@ struct StreamEvent {
data: Vec<u8>,
}

struct RecentLines {
lines: VecDeque<String>,
current: Vec<u8>,
}

impl RecentLines {
fn new() -> Self {
Self {
lines: VecDeque::with_capacity(RECENT_OUTPUT_LINES),
current: Vec::new(),
}
}

fn push(&mut self, chunk: &[u8]) {
for &byte in chunk {
match byte {
b'\n' => self.finish_current_line(),
b'\r' => {
self.current.clear();
}
_ => {
if self.current.len() < RECENT_OUTPUT_LINE_BYTES {
self.current.push(byte);
}
}
}
}
}

fn finish_current_line(&mut self) {
let line = sanitize_display_line(&self.current);
self.current.clear();
if line.is_empty() {
return;
}
if self.lines.len() == RECENT_OUTPUT_LINES {
self.lines.pop_front();
}
self.lines.push_back(line);
}

fn lines(&self) -> Vec<String> {
let mut lines: Vec<String> = self.lines.iter().cloned().collect();
let current = sanitize_display_line(&self.current);
if !current.is_empty() {
lines.push(current);
}
let keep_from = lines.len().saturating_sub(RECENT_OUTPUT_LINES);
lines.into_iter().skip(keep_from).collect()
}
}

fn sanitize_display_line(raw: &[u8]) -> String {
let text = String::from_utf8_lossy(raw);
let mut out = String::new();
for ch in text.chars() {
if ch == '\t' {
out.push_str(" ");
} else if ch.is_control() {
out.push(' ');
} else {
out.push(ch);
}
if out.chars().count() >= DISPLAY_LINE_CHARS {
out.push_str("...");
break;
}
}
out.trim().to_string()
}

struct LongRunningProgress<'a> {
what: &'a str,
enabled: bool,
Expand All @@ -130,13 +56,13 @@ impl<'a> LongRunningProgress<'a> {
}
}

fn show(&mut self, recent: &[String]) {
fn show(&mut self, recent: &[String], bar: Option<&str>) {
self.shown = true;
if !self.enabled {
return;
}
if self.interactive {
self.render(recent);
self.render(recent, bar);
} else {
eprintln!(
"cade: {} is taking a long time; press Ctrl-C to stop and inspect the command.",
Expand All @@ -150,9 +76,9 @@ impl<'a> LongRunningProgress<'a> {
self.shown && self.enabled && self.interactive
}

fn update(&mut self, recent: &[String]) {
fn update(&mut self, recent: &[String], bar: Option<&str>) {
if self.wants_live() {
self.render(recent);
self.render(recent, bar);
}
}

Expand All @@ -170,8 +96,8 @@ impl<'a> LongRunningProgress<'a> {
}
}

fn render(&mut self, recent: &[String]) {
let block = self.block(recent);
fn render(&mut self, recent: &[String], bar: Option<&str>) {
let block = self.block(recent, bar);
if block == self.last_block {
return;
}
Expand All @@ -193,7 +119,7 @@ impl<'a> LongRunningProgress<'a> {
self.last_block.clear();
}

fn block(&self, recent: &[String]) -> Vec<String> {
fn block(&self, recent: &[String], bar: Option<&str>) -> Vec<String> {
let mut lines = vec![format!(
"cade: {} is taking a long time; press Ctrl-C to stop and inspect the command.",
self.what
Expand All @@ -202,6 +128,9 @@ impl<'a> LongRunningProgress<'a> {
lines.push("cade: recent output:".to_string());
lines.extend(recent.iter().map(|line| format!(" {line}")));
}
if let Some(bar) = bar {
lines.push(bar.to_string());
}
lines
}
}
Expand Down Expand Up @@ -237,20 +166,25 @@ fn handle_stream_event(
event: StreamEvent,
stdout: &mut Vec<u8>,
stderr: &mut Vec<u8>,
recent_stderr: &mut RecentLines,
nix: &mut NixProgress,
progress: Option<&mut LongRunningProgress<'_>>,
) {
match event.kind {
StreamKind::Stdout => stdout.extend(event.data),
StreamKind::Stderr => {
stderr.extend(&event.data);
recent_stderr.push(&event.data);
nix.push(&event.data);
let recent = nix.recent_lines();
let bar = nix.bar_line();
match progress {
// No spinner owns the terminal: drive the standalone widget.
Some(progress) if progress.wants_live() => progress.update(&recent_stderr.lines()),
Some(progress) if progress.wants_live() => progress.update(&recent, bar.as_deref()),
Some(_) => {}
// Feed the active activation spinner instead.
None => crate::progress::set_recent(recent_stderr.lines()),
None => {
crate::progress::set_recent(recent);
crate::progress::set_nix_bar(bar);
}
}
}
}
Expand All @@ -277,7 +211,7 @@ pub(crate) fn run_checked(mut cmd: Command, what: &str) -> Result<Vec<u8>> {

let mut stdout = Vec::new();
let mut stderr = Vec::new();
let mut recent_stderr = RecentLines::new();
let mut nix = NixProgress::new();
// The activation spinner, when present, subsumes the standalone widget.
let mut progress = (!crate::progress::is_active()).then(|| LongRunningProgress::new(what));
let mut warned = false;
Expand All @@ -291,10 +225,13 @@ pub(crate) fn run_checked(mut cmd: Command, what: &str) -> Result<Vec<u8>> {
if !warned && start.elapsed() >= warn_after {
warned = true;
match &mut progress {
Some(progress) => progress.show(&recent_stderr.lines()),
None => crate::progress::mark_long_running(format!(
"cade: {what} is taking a long time; press Ctrl-C to stop and inspect the command."
)),
Some(progress) => progress.show(&nix.recent_lines(), nix.bar_line().as_deref()),
None => {
crate::progress::mark_long_running(format!(
"cade: {what} is taking a long time; press Ctrl-C to stop and inspect the command."
));
crate::progress::set_nix_bar(nix.bar_line());
}
}
}

Expand All @@ -307,13 +244,9 @@ pub(crate) fn run_checked(mut cmd: Command, what: &str) -> Result<Vec<u8>> {
};

match rx.recv_timeout(wait_for) {
Ok(event) => handle_stream_event(
event,
&mut stdout,
&mut stderr,
&mut recent_stderr,
progress.as_mut(),
),
Ok(event) => {
handle_stream_event(event, &mut stdout, &mut stderr, &mut nix, progress.as_mut())
}
Err(RecvTimeoutError::Timeout) => {}
Err(RecvTimeoutError::Disconnected) => {
break child.wait().context("waiting for command status")?;
Expand All @@ -325,16 +258,10 @@ pub(crate) fn run_checked(mut cmd: Command, what: &str) -> Result<Vec<u8>> {
let _ = reader.join();
}
while let Ok(event) = rx.try_recv() {
handle_stream_event(
event,
&mut stdout,
&mut stderr,
&mut recent_stderr,
progress.as_mut(),
);
handle_stream_event(event, &mut stdout, &mut stderr, &mut nix, progress.as_mut());
}
if let Some(mut progress) = progress {
progress.finish(&recent_stderr.lines());
progress.finish(&nix.recent_lines());
}

let out = Output {
Expand All @@ -345,15 +272,21 @@ pub(crate) fn run_checked(mut cmd: Command, what: &str) -> Result<Vec<u8>> {
verbosity::log(Verbosity::Trace, format_args!("cade: finished {what}."));

if !out.status.success() {
let stderr = String::from_utf8_lossy(&out.stderr);
let stderr = stderr.trim();
// prefer the de-jsonified nix messages; fall back to raw stderr for
// non-nix commands (whose stderr is plain text already).
let summary = if nix.saw_nix() {
nix.error_text()
} else {
String::from_utf8_lossy(&out.stderr).into_owned()
};
let summary = summary.trim();
bail!(
"{what} failed ({}){}",
out.status,
if stderr.is_empty() {
if summary.is_empty() {
String::new()
} else {
format!(":\n{stderr}")
format!(":\n{summary}")
}
);
}
Expand Down
Loading
Loading