OXYGENHUB
# 56b8dbe66974 oxygenhub / crates / hub / src / flow.rs
134.8 KiB · Rust · last changed A waiting WASM job no longer says runners lack its image (closes #317) 10 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
/// How long a runner holds a job without the hub hearing from it (claims,
1331
/// heartbeats every 30 s, logs) before the job is handed back
1332
/// (oxygenflow#76).
1333
pub const LEASE_MS: i64 = 3 * 60_000;
1334
1335
/// A job handed back more times than this ends as an error rather than
1336
/// bounce from runner to runner.
1337
pub const MAX_HANDBACKS: i64 = 5;
1338
1339
/// Hand job `id` back to the queue, ahead of new work (oxygenflow#76): its
1340
/// runner drained before leaving (`runner` is it), or its lease lapsed
1341
/// (`None`). The log says why, and the next attempt's follows on. False
1342
/// when the job was not running there.
1343
pub async fn hand_back_job(app: &Shared, id: i64, runner: Option<i64>, why: &str) -> sqlx::Result<bool> {
1344
    let Some(before) = fdb::job(&app.db, id).await? else { return Ok(false) };
1345
    let Some(n) = fdb::hand_back(&app.db, id, runner).await? else { return Ok(false) };
1346
    let t = before.started_ms.map(|s| (db::now_ms() - s).max(0) as u64).unwrap_or(0);
1347
    let record = flow_core::api::Record { t, stream: "flow".into(), text: format!("── {why}; queued again ahead of new work") };
1348
    fdb::append_log(&app.db, id, &[record], MAX_RECORDS as i64).await.ok();
1349
    tracing::info!("flow: job {id} handed back ({n}): {why}");
1350
    if n > MAX_HANDBACKS {
1351
        let error = format!("handed back {n} times; the last: {why}");
1352
        let changed =
1353
            fdb::finish(&app.db, id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
1354
                .await?;
1355
        report_changed(app, before.run_id, changed).await?;
1356
    } else if let Some(run) = fdb::run_by_id(&app.db, before.run_id).await? {
1357
        if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
1358
            let summary = format!("{why}; queued again ahead of new work");
1359
            report_check(app, &row, &run.state, run.number, &before.name, "queued", &summary).await;
1360
        }
1361
    }
1362
    Ok(true)
1363
}
1364
1365
/// Hand back the jobs of runners not heard from for [`LEASE_MS`]: a phone
1366
/// that lost every network, a host that died (oxygenflow#76).
1367
pub async fn requeue_lapsed(app: &Shared) -> sqlx::Result<usize> {
1368
    let lapsed = fdb::running_on_silent_runners(&app.db, db::now_ms() - LEASE_MS).await?;
1369
    let mut n = 0;
1370
    for (job, runner) in lapsed {
1371
        let why = format!("the runner {runner} has not been heard from for {} minutes", LEASE_MS / 60_000);
1372
        if hand_back_job(app, job.id, None, &why).await? {
1373
            n += 1;
1374
        }
1375
    }
1376
    Ok(n)
1377
}
1378
1379
/// `POST /api/v1/flow/jobs/{id}/release` (oxygenflow#76): a draining
1380
/// runner hands back a job it holds, as it leaves (off the allowed network,
1381
/// a restart, a spot reclaim). Not a decline: the runner is not held from
1382
/// the job and it does not count towards unplaceable.
1383
pub async fn release(
1384
    State(app): State<Shared>,
1385
    headers: HeaderMap,
1386
    Path(id): Path<i64>,
1387
    Json(d): Json<flow_core::api::Decline>,
1388
) -> Result<StatusCode, ApiError> {
1389
    let me = runner_auth(&app, &headers).await?;
1390
    db::runners::seen(&app.db, me.id, None, None).await?;
1391
    let reason: String = d.reason.chars().map(|c| if c.is_control() { ' ' } else { c }).take(500).collect();
1392
    let why = match reason.trim() {
1393
        "" => format!("handed back by {}", me.name),
1394
        r => format!("handed back by {}: {r}", me.name),
1395
    };
1396
    if !hand_back_job(&app, id, Some(me.id), &why).await? {
1397
        return Err(ApiError(StatusCode::CONFLICT, "that job is not running on this runner".into()));
1398
    }
1399
    Ok(StatusCode::NO_CONTENT)
1400
}
1401
1402
/// `POST /api/v1/flow/jobs/{id}/decline` (OxygenFlow spec §11.5): the
1403
/// runner will not run a job it was handed. The job is queued again and
1404
/// not offered to that runner while its profile stays the same (and for
1405
/// [`fdb::DECLINE_HOLDS_MS`] at most); once [`UNPLACEABLE_AFTER`]
1406
/// different runners have declined it, it ends as unplaceable with their
1407
/// reasons. A decline is never a failed check.
1408
/// `POST /api/v1/flow/runners/heartbeat` (oxygenhub#243): a runner whose
1409
/// job slots are all full claims nothing, so it says it is there.
1410
pub async fn heartbeat(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
1411
    let me = runner_auth(&app, &headers).await?;
1412
    db::runners::seen(&app.db, me.id, None, None).await?;
1413
    Ok(StatusCode::NO_CONTENT)
1414
}
1415
1416
pub async fn decline(
1417
    State(app): State<Shared>,
1418
    headers: HeaderMap,
1419
    Path(id): Path<i64>,
1420
    Json(d): Json<flow_core::api::Decline>,
1421
) -> Result<StatusCode, ApiError> {
1422
    let me = runner_auth(&app, &headers).await?;
1423
    db::runners::seen(&app.db, me.id, None, None).await?;
1424
    let reason: String = d.reason.chars().map(|c| if c.is_control() { ' ' } else { c }).take(500).collect();
1425
    let reason = match reason.trim() {
1426
        "" => "no reason given".to_string(),
1427
        r => r.to_string(),
1428
    };
1429
    let Some(all) = fdb::decline(&app.db, id, me.id, &me.name, &me.profile, &reason).await? else {
1430
        return Err(ApiError(StatusCode::CONFLICT, "that job is not running on this runner".into()));
1431
    };
1432
    tracing::info!("flow: runner {} declined job {id}: {reason}", me.name);
1433
    let job = fdb::job(&app.db, id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such job".into()))?;
1434
    let runners: std::collections::BTreeSet<i64> = all.iter().map(|d| d.runner_id).collect();
1435
    if runners.len() >= UNPLACEABLE_AFTER {
1436
        let error = format!(
1437
            "unplaceable: declined by {} runners: {}",
1438
            runners.len(),
1439
            all.iter().map(|d| format!("{}: {}", d.runner, d.reason)).collect::<Vec<_>>().join("; ")
1440
        );
1441
        let changed =
1442
            fdb::finish(&app.db, id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
1443
                .await?;
1444
        report_changed(&app, job.run_id, changed).await?;
1445
    } else if let Some(run) = fdb::run_by_id(&app.db, job.run_id).await? {
1446
        if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
1447
            let summary = format!("declined by {}: {reason}; waiting for another runner", me.name);
1448
            report_check(&app, &row, &run.state, run.number, &job.name, "queued", &summary).await;
1449
            fdb::set_waiting(&app.db, id, &summary).await?;
1450
        }
1451
    }
1452
    Ok(StatusCode::NO_CONTENT)
1453
}
1454
1455
/// Why no runner can take `job` of a repository of `owner` (id `repo_id`)
1456
/// now (spec §11.4), from what each runner offered at its last claim:
1457
/// empty when one could (it waits its turn or a free slot), else what
1458
/// each one lacks. `declines` are the job's.
1459
/// What placement knows of the fleet: images' architectures, the images
1460
/// the hub holds, and the time.
1461
pub struct Fleet<'a> {
1462
    pub image_archs: &'a std::collections::HashMap<String, String>,
1463
    pub hub_images: &'a std::collections::HashSet<String>,
1464
    pub now: i64,
1465
}
1466
1467
/// Why runner `r` cannot take `job` of a repository of `owner` (id
1468
/// `repo_id`), from what it offered at its last claim (spec §11.4); `None`
1469
/// when it can. `declines` are the job's.
1470
pub fn runner_lacks(
1471
    job: &fdb::Job,
1472
    owner: &str,
1473
    repo_id: i64,
1474
    r: &db::runners::Runner,
1475
    fleet: &Fleet,
1476
    declines: &[fdb::DeclineRow],
1477
) -> Option<String> {
1478
    let sandbox: serde_json::Value = serde_json::from_str(&job.sandbox).unwrap_or_default();
1479
    let rootfs = sandbox["rootfs"].as_str().unwrap_or("");
1480
    let wanted_arch = job.arch().or_else(|| fleet.image_archs.get(rootfs).cloned());
1481
    let need = |k: &str| sandbox[k].as_u64().unwrap_or(0);
1482
    if r.state == "draining" {
1483
        return Some("is draining".into());
1484
    }
1485
    let scope = r.scope();
1486
    if (!scope.owner.is_empty() && scope.owner != owner) || scope.repo_id.is_some_and(|id| id != repo_id) {
1487
        return Some("serves other repositories".into());
1488
    }
1489
    let tiers = r.tier_list();
1490
    if !tiers.is_empty() && !tiers.contains(&job.runtime.as_str()) {
1491
        return Some(format!("has no {} tier (it offers {})", job.runtime, tiers.join(", ")));
1492
    }
1493
    if let Some(w) = wanted_arch.as_deref().filter(|w| !r.arch.is_empty() && *w != r.arch) {
1494
        return Some(format!("is {}; the job needs {w}", r.arch));
1495
    }
1496
    // A job with no image (the WASM tier) needs none on the runner, as its claim says.
1497
    let fetches = r.fetches_images && fleet.hub_images.contains(rootfs);
1498
    if !rootfs.is_empty() && !fetches && r.image_list().is_some_and(|have| !have.iter().any(|h| h == rootfs)) {
1499
        let why = if r.fetches_images { " (nor does the hub: send it with flow rootfs push)" } else { "" };
1500
        return Some(format!("does not hold image {}{why}", &rootfs[..12.min(rootfs.len())]));
1501
    }
1502
    let labels = r.label_list();
1503
    if let Some(l) = job.needs().iter().find(|l| !labels.contains(&l.as_str())) {
1504
        return Some(format!("lacks label {l}"));
1505
    }
1506
    if let Some(m) = r.memory_mib.filter(|m| (*m as u64) < need("memory_mib")) {
1507
        return Some(format!("has {m} MiB; the job needs {} MiB", need("memory_mib")));
1508
    }
1509
    if let Some(c) = r.cpus.filter(|c| (*c as u64) < need("cpus")) {
1510
        return Some(format!("has {c} CPUs; the job needs {}", need("cpus")));
1511
    }
1512
    // The disk it learned it needs (oxygenflow#41).
1513
    if let (Some(n), Some(free)) = (job.need_disk_mib, r.free_disk_mib) {
1514
        if free < n {
1515
            return Some(format!(
1516
                "has {} free; the job needs ~{} (its recent runs took up to {})",
1517
                mib(free),
1518
                mib(n),
1519
                mib((n - 64) * 4 / 5)
1520
            ));
1521
        }
1522
    }
1523
    if let Some(d) = declines.iter().find(|d| d.runner_id == r.id && fleet.now - d.ms < fdb::DECLINE_HOLDS_MS) {
1524
        return Some(format!("declined it: {}", d.reason));
1525
    }
1526
    None
1527
}
1528
1529
/// Why no runner can take `job` of a repository of `owner` (id `repo_id`)
1530
/// now (spec §11.4), from what each runner offered at its last claim:
1531
/// empty when one could (it waits its turn or a free slot), else what
1532
/// each one lacks. `declines` are the job's.
1533
#[allow(clippy::too_many_arguments)]
1534
pub fn why_waiting(
1535
    job: &fdb::Job,
1536
    owner: &str,
1537
    repo_id: i64,
1538
    runners: &[db::runners::Runner],
1539
    image_archs: &std::collections::HashMap<String, String>,
1540
    declines: &[fdb::DeclineRow],
1541
    now: i64,
1542
    hub_images: &std::collections::HashSet<String>,
1543
) -> String {
1544
    let fleet = Fleet { image_archs, hub_images, now };
1545
    let online: Vec<&db::runners::Runner> = runners.iter().filter(|r| r.state != "disabled" && r.online()).collect();
1546
    if online.is_empty() {
1547
        return "no runner is online".into();
1548
    }
1549
    let mut why = Vec::new();
1550
    for r in &online {
1551
        match runner_lacks(job, owner, repo_id, r, &fleet, declines) {
1552
            None => return String::new(),
1553
            Some(w) => why.push(format!("{} {w}", r.name)),
1554
        }
1555
    }
1556
    let more = why.len().saturating_sub(4);
1557
    why.truncate(4);
1558
    let mut text = format!("no runner can take it: {}", why.join("; "));
1559
    if more > 0 {
1560
        text.push_str(&format!("; and {more} more"));
1561
    }
1562
    text
1563
}
1564
1565
/// Why a job that some runner could take still waits (oxygenhub#259): the
1566
/// runners that could take it are all busy, or have a free slot without
1567
/// the room for it now, and how many ready jobs come first (a higher
1568
/// priority, or the same one and older).
1569
#[allow(clippy::too_many_arguments)]
1570
pub fn why_still_waiting(
1571
    job: &fdb::Job,
1572
    owner: &str,
1573
    repo_id: i64,
1574
    runners: &[db::runners::Runner],
1575
    fleet: (&std::collections::HashMap<String, String>, &std::collections::HashSet<String>, i64),
1576
    declines: &[fdb::DeclineRow],
1577
    running: &std::collections::HashMap<i64, i64>,
1578
    ahead: usize,
1579
    behind_urgent: &[String],
1580
) -> String {
1581
    let fleet = Fleet { image_archs: fleet.0, hub_images: fleet.1, now: fleet.2 };
1582
    let mut busy = Vec::new();
1583
    for r in runners.iter().filter(|r| r.state != "disabled" && r.online()) {
1584
        if runner_lacks(job, owner, repo_id, r, &fleet, declines).is_some() {
1585
            continue;
1586
        }
1587
        let n = running.get(&r.id).copied().unwrap_or(0);
1588
        let slots = r.max_jobs.max(1);
1589
        if n >= slots {
1590
            busy.push(format!("{} busy ({n} of {slots})", r.name));
1591
        } else {
1592
            busy.push(format!("{} has a free slot ({n} of {slots}) but not the memory or disk for it now", r.name));
1593
        }
1594
    }
1595
    let mut parts = Vec::new();
1596
    if !busy.is_empty() {
1597
        parts.push(format!("the runners that can take it are busy: {}", busy.join("; ")));
1598
    }
1599
    if ahead > 0 {
1600
        let after = match behind_urgent {
1601
            [] => String::new(),
1602
            [one] => format!(" (after expedited run {one})"),
1603
            many => format!(" (after expedited runs {})", many.join(", ")),
1604
        };
1605
        parts.push(format!("{ahead} ready {} first{after}", if ahead == 1 { "job comes" } else { "jobs come" }));
1606
    }
1607
    parts.join("; ")
1608
}
1609
1610
/// How long a job is held for a better runner before any runner that fits
1611
/// takes it (oxygenflow#42).
1612
const BETTER_HOLD_MS: i64 = 15_000;
1613
/// A runner counts as there to take a job when it asked this recently.
1614
const POLLING_MS: i64 = 10_000;
1615
1616
/// When each job was first passed over for a better runner.
1617
/// Keyed by hub (tests run several in one process) and job.
1618
static HELD: std::sync::Mutex<Option<std::collections::HashMap<(String, i64), i64>>> = std::sync::Mutex::new(None);
1619
1620
/// The build cache slots each runner said at its last claim it holds
1621
/// (oxygenflow#51). Keyed by hub (tests run several in one process) and
1622
/// runner; a restart forgets them until each runner's next claim.
1623
/// Each slot maps to when it last kept a disk (Unix ms, 0 unknown).
1624
type CacheSlots = std::collections::HashMap<(String, i64), std::collections::HashMap<String, i64>>;
1625
static CACHES: std::sync::Mutex<Option<CacheSlots>> = std::sync::Mutex::new(None);
1626
1627
/// When runner `runner` last kept a disk in build cache slot `slot` (0 when
1628
/// it did not say); `None` when it holds none there.
1629
fn cache_kept(hub: &str, runner: i64, slot: &str) -> Option<i64> {
1630
    CACHES
1631
        .lock()
1632
        .unwrap_or_else(|p| p.into_inner())
1633
        .as_ref()
1634
        .and_then(|c| c.get(&(hub.to_string(), runner)))
1635
        .and_then(|held| held.get(slot).copied())
1636
}
1637
1638
/// A copy of a build cache kept at least this much later is the fresher
1639
/// (oxygenflow#54): closer than that, the two are as good as each other.
1640
const FRESHER_MS: i64 = 60_000;
1641
1642
/// How well a runner fits a job (oxygenflow#42, #51, #54).
1643
struct Fit {
1644
    /// When it last kept the job's build cache, if it holds it.
1645
    cache: Option<i64>,
1646
    image: bool,
1647
    speed: i64,
1648
}
1649
1650
impl Fit {
1651
    /// Whether this fit is better than `other`: holding the job's build
1652
    /// cache counts most (a warm build beats any image fetch), and of two
1653
    /// that hold it the fresher copy; then holding the image, then speed.
1654
    fn beats(&self, other: &Fit) -> bool {
1655
        match (self.cache, other.cache) {
1656
            (Some(_), None) => return true,
1657
            (None, Some(_)) => return false,
1658
            (Some(a), Some(b)) if a > 0 && b > 0 && (a - b).abs() >= FRESHER_MS => return a > b,
1659
            _ => {}
1660
        }
1661
        (self.image, self.speed) > (other.image, other.speed)
1662
    }
1663
}
1664
1665
/// How runner `r` fits a job on image `rootfs` whose build cache slot is
1666
/// `slot`.
1667
fn fit(hub: &str, r: &db::runners::Runner, rootfs: &str, slot: &str) -> Fit {
1668
    Fit {
1669
        cache: cache_kept(hub, r.id, slot),
1670
        image: r.image_list().is_some_and(|have| have.iter().any(|h| h == rootfs)),
1671
        speed: r.speed_class.unwrap_or(0),
1672
    }
1673
}
1674
1675
/// A span as people say it: 40 s, 12 min, 3 h, 2 days.
1676
fn ago(ms: i64) -> String {
1677
    let s = ms.max(0) / 1000;
1678
    match s {
1679
        0..=59 => format!("{s} s"),
1680
        60..=3599 => format!("{} min", s / 60),
1681
        3600..=172_799 => format!("{} h", s / 3600),
1682
        _ => format!("{} days", s / 86_400),
1683
    }
1684
}
1685
1686
fn rootfs_of(job: &fdb::Job) -> String {
1687
    serde_json::from_str::<serde_json::Value>(&job.sandbox).ok().and_then(|v| v["rootfs"].as_str().map(String::from)).unwrap_or_default()
1688
}
1689
1690
/// A size in MiB as people say it: 9.4 GiB, 740 MiB.
1691
fn mib(m: i64) -> String {
1692
    if m >= 1024 {
1693
        format!("{:.1} GiB", m as f64 / 1024.0)
1694
    } else {
1695
        format!("{m} MiB")
1696
    }
1697
}
1698
1699
/// One placement pass: say why each ready queued job waits.
1700
pub async fn explain_waits(app: &Shared) -> sqlx::Result<()> {
1701
    let ready = fdb::ready_queued(&app.db).await?;
1702
    if ready.is_empty() {
1703
        return Ok(());
1704
    }
1705
    let runners = db::runners::list(&app.db).await?;
1706
    let archs = fdb::image_archs(&app.db).await?;
1707
    let held = crate::images::held(&app.db).await?;
1708
    let now = db::now_ms();
1709
    let ranks = fdb::queued_ranks(&app.db).await?;
1710
    let running = fdb::running_by_runner(&app.db).await?;
1711
    // Claim order, roughly: a better rank first, then the older job.
1712
    let order: Vec<(i64, i64)> = ready.iter().map(|(j, _, _)| (ranks.get(&j.id).copied().unwrap_or(2), j.id)).collect();
1713
    let run_of: std::collections::HashMap<i64, i64> = ready.iter().map(|(j, _, _)| (j.id, j.run_id)).collect();
1714
    // Expedited runs (rank 0) by name, for the jobs they moved down (#291).
1715
    let mut urgent: std::collections::BTreeMap<i64, String> = std::collections::BTreeMap::new();
1716
    for (j, _, _) in ready.iter().filter(|(j, _, _)| ranks.get(&j.id) == Some(&0)) {
1717
        if urgent.contains_key(&j.run_id) {
1718
            continue;
1719
        }
1720
        if let Some(run) = fdb::run_by_id(&app.db, j.run_id).await? {
1721
            if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
1722
                urgent.insert(j.run_id, format!("{}/{} #{}", row.owner, row.name, run.number));
1723
            }
1724
        }
1725
    }
1726
    // Runs whose waiting notes changed: their pages hear of it now.
1727
    let mut changed = std::collections::BTreeSet::new();
1728
    for (job, owner, repo_id) in ready {
1729
        let declines = fdb::declines_of_job(&app.db, job.id).await?;
1730
        let mut why = why_waiting(&job, &owner, repo_id, &runners, &archs, &declines, now, &held);
1731
        if why.is_empty() {
1732
            let mine = (ranks.get(&job.id).copied().unwrap_or(2), job.id);
1733
            let ahead = order.iter().filter(|o| **o < mine).count();
1734
            let mut behind: Vec<String> = Vec::new();
1735
            if mine.0 > 0 {
1736
                for o in order.iter().filter(|o| o.0 == 0 && **o < mine) {
1737
                    let Some(r) = run_of.get(&o.1).filter(|r| **r != job.run_id) else { continue };
1738
                    if let Some(label) = urgent.get(r).filter(|l| !behind.contains(l)) {
1739
                        behind.push(label.clone());
1740
                    }
1741
                }
1742
            }
1743
            why = why_still_waiting(&job, &owner, repo_id, &runners, (&archs, &held, now), &declines, &running, ahead, &behind);
1744
        }
1745
        if why == job.waiting {
1746
            continue;
1747
        }
1748
        fdb::set_waiting(&app.db, job.id, &why).await?;
1749
        changed.insert(job.run_id);
1750
        // The job's check says it too, so a proposal shows why it is stuck
1751
        // (oxygenhub#28); only when the reason changes in kind, not in its
1752
        // counts (#259: a queue position moves every pass, and each check
1753
        // report reaches webhooks).
1754
        let kind = |s: &str| s.chars().filter(|c| !c.is_ascii_digit()).collect::<String>();
1755
        if kind(&why) == kind(&job.waiting) {
1756
            continue;
1757
        }
1758
        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?) {
1759
            let summary = if why.is_empty() { "waiting for a runner" } else { why.as_str() };
1760
            report_check(app, &row, &run.state, run.number, &job.name, "queued", summary).await;
1761
        }
1762
    }
