runnerd-web 0.0.17

//! `/history`: finished and running jobs, filtered by repository, workflow and outcome with links, a page at a time;
//! and the trends of the last 30 days from `/v1/stats`: jobs per day by conclusion, how long they waited and ran,
//! their memory peaks.

use maud::{Markup, html};
use runnerd_core::api::{
    Bucket, JobPage, JobQuery, JobState, Stats, StatsQuery, StatsSummary, Status,
};
use runnerd_core::client::{Client, ClientError};
use serde::{Deserialize, Serialize};

use super::{Page, Parts, badge, js, page, profile_class, time_ago};
use crate::chart::{Band, Bar, Base, Series, TimeChart, nice_top, stacked_bars};
use crate::format;

/// How far back the trends reach.
const TREND_DAYS: u64 = 30;
const PAGE: u32 = 50;
/// The latest jobs read for the workflows the filter offers.
const WORKFLOWS_READ: u32 = 500;

/// The outcomes the filter offers: a conclusion or a state.
const OUTCOMES: [(&str, &str); 8] = [
    ("success", "Succeeded"),
    ("failure", "Failed"),
    ("cancelled", "Cancelled"),
    ("timed_out", "Timed out"),
    ("running", "Running"),
    ("queued", "Queued"),
    ("lost", "Lost"),
    ("elsewhere", "Not run here"),
];

/// The page's query string.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub(crate) struct Filter {
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "empty_none"
    )]
    pub(crate) repository: Option<String>,
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "empty_none"
    )]
    pub(crate) outcome: Option<String>,
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "empty_none"
    )]
    pub(crate) workflow: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub(crate) before: Option<u64>,
}

/// An empty form field is no filter.
fn empty_none<'de, D: serde::Deserializer<'de>>(
    deserializer: D,
) -> Result<Option<String>, D::Error> {
    Ok(Option::<String>::deserialize(deserializer)?.filter(|value| !value.is_empty()))
}

impl Filter {
    fn query(&self) -> JobQuery {
        let mut query = JobQuery {
            repository: self.repository.clone(),
            workflow: self.workflow.clone(),
            before: self.before,
            limit: Some(PAGE),
            ..JobQuery::default()
        };
        match self.outcome.as_deref() {
            Some("running") => query.state = Some(JobState::Running),
            Some("queued") => query.state = Some(JobState::Queued),
            Some("lost") => query.state = Some(JobState::Lost),
            Some("elsewhere") => query.state = Some(JobState::Elsewhere),
            Some(conclusion) => query.conclusion = Some(conclusion.to_owned()),
            None => {}
        }
        query
    }
}

/// Everything the history page shows.
#[derive(Debug, Clone)]
pub(crate) struct History {
    pub(crate) now: u64,
    pub(crate) filter: Filter,
    pub(crate) status: Status,
    pub(crate) page: JobPage,
    pub(crate) stats: Stats,
    /// The workflows of the repository's latest jobs (of every repository's without one), by name.
    pub(crate) workflows: Vec<String>,
}

impl History {
    pub(crate) async fn load(
        daemon: &Client,
        filter: Filter,
        now: u64,
    ) -> Result<History, ClientError> {
        let status = daemon.get("/v1/status").await?;
        let page = daemon.get_query("/v1/jobs", &filter.query()).await?;
        let trends = daemon
            .get_query(
                "/v1/stats",
                &StatsQuery {
                    repository: filter.repository.clone(),
                    since: Some(day_start(now).saturating_sub((TREND_DAYS - 1) * 86_400)),
                    until: None,
                    bucket: Bucket::Day,
                },
            )
            .await?;
        let latest: JobPage = daemon
            .get_query(
                "/v1/jobs",
                &JobQuery {
                    repository: filter.repository.clone(),
                    limit: Some(WORKFLOWS_READ),
                    ..JobQuery::default()
                },
            )
            .await?;
        let mut workflows: Vec<String> = latest
            .jobs
            .into_iter()
            .filter_map(|job| job.workflow)
            .collect();
        // A workflow filtered on stays offered, though none of the latest jobs ran it.
        workflows.extend(filter.workflow.clone());
        workflows.sort();
        workflows.dedup();
        Ok(History {
            now,
            filter,
            status,
            page,
            stats: trends,
            workflows,
        })
    }
}

