OXYGENHUB
◆ proposal-list-fast oxygenhub / crates / hub / src / flow.rs
143.3 KiB · Rust · last changed Runner updates: a build that rolls back on one runner is held 10 days ago source blame history raw
42fa9554 Andy McCall ↶ 1
//! OxygenFlow on the hub (hub spec §13.2): runs started by pushes, the
2
//! runner API, job tokens and the checks that mirror jobs. Pipelines are
3
//! parsed by `flow-core`, the same code `flow check` runs.
4
5
use crate::api::ApiError;
6
use crate::db::{self, flow as fdb};
7
use crate::repos::RepoName;
8
use crate::Shared;
9
use axum::extract::{Path, State};
10
use axum::http::{HeaderMap, StatusCode};
11
use axum::response::{IntoResponse, Response};
12
use axum::Json;
13
use flow_core::api::{Claim, ClaimRequest, Finish, LogBatch, MAX_RECORDS, MAX_RECORD_TEXT};
14
use flow_core::{Pipeline, PIPELINE_PATH};
15
use oxy_core::hash::ChangeHash;
16
17
/// Prefix of job tokens, so the wire protocol can tell them from personal tokens.
18
pub const JOB_TOKEN_PREFIX: &str = "flowjob_";
19
/// A job token is refused this long after its job started, whatever its state.
20
pub const JOB_TOKEN_MAX_AGE_MS: i64 = 2 * 3600 * 1000;
21
9008bf6c Andy McCall ↶ 22
/// Whether pushes to this repository start runs: its own setting when a
23
/// site administrator made one, else hub.toml's `[flow] repos`.
24
pub fn enabled(app: &Shared, row: &db::repos::RepoRow) -> bool {
166f6e9b Andy McCall 25
    // A drop never runs Flow (#279), whatever it holds.
26
    if row.is_drop() {
27
        return false;
28
    }
9008bf6c Andy McCall ↶ 29
    match row.flow.as_str() {
1870e4fa Andy McCall ↶ 30
        // `own`: on, run only by the repository's or its owner's runners (#225).
31
        "on" | "own" => true,
9008bf6c Andy McCall ↶ 32
        "off" => false,
33
        _ => app.config.flow.allows(&row.owner, &row.name),
34
    }
35
}
36
42fa9554 Andy McCall ↶ 37
/// A bookmark moved by a push: start a run when the repository is allowed
38
/// and the new state has a pipeline.
39
pub async fn on_push(app: &Shared, row: &db::repos::RepoRow, bookmark: &str, state: &str, heads: &[ChangeHash], actor: &str) {
c889911b Andy McCall ↶ 40
    if heads.is_empty() || !enabled(app, row) {
42fa9554 Andy McCall ↶ 41
        return;
42
    }
c889911b Andy McCall ↶ 43
    // A pushed tag runs the jobs whose `on` names it (oxygenflow#24).
44
    let started = match bookmark.strip_prefix("tags/") {
45
        Some(tag) => start_run_with(app, row, bookmark, state, heads, actor, &format!("tag:{tag}"), None).await,
46
        None => {
367f34b8 Andy McCall ↶ 47
            // `[skip flow]` in the newest change it brings (#284): recorded,
48
            // no jobs.
49
            if let Some((change, marker)) = skip_asked(app, row, bookmark, heads).await {
50
                skip_run(app, row, bookmark, state, heads, actor, &change, marker).await;
51
                return;
52
            }
a9f1c0bf Andy McCall ↶ 53
            // It supersedes the push runs still going on the bookmark (#267).
c889911b Andy McCall ↶ 54
            let touched = touched_since_last_run(app, row, bookmark, heads).await;
a9f1c0bf Andy McCall ↶ 55
            start_run_scoped(app, row, bookmark, state, heads, actor, "push", touched.as_deref()).await
c889911b Andy McCall ↶ 56
        }
57
    };
58
    if let Err(e) = started {
1edac4b6 Andy McCall ↶ 59
        tracing::warn!("flow: starting a run of {}/{}: {e}", row.owner, row.name);
367f34b8 Andy McCall ↶ 60
    }
61
}
62
5588bb36 Andy McCall ↶ 63
/// Whether a job's earlier pass may stand for it on the same state (#265):
64
/// not a job that waits for a person, deploys to an environment, holds
65
/// secrets or asks for identity tokens, whose running is the point.
66
fn reusable(job: &flow_core::Job) -> bool {
67
    job.approval.is_none() && job.environment.is_none() && job.secrets.is_empty() && job.identities.is_empty()
68
}
69
367f34b8 Andy McCall ↶ 70
/// The markers that ask a push not to start a run (#284), as the forges
71
/// spell them; matched in any case.
72
pub const SKIP_MARKERS: [&str; 3] = ["[skip flow]", "[skip ci]", "[ci skip]"];
73
3b3a51af Andy McCall ↶ 74
/// The marker in `message` that asks for no run, if any. A marker quoted
75
/// in code (between backticks, or in a fenced block) only mentions one
76
/// and does not count.
367f34b8 Andy McCall ↶ 77
pub fn skip_marker(message: &str) -> Option<&'static str> {
3b3a51af Andy McCall ↶ 78
    let m = outside_code(message).to_lowercase();
367f34b8 Andy McCall ↶ 79
    SKIP_MARKERS.into_iter().find(|k| m.contains(k))
80
}
81
3b3a51af Andy McCall ↶ 82
/// `text` without its fenced blocks (lines between ``` fences) and inline
83
/// code spans (between backticks).
84
fn outside_code(text: &str) -> String {
85
    let mut out = String::new();
86
    let mut fenced = false;
87
    for line in text.lines() {
88
        if line.trim_start().starts_with("```") {
89
            fenced = !fenced;
90
            continue;
91
        }
92
        if fenced {
93
            continue;
94
        }
95
        // Inline spans: every other backtick-separated piece is code; an
96
        // unmatched backtick leaves the rest as text.
97
        let pieces: Vec<&str> = line.split('`').collect();
98
        let closed = pieces.len() % 2 == 1;
99
        for (i, piece) in pieces.iter().enumerate() {
100
            let in_code = i % 2 == 1 && (closed || i + 1 < pieces.len());
101
            if !in_code {
102
                out.push_str(piece);
103
                out.push(' ');
104
            }
105
        }
106
        out.push('\n');
107
    }
108
    out
109
}
110
367f34b8 Andy McCall ↶ 111
/// Whether the repository lets a push to `bookmark` skip its run: `any`
112
/// bookmark (the default), `others` than the default one, or `never`.
113
pub fn skip_allowed(row: &db::repos::RepoRow, bookmark: &str) -> bool {
114
    match row.flow_skip.as_str() {
115
        "never" => false,
116
        "others" => bookmark != row.default_bookmark,
117
        _ => true,
118
    }
119
}
120
121
/// The newest change of `heads` (by its clock) when its message asks for
122
/// no run and the repository allows that here: its hash and the marker.
123
async fn skip_asked(app: &Shared, row: &db::repos::RepoRow, bookmark: &str, heads: &[ChangeHash]) -> Option<(ChangeHash, &'static str)> {
124
    if !skip_allowed(row, bookmark) {
125
        return None;
126
    }
127
    let repo = RepoName::new(&row.owner, &row.name)?;
128
    let h = heads.to_vec();
129
    let newest = app
130
        .repos
131
        .read(&repo, move |r, _| {
132
            let mut best: Option<(oxy_core::objects::Hlc, ChangeHash, String)> = None;
133
            for x in &h {
134
                let (c, _) = r.store().get_change_lazy(x)?;
135
                if best.as_ref().is_none_or(|(t, _, _)| c.hlc > *t) {
136
                    best = Some((c.hlc, *x, c.message.clone()));
137
                }
138
            }
139
            Ok(best)
140
        })
141
        .await
142
        .ok()??;
143
    skip_marker(&newest.2).map(|m| (newest.1, m))
144
}
145
146
/// Record a push's run as skipped (#284): finished, with no jobs, saying
147
/// which change asked and who pushed it. The next run's scope still covers
148
/// what this push brought, as a skipped run is never its baseline.
149
#[allow(clippy::too_many_arguments)]
150
async fn skip_run(
151
    app: &Shared,
152
    row: &db::repos::RepoRow,
153
    bookmark: &str,
154
    state: &str,
155
    heads: &[ChangeHash],
156
    actor: &str,
157
    change: &ChangeHash,
158
    marker: &str,
159
) {
160
    let mut hex: Vec<String> = heads.iter().map(|h| h.to_hex()).collect();
161
    hex.sort();
162
    let heads_s = hex.join("+");
163
    let why = format!("{marker} in change {}, pushed by {actor}", change.short(12));
164
    let base =
165
        db::flow::NewRun { repo_id: row.id, bookmark, state, heads: &heads_s, pipeline_hash: "", actor, trigger: "push", error: None };
166
    if let Err(e) = db::flow::create_skipped_run(&app.db, base, &why).await {
167
        tracing::warn!("flow: recording a skipped run of {}/{}: {e}", row.owner, row.name);
1edac4b6 Andy McCall ↶ 168
    }
169
}
170
171
/// "Run pipeline" (hub spec §13.2): run a bookmark's current state without
172
/// moving it. Returns the new run's number.
0650d94e Andy McCall ↶ 173
/// `jobs`, when not empty, are the only jobs to start (oxygenhub#130), with
174
/// the jobs they depend on.
175
pub async fn run_bookmark(app: &Shared, row: &db::repos::RepoRow, bookmark: &str, actor: &str, jobs: &[String]) -> Result<i64, String> {
1edac4b6 Andy McCall ↶ 176
    if !enabled(app, row) {
177
        return Err("OxygenFlow is not enabled for this repository".into());
178
    }
179
    let repo = RepoName::new(&row.owner, &row.name).ok_or("bad repository name")?;
180
    let b = bookmark.to_string();
181
    let found = app
182
        .repos
183
        .read(&repo, move |r, _| {
184
            let Some(st) = r.view()?.bookmarks.get(&b).copied() else { return Ok(None) };
185
            Ok(Some((st, r.store().get_state(&st)?.heads)))
186
        })
187
        .await
188
        .map_err(|e| e.to_string())?;
189
    let Some((state, heads)) = found else { return Err(format!("no bookmark {bookmark}")) };
190
    if heads.is_empty() {
191
        return Err(format!("{bookmark} has no changes yet"));
192
    }
0650d94e Andy McCall ↶ 193
    start_run_at(app, row, bookmark, &state.to_hex(), &heads, actor, "manual", None, None, jobs)
1edac4b6 Andy McCall ↶ 194
        .await?
195
        .ok_or_else(|| format!("{bookmark} has no {PIPELINE_PATH}"))
196
}
197
4f692533 Andy McCall ↶ 198
/// "Run pipeline" on one committed change: the state whose only head is
199
/// `change`, whatever bookmarks hold it. Returns the new run's number.
0650d94e Andy McCall ↶ 200
pub async fn run_change(app: &Shared, row: &db::repos::RepoRow, change: &str, actor: &str, jobs: &[String]) -> Result<i64, String> {
4f692533 Andy McCall ↶ 201
    if !enabled(app, row) {
202
        return Err("OxygenFlow is not enabled for this repository".into());
203
    }
204
    let h = ChangeHash::from_hex(change.trim().trim_start_matches('#')).ok_or("give the full hash of a change")?;
205
    let repo = RepoName::new(&row.owner, &row.name).ok_or("bad repository name")?;
df15b747 Andy McCall ↶ 206
    let known = app.repos.read(&repo, move |r, _| Ok(r.store().get_change_meta(&h).is_ok())).await.map_err(|e| e.to_string())?;
4f692533 Andy McCall ↶ 207
    if !known {
208
        return Err(format!("no change {} in this repository", &change.trim()[..12.min(change.trim().len())]));
209
    }
210
    let state = oxy_core::hash::hash_object(oxy_core::hash::ObjectType::State, &oxy_core::objects::StateObject::new(vec![h]).encode());
0650d94e Andy McCall ↶ 211
    start_run_at(app, row, "", &state.to_hex(), &[h], actor, "manual", None, None, jobs)
4f692533 Andy McCall ↶ 212
        .await?
213
        .ok_or_else(|| format!("that change's state has no {PIPELINE_PATH}"))
214
}
215
1edac4b6 Andy McCall ↶ 216
/// Re-run a finished run: the same state, bookmark and pipeline, as a new
217
/// run whose checks replace the old ones. Returns the new run's number.
218
pub async fn rerun(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run, actor: &str) -> Result<i64, String> {
219
    if !enabled(app, row) {
220
        return Err("OxygenFlow is not enabled for this repository".into());
221
    }
222
    if run.live() {
223
        return Err(format!("run #{} is still {}", run.number, run.status));
224
    }
225
    let heads: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
226
    if heads.is_empty() {
227
        return Err("the run names no changes".into());
228
    }
c889911b Andy McCall ↶ 229
    // A rerun repeats its run's event: the jobs it had are the jobs it gets.
230
    let trigger = format!("rerun:{}:{}", run.number, original_event(run));
231
    start_run(app, row, &run.bookmark, &run.state, &heads, actor, &trigger)
1edac4b6 Andy McCall ↶ 232
        .await?
233
        .ok_or_else(|| format!("that state has no {PIPELINE_PATH}"))
745d225d Andy McCall ↶ 234
}
235
e8fa5369 Andy McCall ↶ 236
/// Run one job of a finished run again (oxygenflow#31), with the jobs
237
/// that depend on it; the jobs it depends on keep their results, so a
238
/// flaky test reruns without the build before it. Its checks go back to
239
/// queued. Returns how many jobs were queued again.
240
pub async fn rerun_job(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run, job: &str, actor: &str) -> Result<usize, String> {
241
    if !enabled(app, row) {
242
        return Err("OxygenFlow is not enabled for this repository".into());
243
    }
244
    if run.live() {
245
        return Err(format!("run #{} is still {}: wait for it, or cancel it, first", run.number, run.status));
246
    }
247
    let changed = fdb::rerun_job(&app.db, run.id, job).await.map_err(|e| {
248
        tracing::warn!("flow: rerunning {job} of run #{} of {}/{}: {e}", run.number, row.owner, row.name);
249
        "the job could not be queued again".to_string()
250
    })?;
251
    if changed.is_empty() {
252
        return Err(format!("run #{} has no job {job:?}", run.number));
253
    }
254
    for j in &changed {
255
        report_check(app, row, &run.state, run.number, &j.name, "queued", &format!("queued again by {actor}")).await;
256
    }
257
    Ok(changed.len())
258
}
259
745d225d Andy McCall ↶ 260
/// Cancel a run still going (oxygenflow#32), its checks with it.
261
pub async fn cancel(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run, actor: &str) -> Result<(), String> {
262
    if !run.live() {
263
        return Err(format!("run #{} is already {}", run.number, run.status));
264
    }
265
    cancel_with(app, run, &format!("cancelled by {actor}")).await.map_err(|e| {
266
        tracing::warn!("flow: cancelling run #{} of {}/{}: {e}", run.number, row.owner, row.name);
267
        "the run could not be cancelled".to_string()
268
    })
269
}
270
271
async fn cancel_with(app: &Shared, run: &fdb::Run, why: &str) -> sqlx::Result<()> {
272
    let changed = fdb::cancel_run(&app.db, run.id, why).await?;
273
    report_changed(app, run.id, changed).await
c889911b Andy McCall ↶ 274
}
275
417184c7 Andy McCall ↶ 276
/// Why job `job` of `run` cannot be decided on by `who` (oxygenflow#57),
277
/// or its approval: it must be waiting, the jobs it depends on done and
278
/// passed, `who` must have the role it names on the repository, and with
279
/// others-only must not be the person whose push started the run.
280
pub async fn may_decide(
281
    app: &Shared,
282
    row: &db::repos::RepoRow,
283
    run: &fdb::Run,
284
    job: &fdb::Job,
285
    who: &db::accounts::Account,
286
) -> Result<flow_core::Approval, String> {
287
    let spec: flow_core::Job = serde_json::from_str(&job.spec).map_err(|e| format!("stored job: {e}"))?;
288
    let Some(approval) = spec.approval else { return Err(format!("{} does not wait for approval", job.name)) };
289
    if job.status != "queued" || job.approval != "waiting" {
290
        return Err(format!("{} is not waiting for approval", job.name));
291
    }
292
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| e.to_string())?;
293
    if let Some(d) = job.depends_on().iter().find(|d| !jobs.iter().any(|j| &j.name == *d && j.status == "passed")) {
294
        return Err(format!("{} waits for {d} first", job.name));
295
    }
296
    let need = crate::auth::roles::Role::parse(&approval.by).unwrap_or(crate::auth::roles::Role::Maintain);
297
    let role = crate::auth::roles::role_for(&app.db, Some(who), row).await.map_err(|e| e.to_string())?;
298
    if role.is_none_or(|r| r < need) {
299
        return Err(format!("approving {} takes the {} role on {}/{}", job.name, approval.by, row.owner, row.name));
300
    }
301
    if approval.others_only && who.username == run.actor {
302
        return Err(format!("{} must be approved by someone other than {}, whose push started the run", job.name, run.actor));
303
    }
304
    Ok(approval)
305
}
306
307
/// Approve or reject job `name` of `run` as `who` (oxygenflow#57): the
308
/// decision goes on the job, its log and the audit log; a rejected job ends
309
/// as cancelled and the jobs after it are skipped. What happened, or why not.
310
pub async fn decide(
311
    app: &Shared,
312
    row: &db::repos::RepoRow,
313
    run: &fdb::Run,
314
    name: &str,
315
    who: &db::accounts::Account,
316
    approve: bool,
05f1a85a Andy McCall ↶ 317
    via: Option<&str>,
417184c7 Andy McCall ↶ 318
) -> Result<String, String> {
05f1a85a Andy McCall ↶ 319
    decide_with(app, row, run, name, who, approve, Through { seal: None, via }).await
47e37402 Andy McCall ↶ 320
}
321
05f1a85a Andy McCall ↶ 322
/// How a decision arrived: with a sealed approval's ref, or through an
323
/// agent token (by its name).
324
#[derive(Clone, Copy, Default)]
325
struct Through<'a> {
326
    seal: Option<&'a str>,
327
    via: Option<&'a str>,
328
}
329
47e37402 Andy McCall ↶ 330
/// [`decide`], from a verified seal (`Some(approval ref)`) or without one;
331
/// a gate that takes a sealed approval is not approved without.
332
async fn decide_with(
333
    app: &Shared,
334
    row: &db::repos::RepoRow,
335
    run: &fdb::Run,
336
    name: &str,
337
    who: &db::accounts::Account,
338
    approve: bool,
05f1a85a Andy McCall ↶ 339
    through: Through<'_>,
47e37402 Andy McCall ↶ 340
) -> Result<String, String> {
05f1a85a Andy McCall ↶ 341
    let Through { seal, via } = through;
417184c7 Andy McCall ↶ 342
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| e.to_string())?;
343
    let Some(job) = jobs.into_iter().find(|j| j.name == name) else { return Err(format!("run #{} has no job {name}", run.number)) };
47e37402 Andy McCall ↶ 344
    let approval = may_decide(app, row, run, &job, who).await?;
4a68f106 Andy McCall ↶ 345
    // A gate exists so a person decides (#258): an agent's token decides it
346
    // only where the repository allows it. A sealed decision is a person's
347
    // key, whatever carried it.
348
    if let (Some(agent), None) = (via, seal) {
349
        if !row.agents_decide_gates {
350
            return Err(format!(
351
                "{name} is decided by a person here, not through an agent's token ({agent}): decide it yourself on the run page, or a maintainer can let agents decide approval gates in Settings › OxygenFlow"
352
            ));
353
        }
354
    }
47e37402 Andy McCall ↶ 355
    if approve && approval.sealed && seal.is_none() {
356
        return Err(format!(
357
            "{name} takes an approval signed with your key: in a checkout of {}/{}, run oxy seal --flow {}/{}/{}/flow/{} --job {name}",
358
            row.owner,
359
            row.name,
360
            app.config.base_url(),
361
            row.owner,
362
            row.name,
363
            run.number
364
        ));
365
    }
417184c7 Andy McCall ↶ 366
    let target = format!("{}/{}#{} {name}", row.owner, row.name, run.number);
47e37402 Andy McCall ↶ 367
    let sealed = seal.map(|r| format!(", sealed (approval {})", &r[..12.min(r.len())])).unwrap_or_default();
05f1a85a Andy McCall ↶ 368
    // Through an agent's token, it says so (oxygenhub#229).
369
    let by = match via {
370
        Some(v) => format!("{} via {v}", who.username),
371
        None => who.username.clone(),
372
    };
373
    let detail = [seal.unwrap_or(""), &via.map(|v| format!("via {v}")).unwrap_or_default()]
374
        .iter()
375
        .filter(|s| !s.is_empty())
376
        .cloned()
377
        .collect::<Vec<_>>()
378
        .join(", ");
417184c7 Andy McCall ↶ 379
    let said = if approve {
05f1a85a Andy McCall ↶ 380
        if !fdb::approve_job(&app.db, job.id, &who.username, seal.unwrap_or(""), via.unwrap_or("")).await.map_err(|e| e.to_string())? {
417184c7 Andy McCall ↶ 381
            return Err(format!("{name} was decided on meanwhile"));
382
        }
05f1a85a Andy McCall ↶ 383
        db::accounts::audit(&app.db, Some(who), "flow.approved", &target, &detail).await.ok();
384
        format!("approved by {by}{sealed}")
417184c7 Andy McCall ↶ 385
    } else {
05f1a85a Andy McCall ↶ 386
        fdb::note_rejection(&app.db, job.id, &who.username, via.unwrap_or("")).await.map_err(|e| e.to_string())?;
387
        let why = format!("rejected by {by}{sealed}");
417184c7 Andy McCall ↶ 388
        let changed =
389
            fdb::finish(&app.db, job.id, fdb::Outcome { status: "cancelled", exit_code: None, error: &why, receipt: "", receipt_hash: "" })
390
                .await
391
                .map_err(|e| e.to_string())?;
392
        report_changed(app, run.id, changed).await.ok();
05f1a85a Andy McCall ↶ 393
        db::accounts::audit(&app.db, Some(who), "flow.rejected", &target, &detail).await.ok();
417184c7 Andy McCall ↶ 394
        why
395
    };
396
    let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: said.clone() };
397
    fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
398
    Ok(format!("{name}: {said}"))