1763
    for run_id in changed {
1764
        app.bus.live(&crate::events::topic::run(run_id), "jobs");
1765
    }
1766
    Ok(())
1767
}
1768
1769
/// Run a placement pass every 15 seconds.
1770
pub async fn placement(app: Shared) {
1771
    loop {
1772
        tokio::time::sleep(std::time::Duration::from_secs(15)).await;
1773
        if let Err(e) = explain_waits(&app).await {
1774
            tracing::warn!("flow: placement pass: {e}");
1775
        }
1776
    }
1777
}
1778
1779
/// The Oxygen subrepo pins in `name`'s state `heads`: (path, repository id, pinned heads).
1780
pub(crate) async fn pins_in(
1781
    app: &Shared,
1782
    name: crate::repos::RepoName,
1783
    heads: Vec<oxy_core::hash::ChangeHash>,
1784
) -> Result<Vec<(String, [u8; 16], Vec<oxy_core::hash::ChangeHash>)>, String> {
1785
    app.repos
1786
        .read(&name, move |repo, cache| {
1787
            let loaded = cache.load(repo, &heads)?;
1788
            let mut out = Vec::new();
1789
            for (path, f) in &loaded.snapshot.files {
1790
                if f.kind != oxy_core::objects::NodeKind::Subrepo {
1791
                    continue;
1792
                }
1793
                if let oxy_core::state::FileContent::Opaque { blobs } = &f.content {
1794
                    if let Some(b) = blobs.first() {
1795
                        if let Ok(oxy_core::subrepo::Pin::Oxy { repo: id, heads, .. }) = repo
1796
                            .read_blob(b)
1797
                            .map_err(crate::repos::RepoError::Oxy)
1798
                            .and_then(|bytes| oxy_core::subrepo::Pin::decode(&bytes).map_err(|e| crate::repos::RepoError::Oxy(e.into())))
1799
                        {
1800
                            out.push((path.clone(), id, heads));
1801
                        }
1802
                    }
1803
                }
1804
            }
1805
            Ok(out)
1806
        })
1807
        .await
1808
        .map_err(|e| e.to_string())
1809
}
1810
1811
/// How deep subrepos of subrepos are followed.
1812
const MAX_SUBREPO_DEPTH: usize = 3;
1813
1814
/// The Oxygen subrepos the run's state pins, and those their states pin in
1815
/// turn (parents first, paths joined), that live on this hub and that the
1816
/// run's pusher may read: what the job's workspace needs beside its own
1817
/// tree. A pin the hub cannot serve is left out, with what it pins, and
1818
/// the third list says why, for the job's log.
1819
async fn subrepo_inputs(
1820
    app: &Shared,
1821
    row: &db::repos::RepoRow,
1822
    run: &fdb::Run,
1823
) -> (Vec<flow_core::api::SubrepoInput>, Vec<i64>, Vec<String>) {
1824
    let Some(name) = crate::repos::RepoName::new(&row.owner, &row.name) else { return (vec![], vec![], vec![]) };
1825
    let heads: Vec<oxy_core::hash::ChangeHash> = run.head_list().into_iter().filter_map(oxy_core::hash::ChangeHash::from_hex).collect();
1826
    let pusher = db::accounts::account_by_name(&app.db, &run.actor).await.ok().flatten();
1827
    let rows = db::repos::list(&app.db).await.unwrap_or_default();
1828
    let mut inputs = Vec::new();
1829
    let mut ids = Vec::new();
1830
    let mut left_out = Vec::new();
1831
    let actor = if run.actor.is_empty() { "the run's starter".to_string() } else { run.actor.clone() };
1832
    // (path prefix, repository, heads, depth), parents before children.
1833
    let mut queue = std::collections::VecDeque::from([(String::new(), name, heads, 0usize)]);
1834
    while let Some((prefix, name, heads, depth)) = queue.pop_front() {
1835
        if depth == MAX_SUBREPO_DEPTH {
1836
            continue;
1837
        }
1838
        for (path, id, pinned) in pins_in(app, name, heads).await.unwrap_or_default() {
1839
            let path = if prefix.is_empty() { path } else { format!("{prefix}/{path}") };
1840
            let mut hosted = false;
1841
            for other in &rows {
1842
                let Some(other_name) = crate::repos::RepoName::new(&other.owner, &other.name) else { continue };
1843
                let matches = app.repos.read(&other_name, move |r, _| Ok(r.id().ok() == Some(id))).await.unwrap_or(false);
1844
                if !matches {
1845
                    continue;
1846
                }
1847
                hosted = true;
1848
                let role = crate::auth::roles::role_for(&app.db, pusher.as_ref(), other).await.ok().flatten();
1849
                // A Diffusion bump's run reads the upstream it bumps: the one
1850
                // the consumer pins (someone who may write it committed the
1851
                // pin), and no other (#150).
1852
                let diffused = run.actor == crate::diffusion::ACCOUNT
1853
                    && run.bookmark.starts_with("diffusion/")
1854
                    && sqlx::query_scalar::<_, i64>("SELECT COUNT(*) FROM diffusion_pins WHERE consumer_id = $1 AND upstream_repo_id = $2")
1855
                        .bind(run.repo_id)
1856
                        .bind(other.id)
1857
                        .fetch_one(&app.db)
1858
                        .await
1859
                        .unwrap_or(0)
1860
                        > 0;
1861
                if diffused || crate::auth::roles::allows(role, crate::auth::Access::Read) {
1862
                    inputs.push(flow_core::api::SubrepoInput {
1863
                        path: path.clone(),
1864
                        repo: format!("{}/{}", other.owner, other.name),
1865
                        clone_url: format!("{}/{}/{}", app.config.base_url(), other.owner, other.name),
1866
                        heads: pinned.iter().map(|h| h.to_hex()).collect(),
1867
                    });
1868
                    if !ids.contains(&other.id) {
1869
                        ids.push(other.id);
1870
                    }
1871
                    queue.push_back((path.clone(), other_name, pinned.clone(), depth + 1));
1872
                } else {
1873
                    left_out.push(format!(
1874
                        "subrepo {path} ({}/{}) is left out: {actor} cannot read it, so the job has no files there",
1875
                        other.owner, other.name
1876
                    ));
1877
                }
1878
                break;
1879
            }
1880
            if !hosted {
1881
                left_out.push(format!("subrepo {path} is left out: the repository it pins is not on this hub"));
1882
            }
1883
        }
1884
    }
1885
    (inputs, ids, left_out)
1886
}
1887
1888
async fn running_job(app: &Shared, id: i64) -> Result<fdb::Job, ApiError> {
1889
    match fdb::job(&app.db, id).await? {
1890
        Some(j) if j.status == "running" => Ok(j),
1891
        Some(_) => Err(ApiError(StatusCode::CONFLICT, "this job is not running".into())),
1892
        None => Err(ApiError(StatusCode::NOT_FOUND, "no such job".into())),
1893
    }
1894
}
1895
1896
/// `POST /api/v1/flow/jobs/{id}/log`.
1897
pub async fn log(
1898
    State(app): State<Shared>,
1899
    headers: HeaderMap,
1900
    Path(id): Path<i64>,
1901
    Json(mut batch): Json<LogBatch>,
1902
) -> Result<StatusCode, ApiError> {
1903
    runner_auth(&app, &headers).await?;
1904
    let job = running_job(&app, id).await?;
1905
    // An empty batch asks only whether the job still runs: a cancelled
1906
    // one answers 409 and its runner stops it (oxygenflow#32).
1907
    if batch.records.is_empty() {
1908
        return Ok(StatusCode::NO_CONTENT);
1909
    }
1910
    // A secret's value never reaches the stored log (#107).
1911
    let values: Vec<String> = match serde_json::from_str::<flow_core::Job>(&job.spec) {
1912
        Ok(spec) if !spec.secrets.is_empty() => {
1913
            let run = fdb::run_by_id(&app.db, job.run_id).await?;
1914
            let row = match run {
1915
                Some(run) => db::repos::get_by_id(&app.db, run.repo_id).await?,
1916
                None => None,
1917
            };
1918
            match row {
1919
                Some(row) => {
1920
                    let names: Vec<String> = spec.secrets.iter().map(|s| s.name.clone()).collect();
1921
                    crate::secrets::for_job(&app, &row, &names).await?.into_iter().map(|(_, v)| v).collect()
1922
                }
1923
                None => vec![],
1924
            }
1925
        }
1926
        _ => vec![],
1927
    };
1928
    let kid = app.oidc.get().map(|i| i.kid.clone());
1929
    for r in &mut batch.records {
1930
        if !values.is_empty() {
1931
            r.text = crate::secrets::mask(&r.text, &values);
1932
        }
1933
        if let Some(kid) = &kid {
1934
            r.text = crate::oidc::mask(&r.text, kid);
1935
        }
1936
        if r.text.len() > MAX_RECORD_TEXT {
1937
            let mut cut = MAX_RECORD_TEXT;
1938
            while !r.text.is_char_boundary(cut) {
1939
                cut -= 1;
1940
            }
1941
            r.text.truncate(cut);
1942
        }
1943
        if !matches!(r.stream.as_str(), "out" | "err" | "console" | "flow") {
1944
            r.stream = "console".into();
1945
        }
1946
    }
1947
    let kept = fdb::append_log(&app.db, job.id, &batch.records, MAX_RECORDS as i64).await?;
1948
    if kept < batch.records.len() && job.log_count < MAX_RECORDS as i64 {
1949
        tracing::info!("flow: job {} reached the log limit", job.id);
1950
    }
1951
    Ok(StatusCode::NO_CONTENT)
1952
}
1953
1954
/// Largest artifact the hub keeps; the runner refuses larger ones first.
1955
pub const MAX_ARTIFACT_BYTES: usize = 512 << 20;
1956
1957
/// `POST /api/v1/flow/jobs/{id}/artifacts/{name}`: the bytes of an artifact
1958
/// the job declares (OxygenFlow spec §5.2), kept as a blob of the run's
1959
/// repository. Answers `{"blob"}`.
1960
pub async fn artifact(
1961
    State(app): State<Shared>,
1962
    headers: HeaderMap,
1963
    Path((id, name)): Path<(i64, String)>,
1964
    body: axum::body::Bytes,
1965
) -> Result<Response, ApiError> {
1966
    runner_auth(&app, &headers).await?;
1967
    let job = running_job(&app, id).await?;
1968
    let spec: flow_core::Job =
1969
        serde_json::from_str(&job.spec).map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("stored job: {e}")))?;