fn day_start(at: u64) -> u64 {
    at - at % 86_400
}

/// The trends' days, all repositories of the filter summed, oldest first.
fn days(stats: &Stats, now: u64) -> Vec<StatsSummary> {
    stats.daily(
        day_start(now).saturating_sub((TREND_DAYS - 1) * 86_400),
        TREND_DAYS,
    )
}

/// The whole page.
pub(crate) fn render(history: &History) -> Markup {
    let main = html! {
        h1.visually-hidden { "History" }
        (filters(history))
        (trends(history))
        (jobs(history))
    };
    page("History", Some(Page::History), None, &main)
}

/// The filters, as links: each sets one filter and keeps the others, so they work without scripts and a filtered
/// page can be bookmarked or shared.
fn filters(history: &History) -> Markup {
    let filter = &history.filter;
    let link = |change: &dyn Fn(&mut Filter)| {
        let mut next = Filter {
            before: None,
            ..filter.clone()
        };
        change(&mut next);
        let query = serde_urlencoded::to_string(&next).unwrap_or_default();
        if query.is_empty() {
            "/history".to_owned()
        } else {
            format!("/history?{query}")
        }
    };
    let repositories: Vec<(Option<String>, String)> = std::iter::once((None, "All".to_owned()))
        .chain(
            history
                .status
                .repositories
                .iter()
                .map(|repository| (Some(repository.name.clone()), repository.name.clone())),
        )
        .collect();
    let workflows: Vec<(Option<String>, String)> = std::iter::once((None, "All".to_owned()))
        .chain(
            history
                .workflows
                .iter()
                .map(|workflow| (Some(workflow.clone()), workflow.clone())),
        )
        .collect();
    let outcomes: Vec<(Option<String>, String)> = std::iter::once((None, "Any".to_owned()))
        .chain(
            OUTCOMES
                .iter()
                .map(|(value, label)| (Some((*value).to_owned()), (*label).to_owned())),
        )
        .collect();
    let group = |name: &str,
                 current: &Option<String>,
                 options: &[(Option<String>, String)],
                 set: &dyn Fn(&mut Filter, Option<String>)| {
        html! {
            div.filter-group role="group" aria-labelledby=(format!("filter-{}", name.to_lowercase())) {
                span.filter-name #(format!("filter-{}", name.to_lowercase())) { (name) }
                ul {
                    @for (value, label) in options {
                        li {
                            a href=(link(&|next| set(next, value.clone())))
                                aria-current=[(current == value).then_some("true")] { (label) }
                        }
                    }
                }
            }
        }
    };
    html! {
        nav.filters aria-label="Filter jobs" {
            (group("Repository", &filter.repository, &repositories, &|next, value| {
                // Another repository's workflows differ: its filter starts over.
                if next.repository != value {
                    next.workflow = None;
                }
                next.repository = value;
            }))
            @if history.workflows.len() > 1 || filter.workflow.is_some() {
                (group("Workflow", &filter.workflow, &workflows, &|next, value| next.workflow = value))
            }
            (group("Outcome", &filter.outcome, &outcomes, &|next, value| next.outcome = value))
        }
    }
}

/// Picks the day under the pointer, from the chart it is over: day `i` is the `i`th thirtieth of the chart's width.
const DAY_UNDER_POINTER: &str = "const area = evt.target.closest('.chart-card')?.querySelector('.chart-area'); \
    if (area) { const box = area.getBoundingClientRect(); \
    $_day = Math.min(29, Math.max(0, Math.floor((evt.clientX - box.left) / box.width * 30))) }";
/// Steps through the days with the arrow keys.
const DAY_KEYS: &str = "if (evt.key == 'ArrowLeft') { $_day = Math.max(0, ($_day < 0 ? 30 : $_day) - 1); evt.preventDefault() } \
    else if (evt.key == 'ArrowRight') { $_day = Math.min(29, $_day + 1); evt.preventDefault() } \
    else if (evt.key == 'Escape') { $_day = -1 }";