399
}
400
dc59d1b5 Andy McCall ↶ 401
/// Tell the people who may approve a job of `run` that has just become
402
/// ready (its dependencies all passed) and waits for them (oxygenflow#57).
403
/// Told once: the job's log notes it.
404
async fn tell_approvers(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run) {
405
    const TOLD: &str = "waiting for approval; the people who may approve were told";
406
    let Ok(jobs) = fdb::jobs(&app.db, run.id).await else { return };
407
    for job in jobs.iter().filter(|j| j.status == "queued" && j.approval == "waiting") {
408
        if !job.depends_on().iter().all(|d| jobs.iter().any(|j| &j.name == d && j.status == "passed")) {
409
            continue;
410
        }
411
        let already = fdb::log(&app.db, job.id, 0, 50).await.unwrap_or_default().iter().any(|l| l.text == TOLD);
412
        if already {
413
            continue;
414
        }
415
        let mut targets = Vec::new();
416
        for a in db::accounts::accounts(&app.db).await.unwrap_or_default().iter().filter(|a| !a.blocked()) {
417
            if may_decide(app, row, run, job, a).await.is_ok() {
418
                targets.push((a.id, db::notify::Reason::Participating));
419
            }
420
        }
421
        let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: TOLD.into() };
422
        fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
423
        let title = format!("{}/{} run #{}: {} waits for your approval", row.owner, row.name, run.number, job.name);
424
        let url = format!("/{}/{}/flow/{}", row.owner, row.name, run.number);
425
        crate::notify::tell(app, "flow.approval", &title, &url, &run.actor, Some(row.id), targets).await;
426
    }
47e37402 Andy McCall ↶ 427
}
428
429
/// What approving job `name` of `run` means, for the approver to sign
430
/// (oxygenhub#235): this repository, the run's URL, the job's hash with its
431
/// sandbox, the run's state, the blobs it takes, its environment.
432
pub async fn approval_statement(
433
    app: &Shared,
434
    row: &db::repos::RepoRow,
435
    run: &fdb::Run,
436
    name: &str,
437
) -> Result<(oxy_core::approval::Statement, fdb::Job), String> {
438
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| e.to_string())?;
439
    let Some(job) = jobs.into_iter().find(|j| j.name == name) else { return Err(format!("run #{} has no job {name}", run.number)) };
440
    let spec: flow_core::Job = serde_json::from_str(&job.spec).map_err(|e| format!("stored job: {e}"))?;
441
    let sandbox: flow_core::Sandbox = serde_json::from_str(&job.sandbox).map_err(|e| format!("stored sandbox: {e}"))?;
442
    let repo_name = RepoName::new(&row.owner, &row.name).ok_or("bad repository name")?;
443
    let repo = app.repos.read(&repo_name, |r, _| Ok(r.id()?)).await.map_err(|e| e.to_string())?;
444
    let state = oxy_core::hash::ObjectRef::from_hex(&run.state).ok_or("the run has no state")?;
445
    let inputs = artifact_inputs(app, &job, &spec).await?.iter().filter_map(|i| oxy_core::hash::ObjectRef::from_hex(&i.blob)).collect();
446
    let statement = oxy_core::approval::Statement {
447
        repo,
448
        run: format!("{}/{}/{}/flow/{}", app.config.base_url(), row.owner, row.name, run.number),
449
        job: name.to_string(),
450
        job_hash: oxy_core::hash::ObjectRef(spec.hash(&sandbox)),
451
        state,
452
        inputs,
453
        environment: spec.environment.clone().unwrap_or_default(),
454
        approve: true,
455
    };
456
    Ok((statement, job))
457
}
458
317d776c Andy McCall ↶ 459
/// An unlinked key's account, when its identity succeeds a linked key's
460
/// through `previous` links that each keep the key pair (a renewal or a
461
/// delegation, Oxygen spec §14.2), with the identities from it down to the
462
/// linked one, to link (oxygenhub#236). A step that changes the key pair
463
/// ends the search: that is a new key, linked by proving it.
464
async fn linked_through_chain(
465
    app: &Shared,
466
    repo: &RepoName,
467
    signer: &oxy_core::identity::Identity,
468
    links: &[(String, String)],
469
) -> Option<(String, Vec<oxy_core::identity::Identity>)> {
470
    let mut chain = vec![signer.clone()];
471
    let mut cur = signer.clone();
472
    for _ in 0..64 {
473
        let prev = cur.previous?;
474
        let hex = prev.to_hex();
475
        let found = match db::accounts::identity_by_key(&app.db, &hex).await.ok()? {
476
            Some(l) => oxy_core::identity::Identity::decode(&l.object).ok(),
477
            None => app.repos.read(repo, move |r, _| Ok(r.store().get_identity(&prev).ok())).await.ok().flatten(),
478
        };
479
        let id = found?;
480
        if id.hash() != prev || id.ed25519_pk != cur.ed25519_pk || id.mldsa65_pk != cur.mldsa65_pk {
481
            return None;
482
        }
483
        if let Some((_, u)) = links.iter().find(|(k, _)| *k == hex) {
484
            return Some((u.clone(), chain));
485
        }
486
        chain.push(id.clone());
487
        cur = id;
488
    }
489
    None
490
}
491
47e37402 Andy McCall ↶ 492
/// Decide on job `name` of `run` from a signed approval (oxygenhub#235): it
493
/// must verify, cover exactly this job's statement, and be signed by a key
494
/// linked to an account (a delegated agent key is not) that may decide; it
495
/// is kept in the repository. What happened, or why not.
496
pub async fn decide_sealed(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run, name: &str, signed_hex: &str) -> Result<String, String> {
497
    let bytes = hex::decode(signed_hex.trim()).map_err(|_| "the signed approval is not hex".to_string())?;
498
    let sa = oxy_core::approval::SignedApproval::decode(&bytes).map_err(|e| format!("not a signed approval: {e}"))?;
499
    sa.verify().map_err(|e| format!("it does not verify: {e}"))?;
500
    let (mut expected, _) = approval_statement(app, row, run, name).await?;
501
    let given = sa.statement().map_err(|e| e.to_string())?;
502
    expected.approve = given.approve;
503
    if !sa.covers(&expected) {
504
        return Err(format!(
505
            "it approves something else than job {name} of run #{} as it is now (another run, state, plan or environment): sign again",
506
            run.number
507
        ));
508
    }
509
    let key = sa.signer.hash().to_hex();
510
    let links = db::accounts::identity_accounts(&app.db).await.map_err(|e| e.to_string())?;
511
    let repo_name = RepoName::new(&row.owner, &row.name).ok_or("bad repository name")?;
317d776c Andy McCall ↶ 512
    let username = match links.iter().find(|(k, _)| *k == key) {
513
        Some((_, u)) => u.clone(),
514
        // A renewal or delegation of a linked key keeps its key pair: it is
515
        // the same person's, and linked now (oxygenhub#236).
516
        None => match linked_through_chain(app, &repo_name, &sa.signer, &links).await {
517
            Some((u, chain)) => {
518
                if let Ok(Some(acc)) = db::accounts::account_by_name(&app.db, &u).await {
519
                    for id in &chain {
520
                        let k = id.hash().to_hex();
521
                        if let Ok(None) = db::accounts::identity_by_key(&app.db, &k).await {
522
                            db::accounts::link_identity(&app.db, acc.id, &k, &id.name, &id.email, &id.encode()).await.ok();
523
                        }
524
                    }
525
                }
526
                u
527
            }
528
            None => {
529
                return Err(format!(
530
                    "key {} is not linked to an account here, nor a renewal of a key that is (link it under Settings › Keys; an agent's delegated key cannot approve)",
531
                    &key[..12]
532
                ))
533
            }
534
        },
535
    };
536
    let who = db::accounts::account_by_name(&app.db, &username).await.map_err(|e| e.to_string())?.ok_or("the key's account is gone")?;
47e37402 Andy McCall ↶ 537
    let jobs = fdb::jobs(&app.db, run.id).await.map_err(|e| e.to_string())?;
538
    let job = jobs.iter().find(|j| j.name == name).ok_or("no such job")?;
539
    may_decide(app, row, run, job, &who).await?;
965b950f Andy McCall ↶ 540
    let (rid, signers) = (sa.attest.repo, sa.sigs.iter().map(|s| s.key).collect::<Vec<_>>());
47e37402 Andy McCall ↶ 541
    let kept = app.repos.write(&repo_name, move |r, _| Ok(r.add_approval(&sa)?)).await.map_err(|e| e.to_string())?;
965b950f Andy McCall ↶ 542
    crate::tlog::log(app, vec![crate::tlog::Pending { kind: "approval", repo: rid, repo_row: Some(row.id), object: kept, signers }]).await;
05f1a85a Andy McCall ↶ 543
    decide_with(app, row, run, name, &who, given.approve, Through { seal: Some(&kept.to_hex()), via: None }).await
dc59d1b5 Andy McCall ↶ 544
}
545
417184c7 Andy McCall ↶ 546
/// End the approvals that waited too long (oxygenflow#57): from when the
547
/// jobs a waiting job depends on finished (or its run began).
548
pub async fn expire_approvals(app: &Shared, now: i64) -> sqlx::Result<usize> {
549
    let mut ended = 0;
550
    for job in fdb::waiting_for_approval(&app.db).await? {
551
        let Ok(spec) = serde_json::from_str::<flow_core::Job>(&job.spec) else { continue };
552
        let Some(approval) = spec.approval else { continue };
553
        let Some(run) = fdb::run_by_id(&app.db, job.run_id).await? else { continue };
554
        let jobs = fdb::jobs(&app.db, run.id).await?;
555
        let wanted = job.depends_on();
556
        let deps: Vec<&fdb::Job> = jobs.iter().filter(|j| wanted.contains(&j.name)).collect();
557
        if deps.iter().any(|d| d.status != "passed") {
558
            continue;
559
        }
560
        let since = deps.iter().filter_map(|d| d.finished_ms).max().unwrap_or(run.created_ms);
561
        if now - since < approval.expires_s as i64 * 1000 {
562
            continue;
563
        }
564
        let hours = approval.expires_s as f64 / 3600.0;
565
        let why =
566
            format!("no approval within {}", if hours >= 1.0 { format!("{hours:.0}h") } else { format!("{}m", approval.expires_s / 60) });
567
        let changed =
568
            fdb::finish(&app.db, job.id, fdb::Outcome { status: "cancelled", exit_code: None, error: &why, receipt: "", receipt_hash: "" })
569
                .await?;
570
        report_changed(app, run.id, changed).await?;
571
        ended += 1;
572
    }
573
    Ok(ended)
a9f1c0bf Andy McCall ↶ 574
}
575
576
/// Newest run wins (oxygenhub#267): whether a new run started by `trigger`
577
/// cancels the older runs of its bookmark still live.
578
///
579
/// - A **push** run supersedes the older push runs of its bookmark: they
580
///   test states the bookmark has moved past. Diffusion's bumps start push
581
///   runs too.
582
/// - A **proposal** run (bookmark `proposal/N`, started when the
583
///   proposal's target moved, `web::proposals::settle_after_push`)
584
///   supersedes the older proposal runs of the same proposal: they test
585
///   projected states it no longer has. It leaves the proposal's source
586
///   bookmark's push runs alone: those test the source head, a different
587
///   state that other proposals or the bookmark's own checks may want.
588
/// - **Tag**, **manual** ("Run pipeline" on a bookmark or a change),
589
///   **schedule** and **rerun** runs were each asked for in their own
590
///   right (a person or a cron), so they supersede nothing and nothing
591
///   supersedes them: a rerun of an old push run tests the state it names,
592
///   on purpose. They are cancelled by hand.
593
///
594
/// Only runs of the same trigger on the same bookmark are superseded, so a
595
/// push never cancels a rerun or a proposal's run, nor the other way round.
596
fn supersedes(trigger: &str) -> bool {
597
    matches!(trigger, "push" | "proposal")
417184c7 Andy McCall ↶ 598
}
599
a9f1c0bf Andy McCall ↶ 600
/// Cancel what run `number` supersedes ([`supersedes`]): the older runs of
601
/// `bookmark` started by the same `trigger` still queued, and those already
602
/// running unless the repository keeps them (`flow_keep_running`, Settings
603
/// › OxygenFlow). A push run's scope reaches back past them either way
604
/// ([`fdb::latest_on`]).
605
async fn supersede(app: &Shared, row: &db::repos::RepoRow, bookmark: &str, trigger: &str, number: i64) {
606
    let Ok(older) = fdb::live_runs_before(&app.db, row.id, bookmark, trigger, number, !row.flow_keep_running).await else { return };
745d225d Andy McCall ↶ 607
    for run in older {
608
        if let Err(e) = cancel_with(app, &run, &format!("superseded by run #{number}")).await {
609
            tracing::warn!("flow: superseding run #{} of {}/{}: {e}", run.number, row.owner, row.name);
610
        }
611
    }
612
}
613
2abea308 Andy McCall ↶ 614
/// A proposal landed (#263): its runs that no runner has started can no
615
/// longer change anything, and they hold the queue ahead of the target's
616
/// own run, so they are cancelled. Its source bookmark's push runs (when
617
/// that bookmark is in this repository and is not the target) and its
618
/// `proposal/N` runs; running ones are left to finish.
619
pub async fn moot_after_landing(app: &Shared, row: &db::repos::RepoRow, p: &db::proposals::ProposalRow) {
620
    let now = db::now_ms();
621
    let mut moot = Vec::new();
622
    let same_repo = p.source_repo_id.is_none_or(|id| id == row.id);
623
    if p.source_kind == "bookmark" && same_repo && !p.source_bookmark.is_empty() && p.source_bookmark != p.target {
624
        moot.extend(fdb::unstarted_runs_on(&app.db, row.id, &p.source_bookmark, "push", now).await.unwrap_or_default());
625
    }
626
    moot.extend(fdb::unstarted_runs_on(&app.db, row.id, &format!("proposal/{}", p.number), "proposal", now).await.unwrap_or_default());
627
    for run in moot {
628
        if let Err(e) = cancel_with(app, &run, &format!("moot: proposal #{} landed", p.number)).await {
629
            tracing::warn!("flow: cancelling run #{} of {}/{}: {e}", run.number, row.owner, row.name);
630
        }
631
    }
632
}
633
c889911b Andy McCall ↶ 634
/// The event a run's trigger stands for: `push`, `tag:NAME`, `manual`,
635
/// `schedule`, and `rerun:N:EVENT` repeating EVENT.
636
fn event_of<'a>(trigger: &'a str, bookmark: &'a str) -> flow_core::pipeline::Event<'a> {
637
    use flow_core::pipeline::Event;
638
    let t = match trigger.strip_prefix("rerun:") {
639
        Some(rest) => rest.split_once(':').map(|(_, e)| e).unwrap_or("manual"),
640
        None => trigger,
641
    };
642
    if let Some(tag) = t.strip_prefix("tag:") {
643
        Event::Tag(tag)
644
    } else if t == "push" {
645
        Event::Push(bookmark)
646
    } else if t == "schedule" {
647
        Event::Schedule
648
    } else {
649
        Event::Manual
650
    }
1edac4b6 Andy McCall ↶ 651
}
652
c889911b Andy McCall ↶ 653
/// The event to repeat when rerunning `run`.
654
fn original_event(run: &fdb::Run) -> String {
655
    let t = run.trigger.as_str();
656
    match t.strip_prefix("rerun:") {
657
        Some(rest) => rest.split_once(':').map(|(_, e)| e.to_string()).unwrap_or_else(|| "manual".into()),
658
        None => t.to_string(),
659
    }
660
}
661
d7ce41ac Andy McCall ↶ 662
/// The paths the changes a push brought touch: the changes in `heads`'
663
/// state that the bookmark's previous run did not have, and the files their
664
/// edits and tree operations name, as the new state places them. `None`
665
/// (run every job) for the bookmark's first run, or when it cannot be told.
666
async fn touched_since_last_run(app: &Shared, row: &db::repos::RepoRow, bookmark: &str, heads: &[ChangeHash]) -> Option<Vec<String>> {
667
    let last = fdb::latest_on(&app.db, row.id, bookmark).await.ok()??;
668
    let old: Vec<ChangeHash> = last.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
669
    if old.is_empty() {
670
        return None;
671
    }
672
    let repo = RepoName::new(&row.owner, &row.name)?;
673
    let new = heads.to_vec();
674
    app.repos
675
        .read(&repo, move |r, cache| {
676
            let fresh = r.negotiate(&old, &new)?;
677
            let loaded = cache.load(r, &new)?;
678
            let by_node: std::collections::HashMap<oxy_core::ids::NodeId, &String> =
679
                loaded.snapshot.files.iter().map(|(p, f)| (f.node, p)).collect();
680
            let mut paths = std::collections::BTreeSet::new();
681
            for h in fresh {
682
                let (c, _) = r.store().get_change_lazy(&h)?;
683
                let nodes = c.edits.iter().map(|e| e.node()).chain(c.tree_ops.iter().map(|o| o.node()));
684
                for n in nodes {
685
                    if let Some(p) = by_node.get(&n) {
686
                        paths.insert((*p).clone());
687
                    }
688
                }
689
            }
690
            Ok(paths.into_iter().collect::<Vec<String>>())
691
        })
692
        .await
693
        .ok()
694
}
695
696
/// Whether a job runs for a push that touched `touched`: always without a
697
/// scope or without knowing what was touched, else when a path matches.
698
fn in_scope(scope: &[String], touched: Option<&[String]>) -> bool {
699
    let Some(touched) = touched else { return true };
700
    if scope.is_empty() {
701
        return true;
702
    }
703
    let mut b = globset::GlobSetBuilder::new();
704
    for g in scope {
705
        match globset::Glob::new(g) {
706
            Ok(g) => {
707
                b.add(g);
708
            }
709
            Err(_) => return true,
710
        }
711
    }
712
    let Ok(set) = b.build() else { return true };
713
    touched.iter().any(|p| set.is_match(p))
714
}
715
716
/// [`start_run`] for a push: jobs whose `scope` the push did not touch are
717
/// left out of the run, unless a job that runs depends on them.
718
#[allow(clippy::too_many_arguments)]
719
pub async fn start_run_scoped(
720
    app: &Shared,
721
    row: &db::repos::RepoRow,
722
    bookmark: &str,
723
    state: &str,
724
    heads: &[ChangeHash],
725
    actor: &str,
726
    trigger: &str,
727
    touched: Option<&[String]>,
728
) -> Result<Option<i64>, String> {
729
    start_run_with(app, row, bookmark, state, heads, actor, trigger, touched).await
730
}
731
1edac4b6 Andy McCall ↶ 732
/// Start a run of the pipeline in the state `heads` make (whose state
733
/// hash is `state`), recorded on `bookmark`: for a push, "Run pipeline"
734
/// (`trigger` = `manual`) and re-runs (`rerun:N`). `actor` is the account
735
/// whose access the run's subrepo reads are checked against. Returns the
736
/// run's number, or `None` when the state has no pipeline. The caller
737
/// checks that Flow is enabled.
738
pub async fn start_run(
739
    app: &Shared,
740
    row: &db::repos::RepoRow,
741
    bookmark: &str,
742
    state: &str,
743
    heads: &[ChangeHash],
744
    actor: &str,
745
    trigger: &str,
746
) -> Result<Option<i64>, String> {
d7ce41ac Andy McCall ↶ 747
    start_run_with(app, row, bookmark, state, heads, actor, trigger, None).await
748
}
749
750
#[allow(clippy::too_many_arguments)]
751
async fn start_run_with(
752
    app: &Shared,
753
    row: &db::repos::RepoRow,
754
    bookmark: &str,
755
    state: &str,
756
    heads: &[ChangeHash],
757
    actor: &str,
758
    trigger: &str,
759
    touched: Option<&[String]>,
760
) -> Result<Option<i64>, String> {
0650d94e Andy McCall ↶ 761
    start_run_at(app, row, bookmark, state, heads, actor, trigger, touched, None, &[]).await
348f8c4b Andy McCall ↶ 762
}
763
0650d94e Andy McCall ↶ 764
/// [`start_run_with`], for a scheduled run due at `at` on the hub's clock;
765
/// `only`, when not empty, the jobs a manual run starts (oxygenhub#130).
348f8c4b Andy McCall ↶ 766
#[allow(clippy::too_many_arguments)]
767
async fn start_run_at(
768
    app: &Shared,
769
    row: &db::repos::RepoRow,
770
    bookmark: &str,
771
    state: &str,
772
    heads: &[ChangeHash],
773
    actor: &str,
774
    trigger: &str,
775
    touched: Option<&[String]>,
776
    at: Option<flow_core::pipeline::When>,
0650d94e Andy McCall ↶ 777
    only: &[String],
348f8c4b Andy McCall ↶ 778
) -> Result<Option<i64>, String> {
1edac4b6 Andy McCall ↶ 779
    let repo = RepoName::new(&row.owner, &row.name).ok_or("bad repository name")?;
42fa9554 Andy McCall ↶ 780
    let h = heads.to_vec();
781
    let text = app
782
        .repos
783
        .read(&repo, move |r, cache| {
784
            let loaded = cache.load(r, &h)?;
785
            Ok(match loaded.snapshot.files.get(PIPELINE_PATH).map(|f| &f.content) {
786
                Some(oxy_core::state::FileContent::Text { bytes, .. }) => Some(String::from_utf8_lossy(bytes).into_owned()),
787
                _ => None,
788
            })
789
        })
1edac4b6 Andy McCall ↶ 790
        .await
791
        .map_err(|e| format!("reading the pipeline: {e}"))?;
792
    let Some(text) = text else { return Ok(None) };
42fa9554 Andy McCall ↶ 793
    let mut hex: Vec<String> = heads.iter().map(|h| h.to_hex()).collect();
794
    hex.sort();
795
    let heads_s = hex.join("+");
1edac4b6 Andy McCall ↶ 796
    let base = db::flow::NewRun { repo_id: row.id, bookmark, state, heads: &heads_s, pipeline_hash: "", actor, trigger, error: None };
797
    let id = match Pipeline::parse(&text) {
5f3fa151 Andy McCall ↶ 798
        // A scheduled tick cannot tell whether a pipeline it cannot read
799
        // has a schedule, so it starts nothing (#321): the push's run
800
        // already says what is wrong, once rather than every minute.
801
        Err(_) if at.is_some() => return Ok(None),
42fa9554 Andy McCall ↶ 802
        Err(problems) => {
803
            let msg = problems.to_string();
1edac4b6 Andy McCall ↶ 804
            db::flow::create_run(&app.db, db::flow::NewRun { error: Some(&msg), ..base }, &[]).await.map_err(|e| e.to_string())?
42fa9554 Andy McCall ↶ 805
        }
806
        Ok(p) => {
807
            let depths = p.depths();
d7ce41ac Andy McCall ↶ 808
            // Jobs out of the push's scope stay out, unless a kept job
809
            // needs them.
c889911b Andy McCall ↶ 810
            // The jobs this run's event starts (`on`), out of those its
811
            // push touched (`scope`); then what they depend on.
348f8c4b Andy McCall ↶ 812
            let event = match at {
813
                Some(w) => flow_core::pipeline::Event::ScheduleAt(w),
814
                None => event_of(trigger, bookmark),
815
            };
0650d94e Andy McCall ↶ 816
            let starts = |j: &flow_core::Job| p.on_of(j).matches(event) && in_scope(&j.scope, touched);
817
            let mut keep: std::collections::HashSet<String> = if only.is_empty() {
818
                p.order().into_iter().filter(|j| starts(j)).map(|j| j.name.clone()).collect()
819
            } else {
820
                // Named jobs (oxygenhub#130): each one this event starts.
821
                let startable: Vec<&str> = p.order().into_iter().filter(|j| starts(j)).map(|j| j.name.as_str()).collect();
822
                for name in only {
823
                    if !startable.contains(&name.as_str()) {
824
                        let what = if p.jobs.contains_key(name) {
825
                            "is not started by hand (no `on { manual }`)"
826
                        } else {
827
                            "is not in the pipeline"
828
                        };
829
                        return Err(format!("job {name:?} {what}; jobs a manual run can start: {}", startable.join(", ")));
830
                    }
831
                }
832
                only.iter().cloned().collect()
833
            };
d7ce41ac Andy McCall ↶ 834
            loop {
835
                let needed: Vec<String> = p
836
                    .order()
837
                    .into_iter()
838
                    .filter(|j| keep.contains(&j.name))
839
                    .flat_map(|j| j.depends_on.iter().cloned())
840
                    .filter(|d| !keep.contains(d))
841
                    .collect();
842
                if needed.is_empty() {
843
                    break;
844
                }
845
                keep.extend(needed);
846
            }
44a3d2eb Andy McCall ↶ 847
            let mut jobs: Vec<fdb::NewJob> = p
42fa9554 Andy McCall ↶ 848
                .order()
849
                .into_iter()
d7ce41ac Andy McCall ↶ 850
                .filter(|j| keep.contains(&j.name))
42fa9554 Andy McCall ↶ 851
                .map(|j| {
852
                    let sb = &p.sandboxes[&j.sandbox];
853
                    fdb::NewJob {
854
                        name: j.name.clone(),
855
                        depth: depths[j.name.as_str()] as i64,
856
                        depends: j.depends_on.clone(),
857
                        spec: serde_json::to_string(j).unwrap_or_default(),
858
                        sandbox: serde_json::to_string(sb).unwrap_or_default(),
859
                        runtime: sb.runtime.as_str().into(),
44a3d2eb Andy McCall ↶ 860
                        need_disk_mib: None,
5588bb36 Andy McCall ↶ 861
                        reused: None,
42fa9554 Andy McCall ↶ 862
                    }
863
                })
864
                .collect();
44a3d2eb Andy McCall ↶ 865
            // What each job needs, learned from its past runs (oxygenflow#41).
866
            for j in &mut jobs {
867
                j.need_disk_mib = fdb::learned_disk_need(&app.db, row.id, &j.name).await.map_err(|e| e.to_string())?;
868
            }
c889911b Andy McCall ↶ 869
            if jobs.is_empty() {
870
                // Nothing this event starts (or this push touched).
d7ce41ac Andy McCall ↶ 871
                return Ok(None);
5588bb36 Andy McCall ↶ 872
            }
873
            // A job that passed on this very state, with the same spec and
874
            // sandbox, is not run again by a push (#265): main after a
875
            // proposal landed it as tested. Never one that publishes, deploys
876
            // or holds secrets, nor one whose artifacts a job of this run
877
            // takes; and not where the repository turned reuse off.
878
            if trigger == "push" && row.flow_reuse {
879
                let consumed: std::collections::HashSet<&str> = p
880
                    .order()
881
                    .into_iter()
882
                    .filter(|j| keep.contains(&j.name))
883
                    .flat_map(|j| j.inputs.iter().map(|i| i.from.as_str()))
884
                    .collect();
885
                for j in &mut jobs {
886
                    let Some(spec) = p.jobs.get(&j.name) else { continue };
887
                    if !reusable(spec) || consumed.contains(j.name.as_str()) {
888
                        continue;
889
                    }
890
                    j.reused =
891
                        fdb::passed_on_state(&app.db, row.id, state, &j.name, &j.spec, &j.sandbox).await.map_err(|e| e.to_string())?;
892
                }
d7ce41ac Andy McCall ↶ 893
            }
42fa9554 Andy McCall ↶ 894
            let hash = hex::encode(p.hash());
1edac4b6 Andy McCall ↶ 895
            let id =
896
                db::flow::create_run(&app.db, db::flow::NewRun { pipeline_hash: &hash, ..base }, &jobs).await.map_err(|e| e.to_string())?;
897
            if let Ok(Some(run)) = fdb::run_by_id(&app.db, id).await {
5588bb36 Andy McCall ↶ 898
                for j in jobs.iter().filter(|j| j.reused.is_none()) {
a0d4bbfb Andy McCall ↶ 899
                    report_check(app, row, state, run.number, &j.name, "queued", "waiting for a runner").await;
42fa9554 Andy McCall ↶ 900
                }
5588bb36 Andy McCall ↶ 901
                // Reused passes (#265) report as any pass does: their checks,
902
                // and a run that passed with them (Diffusion, landing a bump).
903
                if jobs.iter().any(|j| j.reused.is_some()) {
904
                    let reused: Vec<fdb::Job> =
905
                        fdb::jobs(&app.db, run.id).await.unwrap_or_default().into_iter().filter(|j| j.reused_from().is_some()).collect();
906
                    if let Err(e) = report_changed(app, run.id, reused).await {
907
                        tracing::warn!("flow: reporting reused passes of run #{}: {e}", run.number);
908
                    }
909
                }
1c8276b9 Andy McCall ↶ 910
                images_check(app, row, state, run.number, &jobs).await;
42fa9554 Andy McCall ↶ 911
            }
912
            id
913
        }
914
    };
1edac4b6 Andy McCall ↶ 915
    let run = fdb::run_by_id(&app.db, id).await.map_err(|e| e.to_string())?.ok_or("the run vanished")?;
a9f1c0bf Andy McCall ↶ 916
    if supersedes(trigger) {
917
        supersede(app, row, bookmark, trigger, run.number).await;
918
    }
1edac4b6 Andy McCall ↶ 919
    Ok(Some(run.number))
42fa9554 Andy McCall ↶ 920
}
921
1c8276b9 Andy McCall ↶ 922
/// The `pipeline/images` check (#137): set failing when an image the run's
923
/// jobs pin is held by neither the hub nor a runner, so a proposal pinning
924
/// one says so before it lands rather than its runs queueing for good;
925
/// passed again by a later run of the state once every image is held.
926
async fn images_check(app: &Shared, row: &db::repos::RepoRow, state: &str, run_number: i64, jobs: &[fdb::NewJob]) {
927
    let mut pinned: Vec<String> = jobs
928
        .iter()
929
        .filter_map(|j| serde_json::from_str::<serde_json::Value>(&j.sandbox).ok())
930
        .filter_map(|v| v["rootfs"].as_str().map(String::from))
931
        .filter(|r| !r.is_empty())
932
        .collect();
933
    pinned.sort();
934
    pinned.dedup();
935
    if pinned.is_empty() {
936
        return;
937
    }
938
    let mut held = crate::images::held(&app.db).await.unwrap_or_default();
939
    // Nobody can be said to lack an image unless some runner is known and
940
    // every one reports what it holds.
941
    let runners: Vec<db::runners::Runner> =
942
        db::runners::list(&app.db).await.unwrap_or_default().into_iter().filter(|r| r.state != "disabled").collect();
943
    if runners.is_empty() || runners.iter().any(|r| r.image_list().is_none()) {
944
        return;
945
    }
946
    for r in &runners {
947
        held.extend(r.image_list().unwrap_or_default());
948
    }
949
    let missing: Vec<&String> = pinned.iter().filter(|h| !held.contains(*h)).collect();
950
    // Only a missing image makes the check; one that was failing on this
951
    // state turns to passed once its images are held.
952
    let failing_before = db::hooks::checks_for_state(&app.db, row.id, state)
953
        .await
954
        .unwrap_or_default()
955
        .iter()
956
        .any(|c| c.name == "pipeline/images" && c.status != "passed");
957
    if missing.is_empty() && !failing_before {
958
        return;
959
    }
960
    let (status, summary) = if missing.is_empty() {
961
        (
962
            "passed",
963
            format!("{} now held", if pinned.len() == 1 { "its image is".to_string() } else { format!("all {} images are", pinned.len()) }),
964
        )
965
    } else {
966
        let names: Vec<String> = missing.iter().map(|h| h[..12.min(h.len())].to_string()).collect();
967
        ("failed", format!("neither the hub nor a runner holds image {}: send it with flow rootfs push HASH", names.join(", ")))
968
    };
969
    let url = format!("{}/{}/{}/flow/{run_number}", app.config.base_url(), row.owner, row.name);
970
    if let Ok(c) = db::hooks::upsert_check(
971
        &app.db,
972
        row.id,
973
        db::hooks::CheckReport { state, name: "pipeline/images", status, summary: &summary, url: &url, reporter: None, seal: "" },
974
    )
975
    .await
976
    {
977
        let api = crate::api::check_of(&c);
33d98147 Andy McCall 978
        app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
1c8276b9 Andy McCall ↶ 979
        crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
980
    }
981
}
982
a0d4bbfb Andy McCall ↶ 983
/// Record a job's check; it links to the run's page by the run's number.
984
async fn report_check(app: &Shared, row: &db::repos::RepoRow, state: &str, run_number: i64, job: &str, status: &str, summary: &str) {
985
    let url = format!("{}/{}/{}/flow/{run_number}", app.config.base_url(), row.owner, row.name);
42fa9554 Andy McCall ↶ 986
    let name = format!("flow/{job}");
987
    let c = db::hooks::upsert_check(
988
        &app.db,
989
        row.id,
990
        db::hooks::CheckReport { state, name: &name, status, summary, url: &url, reporter: None, seal: "" },
991
    )
992
    .await;
993
    if let Ok(c) = c {
994
        let api = crate::api::check_of(&c);
33d98147 Andy McCall 995
        app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
42fa9554 Andy McCall ↶ 996
        crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
997
    }
998
}
999
1000
/// The check status a job's status shows as.
1001
fn check_status(job_status: &str) -> &'static str {
1002
    match job_status {
1003
        "queued" => "queued",
1004
        "running" => "running",
1005
        "passed" => "passed",
1006
        "skipped" => "skipped",
745d225d Andy McCall ↶ 1007
        "cancelled" => "cancelled",
42fa9554 Andy McCall ↶ 1008
        _ => "failed",
1009
    }
