Diffusion: the bump 1d634f698ecd

/// The bookmark a consumer's bump for the subrepo at `path` lives on.

pub fn bump_bookmark(path: &str) -> String {

    format!("diffusion/{}", path.trim_matches('/'))

}

/// What a bump did.

#[derive(Clone, Debug, PartialEq, Eq)]

pub enum Bumped {

    /// The bump bookmark now holds the target plus one change moving the pin.

    Moved { bookmark: String, change: ChangeHash, heads: Vec<ChangeHash> },

    /// The pin already holds the upstream state.

    UpToDate,

    /// The bump bookmark already moves the pin to that state.

    Already,

    /// The upstream state does not hold everything the pin does (upstream

    /// moved backwards or was rewritten): consumers only move forward.

    Backwards,

    /// The consumer has no Oxygen pin of that upstream at `path` on its

    /// target bookmark.

    NoPin,

}

/// How the upstream's state `new` relates to a consumer's pin `old`, read

/// in the upstream: `Some(n)` new changes when `new` holds all of `old`

/// and more, `Some(0)` when it adds nothing, `None` when it lacks some.

pub async fn ahead_of(

    app: &Shared,

    upstream: &RepoName,

    old: Vec<ChangeHash>,

    new: Vec<ChangeHash>,

) -> Result<Option<usize>, crate::repos::RepoError> {

    app.repos

        .read(upstream, move |r, cache| {

            let (o, n) = (cache.summary(r, &old)?, cache.summary(r, &new)?);

            if !o.changes.iter().all(|c| n.changes.contains(c)) {

                return Ok(None);

            }

            Ok(Some(n.changes.len() - o.changes.len()))

        })

        .await

}

/// Move `consumer`'s pin of `upstream` at `path` to `new_heads`, on a bump

/// bookmark built from `target` (§4.3): one change, signed with the hub's

/// key, on the target's heads. The upstream decides forwardness.

