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.

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

[4/n] [update-engine] line displays can now compute offsets from a start time #6487

Merged
merged 4 commits into from
Aug 30, 2024
Merged

[4/n] [update-engine] line displays can now compute offsets from a start time #6487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e1d12de
[spr] changes to main this commit is based on
sunshowers Aug 30, 2024
6cb61be
[spr] initial version
sunshowers Aug 30, 2024
79f0940
[spr] changes introduced through rebase
sunshowers Aug 30, 2024
1d0657a
cherry-pick on main
sunshowers Aug 30, 2024
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
1 change: 1 addition & 0 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 update-engine/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ workspace = true
[dependencies]
anyhow.workspace = true
cancel-safe-futures.workspace = true
chrono.workspace = true
debug-ignore.workspace = true
derive-where.workspace = true
either.workspace = true
Expand Down
9 changes: 7 additions & 2 deletions update-engine/src/display/group_display.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,13 @@ impl<K: Eq + Ord, W: std::io::Write, S: StepSpec> GroupDisplay<K, W, S> {
pub fn write_stats(&mut self, header: &str) -> std::io::Result<()> {
// Add a blank prefix which is equal to the maximum width of known prefixes.
let prefix = " ".repeat(self.max_width);
let mut line =
self.formatter.start_line(&prefix, Some(self.start_sw.elapsed()));
let mut line = self.formatter.start_line(
&prefix,
// TODO: we don't currently support setting a start time for group
// displays. We should do that at some point.
None,
Some(self.start_sw.elapsed()),
);
self.stats.format_line(&mut line, header, &self.formatter);
writeln!(self.writer, "{line}")
}
Expand Down
11 changes: 11 additions & 0 deletions update-engine/src/display/line_display.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

// Copyright 2023 Oxide Computer Company

use chrono::{DateTime, Utc};
use debug_ignore::DebugIgnore;
use derive_where::derive_where;
use owo_colors::Style;
Expand Down Expand Up @@ -50,6 +51,16 @@ impl<W: std::io::Write> LineDisplay<W> {
self.formatter.set_styles(styles);
}

/// Sets the start time for all future lines.
///
/// If the start time is set, then the progress display will be relative to
/// that time. Otherwise, only the offset from the start of the job will be
/// displayed.
#[inline]
pub fn set_start_time(&mut self, start_time: DateTime<Utc>) {
self.shared.set_start_time(start_time);
}

/// Sets the amount of time before the next progress event is shown.
#[inline]
pub fn set_progress_interval(&mut self, interval: Duration) {
Expand Down
185 changes: 141 additions & 44 deletions update-engine/src/display/line_display_shared.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
use std::{
collections::HashMap,
fmt::{self, Write as _},
sync::LazyLock,
time::Duration,
};

use chrono::{DateTime, Utc};
use owo_colors::OwoColorize;
use swrite::{swrite, SWrite as _};

Expand All @@ -33,6 +35,8 @@ pub(super) const HEADER_WIDTH: usize = 9;

#[derive(Debug, Default)]
pub(super) struct LineDisplayShared {
// The start time, if provided.
start_time: Option<DateTime<Utc>>,
// This is a map from root execution ID to data about it.
execution_data: HashMap<ExecutionId, ExecutionData>,
}
Expand All @@ -45,6 +49,10 @@ impl LineDisplayShared {
) -> LineDisplaySharedContext<'a> {
LineDisplaySharedContext { shared: self, prefix, formatter }
}

pub(super) fn set_start_time(&mut self, start_time: DateTime<Utc>) {
self.start_time = Some(start_time);
}
}