1010
}
1011
b6b7e4cf Andy McCall ↶ 1012
/// The runner a bearer token belongs to: a registered runner, or one
1013
/// configured with a hub.toml token (tracked from its first request). A
1014
/// disabled runner is refused.
92a797b2 Andy McCall ↶ 1015
pub(crate) async fn runner_auth(app: &Shared, headers: &HeaderMap) -> Result<db::runners::Runner, ApiError> {
42fa9554 Andy McCall ↶ 1016
    let Some(t) = oxy_server::bearer_token(headers) else {
1017
        return Err(ApiError(StatusCode::UNAUTHORIZED, "a runner token is required".into()));
b6b7e4cf Andy McCall ↶ 1018
    };
1019
    let hash = blake3::hash(t.as_bytes()).to_hex().to_string();
1020
    let runner = match db::runners::by_token(&app.db, &hash).await? {
1021
        Some(r) => r,
1022
        None if app.config.flow.runner_tokens.iter().any(|x| crate::auth::mac_equal(x, t)) => {
1023
            db::runners::configured(&app.db, &hash, "runner").await?
1024
        }
1025
        None => return Err(ApiError(StatusCode::UNAUTHORIZED, "not a runner token".into())),
42fa9554 Andy McCall ↶ 1026
    };
b6b7e4cf Andy McCall ↶ 1027
    if runner.state == "disabled" {
1028
        return Err(ApiError(StatusCode::FORBIDDEN, format!("runner {} is disabled on this hub", runner.name)));
42fa9554 Andy McCall ↶ 1029
    }
b6b7e4cf Andy McCall ↶ 1030
    Ok(runner)
42fa9554 Andy McCall ↶ 1031
}
1032
b6b7e4cf Andy McCall ↶ 1033
/// `POST /api/v1/flow/runners/register`: a one-time registration token
1034
/// from Admin → Runners buys a runner credential, binding the runner's
1035
/// signing identity (hub spec §13.2).
1036
pub async fn register(
1037
    State(app): State<Shared>,
1038
    Json(req): Json<flow_core::api::Register>,
1039
) -> Result<Json<flow_core::api::Registered>, ApiError> {
1040
    let bytes = hex::decode(req.identity.trim()).map_err(|_| ApiError(StatusCode::BAD_REQUEST, "identity: not hex".into()))?;
1041
    let identity = oxy_core::identity::Identity::decode(&bytes).map_err(|e| ApiError(StatusCode::BAD_REQUEST, format!("identity: {e}")))?;
1042
    let name: String = req.name.chars().filter(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')).take(64).collect();
1043
    if name.is_empty() {
1044
        return Err(ApiError(StatusCode::BAD_REQUEST, "give the runner a name of letters, digits, - _ or .".into()));
1045
    }
1046
    let credential = format!("flowrunner_{}", crate::auth::random_hex(32));
1047
    let hash = blake3::hash(credential.as_bytes()).to_hex().to_string();
1048
    let reg = blake3::hash(req.token.trim().as_bytes()).to_hex().to_string();
1049
    let runner =
1050
        db::runners::register(&app.db, &reg, &name, &hash, &identity.hash().to_hex(), &identity.name, "").await?.ok_or_else(|| {
1051
            ApiError(StatusCode::FORBIDDEN, "that registration token is unknown, used or expired; create one on Admin → Runners".into())
1052
        })?;
1053
    db::runners::seen(&app.db, runner.id, None, Some(&req.info)).await?;
1054
    tracing::info!("flow: runner {} registered (key {})", runner.name, &runner.key[..12]);
1055
    Ok(Json(flow_core::api::Registered { id: runner.id, name: runner.name, credential }))
1056
}
1057
42fa9554 Andy McCall ↶ 1058
/// `POST /api/v1/flow/claim`.
1059
pub async fn claim(State(app): State<Shared>, headers: HeaderMap, Json(req): Json<ClaimRequest>) -> Result<Response, ApiError> {
b6b7e4cf Andy McCall ↶ 1060
    let me = runner_auth(&app, &headers).await?;
1061
    let claimed: String = req.runner.chars().filter(|c| !c.is_control()).take(64).collect();
1062
    db::runners::seen(&app.db, me.id, Some(&claimed), req.info.as_ref()).await?;
eef677c4 Andy McCall ↶ 1063
    if let Some(holding) = &req.holding {
1064
        end_jobs_not_held(&app, &me, holding).await?;
1065
    }
b6b7e4cf Andy McCall ↶ 1066
    // A draining runner finishes what it has and takes nothing new.
1067
    if me.state == "draining" {
1068
        return Ok(StatusCode::NO_CONTENT.into_response());
1069
    }
1070
    let runner = if me.source == "registered" { me.name.clone() } else { claimed };
42fa9554 Andy McCall ↶ 1071
    let secret = format!("{JOB_TOKEN_PREFIX}{}", crate::auth::random_hex(32));
efd29a00 Andy McCall ↶ 1072
    // What it holds and what it is (OxygenFlow spec §11): the images'
1073
    // architectures it reports are remembered for every runner's claims.
1074
    if let Some(archs) = &req.image_archs {
1075
        fdb::record_image_archs(&app.db, archs).await?;
1076
    }
1077
    let arch = req.info.as_ref().map(|i| i.arch.clone()).filter(|a| !a.is_empty()).unwrap_or_else(|| me.arch.clone());
4d2e44d7 Andy McCall ↶ 1078
    // What it offers, kept for the placement pass; a job it declined is
1079
    // not offered to it again while this stays the same (spec §11.5).
1080
    let profile = profile_of(&req, &arch);
92a797b2 Andy McCall ↶ 1081
    db::runners::set_offer(&app.db, me.id, &req.runtimes, req.images.as_deref(), req.fetches_images, &profile).await?;
2fb70d01 Andy McCall ↶ 1082
    if let Some(f) = &req.facts {
1083
        db::runners::set_facts(&app.db, me.id, f).await?;
1084
    }
a46d15e7 Andy McCall ↶ 1085
    app.swarm.claimed(me.id, req.swarm.as_ref());
c2be148c Andy McCall ↶ 1086
    // The build caches it holds (oxygenflow#51), and when each last kept a
1087
    // disk (oxygenflow#54; 0 from an older runner), for placing jobs by.
4fa0da12 Andy McCall ↶ 1088
    if let Some(c) = &req.caches {
c2be148c Andy McCall ↶ 1089
        let kept = |slot: &str| req.cache_times.as_ref().and_then(|t| t.get(slot)).map_or(0, |ms| *ms as i64);
4fa0da12 Andy McCall ↶ 1090
        CACHES
1091
            .lock()
1092
            .unwrap_or_else(|p| p.into_inner())
1093
            .get_or_insert_with(Default::default)
c2be148c Andy McCall ↶ 1094
            .insert((app.repos.root().display().to_string(), me.id), c.iter().map(|s| (s.clone(), kept(s))).collect());
4fa0da12 Andy McCall ↶ 1095
    }
b0612e7d Andy McCall ↶ 1096
    let room = fdb::Room {
4d2e44d7 Andy McCall ↶ 1097
        declined: fdb::declined_by(&app.db, me.id, &profile).await?,
b0612e7d Andy McCall ↶ 1098
        memory_mib: req.free_memory_mib,
1099
        cpus: req.free_cpus,
1100
        images: req.images.as_ref().map(|i| i.iter().map(|h| h.to_ascii_lowercase()).collect()),
efd29a00 Andy McCall ↶ 1101
        arch,
1102
        image_archs: fdb::image_archs(&app.db).await?,
92a797b2 Andy McCall ↶ 1103
        fetchable: if req.fetches_images { crate::images::held(&app.db).await? } else { Default::default() },
44a3d2eb Andy McCall ↶ 1104
        free_disk_mib: req.facts.as_ref().and_then(|f| f.free_disk_mib),
b0612e7d Andy McCall ↶ 1105
    };
7f5f6c05 Andy McCall ↶ 1106
    // The labels it reports now, or those it registered with, and those
1107
    // an administrator gave it (#98).
1108
    let mut labels: Vec<String> = match &req.info {
c4c87f48 Andy McCall ↶ 1109
        Some(i) => i.labels.clone(),
7f5f6c05 Andy McCall ↶ 1110
        None => me.reported_label_list().into_iter().map(String::from).collect(),
c4c87f48 Andy McCall ↶ 1111
    };
7f5f6c05 Andy McCall ↶ 1112
    for l in me.admin_label_list() {
1113
        if !labels.iter().any(|x| x == l) {
1114
            labels.push(l.to_string());
1115
        }
1116
    }
501d8b26 Andy McCall ↶ 1117
    // Ranking (oxygenflow#42): a job another free runner would do better
1118
    // (it holds the image, or is faster) is held for it briefly.
1119
    let runners = db::runners::list(&app.db).await?;
1120
    let me_now = runners.iter().find(|r| r.id == me.id).cloned().unwrap_or_else(|| me.clone());
1121
    let running: std::collections::HashMap<i64, i64> = db::runners::running(&app.db).await?.into_iter().collect();
4fa0da12 Andy McCall ↶ 1122
    let queue = fdb::queue(&app.db).await?;
1123
    let owners: std::collections::HashMap<i64, (String, i64)> = queue.iter().map(|q| (q.job_id, (q.owner.clone(), q.repo_id))).collect();
1124
    // Each job's build cache slot (oxygenflow#51), as runners report theirs.
1125
    let slots: std::collections::HashMap<i64, String> =
1126
        queue.iter().map(|q| (q.job_id, flow_core::api::cache_slot(&format!("{}/{}", q.owner, q.name), &q.job))).collect();
501d8b26 Andy McCall ↶ 1127
    let (archs, held) = (fdb::image_archs(&app.db).await?, crate::images::held(&app.db).await?);
1128
    let now = db::now_ms();
1129
    let fleet = Fleet { image_archs: &archs, hub_images: &held, now };
c95446a1 Andy McCall ↶ 1130
    let hub_key = app.repos.root().display().to_string();
501d8b26 Andy McCall ↶ 1131
    let better = |j: &fdb::Job| -> bool {
1132
        let Some((owner, repo_id)) = owners.get(&j.id) else { return false };
1133
        let rootfs = rootfs_of(j);
1134
        let mut holds = HELD.lock().unwrap_or_else(|p| p.into_inner());
1135
        let holds = holds.get_or_insert_with(Default::default);
1136
        holds.retain(|_, t| now - *t < 600_000);
c95446a1 Andy McCall ↶ 1137
        if holds.get(&(hub_key.clone(), j.id)).is_some_and(|t| now - *t >= BETTER_HOLD_MS) {
501d8b26 Andy McCall ↶ 1138
            return false;
1139
        }
4fa0da12 Andy McCall ↶ 1140
        let slot = slots.get(&j.id).map(String::as_str).unwrap_or("");
c2be148c Andy McCall ↶ 1141
        let mine = fit(&hub_key, &me_now, &rootfs, slot);
501d8b26 Andy McCall ↶ 1142
        let other = runners.iter().any(|r| {
1143
            r.id != me.id
1144
                && r.state == "active"
1145
                && r.last_seen_ms.is_some_and(|t| now - t < POLLING_MS)
1146
                && running.get(&r.id).copied().unwrap_or(0) < r.max_jobs.max(1)
c2be148c Andy McCall ↶ 1147
                && fit(&hub_key, r, &rootfs, slot).beats(&mine)
501d8b26 Andy McCall ↶ 1148
                && runner_lacks(j, owner, *repo_id, r, &fleet, &[]).is_none()
1149
        });
1150
        if other {
c95446a1 Andy McCall ↶ 1151
            holds.entry((hub_key.clone(), j.id)).or_insert(now);
501d8b26 Andy McCall ↶ 1152
        }
1153
        other
1154
    };
c4c87f48 Andy McCall ↶ 1155
    let Some(job) =
501d8b26 Andy McCall ↶ 1156
        fdb::claim_ranked(&app.db, &req.runtimes, &runner, &crate::auth::token_hash(&secret), room, &me.scope(), &labels, &better).await?
c4c87f48 Andy McCall ↶ 1157
    else {
42fa9554 Andy McCall ↶ 1158
        return Ok(StatusCode::NO_CONTENT.into_response());
1159
    };
501d8b26 Andy McCall ↶ 1160
    // Why here (oxygenflow#42).
c95446a1 Andy McCall ↶ 1161
    let waited =
1162
        HELD.lock().unwrap_or_else(|p| p.into_inner()).as_mut().and_then(|h| h.remove(&(hub_key.clone(), job.id))).map(|t| now - t);
501d8b26 Andy McCall ↶ 1163
    let rootfs = rootfs_of(&job);
d7050703 Andy McCall ↶ 1164
    // A WASM job has no image (#323), so nothing to hold or fetch.
1165
    let mut why = Vec::new();
1166
    if !rootfs.is_empty() {
1167
        why.push(if me_now.image_list().is_some_and(|have| have.contains(&rootfs)) {
1168
            "holds the image".to_string()
1169
        } else {
1170
            "fetches the image from the hub".to_string()
1171
        });
1172
    }
c2be148c Andy McCall ↶ 1173
    if let Some(kept) = slots.get(&job.id).and_then(|slot| cache_kept(&hub_key, me.id, slot)) {
1174
        why.insert(
1175
            0,
1176
            if kept > 0 { format!("holds its build cache (kept {} ago)", ago(now - kept)) } else { "holds its build cache".into() },
1177
        );
4fa0da12 Andy McCall ↶ 1178
    }
501d8b26 Andy McCall ↶ 1179
    match running.get(&me.id).copied().unwrap_or(0) {
1180
        0 => why.push("idle".into()),
1181
        n => why.push(format!("running {n} other job{}", if n == 1 { "" } else { "s" })),
1182
    }
1183
    if let Some(sp) = me_now.speed {
1184
        why.push(format!("speed {sp} (class {})", me_now.speed_class.unwrap_or(0)));
1185
    }
1186
    if let Some(w) = waited {
1187
        why.push(format!("after {} s held for a better runner", w / 1000));
1188
    }
1189
    fdb::set_placed(&app.db, job.id, &why.join(", ")).await?;
b6b7e4cf Andy McCall ↶ 1190
    db::runners::set_job_runner(&app.db, job.id, me.id).await?;
42fa9554 Andy McCall ↶ 1191
    let run = fdb::run_by_id(&app.db, job.run_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1192
    let row =
1193
        db::repos::get_by_id(&app.db, run.repo_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such repository".into()))?;
a0d4bbfb Andy McCall ↶ 1194
    report_check(&app, &row, &run.state, run.number, &job.name, "running", &format!("running on {runner}")).await;
42fa9554 Andy McCall ↶ 1195
    let bad = |e: serde_json::Error| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("stored job: {e}"));
5dead1f4 Andy McCall ↶ 1196
    // The job's limit: its own timeout, else its sandbox's, else the site
1197
    // default, never past the site maximum; recorded for the reaper.
1198
    let limits = limits(&app).await;
1199
    let spec: flow_core::pipeline::Job = serde_json::from_str(&job.spec).map_err(bad)?;
1200
    let sandbox: flow_core::pipeline::Sandbox = serde_json::from_str(&job.sandbox).map_err(bad)?;
7f5f6c05 Andy McCall ↶ 1201
    let mut timeout_s = spec.timeout_s.or(sandbox.timeout_s).unwrap_or(limits.default_s).min(limits.max_s).max(60);
1202
    // ...and never past the runner's own limit, when it has one (#98).
1203
    if let Some(m) = me.timeout_minutes.filter(|m| *m > 0) {
1204
        timeout_s = timeout_s.min(m as u64 * 60).max(60);
1205
    }
5dead1f4 Andy McCall ↶ 1206
    fdb::set_job_timeout(&app.db, job.id, timeout_s).await?;
42fa9554 Andy McCall ↶ 1207
    let claim = Claim {
1208
        job_id: job.id,
1209
        run_id: run.id,
1210
        repo: format!("{}/{}", row.owner, row.name),
1211
        clone_url: format!("{}/{}/{}", app.config.base_url(), row.owner, row.name),
1212
        token: secret,
1213
        heads: run.head_list().into_iter().map(String::from).collect(),
1214
        pipeline_hash: run.pipeline_hash.clone(),
5dead1f4 Andy McCall ↶ 1215
        job: spec,
1216
        sandbox,
1217
        timeout_s,
fd3db644 Andy McCall ↶ 1218
        subrepos: vec![],
9a065bc0 Andy McCall ↶ 1219
        state: run.state.clone(),
1220
        bookmark: run.bookmark.clone(),
1221
        run_number: run.number,
2a83f530 Andy McCall ↶ 1222
        // The site's, the owner's and the repository's variables (#102).
1223
        env: crate::variables::env_for_repo(&app.db, &row).await?,
4ac01a73 Andy McCall ↶ 1224
        secrets: vec![],
cd437c4f Andy McCall ↶ 1225
        inputs: vec![],
3b650652 Andy McCall ↶ 1226
        // For a runner that must leave: finish it, or hand it back
1227
        // (oxygenflow#76).
1228
        expected_ms: fdb::expected_ms(&app.db, row.id, &job.name).await?.map(|ms| ms as u64),
e4203e14 Andy McCall ↶ 1229
        // What an attempt handed back saved, to resume from (oxygenflow#77).
1230
        checkpoint: if job.handbacks > 0 { fdb::checkpoint(&app.db, job.id).await?.map(|a| a.blob) } else { None },
42fa9554 Andy McCall ↶ 1231
    };
fd3db644 Andy McCall ↶ 1232
    let mut claim = claim;
4ac01a73 Andy McCall ↶ 1233
    let (inputs, ids, mut left_out) = subrepo_inputs(&app, &row, &run).await;
1234
    // The secrets the job declares, as files (#107); one not set is said
1235
    // at the top of the log and left out, so the job fails on the file.
1236
    let names: Vec<String> = claim.job.secrets.iter().map(|s| s.name.clone()).collect();
1237
    let found = crate::secrets::for_job(&app, &row, &names).await?;
d1727c57 Andy McCall ↶ 1238
    // The identities it asks for (#103): a token each, as a file.
b644e175 Andy McCall ↶ 1239
    // An environment goes in its tokens only once the job was approved
1240
    // (oxygenflow#59): the approval is the environment's protection.
1241
    let environment = claim.job.environment.clone().filter(|_| job.approval == "approved");
1242
    if let (Some(e), None, false) = (&claim.job.environment, &environment, claim.job.identities.is_empty()) {
1243
        left_out.push(format!(
1244
            "environment {e}: not in the job's identity tokens, because the job was not approved (give it an approval block)"
1245
        ));
1246
    }
d1727c57 Andy McCall ↶ 1247
    if !claim.job.identities.is_empty() {
1248
        let issuer = app.oidc().await.map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("oidc: {e}")))?;
1249
        for i in &claim.job.identities {
1250
            let token = issuer.mint(&crate::oidc::JobClaims {
1251
                issuer: app.config.base_url(),
1252
                audience: &i.audience,
1253
                owner: &row.owner,
1254
                name: &row.name,
1255
                visibility: &row.visibility,
1256
                bookmark: &run.bookmark,
1257
                run_number: run.number,
1258
                job: &job.name,
1259
                state: &run.state,
1260
                runner: &runner,
1261
                actor: &run.actor,
b644e175 Andy McCall ↶ 1262
                environment: environment.as_deref(),
47e37402 Andy McCall ↶ 1263
                approved_by: (job.approval == "approved").then_some(job.approved_by.as_str()),
1264
                approval: (!job.approval_seal.is_empty()).then_some(job.approval_seal.as_str()),
d1727c57 Andy McCall ↶ 1265
                now_ms: db::now_ms(),
1266
                ttl_s: timeout_s,
1267
            });
1268
            claim.secrets.push(flow_core::api::SecretInput {
1269
                name: format!("identity:{}", i.audience),
1270
                path: i.mount_path.clone(),
1271
                value: token,
1272
            });
1273
        }
1274
    }
4ac01a73 Andy McCall ↶ 1275
    for s in &claim.job.secrets {
1276
        match found.iter().find(|(n, _)| *n == s.name) {
1277
            Some((name, value)) => {
1278
                claim.secrets.push(flow_core::api::SecretInput { name: name.clone(), path: s.mount_path.clone(), value: value.clone() })
1279
            }
1280
            None => left_out.push(format!(
1281
                "secret {:?} is not set for this repository, its owner or the site; {} will be missing",
1282
                s.name, s.mount_path
1283
            )),
1284
        }
1285
    }
fd3db644 Andy McCall ↶ 1286
    if !ids.is_empty() {
1287
        fdb::set_also_read(&app.db, job.id, &ids).await?;
1288
    }
afd0be38 Andy McCall ↶ 1289
    // Say at the top of the job's log what it will not have (oxygenhub#56),
1290
    // rather than let it fail later on missing files.
1291
    if !left_out.is_empty() {
1292
        let records: Vec<flow_core::api::Record> =
1293
            left_out.into_iter().map(|text| flow_core::api::Record { t: 0, stream: "flow".into(), text }).collect();
1294
        fdb::append_log(&app.db, job.id, &records, MAX_RECORDS as i64).await?;
1295
    }
fd3db644 Andy McCall ↶ 1296
    claim.subrepos = inputs;
cd437c4f Andy McCall ↶ 1297
    // Artifacts of jobs it depends on (oxygenflow#58), with the blob each
1298
    // producer's receipt names; the runner checks what it fetches against it.
1299
    match artifact_inputs(&app, &job, &claim.job).await {
1300
        Ok(found) => claim.inputs = found,
1301
        Err(why) => {
1302
            let error = format!("inputs: {why}");
1303
            fdb::finish(&app.db, job.id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
1304
                .await?;
1305
            return Err(ApiError(StatusCode::CONFLICT, error));
1306
        }
1307
    }
42fa9554 Andy McCall ↶ 1308
    Ok(Json(claim).into_response())
cd437c4f Andy McCall ↶ 1309
}
1310
1311
/// The artifacts a job takes (oxygenflow#58), each from a job of the same
1312
/// run that passed with a receipt; a passing job's receipt names exactly the
1313
/// artifacts it uploaded (checked at finish), so their blobs are attested.
1314
async fn artifact_inputs(app: &Shared, job: &fdb::Job, spec: &flow_core::Job) -> Result<Vec<flow_core::api::ArtifactInput>, String> {
1315
    if spec.inputs.is_empty() {
1316
        return Ok(vec![]);
1317
    }
1318
    let jobs = fdb::jobs(&app.db, job.run_id).await.map_err(|e| e.to_string())?;
1319
    let mut out = Vec::new();
1320
    for i in &spec.inputs {
1321
        let Some(producer) = jobs.iter().find(|j| j.name == i.from) else {
1322
            return Err(format!("{:?} is not a job of this run", i.from));
1323
        };
1324
        if producer.status != "passed" || producer.receipt_hash.is_empty() {
1325
            return Err(format!("{} has not passed with a receipt, so {} cannot be taken from it", i.from, i.artifact));
1326
        }
1327
        let artifacts = fdb::artifacts(&app.db, producer.id).await.map_err(|e| e.to_string())?;
1328
        let Some(a) = artifacts.iter().find(|a| a.name == i.artifact) else {
1329
            return Err(format!("{} kept no artifact {}", i.from, i.artifact));
1330
        };
1331
        out.push(flow_core::api::ArtifactInput {
1332
            artifact: i.artifact.clone(),
1333
            from: i.from.clone(),
1334
            path: i.path.clone(),
1335
            blob: a.blob.clone(),
1336
        });
1337
    }
1338
    Ok(out)
1339
}
1340
1341
/// `GET /api/v1/flow/jobs/{id}/inputs/{index}`: the bytes of input `index`
1342
/// of a running job (oxygenflow#58), for the runner holding it.
1343
pub async fn input(State(app): State<Shared>, headers: HeaderMap, Path((id, index)): Path<(i64, usize)>) -> Result<Response, ApiError> {
1344
    let runner = runner_auth(&app, &headers).await?;
1345
    let job = running_job(&app, id).await?;
1346
    // A registered runner reads only the inputs of a job it holds (a
1347
    // configured token's runner names itself when it claims).
1348
    if runner.source == "registered" && job.runner != runner.name {
1349
        return Err(ApiError(StatusCode::FORBIDDEN, "this job is held by another runner".into()));
1350
    }
1351
    let spec: flow_core::Job =
1352
        serde_json::from_str(&job.spec).map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("stored job: {e}")))?;