pub async fn bump(

    app: &Shared,

    consumer: &RepoRow,

    target: &str,

    path: &str,

    upstream: &RepoRow,

    new_heads: Vec<ChangeHash>,

) -> Result<Bumped, crate::repos::RepoError> {

    use oxy_core::identity::Domain;

    use oxy_core::subrepo::Pin;

    let (Some(cname), Some(uname)) = (RepoName::new(&consumer.owner, &consumer.name), RepoName::new(&upstream.owner, &upstream.name))

    else {

        return Ok(Bumped::NoPin);

    };

    let upstream_id = app.repos.read(&uname, |r, _| Ok(r.id()?)).await?;

    // The consumer's current pin at `path` on its target, and on its bump

    // bookmark if it has one.

    let (t, p) = (target.to_string(), path.trim_matches('/').to_string());

    let (current, bumped) = app

        .repos

        .read(&cname, move |r, cache| {

            let pin_on = |bookmark: &str| -> Result<Option<Pin>, crate::repos::RepoError> {

                let heads = heads_of(r, bookmark)?;

                if heads.is_empty() {

                    return Ok(None);

                }

                let loaded = cache.load(r, &heads)?;

                let Some(f) = loaded.snapshot.files.get(&p) else { return Ok(None) };

                let oxy_core::state::FileContent::Opaque { blobs } = &f.content else { return Ok(None) };

                let Some(b) = blobs.first() else { return Ok(None) };

                Ok(Pin::decode(&r.read_blob(b)?).ok())

            };

            Ok((pin_on(&t)?, pin_on(&bump_bookmark(&p))?))

        })

        .await?;

    let Some(Pin::Oxy { repo, heads: old, bookmark }) = current else { return Ok(Bumped::NoPin) };

    if let Some(Pin::Oxy { heads: b, .. }) = &bumped {

        let (mut b, mut n) = (b.clone(), new_heads.clone());

        b.sort();

        n.sort();

        if b == n {

            return Ok(Bumped::Already);

        }

    }

    if repo != upstream_id {

        return Ok(Bumped::NoPin);

    }

    match ahead_of(app, &uname, old.clone(), new_heads.clone()).await? {

        None => return Ok(Bumped::Backwards),

        Some(0) => return Ok(Bumped::UpToDate),

        Some(_) => {}

    }

    let (key, secret) =

        crate::keys::load_secret(&app.config.keys_dir()).map_err(|e| crate::repos::RepoError::Io(std::io::Error::other(e.to_string())))?;

    let identity = app.hub_key.identity.clone();

    let upstream_label = format!("{}/{}", upstream.owner, upstream.name);

    let (t, p) = (target.to_string(), path.trim_matches('/').to_string());

    let pin = Pin::Oxy { repo, heads: new_heads.clone(), bookmark };

    let short: Vec<String> = new_heads.iter().map(|h| h.to_hex()[..12].to_string()).collect();

    let message = format!("Diffusion: move {p} to {upstream_label} {}", short.join("+"));

    app.repos

        .write(&cname, move |r, _| {

            let base = heads_of(r, &t)?;

            let change = r.build_pin_change(&base, &p, &pin, &message, key)?;

            let hash = change.hash();

            let sig = secret.sign(Domain::Change, &key, &hash);

            let mut state = r.load_state(&base)?;

            state.add(change.clone()).map_err(|e| crate::repos::RepoError::Oxy(oxy_core::repo::RepoError::Msg(e.to_string())))?;

            let mut candidates = base.clone();

            candidates.push(hash);

            let heads = state.maximal(&candidates);

            let bookmark = bump_bookmark(&p);

            // The bump bookmark is the hub's own and is rebuilt on the

            // target each time, so the bump it replaces may go.

            let mut update = r.host_ref_update(&bookmark, &heads, Some((&key, &secret)))?;

            update.force = true;

            let report = r.apply_hosted(Some((change, vec![sig])), &[identity], update)?;

            if let Some(refused) = report.results.iter().find(|x| !x.ok) {

                return Err(crate::repos::RepoError::Oxy(oxy_core::repo::RepoError::Msg(format!(

                    "the bump was refused: {}",

                    refused.reason

                ))));

            }

            Ok(Bumped::Moved { bookmark, change: hash, heads })

        })

        .await

}

    // A bump (DF3): one signed change on the target moving only the pin, on

    // `diffusion/deps/api`; again with the same state, nothing new.

    let game_row = db::repos::get(&h.app.db, "andy", "game").await.unwrap().unwrap();

    let api_row = db::repos::get(&h.app.db, "andy", "api").await.unwrap().unwrap();

    let api_heads = api.bookmark_heads().unwrap();

    let bumped = oxygenhub::diffusion::bump(&h.app, &game_row, "main", "deps/api", &api_row, api_heads.clone()).await.unwrap();

    let oxygenhub::diffusion::Bumped::Moved { bookmark, heads, .. } = bumped else { panic!("{bumped:?}") };

    assert_eq!(bookmark, "diffusion/deps/api");

    game.fetch("origin").unwrap();

    let bump_state = game.load_state(&heads).unwrap().materialize();

    let pin = match &bump_state.files["deps/api"].content {

        oxy_core::state::FileContent::Opaque { blobs } => oxy_core::subrepo::Pin::decode(&game.read_blob(&blobs[0]).unwrap()).unwrap(),

        other => panic!("{other:?}"),

    };

    assert!(

        matches!(&pin, oxy_core::subrepo::Pin::Oxy { heads, .. } if { let mut a = heads.clone(); a.sort(); let mut b = api_heads.clone(); b.sort(); a == b }),

        "{pin:?}"

    );

    assert!(bump_state.files.contains_key("game.c"), "the rest of the game is as it was");

    assert_eq!(

        oxygenhub::diffusion::bump(&h.app, &game_row, "main", "deps/api", &api_row, api_heads.clone()).await.unwrap(),

        oxygenhub::diffusion::Bumped::Already

    );

    // A state lacking what the pin has is not followed backwards.

    write(api_work.path(), "other.c", "v3\n");

    api.snapshot("t").unwrap();

    let v3 = api.commit("api v3, on its own", &[]).unwrap();

    assert!(api.push("origin", false).unwrap().iter().all(|r| r.ok));

    let only_v3 = api.load_state(&[v3]).unwrap().heads().to_vec();

    assert_eq!(

        oxygenhub::diffusion::bump(&h.app, &game_row, "main", "deps/api", &api_row, only_v3).await.unwrap(),

        oxygenhub::diffusion::Bumped::Backwards

    );

    // The upstream moves again: the same bookmark moves.

    let newer = api.bookmark_heads().unwrap();

    let again = oxygenhub::diffusion::bump(&h.app, &game_row, "main", "deps/api", &api_row, newer).await.unwrap();

    assert!(matches!(again, oxygenhub::diffusion::Bumped::Moved { ref bookmark, .. } if bookmark == "diffusion/deps/api"), "{again:?}");

