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