OXYGENHUB
# c4e432da4bc9 oxygenhub / docs / diffusion.md
9.9 KiB · Markdown · last changed Diffusion: an upstream without checks is amber, not green 23 days ago renderedsource blame history raw
1
# Diffusion: upstream changes reach their consumers
2
3
Status: design, 2026-10-12. D1 is planned first; nothing is built yet.
4
"Diffusion" is a working name (changes diffuse from an upstream into the
5
repositories that pin it); Andy has not confirmed it.
6
7
## 1. The problem
8
9
R* API is a subrepo of Metal Gear, Metal Gear 2, Super Mario Land and
10
others. When it changes, each consumer should take the change, test it,
11
and propose it when it works, with no one opening proposals by hand.
12
Renovate and Dependabot do this for package manifests; Diffusion does it
13
for Oxygen pins, as part of Oxygen, and goes further than they can.
14
15
## 2. Why Oxygen can do better
16
17
- **The dependency graph is exact.** An Oxygen pin names a repository id
18
  and a state, and is a verifiable object (spec §7.8). The hub already
19
  reads every pin in a state to give jobs their subrepos. Nothing is
20
  scanned or guessed.
21
- **A pin is a set of changes, and independent changes commute.** A
22
  consumer can take an upstream state minus one change and whatever is
23
  built on it (§6). Git tools can only pin one commit: all or nothing.
24
- **Bumps never need rebasing.** The pin change commutes with the
25
  consumer's own work; only a consumer moving the same pin itself
26
  conflicts, as an ordinary replace conflict.
27
- **Everything is signed.** The bump, the upstream changes and the CI
28
  receipts are signed objects, so a consumer can check what it takes, even
29
  from another hub.
30
31
## 3. The approaches compared
32
33
| Approach | Strength | Weakness |
34
|---|---|---|
35
| Bump proposals (Renovate, Dependabot) | Consumers stay in charge; auditable; works across hubs | Reactive: breakage is found after upstream ships |
36
| Monorepo at head (Google) | Upstream cannot land what breaks a consumer | Takes control from consumers; upstream sees all code; one hub only |
37
| Upstream-driven migrations (large-scale changes, codemods) | Handles breaking changes, not just detects them | Needs tooling per change |
38
| Consumer-gated promotion (contract testing) | Prevents breakage | Needs consumers' tests to run upstream |
39
40
Diffusion is bump proposals as the base, with consumer checks on upstream
41
proposals (§7), partial pins (§6) and repair (§8) on top.
42
43
## 4. D1: follow and propose
44
45
### 4.1 The reverse pin index
46
47
When a push moves a repository's default bookmark, the hub records each
48
Oxygen pin in the new state: consumer, path, the upstream repository id
49
and the pinned heads (`diffusion_pins`). That answers "who consumes R*
50
API, at which state" at once. An upstream repository's page shows its
51
consumers on this hub ("Used by"); the API gives
52
`GET /repos/{owner}/{name}/consumers`.
53
54
### 4.2 Turning it on
55
56
A consumer follows a subrepo when, in order of precedence:
57
58
1. its `.oxymodules` entry says so, beside the existing `url` and
59
   `bookmark` keys:
60
61
   ```toml
62
   [rstar-api]
63
   url = "https://oxygenhub.io/doomsdayone/rstar-api"
64
   bookmark = "main"
65
   follow = "green"   # off | green | any
66
   land = "propose"   # propose | auto
67
   ```
68
69
2. else its repository setting (Settings › Subrepos), so an
70
   administrator can turn it on without a commit;
71
3. else the hub's default (`[diffusion] follow` in hub.toml, `off`).
72
73
`green` waits for the upstream state's required checks to pass; `any`
74
follows every move. An upstream with no checks at all is **unverified**
75
(amber): it never turns green, so its moves bump green followers too, and
76
the proposal is labelled `upstream unverified` with a note saying only the
77
consumer's pipeline tested it (decided by Andy, 2026-10-13). A passing run
78
of the upstream later clears it. `auto` lands a green bump itself when the consumer's
79
trust policy and required checks allow it; D1 only proposes.
80
81
### 4.3 The bump
82
83
When an upstream's followed bookmark reaches a new state S (and, for
84
`green`, S's required checks pass), for each consumer that follows it:
85
86
- **Skip** when the consumer's pin already holds S, or when S does not
87
  hold everything the current pin does (upstream moved backwards or was
88
  rewritten). Consumers only move forward.
89
- **Build** one change on the consumer's default heads that replaces the
90
  pin's blob with a pin of S. The hub signs it with its delegate key, as
91
  it signs wiki edits, authored by the hub's `diffusion` account.
92
- **Place** it on the bookmark `diffusion/<path>`: the consumer's default
93
  heads plus the change. One bookmark per consumer and subrepo, moved in
94
  place when upstream moves again, so there is never a pile of bumps.
95
- **Propose** it, once: a proposal from `diffusion/<path>` to the default
96
  bookmark, labelled `dependencies`, kept up to date as the bookmark
97
  moves. Its CI runs on the projected state like any proposal's.
98
99
A trust policy that does not admit the hub's key still gets the
100
proposal; it is landed from a client, as today.
101
102
### 4.4 What the proposal says
103
104
- The upstream, the old pin and the new state.
105
- **The exact changelog:** every upstream change in S and not in the old
106
  pin, with its author, whether it is signed, and the issues it closes or