#[derive(Debug)]
Expand All @@ -60,7 +68,11 @@ impl<'a> LineDisplaySharedContext<'a> {
/// This line does not have a trailing newline; adding one is the caller's
/// responsibility.
pub(super) fn format_generic(&self, message: &str) -> String {
let mut line = self.formatter.start_line(self.prefix, None);
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
None,
);
line.push_str(message);
line
}
Expand Down Expand Up @@ -134,9 +146,11 @@ impl<'a> LineDisplaySharedContext<'a> {
) {
match &step_event.kind {
StepEventKind::NoStepsDefined => {
let mut line = self
.formatter
.start_line(self.prefix, Some(step_event.total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(step_event.total_elapsed),
);
swrite!(
line,
"{}",
Expand All @@ -152,9 +166,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&first_step.info,
&nest_data,
);
let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

swrite!(
line,
Expand All @@ -178,9 +194,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&nest_data,
);

let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

swrite!(
line,
Expand Down Expand Up @@ -224,9 +242,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&nest_data,
);

let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

swrite!(
line,
Expand Down Expand Up @@ -270,9 +290,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&step.info,
&nest_data,
);
let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

self.formatter.add_completion_and_step_info(
&mut line,
Expand All @@ -293,9 +315,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&nest_data,
);

let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

self.format_step_running(&mut line, ld_step_info);

Expand All @@ -315,9 +339,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&nest_data,
);

let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

self.formatter.add_completion_and_step_info(
&mut line,
Expand All @@ -344,9 +370,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&nest_data,
);

let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);
// The prefix is used for "Caused by" lines below. Add
// the requisite amount of spacing here.
let mut caused_by_prefix = line.clone();
Expand Down Expand Up @@ -387,9 +415,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&nest_data,
);

let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

swrite!(
line,
Expand Down Expand Up @@ -463,8 +493,11 @@ impl<'a> LineDisplaySharedContext<'a> {
&self,
info: &ExecutionTerminalInfo,
) -> String {
let mut line =
self.formatter.start_line(self.prefix, info.leaf_total_elapsed);
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
info.leaf_total_elapsed,
);
match info.kind {
TerminalKind::Completed => {
swrite!(
Expand Down Expand Up @@ -540,9 +573,11 @@ impl<'a> LineDisplaySharedContext<'a> {
nest_data: &nest_data,
};

let mut line = self
.formatter
.start_line(self.prefix, Some(root_total_elapsed));
let mut line = self.formatter.start_line(
self.prefix,
self.shared.start_time,
Some(root_total_elapsed),
);

let (before, after) = match progress {
Some(counter) => {
Expand Down Expand Up @@ -685,6 +720,7 @@ impl LineDisplayFormatter {
pub(super) fn start_line(
&self,
prefix: &str,
start_time: Option<DateTime<Utc>>,
total_elapsed: Option<Duration>,
) -> String {
let mut line = format!("[{}", prefix.style(self.styles.prefix_style));
Expand All @@ -694,17 +730,31 @@ impl LineDisplayFormatter {
}

// Show total elapsed time in an hh:mm:ss format.
if let Some(total_elapsed) = total_elapsed {
let total_elapsed_secs = total_elapsed.as_secs();
let hours = total_elapsed_secs / 3600;
let minutes = (total_elapsed_secs % 3600) / 60;
let seconds = total_elapsed_secs % 60;
swrite!(line, "{:02}:{:02}:{:02}", hours, minutes, seconds);
// To show total_elapsed more accurately, use:
// swrite!(line, "{:.2?}", total_elapsed);
} else {
// Add 8 spaces to align with hh:mm:ss.
line.push_str(" ");
match (start_time, total_elapsed) {
(Some(start_time), Some(total_elapsed)) => {
// Add the offset from the start time.
let current_time = start_time + total_elapsed;
swrite!(
line,
"{}",
current_time.format_with_items(DATETIME_FORMAT.iter())
);
}
(None, Some(total_elapsed)) => {
let total_elapsed_secs = total_elapsed.as_secs();
let hours = total_elapsed_secs / 3600;
let minutes = (total_elapsed_secs % 3600) / 60;
let seconds = total_elapsed_secs % 60;
swrite!(line, "{:02}:{:02}:{:02}", hours, minutes, seconds);
// To show total_elapsed more accurately, use:
// swrite!(line, "{:.2?}", total_elapsed);
}
(Some(_), None) => {
line.push_str(DATETIME_FORMAT_INDENT);
}
(None, None) => {
line.push_str(ELAPSED_FORMAT_INDENT);
}
}

line.push_str("] ");
Expand Down Expand Up @@ -874,6 +924,23 @@ impl LineDisplayFormatter {
}
}

static DATETIME_FORMAT: LazyLock<Vec<chrono::format::Item<'static>>> =
LazyLock::new(|| {
// The format is "Jan 01 00:00:00".
//
// We can add customization in the future, but we want to restrict
// formats to fixed-width so we know how to align them.
chrono::format::StrftimeItems::new("%b %d %H:%M:%S")
.parse()
.expect("datetime format is valid")
});

// "Jan 01 00:00:00" is 15 characters wide.
const DATETIME_FORMAT_INDENT: &str = " ";

// "00:00:00" is 8 characters wide.
const ELAPSED_FORMAT_INDENT: &str = " ";

#[derive(Clone, Debug)]
pub(super) struct LineDisplayOutput {
lines: Vec<String>,
Expand Down Expand Up @@ -989,6 +1056,8 @@ impl fmt::Display for AsLetters {

#[cfg(test)]
mod tests {
use chrono::TimeZone;

use super::*;

#[test]
Expand All @@ -1010,4 +1079,32 @@ mod tests {
);
}
}

#[test]
fn test_start_line() {
let formatter = LineDisplayFormatter::new();
let prefix = "prefix";
let start_time = Utc.with_ymd_and_hms(2023, 2, 8, 3, 40, 56).unwrap();

assert_eq!(
formatter.start_line(prefix, None, None),
"[prefix ] ",
);
assert_eq!(
formatter.start_line(prefix, None, Some(Duration::from_secs(5))),
"[prefix 00:00:05] ",
);
assert_eq!(
formatter.start_line(prefix, Some(start_time), None),
"[prefix ] ",
);
assert_eq!(
formatter.start_line(
prefix,
Some(start_time),
Some(Duration::from_secs(3600)),
),
"[prefix Feb 08 04:40:56] ",
);
}
}
Loading