1353
    let found = artifact_inputs(&app, &job, &spec).await.map_err(|why| ApiError(StatusCode::CONFLICT, why))?;
1354
    let Some(i) = found.get(index) else {
1355
        return Err(ApiError(StatusCode::NOT_FOUND, format!("job {} has no input {index}", job.name)));
1356
    };
1357
    let run = fdb::run_by_id(&app.db, job.run_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1358
    let row =
1359
        db::repos::get_by_id(&app.db, run.repo_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such repository".into()))?;
1360
    let repo = RepoName::new(&row.owner, &row.name).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "bad repository name".into()))?;
1361
    let blob = oxy_core::hash::ObjectRef::from_hex(&i.blob)
1362
        .ok_or_else(|| ApiError(StatusCode::INTERNAL_SERVER_ERROR, "a kept artifact has a bad blob".into()))?;
1363
    let bytes = app
1364
        .repos
1365
        .read(&repo, move |r, _| Ok(r.read_blob(&blob)?))
1366
        .await
1367
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("read the artifact: {e}")))?;
1368
    Ok(([(axum::http::header::CONTENT_TYPE, "application/octet-stream")], bytes).into_response())
fd3db644 Andy McCall ↶ 1369
}
1370
4d2e44d7 Andy McCall ↶ 1371
/// BLAKE3 over what a claiming runner offers: tiers, images, architecture,
1372
/// labels and capacity, each list sorted.
1373
fn profile_of(req: &ClaimRequest, arch: &str) -> String {
1374
    let sorted = |v: &[String]| {
1375
        let mut v = v.to_vec();
1376
        v.sort();
1377
        v
1378
    };
1379
    let info = req.info.as_ref();
1380
    let v = serde_json::json!({
1381
        "arch": arch,
1382
        "tiers": sorted(&req.runtimes),
1383
        "images": req.images.as_deref().map(sorted),
1384
        "labels": info.map(|i| sorted(&i.labels)),
1385
        "memory_mib": info.and_then(|i| i.memory_mib),
1386
        "cpus": info.and_then(|i| i.cpus),
1387
    });
1388
    blake3::hash(v.to_string().as_bytes()).to_hex().to_string()
1389
}
1390
1391
/// A job handed back by this many different runners is unplaceable.
1392
pub const UNPLACEABLE_AFTER: usize = 3;
1393
ab4df6aa Andy McCall ↶ 1394
/// How long a runner holds a job without the hub hearing from it (claims,
1395
/// heartbeats every 30 s, logs) before the job is handed back
1396
/// (oxygenflow#76).
1397
pub const LEASE_MS: i64 = 3 * 60_000;
1398
1399
/// A job handed back more times than this ends as an error rather than
1400
/// bounce from runner to runner.
1401
pub const MAX_HANDBACKS: i64 = 5;
1402
1403
/// Hand job `id` back to the queue, ahead of new work (oxygenflow#76): its
1404
/// runner drained before leaving (`runner` is it), or its lease lapsed
1405
/// (`None`). The log says why, and the next attempt's follows on. False
1406
/// when the job was not running there.
1407
pub async fn hand_back_job(app: &Shared, id: i64, runner: Option<i64>, why: &str) -> sqlx::Result<bool> {
1408
    let Some(before) = fdb::job(&app.db, id).await? else { return Ok(false) };
1409
    let Some(n) = fdb::hand_back(&app.db, id, runner).await? else { return Ok(false) };
1410
    let t = before.started_ms.map(|s| (db::now_ms() - s).max(0) as u64).unwrap_or(0);
1411
    let record = flow_core::api::Record { t, stream: "flow".into(), text: format!("── {why}; queued again ahead of new work") };
1412
    fdb::append_log(&app.db, id, &[record], MAX_RECORDS as i64).await.ok();
1413
    tracing::info!("flow: job {id} handed back ({n}): {why}");
1414
    if n > MAX_HANDBACKS {
1415
        let error = format!("handed back {n} times; the last: {why}");
1416
        let changed =
1417
            fdb::finish(&app.db, id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
1418
                .await?;
1419
        report_changed(app, before.run_id, changed).await?;
1420
    } else if let Some(run) = fdb::run_by_id(&app.db, before.run_id).await? {
1421
        if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
1422
            let summary = format!("{why}; queued again ahead of new work");
1423
            report_check(app, &row, &run.state, run.number, &before.name, "queued", &summary).await;
1424
        }
1425
    }
1426
    Ok(true)
1427
}
1428
1429
/// Hand back the jobs of runners not heard from for [`LEASE_MS`]: a phone
1430
/// that lost every network, a host that died (oxygenflow#76).
1431
pub async fn requeue_lapsed(app: &Shared) -> sqlx::Result<usize> {
1432
    let lapsed = fdb::running_on_silent_runners(&app.db, db::now_ms() - LEASE_MS).await?;
1433
    let mut n = 0;
1434
    for (job, runner) in lapsed {
1435
        let why = format!("the runner {runner} has not been heard from for {} minutes", LEASE_MS / 60_000);
1436
        if hand_back_job(app, job.id, None, &why).await? {
1437
            n += 1;
1438
        }
1439
    }
1440
    Ok(n)
1441
}
1442
e4203e14 Andy McCall ↶ 1443
/// `POST /api/v1/flow/jobs/{id}/checkpoint` (oxygenflow#77): a runner
1444
/// handing a job back keeps its checkpoint directories, packed; kept as a
1445
/// blob of the job's repository, for the next attempt's claim to name.
1446
pub async fn save_checkpoint(
1447
    State(app): State<Shared>,
1448
    headers: HeaderMap,
1449
    Path(id): Path<i64>,
1450
    body: axum::body::Bytes,
1451
) -> Result<Response, ApiError> {
1452
    let runner = runner_auth(&app, &headers).await?;
1453
    let job = running_job(&app, id).await?;
1454
    if runner.source == "registered" && job.runner != runner.name {
1455
        return Err(ApiError(StatusCode::FORBIDDEN, "this job is held by another runner".into()));
1456
    }
1457
    let spec: flow_core::Job =
1458
        serde_json::from_str(&job.spec).map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("stored job: {e}")))?;
1459
    if spec.checkpoints.is_empty() {
1460
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("job {} declares no checkpoint", job.name)));
1461
    }
1462
    let repo = job_repo(&app, &job).await?;
1463
    let content = blake3::hash(&body).to_hex().to_string();
1464
    let size = body.len() as i64;
1465
    let blob = app
1466
        .repos
1467
        .write(&repo, move |r, _| Ok(r.store_blob(&body)?))
1468
        .await
1469
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("keep the checkpoint: {e}")))?;
1470
    let a = fdb::Artifact {
1471
        job_id: job.id,
1472
        name: fdb::CHECKPOINT.into(),
1473
        path: spec.checkpoints.join(" "),
1474
        blob: blob.to_hex(),
1475
        size,
1476
        content,
1477
        created_ms: db::now_ms(),
1478
    };
1479
    fdb::add_artifact(&app.db, &a).await?;
1480
    Ok(Json(serde_json::json!({ "blob": a.blob })).into_response())
1481
}
1482
1483
/// `GET /api/v1/flow/jobs/{id}/checkpoint` (oxygenflow#77): the checkpoint
1484
/// a handed-back attempt saved, for the attempt now running it.
1485
pub async fn checkpoint(State(app): State<Shared>, headers: HeaderMap, Path(id): Path<i64>) -> Result<Response, ApiError> {
1486
    let runner = runner_auth(&app, &headers).await?;
1487
    let job = running_job(&app, id).await?;
1488
    if runner.source == "registered" && job.runner != runner.name {
1489
        return Err(ApiError(StatusCode::FORBIDDEN, "this job is held by another runner".into()));
1490
    }
1491
    let a = fdb::checkpoint(&app.db, job.id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "this job has no checkpoint".into()))?;
1492
    let repo = job_repo(&app, &job).await?;
1493
    let blob = oxy_core::hash::ObjectRef::from_hex(&a.blob)
1494
        .ok_or_else(|| ApiError(StatusCode::INTERNAL_SERVER_ERROR, "a kept checkpoint has a bad blob".into()))?;
1495
    let bytes = app
1496
        .repos
1497
        .read(&repo, move |r, _| Ok(r.read_blob(&blob)?))
1498
        .await
1499
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("read the checkpoint: {e}")))?;
1500
    Ok(([(axum::http::header::CONTENT_TYPE, "application/octet-stream")], bytes).into_response())