107
  refers to.
108
- Its checks, as for any proposal. A red bump stays open, with the
109
  failing check; D2 then says which upstream change broke it.
110
111
## 5. Across hubs
112
113
Each hub only ever writes to its own repositories. What one hub tells
114
another is a hint; the consumer's hub fetches and verifies the facts.
115
116
- **Polling always works.** The consumer's hub has the upstream URL in
117
  `.oxymodules`; it asks for the followed bookmark every few minutes. An
118
  upstream kept in a Strata bucket with no hub is polled by reading its
119
  bookmark record.
120
- **Subscribing makes it prompt.** The consumer's hub asks the upstream's
121
  hub to notify it when the bookmark moves. Notes are signed with the
122
  upstream hub's key and carry only "repository *id* moved to state *S*";
123
  the consumer fetches and verifies. A forged note causes a fetch, nothing
124
  more; a lost one is caught by the next poll.
125
- **Private upstreams** are read with a read-only credential the
126
  consumer's owner stores as a secret on the consumer's hub.
127
- **"Green" across hubs** is evidence the consumer checks: a Flow receipt
128
  for S, signed by a runner the upstream hub vouches for. The consumer's
129
  policy names the upstream hub keys it accepts, and may also require
130
  every upstream change to be signed by the upstream's maintainers, which
131
  holds even if the upstream hub is compromised.
132
- **Consumer checks across hubs (§7)** are opt-in on both sides; the
133
  consumer's hub runs them on its own runners and returns only a signed
134
  summary, or nothing.
135
136
## 6. D2: partial pins and the culprit
137
138
A pin is a state: any set of changes closed under dependencies. So a
139
consumer can pin "upstream S, minus change X and everything built on X":
140
its heads are the maximal changes of `closure(S) − ({X} ∪ dependents(X))`,
141
well-formed by construction.
142
143
When a bump of N upstream changes fails:
144
145
1. Flow searches for the culprit by testing subsets of the N changes (a
146
   delta-debugging search over independent changes, bounded in runs).
147
2. The bump proposal then pins everything except the culprit and its
148
   dependents, and says which change is held back and why, with the
149
   failure.
150
3. The consumer gets the rest at once; the held-back change comes with a
151
   later bump, once upstream fixes it.
152
153
`oxy submodule` and checkout take such pins as they are (a pin is heads);
154
`oxy submodule status` names the changes a partial pin leaves out.
155
156
## 7. D3: consumers test upstream proposals
157
158
A proposal on R* API can run each consumer's pipeline with its pin swapped
159
for the proposal's projected state, committing nothing to the consumer
160
(the claim already carries subrepo pins; the run overrides one). Each
161
consumer's result appears on the upstream proposal as a check,
162
`consumers/<owner>/<name>`, with a summary: "Metal Gear ✔, Super Mario
163
Land ✘ (test X)". The person changing the API sees what breaks before it
164
lands, which is the monorepo's main strength without taking consumers'
165
control. An upstream may make consumer checks required.
166
167
## 8. D4: repair
168
169
- **Migrations with the change.** An upstream change that alters the API
170
  may carry a migration (a script, or instructions for an agent) under
171
  `.diffusion/migrations/`. A bump spanning it runs the migration in the
172
  consumer and adds the result as a separate change on the bump proposal.
173
- **An agent's fix.** When a bump is red, a scoped agent key (an agent
174
  home with `changes` scope on that consumer, never `refs`) may add a fix
175
  as a separate change to the proposal, for the consumer's owner to
176
  review. The bump and the fix stay separate changes, so either can be
177
  dropped.
178
179
## 9. D5: reach
180
181
- **Auto-land** (`land = "auto"`): a green bump lands itself when the
182
  consumer's trust policy and required checks allow it, and every
183
  upstream change is signed by keys the policy trusts.
184
- **Chains:** landing a bump moves the consumer's default bookmark, which
185
  may be followed in turn.
186
- **Grouping and quiet hours:** several upstreams' bumps in one proposal;
187
  no bumps outside set hours.
188
- **Cross-hub** polling and subscriptions (§5).
189
- **Channels:** with Cylinder, a consumer follows `rstar-api:stable`, a
190
  signed channel whose moves are gated by consumer checks (§7).
191
192
## 10. Order
193
194
| Step | What |
195
|---|---|
196
| D1 | The reverse pin index and Used by; turning it on; the signed bump on `diffusion/<path>`, moved in place; the proposal with the changelog |
197
| D2 | Partial pins; the culprit search |
198
| D3 | Consumer checks on upstream proposals |
199
| D4 | Migrations and agent fixes |
200
| D5 | Auto-land, chains, grouping, cross-hub, channels |
201
202
D2 is what no other tool can do; D3 is worth the most.
203
204
## 11. Open questions
205
206
- **The name:** Diffusion, or plainer ("Follow")?
207
- **Who may turn it on** for a consumer: its owner and administrators, or
208
  also the upstream's maintainers (by offering, which the consumer
209
  accepts)?
210
- **Bot identity:** a `diffusion` account per hub, or the upstream
211
  pusher's name with the hub as delegate?
212
- **Cost limits** for the culprit search and consumer checks: runs per
213
  bump, per upstream proposal, per day.