OXYGENHUB
# addec2bd6423 oxygenhub / crates / hub / src / web / flow.rs
32.7 KiB · Rust · last changed Rerun one job of a run, with what depends on it 22 days ago source blame history raw
42fa9554 Andy McCall ↶ 1
//! The Flow tab (hub spec §13.2): runs of a repository, and a run's job
2
//! graph with live status and logs.
3
1edac4b6 Andy McCall ↶ 4
use super::settings::{csrf, require};
5
use super::{filters, lookup, lookup_role, Error, Page, RepoShell, Shell};
6
use crate::auth::{Access, Role, Viewer};
42fa9554 Andy McCall ↶ 7
use crate::db::{self, flow as fdb};
8
use crate::Shared;
9
use askama::Template;
1edac4b6 Andy McCall ↶ 10
use axum::extract::{Form, Path, Query, State};
11
use axum::response::{IntoResponse, Redirect, Response};
42fa9554 Andy McCall ↶ 12
use axum::Json;
13
use serde::Deserialize;
14
15
pub struct RunRow {
16
    pub r: fdb::Run,
17
    pub duration: String,
18
    pub jobs: Vec<(String, String)>,
bf3d0754 Andy McCall ↶ 19
    /// "3rd in line" for a run still waiting for a runner.
20
    pub place: Option<String>,
42fa9554 Andy McCall ↶ 21
}
22
23
#[derive(Template)]
24
#[template(path = "flow_runs.html")]
25
pub struct RunsPage {
26
    shell: Shell,
27
    repo: RepoShell,
28
    runs: Vec<RunRow>,
29
    enabled: bool,
30
    older: Option<i64>,
1edac4b6 Andy McCall ↶ 31
    /// Writers may start runs: the bookmarks to offer, default first.
32
    can_run: bool,
33
    bookmarks: Vec<String>,
34
    error: Option<String>,
4f692533 Andy McCall ↶ 35
    /// Why this viewer is not offered "Run pipeline", when they are not.
36
    why_not: Option<String>,
42fa9554 Andy McCall ↶ 37
}
38
39
#[derive(Deserialize)]
40
pub struct RunsQuery {
41
    before: Option<i64>,
1edac4b6 Andy McCall ↶ 42
    /// Why a "Run pipeline" or "Re-run" did not start.
43
    error: Option<String>,
42fa9554 Andy McCall ↶ 44
}
45
4f692533 Andy McCall ↶ 46
/// Why `viewer` may not start runs here, or `None` when they may.
47
pub fn why_not_run(enabled: bool, signed_in: bool, role: Role) -> Option<String> {
48
    if !enabled {
49
        Some("Flow is off for this repository; a site administrator can turn it on in Settings → Flow.".into())
50
    } else if !signed_in {
51
        Some("Sign in with write access to run the pipeline.".into())
52
    } else if role < Role::Write {
53
        Some("Running the pipeline needs write access to this repository.".into())
54
    } else {
55
        None
56
    }
57
}
58
42fa9554 Andy McCall ↶ 59
const PER_PAGE: i64 = 30;
60
61
pub async fn runs(
62
    State(app): State<Shared>,
63
    viewer: Viewer,
64
    Path((owner, name)): Path<(String, String)>,
65
    Query(q): Query<RunsQuery>,
66
) -> Result<Page<RunsPage>, Error> {
67
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow"), &viewer);
68
    let (_repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
69
    let list = fdb::runs(&app.db, row.id, PER_PAGE + 1, q.before).await.map_err(|e| Error::from_db(shell.clone(), e))?;
70
    let older = (list.len() as i64 > PER_PAGE).then(|| list[PER_PAGE as usize - 1].id);
bf3d0754 Andy McCall ↶ 71
    let queue = if list.iter().any(|r| r.live()) { fdb::queue(&app.db).await.unwrap_or_default() } else { vec![] };
42fa9554 Andy McCall ↶ 72
    let mut runs = Vec::new();
73
    for r in list.into_iter().take(PER_PAGE as usize) {
bf3d0754 Andy McCall ↶ 74
        let place = if r.live() { crate::flow::queue_info(&queue, row.id, r.id).place() } else { None };
42fa9554 Andy McCall ↶ 75
        let jobs = fdb::jobs(&app.db, r.id).await.unwrap_or_default();
76
        let duration = match r.finished_ms {
77
            Some(f) => crate::flow::human_ms(f - r.created_ms),
78
            None if r.live() => crate::flow::human_ms(db::now_ms() - r.created_ms),
79
            None => "–".into(),
80
        };
bf3d0754 Andy McCall ↶ 81
        runs.push(RunRow { jobs: jobs.into_iter().map(|j| (j.name, j.status)).collect(), duration, r, place });
42fa9554 Andy McCall ↶ 82
    }
9008bf6c Andy McCall ↶ 83
    let enabled = crate::flow::enabled(&app, &row);
4f692533 Andy McCall ↶ 84
    let why_not = why_not_run(enabled, viewer.account().is_some(), role);
85
    let can_run = why_not.is_none();
1edac4b6 Andy McCall ↶ 86
    let bookmarks = if can_run { bookmark_names(&app, &row).await } else { vec![] };
87
    Ok(Page(RunsPage {
88
        shell,
89
        repo: RepoShell::new(&app, &row, "flow").with_role(role),
90
        runs,
91
        enabled,
92
        older,
93
        can_run,
94
        bookmarks,
95
        error: q.error,
4f692533 Andy McCall ↶ 96
        why_not,
1edac4b6 Andy McCall ↶ 97
    }))
98
}
99
100
/// The repository's bookmarks, its default first.
101
async fn bookmark_names(app: &Shared, row: &db::repos::RepoRow) -> Vec<String> {
102
    let Some(repo) = crate::repos::RepoName::new(&row.owner, &row.name) else { return vec![] };
103
    let mut names: Vec<String> = app.repos.read(&repo, |r, _| Ok(r.view()?.bookmarks.keys().cloned().collect())).await.unwrap_or_default();
104
    names.sort_by_key(|n| (n != &row.default_bookmark, n.clone()));
105
    names
106
}
107
108
#[derive(Deserialize)]
109
pub struct StartForm {
110
    #[serde(rename = "_csrf")]
111
    csrf_token: String,
4f692533 Andy McCall ↶ 112
    #[serde(default)]
1edac4b6 Andy McCall ↶ 113
    bookmark: String,
4f692533 Andy McCall ↶ 114
    /// A change's full hash: run the state whose only head it is.
115
    #[serde(default)]
116
    change: String,
1edac4b6 Andy McCall ↶ 117
}
118
4f692533 Andy McCall ↶ 119
/// `POST /{owner}/{name}/flow/start`: "Run pipeline" on a bookmark's
120
/// current state, or on one committed change.
1edac4b6 Andy McCall ↶ 121
pub async fn start(
122
    State(app): State<Shared>,
123
    viewer: Viewer,
124
    Path((owner, name)): Path<(String, String)>,
125
    Form(f): Form<StartForm>,
126
) -> Result<Response, Error> {
127
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow"), &viewer);
128
    let me = require(&viewer, &shell)?;
129
    let (_, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
130
    csrf(&viewer, &f.csrf_token, &shell)?;
4f692533 Andy McCall ↶ 131
    let (started, what) = if f.change.trim().is_empty() {
0650d94e Andy McCall ↶ 132
        (crate::flow::run_bookmark(&app, &row, f.bookmark.trim(), &me.account.username, &[]).await, f.bookmark.trim().to_string())
4f692533 Andy McCall ↶ 133
    } else {
0650d94e Andy McCall ↶ 134
        (crate::flow::run_change(&app, &row, &f.change, &me.account.username, &[]).await, format!("change {}", f.change.trim()))
4f692533 Andy McCall ↶ 135
    };
136
    Ok(match started {
1edac4b6 Andy McCall ↶ 137
        Ok(n) => {
4f692533 Andy McCall ↶ 138
            db::accounts::audit(&app.db, Some(&me.account), "flow.run", &format!("{owner}/{name}"), &format!("#{n} {what}")).await.ok();
1edac4b6 Andy McCall ↶ 139
            Redirect::to(&format!("/{owner}/{name}/flow/{n}")).into_response()
140
        }
141
        Err(msg) => Redirect::to(&format!("/{owner}/{name}/flow?error={}", urlencoding(&msg))).into_response(),
142
    })
143
}
144
145
#[derive(Deserialize)]
146
pub struct RerunForm {
147
    #[serde(rename = "_csrf")]
148
    csrf_token: String,
149
}
150
151
/// `POST /{owner}/{name}/flow/{number}/rerun`.
152
pub async fn rerun(
153
    State(app): State<Shared>,
154
    viewer: Viewer,
155
    Path((owner, name, number)): Path<(String, String, i64)>,
156
    Form(f): Form<RerunForm>,
157
) -> Result<Response, Error> {
158
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{number}"), &viewer);
159
    let me = require(&viewer, &shell)?;
160
    let (_, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
161
    csrf(&viewer, &f.csrf_token, &shell)?;
162
    let run = fdb::run(&app.db, row.id, number)
163
        .await
164
        .map_err(|e| Error::from_db(shell.clone(), e))?
165
        .ok_or_else(|| Error::not_found(shell.clone()))?;
166
    Ok(match crate::flow::rerun(&app, &row, &run, &me.account.username).await {
167
        Ok(n) => {
168
            db::accounts::audit(&app.db, Some(&me.account), "flow.rerun", &format!("{owner}/{name}"), &format!("#{n} of #{number}"))
169
                .await
170
                .ok();
171
            Redirect::to(&format!("/{owner}/{name}/flow/{n}")).into_response()
172
        }
173
        Err(msg) => Redirect::to(&format!("/{owner}/{name}/flow?error={}", urlencoding(&msg))).into_response(),
174
    })
175
}
176
e8fa5369 Andy McCall ↶ 177
/// `POST /{owner}/{name}/flow/{number}/jobs/{job}/rerun` (oxygenflow#31).
178
pub async fn rerun_job(
179
    State(app): State<Shared>,
180
    viewer: Viewer,
181
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
182
    Form(f): Form<RerunForm>,
183
) -> Result<Response, Error> {
184
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{number}"), &viewer);
185
    let me = require(&viewer, &shell)?;
186
    let (_, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
187
    csrf(&viewer, &f.csrf_token, &shell)?;
188
    let run = fdb::run(&app.db, row.id, number)
189
        .await
190
        .map_err(|e| Error::from_db(shell.clone(), e))?
191
        .ok_or_else(|| Error::not_found(shell.clone()))?;
192
    Ok(match crate::flow::rerun_job(&app, &row, &run, &job, &me.account.username).await {
193
        Ok(_) => {
194
            db::accounts::audit(&app.db, Some(&me.account), "flow.rerun", &format!("{owner}/{name}"), &format!("{job} of #{number}"))
195
                .await
196
                .ok();
197
            Redirect::to(&format!("/{owner}/{name}/flow/{number}")).into_response()
198
        }
199
        Err(msg) => Redirect::to(&format!("/{owner}/{name}/flow?error={}", urlencoding(&msg))).into_response(),
200
    })
201
}
202
745d225d Andy McCall ↶ 203
/// `POST /{owner}/{name}/flow/{number}/cancel` (oxygenflow#32).
204
pub async fn cancel(
205
    State(app): State<Shared>,
206
    viewer: Viewer,
207
    Path((owner, name, number)): Path<(String, String, i64)>,
208
    Form(f): Form<RerunForm>,
209
) -> Result<Response, Error> {
210
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{number}"), &viewer);
211
    let me = require(&viewer, &shell)?;
212
    let (_, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
213
    csrf(&viewer, &f.csrf_token, &shell)?;
214
    let run = fdb::run(&app.db, row.id, number)
215
        .await
216
        .map_err(|e| Error::from_db(shell.clone(), e))?
217
        .ok_or_else(|| Error::not_found(shell.clone()))?;
218
    Ok(match crate::flow::cancel(&app, &row, &run, &me.account.username).await {
219
        Ok(()) => {
220
            db::accounts::audit(&app.db, Some(&me.account), "flow.cancel", &format!("{owner}/{name}"), &format!("#{number}")).await.ok();
221
            Redirect::to(&format!("/{owner}/{name}/flow/{number}")).into_response()
222
        }
223
        Err(msg) => Redirect::to(&format!("/{owner}/{name}/flow?error={}", urlencoding(&msg))).into_response(),
224
    })
225
}
226
1edac4b6 Andy McCall ↶ 227
/// Percent-encode a message for a query string.
228
fn urlencoding(s: &str) -> String {
229
    s.bytes()
230
        .map(|b| match b {
231
            b'A'..=b'Z' | b'a'..=b'z' | b'0'..=b'9' | b'-' | b'.' | b'_' | b'~' => (b as char).to_string(),
232
            _ => format!("%{b:02X}"),
233
        })
234
        .collect()
42fa9554 Andy McCall ↶ 235
}
236
237
/// A job placed in the graph.
238
pub struct Node {
239
    pub j: fdb::Job,
240
    pub x: i64,
241
    pub y: i64,
242
    pub duration: String,
243
}
244
245
pub struct Edge {
246
    pub d: String,
247
    pub status: String,
248
}
249
250
pub struct Graph {
251
    pub nodes: Vec<Node>,
252
    pub edges: Vec<Edge>,
253
    pub width: i64,
254
    pub height: i64,
255
}
256
257
pub const NODE_W: i64 = 200;
258
pub const NODE_H: i64 = 48;
259
const COL_GAP: i64 = 72;
260
const ROW_GAP: i64 = 18;
261
const PAD: i64 = 12;
262
263
/// Columns by dependency depth, jobs in each column in name order.
264
pub fn layout(jobs: Vec<fdb::Job>) -> Graph {
265
    let mut by_depth: std::collections::BTreeMap<i64, Vec<fdb::Job>> = Default::default();
266
    for j in jobs {
267
        by_depth.entry(j.depth).or_default().push(j);
268
    }
269
    let rows = by_depth.values().map(Vec::len).max().unwrap_or(0) as i64;
270
    let height = PAD * 2 + rows * NODE_H + (rows - 1).max(0) * ROW_GAP;
271
    let mut nodes = Vec::new();
272
    for (col, (_, mut js)) in by_depth.into_iter().enumerate() {
273
        js.sort_by(|a, b| a.name.cmp(&b.name));
274
        let n = js.len() as i64;
275
        let column_h = n * NODE_H + (n - 1).max(0) * ROW_GAP;
276
        let top = (height - column_h) / 2;
277
        for (i, j) in js.into_iter().enumerate() {
278
            let duration = crate::flow::duration(&j);
279
            nodes.push(Node { x: PAD + col as i64 * (NODE_W + COL_GAP), y: top + i as i64 * (NODE_H + ROW_GAP), duration, j });
280
        }
281
    }
282
    let mut edges = Vec::new();
283
    for n in &nodes {
284
        for d in n.j.depends_on() {
285
            if let Some(from) = nodes.iter().find(|m| m.j.name == d) {
286
                let (x1, y1) = (from.x + NODE_W, from.y + NODE_H / 2);
287
                let (x2, y2) = (n.x, n.y + NODE_H / 2);
288
                let mid = (x1 + x2) / 2;
289
                edges.push(Edge { d: format!("M{x1},{y1} C{mid},{y1} {mid},{y2} {x2},{y2}"), status: from.j.status.clone() });
290
            }
291
        }
292
    }
293
    let cols = nodes.iter().map(|n| n.x).max().map(|x| x + NODE_W + PAD).unwrap_or(PAD * 2);
294
    Graph { nodes, edges, width: cols, height: height.max(NODE_H + PAD * 2) }
295
}
296
297
pub fn glyph(status: &str) -> &'static str {
298
    match status {
299
        "passed" => "✓",
300
        "failed" => "✕",
301
        "running" => "●",
302
        "skipped" => "⤼",
745d225d Andy McCall ↶ 303
        "cancelled" => "⊘",
42fa9554 Andy McCall ↶ 304
        "error" => "!",
305
        _ => "○",
306
    }
307
}
308
0b203bbf Andy McCall ↶ 309
/// Failed tests a run page lists per job; the rest are counted.
310
const SHOWN_FAILURES: i64 = 50;
311
42fa9554 Andy McCall ↶ 312
pub struct JobLog {
313
    pub j: fdb::Job,
a3c8288b Andy McCall ↶ 314
    pub artifacts: Vec<fdb::Artifact>,
42fa9554 Andy McCall ↶ 315
    pub lines: Vec<fdb::LogLine>,
316
    pub duration: String,
317
    /// The last line shown; the live view asks for what follows.
318
    pub last_seq: i64,
554ccacf Andy McCall ↶ 319
    /// The job's coverage report, when it uploaded one (#113): its id and percentage.
320
    pub coverage: Option<(i64, String)>,
0b203bbf Andy McCall ↶ 321
    /// The job's test report, when it uploaded one (#114), and its first
322
    /// failures.
323
    pub tests: Option<crate::junit::Report>,
324
    pub failures: Vec<crate::junit::Case>,
42fa9554 Andy McCall ↶ 325
}
326
327
#[derive(Template)]
328
#[template(path = "flow_run.html")]
329
pub struct RunPage {
330
    shell: Shell,
331
    repo: RepoShell,
332
    run: fdb::Run,
333
    graph: Graph,
334
    logs: Vec<JobLog>,
335
    duration: String,
1edac4b6 Andy McCall ↶ 336
    /// Whether the viewer may re-run it.
337
    can_rerun: bool,
745d225d Andy McCall ↶ 338
    /// Whether the viewer may cancel it.
339
    can_cancel: bool,
bf3d0754 Andy McCall ↶ 340
    /// Where a live run stands among the runners' work.
341
    queue: Option<crate::flow::QueueInfo>,
10708ab8 Andy McCall ↶ 342
    /// Releases a writer may attach this run's artifacts to.
343
    releases: Vec<db::releases::Release>,
42fa9554 Andy McCall ↶ 344
}
345
346
/// Lines of a job's log a page shows before "the rest is loaded as it comes".
347
const PAGE_LINES: i64 = 5000;
348
349
pub async fn run(
350
    State(app): State<Shared>,
351
    viewer: Viewer,
352
    Path((owner, name, id)): Path<(String, String, i64)>,
353
) -> Result<Page<RunPage>, Error> {
354
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}"), &viewer);
355
    let (_repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
356
    let run = fdb::run(&app.db, row.id, id)
357
        .await
358
        .map_err(|e| Error::from_db(shell.clone(), e))?
359
        .ok_or_else(|| Error::not_found(shell.clone()))?;
360
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
554ccacf Andy McCall ↶ 361
    let reports = crate::coverage::for_run(&app.db, run.id).await.unwrap_or_default();
0b203bbf Andy McCall ↶ 362
    let test_reports = crate::junit::for_run(&app.db, run.id).await.unwrap_or_default();
42fa9554 Andy McCall ↶ 363
    let mut logs = Vec::new();
364
    for j in &jobs {
365
        let lines = fdb::log(&app.db, j.id, 0, PAGE_LINES).await.unwrap_or_default();
366
        let last_seq = lines.last().map(|l| l.seq).unwrap_or(0);
a3c8288b Andy McCall ↶ 367
        let artifacts = fdb::artifacts(&app.db, j.id).await.unwrap_or_default();
554ccacf Andy McCall ↶ 368
        let coverage = reports
369
            .iter()
40dd3f86 Andy McCall ↶ 370
            .find(|r| r.job_id == Some(j.id))
554ccacf Andy McCall ↶ 371
            .map(|r| (r.id, r.percent().map(|p| format!("{p:.1}%")).unwrap_or_else(|| "no lines".into())));
0b203bbf Andy McCall ↶ 372
        let tests = test_reports.iter().find(|r| r.job_id == j.id).cloned();
373
        let failures = match &tests {
374
            Some(r) if r.broken() > 0 => crate::junit::failures(&app.db, r.id, SHOWN_FAILURES).await.unwrap_or_default(),
375
            _ => vec![],
376
        };
377
        logs.push(JobLog { duration: crate::flow::duration(j), j: j.clone(), artifacts, lines, last_seq, coverage, tests, failures });
42fa9554 Andy McCall ↶ 378
    }
379
    let duration = match run.finished_ms {
380
        Some(f) => crate::flow::human_ms(f - run.created_ms),
381
        None => crate::flow::human_ms(db::now_ms() - run.created_ms),
382
    };
383
    let graph = layout(jobs);
745d225d Andy McCall ↶ 384
    let can_write = viewer.account().is_some() && role >= Role::Write;
385
    let can_rerun = !run.live() && can_write && crate::flow::enabled(&app, &row);
386
    let can_cancel = run.live() && can_write;
bf3d0754 Andy McCall ↶ 387
    let queue = if run.live() {
388
        let q = fdb::queue(&app.db).await.unwrap_or_default();
389
        Some(crate::flow::queue_info(&q, row.id, run.id)).filter(|i| i.position.is_some())
390
    } else {
391
        None
10708ab8 Andy McCall ↶ 392
    };
393
    let releases = if viewer.account().is_some() && role >= Role::Write && logs.iter().any(|l| !l.artifacts.is_empty()) {
394
        db::releases::list(&app.db, row.id).await.unwrap_or_default()
395
    } else {
396
        vec![]
bf3d0754 Andy McCall ↶ 397
    };
10708ab8 Andy McCall ↶ 398
    Ok(Page(RunPage {
399
        shell,
400
        repo: RepoShell::new(&app, &row, "flow").with_role(role),
401
        run,
402
        graph,
403
        logs,
404
        duration,
405
        can_rerun,
745d225d Andy McCall ↶ 406
        can_cancel,
10708ab8 Andy McCall ↶ 407
        queue,
408
        releases,
409
    }))
42fa9554 Andy McCall ↶ 410
}
411
412
#[derive(Deserialize)]
413
pub struct LiveQuery {
414
    /// `job:seq,job:seq`: the last log line each open job already shows.
415
    after: Option<String>,
416
}
417
418
/// `GET /{owner}/{name}/flow/{id}/live`: statuses and new log lines, for the
419
/// run page while it is live.
420
pub async fn live(
421
    State(app): State<Shared>,
422
    viewer: Viewer,
423
    Path((owner, name, id)): Path<(String, String, i64)>,
424
    Query(q): Query<LiveQuery>,
425
) -> Result<Response, Error> {
426
    let shell = Shell::new(&app, "", &viewer);
427
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
428
    let run = fdb::run(&app.db, row.id, id)
429
        .await
430
        .map_err(|e| Error::from_db(shell.clone(), e))?
431
        .ok_or_else(|| Error::not_found(shell.clone()))?;
432
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
433
    let after: std::collections::HashMap<i64, i64> = q
434
        .after
435
        .unwrap_or_default()
436
        .split(',')
437
        .filter_map(|p| p.split_once(':'))
438
        .filter_map(|(a, b)| Some((a.parse().ok()?, b.parse().ok()?)))
439
        .collect();
440
    let mut out = Vec::new();
441
    for j in &jobs {
442
        let lines = match after.get(&j.id) {
443
            Some(seq) => fdb::log(&app.db, j.id, *seq, 1000).await.unwrap_or_default(),
444
            None => vec![],
445
        };
446
        out.push(serde_json::json!({
447
            "id": j.id,
448
            "name": j.name,
449
            "status": j.status,
450
            "glyph": glyph(&j.status),
451
            "duration": crate::flow::duration(j),
452
            "exit_code": j.exit_code,
453
            "lines": lines.iter().map(|l| serde_json::json!({ "seq": l.seq, "t": l.t, "stream": l.stream, "text": l.text })).collect::<Vec<_>>(),
454
        }));
455
    }
456
    Ok(Json(serde_json::json!({ "status": run.status, "live": run.live(), "jobs": out })).into_response())
457
}
736f6813 Andy McCall ↶ 458
459
// ------------------------------------------------------------ state stamps
460
461
/// In rendered Markdown, the image path that is the viewed state's stamp.
462
pub const STAMP_IMAGE: &str = ".flow/stamp";
463
/// In rendered Markdown, the link path to the viewed state's run.
464
pub const RUN_LINK: &str = ".flow/run";
465
466
/// Resolve a ref to its state address, and whether the ref can move.
467
async fn state_of(app: &Shared, owner: &str, name: &str, r: &str) -> Result<(String, bool), crate::repos::RepoError> {
468
    let repo = crate::repos::RepoName::new(owner, name).ok_or(crate::repos::RepoError::NotFound)?;
469
    let spec = r.to_string();
470
    app.repos
471
        .read(&repo, move |repo, cache| {
472
            let t = crate::repos::view::resolve(repo, cache, &spec)?;
473
            let moves = matches!(t.kind, crate::repos::view::RefKind::Bookmark | crate::repos::view::RefKind::Tag);
474
            Ok((t.permalink().unwrap_or_default(), moves))
475
        })
476
        .await
477
}
478
479
/// `GET /{owner}/{name}/flow/stamp/{ref}` (hub spec §13.2).
480
pub async fn stamp(
481
    State(app): State<Shared>,
482
    viewer: Viewer,
483
    Path((owner, name, r)): Path<(String, String, String)>,
484
) -> Result<Response, Error> {
485
    let shell = Shell::new(&app, "", &viewer);
486
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
487
    let (heads, moves) = state_of(&app, &owner, &name, &r).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
488
    if moves && !heads.is_empty() {
489
        let mut res = axum::response::Redirect::to(&format!("/{owner}/{name}/flow/stamp/{heads}")).into_response();
490
        res.headers_mut().insert(axum::http::header::CACHE_CONTROL, axum::http::HeaderValue::from_static("no-cache"));
491
        return Ok(res);
492
    }
493
    let run = fdb::latest_for_heads(&app.db, row.id, &heads).await.map_err(|e| Error::from_db(shell.clone(), e))?;
494
    let jobs = match &run {
495
        Some(r) => fdb::jobs(&app.db, r.id).await.map_err(|e| Error::from_db(shell.clone(), e))?,
496
        None => vec![],
497
    };
498
    let svg = stamp_svg(&heads, run.as_ref(), &jobs);
499
    let cache = if run.as_ref().is_some_and(|r| !r.live()) { "public, max-age=3600" } else { "public, max-age=60" };
500
    Ok((
501
        [
502
            (axum::http::header::CONTENT_TYPE, "image/svg+xml; charset=utf-8"),
503
            (axum::http::header::CACHE_CONTROL, cache),
504
            (axum::http::header::CONTENT_SECURITY_POLICY, "default-src 'none'; style-src 'unsafe-inline'"),
505
        ],
506
        svg,
507
    )
508
        .into_response())
509
}
510
511
/// `GET /{owner}/{name}/flow/at/{ref}`: the run of the ref's state, or the Flow tab.
512
pub async fn at(
513
    State(app): State<Shared>,
514
    viewer: Viewer,
515
    Path((owner, name, r)): Path<(String, String, String)>,
516
) -> Result<Response, Error> {
517
    let shell = Shell::new(&app, "", &viewer);
518
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
519
    let (heads, _) = state_of(&app, &owner, &name, &r).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
520
    let run = fdb::latest_for_heads(&app.db, row.id, &heads).await.map_err(|e| Error::from_db(shell.clone(), e))?;
521
    let to = match run {
a0d4bbfb Andy McCall ↶ 522
        Some(r) => format!("/{owner}/{name}/flow/{}", r.number),
736f6813 Andy McCall ↶ 523
        None => format!("/{owner}/{name}/flow"),
524
    };
525
    Ok(axum::response::Redirect::to(&to).into_response())
526
}
527
528
fn xml(s: &str) -> String {
529
    s.replace('&', "&amp;").replace('<', "&lt;").replace('>', "&gt;").replace('"', "&quot;")
530
}
531
532
/// The stamp: the mark, one glyph per job, the status, the state and the
533
/// date; the same facts machine-readable in `<metadata>`. Fixed colours,
534
/// because an image does not follow the page's theme.
535
pub fn stamp_svg(heads: &str, run: Option<&fdb::Run>, jobs: &[fdb::Job]) -> String {
536
    const CH: f64 = 6.6; // IBM Plex Mono at 11px
537
    let colour = |s: &str| match s {
538
        "passed" => "#5fe3a1",
539
        "failed" | "error" => "#ff5e7a",
540
        "running" => "#00e0f0",
541
        _ => "#8592ad",
542
    };
543
    let short: String = heads.chars().take(12).collect();
544
    let (status, date) = match run {
545
        Some(r) => (r.status.as_str(), crate::render::time::absolute(r.created_ms as u64).chars().take(10).collect::<String>()),
546
        None => ("no run", String::new()),
547
    };
548
    let mut ordered: Vec<&fdb::Job> = jobs.iter().collect();
549
    ordered.sort_by(|a, b| (a.depth, &a.name).cmp(&(b.depth, &b.name)));
550
    let label = "OXYGENFLOW";
551
    let label_w = 14.0 + label.len() as f64 * 6.2 + 8.0;
552
    let glyphs_w = if ordered.is_empty() { 0.0 } else { ordered.len() as f64 * 10.0 + 6.0 };
553
    let tail = if date.is_empty() { format!("{status} · {short}") } else { format!("{status} · {short} · {date}") };
554
    let right_w = 8.0 + glyphs_w + tail.chars().count() as f64 * CH + 8.0;
555
    let w = (label_w + right_w).ceil();
556
    let mut glyphs = String::new();
557
    for (i, j) in ordered.iter().enumerate() {
558
        let x = label_w + 8.0 + i as f64 * 10.0 + 4.0;
559
        glyphs.push_str(&format!(
560
            r#"<text x="{x:.1}" y="15" fill="{}" text-anchor="middle">{}</text>"#,
561
            colour(&j.status),
562
            glyph(&j.status)
563
        ));
564
    }
565
    let meta = serde_json::json!({
566
        "heads": heads.split('+').filter(|h| !h.is_empty()).collect::<Vec<_>>(),
a0d4bbfb Andy McCall ↶ 567
        "run": run.map(|r| r.number),
736f6813 Andy McCall ↶ 568
        "status": status,
569
        "jobs": ordered.iter().map(|j| serde_json::json!({ "name": j.name, "status": j.status, "receipt": j.receipt_hash })).collect::<Vec<_>>(),
570
    });
571
    let title = match run {
a0d4bbfb Andy McCall ↶ 572
        Some(r) => format!("OxygenFlow run #{} {status} on state {short}", r.number),
736f6813 Andy McCall ↶ 573
        None => format!("OxygenFlow: no run for state {short}"),
574
    };
575
    format!(
576
        r##"<svg xmlns="http://www.w3.org/2000/svg" width="{w}" height="22" viewBox="0 0 {w} 22" role="img" aria-label="{t}"><title>{t}</title><metadata>{m}</metadata><rect width="{w}" height="22" rx="4" fill="#0e1526"/><rect width="{lw:.1}" height="22" rx="4" fill="#0b3f9e"/><rect x="{lx:.1}" width="4" height="22" fill="#0b3f9e"/><circle cx="9" cy="11" r="3.2" fill="none" stroke="#00f0ff" stroke-width="1.6"/><text x="16" y="15" fill="#ffffff" font-family="Barlow, Verdana, sans-serif" font-size="10.5" font-weight="700" letter-spacing=".6">{label}</text><g font-family="IBM Plex Mono, ui-monospace, monospace" font-size="11">{glyphs}<text x="{tx:.1}" y="15" fill="{sc}">{tail}</text></g><rect x=".5" y=".5" width="{wi}" height="21" rx="3.5" fill="none" stroke="#1f2b47"/></svg>"##,
577
        t = xml(&title),
578
        m = xml(&meta.to_string()),
579
        lw = label_w,
580
        lx = label_w - 4.0,
581
        tx = label_w + 8.0 + glyphs_w,
582
        sc = colour(status),
583
        tail = xml(&tail),
584
        wi = w - 1.0,
585
    )
586
}
cc19697f Andy McCall ↶ 587
588
/// A receipt kept in a repository (Oxygen spec §14.6), as pages show it.
589
#[derive(Clone, Debug)]
590
pub struct ReceiptRow {
591
    pub attest: String,
592
    pub job: String,
593
    pub exit_code: u32,
594
    pub duration: String,
595
    pub runner: String,
596
    pub run: String,
597
    /// Why it does not verify, or that its runner's key was revoked.
598
    pub problem: String,
599
    pub made_ms: i64,
600
}
601
602
impl ReceiptRow {
603
    pub fn passed(&self) -> bool {
604
        self.exit_code == 0
605
    }
606
}
607
608
/// The receipts kept for the state of `heads`.
609
pub async fn receipts_of(app: &Shared, name: &crate::repos::RepoName, heads: Vec<oxy_core::hash::ChangeHash>) -> Vec<ReceiptRow> {
610
    let base = app.config.base_url();
611
    let found = app.repos.read(name, move |repo, _| Ok(repo.receipts(&heads)?)).await.unwrap_or_default();
612
    found
613
        .into_iter()
614
        .map(|i| {
615
            let r = &i.signed.receipt;
616
            let run = i.signed.run().to_string();
617
            ReceiptRow {
618
                attest: i.attest.to_hex(),
619
                job: r.job_name.clone(),
620
                exit_code: r.exit_code,
621
                duration: crate::flow::human_ms(r.duration_ms as i64),
622
                runner: i.signed.runner.name.clone(),
623
                // Only links to this hub are followed from the page.
624
                run: if run.starts_with(base) { run } else { String::new() },
625
                problem: match (i.problem, i.revoked) {
626
                    (Some(p), _) => p,
627
                    (None, true) => "the runner's key was revoked".into(),
628
                    (None, false) => String::new(),
629
                },
630
                made_ms: i.signed.attest.hlc.wall_ms as i64,
631
            }
632
        })
633
        .collect()
634
}
635
636
/// `GET /{owner}/{name}/receipts/{attest}`: a signed receipt, for
637
/// `oxy receipt verify` or `oxy receipt import`.
638
pub async fn receipt_file(
639
    State(app): State<Shared>,
640
    viewer: Viewer,
641
    Path((owner, name, attest)): Path<(String, String, String)>,
642
) -> Result<Response, Error> {
643
    let shell = Shell::new(&app, &format!("/{owner}/{name}/receipts/{attest}"), &viewer);
644
    let (repo, _row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
645
    let Some(r) = oxy_core::hash::ObjectRef::from_hex(attest.trim_end_matches(".receipt")) else {
646
        return Err(Error::not_found(shell));
647
    };
648
    let (job, bytes) = app
649
        .repos
650
        .read(&repo, move |repo, _| {
651
            let i = repo.receipt(&r)?;
652
            Ok((i.signed.receipt.job_name.clone(), i.signed.encode()))
653
        })
654
        .await
655
        .map_err(|_| Error::not_found(shell.clone()))?;
656
    let file: String = job.chars().filter(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')).collect();
657
    Ok((
658
        [
659
            (axum::http::header::CONTENT_TYPE, "application/oxy-receipt".to_string()),
660
            (axum::http::header::CONTENT_DISPOSITION, format!("attachment; filename=\"{file}-{}.receipt\"", r.short(12))),
a3c8288b Andy McCall ↶ 661
        ],
662
        bytes,
663
    )
664
        .into_response())
665
}
666
667
/// `GET /{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}`: an artifact
668
/// of a run's job, read from the repository.
669
pub async fn artifact_file(
670
    State(app): State<Shared>,
671
    viewer: Viewer,
672
    Path((owner, name, id, job, artifact)): Path<(String, String, i64, String, String)>,
673
) -> Result<Response, Error> {
674
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}"), &viewer);
675
    let (repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
676
    let run = fdb::run(&app.db, row.id, id)
677
        .await
678
        .map_err(|e| Error::from_db(shell.clone(), e))?
679
        .ok_or_else(|| Error::not_found(shell.clone()))?;
680
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
681
    let Some(j) = jobs.iter().find(|j| j.name == job) else { return Err(Error::not_found(shell)) };
682
    let arts = fdb::artifacts(&app.db, j.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
683
    let Some(a) = arts.into_iter().find(|a| a.name == artifact) else { return Err(Error::not_found(shell)) };
684
    let Some(blob) = oxy_core::hash::ObjectRef::from_hex(&a.blob) else { return Err(Error::not_found(shell)) };
685
    let bytes = app.repos.read(&repo, move |r, _| Ok(r.read_blob(&blob)?)).await.map_err(|_| Error::not_found(shell.clone()))?;
686
    let file = a.path.rsplit('/').next().unwrap_or(&a.name).to_string();
687
    Ok((
688
        [
689
            (axum::http::header::CONTENT_TYPE, "application/octet-stream".to_string()),
690
            (axum::http::header::CONTENT_DISPOSITION, format!("attachment; filename=\"{}\"", file.replace('"', ""))),
cc19697f Andy McCall ↶ 691
        ],
692
        bytes,
693
    )
694
        .into_response())
10708ab8 Andy McCall ↶ 695
}
696
697
#[derive(Deserialize)]
698
pub struct AttachForm {
699
    _csrf: String,
700
    release: i64,
701
}
702
703
/// `POST /{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}/attach`: add
704
/// an artifact to a release as an asset, named after its path; the release
705
/// page then shows the run and receipt that built it.
706
pub async fn attach(
707
    State(app): State<Shared>,
708
    viewer: Viewer,
709
    Path((owner, name, id, job, artifact)): Path<(String, String, i64, String, String)>,
710
    Form(f): Form<AttachForm>,
711
) -> Result<Response, Error> {
712
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}"), &viewer);
713
    require(&viewer, &shell)?;
714
    csrf(&viewer, &f._csrf, &shell)?;
715
    let (repo, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
716
    let run = fdb::run(&app.db, row.id, id)
717
        .await
718
        .map_err(|e| Error::from_db(shell.clone(), e))?
719
        .ok_or_else(|| Error::not_found(shell.clone()))?;
720
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
721
    let Some(j) = jobs.iter().find(|j| j.name == job) else { return Err(Error::not_found(shell)) };
6f52a041 Andy McCall ↶ 722
    // A failing job's `when "always"` artifacts are not in its receipt, so
723
    // they cannot stand for a release (oxygenflow#37).
724
    if j.status != "passed" {
725
        return Err(Error::bad(shell, "only a passing job's artifacts can be attached to a release"));
726
    }
10708ab8 Andy McCall ↶ 727
    let arts = fdb::artifacts(&app.db, j.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
728
    let Some(a) = arts.into_iter().find(|a| a.name == artifact) else { return Err(Error::not_found(shell)) };
729
    let releases = db::releases::list(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
730
    let Some(rel) = releases.into_iter().find(|r| r.id == f.release) else { return Err(Error::not_found(shell)) };
731
    let Some(blob) = oxy_core::hash::ObjectRef::from_hex(&a.blob) else { return Err(Error::not_found(shell)) };
732
    let bytes = app.repos.read(&repo, move |r, _| Ok(r.read_blob(&blob)?)).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
733
    let file = a.path.rsplit('/').next().unwrap_or(&a.name).to_string();
734
    super::releases::store_asset(&app, rel.id, &file, "application/octet-stream", &bytes)
735
        .await
736
        .map_err(|m| Error::bad(shell.clone(), m))?;
737
    Ok(Redirect::to(&format!("/{owner}/{name}/releases/tag/{}", rel.tag)).into_response())
cc19697f Andy McCall ↶ 738
}
8933faff Andy McCall ↶ 739
740
/// `/{owner}/{name}/flow/badge.svg`: the latest run on the default
741
/// bookmark as a small SVG for a README, for whoever may read the
742
/// repository. `passed` green, `failed` or `error` red, a run still going
743
/// blue, none grey.
744
pub async fn badge(
745
    State(app): State<Shared>,
746
    viewer: Viewer,
747
    Path((owner, name)): Path<(String, String)>,
748
) -> Result<axum::response::Response, Error> {
749
    use axum::response::IntoResponse;
750
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow"), &viewer);
751
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
752
    let latest = fdb::latest_on(&app.db, row.id, &row.default_bookmark).await.map_err(|e| Error::from_db(shell.clone(), e))?;
753
    let (text, colour) = match latest.as_ref().map(|r| r.status.as_str()) {
754
        Some("passed") => ("passing", "#2da44e"),
755
        Some("failed") | Some("error") => ("failing", "#cf222e"),
756
        Some("cancelled") => ("cancelled", "#6e7781"),
757
        Some(_) => ("running", "#0969da"),
758
        None => ("no runs", "#6e7781"),
759
    };
760
    let label = "OxygenFlow";
761
    let (lw, tw) = (label.len() as u32 * 7 + 10, text.len() as u32 * 7 + 10);
762
    let svg = format!(
763
        r##"<svg xmlns="http://www.w3.org/2000/svg" width="{w}" height="20" role="img" aria-label="{label}: {text}"><title>{label}: {text}</title><rect width="{lw}" height="20" rx="3" fill="#555"/><rect x="{lw}" width="{tw}" height="20" rx="3" fill="{colour}"/><rect x="{lw}" width="4" height="20" fill="{colour}"/><g fill="#fff" font-family="Verdana,DejaVu Sans,sans-serif" font-size="11" text-anchor="middle"><text x="{lx}" y="14">{label}</text><text x="{tx}" y="14">{text}</text></g></svg>"##,
764
        w = lw + tw,
765
        lx = lw / 2,
766
        tx = lw + tw / 2,
767
    );
768
    Ok((
769
        [(axum::http::header::CONTENT_TYPE, "image/svg+xml; charset=utf-8"), (axum::http::header::CACHE_CONTROL, "no-cache, max-age=60")],
770
        svg,
771
    )
772
        .into_response())
773
}