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