1501
}
1502
1503
/// The repository job `job` runs for.
1504
async fn job_repo(app: &Shared, job: &fdb::Job) -> Result<RepoName, ApiError> {
1505
    let run = fdb::run_by_id(&app.db, job.run_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1506
    let row =
1507
        db::repos::get_by_id(&app.db, run.repo_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such repository".into()))?;
1508
    RepoName::new(&row.owner, &row.name).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "bad repository name".into()))
1509
}
1510
ab4df6aa Andy McCall ↶ 1511
/// `POST /api/v1/flow/jobs/{id}/release` (oxygenflow#76): a draining
1512
/// runner hands back a job it holds, as it leaves (off the allowed network,
1513
/// a restart, a spot reclaim). Not a decline: the runner is not held from
1514
/// the job and it does not count towards unplaceable.
1515
pub async fn release(
1516
    State(app): State<Shared>,
1517
    headers: HeaderMap,
1518
    Path(id): Path<i64>,
1519
    Json(d): Json<flow_core::api::Decline>,
1520
) -> Result<StatusCode, ApiError> {
1521
    let me = runner_auth(&app, &headers).await?;
1522
    db::runners::seen(&app.db, me.id, None, None).await?;
1523
    let reason: String = d.reason.chars().map(|c| if c.is_control() { ' ' } else { c }).take(500).collect();
1524
    let why = match reason.trim() {
1525
        "" => format!("handed back by {}", me.name),
1526
        r => format!("handed back by {}: {r}", me.name),
1527
    };
1528
    if !hand_back_job(&app, id, Some(me.id), &why).await? {
1529
        return Err(ApiError(StatusCode::CONFLICT, "that job is not running on this runner".into()));
1530
    }
1531
    Ok(StatusCode::NO_CONTENT)
1532
}
1533
4d2e44d7 Andy McCall ↶ 1534
/// `POST /api/v1/flow/jobs/{id}/decline` (OxygenFlow spec §11.5): the
1535
/// runner will not run a job it was handed. The job is queued again and
1536
/// not offered to that runner while its profile stays the same (and for
1537
/// [`fdb::DECLINE_HOLDS_MS`] at most); once [`UNPLACEABLE_AFTER`]
1538
/// different runners have declined it, it ends as unplaceable with their
1539
/// reasons. A decline is never a failed check.
e9b9619c Andy McCall ↶ 1540
/// `POST /api/v1/flow/runners/heartbeat` (oxygenhub#243): a runner whose
1541
/// job slots are all full claims nothing, so it says it is there.
1542
pub async fn heartbeat(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
1543
    let me = runner_auth(&app, &headers).await?;
1544
    db::runners::seen(&app.db, me.id, None, None).await?;
1545
    Ok(StatusCode::NO_CONTENT)
1546
}
1547
8501fd58 Andy McCall ↶ 1548
/// `GET /api/v1/flow/runner/update` (oxygenhub#322): the update policy
1549
/// that applies to this runner and the build it should run, if another.
1550
pub async fn runner_update(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<flow_core::api::UpdateAnswer>, ApiError> {
1551
    let me = runner_auth(&app, &headers).await?;
1552
    db::runners::seen(&app.db, me.id, None, None).await?;
1553
    let policy = crate::runner_updates::Levels::load(&app.db).await?.resolve(&me);
1554
    let hour = time::OffsetDateTime::now_utc().hour();
1555
    let (offer, note) = crate::runner_updates::offer(&app.db, &me, &policy, hour).await?;
1556
    Ok(Json(flow_core::api::UpdateAnswer { policy, offer, note }))
1557
}
1558
1559
/// `POST /api/v1/flow/runner/update`: what the runner did about its update
1560
/// (fetched, checked, installed, a dry run's verdict, a rollback), kept on
1561
/// its page and in the audit log.
1562
pub async fn report_update(
1563
    State(app): State<Shared>,
1564
    headers: HeaderMap,
1565
    Json(r): Json<flow_core::api::UpdateReport>,
1566
) -> Result<StatusCode, ApiError> {
1567
    let me = runner_auth(&app, &headers).await?;
1568
    let note: String = r.note.chars().map(|c| if c.is_control() { ' ' } else { c }).take(500).collect();
1569
    let note = note.trim();
1570
    if note.is_empty() {
1571
        return Err(ApiError(StatusCode::BAD_REQUEST, "say what happened (note)".into()));
1572
    }
1573
    db::runner_updates::report(&app.db, me.id, note).await?;
faf5246c Andy McCall ↶ 1574
    // A build that rolled back here is held back from every runner (#326).
1575
    if let Some(v) = crate::runner_updates::rolled_back_version(note) {
1576
        let why = note.split_once(": ").map(|(_, w)| w).unwrap_or("rolled back");
1577
        db::runner_updates::hold(&app.db, &v, &me.name, why).await?;
1578
        db::accounts::audit(&app.db, None, "runner.update.held", &v, &format!("rolled back on {}: {why}", me.name)).await.ok();
1579
    }
8501fd58 Andy McCall ↶ 1580
    db::accounts::audit(&app.db, None, "runner.update", &me.name, note).await.ok();
1581
    Ok(StatusCode::NO_CONTENT)
1582
}
1583
4d2e44d7 Andy McCall ↶ 1584
pub async fn decline(
1585
    State(app): State<Shared>,
1586
    headers: HeaderMap,
1587
    Path(id): Path<i64>,
1588
    Json(d): Json<flow_core::api::Decline>,
1589
) -> Result<StatusCode, ApiError> {
1590
    let me = runner_auth(&app, &headers).await?;
1591
    db::runners::seen(&app.db, me.id, None, None).await?;
1592
    let reason: String = d.reason.chars().map(|c| if c.is_control() { ' ' } else { c }).take(500).collect();
1593
    let reason = match reason.trim() {
1594
        "" => "no reason given".to_string(),
1595
        r => r.to_string(),
1596
    };
1597
    let Some(all) = fdb::decline(&app.db, id, me.id, &me.name, &me.profile, &reason).await? else {
1598
        return Err(ApiError(StatusCode::CONFLICT, "that job is not running on this runner".into()));
1599
    };
1600
    tracing::info!("flow: runner {} declined job {id}: {reason}", me.name);
1601
    let job = fdb::job(&app.db, id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such job".into()))?;
1602
    let runners: std::collections::BTreeSet<i64> = all.iter().map(|d| d.runner_id).collect();
1603
    if runners.len() >= UNPLACEABLE_AFTER {
1604
        let error = format!(
1605
            "unplaceable: declined by {} runners: {}",
1606
            runners.len(),
1607
            all.iter().map(|d| format!("{}: {}", d.runner, d.reason)).collect::<Vec<_>>().join("; ")
1608
        );
1609
        let changed =
1610
            fdb::finish(&app.db, id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
1611
                .await?;
1612
        report_changed(&app, job.run_id, changed).await?;
1613
    } else if let Some(run) = fdb::run_by_id(&app.db, job.run_id).await? {
1614
        if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
1615
            let summary = format!("declined by {}: {reason}; waiting for another runner", me.name);
1616
            report_check(&app, &row, &run.state, run.number, &job.name, "queued", &summary).await;
1617
            fdb::set_waiting(&app.db, id, &summary).await?;
1618
        }
1619
    }
1620
    Ok(StatusCode::NO_CONTENT)
501d8b26 Andy McCall ↶ 1621
}
1622
1623
/// Why no runner can take `job` of a repository of `owner` (id `repo_id`)
1624
/// now (spec §11.4), from what each runner offered at its last claim:
1625
/// empty when one could (it waits its turn or a free slot), else what
1626
/// each one lacks. `declines` are the job's.
1627
/// What placement knows of the fleet: images' architectures, the images
1628
/// the hub holds, and the time.
1629
pub struct Fleet<'a> {
1630
    pub image_archs: &'a std::collections::HashMap<String, String>,
1631
    pub hub_images: &'a std::collections::HashSet<String>,
1632
    pub now: i64,
1633
}
1634
1635
/// Why runner `r` cannot take `job` of a repository of `owner` (id
1636
/// `repo_id`), from what it offered at its last claim (spec §11.4); `None`
1637
/// when it can. `declines` are the job's.
1638
pub fn runner_lacks(
1639
    job: &fdb::Job,
1640
    owner: &str,
1641
    repo_id: i64,
1642
    r: &db::runners::Runner,
1643
    fleet: &Fleet,
1644
    declines: &[fdb::DeclineRow],
1645
) -> Option<String> {
1646
    let sandbox: serde_json::Value = serde_json::from_str(&job.sandbox).unwrap_or_default();
1647
    let rootfs = sandbox["rootfs"].as_str().unwrap_or("");
1648
    let wanted_arch = job.arch().or_else(|| fleet.image_archs.get(rootfs).cloned());
1649
    let need = |k: &str| sandbox[k].as_u64().unwrap_or(0);
1650
    if r.state == "draining" {
1651
        return Some("is draining".into());
1652
    }
1653
    let scope = r.scope();
1654
    if (!scope.owner.is_empty() && scope.owner != owner) || scope.repo_id.is_some_and(|id| id != repo_id) {
1655
        return Some("serves other repositories".into());
1656
    }
1657
    let tiers = r.tier_list();
1658
    if !tiers.is_empty() && !tiers.contains(&job.runtime.as_str()) {
1659
        return Some(format!("has no {} tier (it offers {})", job.runtime, tiers.join(", ")));
1660
    }
1661
    if let Some(w) = wanted_arch.as_deref().filter(|w| !r.arch.is_empty() && *w != r.arch) {
1662
        return Some(format!("is {}; the job needs {w}", r.arch));
1663
    }
56b8dbe6 Andy McCall ↶ 1664
    // A job with no image (the WASM tier) needs none on the runner, as its claim says.
501d8b26 Andy McCall ↶ 1665
    let fetches = r.fetches_images && fleet.hub_images.contains(rootfs);
56b8dbe6 Andy McCall ↶ 1666
    if !rootfs.is_empty() && !fetches && r.image_list().is_some_and(|have| !have.iter().any(|h| h == rootfs)) {
501d8b26 Andy McCall ↶ 1667
        let why = if r.fetches_images { " (nor does the hub: send it with flow rootfs push)" } else { "" };
1668
        return Some(format!("does not hold image {}{why}", &rootfs[..12.min(rootfs.len())]));
1669
    }
1670
    let labels = r.label_list();
1671
    if let Some(l) = job.needs().iter().find(|l| !labels.contains(&l.as_str())) {
1672
        return Some(format!("lacks label {l}"));
1673
    }
1674
    if let Some(m) = r.memory_mib.filter(|m| (*m as u64) < need("memory_mib")) {
1675
        return Some(format!("has {m} MiB; the job needs {} MiB", need("memory_mib")));
1676
    }
1677
    if let Some(c) = r.cpus.filter(|c| (*c as u64) < need("cpus")) {
1678
        return Some(format!("has {c} CPUs; the job needs {}", need("cpus")));
1679
    }
1680
    // The disk it learned it needs (oxygenflow#41).
1681
    if let (Some(n), Some(free)) = (job.need_disk_mib, r.free_disk_mib) {
1682
        if free < n {
1683
            return Some(format!(
1684
                "has {} free; the job needs ~{} (its recent runs took up to {})",
1685
                mib(free),
1686
                mib(n),
1687
                mib((n - 64) * 4 / 5)
1688
            ));
1689
        }
1690
    }
1691
    if let Some(d) = declines.iter().find(|d| d.runner_id == r.id && fleet.now - d.ms < fdb::DECLINE_HOLDS_MS) {
1692
        return Some(format!("declined it: {}", d.reason));
1693
    }
1694
    None
4d2e44d7 Andy McCall ↶ 1695
}
1696
1697
/// Why no runner can take `job` of a repository of `owner` (id `repo_id`)
1698
/// now (spec §11.4), from what each runner offered at its last claim:
1699
/// empty when one could (it waits its turn or a free slot), else what
1700
/// each one lacks. `declines` are the job's.
92a797b2 Andy McCall ↶ 1701
#[allow(clippy::too_many_arguments)]
4d2e44d7 Andy McCall ↶ 1702
pub fn why_waiting(
1703
    job: &fdb::Job,
1704
    owner: &str,
1705
    repo_id: i64,
1706
    runners: &[db::runners::Runner],
1707
    image_archs: &std::collections::HashMap<String, String>,
1708
    declines: &[fdb::DeclineRow],
1709
    now: i64,
92a797b2 Andy McCall ↶ 1710
    hub_images: &std::collections::HashSet<String>,
4d2e44d7 Andy McCall ↶ 1711
) -> String {
501d8b26 Andy McCall ↶ 1712
    let fleet = Fleet { image_archs, hub_images, now };
4d2e44d7 Andy McCall ↶ 1713
    let online: Vec<&db::runners::Runner> = runners.iter().filter(|r| r.state != "disabled" && r.online()).collect();
1714
    if online.is_empty() {
1715
        return "no runner is online".into();
1716
    }
1717
    let mut why = Vec::new();
1718
    for r in &online {
501d8b26 Andy McCall ↶ 1719
        match runner_lacks(job, owner, repo_id, r, &fleet, declines) {
4d2e44d7 Andy McCall ↶ 1720
            None => return String::new(),
1721
            Some(w) => why.push(format!("{} {w}", r.name)),
1722
        }
1723
    }
1724
    let more = why.len().saturating_sub(4);
1725
    why.truncate(4);
1726
    let mut text = format!("no runner can take it: {}", why.join("; "));
1727
    if more > 0 {
1728
        text.push_str(&format!("; and {more} more"));
1729
    }
1730
    text
501d8b26 Andy McCall ↶ 1731
}
1732
58cbf424 Andy McCall ↶ 1733
/// Why a job that some runner could take still waits (oxygenhub#259): the
1734
/// runners that could take it are all busy, or have a free slot without
1735
/// the room for it now, and how many ready jobs come first (a higher
1736
/// priority, or the same one and older).
1737
#[allow(clippy::too_many_arguments)]
1738
pub fn why_still_waiting(
1739
    job: &fdb::Job,
1740
    owner: &str,
1741
    repo_id: i64,
1742
    runners: &[db::runners::Runner],
1743
    fleet: (&std::collections::HashMap<String, String>, &std::collections::HashSet<String>, i64),
1744
    declines: &[fdb::DeclineRow],
1745
    running: &std::collections::HashMap<i64, i64>,
1746
    ahead: usize,
794ff94f Andy McCall ↶ 1747
    behind_urgent: &[String],
58cbf424 Andy McCall ↶ 1748
) -> String {
1749
    let fleet = Fleet { image_archs: fleet.0, hub_images: fleet.1, now: fleet.2 };
1750
    let mut busy = Vec::new();
1751
    for r in runners.iter().filter(|r| r.state != "disabled" && r.online()) {
1752
        if runner_lacks(job, owner, repo_id, r, &fleet, declines).is_some() {
1753
            continue;
1754
        }
1755
        let n = running.get(&r.id).copied().unwrap_or(0);
1756
        let slots = r.max_jobs.max(1);
1757
        if n >= slots {
1758
            busy.push(format!("{} busy ({n} of {slots})", r.name));
1759
        } else {
1760
            busy.push(format!("{} has a free slot ({n} of {slots}) but not the memory or disk for it now", r.name));
1761
        }
1762
    }
1763
    let mut parts = Vec::new();
1764
    if !busy.is_empty() {
1765
        parts.push(format!("the runners that can take it are busy: {}", busy.join("; ")));
1766
    }
1767
    if ahead > 0 {
794ff94f Andy McCall ↶ 1768
        let after = match behind_urgent {
1769
            [] => String::new(),
1770
            [one] => format!(" (after expedited run {one})"),
1771
            many => format!(" (after expedited runs {})", many.join(", ")),
1772
        };
1773
        parts.push(format!("{ahead} ready {} first{after}", if ahead == 1 { "job comes" } else { "jobs come" }));
58cbf424 Andy McCall ↶ 1774
    }
1775
    parts.join("; ")
1776
}
1777
501d8b26 Andy McCall ↶ 1778
/// How long a job is held for a better runner before any runner that fits
1779
/// takes it (oxygenflow#42).
1780
const BETTER_HOLD_MS: i64 = 15_000;
1781
/// A runner counts as there to take a job when it asked this recently.
1782
const POLLING_MS: i64 = 10_000;
1783
1784
/// When each job was first passed over for a better runner.
c95446a1 Andy McCall ↶ 1785
/// Keyed by hub (tests run several in one process) and job.
1786
static HELD: std::sync::Mutex<Option<std::collections::HashMap<(String, i64), i64>>> = std::sync::Mutex::new(None);
4fa0da12 Andy McCall ↶ 1787
1788
/// The build cache slots each runner said at its last claim it holds
1789
/// (oxygenflow#51). Keyed by hub (tests run several in one process) and
1790
/// runner; a restart forgets them until each runner's next claim.
c2be148c Andy McCall ↶ 1791
/// Each slot maps to when it last kept a disk (Unix ms, 0 unknown).
1792
type CacheSlots = std::collections::HashMap<(String, i64), std::collections::HashMap<String, i64>>;
4fa0da12 Andy McCall ↶ 1793
static CACHES: std::sync::Mutex<Option<CacheSlots>> = std::sync::Mutex::new(None);
1794
c2be148c Andy McCall ↶ 1795
/// When runner `runner` last kept a disk in build cache slot `slot` (0 when
1796
/// it did not say); `None` when it holds none there.
1797
fn cache_kept(hub: &str, runner: i64, slot: &str) -> Option<i64> {
4fa0da12 Andy McCall ↶ 1798
    CACHES
1799
        .lock()
1800
        .unwrap_or_else(|p| p.into_inner())
1801
        .as_ref()
1802
        .and_then(|c| c.get(&(hub.to_string(), runner)))
c2be148c Andy McCall ↶ 1803
        .and_then(|held| held.get(slot).copied())
1804
}
1805
1806
/// A copy of a build cache kept at least this much later is the fresher
1807
/// (oxygenflow#54): closer than that, the two are as good as each other.
1808
const FRESHER_MS: i64 = 60_000;
1809
1810
/// How well a runner fits a job (oxygenflow#42, #51, #54).
1811
struct Fit {
1812
    /// When it last kept the job's build cache, if it holds it.
1813
    cache: Option<i64>,
1814
    image: bool,
1815
    speed: i64,
1816
}
1817
1818
impl Fit {
1819
    /// Whether this fit is better than `other`: holding the job's build
1820
    /// cache counts most (a warm build beats any image fetch), and of two
1821
    /// that hold it the fresher copy; then holding the image, then speed.
1822
    fn beats(&self, other: &Fit) -> bool {
1823
        match (self.cache, other.cache) {
1824
            (Some(_), None) => return true,
1825
            (None, Some(_)) => return false,
1826
            (Some(a), Some(b)) if a > 0 && b > 0 && (a - b).abs() >= FRESHER_MS => return a > b,
1827
            _ => {}
1828
        }
1829
        (self.image, self.speed) > (other.image, other.speed)
1830
    }
1831
}
1832
1833
/// How runner `r` fits a job on image `rootfs` whose build cache slot is
1834
/// `slot`.
1835
fn fit(hub: &str, r: &db::runners::Runner, rootfs: &str, slot: &str) -> Fit {
1836
    Fit {
1837
        cache: cache_kept(hub, r.id, slot),
1838
        image: r.image_list().is_some_and(|have| have.iter().any(|h| h == rootfs)),
1839
        speed: r.speed_class.unwrap_or(0),
1840
    }
4fa0da12 Andy McCall ↶ 1841
}
501d8b26 Andy McCall ↶ 1842
c2be148c Andy McCall ↶ 1843
/// A span as people say it: 40 s, 12 min, 3 h, 2 days.
1844
fn ago(ms: i64) -> String {
1845
    let s = ms.max(0) / 1000;
1846
    match s {
1847
        0..=59 => format!("{s} s"),
1848
        60..=3599 => format!("{} min", s / 60),
1849
        3600..=172_799 => format!("{} h", s / 3600),
1850
        _ => format!("{} days", s / 86_400),
1851
    }
501d8b26 Andy McCall ↶ 1852
}
1853
1854
fn rootfs_of(job: &fdb::Job) -> String {
1855
    serde_json::from_str::<serde_json::Value>(&job.sandbox).ok().and_then(|v| v["rootfs"].as_str().map(String::from)).unwrap_or_default()
44a3d2eb Andy McCall ↶ 1856
}
1857
1858
/// A size in MiB as people say it: 9.4 GiB, 740 MiB.
1859
fn mib(m: i64) -> String {
1860
    if m >= 1024 {
1861
        format!("{:.1} GiB", m as f64 / 1024.0)
1862
    } else {
1863
        format!("{m} MiB")
1864
    }
4d2e44d7 Andy McCall ↶ 1865
}
1866
1867
/// One placement pass: say why each ready queued job waits.
1868
pub async fn explain_waits(app: &Shared) -> sqlx::Result<()> {
1869
    let ready = fdb::ready_queued(&app.db).await?;
1870
    if ready.is_empty() {
1871
        return Ok(());
1872
    }
1873
    let runners = db::runners::list(&app.db).await?;
1874
    let archs = fdb::image_archs(&app.db).await?;
92a797b2 Andy McCall ↶ 1875
    let held = crate::images::held(&app.db).await?;
4d2e44d7 Andy McCall ↶ 1876
    let now = db::now_ms();
58cbf424 Andy McCall ↶ 1877
    let ranks = fdb::queued_ranks(&app.db).await?;
1878
    let running = fdb::running_by_runner(&app.db).await?;
1879
    // Claim order, roughly: a better rank first, then the older job.
1880
    let order: Vec<(i64, i64)> = ready.iter().map(|(j, _, _)| (ranks.get(&j.id).copied().unwrap_or(2), j.id)).collect();
794ff94f Andy McCall ↶ 1881
    let run_of: std::collections::HashMap<i64, i64> = ready.iter().map(|(j, _, _)| (j.id, j.run_id)).collect();
1882
    // Expedited runs (rank 0) by name, for the jobs they moved down (#291).
1883
    let mut urgent: std::collections::BTreeMap<i64, String> = std::collections::BTreeMap::new();
1884
    for (j, _, _) in ready.iter().filter(|(j, _, _)| ranks.get(&j.id) == Some(&0)) {
1885
        if urgent.contains_key(&j.run_id) {
1886
            continue;
1887
        }
1888
        if let Some(run) = fdb::run_by_id(&app.db, j.run_id).await? {
1889
            if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
1890
                urgent.insert(j.run_id, format!("{}/{} #{}", row.owner, row.name, run.number));
1891
            }
1892
        }
1893
    }
1894
    // Runs whose waiting notes changed: their pages hear of it now.
1895
    let mut changed = std::collections::BTreeSet::new();
4d2e44d7 Andy McCall ↶ 1896
    for (job, owner, repo_id) in ready {
1897
        let declines = fdb::declines_of_job(&app.db, job.id).await?;
58cbf424 Andy McCall ↶ 1898
        let mut why = why_waiting(&job, &owner, repo_id, &runners, &archs, &declines, now, &held);
1899
        if why.is_empty() {
1900
            let mine = (ranks.get(&job.id).copied().unwrap_or(2), job.id);
1901
            let ahead = order.iter().filter(|o| **o < mine).count();
794ff94f Andy McCall ↶ 1902
            let mut behind: Vec<String> = Vec::new();
1903
            if mine.0 > 0 {
1904
                for o in order.iter().filter(|o| o.0 == 0 && **o < mine) {
1905
                    let Some(r) = run_of.get(&o.1).filter(|r| **r != job.run_id) else { continue };
1906
                    if let Some(label) = urgent.get(r).filter(|l| !behind.contains(l)) {
1907
                        behind.push(label.clone());
1908
                    }
1909
                }
1910
            }
1911
            why = why_still_waiting(&job, &owner, repo_id, &runners, (&archs, &held, now), &declines, &running, ahead, &behind);
58cbf424 Andy McCall ↶ 1912
        }
67040b15 Andy McCall ↶ 1913
        if why == job.waiting {
1914
            continue;
1915
        }
4d2e44d7 Andy McCall ↶ 1916
        fdb::set_waiting(&app.db, job.id, &why).await?;
794ff94f Andy McCall ↶ 1917
        changed.insert(job.run_id);
67040b15 Andy McCall ↶ 1918
        // The job's check says it too, so a proposal shows why it is stuck
58cbf424 Andy McCall ↶ 1919
        // (oxygenhub#28); only when the reason changes in kind, not in its
1920
        // counts (#259: a queue position moves every pass, and each check
1921
        // report reaches webhooks).
1922
        let kind = |s: &str| s.chars().filter(|c| !c.is_ascii_digit()).collect::<String>();
1923
        if kind(&why) == kind(&job.waiting) {
1924
            continue;
1925
        }
67040b15 Andy McCall ↶ 1926
        if let (Some(run), Some(row)) = (fdb::run_by_id(&app.db, job.run_id).await?, db::repos::get_by_id(&app.db, repo_id).await?) {
1927
            let summary = if why.is_empty() { "waiting for a runner" } else { why.as_str() };
1928
            report_check(app, &row, &run.state, run.number, &job.name, "queued", summary).await;
1929
        }
794ff94f Andy McCall ↶ 1930
    }
1931
    for run_id in changed {
1932
        app.bus.live(&crate::events::topic::run(run_id), "jobs");
4d2e44d7 Andy McCall ↶ 1933
    }
1934
    Ok(())
1935
}
1936
1937
/// Run a placement pass every 15 seconds.
1938
pub async fn placement(app: Shared) {
1939
    loop {
1940
        tokio::time::sleep(std::time::Duration::from_secs(15)).await;
1941
        if let Err(e) = explain_waits(&app).await {
1942
            tracing::warn!("flow: placement pass: {e}");
1943
        }
1944
    }
1945
}
1946
25091e5c Andy McCall ↶ 1947
/// The Oxygen subrepo pins in `name`'s state `heads`: (path, repository id, pinned heads).
f677d627 Andy McCall ↶ 1948
pub(crate) async fn pins_in(
25091e5c Andy McCall ↶ 1949
    app: &Shared,
1950
    name: crate::repos::RepoName,
1951
    heads: Vec<oxy_core::hash::ChangeHash>,
5d54cf74 Andy McCall ↶ 1952
) -> Result<Vec<(String, [u8; 16], Vec<oxy_core::hash::ChangeHash>)>, String> {
25091e5c Andy McCall ↶ 1953
    app.repos
fd3db644 Andy McCall ↶ 1954
        .read(&name, move |repo, cache| {
1955
            let loaded = cache.load(repo, &heads)?;
1956
            let mut out = Vec::new();
1957
            for (path, f) in &loaded.snapshot.files {
1958
                if f.kind != oxy_core::objects::NodeKind::Subrepo {
1959
                    continue;
1960
                }
1961
                if let oxy_core::state::FileContent::Opaque { blobs } = &f.content {
1962
                    if let Some(b) = blobs.first() {
1963
                        if let Ok(oxy_core::subrepo::Pin::Oxy { repo: id, heads, .. }) = repo
1964
                            .read_blob(b)
1965
                            .map_err(crate::repos::RepoError::Oxy)
1966
                            .and_then(|bytes| oxy_core::subrepo::Pin::decode(&bytes).map_err(|e| crate::repos::RepoError::Oxy(e.into())))
1967
                        {
1968
                            out.push((path.clone(), id, heads));
1969
                        }
1970
                    }
1971
                }
1972
            }
1973
            Ok(out)
1974
        })
1975
        .await
5d54cf74 Andy McCall ↶ 1976
        .map_err(|e| e.to_string())
25091e5c Andy McCall ↶ 1977
}
1978
1979
/// How deep subrepos of subrepos are followed.
1980
const MAX_SUBREPO_DEPTH: usize = 3;
1981
1982
/// The Oxygen subrepos the run's state pins, and those their states pin in
1983
/// turn (parents first, paths joined), that live on this hub and that the
1984
/// run's pusher may read: what the job's workspace needs beside its own
afd0be38 Andy McCall ↶ 1985
/// tree. A pin the hub cannot serve is left out, with what it pins, and
1986
/// the third list says why, for the job's log.
1987
async fn subrepo_inputs(
1988
    app: &Shared,
1989
    row: &db::repos::RepoRow,
1990
    run: &fdb::Run,
1991
) -> (Vec<flow_core::api::SubrepoInput>, Vec<i64>, Vec<String>) {
1992
    let Some(name) = crate::repos::RepoName::new(&row.owner, &row.name) else { return (vec![], vec![], vec![]) };
25091e5c Andy McCall ↶ 1993
    let heads: Vec<oxy_core::hash::ChangeHash> = run.head_list().into_iter().filter_map(oxy_core::hash::ChangeHash::from_hex).collect();
fd3db644 Andy McCall ↶ 1994
    let pusher = db::accounts::account_by_name(&app.db, &run.actor).await.ok().flatten();
25091e5c Andy McCall ↶ 1995
    let rows = db::repos::list(&app.db).await.unwrap_or_default();
fd3db644 Andy McCall ↶ 1996
    let mut inputs = Vec::new();
1997
    let mut ids = Vec::new();
afd0be38 Andy McCall ↶ 1998
    let mut left_out = Vec::new();
1999
    let actor = if run.actor.is_empty() { "the run's starter".to_string() } else { run.actor.clone() };
25091e5c Andy McCall ↶ 2000
    // (path prefix, repository, heads, depth), parents before children.
2001
    let mut queue = std::collections::VecDeque::from([(String::new(), name, heads, 0usize)]);
2002
    while let Some((prefix, name, heads, depth)) = queue.pop_front() {
2003
        if depth == MAX_SUBREPO_DEPTH {
2004
            continue;
2005
        }
5d54cf74 Andy McCall ↶ 2006
        for (path, id, pinned) in pins_in(app, name, heads).await.unwrap_or_default() {
25091e5c Andy McCall ↶ 2007
            let path = if prefix.is_empty() { path } else { format!("{prefix}/{path}") };
afd0be38 Andy McCall ↶ 2008
            let mut hosted = false;
25091e5c Andy McCall ↶ 2009
            for other in &rows {
2010
                let Some(other_name) = crate::repos::RepoName::new(&other.owner, &other.name) else { continue };
2011
                let matches = app.repos.read(&other_name, move |r, _| Ok(r.id().ok() == Some(id))).await.unwrap_or(false);
2012
                if !matches {
2013
                    continue;
2014
                }
afd0be38 Andy McCall ↶ 2015
                hosted = true;
25091e5c Andy McCall ↶ 2016
                let role = crate::auth::roles::role_for(&app.db, pusher.as_ref(), other).await.ok().flatten();
180dc43a Andy McCall ↶ 2017
                // A Diffusion bump's run reads the upstream it bumps: the one
2018
                // the consumer pins (someone who may write it committed the
2019
                // pin), and no other (#150).
2020
                let diffused = run.actor == crate::diffusion::ACCOUNT
2021
                    && run.bookmark.starts_with("diffusion/")
5d90e0e0 Andy McCall 2022
                    && sqlx::query_scalar::<_, i64>("SELECT COUNT(*) FROM diffusion_pins WHERE consumer_id = $1 AND upstream_repo_id = $2")
180dc43a Andy McCall ↶ 2023
                        .bind(run.repo_id)
2024
                        .bind(other.id)
2025
                        .fetch_one(&app.db)
2026
                        .await
2027
                        .unwrap_or(0)
2028
                        > 0;
2029
                if diffused || crate::auth::roles::allows(role, crate::auth::Access::Read) {
25091e5c Andy McCall ↶ 2030
                    inputs.push(flow_core::api::SubrepoInput {
2031
                        path: path.clone(),
2032
                        repo: format!("{}/{}", other.owner, other.name),
2033
                        clone_url: format!("{}/{}/{}", app.config.base_url(), other.owner, other.name),
2034
                        heads: pinned.iter().map(|h| h.to_hex()).collect(),
2035
                    });
2036
                    if !ids.contains(&other.id) {
2037
                        ids.push(other.id);
2038
                    }
2039
                    queue.push_back((path.clone(), other_name, pinned.clone(), depth + 1));
afd0be38 Andy McCall ↶ 2040
                } else {
2041
                    left_out.push(format!(
2042
                        "subrepo {path} ({}/{}) is left out: {actor} cannot read it, so the job has no files there",
2043
                        other.owner, other.name
2044
                    ));
25091e5c Andy McCall ↶ 2045
                }
2046
                break;
afd0be38 Andy McCall ↶ 2047
            }
2048
            if !hosted {
2049
                left_out.push(format!("subrepo {path} is left out: the repository it pins is not on this hub"));
fd3db644 Andy McCall ↶ 2050
            }
2051
        }
2052
    }
afd0be38 Andy McCall ↶ 2053
    (inputs, ids, left_out)
42fa9554 Andy McCall ↶ 2054
}
2055
2056
async fn running_job(app: &Shared, id: i64) -> Result<fdb::Job, ApiError> {
2057
    match fdb::job(&app.db, id).await? {
2058
        Some(j) if j.status == "running" => Ok(j),
2059
        Some(_) => Err(ApiError(StatusCode::CONFLICT, "this job is not running".into())),
2060
        None => Err(ApiError(StatusCode::NOT_FOUND, "no such job".into())),
2061
    }
2062
}
2063
2064
/// `POST /api/v1/flow/jobs/{id}/log`.
2065
pub async fn log(
2066
    State(app): State<Shared>,
2067
    headers: HeaderMap,
2068
    Path(id): Path<i64>,
2069
    Json(mut batch): Json<LogBatch>,
2070
) -> Result<StatusCode, ApiError> {
d94449e4 Andy McCall ↶ 2071
    let me = runner_auth(&app, &headers).await?;
42fa9554 Andy McCall ↶ 2072
    let job = running_job(&app, id).await?;
d94449e4 Andy McCall ↶ 2073
    // A runner busy with its only job claims nothing, so its log and
2074
    // finish calls are what keep it online (oxygenhub#78).
2075
    db::runners::seen(&app.db, me.id, None, None).await?;
745d225d Andy McCall ↶ 2076
    // An empty batch asks only whether the job still runs: a cancelled
2077
    // one answers 409 and its runner stops it (oxygenflow#32).
2078
    if batch.records.is_empty() {
2079
        return Ok(StatusCode::NO_CONTENT);
2080
    }
4ac01a73 Andy McCall ↶ 2081
    // A secret's value never reaches the stored log (#107).
2082
    let values: Vec<String> = match serde_json::from_str::<flow_core::Job>(&job.spec) {
2083
        Ok(spec) if !spec.secrets.is_empty() => {
2084
            let run = fdb::run_by_id(&app.db, job.run_id).await?;
2085
            let row = match run {
2086
                Some(run) => db::repos::get_by_id(&app.db, run.repo_id).await?,
2087
                None => None,
2088
            };
2089
            match row {
2090
                Some(row) => {
2091
                    let names: Vec<String> = spec.secrets.iter().map(|s| s.name.clone()).collect();
2092
                    crate::secrets::for_job(&app, &row, &names).await?.into_iter().map(|(_, v)| v).collect()
2093
                }
2094
                None => vec![],
2095
            }
2096
        }
2097
        _ => vec![],
2098
    };
d1727c57 Andy McCall ↶ 2099
    let kid = app.oidc.get().map(|i| i.kid.clone());
42fa9554 Andy McCall ↶ 2100
    for r in &mut batch.records {
4ac01a73 Andy McCall ↶ 2101
        if !values.is_empty() {
2102
            r.text = crate::secrets::mask(&r.text, &values);
d1727c57 Andy McCall ↶ 2103
        }
2104
        if let Some(kid) = &kid {
2105
            r.text = crate::oidc::mask(&r.text, kid);
4ac01a73 Andy McCall ↶ 2106
        }
42fa9554 Andy McCall ↶ 2107
        if r.text.len() > MAX_RECORD_TEXT {
2108
            let mut cut = MAX_RECORD_TEXT;
2109
            while !r.text.is_char_boundary(cut) {
2110
                cut -= 1;
2111
            }
2112
            r.text.truncate(cut);
2113
        }
2114
        if !matches!(r.stream.as_str(), "out" | "err" | "console" | "flow") {
2115
            r.stream = "console".into();
2116
        }
2117
    }
2118
    let kept = fdb::append_log(&app.db, job.id, &batch.records, MAX_RECORDS as i64).await?;
2119
    if kept < batch.records.len() && job.log_count < MAX_RECORDS as i64 {
2120
        tracing::info!("flow: job {} reached the log limit", job.id);
2121
    }
2122
    Ok(StatusCode::NO_CONTENT)
2123
}
2124
a3c8288b Andy McCall ↶ 2125
/// Largest artifact the hub keeps; the runner refuses larger ones first.
2126
pub const MAX_ARTIFACT_BYTES: usize = 512 << 20;
2127
2128
/// `POST /api/v1/flow/jobs/{id}/artifacts/{name}`: the bytes of an artifact
2129
/// the job declares (OxygenFlow spec §5.2), kept as a blob of the run's
2130
/// repository. Answers `{"blob"}`.
2131
pub async fn artifact(
2132
    State(app): State<Shared>,
2133
    headers: HeaderMap,
2134
    Path((id, name)): Path<(i64, String)>,
2135
    body: axum::body::Bytes,
2136
) -> Result<Response, ApiError> {
b6b7e4cf Andy McCall ↶ 2137
    runner_auth(&app, &headers).await?;
a3c8288b Andy McCall ↶ 2138
    let job = running_job(&app, id).await?;
2139
    let spec: flow_core::Job =
2140
        serde_json::from_str(&job.spec).map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("stored job: {e}")))?;
