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