/// The last 30 days as three charts on one day axis. Pointing at a day, or stepping to it with the arrow keys, marks
/// it on every chart and puts its numbers in the headline.
fn trends(history: &History) -> Markup {
    let days = days(&history.stats, history.now);
    let peak = StatsSummary::of(&days).memory_peak.unwrap_or(0);
    let bars: Vec<Bar> = days
        .iter()
        .map(|day| Bar {
            label: format::short_date(day.start),
            parts: vec![day.succeeded, day.failed, day.cancelled, day.other()],
        })
        .collect();
    let durations = daily(&days, StatsSummary::average_run);
    let waits = daily(&days, StatsSummary::average_wait);
    let peaks = daily(&days, |day| day.memory_peak);
    let time_top = nice_top(
        durations
            .iter()
            .chain(&waits)
            .map(|point| point.1)
            .max()
            .unwrap_or(0),
        Base::Decimal,
    );
    let times = per_day(
        "Average run time and wait per day",
        vec![
            Series::line("run time", "run", durations),
            Series::line("wait", "wait", waits),
        ],
        format::duration,
        &days,
    );
    let memory = per_day(
        "Highest sampled memory peak per day",
        vec![Series::line("memory peak", "memory", peaks)],
        format::bytes,
        &days,
    );
    // One band per chart, a day wide, which the stylesheet moves to the picked day by `--day`.
    let mark = |from, to| {
        [Band {
            from,
            to: Some(to),
            shown: "$_day >= 0".to_owned(),
            label: String::new(),
        }]
    };
    let bar_marks = mark(0, 1);
    let day_marks = days
        .first()
        .map_or(mark(0, 0), |day| mark(day.start, day.start + 86_399));
    let dates: Vec<String> = days
        .iter()
        .map(|day| format::short_date(day.start))
        .collect();
    html! {
        section.trends aria-labelledby="trends-title" "data-signals:_day__ifmissing"="-1" "data-style:--day"="$_day" {
            h2 #trends-title data-text=(lens("Last 30 days", &dates)) { "Last 30 days" }
            p.visually-hidden { "Jobs that finished, by the day they were queued (UTC). Arrow keys step through the days." }
            @if history.filter.workflow.is_some() || history.filter.outcome.is_some() {
                p.muted {
                    "These count every workflow and outcome"
                    @if let Some(repository) = &history.filter.repository { " of " (repository) }
                    "; the list below is filtered."
                }
            }
            (headline(&days))
            div.charts.three tabindex="0" role="group" aria-label="Charts per day"
                data-on:pointermove=(DAY_UNDER_POINTER) data-on:pointerdown=(DAY_UNDER_POINTER)
                data-on:pointerleave="evt.pointerType == 'mouse' && ($_day = -1)" data-on:keydown=(DAY_KEYS) data-on:blur="$_day = -1" {
                div.chart-card {
                    h3 { "Jobs per day" }
                    (stacked_bars("Jobs per day by conclusion", &["success", "failure", "neutral", "other"], &bars, |n| n.to_string(), &bar_marks))
                    ul.legend {
                        li.success { span.swatch {} "succeeded" }
                        li.failure { span.swatch {} "failed or lost" }
                        li.neutral { span.swatch {} "cancelled" }
                    }
                }
                div.chart-card {
                    h3 { "Run time and wait" }
                    (times.render_with(time_top, &day_marks, &Parts::default()))
                    ul.legend {
                        li.run { span.swatch {} "average run" }
                        li.wait { span.swatch {} "average wait for a runner" }
                    }
                }
                div.chart-card {
                    h3 { "Memory peak" }
                    (memory.render_with(nice_top(peak, Base::Binary), &day_marks, &Parts::default()))
                }
            }
        }
    }
}

/// A Datastar expression for text that is `whole` with no day picked and the picked day's entry of `per_day` else.
fn lens(whole: &str, per_day: &[String]) -> String {
    let entries: Vec<String> = per_day.iter().map(|entry| js(entry)).collect();
    format!(
        "$_day < 0 ? {} : [{}][$_day]",
        js(whole),
        entries.join(", ")
    )
}

/// A day's value at its middle, so a line's points sit over the bars of the same days.
fn daily(days: &[StatsSummary], value: fn(&StatsSummary) -> Option<u64>) -> Vec<(u64, u64)> {
    days.iter()
        .filter_map(|day| value(day).map(|value| (day.start + 43_200, value)))
        .collect()
}