2141
    let Some(out) = spec.outputs.iter().find(|o| o.name == name) else {
2142
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("job {} declares no artifact {name:?}", job.name)));
2143
    };
2144
    let run = fdb::run_by_id(&app.db, job.run_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2145
    let row =
2146
        db::repos::get_by_id(&app.db, run.repo_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such repository".into()))?;
2147
    let repo = RepoName::new(&row.owner, &row.name).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "bad repository name".into()))?;
a36bab6b Andy McCall ↶ 2148
    // A report's artifact is its manifest (#127): checked, and its files
2149
    // found in the store, before it is kept.
2150
    let report = match out.kind {
2151
        flow_core::OutputKind::Report => Some(report_manifest(&app, &repo, &name, &body).await?),
2152
        flow_core::OutputKind::Artifact => None,
2153
    };
a3c8288b Andy McCall ↶ 2154
    let content = blake3::hash(&body).to_hex().to_string();
2155
    let size = body.len() as i64;
a36bab6b Andy McCall ↶ 2156
    let artifact = report.is_none();
2157
    let report_bytes = (artifact && name == crate::coverage::ARTIFACT).then(|| body.clone());
2158
    let junit_bytes = (artifact && name == crate::junit::ARTIFACT).then(|| body.clone());
a3c8288b Andy McCall ↶ 2159
    let blob = app
2160
        .repos
2161
        .write(&repo, move |r, _| Ok(r.store_blob(&body)?))
2162
        .await
2163
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("keep the artifact: {e}")))?;
2164
    let a = fdb::Artifact { job_id: job.id, name, path: out.path.clone(), blob: blob.to_hex(), size, content, created_ms: db::now_ms() };
2165
    fdb::add_artifact(&app.db, &a).await?;
a36bab6b Andy McCall ↶ 2166
    if let Some((manifest, declaration)) = report {
2167
        let origin = crate::reports::Origin {
2168
            repo_id: row.id,
2169
            run_id: run.id,
2170
            run_number: run.number,
2171
            job_id: job.id,
2172
            job: &job.name,
2173
            bookmark: &run.bookmark,
2174
            state: &run.state,
2175
        };
2176
        let said = match declaration {
2177
            Ok(d) => match crate::reports::keep(&app, &origin, &a.name, &d, &manifest, &a.blob).await {
c8df33a6 Andy McCall ↶ 2178
                Ok(id) => {
2179
                    report_threshold_checks(&app, &row, &run, &a.name, id, &d.metrics).await;
a36bab6b Andy McCall ↶ 2180
                    let s = if d.metrics.len() == 1 { "" } else { "s" };
2181
                    format!("report {}: {} \"{}\", {} metric{s}", a.name, d.kind, d.title, d.metrics.len())
2182
                }
2183
                Err(e) => format!("report {}: not indexed: {e}", a.name),
2184
            },
2185
            Err(why) => {
2186
                let d = crate::reports::Declaration::unreadable(&a.name, &why);
2187
                crate::reports::keep(&app, &origin, &a.name, &d, &manifest, &a.blob).await.ok();
2188
                format!("report {}: report.toml: {why}", a.name)
2189
            }
2190
        };
2191
        let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: said };
2192
        fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
2193
    }
554ccacf Andy McCall ↶ 2194
    // A coverage report (#113) is read now; what it says, or why it could
2195
    // not be read, goes in the job's log. It never fails the upload.
2196
    if let Some(bytes) = report_bytes {
2197
        let said = match read_coverage(&app, &repo, &row, &run, &job, &a.blob, bytes).await {
2198
            Ok(text) | Err(text) => text,
2199
        };
2200
        let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: said };
2201
        fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
2202
    }
0b203bbf Andy McCall ↶ 2203
    // A test report (#114) likewise.
2204
    if let Some(bytes) = junit_bytes {
2205
        let said = match read_junit(&app, &row, &run, &job, &a.blob, bytes).await {
2206
            Ok(text) | Err(text) => text,
2207
        };
2208
        let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: said };
2209
        fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
2210
    }
a3c8288b Andy McCall ↶ 2211
    Ok(Json(serde_json::json!({ "blob": a.blob })).into_response())
a36bab6b Andy McCall ↶ 2212
}
2213
c8df33a6 Andy McCall ↶ 2214
/// A check per metric with a threshold (#127, docs/reports.md §5), named
2215
/// `report/NAME/METRIC` on the run's state: failed when the value crosses
2216
/// `fail_above` or `fail_below`, which a proposal may require.
2217
async fn report_threshold_checks(
2218
    app: &Shared,
2219
    row: &db::repos::RepoRow,
2220
    run: &fdb::Run,
2221
    name: &str,
2222
    id: i64,
2223
    metrics: &[crate::reports::Metric],
2224
) {
2225
    let url = format!("{}/{}/{}/reports/{name}?id={id}", app.config.base_url(), row.owner, row.name);
2226
    for m in metrics.iter().filter(|m| m.fail_above.is_some() || m.fail_below.is_some()) {
2227
        let unit = if m.unit.is_empty() { String::new() } else { format!(" {}", m.unit) };
2228
        let above = m.fail_above.filter(|a| m.value > *a);
2229
        let below = m.fail_below.filter(|b| m.value < *b);
2230
        let (status, summary) = match (above, below) {
2231
            (Some(a), _) => ("failed", format!("{}{unit}, above {a}", m.value)),
2232
            (_, Some(b)) => ("failed", format!("{}{unit}, below {b}", m.value)),
2233
            _ => {
2234
                let limits: Vec<String> = [m.fail_above.map(|a| format!("at most {a}")), m.fail_below.map(|b| format!("at least {b}"))]
2235
                    .into_iter()
2236
                    .flatten()
2237
                    .collect();
2238
                ("passed", format!("{}{unit} ({})", m.value, limits.join(", ")))
2239
            }
2240
        };
2241
        let check = format!("report/{name}/{}", m.key);
2242
        if let Ok(c) = db::hooks::upsert_check(
2243
            &app.db,
2244
            row.id,
2245
            db::hooks::CheckReport { state: &run.state, name: &check, status, summary: &summary, url: &url, reporter: None, seal: "" },
2246
        )
2247
        .await
2248
        {
2249
            let api = crate::api::check_of(&c);
33d98147 Andy McCall 2250
            app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
c8df33a6 Andy McCall ↶ 2251
            crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
2252
        }
2253
    }
2254
}
2255
a36bab6b Andy McCall ↶ 2256
/// Check report manifest `body` (#127) and that the repository holds every
2257
/// file it names; answers it with the report's declaration, or why that
2258
/// could not be read.
2259
async fn report_manifest(
2260
    app: &Shared,
2261
    repo: &RepoName,
2262
    name: &str,
2263
    body: &[u8],
2264
) -> Result<(crate::reports::Manifest, Result<crate::reports::Declaration, String>), ApiError> {
2265
    let manifest = crate::reports::parse_manifest(body).map_err(|e| ApiError(StatusCode::BAD_REQUEST, e))?;
2266
    let refs: Vec<(String, oxy_core::hash::ObjectRef)> =
2267
        manifest.files.iter().filter_map(|f| Some((f.path.clone(), oxy_core::hash::ObjectRef::from_hex(&f.blob)?))).collect();
2268
    let declaration = manifest.blob("report.toml").and_then(oxy_core::hash::ObjectRef::from_hex);
2269
    let found = app
2270
        .repos
2271
        .read(repo, move |r, _| {
2272
            if let Some((path, _)) = refs.iter().find(|(_, b)| !r.store().has(b)) {
2273
                return Ok(Err(path.clone()));
2274
            }
2275
            Ok(Ok(declaration.map(|b| r.read_blob(&b)).transpose()?))
2276
        })
2277
        .await
2278
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("read the report: {e}")))?;
2279
    let toml = found.map_err(|path| ApiError(StatusCode::BAD_REQUEST, format!("report file {path} was not uploaded; upload it first")))?;
2280
    let declaration = crate::reports::parse_declaration(name, &toml.unwrap_or_default());
2281
    Ok((manifest, declaration))
2282
}
2283
2284
/// `POST /api/v1/flow/jobs/{id}/reports/{name}/files`: one file of a report
2285
/// the job declares (#127), its path in `X-Flow-Report-Path`, kept as a
2286
/// blob of the run's repository. Answers `{"blob"}`; the manifest naming
2287
/// the files follows as the report's artifact.
2288
pub async fn report_file(
2289
    State(app): State<Shared>,
2290
    headers: HeaderMap,
2291
    Path((id, name)): Path<(i64, String)>,
2292
    body: axum::body::Bytes,
2293
) -> Result<Response, ApiError> {
2294
    runner_auth(&app, &headers).await?;
2295
    let job = running_job(&app, id).await?;
2296
    let spec: flow_core::Job =
2297
        serde_json::from_str(&job.spec).map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("stored job: {e}")))?;
2298
    if !spec.outputs.iter().any(|o| o.name == name && o.kind == flow_core::OutputKind::Report) {
2299
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("job {} declares no report {name:?}", job.name)));
2300
    }
2301
    let path = headers.get("x-flow-report-path").and_then(|v| v.to_str().ok()).unwrap_or_default();
2302
    if !crate::reports::path_ok(path) {
2303
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("report file {path:?}: give its path in X-Flow-Report-Path")));
2304
    }
2305
    let run = fdb::run_by_id(&app.db, job.run_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2306
    let row =
2307
        db::repos::get_by_id(&app.db, run.repo_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such repository".into()))?;
2308
    let repo = RepoName::new(&row.owner, &row.name).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "bad repository name".into()))?;
2309
    let blob = app
2310
        .repos
2311
        .write(&repo, move |r, _| Ok(r.store_blob(&body)?))
2312
        .await
