Skip to content
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.

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

Don't conflate ticking with updating estimates #434

Merged
merged 3 commits into from
May 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 1 addition & 4 deletions src/progress_bar.rs
Original file line number Diff line number Diff line change
Expand Up @@ -591,10 +591,7 @@ impl TickerControl {
break;
}

if state.state.tick != 0 {
state.state.tick = state.state.tick.saturating_add(1);
}

state.state.tick = state.state.tick.saturating_add(1);
state.draw(false, Instant::now()).ok();

drop(state); // Don't forget to drop the lock before sleeping
Expand Down
17 changes: 9 additions & 8 deletions src/state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,31 +82,32 @@ impl BarState {

pub(crate) fn set_length(&mut self, now: Instant, len: u64) {
self.state.len = Some(len);
self.tick(now);
self.update_estimate_and_draw(now);
}

pub(crate) fn inc_length(&mut self, now: Instant, delta: u64) {
if let Some(len) = self.state.len {
self.state.len = Some(len.saturating_add(delta));
}
self.tick(now);
self.update_estimate_and_draw(now);
}

pub(crate) fn set_message(&mut self, now: Instant, msg: Cow<'static, str>) {
self.style.message = msg;
self.tick(now);
self.update_estimate_and_draw(now);
}

pub(crate) fn set_prefix(&mut self, now: Instant, prefix: Cow<'static, str>) {
self.style.prefix = prefix;
self.tick(now);
self.update_estimate_and_draw(now);
}

pub(crate) fn tick(&mut self, now: Instant) {
if self.state.tick == 0 {
self.state.tick = self.state.tick.saturating_add(1);
}
self.state.tick = self.state.tick.saturating_add(1);
self.update_estimate_and_draw(now);
}

fn update_estimate_and_draw(&mut self, now: Instant) {
let pos = self.state.pos.pos.load(Ordering::Relaxed);
self.state.est.record(pos, now);
let _ = self.draw(false, now);
Expand Down Expand Up @@ -137,7 +138,7 @@ impl BarState {
}

let ret = f();
let _ = self.draw(true, now);
let _ = self.draw(true, Instant::now());
ret
}

Expand Down
22 changes: 22 additions & 0 deletions tests/render.rs
Original file line number Diff line number Diff line change
Expand Up @@ -271,3 +271,25 @@ fn ticker_drop() {
" doing stuff 0\n doing stuff 1\n doing stuff 2\n doing stuff 3\n doing stuff 4"
);
}

#[test]
fn manually_inc_ticker() {
chris-laplante marked this conversation as resolved.
Show resolved Hide resolved
let in_mem = InMemoryTerm::new(10, 80);
let mp =
MultiProgress::with_draw_target(ProgressDrawTarget::term_like(Box::new(in_mem.clone())));

let spinner = mp.add(ProgressBar::new_spinner().with_message("msg"));

assert_eq!(in_mem.contents(), "");

spinner.inc(1);
assert_eq!(in_mem.contents(), "⠁ msg");

spinner.inc(1);
assert_eq!(in_mem.contents(), "⠉ msg");

// set_message / set_prefix shouldn't increase tick
spinner.set_message("new message");
spinner.set_prefix("prefix");
assert_eq!(in_mem.contents(), "⠉ new message");
}