1970
    let Some(out) = spec.outputs.iter().find(|o| o.name == name) else {
1971
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("job {} declares no artifact {name:?}", job.name)));
1972
    };
1973
    let run = fdb::run_by_id(&app.db, job.run_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1974
    let row =
1975
        db::repos::get_by_id(&app.db, run.repo_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such repository".into()))?;
1976
    let repo = RepoName::new(&row.owner, &row.name).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "bad repository name".into()))?;
1977
    // A report's artifact is its manifest (#127): checked, and its files
1978
    // found in the store, before it is kept.
1979
    let report = match out.kind {
1980
        flow_core::OutputKind::Report => Some(report_manifest(&app, &repo, &name, &body).await?),
1981
        flow_core::OutputKind::Artifact => None,
1982
    };
1983
    let content = blake3::hash(&body).to_hex().to_string();
1984
    let size = body.len() as i64;
1985
    let artifact = report.is_none();
1986
    let report_bytes = (artifact && name == crate::coverage::ARTIFACT).then(|| body.clone());
1987
    let junit_bytes = (artifact && name == crate::junit::ARTIFACT).then(|| body.clone());
1988
    let blob = app
1989
        .repos
1990
        .write(&repo, move |r, _| Ok(r.store_blob(&body)?))
1991
        .await