- **Architecture** (OxygenFlow spec §11.2–§11.3, oxygenflow#36): a runner reports each image's architecture on its claims (`image_archs`), kept in `flow_images`; a job is offered only to a runner whose architecture matches its sandbox's `arch`, else its image's as known; unknown matches, as before. The queue says which architecture a waiting job asks for. **Images by hash** (oxygenflow#39, Jetstream): `flow rootfs push HASH` sends a rootfs image as the FastCDC chunks the hub lacks (`POST /flow/images/missing`, `PUT /flow/images/chunks/{hash}`, by a token that may write repositories) and then its manifest (`PUT /flow/images/{hash}`), which the hub accepts only when every chunk is held and they make an image with that hash; chunks are kept zstd-compressed under `<data>/images`, shared by every image, and `jet_images` lists what is held. Runners and accounts fetch with `GET /flow/images/{hash}` and `GET /flow/images/chunks/{hash}`. A runner whose claims say `fetches_images` is offered jobs whose image only the hub holds, and fetches it before its preflight. Each claim also carries the runner's `facts` (OxygenFlow spec §11.1, oxygenflow#40): free disk, load, speed score and class, kernel; the hub keeps the latest on the runner, shows them on Admin › Runners and in `GET /runners`. A job's finish carries the most disk and memory it took (`peak_disk_mib`, `peak_memory_mib`, oxygenflow#41); a new job's `need_disk_mib` is the most its last five runs of the same repository and name took, plus a quarter and 64 MiB, and it is offered only to a runner whose claim reports at least that much free disk; the waiting reason says so. **Ranking** (oxygenflow#42): a job that another free runner which polled in the last 10 s would do better (it holds the job's image while the claimant would fetch it, or has a higher speed class) is held from the claimant for up to 15 s, then any runner that fits takes it; each job records why it ran where it did (`placed`: "holds the image, idle, speed 100 (class 3)", with "after N s held for a better runner" when it was), shown on the run page, in the API and by `oh run view`. A run whose jobs pin an image held by neither the hub nor a runner sets a failing `pipeline/images` check on its state (#137), naming the images and how to send them (`flow rootfs push`), so a proposal pinning a new image shows it before it lands; a later run of the state turns it to passed once every image is held. A placement pass every 15 seconds works out why each ready queued job no runner can take waits, from what each online runner offered at its last claim (scope, tier, architecture, image held, labels, memory and CPUs, a recent decline), and shows it on the job (API `waiting`, `oh run view` and `oh run watch`, its panel open on the run page) and in its check's summary, so a proposal says why its check is stuck (#28). **Diffusion** (#148, `docs/diffusion.md`): a push that moves a repository's default bookmark, or the bookmark its work lands on (the most common target of its proposals landed in the last 90 days), records each Oxygen subrepo pin in the new state (`diffusion_pins`: consumer, bookmark, path, the upstream's Oxygen repository id, the pinned heads); a hub that had no index fills it at start. `GET /repos/{owner}/{name}/consumers` lists the consumers the caller may read, each with its pin and how many changes of this repository's default bookmark it lacks (`behind`, null when the pin names changes this repository does not hold), and the overview shows them as Used by. A consumer follows a subrepo's upstream as its `.oxymodules` entry says (`follow = off | green | any`, `land = propose | auto`, `target` naming the bookmark to bump, `watch` listing paths whose upstream changes are flagged), else as its repository setting says (Settings › Diffusion, or `PUT /repos/{owner}/{name}/diffusion {"follow": ...}` by its owners and admins; migration 0058), else as `[diffusion] follow` in hub.toml says (default `off`). A **bump** moves a consumer's pin at a path to a newer upstream state: one change on the target bookmark's heads that replaces only the pin (oxy-core `build_pin_change`), signed with the hub's key, on the bookmark `diffusion/<path>`, which the hub owns and rebuilds on the target each time (a forced update). It is skipped when the pin already holds the state, when the bump bookmark already moves it there, or when the state lacks changes the pin has (consumers only move forward). **Images page** (#146): Admin › Runners › Images lists every rootfs image a runner holds, the hub keeps, or a job ran on in the last 90 days (from each job's sandbox), newest use first: its size and architecture, where it is (the hub, each runner holding it, each runner fetching it from the swarm now), the repositories whose jobs used it, and who sent it; an image held nowhere is marked. **The swarm** (#144, oxygenflow docs/jetstream.md §8.1): a runner in an image swarm reports its peer address, its site and the BLAKE3 of its TLS certificate with each claim (`swarm`; without a certificate it is not in the swarm), kept in memory and shown on Admin › Runners. `POST /flow/swarm/announce {image, state}` (by a runner; `fetching`, `done` or `stopped`) returns the online runners in its site that hold the image or announced fetching it in the last 45 seconds, each with its certificate's fingerprint, which the fetcher pins its TLS connection to, and a ticket signed with the hub key (JSON naming the runner, its site and an expiry 15 minutes on, hex, then the signature) that peers check against `/.well-known/oxyhub-key` before serving chunks; a runner that has not reported an address is told to add `[runner.swarm]` (409).