2313
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("keep the report file: {e}")))?;
2314
    Ok(Json(serde_json::json!({ "blob": blob.to_hex() })).into_response())
0b203bbf Andy McCall ↶ 2315
}
2316
2317
/// Parse and keep a job's JUnit report: what it says, or why not.
2318
async fn read_junit(
2319
    app: &Shared,
2320
    row: &db::repos::RepoRow,
2321
    run: &fdb::Run,
2322
    job: &fdb::Job,
2323
    blob: &str,
2324
    bytes: axum::body::Bytes,
2325
) -> Result<String, String> {
2326
    if bytes.len() > crate::junit::MAX_REPORT {
2327
        return Err(format!("tests: the report is {} MiB; at most {} MiB is read", bytes.len() >> 20, crate::junit::MAX_REPORT >> 20));
2328
    }
2329
    let text = String::from_utf8(bytes.to_vec()).map_err(|_| "tests: the report is not UTF-8 text (JUnit XML is expected)".to_string())?;
2330
    let cases = tokio::task::spawn_blocking(move || crate::junit::parse(&text))
2331
        .await
2332
        .map_err(|e| format!("tests: {e}"))?
2333
        .map_err(|e| format!("tests: {e}"))?;
2334
    let origin = crate::junit::Origin {
2335
        repo_id: row.id,
2336
        run_id: run.id,
2337
        run_number: run.number,
2338
        job_id: job.id,
2339
        job: &job.name,
2340
        bookmark: &run.bookmark,
2341
        state: &run.state,
2342
        blob,
2343
    };
2344
    crate::junit::keep(app, &origin, &cases).await.map_err(|e| format!("tests: {e}"))?;
2345
    let r = crate::junit::for_run(&app.db, run.id)
2346
        .await
2347
        .map_err(|e| format!("tests: {e}"))?
2348
        .into_iter()
2349
        .find(|r| r.job_id == job.id)
2350
        .ok_or_else(|| "tests: the report was not kept".to_string())?;
3d5c825a Andy McCall ↶ 2351
    // The `tests` check on the run's state: what fails, and which of those
2352
    // passed in the same job's latest report on the default bookmark, so a
2353
    // proposal names what it broke.
2354
    let base = crate::junit::baseline(&app.db, &r, &row.default_bookmark).await.map_err(|e| format!("tests: {e}"))?;
2355
    let newly = match &base {
2356
        Some(b) if r.broken() > 0 => crate::junit::newly_failing(&app.db, r.id, b.id).await.map_err(|e| format!("tests: {e}"))?,
2357
        _ => vec![],
2358
    };
2359
    let (status, summary) = if r.broken() == 0 {
2360
        ("passed", format!("{} passed", r.passed))
2361
    } else if let Some(b) = &base {
2362
        let names: Vec<&str> = newly.iter().take(3).map(String::as_str).collect();
2363
        let more = if newly.len() > 3 { format!(", +{}", newly.len() - 3) } else { String::new() };
2364
        let new = if newly.is_empty() {
2365
            format!("none new against {} run #{}", row.default_bookmark, b.run_number)
2366
        } else {
2367
            format!("{} new against {}: {}{more}", newly.len(), row.default_bookmark, names.join(", "))
2368
        };
2369
        ("failed", format!("{} failing; {new}", r.broken()))
2370
    } else {
2371
        ("failed", format!("{} failing", r.broken()))
2372
    };
2373
    let url = format!("{}/{}/{}/tests?report={}", app.config.base_url(), row.owner, row.name, r.id);
2374
    if let Ok(c) = db::hooks::upsert_check(
2375
        &app.db,
2376
        row.id,
2377
        db::hooks::CheckReport { state: &run.state, name: "tests", status, summary: &summary, url: &url, reporter: None, seal: "" },
2378
    )
2379
    .await
2380
    {
2381
        let api = crate::api::check_of(&c);
33d98147 Andy McCall 2382
        app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
3d5c825a Andy McCall ↶ 2383
        crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
2384
    }
0b203bbf Andy McCall ↶ 2385
    Ok(format!("tests: {} in {}", r.summary(), human_ms(r.time_ms)))
554ccacf Andy McCall ↶ 2386
}
2387
2388
/// Parse and keep a job's coverage report: what it says, or why not.
2389
async fn read_coverage(
2390
    app: &Shared,
2391
    repo: &RepoName,
2392
    row: &db::repos::RepoRow,
2393
    run: &fdb::Run,
2394
    job: &fdb::Job,
2395
    blob: &str,
2396
    bytes: axum::body::Bytes,
2397
) -> Result<String, String> {
2398
    if bytes.len() > crate::coverage::MAX_REPORT {
2399
        return Err(format!(
2400
            "coverage: the report is {} MiB; at most {} MiB is read",
2401
            bytes.len() >> 20,
2402
            crate::coverage::MAX_REPORT >> 20
2403
        ));
2404
    }
7fff30c4 Andy McCall ↶ 2405
    let text = String::from_utf8(bytes.to_vec())
17dc8de4 Andy McCall ↶ 2406
        .map_err(|_| "coverage: the report is not text (LCOV, Cobertura XML or JaCoCo XML is expected)".to_string())?;
7fff30c4 Andy McCall ↶ 2407
    let (files, outside, format) = tokio::task::spawn_blocking(move || crate::coverage::parse(&text))
554ccacf Andy McCall ↶ 2408
        .await
2409
        .map_err(|e| format!("coverage: {e}"))?
2410
        .map_err(|e| format!("coverage: {e}"))?;
2411
    let heads: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
2412
    let in_state: std::collections::HashSet<String> = app
2413
        .repos
2414
        .read(repo, move |r, cache| Ok(cache.load(r, &heads)?.snapshot.files.keys().cloned().collect()))
2415
        .await
2416
        .map_err(|e| format!("coverage: the run's files could not be read: {e}"))?;
2417
    let heads: Vec<String> = run.head_list().into_iter().map(String::from).collect();
2418
    let origin = crate::coverage::Origin {
2419
        repo_id: row.id,
40dd3f86 Andy McCall ↶ 2420
        run_id: Some(run.id),
554ccacf Andy McCall ↶ 2421
        run_number: run.number,
40dd3f86 Andy McCall ↶ 2422
        job_id: Some(job.id),
2423
        uploader: "",
554ccacf Andy McCall ↶ 2424
        job: &job.name,
2425
        bookmark: &run.bookmark,
2426
        state: &run.state,
2427
        heads: &heads,
2428
        blob,
7fff30c4 Andy McCall ↶ 2429
        format,
554ccacf Andy McCall ↶ 2430
    };
2431
    let id = crate::coverage::keep(app, &origin, files, outside, &in_state).await.map_err(|e| format!("coverage: {e}"))?;
2432
    let Some(r) = crate::coverage::report(&app.db, row.id, id).await.map_err(|e| format!("coverage: {e}"))? else {
2433
        return Err("coverage: the report was not kept".into());
2434
    };
7edaff01 Andy McCall ↶ 2435
    // The `coverage` check on the run's state (#113): against the default
2436
    // bookmark, under the repository's rules.
2437
    let base = crate::coverage::baseline(&app.db, &r, &row.default_bookmark).await.map_err(|e| format!("coverage: {e}"))?;
2438
    let rules = crate::coverage::rules(&app.db, row.id).await.map_err(|e| format!("coverage: {e}"))?;
2439
    let (status, summary) = crate::coverage::verdict(&r, base.as_ref(), &row.default_bookmark, rules);
2440
    let url = format!("{}/{}/{}/coverage?report={}", app.config.base_url(), row.owner, row.name, r.id);
2441
    if let Ok(c) = db::hooks::upsert_check(
2442
        &app.db,
2443
        row.id,
2444
        db::hooks::CheckReport { state: &run.state, name: "coverage", status, summary: &summary, url: &url, reporter: None, seal: "" },
2445
    )
2446
    .await
2447
    {
2448
        let api = crate::api::check_of(&c);
33d98147 Andy McCall 2449
        app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
7edaff01 Andy McCall ↶ 2450
        crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
2451
    }
554ccacf Andy McCall ↶ 2452
    let pct = r.percent().map(|p| format!("{p:.1}%")).unwrap_or_else(|| "no lines".into());
2453
    let dropped =
2454
        if r.dropped > 0 { format!(" ({} named files are not in this state and were left out)", r.dropped) } else { String::new() };
2455
    Ok(format!("coverage: {pct} of lines ({} of {}) in {} files{dropped}", r.lines_hit, r.lines_found, r.files))
a3c8288b Andy McCall ↶ 2456
}
2457
42fa9554 Andy McCall ↶ 2458
/// `POST /api/v1/flow/jobs/{id}/finish`.
2459
pub async fn finish(
2460
    State(app): State<Shared>,
2461
    headers: HeaderMap,
2462
    Path(id): Path<i64>,
2463
    Json(f): Json<Finish>,
2464
) -> Result<StatusCode, ApiError> {
b6b7e4cf Andy McCall ↶ 2465
    let me = runner_auth(&app, &headers).await?;
42fa9554 Andy McCall ↶ 2466
    let job = running_job(&app, id).await?;
d94449e4 Andy McCall ↶ 2467
    db::runners::seen(&app.db, me.id, None, None).await?;
42fa9554 Andy McCall ↶ 2468
    let status = match (f.exit_code, &f.error) {
2469
        (Some(0), None) => "passed",
2470
        (Some(_), _) => "failed",
2471
        (None, _) => "error",
2472
    };
2473
    let (receipt, receipt_hash) = match &f.receipt {
2474
        Some(r) if r.job_name == job.name && Some(r.exit_code as i32) == f.exit_code => {
d29070fa Andy McCall ↶ 2475
            // A passing job's receipt names exactly the artifacts uploaded,
2476
            // in name order; a failing one's names none, though it may have
2477
            // kept `when "always"` artifacts (oxygenflow#37).
2478
            let kept: Vec<String> =
2479
                if r.exit_code == 0 { fdb::artifacts(&app.db, job.id).await?.into_iter().map(|a| a.blob).collect() } else { vec![] };
a3c8288b Andy McCall ↶ 2480
            if r.outputs.iter().map(hex::encode).collect::<Vec<_>>() != kept {
2481
                return Err(ApiError(StatusCode::BAD_REQUEST, "the receipt names other outputs than the artifacts uploaded".into()));
2482
            }
42fa9554 Andy McCall ↶ 2483
            (serde_json::to_string(r).unwrap_or_default(), hex::encode(r.hash()))
2484
        }
2485
        Some(_) => return Err(ApiError(StatusCode::BAD_REQUEST, "the receipt does not match the job".into())),
2486
        None => (String::new(), String::new()),
2487
    };
2488
    let error = f.error.clone().unwrap_or_default();
44a3d2eb Andy McCall ↶ 2489
    fdb::set_peaks(&app.db, job.id, f.peak_disk_mib, f.peak_memory_mib).await?;
42fa9554 Andy McCall ↶ 2490
    let changed = fdb::finish(
2491
        &app.db,
2492
        job.id,
2493
        fdb::Outcome { status, exit_code: f.exit_code.map(i64::from), error: &error, receipt: &receipt, receipt_hash: &receipt_hash },
2494
    )
2495
    .await?;
2496
    if let Some(run) = fdb::run_by_id(&app.db, job.run_id).await? {
2497
        if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
cc19697f Andy McCall ↶ 2498
            if let (Some(r), Some(signed)) = (&f.receipt, &f.signed_receipt) {
b6b7e4cf Andy McCall ↶ 2499
                let (attest, signer, note) = match keep_receipt(&app, &me, &row, &run, r, signed).await {
cc19697f Andy McCall ↶ 2500
                    Ok((attest, signer)) => (attest, signer, String::new()),
2501
                    Err(e) => {
2502
                        tracing::warn!("flow: job {} receipt not kept: {e}", job.id);
2503
                        (String::new(), String::new(), e)
2504
                    }
2505
                };
2506
                fdb::set_receipt(&app.db, job.id, &attest, &signer, &note).await?;
2507
            }
42fa9554 Andy McCall ↶ 2508
        }
2509
    }
070a7b64 Andy McCall ↶ 2510
    report_changed(&app, job.run_id, changed).await?;
42fa9554 Andy McCall ↶ 2511
    Ok(StatusCode::NO_CONTENT)
070a7b64 Andy McCall ↶ 2512
}
2513
2514
/// Report the checks of jobs whose status changed.
2515
async fn report_changed(app: &Shared, run_id: i64, changed: Vec<fdb::Job>) -> sqlx::Result<()> {
2516
    let Some(run) = fdb::run_by_id(&app.db, run_id).await? else {
2517
        return Ok(());
2518
    };
2519
    let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? else {
2520
        return Ok(());
2521
    };
4a4400c5 Andy McCall ↶ 2522
    let mut errored_on: Vec<i64> = Vec::new();
dc59d1b5 Andy McCall ↶ 2523
    let some_passed = changed.iter().any(|j| j.status == "passed");
7e01a766 Andy McCall ↶ 2524
    if !changed.is_empty() {
33d98147 Andy McCall 2525
        app.bus.live(&crate::events::topic::run(run_id), "jobs");
7e01a766 Andy McCall ↶ 2526
    }
070a7b64 Andy McCall ↶ 2527
    for j in changed {
2528
        let summary = match j.status.as_str() {
5588bb36 Andy McCall ↶ 2529
            "passed" => match j.reused_from() {
2530
                Some(n) => format!("passed in run #{n} on this state, reused"),
2531
                None => format!("passed in {}", duration(&j)),
2532
            },
070a7b64 Andy McCall ↶ 2533
            "failed" => format!("exit {} after {}", j.exit_code.unwrap_or(-1), duration(&j)),
2534
            "skipped" => "skipped: a dependency did not pass".into(),
745d225d Andy McCall ↶ 2535
            "cancelled" => j.error.clone(),
070a7b64 Andy McCall ↶ 2536
            _ => format!("could not run: {}", j.error),
2537
        };
2538
        report_check(app, &row, &run.state, run.number, &j.name, check_status(&j.status), &summary).await;
4a4400c5 Andy McCall ↶ 2539
        if j.status == "error" {
2540
            if let Some(r) = runner_of(app, j.id).await {
2541
                errored_on.push(r);
2542
            }
2543
        }
2544
    }
2545
    errored_on.dedup();
2546
    for r in errored_on {
2547
        drain_if_erroring(app, r).await;
dc59d1b5 Andy McCall ↶ 2548
    }
2549
    if some_passed {
2550
        tell_approvers(app, &row, &run).await;
4a4400c5 Andy McCall ↶ 2551
    }
2552
    if let Some(done) = fdb::run_by_id(&app.db, run_id).await? {
2553
        if done.status == "failed" && !done.live() {
2554
            tell_failed(app, &row, &done).await;
2555
        }
bff9106e Andy McCall ↶ 2556
        // A pass after a failure on the same bookmark: fixed (#183).
2557
        if done.status == "passed" {
2558
            let before: Option<String> = sqlx::query_scalar(
5d90e0e0 Andy McCall 2559
                "SELECT status FROM flow_runs WHERE repo_id = $1 AND bookmark = $2 AND id < $3 AND status IN ('passed', 'failed')
bff9106e Andy McCall ↶ 2560
                 ORDER BY id DESC LIMIT 1",
2561
            )
2562
            .bind(done.repo_id)
2563
            .bind(&done.bookmark)
2564
            .bind(done.id)
2565
            .fetch_optional(&app.db)
2566
            .await?;
2567
            // Or this very run failed and a job of it was run again.
2568
            let url = format!("/{}/{}/flow/{}", row.owner, row.name, done.number);
5d90e0e0 Andy McCall 2569
            let failed_here: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM notifications WHERE kind = 'flow.failed' AND url = $1")
bff9106e Andy McCall ↶ 2570
                .bind(&url)
2571
                .fetch_one(&app.db)
2572
                .await?;
2573
            if before.as_deref() == Some("failed") || failed_here > 0 {
2574
                tell_fixed(app, &row, &done).await;
2575
            }
2576
        }
070a7b64 Andy McCall ↶ 2577
    }
a7e6e8e6 Andy McCall ↶ 2578
    // A passing run of an upstream's default bookmark: consumers following
2579
    // it when green are bumped (Diffusion, #148).
2580
    if let Some(done) = fdb::run_by_id(&app.db, run_id).await? {
2581
        if done.status == "passed" && done.bookmark == row.default_bookmark {
2582
            let heads: Vec<ChangeHash> = done.head_list().iter().filter_map(|h| ChangeHash::from_hex(h)).collect();
2583
            let (app, row) = (app.clone(), row.clone());
2584
            tokio::spawn(async move { crate::diffusion::propagate(&app, &row, heads, true).await });
2585
        }
f4d6ef41 Andy McCall ↶ 2586
        // A bump's run passed: a consumer that lands its bumps itself may
2587
        // land it now (docs/diffusion.md §4.2).
2588
        if let Some(path) = done.bookmark.strip_prefix("diffusion/").filter(|_| done.status == "passed") {
2589
            tokio::spawn(crate::diffusion::try_land(app.clone(), row.clone(), path.to_string()));
2590
        }
a7e6e8e6 Andy McCall ↶ 2591
    }
070a7b64 Andy McCall ↶ 2592
    Ok(())
4a4400c5 Andy McCall ↶ 2593
}
2594
2595
/// The account OxygenFlow's notices come from, made on first use with no
2596
/// way to sign in.
2597
pub const ACCOUNT: &str = "oxygenflow";
2598
2599
async fn flow_account(pool: &db::Pool) -> Option<db::accounts::Account> {
2600
    if let Ok(Some(a)) = db::accounts::account_by_name(pool, ACCOUNT).await {
2601
        return Some(a);
2602
    }
2603
    db::accounts::create_account(pool, ACCOUNT, "oxygenflow@localhost", "!", "", false).await.ok()
2604
}
2605
2606
async fn runner_of(app: &Shared, job_id: i64) -> Option<i64> {
5d90e0e0 Andy McCall 2607
    sqlx::query_scalar("SELECT runner_id FROM flow_jobs WHERE id = $1").bind(job_id).fetch_optional(&app.db).await.ok().flatten().flatten()
4a4400c5 Andy McCall ↶ 2608
}
2609
2610
/// A failed run (oxygenflow#30): its pusher and the repository's watchers
2611
/// are told, in their inboxes and by email as they chose, naming the jobs
2612
/// that did not pass.
2613
async fn tell_failed(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run) {
2614
    let Some(me) = flow_account(&app.db).await else { return };
2615
    let jobs = fdb::jobs(&app.db, run.id).await.unwrap_or_default();
2616
    let broken: Vec<String> = jobs.iter().filter(|j| matches!(j.status.as_str(), "failed" | "error")).map(|j| j.name.clone()).collect();
2617
    let pusher = db::accounts::account_by_name(&app.db, &run.actor).await.ok().flatten();
2618
    let on = if run.bookmark.is_empty() { String::new() } else { format!(" on {}", run.bookmark) };
2619
    crate::notify::deliver(
2620
        app,
2621
        crate::notify::Event {
2622
            kind: "flow.failed",
2623
            title: format!("{}/{}: run #{}{on} failed ({})", row.owner, row.name, run.number, broken.join(", ")),
bff9106e Andy McCall ↶ 2624
            url: format!("/{}/{}/flow/{}", row.owner, row.name, run.number),
2625
            actor: &me,
2626
            repo_id: row.id,
2627
            thread: None,
2628
            mention_text: "",
2629
            direct: pusher.into_iter().map(|a| a.id).collect(),
2630
        },
2631
    )
2632
    .await;
2633
}
2634
2635
/// A run that passes after its bookmark's last one failed (oxygenhub#183):
2636
/// its pusher and the repository's watchers hear it is green again.
2637
async fn tell_fixed(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run) {
2638
    let Some(me) = flow_account(&app.db).await else { return };
2639
    let pusher = db::accounts::account_by_name(&app.db, &run.actor).await.ok().flatten();
2640
    let on = if run.bookmark.is_empty() { String::new() } else { format!(" on {}", run.bookmark) };
2641
    crate::notify::deliver(
2642
        app,
2643
        crate::notify::Event {
2644
            kind: "flow.fixed",
2645
            title: format!("{}/{}: run #{}{on} passed: fixed", row.owner, row.name, run.number),
4a4400c5 Andy McCall ↶ 2646
            url: format!("/{}/{}/flow/{}", row.owner, row.name, run.number),
2647
            actor: &me,
2648
            repo_id: row.id,
2649
            thread: None,
2650
            mention_text: "",
2651
            direct: pusher.into_iter().map(|a| a.id).collect(),
2652
        },
2653
    )
2654
    .await;
2655
}
2656
2657
/// A runner whose last jobs all ended in infrastructure errors is drained,
2658
/// so it stops taking jobs it fails before running them, and the
2659
/// administrators are told (oxygenflow#30).
2660
async fn drain_if_erroring(app: &Shared, runner_id: i64) {
2661
    let n = app.config.flow.drain_after_errors;
2662
    let Ok(Some(last)) = db::runners::erroring(&app.db, runner_id, n).await else { return };
2663
    let Ok(Some(r)) = db::runners::get(&app.db, runner_id).await else { return };
2664
    if r.state != "active" || db::runners::set_state(&app.db, runner_id, "draining").await.is_err() {
2665
        return;
2666
    }
2667
    tracing::warn!("flow: runner {} drained after {n} errors in a row (last: {last})", r.name);
2668
    let Some(me) = flow_account(&app.db).await else { return };
ea14c4ec Andy McCall ↶ 2669
    let admins: Vec<i64> = sqlx::query_scalar("SELECT id FROM accounts WHERE is_admin = TRUE").fetch_all(&app.db).await.unwrap_or_default();
4a4400c5 Andy McCall ↶ 2670
    crate::notify::deliver(
2671
        app,
2672
        crate::notify::Event {
2673
            kind: "flow.runner_drained",
2674
            title: format!("Runner {} drained: its last {n} jobs ended in errors (last: {last})", r.name),
2675
            url: format!("/admin/runners/{runner_id}"),
2676
            actor: &me,
2677
            repo_id: 0,
2678
            thread: None,
2679
            mention_text: "",
2680
            direct: admins,
2681
        },
2682
    )
2683
    .await;
070a7b64 Andy McCall ↶ 2684
}
2685
5dead1f4 Andy McCall ↶ 2686
/// The site's job time limits (oxygenhub#89): set on Admin → Runners →
2687
/// Settings, else from `hub.toml`.
2688
pub struct Limits {
2689
    /// For a job whose pipeline names none.
2690
    pub default_s: u64,
2691
    /// The most a pipeline may ask for.
2692
    pub max_s: u64,
2693
    /// Grace past a job's limit before the hub gives it up: a runner stops
2694
    /// a job at its limit and reports it within moments, so one still
2695
    /// running this long after is one the runner no longer reports (it was
2696
    /// restarted, or lost the hub while the job ended, oxygenhub#71).
2697
    pub grace_ms: i64,
2698
}
2699
2700
pub const SETTING_DEFAULT: &str = "flow.job_timeout_minutes";
2701
pub const SETTING_MAX: &str = "flow.job_timeout_max_minutes";
2702
pub const SETTING_GRACE: &str = "flow.lost_grace_minutes";
2703
2704
pub async fn limits(app: &Shared) -> Limits {
2705
    let minutes = |key: &'static str| async move {
2706
        db::accounts::setting(&app.db, key).await.ok().flatten().and_then(|v| v.parse::<u64>().ok()).filter(|m| *m > 0)
2707
    };