1992
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("keep the artifact: {e}")))?;
1993
    let a = fdb::Artifact { job_id: job.id, name, path: out.path.clone(), blob: blob.to_hex(), size, content, created_ms: db::now_ms() };
1994
    fdb::add_artifact(&app.db, &a).await?;
1995
    if let Some((manifest, declaration)) = report {
1996
        let origin = crate::reports::Origin {
1997
            repo_id: row.id,
1998
            run_id: run.id,
1999
            run_number: run.number,
2000
            job_id: job.id,
2001
            job: &job.name,
2002
            bookmark: &run.bookmark,
2003
            state: &run.state,
2004
        };
2005
        let said = match declaration {
2006
            Ok(d) => match crate::reports::keep(&app, &origin, &a.name, &d, &manifest, &a.blob).await {
2007
                Ok(id) => {
2008
                    report_threshold_checks(&app, &row, &run, &a.name, id, &d.metrics).await;
2009
                    let s = if d.metrics.len() == 1 { "" } else { "s" };
2010
                    format!("report {}: {} \"{}\", {} metric{s}", a.name, d.kind, d.title, d.metrics.len())
2011
                }
2012
                Err(e) => format!("report {}: not indexed: {e}", a.name),
2013
            },
2014
            Err(why) => {
2015
                let d = crate::reports::Declaration::unreadable(&a.name, &why);
2016
                crate::reports::keep(&app, &origin, &a.name, &d, &manifest, &a.blob).await.ok();
2017
                format!("report {}: report.toml: {why}", a.name)
2018
            }
2019
        };
2020
        let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: said };
2021
        fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
2022
    }
2023
    // A coverage report (#113) is read now; what it says, or why it could
2024
    // not be read, goes in the job's log. It never fails the upload.
2025
    if let Some(bytes) = report_bytes {
2026
        let said = match read_coverage(&app, &repo, &row, &run, &job, &a.blob, bytes).await {
2027
            Ok(text) | Err(text) => text,
2028
        };
2029
        let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: said };
2030
        fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
2031
    }
2032
    // A test report (#114) likewise.
2033
    if let Some(bytes) = junit_bytes {
2034
        let said = match read_junit(&app, &row, &run, &job, &a.blob, bytes).await {
2035
            Ok(text) | Err(text) => text,
2036
        };
2037
        let record = flow_core::api::Record { t: 0, stream: "flow".into(), text: said };
2038
        fdb::append_log(&app.db, job.id, &[record], MAX_RECORDS as i64).await.ok();
2039
    }
2040
    Ok(Json(serde_json::json!({ "blob": a.blob })).into_response())
2041
}
2042
2043
/// A check per metric with a threshold (#127, docs/reports.md §5), named
2044
/// `report/NAME/METRIC` on the run's state: failed when the value crosses
2045
/// `fail_above` or `fail_below`, which a proposal may require.
2046
async fn report_threshold_checks(
2047
    app: &Shared,
2048
    row: &db::repos::RepoRow,
2049
    run: &fdb::Run,
2050
    name: &str,
2051
    id: i64,
2052
    metrics: &[crate::reports::Metric],
2053
) {
2054
    let url = format!("{}/{}/{}/reports/{name}?id={id}", app.config.base_url(), row.owner, row.name);
2055
    for m in metrics.iter().filter(|m| m.fail_above.is_some() || m.fail_below.is_some()) {
2056
        let unit = if m.unit.is_empty() { String::new() } else { format!(" {}", m.unit) };
2057
        let above = m.fail_above.filter(|a| m.value > *a);
2058
        let below = m.fail_below.filter(|b| m.value < *b);
2059
        let (status, summary) = match (above, below) {
2060
            (Some(a), _) => ("failed", format!("{}{unit}, above {a}", m.value)),
2061
            (_, Some(b)) => ("failed", format!("{}{unit}, below {b}", m.value)),
2062
            _ => {
2063
                let limits: Vec<String> = [m.fail_above.map(|a| format!("at most {a}")), m.fail_below.map(|b| format!("at least {b}"))]
2064
                    .into_iter()
2065
                    .flatten()
2066
                    .collect();
2067
                ("passed", format!("{}{unit} ({})", m.value, limits.join(", ")))
2068
            }
2069
        };
2070
        let check = format!("report/{name}/{}", m.key);
2071
        if let Ok(c) = db::hooks::upsert_check(
2072
            &app.db,
2073
            row.id,
2074
            db::hooks::CheckReport { state: &run.state, name: &check, status, summary: &summary, url: &url, reporter: None, seal: "" },
2075
        )
2076
        .await
2077
        {
2078
            let api = crate::api::check_of(&c);
2079
            app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
2080
            crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
2081
        }
2082
    }
2083
}
2084
2085
/// Check report manifest `body` (#127) and that the repository holds every
2086
/// file it names; answers it with the report's declaration, or why that
2087
/// could not be read.
2088
async fn report_manifest(
2089
    app: &Shared,
2090
    repo: &RepoName,
2091
    name: &str,
2092
    body: &[u8],
2093
) -> Result<(crate::reports::Manifest, Result<crate::reports::Declaration, String>), ApiError> {
2094
    let manifest = crate::reports::parse_manifest(body).map_err(|e| ApiError(StatusCode::BAD_REQUEST, e))?;
2095
    let refs: Vec<(String, oxy_core::hash::ObjectRef)> =
2096
        manifest.files.iter().filter_map(|f| Some((f.path.clone(), oxy_core::hash::ObjectRef::from_hex(&f.blob)?))).collect();
2097
    let declaration = manifest.blob("report.toml").and_then(oxy_core::hash::ObjectRef::from_hex);
2098
    let found = app
2099
        .repos
2100
        .read(repo, move |r, _| {
2101
            if let Some((path, _)) = refs.iter().find(|(_, b)| !r.store().has(b)) {
2102
                return Ok(Err(path.clone()));
2103
            }
2104
            Ok(Ok(declaration.map(|b| r.read_blob(&b)).transpose()?))
2105
        })
2106
        .await
2107
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("read the report: {e}")))?;
2108
    let toml = found.map_err(|path| ApiError(StatusCode::BAD_REQUEST, format!("report file {path} was not uploaded; upload it first")))?;
2109
    let declaration = crate::reports::parse_declaration(name, &toml.unwrap_or_default());
2110
    Ok((manifest, declaration))
2111
}
2112
2113
/// `POST /api/v1/flow/jobs/{id}/reports/{name}/files`: one file of a report
2114
/// the job declares (#127), its path in `X-Flow-Report-Path`, kept as a
2115
/// blob of the run's repository. Answers `{"blob"}`; the manifest naming
2116
/// the files follows as the report's artifact.
2117
pub async fn report_file(
2118
    State(app): State<Shared>,
2119
    headers: HeaderMap,
2120
    Path((id, name)): Path<(i64, String)>,
2121
    body: axum::body::Bytes,
2122
) -> Result<Response, ApiError> {
2123
    runner_auth(&app, &headers).await?;
2124
    let job = running_job(&app, id).await?;
2125
    let spec: flow_core::Job =
2126
        serde_json::from_str(&job.spec).map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("stored job: {e}")))?;
2127
    if !spec.outputs.iter().any(|o| o.name == name && o.kind == flow_core::OutputKind::Report) {
2128
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("job {} declares no report {name:?}", job.name)));
2129
    }
