OXYGENHUB
# a2ef53c5db26 oxygenhub / crates / hub / src / web / flow.rs
35.8 KiB · Rust · last changed Approval gates: a job waits for a person with the role 20 days ago source blame history raw
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
4
use super::settings::{csrf, require};
5
use super::{filters, lookup, lookup_role, Error, Page, RepoShell, Shell};
6
use crate::auth::{Access, Role, Viewer};
7
use crate::db::{self, flow as fdb};
8
use crate::Shared;
9
use askama::Template;
10
use axum::extract::{Form, Path, Query, State};
11
use axum::response::{IntoResponse, Redirect, Response};
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)>,
19
    /// "3rd in line" for a run still waiting for a runner.
20
    pub place: Option<String>,
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>,
31
    /// Writers may start runs: the bookmarks to offer, default first.
32
    can_run: bool,
33
    bookmarks: Vec<String>,
34
    error: Option<String>,
35
    /// Why this viewer is not offered "Run pipeline", when they are not.
36
    why_not: Option<String>,
37
}
38
39
#[derive(Deserialize)]
40
pub struct RunsQuery {
41
    before: Option<i64>,
42
    /// Why a "Run pipeline" or "Re-run" did not start.
43
    error: Option<String>,
44
}
45
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
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);
71
    let queue = if list.iter().any(|r| r.live()) { fdb::queue(&app.db).await.unwrap_or_default() } else { vec![] };
72
    let mut runs = Vec::new();
73
    for r in list.into_iter().take(PER_PAGE as usize) {
74
        let place = if r.live() { crate::flow::queue_info(&queue, row.id, r.id).place() } else { None };
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
        };
81
        runs.push(RunRow { jobs: jobs.into_iter().map(|j| (j.name, j.status)).collect(), duration, r, place });
82
    }
83
    let enabled = crate::flow::enabled(&app, &row);
84
    let why_not = why_not_run(enabled, viewer.account().is_some(), role);
85
    let can_run = why_not.is_none();
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,
96
        why_not,
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,
112
    #[serde(default)]
113
    bookmark: String,
114
    /// A change's full hash: run the state whose only head it is.
115
    #[serde(default)]
116
    change: String,
117
}
118
119
/// `POST /{owner}/{name}/flow/start`: "Run pipeline" on a bookmark's
120
/// current state, or on one committed change.
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)?;
131
    let (started, what) = if f.change.trim().is_empty() {
132
        (crate::flow::run_bookmark(&app, &row, f.bookmark.trim(), &me.account.username, &[]).await, f.bookmark.trim().to_string())
133
    } else {
134
        (crate::flow::run_change(&app, &row, &f.change, &me.account.username, &[]).await, format!("change {}", f.change.trim()))
135
    };