2708
    let default_m = minutes(SETTING_DEFAULT).await.unwrap_or(app.config.flow.job_timeout_minutes.max(1));
2709
    let max_m = minutes(SETTING_MAX).await.unwrap_or(default_m.max(6 * 60)).max(default_m);
2710
    let grace_m = minutes(SETTING_GRACE).await.unwrap_or(5);
2711
    Limits { default_s: default_m * 60, max_s: max_m * 60, grace_ms: grace_m as i64 * 60_000 }
2712
}
070a7b64 Andy McCall ↶ 2713
5dead1f4 Andy McCall ↶ 2714
/// End every job still running past its time limit plus the grace:
070a7b64 Andy McCall ↶ 2715
/// it is marked an error with the reason, the jobs that depended on it are
2716
/// skipped and its run settled, as when a runner reports an error.
2717
pub async fn reap_lost_jobs(app: &Shared) -> sqlx::Result<usize> {
5dead1f4 Andy McCall ↶ 2718
    let limits = limits(app).await;
2719
    let lost = fdb::running_past_limit(&app.db, db::now_ms(), limits.default_s, limits.grace_ms).await?;
070a7b64 Andy McCall ↶ 2720
    let n = lost.len();
2721
    for job in lost {
2722
        let error = format!(
2723
            "lost: still running {} minutes after it started, past the time limit; the runner{} stopped reporting it",
2724
            (db::now_ms() - job.started_ms.unwrap_or(0)) / 60_000,
2725
            if job.runner.is_empty() { String::new() } else { format!(" {}", job.runner) },
2726
        );
2727
        let changed =
2728
            fdb::finish(&app.db, job.id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
2729
                .await?;
2730
        tracing::warn!("flow: job {} {error}", job.id);
2731
        report_changed(app, job.run_id, changed).await?;
2732
    }
2733
    Ok(n)
eef677c4 Andy McCall ↶ 2734
}
2735
2736
/// End the jobs running on `runner` that it does not hold (oxygenhub#71):
2737
/// it restarted since claiming them, or never received the claim. A
2738
/// runner claims one job at a time, so a job it holds is always listed.
2739
async fn end_jobs_not_held(app: &Shared, runner: &db::runners::Runner, holding: &[i64]) -> sqlx::Result<()> {
2740
    for job in fdb::running_on(&app.db, runner.id).await? {
2741
        if holding.contains(&job.id) {
2742
            continue;
2743
        }
2744
        let error = format!("lost: the runner {} no longer holds this job (it restarted, or never received it)", runner.name);
2745
        let changed =
2746
            fdb::finish(&app.db, job.id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
2747
                .await?;
2748
        tracing::warn!("flow: job {} {error}", job.id);
2749
        report_changed(app, job.run_id, changed).await?;
2750
    }
2751
    Ok(())
348f8c4b Andy McCall ↶ 2752
}
2753
2754
/// Start the scheduled runs due at `when` (oxygenflow#24): on each
2755
/// repository that runs Flow, the jobs of its default bookmark's pipeline
2756
/// with a `schedule` line due then. Returns how many runs started.
2757
pub async fn run_due(app: &Shared, when: flow_core::pipeline::When) -> usize {
2758
    let Ok(rows) = db::repos::list(&app.db).await else { return 0 };
2759
    let mut started = 0;
2760
    for row in rows.into_iter().filter(|r| enabled(app, r)) {
2761
        let Some(repo) = RepoName::new(&row.owner, &row.name) else { continue };
2762
        let b = row.default_bookmark.clone();
2763
        let found = app
2764
            .repos
2765
            .read(&repo, move |r, _| {
2766
                let Some(st) = r.view()?.bookmarks.get(&b).copied() else { return Ok(None) };
2767
                Ok(Some((st, r.store().get_state(&st)?.heads)))
2768
            })
2769
            .await;
2770
        let Ok(Some((state, heads))) = found else { continue };
2771
        if heads.is_empty() {
2772
            continue;
2773
        }
0650d94e Andy McCall ↶ 2774
        match start_run_at(app, &row, &row.default_bookmark, &state.to_hex(), &heads, &row.owner, "schedule", None, Some(when), &[]).await {
348f8c4b Andy McCall ↶ 2775
            Ok(Some(_)) => started += 1,
2776
            Ok(None) => {}
2777
            Err(e) => tracing::warn!("flow: scheduled run of {}/{}: {e}", row.owner, row.name),
2778
        }
2779
    }
2780
    started
2781
}
2782
2783
/// The hub's clock as a [`When`](flow_core::pipeline::When).
2784
pub fn when_now() -> flow_core::pipeline::When {
2785
    let now = time::OffsetDateTime::now_utc();
2786
    flow_core::pipeline::When {
2787
        minute: now.minute() as u32,
2788
        hour: now.hour() as u32,
2789
        day: now.day() as u32,
2790
        month: u8::from(now.month()) as u32,
2791
        weekday: now.weekday().number_days_from_sunday() as u32,
2792
    }
2793
}
2794
2795
/// Start the scheduled runs due each minute, once a minute.
2796
pub async fn scheduler(app: Shared) {
2797
    let mut last = None;
2798
    loop {
2799
        tokio::time::sleep(std::time::Duration::from_secs(15)).await;
2800
        let minute = time::OffsetDateTime::now_utc().unix_timestamp() / 60;
2801
        if last == Some(minute) {
2802
            continue;
2803
        }
2804
        last = Some(minute);
2805
        let n = run_due(&app, when_now()).await;
2806
        if n > 0 {
2807
            tracing::info!("flow: {n} scheduled run(s) started");
2808
        }
2809
    }
070a7b64 Andy McCall ↶ 2810
}
2811
2812
/// Look for lost jobs once a minute.
2813
pub async fn reaper(app: Shared) {
2814
    loop {
2815
        tokio::time::sleep(std::time::Duration::from_secs(60)).await;
ab4df6aa Andy McCall ↶ 2816
        if let Err(e) = requeue_lapsed(&app).await {
2817
            tracing::warn!("flow: looking for lapsed leases: {e}");
2818
        }
070a7b64 Andy McCall ↶ 2819
        if let Err(e) = reap_lost_jobs(&app).await {
2820
            tracing::warn!("flow: looking for lost jobs: {e}");
417184c7 Andy McCall ↶ 2821
        }
2822
        match expire_approvals(&app, db::now_ms()).await {
2823
            Ok(n) if n > 0 => tracing::info!("flow: {n} approvals expired"),
2824
            Ok(_) => {}
2825
            Err(e) => tracing::warn!("flow: expiring approvals: {e}"),
070a7b64 Andy McCall ↶ 2826
        }
2827
    }
cc19697f Andy McCall ↶ 2828
}
2829
2830
/// Check a runner's signed receipt for a job of `run` and keep it in the
2831
/// repository (Oxygen spec §14.6): the attestation's hex and the runner's
2832
/// name, or why it was not kept. It must be the job's receipt, for the
2833
/// run's state and repository, signed by the key the runner's token first
2834
/// signed with.
2835
pub async fn keep_receipt(
2836
    app: &Shared,
b6b7e4cf Andy McCall ↶ 2837
    runner: &db::runners::Runner,
cc19697f Andy McCall ↶ 2838
    row: &db::repos::RepoRow,
2839
    run: &fdb::Run,
2840
    receipt: &flow_core::Receipt,
2841
    signed_hex: &str,
2842
) -> Result<(String, String), String> {
2843
    use oxy_core::receipt::SignedReceipt;
2844
    let bytes = hex::decode(signed_hex).map_err(|_| "the signed receipt is not hex".to_string())?;
2845
    let sr = SignedReceipt::decode(&bytes).map_err(|e| format!("not a signed receipt: {e}"))?;
2846
    sr.verify().map_err(|e| format!("it does not verify: {e}"))?;
2847
    if sr.receipt.hash().0 != receipt.hash() {
2848
        return Err("it signs another receipt than the job's".into());
2849
    }
2850
    let heads: Vec<oxy_core::hash::ChangeHash> = run.head_list().into_iter().filter_map(oxy_core::hash::ChangeHash::from_hex).collect();
2851
    let state = oxy_core::hash::hash_object(oxy_core::hash::ObjectType::State, &oxy_core::objects::StateObject::new(heads).encode());
2852
    if sr.state() != state {
2853
        return Err("it is for another state than the run's".into());
2854
    }
2c31915f Andy McCall ↶ 2855
    let signer = match &sr.certificate {
2856
        // Signed by a short-lived key this hub certified for this job
2857
        // (keyless, #241): the certificate stands for the runner's key.
2858
        Some(c) => {
2859
            let cert = &c.cert.cert;
2860
            if cert.issuer != app.hub_key.key || c.issuer.hash() != app.hub_key.key {
2861
                return Err("its certificate was not issued by this hub".into());
2862
            }
2863
            let subject = format!("repo:{}/{}:bookmark:{}", row.owner, row.name, run.bookmark);
2864
            if cert.subject != subject {
2865
                return Err(format!("its certificate is for {}, not {subject}", cert.subject));
2866
            }
2867
            if cert.claim("run") != Some(run.number.to_string().as_str()) || cert.claim("job") != Some(sr.receipt.job_name.as_str()) {
2868
                return Err("its certificate is for another run or job".into());
2869
            }
2870
            // Now is when this hub accepts it: a time the runner did not choose.
2871
            if !cert.covers(oxy_core::identity::Scope::SEAL, db::now_ms() as u64) {
2872
                return Err("its certificate does not cover now: certify the key just before signing the receipt".into());
2873
            }
2874
            format!("{} (short-lived key)", runner.name)
2875
        }
2876
        None => {
2877
            let key = sr.runner.hash().to_hex();
2878
            let bound = db::runners::bind_key(&app.db, runner.id, &key, &sr.runner.name).await.map_err(|e| e.to_string())?;
2879
            if bound != key {
2880
                return Err(format!("signed by {}, not the key this runner signs with ({})", &key[..12], &bound[..12.min(bound.len())]));
2881
            }
2882
            sr.runner.name.clone()
2883
        }
2884
    };
cc19697f Andy McCall ↶ 2885
    let name = RepoName::new(&row.owner, &row.name).ok_or("bad repository name")?;
965b950f Andy McCall ↶ 2886
    let (rid, signers) = (sr.attest.repo, sr.sigs.iter().map(|s| s.key).collect::<Vec<_>>());
2887
    let cert = sr.certificate.as_ref().map(|c| (c.cert.cert.hash(), c.cert.cert.issuer));
cc19697f Andy McCall ↶ 2888
    let attest = app.repos.write(&name, move |repo, _| Ok(repo.add_receipt(&sr)?)).await.map_err(|e| e.to_string())?;
965b950f Andy McCall ↶ 2889
    // The transparency log (#238): the receipt, and a short-lived key's
2890
    // certificate beside it.
2891
    let mut entries = vec![crate::tlog::Pending { kind: "receipt", repo: rid, repo_row: Some(row.id), object: attest, signers }];
2892
    if let Some((c, issuer)) = cert {
2893
        entries.push(crate::tlog::Pending { kind: "certificate", repo: rid, repo_row: Some(row.id), object: c, signers: vec![issuer] });
2894
    }
2895
    crate::tlog::log(app, entries).await;
cc19697f Andy McCall ↶ 2896
    Ok((attest.to_hex(), signer))
42fa9554 Andy McCall ↶ 2897
}
2898
2899
/// A job's wall time, as the pages show it.
2900
pub fn duration(j: &fdb::Job) -> String {
2901
    match (j.started_ms, j.finished_ms) {
2902
        (Some(a), Some(b)) => human_ms(b - a),
2903
        (Some(a), None) => human_ms(db::now_ms() - a),
2904
        _ => "–".into(),
2905
    }
2906
}
2907
2908
pub fn human_ms(ms: i64) -> String {
2909
    let ms = ms.max(0);
2910
    if ms < 1000 {
2911
        format!("{ms} ms")
2912
    } else if ms < 60_000 {
2913
        format!("{:.1} s", ms as f64 / 1000.0)
2914
    } else {
2915
        format!("{} min {} s", ms / 60_000, (ms % 60_000) / 1000)
2916
    }
2917
}
bf3d0754 Andy McCall ↶ 2918
2919
/// Where a live run stands among the runners' work: what its viewers may
2920
/// know of it. Jobs of other repositories are named only when those are
2921
/// public; the rest are counted.
2922
#[derive(Clone, Debug, Default, PartialEq, Eq)]
2923
pub struct QueueInfo {
2924
    /// 1-based place of the run's first queued job among all queued jobs.
2925
    pub position: Option<usize>,
2926
    /// Jobs running now, and queued jobs ahead of the run's first one.
2927
    pub running: Vec<String>,
2928
    pub ahead: Vec<String>,
2929
    /// Of those, jobs in repositories the page may not name.
2930
    pub hidden: usize,
2931
}
2932
2933
impl QueueInfo {
2934
    /// "3rd in line" and the like.
2935
    pub fn place(&self) -> Option<String> {
2936
        self.position.map(|n| {
2937
            let suffix = match (n % 10, n % 100) {
2938
                (1, 11) | (2, 12) | (3, 13) => "th",
2939
                (1, _) => "st",
2940
                (2, _) => "nd",
2941
                (3, _) => "rd",
2942
                _ => "th",
2943
            };
2944
            format!("{n}{suffix} in line")
2945
        })
2946
    }
2947
}
2948
2949
/// The queue as `run` (of repository `repo_id`) sees it, from `queue`.
2950
pub fn queue_info(queue: &[fdb::QueueEntry], repo_id: i64, run_id: i64) -> QueueInfo {
2951
    let mut info = QueueInfo::default();
2952
    let first = queue.iter().filter(|e| e.status == "queued").position(|e| e.run_id == run_id);
2953
    info.position = first.map(|i| i + 1);
2954
    let label = |e: &fdb::QueueEntry| format!("{}/{} #{} {}", e.owner, e.name, e.run_number, e.job);
2955
    let mut queued_seen = 0;
2956
    for e in queue {
2957
        if e.run_id == run_id {
2958
            continue;
2959
        }
2960
        let ahead = match e.status.as_str() {
2961
            "running" => true,
2962
            _ => {
2963
                queued_seen += 1;
2964
                first.is_some_and(|f| queued_seen <= f)
2965
            }
2966
        };
2967
        if !ahead {
2968
            continue;
2969
        }
2970
        if e.repo_id != repo_id && e.visibility != "public" {
2971
            info.hidden += 1;
2972
        } else if e.status == "running" {
2973
            info.running.push(label(e));
2974
        } else {
2975
            info.ahead.push(label(e));
2976
        }
2977
    }
2978
    info
2979
}
2980
2981
#[cfg(test)]
2982
mod queue_tests {
2983
    use super::*;
2984
2985
    fn e(job_id: i64, run_id: i64, repo_id: i64, vis: &str, job: &str, status: &str) -> fdb::QueueEntry {
2986
        fdb::QueueEntry {
2987
            job_id,
2988
            run_id,
2989
            repo_id,
2990
            owner: "o".into(),
2991
            name: format!("r{repo_id}"),
2992
            visibility: vis.into(),
2993
            run_number: run_id,
2994
            job: job.into(),
2995
            status: status.into(),
b66e70b7 Andy McCall ↶ 2996
            runner: String::new(),
c4c87f48 Andy McCall ↶ 2997
            spec: String::new(),
2998
            sandbox: String::new(),
e9b9619c Andy McCall ↶ 2999
            started_ms: None,
107eaba5 Andy McCall ↶ 3000
            priority_rank: 2,
3001
            priority_note: String::new(),
bf3d0754 Andy McCall ↶ 3002
        }
3003
    }
3004
3005
    #[test]
3006
    fn a_run_learns_its_place_and_what_is_ahead_of_it() {
3007
        // Running first, then queued in claim order (as `fdb::queue` returns them).
3008
        let q = vec![
3009
            e(1, 10, 1, "public", "build", "running"),
3010
            e(2, 11, 2, "private", "test", "running"),
3011
            e(3, 10, 1, "public", "test", "queued"),
3012
            e(4, 12, 3, "private", "lint", "queued"),
3013
            e(5, 13, 4, "public", "build", "queued"),
3014
            e(6, 13, 4, "public", "test", "queued"),
3015
            e(7, 14, 5, "public", "late", "queued"),
3016
        ];
3017
        let info = queue_info(&q, 4, 13);
3018
        assert_eq!(info.position, Some(3));
3019
        assert_eq!(info.place().as_deref(), Some("3rd in line"));
3020
        assert_eq!(info.running, ["o/r1 #10 build"]);
3021
        assert_eq!(info.ahead, ["o/r1 #10 test"], "queued ahead, not behind");
3022
        assert_eq!(info.hidden, 2, "private repositories are counted, not named");
3023
        // A private repository's own jobs are named to its viewers.
3024
        assert_eq!(queue_info(&q, 3, 12).ahead, ["o/r1 #10 test"]);
3025
        assert_eq!(queue_info(&q, 3, 12).position, Some(2));
3026
        // A run with nothing queued has no place.
3027
        assert_eq!(queue_info(&q, 1, 99).position, None);
3028
        let ordinal = |n| QueueInfo { position: Some(n), ..Default::default() }.place().unwrap();
3029
        assert_eq!(
3030
            [ordinal(1), ordinal(2), ordinal(11), ordinal(22), ordinal(113)],
3031
            ["1st in line", "2nd in line", "11th in line", "22nd in line", "113th in line"]
4d2e44d7 Andy McCall ↶ 3032
        );
3033
    }
3034
}
3035
3036
#[cfg(test)]
3037
mod placement_tests {
3038
    use super::*;
3039
3040
    #[test]
3041
    fn a_waiting_job_says_what_each_runner_lacks() {
3042
        use crate::db::runners::Runner;
3043
        let rootfs = "ab".repeat(32);
3044
        let job = fdb::Job {
3045
            id: 7,
3046
            runtime: "syscall".into(),
3047
            sandbox: serde_json::json!({ "rootfs": rootfs, "memory_mib": 4096, "cpus": 2 }).to_string(),
3048
            spec: serde_json::json!({ "name": "build" }).to_string(),
3049
            ..Default::default()
3050
        };
3051
        let now = db::now_ms();
3052
        let runner = |id: i64, name: &str| Runner {
3053
            id,
3054
            name: name.into(),
3055
            state: "active".into(),
3056
            last_seen_ms: Some(now),
3057
            arch: "x86_64".into(),
3058
            tiers: "microvm,syscall".into(),
3059
            images: serde_json::to_string(&[&rootfs]).unwrap(),
3060
            memory_mib: Some(16384),
3061
            cpus: Some(8),
3062
            ..Default::default()
3063
        };
3064
        let archs = std::collections::HashMap::new();
92a797b2 Andy McCall ↶ 3065
        let why = |runners: &[Runner], declines: &[fdb::DeclineRow]| {
3066
            why_waiting(&job, "andy", 1, runners, &archs, declines, now, &Default::default())
3067
        };
4d2e44d7 Andy McCall ↶ 3068
        assert_eq!(why(&[], &[]), "no runner is online");
3069
        assert_eq!(why(&[runner(1, "earth-1")], &[]), "", "one can take it: it only waits its turn");
3070
        let microvm_only = Runner { tiers: "microvm".into(), ..runner(1, "earth-1") };
3071
        let riscv = Runner { arch: "riscv64".into(), ..runner(2, "narvi") };
3072
        let small = Runner { memory_mib: Some(2048), ..runner(3, "pi") };
3073
        let other = Runner { scope_owner: "bob".into(), ..runner(4, "bobs") };
3074
        let offline = Runner { last_seen_ms: Some(now - 3_600_000), ..runner(5, "gone") };
3075
        assert_eq!(
3076
            why(&[microvm_only, small, other, offline], &[]),
3077
            "no runner can take it: earth-1 has no syscall tier (it offers microvm); pi has 2048 MiB; the job needs 4096 MiB; bobs serves other repositories"
3078
        );
3079
        let archs_known: std::collections::HashMap<String, String> = [(rootfs.clone(), "x86_64".to_string())].into();
3080
        assert_eq!(
92a797b2 Andy McCall ↶ 3081
            why_waiting(&job, "andy", 1, &[riscv], &archs_known, &[], now, &Default::default()),
4d2e44d7 Andy McCall ↶ 3082
            "no runner can take it: narvi is riscv64; the job needs x86_64"
3083
        );
3084
        let without = Runner { images: "[]".into(), ..runner(6, "new") };
56b8dbe6 Andy McCall ↶ 3085
        assert_eq!(why(std::slice::from_ref(&without), &[]), "no runner can take it: new does not hold image abababababab");
3086
        // A WASM job has no image: holding none is no reason to wait.
3087
        let wasm = fdb::Job { runtime: "wasm".into(), sandbox: r#"{"memory_mib":256}"#.into(), ..job.clone() };
3088
        let wasm_runner = Runner { tiers: "microvm,wasm".into(), ..without };
3089
        assert_eq!(why_waiting(&wasm, "andy", 1, &[wasm_runner], &archs, &[], now, &Default::default()), "", "it only waits its turn");
4d2e44d7 Andy McCall ↶ 3090
        let d = fdb::DeclineRow {
3091
            job_id: 7,
3092
            runner_id: 1,
3093
            runner: "earth-1".into(),
3094
            reason: "only 512 MiB of memory is free here".into(),
3095
            ms: now,
3096
        };
3097
        assert_eq!(
3098
            why(&[runner(1, "earth-1")], std::slice::from_ref(&d)),
3099
            "no runner can take it: earth-1 declined it: only 512 MiB of memory is free here"
bf3d0754 Andy McCall ↶ 3100
        );
4d2e44d7 Andy McCall ↶ 3101
        let old = fdb::DeclineRow { ms: now - fdb::DECLINE_HOLDS_MS - 1, ..d };
3102
        assert_eq!(why(&[runner(1, "earth-1")], &[old]), "", "an old decline no longer holds");
bf3d0754 Andy McCall ↶ 3103
    }
3104
}