2130
    let path = headers.get("x-flow-report-path").and_then(|v| v.to_str().ok()).unwrap_or_default();
2131
    if !crate::reports::path_ok(path) {
2132
        return Err(ApiError(StatusCode::BAD_REQUEST, format!("report file {path:?}: give its path in X-Flow-Report-Path")));
2133
    }
2134
    let run = fdb::run_by_id(&app.db, job.run_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
2135
    let row =
2136
        db::repos::get_by_id(&app.db, run.repo_id).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such repository".into()))?;
2137
    let repo = RepoName::new(&row.owner, &row.name).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "bad repository name".into()))?;
2138
    let blob = app
2139
        .repos
2140
        .write(&repo, move |r, _| Ok(r.store_blob(&body)?))
2141
        .await
2142
        .map_err(|e| ApiError(StatusCode::INTERNAL_SERVER_ERROR, format!("keep the report file: {e}")))?;
2143
    Ok(Json(serde_json::json!({ "blob": blob.to_hex() })).into_response())
2144
}
2145
2146
/// Parse and keep a job's JUnit report: what it says, or why not.
2147
async fn read_junit(
2148
    app: &Shared,
2149
    row: &db::repos::RepoRow,
2150
    run: &fdb::Run,
2151
    job: &fdb::Job,
2152
    blob: &str,
2153
    bytes: axum::body::Bytes,
2154
) -> Result<String, String> {
2155
    if bytes.len() > crate::junit::MAX_REPORT {
2156
        return Err(format!("tests: the report is {} MiB; at most {} MiB is read", bytes.len() >> 20, crate::junit::MAX_REPORT >> 20));
2157
    }
2158
    let text = String::from_utf8(bytes.to_vec()).map_err(|_| "tests: the report is not UTF-8 text (JUnit XML is expected)".to_string())?;
2159
    let cases = tokio::task::spawn_blocking(move || crate::junit::parse(&text))
2160
        .await
2161
        .map_err(|e| format!("tests: {e}"))?
2162
        .map_err(|e| format!("tests: {e}"))?;
2163
    let origin = crate::junit::Origin {
2164
        repo_id: row.id,
2165
        run_id: run.id,
2166
        run_number: run.number,
2167
        job_id: job.id,
2168
        job: &job.name,
2169
        bookmark: &run.bookmark,
2170
        state: &run.state,
2171
        blob,
2172
    };
2173
    crate::junit::keep(app, &origin, &cases).await.map_err(|e| format!("tests: {e}"))?;
2174
    let r = crate::junit::for_run(&app.db, run.id)
2175
        .await
2176
        .map_err(|e| format!("tests: {e}"))?
2177
        .into_iter()
2178
        .find(|r| r.job_id == job.id)
2179
        .ok_or_else(|| "tests: the report was not kept".to_string())?;
2180
    // The `tests` check on the run's state: what fails, and which of those
2181
    // passed in the same job's latest report on the default bookmark, so a
2182
    // proposal names what it broke.
2183
    let base = crate::junit::baseline(&app.db, &r, &row.default_bookmark).await.map_err(|e| format!("tests: {e}"))?;
2184
    let newly = match &base {
2185
        Some(b) if r.broken() > 0 => crate::junit::newly_failing(&app.db, r.id, b.id).await.map_err(|e| format!("tests: {e}"))?,
2186
        _ => vec![],
2187
    };
2188
    let (status, summary) = if r.broken() == 0 {
2189
        ("passed", format!("{} passed", r.passed))
2190
    } else if let Some(b) = &base {
2191
        let names: Vec<&str> = newly.iter().take(3).map(String::as_str).collect();
2192
        let more = if newly.len() > 3 { format!(", +{}", newly.len() - 3) } else { String::new() };
2193
        let new = if newly.is_empty() {
2194
            format!("none new against {} run #{}", row.default_bookmark, b.run_number)
2195
        } else {
2196
            format!("{} new against {}: {}{more}", newly.len(), row.default_bookmark, names.join(", "))
2197
        };
2198
        ("failed", format!("{} failing; {new}", r.broken()))
2199
    } else {
2200
        ("failed", format!("{} failing", r.broken()))
2201
    };
2202
    let url = format!("{}/{}/{}/tests?report={}", app.config.base_url(), row.owner, row.name, r.id);
2203
    if let Ok(c) = db::hooks::upsert_check(
2204
        &app.db,
2205
        row.id,
2206
        db::hooks::CheckReport { state: &run.state, name: "tests", status, summary: &summary, url: &url, reporter: None, seal: "" },
2207
    )
2208
    .await
2209
    {
2210
        let api = crate::api::check_of(&c);
2211
        app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
2212
        crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
2213
    }
2214
    Ok(format!("tests: {} in {}", r.summary(), human_ms(r.time_ms)))
2215
}
2216
2217
/// Parse and keep a job's coverage report: what it says, or why not.
2218
async fn read_coverage(
2219
    app: &Shared,
2220
    repo: &RepoName,
2221
    row: &db::repos::RepoRow,
2222
    run: &fdb::Run,
2223
    job: &fdb::Job,
2224
    blob: &str,
2225
    bytes: axum::body::Bytes,
2226
) -> Result<String, String> {
2227
    if bytes.len() > crate::coverage::MAX_REPORT {
2228
        return Err(format!(
2229
            "coverage: the report is {} MiB; at most {} MiB is read",
2230
            bytes.len() >> 20,
2231
            crate::coverage::MAX_REPORT >> 20
2232
        ));
2233
    }
2234
    let text = String::from_utf8(bytes.to_vec())
2235
        .map_err(|_| "coverage: the report is not text (LCOV or Cobertura XML is expected)".to_string())?;
2236
    let (files, outside, format) = tokio::task::spawn_blocking(move || crate::coverage::parse(&text))
2237
        .await
2238
        .map_err(|e| format!("coverage: {e}"))?
2239
        .map_err(|e| format!("coverage: {e}"))?;
2240
    let heads: Vec<ChangeHash> = run.head_list().into_iter().filter_map(ChangeHash::from_hex).collect();
2241
    let in_state: std::collections::HashSet<String> = app
2242
        .repos
2243
        .read(repo, move |r, cache| Ok(cache.load(r, &heads)?.snapshot.files.keys().cloned().collect()))
2244
        .await
2245
        .map_err(|e| format!("coverage: the run's files could not be read: {e}"))?;
2246
    let heads: Vec<String> = run.head_list().into_iter().map(String::from).collect();
2247
    let origin = crate::coverage::Origin {
2248
        repo_id: row.id,
2249
        run_id: Some(run.id),
2250
        run_number: run.number,
2251
        job_id: Some(job.id),
2252
        uploader: "",
2253
        job: &job.name,
2254
        bookmark: &run.bookmark,
2255
        state: &run.state,
2256
        heads: &heads,
2257
        blob,
2258
        format,
2259
    };
2260
    let id = crate::coverage::keep(app, &origin, files, outside, &in_state).await.map_err(|e| format!("coverage: {e}"))?;
2261
    let Some(r) = crate::coverage::report(&app.db, row.id, id).await.map_err(|e| format!("coverage: {e}"))? else {
2262
        return Err("coverage: the report was not kept".into());
2263
    };
2264
    // The `coverage` check on the run's state (#113): against the default
2265
    // bookmark, under the repository's rules.
2266
    let base = crate::coverage::baseline(&app.db, &r, &row.default_bookmark).await.map_err(|e| format!("coverage: {e}"))?;
2267
    let rules = crate::coverage::rules(&app.db, row.id).await.map_err(|e| format!("coverage: {e}"))?;
2268
    let (status, summary) = crate::coverage::verdict(&r, base.as_ref(), &row.default_bookmark, rules);
2269
    let url = format!("{}/{}/{}/coverage?report={}", app.config.base_url(), row.owner, row.name, r.id);
2270
    if let Ok(c) = db::hooks::upsert_check(
2271
        &app.db,
2272
        row.id,
2273
        db::hooks::CheckReport { state: &run.state, name: "coverage", status, summary: &summary, url: &url, reporter: None, seal: "" },
2274
    )
2275
    .await
2276
    {
2277
        let api = crate::api::check_of(&c);
2278
        app.bus.proposal(row.id, hub_api::ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
2279
        crate::hooks::emit(app, row, "check", "flow", serde_json::json!({ "check": api })).await;
2280
    }
2281
    let pct = r.percent().map(|p| format!("{p:.1}%")).unwrap_or_else(|| "no lines".into());
2282
    let dropped =
2283
        if r.dropped > 0 { format!(" ({} named files are not in this state and were left out)", r.dropped) } else { String::new() };
2284
    Ok(format!("coverage: {pct} of lines ({} of {}) in {} files{dropped}", r.lines_hit, r.lines_found, r.files))
2285
}
2286
2287
/// `POST /api/v1/flow/jobs/{id}/finish`.
2288
pub async fn finish(
2289
    State(app): State<Shared>,
2290
    headers: HeaderMap,
2291
    Path(id): Path<i64>,
2292
    Json(f): Json<Finish>,
2293
) -> Result<StatusCode, ApiError> {
2294
    let me = runner_auth(&app, &headers).await?;
2295
    let job = running_job(&app, id).await?;
2296
    let status = match (f.exit_code, &f.error) {
2297
        (Some(0), None) => "passed",
2298
        (Some(_), _) => "failed",
2299
        (None, _) => "error",
2300
    };
2301
    let (receipt, receipt_hash) = match &f.receipt {
2302
        Some(r) if r.job_name == job.name && Some(r.exit_code as i32) == f.exit_code => {
2303
            // A passing job's receipt names exactly the artifacts uploaded,
2304
            // in name order; a failing one's names none, though it may have
2305
            // kept `when "always"` artifacts (oxygenflow#37).
2306
            let kept: Vec<String> =
2307
                if r.exit_code == 0 { fdb::artifacts(&app.db, job.id).await?.into_iter().map(|a| a.blob).collect() } else { vec![] };
2308
            if r.outputs.iter().map(hex::encode).collect::<Vec<_>>() != kept {
2309
                return Err(ApiError(StatusCode::BAD_REQUEST, "the receipt names other outputs than the artifacts uploaded".into()));
2310
            }
2311
            (serde_json::to_string(r).unwrap_or_default(), hex::encode(r.hash()))
2312
        }
2313
        Some(_) => return Err(ApiError(StatusCode::BAD_REQUEST, "the receipt does not match the job".into())),
2314
        None => (String::new(), String::new()),
2315
    };
2316
    let error = f.error.clone().unwrap_or_default();
2317
    fdb::set_peaks(&app.db, job.id, f.peak_disk_mib, f.peak_memory_mib).await?;
2318
    let changed = fdb::finish(
2319
        &app.db,
2320
        job.id,
2321
        fdb::Outcome { status, exit_code: f.exit_code.map(i64::from), error: &error, receipt: &receipt, receipt_hash: &receipt_hash },
2322
    )
2323
    .await?;
2324
    if let Some(run) = fdb::run_by_id(&app.db, job.run_id).await? {
2325
        if let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? {
2326
            if let (Some(r), Some(signed)) = (&f.receipt, &f.signed_receipt) {
2327
                let (attest, signer, note) = match keep_receipt(&app, &me, &row, &run, r, signed).await {
2328
                    Ok((attest, signer)) => (attest, signer, String::new()),
2329
                    Err(e) => {
2330
                        tracing::warn!("flow: job {} receipt not kept: {e}", job.id);
2331
                        (String::new(), String::new(), e)
2332
                    }
2333
                };
2334
                fdb::set_receipt(&app.db, job.id, &attest, &signer, &note).await?;
2335
            }
2336
        }
2337
    }
2338
    report_changed(&app, job.run_id, changed).await?;
2339
    Ok(StatusCode::NO_CONTENT)
2340
}
2341
2342
/// Report the checks of jobs whose status changed.
2343
async fn report_changed(app: &Shared, run_id: i64, changed: Vec<fdb::Job>) -> sqlx::Result<()> {
2344
    let Some(run) = fdb::run_by_id(&app.db, run_id).await? else {
2345
        return Ok(());
2346
    };
2347
    let Some(row) = db::repos::get_by_id(&app.db, run.repo_id).await? else {
2348
        return Ok(());
2349
    };
2350
    let mut errored_on: Vec<i64> = Vec::new();
2351
    let some_passed = changed.iter().any(|j| j.status == "passed");
2352
    if !changed.is_empty() {
2353
        app.bus.live(&crate::events::topic::run(run_id), "jobs");
2354
    }
2355
    for j in changed {
2356
        let summary = match j.status.as_str() {
2357
            "passed" => match j.reused_from() {
2358
                Some(n) => format!("passed in run #{n} on this state, reused"),
2359
                None => format!("passed in {}", duration(&j)),
2360
            },
2361
            "failed" => format!("exit {} after {}", j.exit_code.unwrap_or(-1), duration(&j)),
2362
            "skipped" => "skipped: a dependency did not pass".into(),
2363
            "cancelled" => j.error.clone(),
2364
            _ => format!("could not run: {}", j.error),
2365
        };
2366
        report_check(app, &row, &run.state, run.number, &j.name, check_status(&j.status), &summary).await;
2367
        if j.status == "error" {
2368
            if let Some(r) = runner_of(app, j.id).await {
2369
                errored_on.push(r);
2370
            }
2371
        }
2372
    }
2373
    errored_on.dedup();
2374
    for r in errored_on {
2375
        drain_if_erroring(app, r).await;
2376
    }
2377
    if some_passed {
2378
        tell_approvers(app, &row, &run).await;
2379
    }
2380
    if let Some(done) = fdb::run_by_id(&app.db, run_id).await? {
2381
        if done.status == "failed" && !done.live() {
2382
            tell_failed(app, &row, &done).await;
2383
        }
2384
        // A pass after a failure on the same bookmark: fixed (#183).
2385
        if done.status == "passed" {
2386
            let before: Option<String> = sqlx::query_scalar(
2387
                "SELECT status FROM flow_runs WHERE repo_id = $1 AND bookmark = $2 AND id < $3 AND status IN ('passed', 'failed')
2388
                 ORDER BY id DESC LIMIT 1",
2389
            )
2390
            .bind(done.repo_id)
2391
            .bind(&done.bookmark)
2392
            .bind(done.id)
2393
            .fetch_optional(&app.db)
2394
            .await?;
2395
            // Or this very run failed and a job of it was run again.
2396
            let url = format!("/{}/{}/flow/{}", row.owner, row.name, done.number);
2397
            let failed_here: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM notifications WHERE kind = 'flow.failed' AND url = $1")
2398
                .bind(&url)
2399
                .fetch_one(&app.db)
2400
                .await?;
2401
            if before.as_deref() == Some("failed") || failed_here > 0 {
2402
                tell_fixed(app, &row, &done).await;
2403
            }
2404
        }
2405
    }
2406
    // A passing run of an upstream's default bookmark: consumers following
2407
    // it when green are bumped (Diffusion, #148).
2408
    if let Some(done) = fdb::run_by_id(&app.db, run_id).await? {
2409
        if done.status == "passed" && done.bookmark == row.default_bookmark {
2410
            let heads: Vec<ChangeHash> = done.head_list().iter().filter_map(|h| ChangeHash::from_hex(h)).collect();
2411
            let (app, row) = (app.clone(), row.clone());
2412
            tokio::spawn(async move { crate::diffusion::propagate(&app, &row, heads, true).await });
2413
        }
2414
        // A bump's run passed: a consumer that lands its bumps itself may
2415
        // land it now (docs/diffusion.md §4.2).
2416
        if let Some(path) = done.bookmark.strip_prefix("diffusion/").filter(|_| done.status == "passed") {
2417
            tokio::spawn(crate::diffusion::try_land(app.clone(), row.clone(), path.to_string()));
2418
        }
2419
    }
2420
    Ok(())
2421
}
2422
2423
/// The account OxygenFlow's notices come from, made on first use with no
2424
/// way to sign in.
2425
pub const ACCOUNT: &str = "oxygenflow";
2426
2427
async fn flow_account(pool: &db::Pool) -> Option<db::accounts::Account> {
2428
    if let Ok(Some(a)) = db::accounts::account_by_name(pool, ACCOUNT).await {
2429
        return Some(a);
2430
    }
2431
    db::accounts::create_account(pool, ACCOUNT, "oxygenflow@localhost", "!", "", false).await.ok()
2432
}
2433
2434
async fn runner_of(app: &Shared, job_id: i64) -> Option<i64> {
2435
    sqlx::query_scalar("SELECT runner_id FROM flow_jobs WHERE id = $1").bind(job_id).fetch_optional(&app.db).await.ok().flatten().flatten()
2436
}
2437
2438
/// A failed run (oxygenflow#30): its pusher and the repository's watchers
2439
/// are told, in their inboxes and by email as they chose, naming the jobs
2440
/// that did not pass.
2441
async fn tell_failed(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run) {
2442
    let Some(me) = flow_account(&app.db).await else { return };
2443
    let jobs = fdb::jobs(&app.db, run.id).await.unwrap_or_default();
2444
    let broken: Vec<String> = jobs.iter().filter(|j| matches!(j.status.as_str(), "failed" | "error")).map(|j| j.name.clone()).collect();
2445
    let pusher = db::accounts::account_by_name(&app.db, &run.actor).await.ok().flatten();
2446
    let on = if run.bookmark.is_empty() { String::new() } else { format!(" on {}", run.bookmark) };
2447
    crate::notify::deliver(
2448
        app,
2449
        crate::notify::Event {
2450
            kind: "flow.failed",
2451
            title: format!("{}/{}: run #{}{on} failed ({})", row.owner, row.name, run.number, broken.join(", ")),
2452
            url: format!("/{}/{}/flow/{}", row.owner, row.name, run.number),
2453
            actor: &me,
2454
            repo_id: row.id,
2455
            thread: None,
2456
            mention_text: "",
2457
            direct: pusher.into_iter().map(|a| a.id).collect(),
2458
        },
2459
    )
2460
    .await;
2461
}
2462
2463
/// A run that passes after its bookmark's last one failed (oxygenhub#183):
2464
/// its pusher and the repository's watchers hear it is green again.
2465
async fn tell_fixed(app: &Shared, row: &db::repos::RepoRow, run: &fdb::Run) {
2466
    let Some(me) = flow_account(&app.db).await else { return };
2467
    let pusher = db::accounts::account_by_name(&app.db, &run.actor).await.ok().flatten();
2468
    let on = if run.bookmark.is_empty() { String::new() } else { format!(" on {}", run.bookmark) };
2469
    crate::notify::deliver(
2470
        app,
2471
        crate::notify::Event {
2472
            kind: "flow.fixed",
2473
            title: format!("{}/{}: run #{}{on} passed: fixed", row.owner, row.name, run.number),
2474
            url: format!("/{}/{}/flow/{}", row.owner, row.name, run.number),
2475
            actor: &me,
2476
            repo_id: row.id,
2477
            thread: None,
2478
            mention_text: "",
2479
            direct: pusher.into_iter().map(|a| a.id).collect(),
2480
        },
2481
    )
2482
    .await;
2483
}
2484
2485
/// A runner whose last jobs all ended in infrastructure errors is drained,
2486
/// so it stops taking jobs it fails before running them, and the
2487
/// administrators are told (oxygenflow#30).
2488
async fn drain_if_erroring(app: &Shared, runner_id: i64) {
2489
    let n = app.config.flow.drain_after_errors;
2490
    let Ok(Some(last)) = db::runners::erroring(&app.db, runner_id, n).await else { return };
2491
    let Ok(Some(r)) = db::runners::get(&app.db, runner_id).await else { return };
2492
    if r.state != "active" || db::runners::set_state(&app.db, runner_id, "draining").await.is_err() {
2493
        return;
2494
    }
2495
    tracing::warn!("flow: runner {} drained after {n} errors in a row (last: {last})", r.name);
2496
    let Some(me) = flow_account(&app.db).await else { return };
2497
    let admins: Vec<i64> = sqlx::query_scalar("SELECT id FROM accounts WHERE is_admin = TRUE").fetch_all(&app.db).await.unwrap_or_default();
2498
    crate::notify::deliver(
2499
        app,
2500
        crate::notify::Event {
2501
            kind: "flow.runner_drained",
2502
            title: format!("Runner {} drained: its last {n} jobs ended in errors (last: {last})", r.name),
2503
            url: format!("/admin/runners/{runner_id}"),
2504
            actor: &me,
2505
            repo_id: 0,
2506
            thread: None,
2507
            mention_text: "",
2508
            direct: admins,
2509
        },
2510
    )
2511
    .await;
2512
}
2513
2514
/// The site's job time limits (oxygenhub#89): set on Admin → Runners →
2515
/// Settings, else from `hub.toml`.
2516
pub struct Limits {
2517
    /// For a job whose pipeline names none.
2518
    pub default_s: u64,
2519
    /// The most a pipeline may ask for.
2520
    pub max_s: u64,
2521
    /// Grace past a job's limit before the hub gives it up: a runner stops
2522
    /// a job at its limit and reports it within moments, so one still
2523
    /// running this long after is one the runner no longer reports (it was
2524
    /// restarted, or lost the hub while the job ended, oxygenhub#71).
2525
    pub grace_ms: i64,
2526
}
2527
2528
pub const SETTING_DEFAULT: &str = "flow.job_timeout_minutes";
2529
pub const SETTING_MAX: &str = "flow.job_timeout_max_minutes";
2530
pub const SETTING_GRACE: &str = "flow.lost_grace_minutes";
2531
2532
pub async fn limits(app: &Shared) -> Limits {
2533
    let minutes = |key: &'static str| async move {
2534
        db::accounts::setting(&app.db, key).await.ok().flatten().and_then(|v| v.parse::<u64>().ok()).filter(|m| *m > 0)
2535
    };
2536
    let default_m = minutes(SETTING_DEFAULT).await.unwrap_or(app.config.flow.job_timeout_minutes.max(1));
2537
    let max_m = minutes(SETTING_MAX).await.unwrap_or(default_m.max(6 * 60)).max(default_m);
2538
    let grace_m = minutes(SETTING_GRACE).await.unwrap_or(5);
2539
    Limits { default_s: default_m * 60, max_s: max_m * 60, grace_ms: grace_m as i64 * 60_000 }
2540
}
2541
2542
/// End every job still running past its time limit plus the grace:
2543
/// it is marked an error with the reason, the jobs that depended on it are
2544
/// skipped and its run settled, as when a runner reports an error.
2545
pub async fn reap_lost_jobs(app: &Shared) -> sqlx::Result<usize> {
2546
    let limits = limits(app).await;
2547
    let lost = fdb::running_past_limit(&app.db, db::now_ms(), limits.default_s, limits.grace_ms).await?;
2548
    let n = lost.len();
2549
    for job in lost {
2550
        let error = format!(
2551
            "lost: still running {} minutes after it started, past the time limit; the runner{} stopped reporting it",
2552
            (db::now_ms() - job.started_ms.unwrap_or(0)) / 60_000,
2553
            if job.runner.is_empty() { String::new() } else { format!(" {}", job.runner) },
2554
        );
2555
        let changed =
2556
            fdb::finish(&app.db, job.id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
2557
                .await?;
2558
        tracing::warn!("flow: job {} {error}", job.id);
2559
        report_changed(app, job.run_id, changed).await?;
2560
    }
2561
    Ok(n)
2562
}
2563
2564
/// End the jobs running on `runner` that it does not hold (oxygenhub#71):
2565
/// it restarted since claiming them, or never received the claim. A
2566
/// runner claims one job at a time, so a job it holds is always listed.
2567
async fn end_jobs_not_held(app: &Shared, runner: &db::runners::Runner, holding: &[i64]) -> sqlx::Result<()> {
2568
    for job in fdb::running_on(&app.db, runner.id).await? {
2569
        if holding.contains(&job.id) {
2570
            continue;
2571
        }
2572
        let error = format!("lost: the runner {} no longer holds this job (it restarted, or never received it)", runner.name);
2573
        let changed =
2574
            fdb::finish(&app.db, job.id, fdb::Outcome { status: "error", exit_code: None, error: &error, receipt: "", receipt_hash: "" })
2575
                .await?;
2576
        tracing::warn!("flow: job {} {error}", job.id);
2577
        report_changed(app, job.run_id, changed).await?;
2578
    }
2579
    Ok(())
2580
}
2581
2582
/// Start the scheduled runs due at `when` (oxygenflow#24): on each
2583
/// repository that runs Flow, the jobs of its default bookmark's pipeline
2584
/// with a `schedule` line due then. Returns how many runs started.
2585
pub async fn run_due(app: &Shared, when: flow_core::pipeline::When) -> usize {
2586
    let Ok(rows) = db::repos::list(&app.db).await else { return 0 };
2587
    let mut started = 0;
2588
    for row in rows.into_iter().filter(|r| enabled(app, r)) {
2589
        let Some(repo) = RepoName::new(&row.owner, &row.name) else { continue };
2590
        let b = row.default_bookmark.clone();
2591
        let found = app
2592
            .repos
2593
            .read(&repo, move |r, _| {
2594
                let Some(st) = r.view()?.bookmarks.get(&b).copied() else { return Ok(None) };
2595
                Ok(Some((st, r.store().get_state(&st)?.heads)))
2596
            })
2597
            .await;
2598
        let Ok(Some((state, heads))) = found else { continue };
2599
        if heads.is_empty() {
2600
            continue;
2601
        }
2602
        match start_run_at(app, &row, &row.default_bookmark, &state.to_hex(), &heads, &row.owner, "schedule", None, Some(when), &[]).await {
2603
            Ok(Some(_)) => started += 1,
2604
            Ok(None) => {}
2605
            Err(e) => tracing::warn!("flow: scheduled run of {}/{}: {e}", row.owner, row.name),
2606
        }
2607
    }
2608
    started
2609
}
2610
2611
/// The hub's clock as a [`When`](flow_core::pipeline::When).
2612
pub fn when_now() -> flow_core::pipeline::When {
2613
    let now = time::OffsetDateTime::now_utc();
2614
    flow_core::pipeline::When {
2615
        minute: now.minute() as u32,
2616
        hour: now.hour() as u32,
2617
        day: now.day() as u32,
2618
        month: u8::from(now.month()) as u32,
2619
        weekday: now.weekday().number_days_from_sunday() as u32,
2620
    }
2621
}
2622
2623
/// Start the scheduled runs due each minute, once a minute.
2624
pub async fn scheduler(app: Shared) {
2625
    let mut last = None;
2626
    loop {
2627
        tokio::time::sleep(std::time::Duration::from_secs(15)).await;
2628
        let minute = time::OffsetDateTime::now_utc().unix_timestamp() / 60;
2629
        if last == Some(minute) {
2630
            continue;
2631
        }
2632
        last = Some(minute);
2633
        let n = run_due(&app, when_now()).await;
2634
        if n > 0 {
2635
            tracing::info!("flow: {n} scheduled run(s) started");
2636
        }
2637
    }
2638
}
2639
2640
/// Look for lost jobs once a minute.
2641
pub async fn reaper(app: Shared) {
2642
    loop {
2643
        tokio::time::sleep(std::time::Duration::from_secs(60)).await;
2644
        if let Err(e) = requeue_lapsed(&app).await {
2645
            tracing::warn!("flow: looking for lapsed leases: {e}");
2646
        }
2647
        if let Err(e) = reap_lost_jobs(&app).await {
2648
            tracing::warn!("flow: looking for lost jobs: {e}");
2649
        }
2650
        match expire_approvals(&app, db::now_ms()).await {
2651
            Ok(n) if n > 0 => tracing::info!("flow: {n} approvals expired"),
2652
            Ok(_) => {}
2653
            Err(e) => tracing::warn!("flow: expiring approvals: {e}"),
2654
        }
2655
    }
2656
}
2657
2658
/// Check a runner's signed receipt for a job of `run` and keep it in the
2659
/// repository (Oxygen spec §14.6): the attestation's hex and the runner's
2660
/// name, or why it was not kept. It must be the job's receipt, for the
2661
/// run's state and repository, signed by the key the runner's token first
2662
/// signed with.
2663
pub async fn keep_receipt(
2664
    app: &Shared,
2665
    runner: &db::runners::Runner,
2666
    row: &db::repos::RepoRow,
2667
    run: &fdb::Run,
2668
    receipt: &flow_core::Receipt,
2669
    signed_hex: &str,
2670
) -> Result<(String, String), String> {
2671
    use oxy_core::receipt::SignedReceipt;
2672
    let bytes = hex::decode(signed_hex).map_err(|_| "the signed receipt is not hex".to_string())?;
2673
    let sr = SignedReceipt::decode(&bytes).map_err(|e| format!("not a signed receipt: {e}"))?;
2674
    sr.verify().map_err(|e| format!("it does not verify: {e}"))?;
2675
    if sr.receipt.hash().0 != receipt.hash() {
2676
        return Err("it signs another receipt than the job's".into());
2677
    }
2678
    let heads: Vec<oxy_core::hash::ChangeHash> = run.head_list().into_iter().filter_map(oxy_core::hash::ChangeHash::from_hex).collect();
2679
    let state = oxy_core::hash::hash_object(oxy_core::hash::ObjectType::State, &oxy_core::objects::StateObject::new(heads).encode());
2680
    if sr.state() != state {
2681
        return Err("it is for another state than the run's".into());
2682
    }
2683
    let signer = match &sr.certificate {
2684
        // Signed by a short-lived key this hub certified for this job
2685
        // (keyless, #241): the certificate stands for the runner's key.
2686
        Some(c) => {
2687
            let cert = &c.cert.cert;
2688
            if cert.issuer != app.hub_key.key || c.issuer.hash() != app.hub_key.key {
2689
                return Err("its certificate was not issued by this hub".into());
2690
            }
2691
            let subject = format!("repo:{}/{}:bookmark:{}", row.owner, row.name, run.bookmark);
2692
            if cert.subject != subject {
2693
                return Err(format!("its certificate is for {}, not {subject}", cert.subject));
2694
            }
2695
            if cert.claim("run") != Some(run.number.to_string().as_str()) || cert.claim("job") != Some(sr.receipt.job_name.as_str()) {
2696
                return Err("its certificate is for another run or job".into());
2697
            }
2698
            // Now is when this hub accepts it: a time the runner did not choose.
2699
            if !cert.covers(oxy_core::identity::Scope::SEAL, db::now_ms() as u64) {
2700
                return Err("its certificate does not cover now: certify the key just before signing the receipt".into());
2701
            }
2702
            format!("{} (short-lived key)", runner.name)
2703
        }
2704
        None => {
2705
            let key = sr.runner.hash().to_hex();
2706
            let bound = db::runners::bind_key(&app.db, runner.id, &key, &sr.runner.name).await.map_err(|e| e.to_string())?;
2707
            if bound != key {
2708
                return Err(format!("signed by {}, not the key this runner signs with ({})", &key[..12], &bound[..12.min(bound.len())]));
2709
            }
2710
            sr.runner.name.clone()
2711
        }
2712
    };
2713
    let name = RepoName::new(&row.owner, &row.name).ok_or("bad repository name")?;
2714
    let (rid, signers) = (sr.attest.repo, sr.sigs.iter().map(|s| s.key).collect::<Vec<_>>());
2715
    let cert = sr.certificate.as_ref().map(|c| (c.cert.cert.hash(), c.cert.cert.issuer));
2716
    let attest = app.repos.write(&name, move |repo, _| Ok(repo.add_receipt(&sr)?)).await.map_err(|e| e.to_string())?;
2717
    // The transparency log (#238): the receipt, and a short-lived key's
2718
    // certificate beside it.
2719
    let mut entries = vec![crate::tlog::Pending { kind: "receipt", repo: rid, repo_row: Some(row.id), object: attest, signers }];
2720
    if let Some((c, issuer)) = cert {
2721
        entries.push(crate::tlog::Pending { kind: "certificate", repo: rid, repo_row: Some(row.id), object: c, signers: vec![issuer] });
2722
    }
2723
    crate::tlog::log(app, entries).await;
2724
    Ok((attest.to_hex(), signer))
2725
}
2726
2727
/// A job's wall time, as the pages show it.
2728
pub fn duration(j: &fdb::Job) -> String {
2729
    match (j.started_ms, j.finished_ms) {
2730
        (Some(a), Some(b)) => human_ms(b - a),
2731
        (Some(a), None) => human_ms(db::now_ms() - a),
2732
        _ => "–".into(),
2733
    }
2734
}
2735
2736
pub fn human_ms(ms: i64) -> String {
2737
    let ms = ms.max(0);
2738
    if ms < 1000 {
2739
        format!("{ms} ms")
2740
    } else if ms < 60_000 {
2741
        format!("{:.1} s", ms as f64 / 1000.0)
2742
    } else {
2743
        format!("{} min {} s", ms / 60_000, (ms % 60_000) / 1000)
2744
    }
2745
}
2746
2747
/// Where a live run stands among the runners' work: what its viewers may
2748
/// know of it. Jobs of other repositories are named only when those are
2749
/// public; the rest are counted.
2750
#[derive(Clone, Debug, Default, PartialEq, Eq)]
2751
pub struct QueueInfo {
2752
    /// 1-based place of the run's first queued job among all queued jobs.
2753
    pub position: Option<usize>,
2754
    /// Jobs running now, and queued jobs ahead of the run's first one.
2755
    pub running: Vec<String>,
2756
    pub ahead: Vec<String>,
2757
    /// Of those, jobs in repositories the page may not name.
2758
    pub hidden: usize,
2759
}
2760
2761
impl QueueInfo {
2762
    /// "3rd in line" and the like.
2763
    pub fn place(&self) -> Option<String> {
2764
        self.position.map(|n| {
2765
            let suffix = match (n % 10, n % 100) {
2766
                (1, 11) | (2, 12) | (3, 13) => "th",
2767
                (1, _) => "st",
2768
                (2, _) => "nd",
2769
                (3, _) => "rd",
2770
                _ => "th",
2771
            };
2772
            format!("{n}{suffix} in line")
2773
        })
2774
    }
2775
}
2776
2777
/// The queue as `run` (of repository `repo_id`) sees it, from `queue`.
2778
pub fn queue_info(queue: &[fdb::QueueEntry], repo_id: i64, run_id: i64) -> QueueInfo {
2779
    let mut info = QueueInfo::default();
2780
    let first = queue.iter().filter(|e| e.status == "queued").position(|e| e.run_id == run_id);
2781
    info.position = first.map(|i| i + 1);
2782
    let label = |e: &fdb::QueueEntry| format!("{}/{} #{} {}", e.owner, e.name, e.run_number, e.job);
2783
    let mut queued_seen = 0;
2784
    for e in queue {
2785
        if e.run_id == run_id {
2786
            continue;
2787
        }
2788
        let ahead = match e.status.as_str() {
2789
            "running" => true,
2790
            _ => {
2791
                queued_seen += 1;
2792
                first.is_some_and(|f| queued_seen <= f)
2793
            }
2794
        };
2795
        if !ahead {
2796
            continue;
2797
        }
2798
        if e.repo_id != repo_id && e.visibility != "public" {
2799
            info.hidden += 1;
2800
        } else if e.status == "running" {
2801
            info.running.push(label(e));
2802
        } else {
2803
            info.ahead.push(label(e));
2804
        }
2805
    }
2806
    info
2807
}
2808
2809
#[cfg(test)]
2810
mod queue_tests {
2811
    use super::*;
2812
2813
    fn e(job_id: i64, run_id: i64, repo_id: i64, vis: &str, job: &str, status: &str) -> fdb::QueueEntry {
2814
        fdb::QueueEntry {
2815
            job_id,
2816
            run_id,
2817
            repo_id,
2818
            owner: "o".into(),
2819
            name: format!("r{repo_id}"),
2820
            visibility: vis.into(),
2821
            run_number: run_id,
2822
            job: job.into(),
2823
            status: status.into(),
2824
            runner: String::new(),
2825
            spec: String::new(),
2826
            sandbox: String::new(),
2827
            started_ms: None,
2828
            priority_rank: 2,
2829
            priority_note: String::new(),
2830
        }
2831
    }
2832
2833
    #[test]
2834
    fn a_run_learns_its_place_and_what_is_ahead_of_it() {
2835
        // Running first, then queued in claim order (as `fdb::queue` returns them).
2836
        let q = vec![
2837
            e(1, 10, 1, "public", "build", "running"),
2838
            e(2, 11, 2, "private", "test", "running"),
2839
            e(3, 10, 1, "public", "test", "queued"),
2840
            e(4, 12, 3, "private", "lint", "queued"),
2841
            e(5, 13, 4, "public", "build", "queued"),
2842
            e(6, 13, 4, "public", "test", "queued"),
2843
            e(7, 14, 5, "public", "late", "queued"),
2844
        ];
2845
        let info = queue_info(&q, 4, 13);
2846
        assert_eq!(info.position, Some(3));
2847
        assert_eq!(info.place().as_deref(), Some("3rd in line"));
2848
        assert_eq!(info.running, ["o/r1 #10 build"]);
2849
        assert_eq!(info.ahead, ["o/r1 #10 test"], "queued ahead, not behind");
2850
        assert_eq!(info.hidden, 2, "private repositories are counted, not named");
2851
        // A private repository's own jobs are named to its viewers.
2852
        assert_eq!(queue_info(&q, 3, 12).ahead, ["o/r1 #10 test"]);
2853
        assert_eq!(queue_info(&q, 3, 12).position, Some(2));
2854
        // A run with nothing queued has no place.
2855
        assert_eq!(queue_info(&q, 1, 99).position, None);
2856
        let ordinal = |n| QueueInfo { position: Some(n), ..Default::default() }.place().unwrap();
2857
        assert_eq!(
2858
            [ordinal(1), ordinal(2), ordinal(11), ordinal(22), ordinal(113)],
2859
            ["1st in line", "2nd in line", "11th in line", "22nd in line", "113th in line"]
2860
        );
2861
    }
2862
}
2863
2864
#[cfg(test)]
2865
mod placement_tests {
2866
    use super::*;
2867
2868
    #[test]
2869
    fn a_waiting_job_says_what_each_runner_lacks() {
2870
        use crate::db::runners::Runner;
2871
        let rootfs = "ab".repeat(32);
2872
        let job = fdb::Job {
2873
            id: 7,
2874
            runtime: "syscall".into(),
2875
            sandbox: serde_json::json!({ "rootfs": rootfs, "memory_mib": 4096, "cpus": 2 }).to_string(),
2876
            spec: serde_json::json!({ "name": "build" }).to_string(),
2877
            ..Default::default()
2878
        };
2879
        let now = db::now_ms();
2880
        let runner = |id: i64, name: &str| Runner {
2881
            id,
2882
            name: name.into(),
2883
            state: "active".into(),
2884
            last_seen_ms: Some(now),
2885
            arch: "x86_64".into(),
2886
            tiers: "microvm,syscall".into(),
2887
            images: serde_json::to_string(&[&rootfs]).unwrap(),
2888
            memory_mib: Some(16384),
2889
            cpus: Some(8),
2890
            ..Default::default()
2891
        };
2892
        let archs = std::collections::HashMap::new();
2893
        let why = |runners: &[Runner], declines: &[fdb::DeclineRow]| {
2894
            why_waiting(&job, "andy", 1, runners, &archs, declines, now, &Default::default())
2895
        };
2896
        assert_eq!(why(&[], &[]), "no runner is online");
2897
        assert_eq!(why(&[runner(1, "earth-1")], &[]), "", "one can take it: it only waits its turn");
2898
        let microvm_only = Runner { tiers: "microvm".into(), ..runner(1, "earth-1") };
2899
        let riscv = Runner { arch: "riscv64".into(), ..runner(2, "narvi") };
2900
        let small = Runner { memory_mib: Some(2048), ..runner(3, "pi") };
2901
        let other = Runner { scope_owner: "bob".into(), ..runner(4, "bobs") };
2902
        let offline = Runner { last_seen_ms: Some(now - 3_600_000), ..runner(5, "gone") };
2903
        assert_eq!(
2904
            why(&[microvm_only, small, other, offline], &[]),
2905
            "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"
2906
        );
2907
        let archs_known: std::collections::HashMap<String, String> = [(rootfs.clone(), "x86_64".to_string())].into();
2908
        assert_eq!(
2909
            why_waiting(&job, "andy", 1, &[riscv], &archs_known, &[], now, &Default::default()),
2910
            "no runner can take it: narvi is riscv64; the job needs x86_64"
2911
        );
2912
        let without = Runner { images: "[]".into(), ..runner(6, "new") };
2913
        assert_eq!(why(std::slice::from_ref(&without), &[]), "no runner can take it: new does not hold image abababababab");
2914
        // A WASM job has no image: holding none is no reason to wait.
2915
        let wasm = fdb::Job { runtime: "wasm".into(), sandbox: r#"{"memory_mib":256}"#.into(), ..job.clone() };
2916
        let wasm_runner = Runner { tiers: "microvm,wasm".into(), ..without };
2917
        assert_eq!(why_waiting(&wasm, "andy", 1, &[wasm_runner], &archs, &[], now, &Default::default()), "", "it only waits its turn");
2918
        let d = fdb::DeclineRow {
2919
            job_id: 7,
2920
            runner_id: 1,
2921
            runner: "earth-1".into(),
2922
            reason: "only 512 MiB of memory is free here".into(),
2923
            ms: now,
2924
        };
2925
        assert_eq!(
2926
            why(&[runner(1, "earth-1")], std::slice::from_ref(&d)),
2927
            "no runner can take it: earth-1 declined it: only 512 MiB of memory is free here"
2928
        );
2929
        let old = fdb::DeclineRow { ms: now - fdb::DECLINE_HOLDS_MS - 1, ..d };
2930
        assert_eq!(why(&[runner(1, "earth-1")], &[old]), "", "an old decline no longer holds");
2931
    }
2932
}