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