OXYGENHUB
◆ close-proposal-140 oxygenhub / docs / diffusion.md
10.4 KiB · Markdown · last changed Diffusion: an upstream without checks is amber, not green 22 days ago renderedsource blame history raw
8620925e Andy McCall ↶ 1
# Diffusion: upstream changes reach their consumers
2
3
Status: design, 2026-10-12. D1 is planned first; nothing is built yet.
b20ddaf9 Andy McCall ↶ 4
The name **Diffusion** was confirmed by Andy on 2026-10-12: changes
5
diffuse from an upstream into the repositories that pin it.
8620925e Andy McCall ↶ 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
b20ddaf9 Andy McCall ↶ 67
   target = "develop" # optional: the bookmark to bump (default: learned, §4.3)
8620925e Andy McCall ↶ 68
   ```
69
70
2. else its repository setting (Settings › Subrepos), so an
71
   administrator can turn it on without a commit;
72
3. else the hub's default (`[diffusion] follow` in hub.toml, `off`).
73
74
`green` waits for the upstream state's required checks to pass; `any`
9aaa88b2 Andy McCall ↶ 75
follows every move. An upstream with no checks at all is **unverified**
76
(amber): it never turns green, so its moves bump green followers too, and
77
the proposal is labelled `upstream unverified` with a note saying only the
78
consumer's pipeline tested it (decided by Andy, 2026-10-13). A passing run
79
of the upstream later clears it. `auto` lands a green bump itself when the consumer's
8620925e Andy McCall ↶ 80
trust policy and required checks allow it; D1 only proposes.
81
82
### 4.3 The bump
83
b20ddaf9 Andy McCall ↶ 84
**Which bookmark of the consumer** (decided 2026-10-12): the bookmark its
85
work lands on. The hub learns it per consumer from where the
86
consumer's proposals land (the most common target of those landed in the
87
last 90 days), falling back to the default bookmark; a `target` key in
88
the consumer's `.oxymodules` entry overrides it. The pin index (§4.1)
89
records pins on that bookmark as well as the default. So a game whose
90
default is `main` but whose work lands on `develop` is bumped on
91
`develop`, with no setup, and follows if its workflow changes.
92
8620925e Andy McCall ↶ 93
When an upstream's followed bookmark reaches a new state S (and, for
94
`green`, S's required checks pass), for each consumer that follows it:
95
96
- **Skip** when the consumer's pin already holds S, or when S does not
97
  hold everything the current pin does (upstream moved backwards or was
98
  rewritten). Consumers only move forward.
b20ddaf9 Andy McCall ↶ 99
- **Build** one change on the target bookmark's heads that replaces the
8620925e Andy McCall ↶ 100
  pin's blob with a pin of S. The hub signs it with its delegate key, as
101
  it signs wiki edits, authored by the hub's `diffusion` account.
b20ddaf9 Andy McCall ↶ 102
- **Place** it on the bookmark `diffusion/<path>`: the target's heads
103
  plus the change. One bookmark per consumer and subrepo, moved in
8620925e Andy McCall ↶ 104
  place when upstream moves again, so there is never a pile of bumps.
b20ddaf9 Andy McCall ↶ 105
- **Propose** it, once: a proposal from `diffusion/<path>` to the target
8620925e Andy McCall ↶ 106
  bookmark, labelled `dependencies`, kept up to date as the bookmark
107
  moves. Its CI runs on the projected state like any proposal's.
108
109
A trust policy that does not admit the hub's key still gets the
110
proposal; it is landed from a client, as today.
111
112
### 4.4 What the proposal says
113
114
- The upstream, the old pin and the new state.
115
- **The exact changelog:** every upstream change in S and not in the old
116
  pin, with its author, whether it is signed, and the issues it closes or
117
  refers to.
118
- Its checks, as for any proposal. A red bump stays open, with the
119
  failing check; D2 then says which upstream change broke it.
120
121
## 5. Across hubs
122
123
Each hub only ever writes to its own repositories. What one hub tells
124
another is a hint; the consumer's hub fetches and verifies the facts.
125
126
- **Polling always works.** The consumer's hub has the upstream URL in
127
  `.oxymodules`; it asks for the followed bookmark every few minutes. An
128
  upstream kept in a Strata bucket with no hub is polled by reading its
129
  bookmark record.
130
- **Subscribing makes it prompt.** The consumer's hub asks the upstream's
131
  hub to notify it when the bookmark moves. Notes are signed with the
132
  upstream hub's key and carry only "repository *id* moved to state *S*";
133
  the consumer fetches and verifies. A forged note causes a fetch, nothing
134
  more; a lost one is caught by the next poll.
135
- **Private upstreams** are read with a read-only credential the
136
  consumer's owner stores as a secret on the consumer's hub.
137
- **"Green" across hubs** is evidence the consumer checks: a Flow receipt
138
  for S, signed by a runner the upstream hub vouches for. The consumer's
139
  policy names the upstream hub keys it accepts, and may also require
140
  every upstream change to be signed by the upstream's maintainers, which
141
  holds even if the upstream hub is compromised.
142
- **Consumer checks across hubs (§7)** are opt-in on both sides; the
143
  consumer's hub runs them on its own runners and returns only a signed
144
  summary, or nothing.
145
146
## 6. D2: partial pins and the culprit
147
148
A pin is a state: any set of changes closed under dependencies. So a
149
consumer can pin "upstream S, minus change X and everything built on X":
150
its heads are the maximal changes of `closure(S) − ({X} ∪ dependents(X))`,
151
well-formed by construction.
152
153
When a bump of N upstream changes fails:
154
155
1. Flow searches for the culprit by testing subsets of the N changes (a
156
   delta-debugging search over independent changes, bounded in runs).
157
2. The bump proposal then pins everything except the culprit and its
158
   dependents, and says which change is held back and why, with the
159
   failure.
160
3. The consumer gets the rest at once; the held-back change comes with a
161
   later bump, once upstream fixes it.
162
163
`oxy submodule` and checkout take such pins as they are (a pin is heads);
164
`oxy submodule status` names the changes a partial pin leaves out.
165
166
## 7. D3: consumers test upstream proposals
167
168
A proposal on R* API can run each consumer's pipeline with its pin swapped
169
for the proposal's projected state, committing nothing to the consumer
170
(the claim already carries subrepo pins; the run overrides one). Each
171
consumer's result appears on the upstream proposal as a check,
172
`consumers/<owner>/<name>`, with a summary: "Metal Gear ✔, Super Mario
173
Land ✘ (test X)". The person changing the API sees what breaks before it
174
lands, which is the monorepo's main strength without taking consumers'
175
control. An upstream may make consumer checks required.
176
177
## 8. D4: repair
178
179
- **Migrations with the change.** An upstream change that alters the API
180
  may carry a migration (a script, or instructions for an agent) under
181
  `.diffusion/migrations/`. A bump spanning it runs the migration in the
182
  consumer and adds the result as a separate change on the bump proposal.
183
- **An agent's fix.** When a bump is red, a scoped agent key (an agent
184
  home with `changes` scope on that consumer, never `refs`) may add a fix
185
  as a separate change to the proposal, for the consumer's owner to
186
  review. The bump and the fix stay separate changes, so either can be
187
  dropped.
188
189
## 9. D5: reach
190
191
- **Auto-land** (`land = "auto"`): a green bump lands itself when the
192
  consumer's trust policy and required checks allow it, and every
193
  upstream change is signed by keys the policy trusts.
194
- **Chains:** landing a bump moves the consumer's default bookmark, which
195
  may be followed in turn.
196
- **Grouping and quiet hours:** several upstreams' bumps in one proposal;
197
  no bumps outside set hours.
198
- **Cross-hub** polling and subscriptions (§5).
199
- **Channels:** with Cylinder, a consumer follows `rstar-api:stable`, a
200
  signed channel whose moves are gated by consumer checks (§7).
201
202
## 10. Order
203
204
| Step | What |
205
|---|---|
206
| 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 |
207
| D2 | Partial pins; the culprit search |
208
| D3 | Consumer checks on upstream proposals |
209
| D4 | Migrations and agent fixes |
210
| D5 | Auto-land, chains, grouping, cross-hub, channels |
211
212
D2 is what no other tool can do; D3 is worth the most.
213
214
## 11. Open questions
215
216
- **Who may turn it on** for a consumer: its owner and administrators, or
217
  also the upstream's maintainers (by offering, which the consumer
218
  accepts)?
219
- **Bot identity:** a `diffusion` account per hub, or the upstream
220
  pusher's name with the hub as delegate?
221
- **Cost limits** for the culprit search and consumer checks: runs per
222
  bump, per upstream proposal, per day.