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