OXYGENHUB
# 554ccacfc123 oxygenhub / crates / hub / src / web / flow.rs
30.6 KiB · Rust · last changed Coverage reports, built in 1 month 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() {
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 {
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
745d225d Andy McCall ↶ 177
/// `POST /{owner}/{name}/flow/{number}/cancel` (oxygenflow#32).
178
pub async fn cancel(
179
    State(app): State<Shared>,
180
    viewer: Viewer,
181
    Path((owner, name, number)): Path<(String, String, i64)>,
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::cancel(&app, &row, &run, &me.account.username).await {
193
        Ok(()) => {
194
            db::accounts::audit(&app.db, Some(&me.account), "flow.cancel", &format!("{owner}/{name}"), &format!("#{number}")).await.ok();
195
            Redirect::to(&format!("/{owner}/{name}/flow/{number}")).into_response()
196
        }
197
        Err(msg) => Redirect::to(&format!("/{owner}/{name}/flow?error={}", urlencoding(&msg))).into_response(),
198
    })
199
}
200
1edac4b6 Andy McCall ↶ 201
/// Percent-encode a message for a query string.
202
fn urlencoding(s: &str) -> String {
203
    s.bytes()
204
        .map(|b| match b {
205
            b'A'..=b'Z' | b'a'..=b'z' | b'0'..=b'9' | b'-' | b'.' | b'_' | b'~' => (b as char).to_string(),
206
            _ => format!("%{b:02X}"),
207
        })
208
        .collect()
42fa9554 Andy McCall ↶ 209
}
210
211
/// A job placed in the graph.
212
pub struct Node {
213
    pub j: fdb::Job,
214
    pub x: i64,
215
    pub y: i64,
216
    pub duration: String,
217
}
218
219
pub struct Edge {
220
    pub d: String,
221
    pub status: String,
222
}
223
224
pub struct Graph {
225
    pub nodes: Vec<Node>,
226
    pub edges: Vec<Edge>,
227
    pub width: i64,
228
    pub height: i64,
229
}
230
231
pub const NODE_W: i64 = 200;
232
pub const NODE_H: i64 = 48;
233
const COL_GAP: i64 = 72;
234
const ROW_GAP: i64 = 18;
235
const PAD: i64 = 12;
236
237
/// Columns by dependency depth, jobs in each column in name order.
238
pub fn layout(jobs: Vec<fdb::Job>) -> Graph {
239
    let mut by_depth: std::collections::BTreeMap<i64, Vec<fdb::Job>> = Default::default();
240
    for j in jobs {
241
        by_depth.entry(j.depth).or_default().push(j);
242
    }
243
    let rows = by_depth.values().map(Vec::len).max().unwrap_or(0) as i64;
244
    let height = PAD * 2 + rows * NODE_H + (rows - 1).max(0) * ROW_GAP;
245
    let mut nodes = Vec::new();
246
    for (col, (_, mut js)) in by_depth.into_iter().enumerate() {
247
        js.sort_by(|a, b| a.name.cmp(&b.name));
248
        let n = js.len() as i64;
249
        let column_h = n * NODE_H + (n - 1).max(0) * ROW_GAP;
250
        let top = (height - column_h) / 2;
251
        for (i, j) in js.into_iter().enumerate() {
252
            let duration = crate::flow::duration(&j);
253
            nodes.push(Node { x: PAD + col as i64 * (NODE_W + COL_GAP), y: top + i as i64 * (NODE_H + ROW_GAP), duration, j });
254
        }
255
    }
256
    let mut edges = Vec::new();
257
    for n in &nodes {
258
        for d in n.j.depends_on() {
259
            if let Some(from) = nodes.iter().find(|m| m.j.name == d) {
260
                let (x1, y1) = (from.x + NODE_W, from.y + NODE_H / 2);
261
                let (x2, y2) = (n.x, n.y + NODE_H / 2);
262
                let mid = (x1 + x2) / 2;
263
                edges.push(Edge { d: format!("M{x1},{y1} C{mid},{y1} {mid},{y2} {x2},{y2}"), status: from.j.status.clone() });
264
            }
265
        }
266
    }
267
    let cols = nodes.iter().map(|n| n.x).max().map(|x| x + NODE_W + PAD).unwrap_or(PAD * 2);
268
    Graph { nodes, edges, width: cols, height: height.max(NODE_H + PAD * 2) }
269
}
270
271
pub fn glyph(status: &str) -> &'static str {
272
    match status {
273
        "passed" => "✓",
274
        "failed" => "✕",
275
        "running" => "●",
276
        "skipped" => "⤼",
745d225d Andy McCall ↶ 277
        "cancelled" => "⊘",
42fa9554 Andy McCall ↶ 278
        "error" => "!",
279
        _ => "○",
280
    }
281
}
282
283
pub struct JobLog {
284
    pub j: fdb::Job,
a3c8288b Andy McCall ↶ 285
    pub artifacts: Vec<fdb::Artifact>,
42fa9554 Andy McCall ↶ 286
    pub lines: Vec<fdb::LogLine>,
287
    pub duration: String,
288
    /// The last line shown; the live view asks for what follows.
289
    pub last_seq: i64,
554ccacf Andy McCall ↶ 290
    /// The job's coverage report, when it uploaded one (#113): its id and percentage.
291
    pub coverage: Option<(i64, String)>,
42fa9554 Andy McCall ↶ 292
}
293
294
#[derive(Template)]
295
#[template(path = "flow_run.html")]
296
pub struct RunPage {
297
    shell: Shell,
298
    repo: RepoShell,
299
    run: fdb::Run,
300
    graph: Graph,
301
    logs: Vec<JobLog>,
302
    duration: String,
1edac4b6 Andy McCall ↶ 303
    /// Whether the viewer may re-run it.
304
    can_rerun: bool,
745d225d Andy McCall ↶ 305
    /// Whether the viewer may cancel it.
306
    can_cancel: bool,
bf3d0754 Andy McCall ↶ 307
    /// Where a live run stands among the runners' work.
308
    queue: Option<crate::flow::QueueInfo>,
10708ab8 Andy McCall ↶ 309
    /// Releases a writer may attach this run's artifacts to.
310
    releases: Vec<db::releases::Release>,
42fa9554 Andy McCall ↶ 311
}
312
313
/// Lines of a job's log a page shows before "the rest is loaded as it comes".
314
const PAGE_LINES: i64 = 5000;
315
316
pub async fn run(
317
    State(app): State<Shared>,
318
    viewer: Viewer,
319
    Path((owner, name, id)): Path<(String, String, i64)>,
320
) -> Result<Page<RunPage>, Error> {
321
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}"), &viewer);
322
    let (_repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
323
    let run = fdb::run(&app.db, row.id, id)
324
        .await
325
        .map_err(|e| Error::from_db(shell.clone(), e))?
326
        .ok_or_else(|| Error::not_found(shell.clone()))?;
327
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
554ccacf Andy McCall ↶ 328
    let reports = crate::coverage::for_run(&app.db, run.id).await.unwrap_or_default();
42fa9554 Andy McCall ↶ 329
    let mut logs = Vec::new();
330
    for j in &jobs {
331
        let lines = fdb::log(&app.db, j.id, 0, PAGE_LINES).await.unwrap_or_default();
332
        let last_seq = lines.last().map(|l| l.seq).unwrap_or(0);
a3c8288b Andy McCall ↶ 333
        let artifacts = fdb::artifacts(&app.db, j.id).await.unwrap_or_default();
554ccacf Andy McCall ↶ 334
        let coverage = reports
335
            .iter()
336
            .find(|r| r.job_id == j.id)
337
            .map(|r| (r.id, r.percent().map(|p| format!("{p:.1}%")).unwrap_or_else(|| "no lines".into())));
338
        logs.push(JobLog { duration: crate::flow::duration(j), j: j.clone(), artifacts, lines, last_seq, coverage });
42fa9554 Andy McCall ↶ 339
    }
340
    let duration = match run.finished_ms {
341
        Some(f) => crate::flow::human_ms(f - run.created_ms),
342
        None => crate::flow::human_ms(db::now_ms() - run.created_ms),
343
    };
344
    let graph = layout(jobs);
745d225d Andy McCall ↶ 345
    let can_write = viewer.account().is_some() && role >= Role::Write;
346
    let can_rerun = !run.live() && can_write && crate::flow::enabled(&app, &row);
347
    let can_cancel = run.live() && can_write;
bf3d0754 Andy McCall ↶ 348
    let queue = if run.live() {
349
        let q = fdb::queue(&app.db).await.unwrap_or_default();
350
        Some(crate::flow::queue_info(&q, row.id, run.id)).filter(|i| i.position.is_some())
351
    } else {
352
        None
10708ab8 Andy McCall ↶ 353
    };
354
    let releases = if viewer.account().is_some() && role >= Role::Write && logs.iter().any(|l| !l.artifacts.is_empty()) {
355
        db::releases::list(&app.db, row.id).await.unwrap_or_default()
356
    } else {
357
        vec![]
bf3d0754 Andy McCall ↶ 358
    };
10708ab8 Andy McCall ↶ 359
    Ok(Page(RunPage {
360
        shell,
361
        repo: RepoShell::new(&app, &row, "flow").with_role(role),
362
        run,
363
        graph,
364
        logs,
365
        duration,
366
        can_rerun,
745d225d Andy McCall ↶ 367
        can_cancel,
10708ab8 Andy McCall ↶ 368
        queue,
369
        releases,
370
    }))
42fa9554 Andy McCall ↶ 371
}
372
373
#[derive(Deserialize)]
374
pub struct LiveQuery {
375
    /// `job:seq,job:seq`: the last log line each open job already shows.
376
    after: Option<String>,
377
}
378
379
/// `GET /{owner}/{name}/flow/{id}/live`: statuses and new log lines, for the
380
/// run page while it is live.
381
pub async fn live(
382
    State(app): State<Shared>,
383
    viewer: Viewer,
384
    Path((owner, name, id)): Path<(String, String, i64)>,
385
    Query(q): Query<LiveQuery>,
386
) -> Result<Response, Error> {
387
    let shell = Shell::new(&app, "", &viewer);
388
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
389
    let run = fdb::run(&app.db, row.id, id)
390
        .await
391
        .map_err(|e| Error::from_db(shell.clone(), e))?
392
        .ok_or_else(|| Error::not_found(shell.clone()))?;
393
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
394
    let after: std::collections::HashMap<i64, i64> = q
395
        .after
396
        .unwrap_or_default()
397
        .split(',')
398
        .filter_map(|p| p.split_once(':'))
399
        .filter_map(|(a, b)| Some((a.parse().ok()?, b.parse().ok()?)))
400
        .collect();
401
    let mut out = Vec::new();
402
    for j in &jobs {
403
        let lines = match after.get(&j.id) {
404
            Some(seq) => fdb::log(&app.db, j.id, *seq, 1000).await.unwrap_or_default(),
405
            None => vec![],
406
        };
407
        out.push(serde_json::json!({
408
            "id": j.id,
409
            "name": j.name,
410
            "status": j.status,
411
            "glyph": glyph(&j.status),
412
            "duration": crate::flow::duration(j),
413
            "exit_code": j.exit_code,
414
            "lines": lines.iter().map(|l| serde_json::json!({ "seq": l.seq, "t": l.t, "stream": l.stream, "text": l.text })).collect::<Vec<_>>(),
415
        }));
416
    }
417
    Ok(Json(serde_json::json!({ "status": run.status, "live": run.live(), "jobs": out })).into_response())
418
}
736f6813 Andy McCall ↶ 419
420
// ------------------------------------------------------------ state stamps
421
422
/// In rendered Markdown, the image path that is the viewed state's stamp.
423
pub const STAMP_IMAGE: &str = ".flow/stamp";
424
/// In rendered Markdown, the link path to the viewed state's run.
425
pub const RUN_LINK: &str = ".flow/run";
426
427
/// Resolve a ref to its state address, and whether the ref can move.
428
async fn state_of(app: &Shared, owner: &str, name: &str, r: &str) -> Result<(String, bool), crate::repos::RepoError> {
429
    let repo = crate::repos::RepoName::new(owner, name).ok_or(crate::repos::RepoError::NotFound)?;
430
    let spec = r.to_string();
431
    app.repos
432
        .read(&repo, move |repo, cache| {
433
            let t = crate::repos::view::resolve(repo, cache, &spec)?;
434
            let moves = matches!(t.kind, crate::repos::view::RefKind::Bookmark | crate::repos::view::RefKind::Tag);
435
            Ok((t.permalink().unwrap_or_default(), moves))
436
        })
437
        .await
438
}
439
440
/// `GET /{owner}/{name}/flow/stamp/{ref}` (hub spec §13.2).
441
pub async fn stamp(
442
    State(app): State<Shared>,
443
    viewer: Viewer,
444
    Path((owner, name, r)): Path<(String, String, String)>,
445
) -> Result<Response, Error> {
446
    let shell = Shell::new(&app, "", &viewer);
447
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
448
    let (heads, moves) = state_of(&app, &owner, &name, &r).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
449
    if moves && !heads.is_empty() {
450
        let mut res = axum::response::Redirect::to(&format!("/{owner}/{name}/flow/stamp/{heads}")).into_response();
451
        res.headers_mut().insert(axum::http::header::CACHE_CONTROL, axum::http::HeaderValue::from_static("no-cache"));
452
        return Ok(res);
453
    }
454
    let run = fdb::latest_for_heads(&app.db, row.id, &heads).await.map_err(|e| Error::from_db(shell.clone(), e))?;
455
    let jobs = match &run {
456
        Some(r) => fdb::jobs(&app.db, r.id).await.map_err(|e| Error::from_db(shell.clone(), e))?,
457
        None => vec![],
458
    };
459
    let svg = stamp_svg(&heads, run.as_ref(), &jobs);
460
    let cache = if run.as_ref().is_some_and(|r| !r.live()) { "public, max-age=3600" } else { "public, max-age=60" };
461
    Ok((
462
        [
463
            (axum::http::header::CONTENT_TYPE, "image/svg+xml; charset=utf-8"),
464
            (axum::http::header::CACHE_CONTROL, cache),
465
            (axum::http::header::CONTENT_SECURITY_POLICY, "default-src 'none'; style-src 'unsafe-inline'"),
466
        ],
467
        svg,
468
    )
469
        .into_response())
470
}
471
472
/// `GET /{owner}/{name}/flow/at/{ref}`: the run of the ref's state, or the Flow tab.
473
pub async fn at(
474
    State(app): State<Shared>,
475
    viewer: Viewer,
476
    Path((owner, name, r)): Path<(String, String, String)>,
477
) -> Result<Response, Error> {
478
    let shell = Shell::new(&app, "", &viewer);
479
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
480
    let (heads, _) = state_of(&app, &owner, &name, &r).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
481
    let run = fdb::latest_for_heads(&app.db, row.id, &heads).await.map_err(|e| Error::from_db(shell.clone(), e))?;
482
    let to = match run {
a0d4bbfb Andy McCall ↶ 483
        Some(r) => format!("/{owner}/{name}/flow/{}", r.number),
736f6813 Andy McCall ↶ 484
        None => format!("/{owner}/{name}/flow"),
485
    };
486
    Ok(axum::response::Redirect::to(&to).into_response())
487
}
488
489
fn xml(s: &str) -> String {
490
    s.replace('&', "&amp;").replace('<', "&lt;").replace('>', "&gt;").replace('"', "&quot;")
491
}
492
493
/// The stamp: the mark, one glyph per job, the status, the state and the
494
/// date; the same facts machine-readable in `<metadata>`. Fixed colours,
495
/// because an image does not follow the page's theme.
496
pub fn stamp_svg(heads: &str, run: Option<&fdb::Run>, jobs: &[fdb::Job]) -> String {
497
    const CH: f64 = 6.6; // IBM Plex Mono at 11px
498
    let colour = |s: &str| match s {
499
        "passed" => "#5fe3a1",
500
        "failed" | "error" => "#ff5e7a",
501
        "running" => "#00e0f0",
502
        _ => "#8592ad",
503
    };
504
    let short: String = heads.chars().take(12).collect();
505
    let (status, date) = match run {
506
        Some(r) => (r.status.as_str(), crate::render::time::absolute(r.created_ms as u64).chars().take(10).collect::<String>()),
507
        None => ("no run", String::new()),
508
    };
509
    let mut ordered: Vec<&fdb::Job> = jobs.iter().collect();
510
    ordered.sort_by(|a, b| (a.depth, &a.name).cmp(&(b.depth, &b.name)));
511
    let label = "OXYGENFLOW";
512
    let label_w = 14.0 + label.len() as f64 * 6.2 + 8.0;
513
    let glyphs_w = if ordered.is_empty() { 0.0 } else { ordered.len() as f64 * 10.0 + 6.0 };
514
    let tail = if date.is_empty() { format!("{status} · {short}") } else { format!("{status} · {short} · {date}") };
515
    let right_w = 8.0 + glyphs_w + tail.chars().count() as f64 * CH + 8.0;
516
    let w = (label_w + right_w).ceil();
517
    let mut glyphs = String::new();
518
    for (i, j) in ordered.iter().enumerate() {
519
        let x = label_w + 8.0 + i as f64 * 10.0 + 4.0;
520
        glyphs.push_str(&format!(
521
            r#"<text x="{x:.1}" y="15" fill="{}" text-anchor="middle">{}</text>"#,
522
            colour(&j.status),
523
            glyph(&j.status)
524
        ));
525
    }
526
    let meta = serde_json::json!({
527
        "heads": heads.split('+').filter(|h| !h.is_empty()).collect::<Vec<_>>(),
a0d4bbfb Andy McCall ↶ 528
        "run": run.map(|r| r.number),
736f6813 Andy McCall ↶ 529
        "status": status,
530
        "jobs": ordered.iter().map(|j| serde_json::json!({ "name": j.name, "status": j.status, "receipt": j.receipt_hash })).collect::<Vec<_>>(),
531
    });
532
    let title = match run {
a0d4bbfb Andy McCall ↶ 533
        Some(r) => format!("OxygenFlow run #{} {status} on state {short}", r.number),
736f6813 Andy McCall ↶ 534
        None => format!("OxygenFlow: no run for state {short}"),
535
    };
536
    format!(
537
        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>"##,
538
        t = xml(&title),
539
        m = xml(&meta.to_string()),
540
        lw = label_w,
541
        lx = label_w - 4.0,
542
        tx = label_w + 8.0 + glyphs_w,
543
        sc = colour(status),
544
        tail = xml(&tail),
545
        wi = w - 1.0,
546
    )
547
}
cc19697f Andy McCall ↶ 548
549
/// A receipt kept in a repository (Oxygen spec §14.6), as pages show it.
550
#[derive(Clone, Debug)]
551
pub struct ReceiptRow {
552
    pub attest: String,
553
    pub job: String,
554
    pub exit_code: u32,
555
    pub duration: String,
556
    pub runner: String,
557
    pub run: String,
558
    /// Why it does not verify, or that its runner's key was revoked.
559
    pub problem: String,
560
    pub made_ms: i64,
561
}
562
563
impl ReceiptRow {
564
    pub fn passed(&self) -> bool {
565
        self.exit_code == 0
566
    }
567
}
568
569
/// The receipts kept for the state of `heads`.
570
pub async fn receipts_of(app: &Shared, name: &crate::repos::RepoName, heads: Vec<oxy_core::hash::ChangeHash>) -> Vec<ReceiptRow> {
571
    let base = app.config.base_url();
572
    let found = app.repos.read(name, move |repo, _| Ok(repo.receipts(&heads)?)).await.unwrap_or_default();
573
    found
574
        .into_iter()
575
        .map(|i| {
576
            let r = &i.signed.receipt;
577
            let run = i.signed.run().to_string();
578
            ReceiptRow {
579
                attest: i.attest.to_hex(),
580
                job: r.job_name.clone(),
581
                exit_code: r.exit_code,
582
                duration: crate::flow::human_ms(r.duration_ms as i64),
583
                runner: i.signed.runner.name.clone(),
584
                // Only links to this hub are followed from the page.
585
                run: if run.starts_with(base) { run } else { String::new() },
586
                problem: match (i.problem, i.revoked) {
587
                    (Some(p), _) => p,
588
                    (None, true) => "the runner's key was revoked".into(),
589
                    (None, false) => String::new(),
590
                },
591
                made_ms: i.signed.attest.hlc.wall_ms as i64,
592
            }
593
        })
594
        .collect()
595
}
596
597
/// `GET /{owner}/{name}/receipts/{attest}`: a signed receipt, for
598
/// `oxy receipt verify` or `oxy receipt import`.
599
pub async fn receipt_file(
600
    State(app): State<Shared>,
601
    viewer: Viewer,
602
    Path((owner, name, attest)): Path<(String, String, String)>,
603
) -> Result<Response, Error> {
604
    let shell = Shell::new(&app, &format!("/{owner}/{name}/receipts/{attest}"), &viewer);
605
    let (repo, _row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
606
    let Some(r) = oxy_core::hash::ObjectRef::from_hex(attest.trim_end_matches(".receipt")) else {
607
        return Err(Error::not_found(shell));
608
    };
609
    let (job, bytes) = app
610
        .repos
611
        .read(&repo, move |repo, _| {
612
            let i = repo.receipt(&r)?;
613
            Ok((i.signed.receipt.job_name.clone(), i.signed.encode()))
614
        })
615
        .await
616
        .map_err(|_| Error::not_found(shell.clone()))?;
617
    let file: String = job.chars().filter(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')).collect();
618
    Ok((
619
        [
620
            (axum::http::header::CONTENT_TYPE, "application/oxy-receipt".to_string()),
621
            (axum::http::header::CONTENT_DISPOSITION, format!("attachment; filename=\"{file}-{}.receipt\"", r.short(12))),
a3c8288b Andy McCall ↶ 622
        ],
623
        bytes,
624
    )
625
        .into_response())
626
}
627
628
/// `GET /{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}`: an artifact
629
/// of a run's job, read from the repository.
630
pub async fn artifact_file(
631
    State(app): State<Shared>,
632
    viewer: Viewer,
633
    Path((owner, name, id, job, artifact)): Path<(String, String, i64, String, String)>,
634
) -> Result<Response, Error> {
635
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}"), &viewer);
636
    let (repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
637
    let run = fdb::run(&app.db, row.id, id)
638
        .await
639
        .map_err(|e| Error::from_db(shell.clone(), e))?
640
        .ok_or_else(|| Error::not_found(shell.clone()))?;
641
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
642
    let Some(j) = jobs.iter().find(|j| j.name == job) else { return Err(Error::not_found(shell)) };
643
    let arts = fdb::artifacts(&app.db, j.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
644
    let Some(a) = arts.into_iter().find(|a| a.name == artifact) else { return Err(Error::not_found(shell)) };
645
    let Some(blob) = oxy_core::hash::ObjectRef::from_hex(&a.blob) else { return Err(Error::not_found(shell)) };
646
    let bytes = app.repos.read(&repo, move |r, _| Ok(r.read_blob(&blob)?)).await.map_err(|_| Error::not_found(shell.clone()))?;
647
    let file = a.path.rsplit('/').next().unwrap_or(&a.name).to_string();
648
    Ok((
649
        [
650
            (axum::http::header::CONTENT_TYPE, "application/octet-stream".to_string()),
651
            (axum::http::header::CONTENT_DISPOSITION, format!("attachment; filename=\"{}\"", file.replace('"', ""))),
cc19697f Andy McCall ↶ 652
        ],
653
        bytes,
654
    )
655
        .into_response())
10708ab8 Andy McCall ↶ 656
}
657
658
#[derive(Deserialize)]
659
pub struct AttachForm {
660
    _csrf: String,
661
    release: i64,
662
}
663
664
/// `POST /{owner}/{name}/flow/{id}/artifacts/{job}/{artifact}/attach`: add
665
/// an artifact to a release as an asset, named after its path; the release
666
/// page then shows the run and receipt that built it.
667
pub async fn attach(
668
    State(app): State<Shared>,
669
    viewer: Viewer,
670
    Path((owner, name, id, job, artifact)): Path<(String, String, i64, String, String)>,
671
    Form(f): Form<AttachForm>,
672
) -> Result<Response, Error> {
673
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow/{id}"), &viewer);
674
    require(&viewer, &shell)?;
675
    csrf(&viewer, &f._csrf, &shell)?;
676
    let (repo, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
677
    let run = fdb::run(&app.db, row.id, id)
678
        .await
679
        .map_err(|e| Error::from_db(shell.clone(), e))?
680
        .ok_or_else(|| Error::not_found(shell.clone()))?;
681
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
682
    let Some(j) = jobs.iter().find(|j| j.name == job) else { return Err(Error::not_found(shell)) };
683
    let arts = fdb::artifacts(&app.db, j.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
684
    let Some(a) = arts.into_iter().find(|a| a.name == artifact) else { return Err(Error::not_found(shell)) };
685
    let releases = db::releases::list(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
686
    let Some(rel) = releases.into_iter().find(|r| r.id == f.release) else { return Err(Error::not_found(shell)) };
687
    let Some(blob) = oxy_core::hash::ObjectRef::from_hex(&a.blob) else { return Err(Error::not_found(shell)) };
688
    let bytes = app.repos.read(&repo, move |r, _| Ok(r.read_blob(&blob)?)).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
689
    let file = a.path.rsplit('/').next().unwrap_or(&a.name).to_string();
690
    super::releases::store_asset(&app, rel.id, &file, "application/octet-stream", &bytes)
691
        .await
692
        .map_err(|m| Error::bad(shell.clone(), m))?;
693
    Ok(Redirect::to(&format!("/{owner}/{name}/releases/tag/{}", rel.tag)).into_response())
cc19697f Andy McCall ↶ 694
}
8933faff Andy McCall ↶ 695
696
/// `/{owner}/{name}/flow/badge.svg`: the latest run on the default
697
/// bookmark as a small SVG for a README, for whoever may read the
698
/// repository. `passed` green, `failed` or `error` red, a run still going
699
/// blue, none grey.
700
pub async fn badge(
701
    State(app): State<Shared>,
702
    viewer: Viewer,
703
    Path((owner, name)): Path<(String, String)>,
704
) -> Result<axum::response::Response, Error> {
705
    use axum::response::IntoResponse;
706
    let shell = Shell::new(&app, &format!("/{owner}/{name}/flow"), &viewer);
707
    let (_repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
708
    let latest = fdb::latest_on(&app.db, row.id, &row.default_bookmark).await.map_err(|e| Error::from_db(shell.clone(), e))?;
709
    let (text, colour) = match latest.as_ref().map(|r| r.status.as_str()) {
710
        Some("passed") => ("passing", "#2da44e"),
711
        Some("failed") | Some("error") => ("failing", "#cf222e"),
712
        Some("cancelled") => ("cancelled", "#6e7781"),
713
        Some(_) => ("running", "#0969da"),
714
        None => ("no runs", "#6e7781"),
715
    };
716
    let label = "OxygenFlow";
717
    let (lw, tw) = (label.len() as u32 * 7 + 10, text.len() as u32 * 7 + 10);
718
    let svg = format!(
719
        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>"##,
720
        w = lw + tw,
721
        lx = lw / 2,
722
        tx = lw + tw / 2,
723
    );
724
    Ok((
725
        [(axum::http::header::CONTENT_TYPE, "image/svg+xml; charset=utf-8"), (axum::http::header::CACHE_CONTROL, "no-cache, max-age=60")],
726
        svg,
727
    )
728
        .into_response())
729
}