136
    Ok(match started {
137
        Ok(n) => {
138
            db::accounts::audit(&app.db, Some(&me.account), "flow.run", &format!("{owner}/{name}"), &format!("#{n} {what}")).await.ok();
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
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
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
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()
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" => "⤼",
303
        "cancelled" => "⊘",
304
        "error" => "!",
305
        _ => "○",
306
    }
307
}
308
309
/// Failed tests a run page lists per job; the rest are counted.
310
const SHOWN_FAILURES: i64 = 50;
311
312
pub struct JobLog {
313
    pub j: fdb::Job,
314
    pub artifacts: Vec<fdb::Artifact>,
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,
319
    /// The job's coverage report, when it uploaded one (#113): its id and percentage.
320
    pub coverage: Option<(i64, String)>,
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>,
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,
336
    /// Whether the viewer may re-run it.
337
    can_rerun: bool,
338
    /// Whether the viewer may cancel it.
339
    can_cancel: bool,
340
    /// Where a live run stands among the runners' work.
341
    queue: Option<crate::flow::QueueInfo>,
342
    /// Releases a writer may attach this run's artifacts to.
343
    releases: Vec<db::releases::Release>,
344
    /// Jobs that wait, or waited, for a person (oxygenflow#57).
345
    approvals: Vec<ApprovalView>,
346
}
347
348
/// A job's approval as the run page shows it.
349
pub struct ApprovalView {
350
    pub job: String,
351
    pub by: String,
352
    pub others_only: bool,
353
    /// `waiting`, `approved`, `rejected` or `expired`.
354
    pub state: &'static str,
355
    pub who: String,
356
    pub when_ms: i64,
357
    /// Whether the viewer may approve or reject it now, else why not.
358
    pub may: Result<(), String>,
359
}
360
361
impl ApprovalView {
362
    pub fn may_decide(&self) -> bool {
363
        self.may.is_ok()
364
    }
365
366
    pub fn why_not(&self) -> String {
367
        self.may.clone().err().unwrap_or_default()
368
    }
369
}
370
371
/// Lines of a job's log a page shows before "the rest is loaded as it comes".
372
const PAGE_LINES: i64 = 5000;
373
374
pub async fn run(
375
    State(app): State<Shared>,
376
    viewer: Viewer,
377
    Path((owner, name, id)): Path<(String, String, i64)>,
378
) -> Result<Page<RunPage>, Error> {
379
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}"), &viewer);
380
    let (_repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
381
    let run = fdb::run(&app.db, row.id, id)
382
        .await
383
        .map_err(|e| Error::from_db(shell.clone(), e))?
384
        .ok_or_else(|| Error::not_found(shell.clone()))?;
385
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
386
    let reports = crate::coverage::for_run(&app.db, run.id).await.unwrap_or_default();
387
    let test_reports = crate::junit::for_run(&app.db, run.id).await.unwrap_or_default();
388
    let mut logs = Vec::new();
389
    for j in &jobs {
390
        let lines = fdb::log(&app.db, j.id, 0, PAGE_LINES).await.unwrap_or_default();
391
        let last_seq = lines.last().map(|l| l.seq).unwrap_or(0);
392
        let artifacts = fdb::artifacts(&app.db, j.id).await.unwrap_or_default();
393
        let coverage = reports
394
            .iter()
395
            .find(|r| r.job_id == Some(j.id))
396
            .map(|r| (r.id, r.percent().map(|p| format!("{p:.1}%")).unwrap_or_else(|| "no lines".into())));
397
        let tests = test_reports.iter().find(|r| r.job_id == j.id).cloned();
398
        let failures = match &tests {
399
            Some(r) if r.broken() > 0 => crate::junit::failures(&app.db, r.id, SHOWN_FAILURES).await.unwrap_or_default(),
400
            _ => vec![],
401
        };
402
        logs.push(JobLog { duration: crate::flow::duration(j), j: j.clone(), artifacts, lines, last_seq, coverage, tests, failures });
403
    }
404
    let duration = match run.finished_ms {
405
        Some(f) => crate::flow::human_ms(f - run.created_ms),
406
        None => crate::flow::human_ms(db::now_ms() - run.created_ms),
407
    };
408
    let mut approvals = Vec::new();
409
    for j in jobs.iter().filter(|j| !j.approval.is_empty()) {
410
        let Some(a) = serde_json::from_str::<flow_core::Job>(&j.spec).ok().and_then(|s| s.approval) else { continue };
411
        let state = match (j.approval.as_str(), j.status.as_str()) {
412
            ("waiting", "queued") => "waiting",
413
            ("approved", _) => "approved",
414
            (_, "cancelled") if !j.approved_by.is_empty() => "rejected",
415
            (_, "cancelled") if j.error.starts_with("no approval within") => "expired",
416
            _ => continue,
417
        };
418
        let may = match (state, viewer.account()) {
419
            ("waiting", Some(me)) => crate::flow::may_decide(&app, &row, &run, j, me).await.map(|_| ()),
420
            ("waiting", None) => Err("sign in to approve".into()),
421
            _ => Err(String::new()),
422
        };
423
        approvals.push(ApprovalView {
424
            job: j.name.clone(),
425
            by: a.by,
426
            others_only: a.others_only,
427
            state,
428
            who: j.approved_by.clone(),
429
            when_ms: j.approved_ms.unwrap_or(0),
430
            may,
431
        });
432
    }
433
    let graph = layout(jobs);
434
    let can_write = viewer.account().is_some() && role >= Role::Write;
435
    let can_rerun = !run.live() && can_write && crate::flow::enabled(&app, &row);
436
    let can_cancel = run.live() && can_write;
437
    let queue = if run.live() {
438
        let q = fdb::queue(&app.db).await.unwrap_or_default();
439
        Some(crate::flow::queue_info(&q, row.id, run.id)).filter(|i| i.position.is_some())
440
    } else {
441
        None
442
    };
443
    let releases = if viewer.account().is_some() && role >= Role::Write && logs.iter().any(|l| !l.artifacts.is_empty()) {
444
        db::releases::list(&app.db, row.id).await.unwrap_or_default()
445
    } else {
446
        vec![]
447
    };
448
    Ok(Page(RunPage {
449
        shell,
450
        repo: RepoShell::new(&app, &row, "flow").with_role(role),
451
        run,
452
        graph,
453
        logs,
454
        duration,
455
        can_rerun,
456
        can_cancel,
457
        queue,
458
        releases,
459
        approvals,
460
    }))
461
}
462
463
#[derive(Deserialize)]
464
pub struct DecideForm {
465
    #[serde(rename = "_csrf")]
466
    csrf_token: String,
467
    /// `approve` or `reject`.
468
    action: String,
469
}
470
471
/// `POST /{owner}/{name}/flow/{id}/jobs/{job}/decide`: approve or reject
472
/// a job that waits for a person (oxygenflow#57).
473
pub async fn decide(
474
    State(app): State<Shared>,
475
    viewer: Viewer,
476
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
477
    Form(f): Form<DecideForm>,
478
) -> Result<Response, Error> {
479
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{number}"), &viewer);
480
    let me = require(&viewer, &shell)?;
481
    let (_, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
482
    csrf(&viewer, &f.csrf_token, &shell)?;
483
    let run = fdb::run(&app.db, row.id, number)
484
        .await
485
        .map_err(|e| Error::from_db(shell.clone(), e))?
486
        .ok_or_else(|| Error::not_found(shell.clone()))?;
487
    let approve = match f.action.as_str() {
488
        "approve" => true,
489
        "reject" => false,
490
        _ => return Err(Error::bad(shell, "approve or reject")),
491
    };
492
    match crate::flow::decide(&app, &row, &run, &job, &me.account, approve).await {
493
        Ok(_) => Ok(Redirect::to(&format!("/{owner}/{name}/flow/{number}")).into_response()),
494
        Err(why) => Err(Error::bad(shell, why)),
495
    }
496
}
497
498
#[derive(Deserialize)]
499
pub struct LiveQuery {
500
    /// `job:seq,job:seq`: the last log line each open job already shows.
501
    after: Option<String>,
502
}
503
504
/// `GET /{owner}/{name}/flow/{id}/live`: statuses and new log lines, for the
505
/// run page while it is live.
506
pub async fn live(
507
    State(app): State<Shared>,
508
    viewer: Viewer,
509
    Path((owner, name, id)): Path<(String, String, i64)>,
510
    Query(q): Query<LiveQuery>,
511
) -> Result<Response, Error> {
512
    let shell = Shell::new(&app, "", &viewer);
513
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
514
    let run = fdb::run(&app.db, row.id, id)
515
        .await
516
        .map_err(|e| Error::from_db(shell.clone(), e))?
517
        .ok_or_else(|| Error::not_found(shell.clone()))?;
518
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
519
    let after: std::collections::HashMap<i64, i64> = q
520
        .after
521
        .unwrap_or_default()
522
        .split(',')
523
        .filter_map(|p| p.split_once(':'))
524
        .filter_map(|(a, b)| Some((a.parse().ok()?, b.parse().ok()?)))
525
        .collect();
526
    let mut out = Vec::new();
527
    for j in &jobs {
528
        let lines = match after.get(&j.id) {
529
            Some(seq) => fdb::log(&app.db, j.id, *seq, 1000).await.unwrap_or_default(),
530
            None => vec![],
531
        };
532
        out.push(serde_json::json!({
533
            "id": j.id,
534
            "name": j.name,
535
            "status": j.status,
536
            "glyph": glyph(&j.status),
537
            "duration": crate::flow::duration(j),
538
            "exit_code": j.exit_code,
539
            "lines": lines.iter().map(|l| serde_json::json!({ "seq": l.seq, "t": l.t, "stream": l.stream, "text": l.text })).collect::<Vec<_>>(),
540
        }));
541
    }
542
    Ok(Json(serde_json::json!({ "status": run.status, "live": run.live(), "jobs": out })).into_response())
543
}
544
545
// ------------------------------------------------------------ state stamps
546
547
/// In rendered Markdown, the image path that is the viewed state's stamp.
548
pub const STAMP_IMAGE: &str = ".flow/stamp";
549
/// In rendered Markdown, the link path to the viewed state's run.
550
pub const RUN_LINK: &str = ".flow/run";
551
552
/// Resolve a ref to its state address, and whether the ref can move.
553
async fn state_of(app: &Shared, owner: &str, name: &str, r: &str) -> Result<(String, bool), crate::repos::RepoError> {
554
    let repo = crate::repos::RepoName::new(owner, name).ok_or(crate::repos::RepoError::NotFound)?;
555
    let spec = r.to_string();
556
    app.repos
557
        .read(&repo, move |repo, cache| {
558
            let t = crate::repos::view::resolve(repo, cache, &spec)?;
559
            let moves = matches!(t.kind, crate::repos::view::RefKind::Bookmark | crate::repos::view::RefKind::Tag);
560
            Ok((t.permalink().unwrap_or_default(), moves))
561
        })
562
        .await
563
}
564
565
/// `GET /{owner}/{name}/flow/stamp/{ref}` (hub spec §13.2).
566
pub async fn stamp(
567
    State(app): State<Shared>,
568
    viewer: Viewer,
569
    Path((owner, name, r)): Path<(String, String, String)>,
570
) -> Result<Response, Error> {
571
    let shell = Shell::new(&app, "", &viewer);
572
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
573
    let (heads, moves) = state_of(&app, &owner, &name, &r).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
574
    if moves && !heads.is_empty() {
575
        let mut res = axum::response::Redirect::to(&format!("/{owner}/{name}/flow/stamp/{heads}")).into_response();
576
        res.headers_mut().insert(axum::http::header::CACHE_CONTROL, axum::http::HeaderValue::from_static("no-cache"));
577
        return Ok(res);
578
    }
579
    let run = fdb::latest_for_heads(&app.db, row.id, &heads).await.map_err(|e| Error::from_db(shell.clone(), e))?;
580
    let jobs = match &run {
581
        Some(r) => fdb::jobs(&app.db, r.id).await.map_err(|e| Error::from_db(shell.clone(), e))?,
582
        None => vec![],
583
    };
584
    let svg = stamp_svg(&heads, run.as_ref(), &jobs);
585
    let cache = if run.as_ref().is_some_and(|r| !r.live()) { "public, max-age=3600" } else { "public, max-age=60" };
586
    Ok((
587
        [
588
            (axum::http::header::CONTENT_TYPE, "image/svg+xml; charset=utf-8"),
589
            (axum::http::header::CACHE_CONTROL, cache),
590
            (axum::http::header::CONTENT_SECURITY_POLICY, "default-src 'none'; style-src 'unsafe-inline'"),
591
        ],
592
        svg,
593
    )
594
        .into_response())
595
}
596
597
/// `GET /{owner}/{name}/flow/at/{ref}`: the run of the ref's state, or the Flow tab.
598
pub async fn at(
599
    State(app): State<Shared>,
600
    viewer: Viewer,
601
    Path((owner, name, r)): Path<(String, String, String)>,
602
) -> Result<Response, Error> {
603
    let shell = Shell::new(&app, "", &viewer);
604
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
605
    let (heads, _) = state_of(&app, &owner, &name, &r).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
606
    let run = fdb::latest_for_heads(&app.db, row.id, &heads).await.map_err(|e| Error::from_db(shell.clone(), e))?;
607
    let to = match run {
608
        Some(r) => format!("/{owner}/{name}/flow/{}", r.number),
609
        None => format!("/{owner}/{name}/flow"),
610
    };
611
    Ok(axum::response::Redirect::to(&to).into_response())
612
}
613
614
fn xml(s: &str) -> String {
615
    s.replace('&', "&amp;").replace('<', "&lt;").replace('>', "&gt;").replace('"', "&quot;")
616
}
617
618
/// The stamp: the mark, one glyph per job, the status, the state and the
619
/// date; the same facts machine-readable in `<metadata>`. Fixed colours,
620
/// because an image does not follow the page's theme.
621
pub fn stamp_svg(heads: &str, run: Option<&fdb::Run>, jobs: &[fdb::Job]) -> String {
622
    const CH: f64 = 6.6; // IBM Plex Mono at 11px
623
    let colour = |s: &str| match s {
624
        "passed" => "#5fe3a1",
625
        "failed" | "error" => "#ff5e7a",
626
        "running" => "#00e0f0",
627
        _ => "#8592ad",
628
    };
629
    let short: String = heads.chars().take(12).collect();
630
    let (status, date) = match run {
631
        Some(r) => (r.status.as_str(), crate::render::time::absolute(r.created_ms as u64).chars().take(10).collect::<String>()),
632
        None => ("no run", String::new()),
633
    };
634
    let mut ordered: Vec<&fdb::Job> = jobs.iter().collect();
635
    ordered.sort_by(|a, b| (a.depth, &a.name).cmp(&(b.depth, &b.name)));
636
    let label = "OXYGENFLOW";
637
    let label_w = 14.0 + label.len() as f64 * 6.2 + 8.0;
638
    let glyphs_w = if ordered.is_empty() { 0.0 } else { ordered.len() as f64 * 10.0 + 6.0 };
639
    let tail = if date.is_empty() { format!("{status} · {short}") } else { format!("{status} · {short} · {date}") };
640
    let right_w = 8.0 + glyphs_w + tail.chars().count() as f64 * CH + 8.0;
641
    let w = (label_w + right_w).ceil();
642
    let mut glyphs = String::new();
643
    for (i, j) in ordered.iter().enumerate() {
644
        let x = label_w + 8.0 + i as f64 * 10.0 + 4.0;
645
        glyphs.push_str(&format!(
646
            r#"<text x="{x:.1}" y="15" fill="{}" text-anchor="middle">{}</text>"#,
647
            colour(&j.status),
648
            glyph(&j.status)
649
        ));
650
    }
651
    let meta = serde_json::json!({
652
        "heads": heads.split('+').filter(|h| !h.is_empty()).collect::<Vec<_>>(),
653
        "run": run.map(|r| r.number),
654
        "status": status,
655
        "jobs": ordered.iter().map(|j| serde_json::json!({ "name": j.name, "status": j.status, "receipt": j.receipt_hash })).collect::<Vec<_>>(),
656
    });
657
    let title = match run {
658
        Some(r) => format!("OxygenFlow run #{} {status} on state {short}", r.number),
659
        None => format!("OxygenFlow: no run for state {short}"),
660
    };
661
    format!(
662
        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>"##,
663
        t = xml(&title),
664
        m = xml(&meta.to_string()),
665
        lw = label_w,
666
        lx = label_w - 4.0,
667
        tx = label_w + 8.0 + glyphs_w,
668
        sc = colour(status),
669
        tail = xml(&tail),
670
        wi = w - 1.0,
671
    )
672
}
673
674
/// A receipt kept in a repository (Oxygen spec §14.6), as pages show it.
675
#[derive(Clone, Debug)]
676
pub struct ReceiptRow {
677
    pub attest: String,
678
    pub job: String,
679
    pub exit_code: u32,
680
    pub duration: String,
681
    pub runner: String,
682
    pub run: String,
683
    /// Why it does not verify, or that its runner's key was revoked.
684
    pub problem: String,
685
    pub made_ms: i64,
686
}
687
688
impl ReceiptRow {
689
    pub fn passed(&self) -> bool {
690
        self.exit_code == 0
691
    }
692
}
693
694
/// The receipts kept for the state of `heads`.
695
pub async fn receipts_of(app: &Shared, name: &crate::repos::RepoName, heads: Vec<oxy_core::hash::ChangeHash>) -> Vec<ReceiptRow> {
696
    let base = app.config.base_url();
697
    let found = app.repos.read(name, move |repo, _| Ok(repo.receipts(&heads)?)).await.unwrap_or_default();
698
    found
699
        .into_iter()
700
        .map(|i| {
701
            let r = &i.signed.receipt;
702
            let run = i.signed.run().to_string();
703
            ReceiptRow {
704
                attest: i.attest.to_hex(),
705
                job: r.job_name.clone(),
706
                exit_code: r.exit_code,
707
                duration: crate::flow::human_ms(r.duration_ms as i64),
708
                runner: i.signed.runner.name.clone(),
709
                // Only links to this hub are followed from the page.
710
                run: if run.starts_with(base) { run } else { String::new() },
711
                problem: match (i.problem, i.revoked) {
712
                    (Some(p), _) => p,
713
                    (None, true) => "the runner's key was revoked".into(),
714
                    (None, false) => String::new(),
715
                },
716
                made_ms: i.signed.attest.hlc.wall_ms as i64,
717
            }
718
        })
719
        .collect()
720
}
721
722
/// `GET /{owner}/{name}/receipts/{attest}`: a signed receipt, for
723
/// `oxy receipt verify` or `oxy receipt import`.
724
pub async fn receipt_file(
725
    State(app): State<Shared>,
726
    viewer: Viewer,
727
    Path((owner, name, attest)): Path<(String, String, String)>,
728
) -> Result<Response, Error> {
729
    let shell = Shell::new(&app, &format!("/{owner}/{name}/receipts/{attest}"), &viewer);
730
    let (repo, _row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
731
    let Some(r) = oxy_core::hash::ObjectRef::from_hex(attest.trim_end_matches(".receipt")) else {
732
        return Err(Error::not_found(shell));
733
    };
734
    let (job, bytes) = app
735
        .repos
736
        .read(&repo, move |repo, _| {
737
            let i = repo.receipt(&r)?;
738
            Ok((i.signed.receipt.job_name.clone(), i.signed.encode()))
739
        })
740
        .await
741
        .map_err(|_| Error::not_found(shell.clone()))?;
742
    let file: String = job.chars().filter(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')).collect();
743
    Ok((
744
        [
745
            (axum::http::header::CONTENT_TYPE, "application/oxy-receipt".to_string()),
746
            (axum::http::header::CONTENT_DISPOSITION, format!("attachment; filename=\"{file}-{}.receipt\"", r.short(12))),
747
        ],
748
        bytes,
749
    )
750
        .into_response())
751
}
752
753
/// `GET /{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}`: an artifact
754
/// of a run's job, read from the repository.
755
pub async fn artifact_file(
756
    State(app): State<Shared>,
757
    viewer: Viewer,
758
    Path((owner, name, id, job, artifact)): Path<(String, String, i64, String, String)>,
759
) -> Result<Response, Error> {
760
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}"), &viewer);
761
    let (repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
762
    let run = fdb::run(&app.db, row.id, id)
763
        .await
764
        .map_err(|e| Error::from_db(shell.clone(), e))?
765
        .ok_or_else(|| Error::not_found(shell.clone()))?;
766
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
767
    let Some(j) = jobs.iter().find(|j| j.name == job) else { return Err(Error::not_found(shell)) };
768
    let arts = fdb::artifacts(&app.db, j.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
769
    let Some(a) = arts.into_iter().find(|a| a.name == artifact) else { return Err(Error::not_found(shell)) };
770
    let Some(blob) = oxy_core::hash::ObjectRef::from_hex(&a.blob) else { return Err(Error::not_found(shell)) };
771
    let bytes = app.repos.read(&repo, move |r, _| Ok(r.read_blob(&blob)?)).await.map_err(|_| Error::not_found(shell.clone()))?;
772
    let file = a.path.rsplit('/').next().unwrap_or(&a.name).to_string();
773
    Ok((
774
        [
775
            (axum::http::header::CONTENT_TYPE, "application/octet-stream".to_string()),
776
            (axum::http::header::CONTENT_DISPOSITION, format!("attachment; filename=\"{}\"", file.replace('"', ""))),
777
        ],
778
        bytes,
779
    )
780
        .into_response())
781
}
782
783
#[derive(Deserialize)]
784
pub struct AttachForm {
785
    _csrf: String,
786
    release: i64,
787
}
788
789
/// `POST /{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}/attach`: add
790
/// an artifact to a release as an asset, named after its path; the release
791
/// page then shows the run and receipt that built it.
792
pub async fn attach(
793
    State(app): State<Shared>,
794
    viewer: Viewer,
795
    Path((owner, name, id, job, artifact)): Path<(String, String, i64, String, String)>,
796
    Form(f): Form<AttachForm>,
797
) -> Result<Response, Error> {
798
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}"), &viewer);
799
    require(&viewer, &shell)?;
800
    csrf(&viewer, &f._csrf, &shell)?;
801
    let (repo, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
802
    let run = fdb::run(&app.db, row.id, id)
803
        .await
804
        .map_err(|e| Error::from_db(shell.clone(), e))?
805
        .ok_or_else(|| Error::not_found(shell.clone()))?;
806
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
807
    let Some(j) = jobs.iter().find(|j| j.name == job) else { return Err(Error::not_found(shell)) };
808
    // A failing job's `when "always"` artifacts are not in its receipt, so
809
    // they cannot stand for a release (oxygenflow#37).
810
    if j.status != "passed" {
811
        return Err(Error::bad(shell, "only a passing job's artifacts can be attached to a release"));
812
    }
813
    let arts = fdb::artifacts(&app.db, j.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
814
    let Some(a) = arts.into_iter().find(|a| a.name == artifact) else { return Err(Error::not_found(shell)) };
815
    let releases = db::releases::list(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
816
    let Some(rel) = releases.into_iter().find(|r| r.id == f.release) else { return Err(Error::not_found(shell)) };
817
    let Some(blob) = oxy_core::hash::ObjectRef::from_hex(&a.blob) else { return Err(Error::not_found(shell)) };
818
    let bytes = app.repos.read(&repo, move |r, _| Ok(r.read_blob(&blob)?)).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
819
    let file = a.path.rsplit('/').next().unwrap_or(&a.name).to_string();
820
    super::releases::store_asset(&app, rel.id, &file, "application/octet-stream", &bytes)
821
        .await
822
        .map_err(|m| Error::bad(shell.clone(), m))?;
823
    Ok(Redirect::to(&format!("/{owner}/{name}/releases/tag/{}", rel.tag)).into_response())
824
}
825
826
/// `/{owner}/{name}/flow/badge.svg`: the latest run on the default
827
/// bookmark as a small SVG for a README, for whoever may read the
828
/// repository. `passed` green, `failed` or `error` red, a run still going
829
/// blue, none grey.
830
pub async fn badge(
831
    State(app): State<Shared>,
832
    viewer: Viewer,
833
    Path((owner, name)): Path<(String, String)>,
834
) -> Result<axum::response::Response, Error> {
835
    use axum::response::IntoResponse;
836
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow"), &viewer);
837
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
838
    let latest = fdb::latest_on(&app.db, row.id, &row.default_bookmark).await.map_err(|e| Error::from_db(shell.clone(), e))?;
839
    let (text, colour) = match latest.as_ref().map(|r| r.status.as_str()) {
840
        Some("passed") => ("passing", "#2da44e"),
841
        Some("failed") | Some("error") => ("failing", "#cf222e"),
842
        Some("cancelled") => ("cancelled", "#6e7781"),
843
        Some(_) => ("running", "#0969da"),
844
        None => ("no runs", "#6e7781"),
845
    };
846
    let label = "OxygenFlow";
847
    let (lw, tw) = (label.len() as u32 * 7 + 10, text.len() as u32 * 7 + 10);
848
    let svg = format!(
849
        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>"##,
850
        w = lw + tw,
851
        lx = lw / 2,
852
        tx = lw + tw / 2,
853
    );
854
    Ok((
855
        [(axum::http::header::CONTENT_TYPE, "image/svg+xml; charset=utf-8"), (axum::http::header::CACHE_CONTROL, "no-cache, max-age=60")],
856
        svg,
857
    )
858
        .into_response())
859
}