fn per_day(
    title: &str,
    series: Vec<Series>,
    value: fn(u64) -> String,
    days: &[StatsSummary],
) -> TimeChart {
    TimeChart {
        title: title.to_owned(),
        start: days.first().map_or(0, |day| day.start),
        end: days.last().map_or(0, |day| day.start + 86_399),
        window: None,
        live: None,
        series,
        limits: vec![],
        value,
        time: format::short_date,
        gap: 86_400,
    }
}

/// The 30 days' totals, or the picked day's.
fn headline(days: &[StatsSummary]) -> Markup {
    let total = StatsSummary::of(days);
    let peak = |peak: Option<u64>| peak.map_or("–".to_owned(), format::bytes);
    let share = |summary: &StatsSummary| {
        summary
            .success_percent()
            .map_or("–".to_owned(), |percent| format!("{percent}%"))
    };
    let average = |seconds: Option<u64>| seconds.map_or("–".to_owned(), format::duration);
    let each = |value: &dyn Fn(&StatsSummary) -> String| days.iter().map(value).collect::<Vec<_>>();
    let figures = [
        (
            "Jobs",
            total.jobs.to_string(),
            each(&|day| day.jobs.to_string()),
        ),
        ("Succeeded", share(&total), each(&|day| share(day))),
        (
            "Average run",
            average(total.average_run()),
            each(&|day| average(day.average_run())),
        ),
        (
            "Average wait",
            average(total.average_wait()),
            each(&|day| average(day.average_wait())),
        ),
        (
            "Sampled memory peak",
            peak(total.memory_peak),
            each(&|day| peak(day.memory_peak)),
        ),
    ];
    html! {
        dl.headline aria-live="polite" {
            @for (label, whole, per_day) in &figures {
                div { dt { (label) } dd data-text=(lens(whole, per_day)) { (whole) } }
            }
        }
    }
}

fn jobs(history: &History) -> Markup {
    let now = history.now;
    let next = history.page.next.map(|before| {
        let filter = Filter {
            before: Some(before),
            ..history.filter.clone()
        };
        format!(
            "/history?{}",
            serde_urlencoded::to_string(&filter).unwrap_or_default()
        )
    });
    html! {
        section.jobs aria-labelledby="jobs-title" {
            h2 #jobs-title .visually-hidden { "Jobs" }
            @if history.page.jobs.is_empty() {
                p.muted { "No jobs match." }
            } @else {
                div.table-wrap {
                    table.job-table.history-table {
                        thead {
                            tr {
                                th scope="col" { "Job" }
                                th scope="col" { "Outcome" }
                                th scope="col" { "Queued" }
                                th scope="col" .number { "Waited" }
                                th scope="col" .number { "Ran" }
                                th scope="col" .number { abbr title="The highest of the samples taken every 2 seconds" { "Sampled peak" } }
                                th scope="col" .number { "Avg CPU" }
                            }
                        }
                        tbody {
                            @for job in &history.page.jobs {
                                @let class = job.runner.as_ref().map_or("p-none".to_owned(), |runner| profile_class(&history.status, &runner.profile));
                                tr class=(class) {
                                    th scope="row" {
                                        a href=(format!("/jobs/{}", job.id)) {
                                            span.swatch aria-hidden="true" {}
                                            span.job-name { (job.title().name) }
                                            span.repo { (job.repository) @if let Some(branch) = &job.branch { " · " (branch) } }
                                        }
                                    }
                                    td { (badge(job)) }
                                    // On a phone a row is a card: each figure says what it is.
                                    td { (time_ago(job.timeline.queued_at, now)) }
                                    td.number data-label="waited" { (job.waited(now).map_or("–".to_owned(), format::duration)) }
                                    td.number data-label="ran" { (job.ran(now).map_or("–".to_owned(), format::duration)) }
                                    td.number data-label="peak" { (job.metrics.memory_peak.map_or("–".to_owned(), format::bytes)) }
                                    td.number data-label="CPU" { (job.metrics.cpu_average.map_or("–".to_owned(), format::cores_used)) }
                                }
                            }
                        }
                    }
                }
            }
            @if let Some(next) = next {
                p.pager { a.button-quiet href=(next) { "Older jobs" } }
            }
        }
    }
}