magi/run.rs
1//! Run state: what happened, where it is stored, and how a run is resumed.
2//!
3//! Every node writes its result into [`RunState`] and the whole struct is
4//! flushed to `run.json` before the next node starts. That is what makes a run
5//! resumable: a competition can take an hour, and dying in review round four
6//! should not throw away three implementations, nine judge reads and a
7//! deliberation.
8//!
9//! Patches and raw agent transcripts are *not* in `run.json` — they live beside
10//! it under `artifacts/`, so the state file stays small enough to read by hand.
11use std::collections::{BTreeMap, BTreeSet};
12use std::path::{Path, PathBuf};
13
14use anyhow::{Context as _, Result, bail};
15use jiff::{Timestamp, Zoned};
16use serde::{Deserialize, Serialize};
17
18use crate::agent::SeatState;
19use crate::blind::Leak;
20use crate::config::{Config, MergeMode};
21use crate::verdict::{Finding, Rejection, ReviewVote, Severity};
22
23/// On-disk format version. Bumped when a field changes meaning, so a resumed
24/// run never half-reads a state file written by a different magi.
25///
26/// 2: added `RunStatus::Stalled`, `RunState::quota` (rate-limit losses), and
27/// the quorum fields on `Tally`. `RunState::load` already fails loudly and
28/// clearly on a schema mismatch; an old `run.json` from schema 1 now says so
29/// instead of silently half-reading.
30///
31/// 3: added `RunState::judge_skipped`. A solo candidate makes `judge` write
32/// only an event, leaving `judgements` empty forever — indistinguishable from
33/// "not yet judged" on every later reentry, which is what let `judge` re-run
34/// on a finished run and clobber its status back to `Judging`. The flag is
35/// the missing record of the fact that judging was skipped on purpose.
36///
37/// Also 3: a single-viable-candidate tally records `Tally::judges` as `0` and
38/// fills `Tally::uncontested`, instead of leaving the full roster size sitting
39/// next to a panel that never sat. A schema-2 record keeps reading as "0 of 3
40/// judges present" forever, because a tally is computed once and never
41/// recomputed on resume; the bump keeps that stale reading from being mixed
42/// with the new meaning.
43///
44/// 4: added `ReviewRound::progressed`. `graph::STAGNANT_LIMIT` counts
45/// consecutive rounds with `progressed == false` to decide whether the
46/// review loop should give up early, and a schema-3 record's default
47/// `false` would misreport a round that, at the time, actually committed a
48/// real diff — the field simply did not exist yet to say so. Without the
49/// bump, resuming an old multi-round review could spuriously trip the
50/// stagnation check on rounds that were never stagnant.
51///
52/// 5: added `RunStatus::Landing`. A run inside [`crate::land`]'s post-merge
53/// loop used to carry whatever status `merge` set before calling it forward
54/// unchanged - `Merged`, even while still watching CI or waiting on the
55/// owner's approval - which is also the one status [`RunStatus::resumable`]
56/// treats as finished. A daemon that gave this run's slot back to poll
57/// something else while an approval was outstanding, or one that simply
58/// crashed mid-land, had no way to tell "still landing" from "actually
59/// merged" and would either restart the whole competition or leave the run
60/// stuck reading as done. A schema-4 record has no notion of `Landing` at
61/// all, so this is a meaning a resumed old run cannot be guessed into rather
62/// than a value it can default to - hence the bump, not a `#[serde(default)]`.
63///
64/// 6: a deferred e2e is represented by an empty outcome list plus
65/// `ReviewRound::e2e_deferred`. Schema 5 treated that same empty list as an
66/// unconfigured, successful check, so schema-5 records are migrated with the
67/// old (not-deferred) meaning while older binaries reject schema-6 records.
68///
69/// 7: added `RunState::gate_ran`. An empty `RunState::gate` used to carry two
70/// meanings at once — "never attempted, or the last attempt was
71/// resource-blocked" (`graph::Runner::gate`'s retry case) and "attempted,
72/// zero commands configured, vacuously passed" (a repo with no
73/// `verify.gate`) — and nothing told them apart. `graph::Runner::merge`
74/// therefore read the second case as the first and refused forever: a
75/// review-only run with no gate commands configured reached `Gating` and
76/// then could never leave it. A schema-6 record's non-empty `gate` is
77/// migrated to `gate_ran = true` (a recorded attempt, real or historical,
78/// should not be spent again); an empty one migrates to `gate_ran = false`
79/// and is simply re-attempted by the next `gate()` call, which self-heals
80/// instantly for the zero-commands case.
81///
82/// 8: `ReviewRound::verified_head` used to be `None` for the overwhelming
83/// majority of rounds — every ordinary round that ran e2e against its own
84/// `head` in the main review loop never set it at all, leaving only the
85/// rare catch-up-on-a-different-commit case populated. A reader (a review
86/// prompt, `magi show`, the web UI) had no field to ask "which commit did
87/// this round's `e2e` actually check" and fell back to assuming it was
88/// always `head`, which is also what let a stale round's red output get
89/// quoted to a later round's reviewers as if it were about their patch, not
90/// an earlier one (see `ReviewRound::verification_summary`, which now exists
91/// so nowhere else has to guess). `verified_head` is now set whenever `e2e`
92/// held a real attempt (`E2eStatus::Passed`/`Failed`), always naming the
93/// commit actually checked instead of only the divergent case, and
94/// `ReviewRound::verified_at` is new alongside it. A schema-7 round's own
95/// unconditional main-loop check was always against `head` whether or not
96/// this field said so, so a `None` with a non-empty `e2e` migrates to
97/// `Some(head)` — a reconstruction of a fact that was always true, not a
98/// guess. `verified_at` has no historical value to reconstruct and stays
99/// `None`, which reads through `verification_summary` as "checked at:
100/// unknown" — an honest gap, not a fabricated time.
101/// 9: added [`RunState::operator_fixes`] — one record per `magi fix`
102/// invocation, routing specific, already-recorded findings to a fixer as a
103/// targeted, out-of-band fix outside the normal round sequence. Kept in a
104/// channel of its own rather than folded into [`ReviewRound`], because a
105/// reviewer's own severity and vote (copied verbatim onto
106/// [`OperatorFixFinding`]) must never be rewritten to look like the operator
107/// manufactured a blocking verdict — see `graph::Runner::fix_selected`. A
108/// schema-8 record has no operator-fix history at all, and
109/// `#[serde(default)]` reads an empty list as exactly that: "none happened",
110/// not an unknown gap. Nothing about an existing field's meaning changes.
111///
112/// 10: added `RunStatus::VerifiedNoop` and `Candidate::verified_noop`. Before
113/// this, an implementer that correctly concluded (with evidence) that a
114/// task's request was already satisfied elsewhere had no way to say so: the
115/// run ended the same way as one where every candidate simply failed to
116/// write anything — `after_implement` bailing with "no candidate produced a
117/// change; nothing to judge" and the run settling as a plain `Failed`. That
118/// conflated two very different facts (investigation run 391f's audit is
119/// what surfaced it: two attempts that had, correctly, found their fix
120/// already on `main`). A schema-9 record has no notion of either the new
121/// status or field, so a `VerifiedNoop` value is a meaning that cannot be
122/// reconstructed from an old record — hence the bump, not a
123/// `#[serde(default)]` for the status. `Candidate::verified_noop` alone
124/// *does* default-read as `None` on an old record, which is the honest
125/// reading: a run written before this schema never made the claim.
126///
127/// The report task 391f itself was raised from also named `6c5e`, `8df3` and
128/// `e9ce` as three more tasks whose implement wave ended the same
129/// diff-zero way, and the investigation traced all three — they do not
130/// share one cause.
131///
132/// `6c5e` and `8df3` are the same already-landed pattern as `391f`, not a
133/// coincidence: all three were re-queued together by a same-day audit of
134/// `done`-but-unlanded magi tasks (queue talk `20260912-115153-7216`,
135/// 2026-09-12 02:51–04:24), which found 17 magi tasks marked `done` with no
136/// merge to show for it and re-queued 16 of them, `6c5e` (a fix for the
137/// owner's `magi ask --thread` back-and-forth) and `8df3` (release
138/// automation) included. A second, same-day audit (talk
139/// `20260912-222053-07fe`, 13:20–13:36) then found 12 of those re-queued
140/// tasks — `391f`, `6c5e` and `8df3` among them — already merged by another
141/// route, and the owner had them deleted (`magi task rm`); `391f` alone
142/// survived because a daemon still held its run at the moment of deletion,
143/// which is the only reason any record of this group still exists to audit.
144/// Quoted directly from that second audit's own turn (talk `07fe`, so this
145/// reads without needing access to that talk store), naming both by id:
146///
147/// > 12件がマージ済み(対応不要)、3件が未実装(妥当)、2件が部分実装(要確認)でした。
148/// > **マージ済み → hold/rmを推奨:** 6c5e, 1ddc, fcf5, e25b, cea2, 391f, 3202,
149/// > b0a1, 5365, af85, 9f26, 8df3
150///
151/// — followed by the owner answering "削除!" and the agent confirming "11件
152/// 削除完了。391f はいま実行中のdaemonが掴んでいて削除できませんでした."
153/// `git log` independently confirms both fixes: the ask-back feature `6c5e`
154/// wanted landed as `f0df474` ("let the owner ask back on a question...",
155/// #93) on 2026-09-06, and the release-bump automation `8df3` wanted landed
156/// as `61005dd`/`bedd925` (open a release-bump PR on merge) on 2026-09-07
157/// and `116fcdc` (proportional version bump, #108) on 2026-09-08 — all
158/// before the 09-12 requeue. No run record survives the deletion for either
159/// task, so this schema's evidence is the audit transcript plus the
160/// independently re-checked `git log`, not a `run.json`.
161///
162/// `e9ce` is not that pattern at all, and is the reason the adoption guard
163/// below is all-or-nothing rather than "any candidate said so": its task
164/// asked an implementer to merge the real repository's `main` and cut a
165/// GitHub release — a destructive, out-of-worktree operation `AGENTS.md`
166/// names explicitly as not something to hand to an unattended candidate.
167/// Both of its runs (`20260912-053352-49ad`, `20260912-062629-bab1`)
168/// correctly refused, filed `magi ask` (questions `6196`, `6c9a`), and ended
169/// with an empty diff only because no answer arrived before the implement
170/// node's timeout — `49ad` looped `magi ask --wait` in the foreground for
171/// roughly 50 minutes as instructed before the timeout cut it off; `bab1`
172/// ended its turn moments after filing its question without ever actually
173/// blocking on the wait, a separate protocol slip this schema change does
174/// not attempt to fix. `49ad`'s own `candidates[0].summary` (quoted here
175/// because both records predate schema 10 and, separately, predate a
176/// still-unrelated struct change that already makes today's `magi show`
177/// refuse to parse either of them — `unknown field 'planner'` — so this is
178/// read straight from `run.json` on disk, not through that command):
179///
180/// > タスクの内容(READY 状態の run を実リポジトリの main に `merge --no-ff`
181/// > する、GitHub Release を作る)を精査した結果、これは全てこのワーカーの
182/// > worktree の外にある実リポジトリと GitHub 上の共有状態に対する不可逆な
183/// > 操作であり […] 私自身の運用ルール「Work only inside this worktree.
184/// > Nothing outside it is yours.」と正面から矛盾すると判断しました。
185///
186/// Neither candidate's reply carries the
187/// `NO CHANGE NEEDED` marker below, so both runs correctly stay `Failed`
188/// under this schema, not `VerifiedNoop`: a run blocked on an unanswered
189/// authorization question is not a verified no-op, and reading the two
190/// alike is exactly the misclassification the guard's per-candidate and
191/// whole-run conditions exist to refuse.
192///
193/// `RunStatus::Superseded` (added without a bump, still schema 10) is
194/// additive in the ordinary sense — an old build reading a run written under
195/// a newer one only had `RunStatus` variants to worry about before this, and
196/// a record already on disk never contained the new variant to begin with —
197/// but it is not additive in the sense every earlier schema bump on this
198/// constant was: `daemon::supersede_prior_runs` now rewrites a `Blocked` or
199/// `Stalled` run's `status` field *after* it was first written, once a later
200/// attempt at the same task lands. Any tooling outside magi that reads
201/// `run.json` and assumes a terminal `status` is permanent once set — a
202/// monitoring script polling for `blocked`, say — needs to know that
203/// `superseded` is where some of those records now go instead of staying put
204/// forever; see that function's own doc for exactly when.
205///
206/// Schema 11 adds [`RunState::released_to`] / [`RunState::released_branches`]:
207/// a run whose worktree a later attempt at the same task took over
208/// (`crate::handover`) can no longer be resumed from where it was. The fields
209/// are additive, but an older build would happily resume such a run into a
210/// worktree that no longer exists, which is the one thing the bump is for.
211///
212/// Schema 12 adds [`RunState::driver_exited`]: the driver records that it
213/// stopped walking the graph. Additive, but an older build would keep reading
214/// a long-lived daemon's pid as a live driver of a run that ended long ago.
215///
216/// Schema 13 adds [`RunState::origin`]: who started the run and which task it
217/// stood in for. Additive, and an older record is deliberately left with
218/// `None` ("origin unknown") rather than guessed at — a run from before this
219/// existed must not read as an operator's when nobody knows. The bump exists
220/// so a run is never mistaken for one whose origin was known and empty.
221pub const SCHEMA: u32 = 13;
222
223/// What an unrecorded origin reads as, wherever one is shown.
224pub const ORIGIN_UNKNOWN: &str = "origin unknown (started before origins were recorded)";
225
226/// Who started a run. Legibility only: nothing branches on it, the same rule
227/// as `agent::Invocation::run` / `node`.
228#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
229#[serde(tag = "kind", rename_all = "snake_case")]
230pub enum StartedBy {
231 /// The daemon, minting an attempt for a queue task.
232 Queue {
233 /// The task the attempt belongs to.
234 task: String,
235 },
236 /// An agent inside a talk (chat) conversation, via `magi run` / `magi review`.
237 Chat {
238 /// Talk id, e.g. `4a7b`.
239 talk: String,
240 },
241 /// An agent seat inside another run, identified by the `MAGI_RUN` /
242 /// `MAGI_NODE` it was spawned with.
243 Seat {
244 /// Run the seat belonged to.
245 run: String,
246 /// Node it was working in.
247 node: String,
248 },
249 /// A person at a terminal (or anything that carries no attribution).
250 Operator,
251}
252
253/// Where a run came from, and the task it was meant to finish, if any.
254///
255/// Kept as two facts because they vary independently: a chat agent may start a
256/// run on behalf of a queue task.
257#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
258pub struct Origin {
259 /// Who started it.
260 pub by: StartedBy,
261 /// The queue task this run serves, when it names one.
262 #[serde(default)]
263 pub task: Option<String>,
264}
265
266impl Origin {
267 /// A run a person started with no task attached.
268 pub fn operator() -> Self {
269 Self {
270 by: StartedBy::Operator,
271 task: None,
272 }
273 }
274
275 /// An attempt the daemon mints for `task`.
276 pub fn queue(task: &str) -> Self {
277 Self {
278 by: StartedBy::Queue {
279 task: task.to_owned(),
280 },
281 task: Some(task.to_owned()),
282 }
283 }
284
285 /// Attribute from the `MAGI_RUN` / `MAGI_NODE` pair `agent::invoke`
286 /// exports, as `(run, node)`; `None` for no (or blank) `run` is an
287 /// operator. A node of `chat` is the talk layer, whose run is the talk id.
288 pub fn from_agent_env(env: Option<(String, String)>, task: Option<String>) -> Self {
289 let by = match env {
290 Some((run, node)) if node == crate::queue::CHAT_NODE => StartedBy::Chat { talk: run },
291 Some((run, node)) => StartedBy::Seat { run, node },
292 None => StartedBy::Operator,
293 };
294 Self { by, task }
295 }
296
297 /// The same origin, naming `task` as the one it serves.
298 pub fn serving(mut self, task: Option<String>) -> Self {
299 if task.is_some() {
300 self.task = task;
301 }
302 self
303 }
304
305 /// One short label for lists, reports and the web UI.
306 pub fn label(&self) -> String {
307 let by = match &self.by {
308 StartedBy::Queue { task } => format!("task {}", short_of(task)),
309 StartedBy::Chat { talk } => format!("chat {}", short_of(talk)),
310 StartedBy::Seat { run, node } => format!("{node}@{}", short_of(run)),
311 StartedBy::Operator => "operator".to_owned(),
312 };
313 match (&self.by, &self.task) {
314 (StartedBy::Queue { task: a }, Some(b)) if a == b => by,
315 (_, Some(t)) => format!("{by}, for task {}", short_of(t)),
316 _ => by,
317 }
318 }
319}
320
321/// [`Origin::label`] for a run that may predate origins.
322pub fn origin_label(origin: Option<&Origin>) -> String {
323 origin.map_or_else(|| ORIGIN_UNKNOWN.to_owned(), Origin::label)
324}
325
326/// Where a run got to.
327#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
328#[serde(rename_all = "snake_case")]
329pub enum RunStatus {
330 /// Worktrees being prepared.
331 Prep,
332 /// Candidates being implemented.
333 Implementing,
334 /// Judges ranking blind.
335 Judging,
336 /// Judges deliberating after a split.
337 Deliberating,
338 /// Final votes being collected privately.
339 Voting,
340 /// Winner in the review + verification loop.
341 Reviewing,
342 /// Gate commands running. Transient: `graph::Runner::gate` and
343 /// `graph::Runner::merge` always move a run on from here, whether or not
344 /// any gate commands are configured — see [`RunState::gate_status`] and
345 /// `SCHEMA`'s doc for schema 7, which fixed a repo with an empty
346 /// `verify.gate` stranding a review-only run in `Gating` forever.
347 Gating,
348 /// Inside [`crate::land`]'s post-merge loop: watching CI, running a fix
349 /// round, rebasing onto a moved base, or waiting on the owner's merge
350 /// approval. A run parked here while an approval is outstanding has
351 /// handed its daemon slot back — see [`crate::daemon`] — and resumes
352 /// through exactly this status, not a fresh competition.
353 Landing,
354 /// Winner merged.
355 Merged,
356 /// Winner passed the gate; merge was not requested.
357 Ready,
358 /// The judgement did not gather enough judges (e.g. rate limiting took out
359 /// seats), so the verdict is not trustworthy. The run stopped and kept its
360 /// work so it can be resumed or folded — it must never be confused with a
361 /// healthy `Ready`.
362 Stalled,
363 /// Review rounds exhausted with findings still open, or the gate failed.
364 Blocked,
365 /// The graph could not complete.
366 Failed,
367 /// Every candidate wrote nothing, and every one of them said why in a way
368 /// that survived [`crate::graph::Runner`]'s adoption guard: a clean CLI
369 /// exit, an actually-empty tree, no command left with an unconfirmed
370 /// exit status, and non-empty evidence. Distinct from `Failed` on
371 /// purpose — see `SCHEMA`'s doc for schema 10 — because the two read
372 /// identically to an operator glancing at a card ("nothing happened")
373 /// while meaning opposite things: one is an agent that could not do the
374 /// work, the other is an agent that checked and the work was already
375 /// done. Settles the task through [`crate::queue::Task::handed_off`], not
376 /// [`crate::queue::Task::fail`]: a human still has to look — the claim is
377 /// unverified by magi itself — and `Held` (not `Failed`-and-requeued)
378 /// means nothing retries the task unattended on the same unconfirmed
379 /// claim while that look is pending.
380 VerifiedNoop,
381 /// A later attempt at the same task already finished the job — see
382 /// `crate::queue::Task::superseded_attempts` — so this run's own
383 /// `Blocked`/`Stalled` no longer means anyone has to look at it. Written
384 /// only over one of those two statuses, only once the task itself is
385 /// `crate::queue::TaskStatus::Done`, and only onto an attempt that comes
386 /// before the one that succeeded. Unlike them, not [`Self::resumable`]:
387 /// there is nothing left to resume towards, the task already has its
388 /// answer, and a fold is free to clean this run's worktree away without
389 /// waiting on a human to confirm that first.
390 Superseded,
391 /// The winner's whole change is already on the base under other commit
392 /// ids (a cherry-pick or squash by another task) — see
393 /// [`crate::already`]. Terminal and not a failure: nothing is left to
394 /// land, so unlike `Blocked` nobody has to look, and unlike `Merged` this
395 /// run did not land anything. Never resumable; `BaseSync::already_in`
396 /// names the base commits that carry the change. Added without a schema
397 /// bump, like `Superseded`: no record on disk can contain it yet.
398 AlreadyInBase,
399}
400
401impl RunStatus {
402 /// Is this a terminal state?
403 pub fn done(self) -> bool {
404 matches!(
405 self,
406 Self::Merged
407 | Self::Ready
408 | Self::Stalled
409 | Self::Blocked
410 | Self::Failed
411 | Self::VerifiedNoop
412 | Self::Superseded
413 | Self::AlreadyInBase
414 )
415 }
416
417 /// The name this status is written and shown under, matching the
418 /// `snake_case` serde spelling so a log line, an error message and the
419 /// JSON a phone reads all say the same word.
420 pub fn as_str(self) -> &'static str {
421 match self {
422 Self::Prep => "prep",
423 Self::Implementing => "implementing",
424 Self::Judging => "judging",
425 Self::Deliberating => "deliberating",
426 Self::Voting => "voting",
427 Self::Reviewing => "reviewing",
428 Self::Gating => "gating",
429 Self::Landing => "landing",
430 Self::Merged => "merged",
431 Self::Ready => "ready",
432 Self::Stalled => "stalled",
433 Self::Blocked => "blocked",
434 Self::Failed => "failed",
435 Self::VerifiedNoop => "verified_noop",
436 Self::Superseded => "superseded",
437 Self::AlreadyInBase => "already_in_base",
438 }
439 }
440
441 /// Label for a human-facing listing or report — the same word as
442 /// [`Self::as_str`] except where the machine spelling would read harsher
443 /// than the state actually is. `VerifiedNoop` is the one case: its own
444 /// `as_str` exists for logs, JSON and event messages, none of which
445 /// should quietly grow a second vocabulary, but a bare "verified_noop" in
446 /// a report reads like an error code, not the qualified, evidence-backed
447 /// claim it actually is.
448 pub fn display_label(self) -> &'static str {
449 match self {
450 Self::VerifiedNoop => "agent-verified no-op",
451 Self::AlreadyInBase => "already in base",
452 other => other.as_str(),
453 }
454 }
455
456 /// Can this run be carried on from where it stopped?
457 ///
458 /// Everything except a finished run and a failed one. `execute` skips
459 /// nodes already recorded, so re-entering is cheap wherever the run
460 /// stopped, and the alternative is always a fresh competition against
461 /// work that already exists.
462 ///
463 /// - `Stalled` re-asks only the seats whose absence collapsed the panel,
464 /// keeping the candidates that were already paid for.
465 /// - `Blocked` re-enters the review loop against a branch that is built.
466 /// - **A non-terminal status** means the run was interrupted: a parked
467 /// run waiting for its upgrade, or one whose daemon was killed. This
468 /// used to be excluded, which left run 4043 stuck at `reviewing` with
469 /// the deck telling the operator it could not be resumed - the one
470 /// state where resuming is the only sensible answer.
471 ///
472 /// `Failed` does not qualify: the graph could not complete and there is
473 /// no established point to continue from. Nor does a finished run, whose
474 /// answer is a new competition. Nor does `VerifiedNoop`: every candidate
475 /// already agreed nothing belongs in this worktree, and resuming would
476 /// only re-ask the same question — the answer is for a human to check
477 /// the evidence, not for the graph to run again. Nor does `Superseded`:
478 /// a later attempt at the same task already finished it, so there is
479 /// nothing left this run's own answer could still contribute.
480 ///
481 /// Whether anything is *already* driving the run is a separate question,
482 /// answered by `daemon::is_working_on` at the callers that need it.
483 pub fn resumable(self) -> bool {
484 !matches!(
485 self,
486 Self::Merged
487 | Self::Ready
488 | Self::Failed
489 | Self::VerifiedNoop
490 | Self::Superseded
491 | Self::AlreadyInBase
492 )
493 }
494}
495
496/// One candidate implementation.
497#[derive(Debug, Clone, Serialize, Deserialize)]
498pub struct Candidate {
499 /// Position in the implementer list.
500 pub index: usize,
501 /// Blind label as presented to judges.
502 pub label: char,
503 /// Which agent wrote it. Recorded for the stats tables, never shown to a
504 /// judge.
505 pub agent: String,
506 /// Branch, named after the label so judges can inspect it without learning
507 /// the author.
508 pub branch: String,
509 /// Worktree path.
510 pub worktree: PathBuf,
511 /// Sanitized author summary.
512 #[serde(default)]
513 pub summary: String,
514 /// `git diff --stat`.
515 #[serde(default)]
516 pub stat: String,
517 /// Files touched.
518 #[serde(default)]
519 pub files: usize,
520 /// Commits ahead of base.
521 #[serde(default)]
522 pub commits: usize,
523 /// True when the agent produced no change at all.
524 #[serde(default)]
525 pub empty: bool,
526 /// Why this candidate is not in the running.
527 #[serde(default)]
528 pub failed: Option<String>,
529 /// The evidence this candidate gave for writing no change on purpose —
530 /// the `NO CHANGE NEEDED:` marker `prompt::implement`'s reply format
531 /// documents, verbatim. `Some` only when [`crate::graph`]'s adoption
532 /// guard accepted the claim: the CLI exited cleanly, the tree really is
533 /// empty, no command in the reply was left with an unconfirmed exit
534 /// status, and the evidence itself is non-empty. A candidate that wrote
535 /// nothing and said nothing about why — the ordinary empty loss — always
536 /// reads `None` here, same as one written before schema 10 ever existed.
537 #[serde(default)]
538 pub verified_noop: Option<String>,
539 /// Wall-clock time for the implementation.
540 #[serde(default)]
541 pub duration_ms: u64,
542 /// Whether the worktree has been folded away.
543 #[serde(default)]
544 pub folded: bool,
545}
546
547impl Candidate {
548 /// Can this candidate be judged?
549 pub fn viable(&self) -> bool {
550 self.failed.is_none() && !self.empty
551 }
552}
553
554/// One judge's independent ranking.
555#[derive(Debug, Clone, Serialize, Deserialize)]
556pub struct Judgement {
557 /// Judge seat number, 1-based.
558 pub judge: usize,
559 /// Seat key.
560 pub seat: String,
561 /// Agent occupying the seat.
562 pub agent: String,
563 /// Best-first labels.
564 #[serde(default)]
565 pub ranking: Vec<char>,
566 /// Per-label justification.
567 #[serde(default)]
568 pub reasons: BTreeMap<String, String>,
569 /// Self-reported confidence.
570 #[serde(default)]
571 pub confidence: Option<u8>,
572 /// Order the candidates were presented in, as candidate indices.
573 #[serde(default)]
574 pub order: Vec<usize>,
575 /// Why this judge has no ranking.
576 #[serde(default)]
577 pub failed: Option<String>,
578 /// Wall-clock time.
579 #[serde(default)]
580 pub duration_ms: u64,
581}
582
583/// One judge's turn in a deliberation round.
584#[derive(Debug, Clone, Serialize, Deserialize)]
585pub struct DeliberationTurn {
586 /// Judge seat number, 1-based.
587 pub judge: usize,
588 /// Agent occupying the seat.
589 pub agent: String,
590 /// The argument, as written.
591 pub body: String,
592 /// Where the judge stood at the end of the turn.
593 #[serde(default)]
594 pub tentative: Option<char>,
595}
596
597/// A deliberation round.
598#[derive(Debug, Clone, Serialize, Deserialize)]
599pub struct DeliberationRound {
600 /// 1-based round number.
601 pub round: usize,
602 /// Turns, in the order they were taken.
603 pub turns: Vec<DeliberationTurn>,
604}
605
606/// A final vote, collected privately.
607#[derive(Debug, Clone, Serialize, Deserialize)]
608pub struct VoteRecord {
609 /// Judge seat number, 1-based.
610 pub judge: usize,
611 /// Agent occupying the seat.
612 pub agent: String,
613 /// The vote.
614 #[serde(default)]
615 pub vote: Option<char>,
616 /// Why.
617 #[serde(default)]
618 pub reason: String,
619 /// Did this judge move from its initial first choice?
620 #[serde(default)]
621 pub changed: bool,
622}
623
624/// A seat that was taken out by a CLI rate limit / quota, recorded so a run
625/// whose panel collapsed does not masquerade as a healthy one.
626#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
627pub struct QuotaLoss {
628 /// Seat key, e.g. `judge-1` or `review-2`.
629 pub seat: String,
630 /// Node that was running, e.g. `judge`, `vote`, `review`.
631 pub node: String,
632 /// When the CLI reported the limit.
633 pub at: Timestamp,
634 /// Reset hint if the CLI printed one, free text.
635 #[serde(default)]
636 pub reset: Option<String>,
637}
638
639/// A seat handed from one roster agent to the next after the first failed it
640/// (rate limit, timeout or an ordinary failure), recorded so the answer's
641/// author is never a mystery and a run that recovered on its second agent
642/// still says what it cost.
643#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
644pub struct Handover {
645 /// When the seat changed hands.
646 pub at: Timestamp,
647 /// Node that was running, e.g. `implement`, `judge`, `review`.
648 pub node: String,
649 /// Seat key, e.g. `impl-A` or `judge-2`.
650 pub seat: String,
651 /// Agent id that failed the seat.
652 pub from: String,
653 /// Agent id that took it over.
654 pub to: String,
655 /// Why: `rate limited (quota)`, `timed out`, or the failure's own message.
656 pub reason: String,
657}
658
659/// A newly created lockfile of a package manager the directory does not use,
660/// which a rescue commit left untracked instead of committing. Recorded so the
661/// omission is visible: the file may be one the task really wanted.
662#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
663pub struct Withheld {
664 /// Repo-relative path.
665 pub path: String,
666 /// The manager the file belongs to.
667 pub manager: String,
668 /// The tracked file (or missing manifest) that made it foreign.
669 pub kept_by: String,
670 /// Node whose rescue commit withheld it.
671 pub node: String,
672 /// When.
673 pub at: Timestamp,
674}
675
676/// The mechanical count.
677#[derive(Debug, Clone, Serialize, Deserialize)]
678pub struct Tally {
679 /// First-choice votes per label.
680 pub first_choice: BTreeMap<char, usize>,
681 /// Borda points from the initial rankings, used only to break a tie.
682 pub borda: BTreeMap<char, usize>,
683 /// The winning label.
684 pub winner: char,
685 /// How many judges produced a usable ranking. A panel of one is not a
686 /// consensus and must not be reported as a split.
687 #[serde(default)]
688 pub rankings: usize,
689 /// Did every judge's *initial* first choice agree?
690 pub unanimous_initial: bool,
691 /// Was deliberation run?
692 pub deliberated: bool,
693 /// Judges who moved between their initial ranking and their final vote.
694 pub changed_votes: usize,
695 /// Did the final votes agree?
696 pub unanimous_final: bool,
697 /// How the tie was broken, when it had to be.
698 #[serde(default)]
699 pub tie_break: Option<String>,
700 /// Configured judge count — the size of the full panel. `0` when no
701 /// panel was asked (see `uncontested`), not the roster size a panel that
702 /// never sat would have had.
703 #[serde(default)]
704 pub judges: usize,
705 /// Judges who actually contributed to the decision (not taken out by a
706 /// rate limit and producing a usable rank or vote).
707 #[serde(default)]
708 pub present: usize,
709 /// How many judges are required for a trustworthy verdict. Chosen as a
710 /// strict majority (`judges / 2 + 1`): a verdict backed by a minority must
711 /// never be presented as a healthy one, while a bare majority is still
712 /// real signal. A one-candidate run needs no quorum.
713 #[serde(default)]
714 pub quorum: usize,
715 /// `present >= quorum`, or no quorum was required.
716 #[serde(default)]
717 pub met_quorum: bool,
718 /// Why no panel was asked, when none was: a single viable candidate, or
719 /// a review-only run that never competed. `None` when judges actually
720 /// ranked and voted — including when too few of them survived to reach
721 /// quorum, which is a collapse and must keep reading as one.
722 #[serde(default)]
723 pub uncontested: Option<String>,
724}
725
726/// One reviewer's report in a round.
727#[derive(Debug, Clone, Serialize, Deserialize)]
728pub struct ReviewRecord {
729 /// Reviewer seat number, 1-based.
730 pub reviewer: usize,
731 /// Agent occupying the seat.
732 pub agent: String,
733 /// Reviewer prose.
734 #[serde(default)]
735 pub summary: String,
736 /// Findings, with magi-assigned ids.
737 #[serde(default)]
738 pub findings: Vec<Finding>,
739 /// This seat's initial vote. `None` on a record predating votes, exactly
740 /// like a round that genuinely had none cast — never a stand-in for a
741 /// vote that was lost.
742 #[serde(default)]
743 pub vote: Option<ReviewVote>,
744 /// Why this reviewer produced nothing.
745 #[serde(default)]
746 pub failed: Option<String>,
747 /// Wall-clock time.
748 #[serde(default)]
749 pub duration_ms: u64,
750 /// How many times this seat was asked before it settled — 0 for a first
751 /// answer, N after N nudges (`ask_json_wave`'s retry loop). Read this
752 /// together with [`Self::failed`], never `failed` alone: `failed: Some(_)`
753 /// with `attempts == 0` is a seat that never answered at all, while
754 /// `failed: None` with `attempts > 0` is one that only came back after a
755 /// nudge — recovered, not silent — and the two must not look the same in
756 /// history. A record written before this field existed defaults to `0`,
757 /// which under-reports a pre-existing retry rather than inventing one;
758 /// see `ask_json_wave`'s own doc for where this is filled in.
759 #[serde(default)]
760 pub attempts: usize,
761}
762
763/// One seat's revote during a round's reconsideration (see
764/// [`ReviewRound::reconsideration`]).
765#[derive(Debug, Clone, Serialize, Deserialize)]
766pub struct ReviewRevoteRecord {
767 /// Reviewer seat number, 1-based.
768 pub reviewer: usize,
769 /// Agent occupying the seat.
770 pub agent: String,
771 /// The revote. `None` when the seat did not answer.
772 #[serde(default)]
773 pub vote: Option<ReviewVote>,
774 /// Why.
775 #[serde(default)]
776 pub reason: String,
777 /// Why this seat produced no revote.
778 #[serde(default)]
779 pub failed: Option<String>,
780}
781
782/// One fix round spent on a failing `verify.gate`: which fixer, what it did to
783/// the tree, and the gate output it was shown.
784#[derive(Debug, Clone, Serialize, Deserialize)]
785pub struct GateFixRecord {
786 /// Agent that applied the fix.
787 pub agent: String,
788 /// The gate output the fixer was handed, tail-truncated.
789 pub failed: Vec<CommandOutcome>,
790 /// What the fixer said it changed.
791 #[serde(default)]
792 pub notes: String,
793 /// Did the fix produce a commit?
794 #[serde(default)]
795 pub committed: bool,
796 /// Why the fix step produced nothing.
797 #[serde(default)]
798 pub error: Option<String>,
799}
800
801/// One fixer round spent on a rebase that stopped on a conflict: which fixer,
802/// what it was shown and whether git says the rebase then finished.
803///
804/// The number of these is the budget spent (`graph.review_rounds` is the cap),
805/// written to disk *before* the fixer runs so a park or crash cannot hand the
806/// round back.
807#[derive(Debug, Clone, Serialize, Deserialize)]
808pub struct RebaseFixRecord {
809 /// Agent asked to resolve the conflict.
810 pub agent: String,
811 /// Paths git reported unmerged when the round started.
812 pub paths: Vec<String>,
813 /// The branch tip the rebase started from, so a resumed run can tell a
814 /// worktree still holding those files from one with edits of its own.
815 #[serde(default)]
816 pub from: Option<String>,
817 /// Did git report the rebase finished after the round?
818 #[serde(default)]
819 pub finished: bool,
820 /// Why the round produced nothing (agent failure, quota).
821 #[serde(default)]
822 pub error: Option<String>,
823}
824
825/// The fixer's response to a round.
826#[derive(Debug, Clone, Serialize, Deserialize)]
827pub struct FixRecord {
828 /// Agent that applied the fixes.
829 pub agent: String,
830 /// Finding ids acted on.
831 #[serde(default)]
832 pub addressed: Vec<String>,
833 /// Findings declined, with reasons.
834 #[serde(default)]
835 pub rejected: Vec<Rejection>,
836 /// What changed.
837 #[serde(default)]
838 pub notes: String,
839 /// Did the fix produce a commit?
840 #[serde(default)]
841 pub committed: bool,
842 /// Why the fix step produced nothing.
843 #[serde(default)]
844 pub failed: Option<String>,
845 /// Wall-clock time.
846 #[serde(default)]
847 pub duration_ms: u64,
848 /// How the fixer's own seat was made to answer when its CLI turn ended
849 /// cleanly but without an addressed/rejected report — see
850 /// [`graph::Runner::continue_fix_report`]. `None` for a record written
851 /// before this existed, which must read as "unknown", not as
852 /// [`ContinuationOutcome::NotNeeded`]: an old run really may have hit
853 /// this exact gap and simply had no mechanism to say so.
854 #[serde(default)]
855 pub continuation: Option<ContinuationRecord>,
856}
857
858/// How a node recovered — or failed to recover — a structured report after
859/// the CLI's own turn ended cleanly (a usable, non-empty, exit-0 reply)
860/// without it. A clean CLI turn is not the same fact as the node's own work
861/// being done — see the `fix` node's `continue_fix_report`, which is what
862/// produces this.
863#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
864pub enum ContinuationOutcome {
865 /// The first reply already carried the report; nothing was resumed.
866 NotNeeded,
867 /// A follow-up call in the same session recovered the report.
868 Resumed,
869 /// The continuation budget was spent without ever recovering it.
870 Exhausted,
871 /// A continuation attempt hit the CLI's rate limit; not retried further
872 /// — a quota fails the same way again immediately.
873 QuotaLost,
874 /// No session was left to resume into, so nothing was attempted.
875 NoSession,
876}
877
878/// Cost and outcome of one node's attempt to recover a missing report by
879/// resuming its own seat.
880#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
881pub struct ContinuationRecord {
882 /// Follow-up calls made to the same seat. `0` when the outcome is
883 /// [`ContinuationOutcome::NotNeeded`] or [`ContinuationOutcome::NoSession`].
884 pub attempts: usize,
885 /// Wall-clock time spent on those follow-up calls, summed — not counting
886 /// the original call whose reply this is recovering from.
887 pub cumulative_wait_ms: u64,
888 /// What ended the loop.
889 pub outcome: ContinuationOutcome,
890}
891
892impl ContinuationRecord {
893 /// The report was already there on the first try.
894 pub fn not_needed() -> Self {
895 Self {
896 attempts: 0,
897 cumulative_wait_ms: 0,
898 outcome: ContinuationOutcome::NotNeeded,
899 }
900 }
901}
902
903/// What happened to one operator-selected finding after the fixer ran, as
904/// part of an [`OperatorFixRequest`].
905#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
906#[serde(rename_all = "snake_case")]
907pub enum OperatorFixOutcome {
908 /// The request has not run yet, or never got far enough to report.
909 #[default]
910 Pending,
911 /// The fixer's adoption report named this finding as addressed.
912 Addressed,
913 /// The fixer's adoption report declined it, with an argument.
914 Rejected {
915 /// The fixer's own reason.
916 why: String,
917 },
918 /// The fixer never delivered a usable adoption report at all — a
919 /// dropped stream, a quota hit, or a continuation budget spent without
920 /// recovering one (see `graph::Runner::continue_fix_report`). Distinct
921 /// from `Rejected`, which needs an argument this never produced, and
922 /// never written back as "addressed" or silently left `Pending` — a
923 /// gap in the report is its own outcome, not evidence either way about
924 /// the finding.
925 Unreported,
926}
927
928/// One finding an operator selected for [`OperatorFixRequest`], with the
929/// provenance a reviewer originally gave it, copied here verbatim.
930///
931/// Severity and vote are snapshots, never recomputed and never treated as
932/// blocking just because an operator picked the finding — only
933/// [`Severity::blocks`] on the original [`ReviewRecord`] decides that. This
934/// type exists so an operator's selection is an auditable *addition* to the
935/// record, not a rewrite of what a reviewer actually said.
936#[derive(Debug, Clone, Serialize, Deserialize)]
937pub struct OperatorFixFinding {
938 /// Finding id, e.g. `R2-1-3`.
939 pub id: String,
940 /// Severity as the reviewer recorded it.
941 pub severity: Severity,
942 /// The reviewer seat's overall vote for the round this finding came
943 /// from, if one was cast.
944 #[serde(default)]
945 pub reviewer_vote: Option<ReviewVote>,
946 /// Review round the finding was raised in.
947 pub round: usize,
948 /// That round's own head — the commit the finding was actually raised
949 /// against, used for the freshness check against the branch's current
950 /// head at request time.
951 pub round_head: String,
952 /// Reviewer seat number, 1-based.
953 pub reviewer: usize,
954 /// Agent occupying that seat.
955 pub agent: String,
956 /// File the finding concerns.
957 #[serde(default)]
958 pub file: Option<String>,
959 /// Line the finding concerns.
960 #[serde(default)]
961 pub line: Option<u32>,
962 /// One-line summary.
963 pub title: String,
964 /// The argument.
965 #[serde(default)]
966 pub detail: String,
967 /// What happened to this finding after the fixer ran.
968 #[serde(default)]
969 pub outcome: OperatorFixOutcome,
970}
971
972/// One `magi fix` invocation: the operator's own record of which
973/// already-recorded findings they routed to a fixer, why, and what came
974/// back. See [`SCHEMA`]'s doc for schema 9 on why this is a channel of its
975/// own rather than a field on [`ReviewRound`].
976#[derive(Debug, Clone, Serialize, Deserialize)]
977pub struct OperatorFixRequest {
978 /// When `magi fix` was invoked.
979 pub requested_at: Timestamp,
980 /// The operator's own reasoning. Required and never empty at the CLI —
981 /// the audit trail this feature exists for.
982 pub reason: String,
983 /// The findings selected, each with its own provenance and outcome.
984 pub findings: Vec<OperatorFixFinding>,
985 /// The branch's head at the moment this request started executing.
986 pub head_at_request: String,
987 /// Did the operator pass `--allow-stale`?
988 pub allow_stale: bool,
989 /// Did any selected finding's own `round_head` differ from
990 /// `head_at_request`? Kept distinct from `allow_stale` — flipping that
991 /// flag does not retroactively make a request that was actually fresh
992 /// read as stale, or the reverse.
993 pub stale: bool,
994 /// The fixer's own attempt, once dispatched.
995 #[serde(default)]
996 pub fix: Option<FixRecord>,
997 /// Head after the fixer's commit, when it produced one.
998 #[serde(default)]
999 pub result_head: Option<String>,
1000 /// The review-only run opened to re-verify the change, when one was
1001 /// actually committed. `None` when nothing changed, so there was
1002 /// nothing new to re-review — never left implicit as "not gotten to
1003 /// yet".
1004 #[serde(default)]
1005 pub follow_up_review_run: Option<String>,
1006}
1007
1008/// A command a seat's own CLI reported running, kept for `magi show` and for
1009/// telling "this seat's turn ended" apart from "the process it started is
1010/// done" — see `agent::CommandEvidence`, which is the only source this is
1011/// ever built from. Never something magi polled or supervised; a command the
1012/// CLI never reported finishing (or a CLI this crate has no adapter for at
1013/// all) simply has no entry here, which must read as "unknown", not as
1014/// "nothing ran".
1015#[derive(Debug, Clone, Serialize, Deserialize)]
1016pub struct JobRecord {
1017 /// Graph node the seat belongs to, e.g. `"implement"`, `"fix"`.
1018 pub node: String,
1019 /// Review round this job belongs to, for a `"review"`/`"fix"` node —
1020 /// `None` for every other node, where rounds do not apply, and for every
1021 /// record written before this was tracked. Lets a reader ask "what did
1022 /// this seat itself actually run this round", distinct from and never
1023 /// substituted for magi's own recorded `ReviewRound::e2e` — an absent
1024 /// entry here means unobserved, not that nothing ran (see this type's
1025 /// own doc).
1026 #[serde(default)]
1027 pub round: Option<usize>,
1028 /// Seat key, e.g. `"impl-A"`.
1029 pub seat: String,
1030 /// The CLI's own id for this command.
1031 pub id: String,
1032 /// The command itself, as the CLI reported it.
1033 pub description: String,
1034 /// When this evidence was captured — the moment this seat's reply
1035 /// carrying it was read, not the command's own start time, which no
1036 /// adapter here currently has. A lower bound on staleness only.
1037 pub checked_at: Timestamp,
1038 /// What the CLI reported for it.
1039 pub status: JobStatus,
1040 /// Exit code the CLI reported.
1041 pub exit_code: Option<i32>,
1042 /// Tail of the command's own output, when reported.
1043 #[serde(default)]
1044 pub result_summary: String,
1045 /// Which CLI/event stream this came from, e.g. `"codex"`.
1046 pub source: String,
1047}
1048
1049/// What a [`JobRecord`]'s own CLI reported for it. There is no `Running`
1050/// variant: nothing here is ever polled live, so "still running" and
1051/// "finished but never reported" are the same absence of evidence, not a
1052/// state this type can name — see [`JobRecord`]'s own doc.
1053#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
1054pub enum JobStatus {
1055 /// The command's own reported exit code was `0`.
1056 Completed,
1057 /// The command's own reported exit code was non-zero.
1058 Failed,
1059 /// The CLI reported this command but not a readable exit code.
1060 Unknown,
1061}
1062
1063/// Outcome of one shell command.
1064#[derive(Debug, Clone, Serialize, Deserialize)]
1065pub struct CommandOutcome {
1066 /// The command, as configured.
1067 pub command: String,
1068 /// Exit code, `None` on timeout or signal.
1069 pub code: Option<i32>,
1070 /// Tail of the combined output, for the report and the fix prompt.
1071 #[serde(default)]
1072 pub output_tail: String,
1073 /// Wall-clock time.
1074 #[serde(default)]
1075 pub duration_ms: u64,
1076 /// Set only by magi itself, never inferred from `output_tail`: the
1077 /// configured command was never actually run because a resource it
1078 /// needs — right now, only the shared build cache's lease or the
1079 /// freshness check that must precede using it — was not available
1080 /// within budget. Distinct from an ordinary failure or timeout (both of
1081 /// which *did* run something and are evidence about the patch); this is
1082 /// evidence about the machine, and must never be read as a verdict on
1083 /// the tree it named. `#[serde(default)]` so every record written
1084 /// before this field existed keeps reading as `false` — exactly what it
1085 /// was.
1086 #[serde(default)]
1087 pub resource_blocked: bool,
1088}
1089
1090/// Substrings that mark a Cargo/rustc/link failure: the toolchain could not
1091/// produce a binary to run at all, as opposed to producing one that ran and
1092/// failed. A Windows link race against a shared `CARGO_TARGET_DIR` (see
1093/// AGENTS.md, "Running magi on magi") looks exactly like a red command
1094/// otherwise, and a run has concluded `Blocked` on nothing but that race.
1095const BUILD_FAILURE_MARKERS: &[&str] = &[
1096 "error: could not compile",
1097 "error: linking with",
1098 "LINK : fatal error",
1099 "fatal error LNK",
1100];
1101
1102impl CommandOutcome {
1103 /// Did it pass?
1104 pub fn ok(&self) -> bool {
1105 self.code == Some(0)
1106 }
1107
1108 /// Did this command fail because the code could not be built or linked,
1109 /// rather than because it ran and produced a wrong result? A failure here
1110 /// is not a verdict on the patch under review.
1111 pub fn build_failed(&self) -> bool {
1112 !self.ok()
1113 && BUILD_FAILURE_MARKERS
1114 .iter()
1115 .any(|m| self.output_tail.contains(m))
1116 }
1117}
1118
1119/// One review + verify + fix round.
1120#[derive(Debug, Clone, Serialize, Deserialize)]
1121pub struct ReviewRound {
1122 /// 1-based round number.
1123 pub round: usize,
1124 /// Commit the round reviewed.
1125 pub head: String,
1126 /// The commit `e2e` was actually attempted against. Set whenever an
1127 /// attempt was dispatched (`e2e_status()` reads `Passed`, `Failed`, or
1128 /// `ResourceBlocked`), naming that commit even when it equals `head` —
1129 /// never left implicit, because an implicit "must have been `head`" is
1130 /// exactly what let a later round quote an earlier round's result
1131 /// without saying which commit it came from. A resource-blocked attempt
1132 /// still targeted a specific commit even though no command finished, and
1133 /// leaving that unrecorded is exactly what made a *fresh* blocked
1134 /// attempt read the same as an untracked one from before schema 8.
1135 /// `None` only when nothing was attempted at all (`NotConfigured`,
1136 /// `Deferred`). See `SCHEMA`'s doc for schema 8 for why this broadened
1137 /// from only the catch-up-on-a-different-commit case.
1138 #[serde(default)]
1139 pub verified_head: Option<String>,
1140 /// When the attempt behind `verified_head` actually ran. `None` on
1141 /// every record written before schema 8, and on a round where nothing
1142 /// ran —
1143 /// both read as "unknown", not as "now" or "never asked".
1144 #[serde(default)]
1145 pub verified_at: Option<Timestamp>,
1146 /// Reviewer reports.
1147 pub reviews: Vec<ReviewRecord>,
1148 /// E2E command outcomes for this round.
1149 #[serde(default)]
1150 pub e2e: Vec<CommandOutcome>,
1151 /// True when the first verify attempt this round could not build or
1152 /// link, and `e2e` above holds a second attempt run before concluding.
1153 /// A run must never be decided on a red it could not tell from an
1154 /// unrelated build race.
1155 #[serde(default)]
1156 pub verify_retried: bool,
1157 /// True when `e2e` was intentionally left empty this round: the round
1158 /// already had blocking findings and another round was available, so
1159 /// `graph::Runner::review_loop` sent the fixer straight at them instead
1160 /// of spending a full verify run on a head it already knew would need
1161 /// another fix. Distinct from an `e2e` that is simply empty because
1162 /// `verify.e2e` has no commands configured — `e2e.is_empty()` alone
1163 /// cannot tell those apart, and conflating them is exactly how a
1164 /// deferred check would get painted green. A record written before this
1165 /// field existed defaults to `false`, which is the truth for it: every
1166 /// round used to run e2e unconditionally.
1167 #[serde(default)]
1168 pub e2e_deferred: bool,
1169 /// Why `e2e` was deferred, set only when [`Self::e2e_deferred`] is true.
1170 /// Carried to the fixer's prompt and shown in the report so "deferred"
1171 /// never reads as silence.
1172 #[serde(default)]
1173 pub e2e_defer_reason: Option<String>,
1174 /// Fixer response, absent when the round was already clean.
1175 #[serde(default)]
1176 pub fix: Option<FixRecord>,
1177 /// Findings that hold the merge.
1178 #[serde(default)]
1179 pub blocking: usize,
1180 /// Reviewer seats that answered (did not time out, crash, or return
1181 /// something unparsable).
1182 #[serde(default)]
1183 pub answered: usize,
1184 /// Reviewer seats the round expected an answer from — normally
1185 /// `graph.reviewers`, but recorded per round so a config change between
1186 /// runs never has to be inferred from history.
1187 #[serde(default)]
1188 pub expected: usize,
1189 /// Round ended with no blocking findings and green verification, judged
1190 /// against the seats that answered. See [`Self::incomplete`] for whether
1191 /// that verdict is missing input.
1192 #[serde(default)]
1193 pub clean: bool,
1194 /// Did the tree actually move against `base` this round, comparing the
1195 /// diff after the fix to the diff the reviewers saw at the start of the
1196 /// round?
1197 ///
1198 /// Never derived from the fixer's own `addressed`/`rejected` count: that
1199 /// self-report has been caught lying twice on this workload (runs `b455`
1200 /// and `6218`, both of which committed a real, substantial diff while
1201 /// reporting `0 addressed`). `git` does not lie about whether the tree
1202 /// changed, so this is what `graph::Runner::review_loop` counts rounds of
1203 /// no progress against. Absent on a round with no fix attempt (already
1204 /// clean, or the round the budget ran out on), where it defaults to
1205 /// `false` and is not consulted.
1206 #[serde(default)]
1207 pub progressed: bool,
1208 /// Did the seats' initial votes ([`ReviewRecord::vote`]) disagree?
1209 #[serde(default)]
1210 pub vote_split: bool,
1211 /// One round of revoting, run only when `vote_split`: each seat that cast
1212 /// an initial vote reads every seat's findings and votes, then revotes.
1213 /// Empty when the initial votes already agreed, the same as a solo
1214 /// candidate leaving `deliberation` empty.
1215 #[serde(default)]
1216 pub reconsideration: Vec<ReviewRevoteRecord>,
1217 /// The round's verdict: the most cautious vote among the seats that
1218 /// answered, using each seat's revote where reconsideration ran and its
1219 /// initial vote otherwise. `None` when no seat produced a usable vote —
1220 /// including every record written before votes existed, which is the
1221 /// truth for those rounds, not a gap in this one.
1222 #[serde(default)]
1223 pub verdict: Option<ReviewVote>,
1224}
1225
1226/// A merge-approval question and the head commit it was asked about.
1227#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1228pub struct LandApproval {
1229 /// Id of the question that was filed for `head`.
1230 pub question: String,
1231 /// The commit the question's panel was built from.
1232 pub head: String,
1233}
1234
1235/// A review hand-off the panel did not agree to: findings that hold the merge
1236/// are still open and at least one seat's final vote was reject. Recorded on
1237/// [`RunState::contested_handoff`] so `land` can name them in its question.
1238#[derive(Debug, Clone, Serialize, Deserialize)]
1239pub struct ContestedHandoff {
1240 /// Open findings of severity Major or above, in report order.
1241 pub findings: Vec<Finding>,
1242 /// Seats (1-based) whose final vote was reject, with the agent in the seat.
1243 pub rejecters: Vec<(usize, String)>,
1244}
1245
1246impl ReviewRound {
1247 /// Each answering seat's final vote: its revote where reconsideration ran
1248 /// and answered, its initial vote otherwise. The single place this is
1249 /// decided, shared by the round's verdict and [`Self::contested_handoff`].
1250 pub fn final_votes(&self) -> Vec<(usize, String, ReviewVote)> {
1251 self.reviews
1252 .iter()
1253 .filter_map(|r| {
1254 self.reconsideration
1255 .iter()
1256 .find(|rv| rv.reviewer == r.reviewer)
1257 .and_then(|rv| rv.vote)
1258 .or(r.vote)
1259 .map(|v| (r.reviewer, r.agent.clone(), v))
1260 })
1261 .collect()
1262 }
1263
1264 /// Is this round's hand-off contested: a Major-or-above finding open and
1265 /// at least one final vote of reject? `None` otherwise. Kept as one small
1266 /// function so anything deciding on it reads the same answer.
1267 pub fn contested_handoff(&self) -> Option<ContestedHandoff> {
1268 let findings: Vec<Finding> = self
1269 .reviews
1270 .iter()
1271 .flat_map(|r| r.findings.iter())
1272 .filter(|f| f.severity.blocks())
1273 .cloned()
1274 .collect();
1275 if findings.is_empty() {
1276 return None;
1277 }
1278 let rejecters: Vec<(usize, String)> = self
1279 .final_votes()
1280 .into_iter()
1281 .filter(|(_, _, v)| *v == ReviewVote::Reject)
1282 .map(|(seat, agent, _)| (seat, agent))
1283 .collect();
1284 if rejecters.is_empty() {
1285 return None;
1286 }
1287 Some(ContestedHandoff {
1288 findings,
1289 rejecters,
1290 })
1291 }
1292
1293 /// Did at least one reviewer seat fail to answer this round?
1294 pub fn incomplete(&self) -> bool {
1295 self.answered < self.expected
1296 }
1297
1298 /// The honest state of this round's e2e leg.
1299 ///
1300 /// Never derive this from `e2e.is_empty()` alone anywhere else in the
1301 /// codebase — `NotConfigured` and `Deferred` both leave it empty, and
1302 /// only this method (backed by [`Self::e2e_deferred`]) tells them apart.
1303 /// A resource-blocked attempt is checked first and ahead of both: `e2e`
1304 /// is non-empty for it too, but `CommandOutcome::resource_blocked` says
1305 /// no command actually ran, and reading that as `Failed` is exactly how
1306 /// shared build-cache contention gets misreported as a verdict on the
1307 /// patch (see `CommandOutcome::resource_blocked`'s own doc).
1308 pub fn e2e_status(&self) -> E2eStatus {
1309 if self.e2e.iter().any(|o| o.resource_blocked) {
1310 E2eStatus::ResourceBlocked
1311 } else if !self.e2e.is_empty() {
1312 if self.e2e.iter().all(CommandOutcome::ok) {
1313 E2eStatus::Passed
1314 } else {
1315 E2eStatus::Failed
1316 }
1317 } else if self.e2e_deferred {
1318 E2eStatus::Deferred
1319 } else {
1320 E2eStatus::NotConfigured
1321 }
1322 }
1323
1324 /// Facts about this round's verification leg, judged against
1325 /// `current_head` — the commit whoever is asking is actually looking at
1326 /// right now. `None` when there is nothing worth surfacing: no
1327 /// `verify.e2e` configured, or the round's own check came back green (a
1328 /// passing result needs no skepticism attached to it, and an unread
1329 /// `None` is exactly what keeps a quiet round quiet instead of padding
1330 /// every prompt with "everything was fine").
1331 ///
1332 /// This is the single place that turns `e2e`/`e2e_deferred`/
1333 /// `verified_head`/`verified_at` into text. Every prompt and report that
1334 /// shows a round's verification result must build its wording from this,
1335 /// not re-derive its own summary at the call site — a hand-rolled
1336 /// version at one more place is exactly how "an old red read as today's
1337 /// answer" comes back through a different door (see the incident this
1338 /// type exists to prevent, recorded alongside `SCHEMA`'s doc for schema
1339 /// 8).
1340 pub fn verification_summary(&self, current_head: &str) -> Option<VerificationSummary> {
1341 let status = self.e2e_status();
1342 if matches!(status, E2eStatus::NotConfigured | E2eStatus::Passed) {
1343 return None;
1344 }
1345 let commit = match &self.verified_head {
1346 Some(h) if h == current_head => {
1347 format!("commit {} (this is the head being looked at now)", short(h))
1348 }
1349 Some(h) => format!("commit {} (an earlier head, since superseded)", short(h)),
1350 None => "commit unknown (no command finished checking one)".to_owned(),
1351 };
1352 let checked_at = match self.verified_at {
1353 Some(t) => format!("checked at {t}"),
1354 None => "checked at: unknown (recorded before this was tracked)".to_owned(),
1355 };
1356 let result = match status {
1357 E2eStatus::NotConfigured | E2eStatus::Passed => unreachable!("checked above"),
1358 E2eStatus::Failed => "result: FAILED".to_owned(),
1359 E2eStatus::Deferred => format!(
1360 "result: not run this round yet — deferred to the fixer{}. Not passed, not \
1361 failed.",
1362 self.e2e_defer_reason
1363 .as_deref()
1364 .map(|why| format!(" ({why})"))
1365 .unwrap_or_default()
1366 ),
1367 E2eStatus::ResourceBlocked => "result: could not run — the shared build cache was \
1368 not available. This is evidence about the machine, \
1369 not about the patch."
1370 .to_owned(),
1371 };
1372 let label = format!("round {}, {commit}, {checked_at}\n{result}", self.round);
1373 // `Failed` names the command that actually ran and failed;
1374 // `ResourceBlocked` names the operation magi was waiting on (or the
1375 // freshness check it could not confirm) — `command` still says what
1376 // was attempted even though nothing finished, and leaving it out is
1377 // exactly how a reviewer or fixer lost the one thing this leg *can*
1378 // still tell them: what was being checked, not whether it passed.
1379 let tail = matches!(status, E2eStatus::Failed | E2eStatus::ResourceBlocked).then(|| {
1380 self.e2e
1381 .iter()
1382 .filter(|o| !o.ok())
1383 .map(|o| format!("$ {}\n{}\n", o.command, o.output_tail))
1384 .collect::<String>()
1385 });
1386 Some(VerificationSummary { label, tail })
1387 }
1388}
1389
1390/// The honest state of a round's e2e leg. See [`ReviewRound::e2e_status`].
1391#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1392pub enum E2eStatus {
1393 /// `verify.e2e` has no commands configured.
1394 NotConfigured,
1395 /// Skipped this round on purpose: blocking findings already required a
1396 /// fix, so the round went straight to the fixer instead of spending a
1397 /// full verify run on a head it already knew would need another pass.
1398 Deferred,
1399 /// Ran, and every command exited 0.
1400 Passed,
1401 /// Ran, and at least one command did not exit 0.
1402 Failed,
1403 /// Magi could not even get a command to run — the shared build cache's
1404 /// lease or freshness check was not available within budget. Evidence
1405 /// about the machine, never a verdict on the tree it named; must not be
1406 /// shown or counted the same as [`Self::Failed`].
1407 ResourceBlocked,
1408}
1409
1410/// [`ReviewRound::verification_summary`]'s output: the facts, pre-worded, for
1411/// a prompt or report to place under its own heading. Kept as two pieces
1412/// rather than one pre-joined string so a caller that wants to insert its own
1413/// note between the label and the raw command tail (see `prompt::review`) can
1414/// do so without re-parsing text back apart.
1415#[derive(Debug, Clone)]
1416pub struct VerificationSummary {
1417 /// Round, commit, freshness and result — always present.
1418 pub label: String,
1419 /// Raw `$ command` / output tail, present for `result: FAILED` and for
1420 /// a resource-blocked attempt (naming the operation magi was waiting on,
1421 /// even though nothing finished) — absent for every other result, which
1422 /// has nothing to add past the label.
1423 pub tail: Option<String>,
1424}
1425
1426/// The honest state of a run's final gate. See [`RunState::gate_status`].
1427#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1428pub enum GateStatus {
1429 /// Never attempted, or the last attempt was resource-blocked (the shared
1430 /// build cache could not be acquired or confirmed fresh in time) and
1431 /// needs a retry.
1432 NotRun,
1433 /// Ran with zero commands configured (`verify.gate` is empty) and
1434 /// therefore vacuously passed — there was nothing to check.
1435 PassedWithNoCommands,
1436 /// Ran one or more commands, and every one of them exited 0.
1437 Passed,
1438 /// Ran one or more commands, and at least one did not exit 0.
1439 Failed,
1440}
1441
1442impl GateStatus {
1443 /// May a run in this state proceed to merge?
1444 pub fn ok(self) -> bool {
1445 matches!(self, Self::PassedWithNoCommands | Self::Passed)
1446 }
1447}
1448
1449/// What happened to the winning branch.
1450#[derive(Debug, Clone, Serialize, Deserialize)]
1451pub struct MergeOutcome {
1452 /// Requested mode.
1453 pub mode: MergeMode,
1454 /// Did it land?
1455 pub ok: bool,
1456 /// Command output, or the command the operator should run.
1457 #[serde(default)]
1458 pub detail: String,
1459 /// The winner had no commits ahead of the base, so no pull request was
1460 /// attempted. Distinct from a `gh` failure: nothing was wrong with the
1461 /// tooling, there was simply nothing to land.
1462 #[serde(default)]
1463 pub empty: bool,
1464}
1465
1466/// A seat currently mid-answer: a prompt was sent and no reply has landed yet.
1467///
1468/// This is not the whole story of "is it alive" — a daemon killed mid-wave
1469/// leaves its last wave's entries here forever, since nothing ran to clear
1470/// them. A reader must cross-check a live daemon's heartbeat
1471/// (`daemon::is_working_on`) before trusting one of these as "still running"
1472/// rather than "abandoned". [`RunState::clear_active`] is what keeps that
1473/// leftover from surviving into the next attempt at this run: `execute` calls
1474/// it before doing anything else, so a resumed run never carries a stale
1475/// entry into its own report before the next wave repopulates it.
1476///
1477/// Deliberately carries no agent id: an implementer's agent is no secret, but
1478/// a judge or reviewer seat is blind (`SeatState::key` is keyed by seat, never
1479/// agent, for exactly this reason), and this struct has no way to tell which
1480/// kind of seat it describes. The seat key alone — already in the map this
1481/// lives under — is what every caller needs to say which seat is running.
1482///
1483/// The same map also carries entries for shell-command work that runs
1484/// outside any seat — `verify.e2e`, `verify.gate` — keyed by the task's own
1485/// name (`"e2e"`, `"gate"`) rather than a seat key. [`Self::task`] is `Some`
1486/// only for those; it is how a reader tells the two kinds of entry apart
1487/// without a second map, a second route, or a second SSE reason to poll for
1488/// — see [`RunState::seats_active`] / [`RunState::tasks_active`] for the
1489/// accessors that split them back apart. A task entry is exactly as blind as
1490/// a seat entry: no agent runs it, so there is nothing to leak, and
1491/// [`Self::command`] carries only the shell command being run, never
1492/// anything about who is running it.
1493#[derive(Debug, Clone, Serialize, Deserialize)]
1494pub struct ActiveSeat {
1495 /// Node the seat is answering for, e.g. `implement`, `judge`, `review`.
1496 /// For a task entry, the node the command list runs under (`verify`,
1497 /// `gate`).
1498 pub node: String,
1499 /// When this attempt — or, for a task entry, this one command — was
1500 /// started. A task entry's timer resets at every command boundary,
1501 /// because `verify.e2e` / `verify.gate` apply their timeout per command,
1502 /// not once across the whole list — see [`RunState::task_command`].
1503 pub started_at: Timestamp,
1504 /// The wall-clock budget for this attempt (a seat) or this one command
1505 /// (a task entry).
1506 pub timeout_secs: u64,
1507 /// 0 for the first ask, N for the Nth nudge or resume. For a task entry,
1508 /// 0 for the first pass over the command list, N for the Nth retry (see
1509 /// `run_e2e_with_retry`'s build/link retry).
1510 #[serde(default)]
1511 pub attempt: usize,
1512 /// `None` for a seat; `Some("e2e")` / `Some("gate")` for a running
1513 /// command-list task. This is the type tag that lets both kinds of entry
1514 /// share one map without a task ever being mistaken for a (blind) seat —
1515 /// see this struct's own doc. Omitted from JSON when absent (the common,
1516 /// seat case), rather than written out as a literal `null` on every one
1517 /// of a run's seat entries.
1518 #[serde(default, skip_serializing_if = "Option::is_none")]
1519 pub task: Option<String>,
1520 /// The command currently running, task entries only. Never set on a
1521 /// seat entry — a seat has no command, only a prompt, and a prompt is
1522 /// not safe to show mid-run (see this struct's blindness note).
1523 #[serde(default, skip_serializing_if = "Option::is_none")]
1524 pub command: Option<String>,
1525 /// 1-based position of [`Self::command`] within the task's command list.
1526 #[serde(default, skip_serializing_if = "Option::is_none")]
1527 pub index: Option<usize>,
1528 /// Number of commands in the task's list.
1529 #[serde(default, skip_serializing_if = "Option::is_none")]
1530 pub total: Option<usize>,
1531}
1532
1533impl ActiveSeat {
1534 /// Seconds since this attempt was sent.
1535 #[must_use]
1536 pub fn elapsed_secs(&self, now: Timestamp) -> i64 {
1537 (now.as_second() - self.started_at.as_second()).max(0)
1538 }
1539
1540 /// Seconds left before this attempt's own timeout fires, floored at zero
1541 /// rather than going negative once the CLI has overrun its budget.
1542 #[must_use]
1543 pub fn remaining_secs(&self, now: Timestamp) -> i64 {
1544 (self.timeout_secs as i64 - self.elapsed_secs(now)).max(0)
1545 }
1546}
1547
1548/// Whether a process is provably still driving a run, provably not, or
1549/// neither — see [`RunState::liveness`]. Serialized as a lowercase string
1550/// (`"live"` / `"dead"` / `"unknown"`) rather than a bool: a bool has no room
1551/// for "could not tell", and folding that case into either `true` or `false`
1552/// is exactly the wrong call for a display an operator uses to decide
1553/// whether to wait or to act — see the schema-10 field doc on
1554/// [`RunState::driver_pid`] for the report it used to produce instead.
1555#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
1556#[serde(rename_all = "lowercase")]
1557pub enum Liveness {
1558 /// Proven: a daemon's heartbeat claims the run, or `driver_pid` answers
1559 /// alive under the same identity (`driver_started_at`) this run recorded
1560 /// for it.
1561 Live,
1562 /// Proven: no daemon claim, and either `driver_pid` answers dead outright
1563 /// or it answers alive under a *different* identity than recorded — a
1564 /// pid the OS has since handed to an unrelated process is exactly as
1565 /// good as proof the original driver is gone (see
1566 /// [`RunState::driver_started_at`]'s own doc).
1567 Dead,
1568 /// Neither proven — no daemon claim, and either no `driver_pid` to ask,
1569 /// the platform could not answer for it, or a live pid with nothing (or
1570 /// nothing queryable) to corroborate its identity against. Never treated
1571 /// as `Dead`: see [`RunState::liveness_with`].
1572 Unknown,
1573}
1574
1575/// A timestamped note about a node.
1576#[derive(Debug, Clone, Serialize, Deserialize)]
1577pub struct Event {
1578 /// When.
1579 pub at: Timestamp,
1580 /// Node name.
1581 pub node: String,
1582 /// What happened.
1583 pub message: String,
1584}
1585
1586/// How far the winner's tree trailed the landing base, last time it was
1587/// checked, and what came of trying to close that gap.
1588///
1589/// Set by `graph::Runner::sync_to_base`, which runs before the review loop and
1590/// again before the gate: verifying against a tree that does not yet contain
1591/// the base's tip answers "green on the commit this run branched from", not
1592/// "green on what is about to land", and a merge on that answer can revert
1593/// whatever landed elsewhere while the run was thinking.
1594#[derive(Debug, Clone, Serialize, Deserialize)]
1595pub struct BaseSync {
1596 /// `<remote>/<base>` tip the tree was last checked against.
1597 pub tip: String,
1598 /// Commits `tip` was ahead of the tree at that check, before any rebase
1599 /// this round tried to close the gap. Zero means the tree already
1600 /// contained `tip`.
1601 pub behind: usize,
1602 /// Rebase attempts spent so far this run, bounded by
1603 /// `graph::BASE_SYNC_ROUNDS`.
1604 pub attempts: usize,
1605 /// What git said, if the most recent rebase attempt conflicted or could
1606 /// not be pushed. `Some` here is what makes a `Blocked` run read as
1607 /// "stopped on the base, not on review or the gate" - the rebase is not
1608 /// retried again while this is set; a person has to look.
1609 #[serde(default)]
1610 pub conflict: Option<String>,
1611 /// Set when the winner's whole change turned out to be on the base already
1612 /// under other commit ids (see [`crate::already`]). Present exactly when the
1613 /// run ended as [`RunStatus::AlreadyInBase`].
1614 #[serde(default)]
1615 pub already_in: Option<crate::already::Evidence>,
1616}
1617
1618/// What the land loop saw last time it looked at the pull request.
1619///
1620/// Strings for `state` and `checks` on purpose: they are `gh`'s vocabulary, and
1621/// pinning them into an enum here would mean a new GitHub check conclusion
1622/// turns a readable status into a deserialisation error on a run someone is
1623/// trying to look at.
1624#[derive(Debug, Clone, Serialize, Deserialize)]
1625pub struct PrRecord {
1626 /// Pull request url.
1627 pub url: String,
1628 /// Pull request number.
1629 pub number: u64,
1630 /// `open`, `merged` or `closed`.
1631 pub state: String,
1632 /// `pending`, `green`, `red` or `unknown`.
1633 pub checks: String,
1634 /// Land round, 1-based, or 0 before the first fix.
1635 pub round: usize,
1636 /// Land round budget.
1637 pub rounds: usize,
1638 /// Checks that were red when the pull request merged anyway (the forge
1639 /// said they do not block it). Empty for a green merge, and for any run
1640 /// recorded before this field existed - so empty is not proof nothing was
1641 /// red.
1642 #[serde(default, skip_serializing_if = "Vec::is_empty")]
1643 pub red_at_merge: Vec<String>,
1644}
1645
1646/// What the post-merge release-bump step did, and whether it needs a human.
1647///
1648/// Recorded next to the `bump` events rather than instead of them: the events
1649/// are the narrative, this is what `magi show`, the status word and the
1650/// notification read without parsing prose. `status` stays `Merged` - the
1651/// merge did happen - so [`RunState::needs_attention`] is the one place that
1652/// says a merged run is not fully done.
1653#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
1654pub struct ReleaseBump {
1655 /// The release pull request, when one was opened.
1656 #[serde(default)]
1657 pub pr_url: Option<String>,
1658 /// The version it releases.
1659 #[serde(default)]
1660 pub version: Option<String>,
1661 /// Did enabling automerge on `pr_url` succeed?
1662 #[serde(default)]
1663 pub automerge_enabled: bool,
1664 /// GitHub refused automerge because CI had already finished (the pull
1665 /// request was in clean status), so magi merged it directly. Kept apart
1666 /// from `automerge_enabled`, which stays the plain fact it says it is.
1667 #[serde(default)]
1668 pub merged_directly: bool,
1669 /// What went wrong, verbatim from the tool that said it.
1670 #[serde(default)]
1671 pub problem: Option<String>,
1672 /// What the operator has to do about it. `Some` is what makes a merged run
1673 /// read as needing attention.
1674 #[serde(default)]
1675 pub action_required: Option<String>,
1676}
1677
1678/// The whole run.
1679#[derive(Debug, Clone, Serialize, Deserialize)]
1680pub struct RunState {
1681 /// On-disk format version.
1682 pub schema: u32,
1683 /// Run id, e.g. `20260830-153012-a1b2`.
1684 pub id: String,
1685 /// Repository the run operates on.
1686 pub repo: PathBuf,
1687 /// Branch the run started from.
1688 pub base_branch: String,
1689 /// Commit the run started from.
1690 pub base_commit: String,
1691 /// The task, verbatim.
1692 pub instruction: String,
1693 /// When the run was created.
1694 pub created_at: Timestamp,
1695 /// Last state flush.
1696 pub updated_at: Timestamp,
1697 /// Current status.
1698 pub status: RunStatus,
1699 /// Seed for labels and session ids.
1700 pub seed: u64,
1701 /// Config snapshot, so a resumed run behaves like the original.
1702 pub config: Config,
1703 /// Did this run take a reference on `extensions.worktreeConfig` being on
1704 /// (see [`crate::git::acquire_worktree_config`])? If so, cleanup releases
1705 /// it - which only actually turns the setting back off once every other
1706 /// run sharing this repository has released its own reference too.
1707 #[serde(default)]
1708 pub enabled_worktree_config: bool,
1709 /// Candidates.
1710 #[serde(default)]
1711 pub candidates: Vec<Candidate>,
1712 /// Initial blind rankings.
1713 #[serde(default)]
1714 pub judgements: Vec<Judgement>,
1715 /// `judge` decided a solo candidate needs no panel and only logged it.
1716 ///
1717 /// `judgements` stays empty in that case — nothing to distinguish from
1718 /// "not yet judged" — so this is the record that makes the skip
1719 /// idempotent: without it, every reentry re-ran `judge`, re-logged the
1720 /// same event, and rewrote `status` to `Judging` over whatever a later
1721 /// node had already concluded.
1722 #[serde(default)]
1723 pub judge_skipped: bool,
1724 /// Deliberation, if it happened.
1725 #[serde(default)]
1726 pub deliberation: Vec<DeliberationRound>,
1727 /// Private final votes.
1728 #[serde(default)]
1729 pub votes: Vec<VoteRecord>,
1730 /// The count.
1731 #[serde(default)]
1732 pub tally: Option<Tally>,
1733 /// Review rounds.
1734 #[serde(default)]
1735 pub reviews: Vec<ReviewRound>,
1736 /// Final gate.
1737 ///
1738 /// Never derive whether the gate has run from `gate.is_empty()` alone —
1739 /// use [`Self::gate_status`] instead. An empty list is ambiguous on its
1740 /// own: it is what an unattempted gate looks like, what a
1741 /// resource-blocked attempt leaves behind (see `graph::Runner::gate`'s
1742 /// own doc), and also what a repo with no `verify.gate` commands
1743 /// configured produces once it *has* run. [`Self::gate_ran`] is what
1744 /// tells the third case apart from the first two.
1745 #[serde(default)]
1746 pub gate: Vec<CommandOutcome>,
1747 /// Did `gate()` actually record an attempt — zero commands configured
1748 /// and vacuously passed, or one or more commands that ran to
1749 /// completion — as opposed to never having run, or having last hit a
1750 /// resource-blocked retry?
1751 ///
1752 /// `gate.is_empty()` cannot tell those apart by itself: a repo with no
1753 /// `verify.gate` commands leaves `gate` empty exactly like an
1754 /// unattempted or resource-blocked one does, and reading that empty list
1755 /// as "not yet run" is what stranded a review-only run in
1756 /// `RunStatus::Gating` forever on such a repo — see `SCHEMA`'s doc for
1757 /// schema 7. A record written before this field existed defaults to
1758 /// `false` and is migrated in [`migrate_schema`].
1759 #[serde(default)]
1760 pub gate_ran: bool,
1761 /// Fix rounds a failing gate has already spent, oldest first. Persisted
1762 /// right after each fixer call so a resumed run spends only what is left
1763 /// of `graph.gate_fix_rounds` instead of starting the budget over.
1764 #[serde(default)]
1765 pub gate_fixes: Vec<GateFixRecord>,
1766 /// Fixer rounds spent on a rebase conflict (base sync and land share one
1767 /// budget, `graph.review_rounds`), oldest first. Persisted right before
1768 /// each fixer call, so a resumed run spends only what is left.
1769 #[serde(default)]
1770 pub rebase_fixes: Vec<RebaseFixRecord>,
1771 /// Set at the review loop's hand-off when the last round ended with a
1772 /// blocking finding still open *and* a reviewer's final vote was reject
1773 /// (see [`ReviewRound::contested_handoff`]). `land` reads it to ask the
1774 /// owner before merging even with `graph.land_approval` off. A snapshot
1775 /// taken at hand-off, never recomputed later.
1776 #[serde(default)]
1777 pub contested_handoff: Option<ContestedHandoff>,
1778 /// The head commit `land` has armed (or is about to arm) GitHub auto-merge
1779 /// on. Saved *before* the arm call, so a crash right after it still tells
1780 /// a resume that the forge may be holding an armed merge. Cleared the
1781 /// moment auto-merge is disabled or the pull request is done.
1782 #[serde(default)]
1783 pub land_armed_head: Option<String>,
1784 /// The merge-approval question `land` last filed, and the head commit its
1785 /// panel showed. An answer is only honoured for that exact commit: a fix
1786 /// or rebase push makes a new head the owner has not seen.
1787 #[serde(default)]
1788 pub land_approval: Option<LandApproval>,
1789 /// Outcomes of the `verify.pre_gate` commands from the latest time they
1790 /// ran on the winner. Informational only: a failure here never blocks the
1791 /// run, the gate stays the single arbiter. Overwritten on each pass.
1792 #[serde(default)]
1793 pub pre_gate: Vec<CommandOutcome>,
1794 /// The latest commit a `pre_gate` pass made, if any pass left changes.
1795 #[serde(default)]
1796 pub pre_gate_commit: Option<String>,
1797 /// Merge outcome.
1798 #[serde(default)]
1799 pub merge: Option<MergeOutcome>,
1800 /// Vendor tokens seen in judged material.
1801 #[serde(default)]
1802 pub leaks: Vec<Leak>,
1803 /// Seats lost to a CLI rate limit / quota, in the order they hit.
1804 #[serde(default)]
1805 pub quota: Vec<QuotaLoss>,
1806 /// Seats handed to the next roster agent after a failure, in order.
1807 /// Additive, so `SCHEMA` is not bumped.
1808 #[serde(default)]
1809 pub handovers: Vec<Handover>,
1810 /// How many agent-change seats this run has minted; mixed into their
1811 /// session ids so re-handing a seat to an agent it already had never
1812 /// reuses that agent's earlier uuid. Additive.
1813 #[serde(default)]
1814 pub seat_epoch: u64,
1815 /// Per reviewer seat, which roster agents already failed it and which one
1816 /// last answered, carried across review rounds. Additive, so `SCHEMA` is
1817 /// not bumped. See [`SeatHistory`].
1818 #[serde(default)]
1819 pub seat_history: BTreeMap<String, SeatHistory>,
1820 /// Stray foreign lockfiles a rescue commit left out, one entry per path.
1821 #[serde(default)]
1822 pub withheld: Vec<Withheld>,
1823 /// Parked at a node boundary, waiting to be resumed.
1824 ///
1825 /// A run that is neither finished nor being worked on is otherwise
1826 /// indistinguishable from one whose daemon was killed, and the two want
1827 /// opposite things from an operator: the first is expected to be resumed,
1828 /// the second is a leftover. Cleared by the resume that carries it on.
1829 #[serde(default)]
1830 pub parked: bool,
1831 /// The run that took this run's worktree over, when one did — see
1832 /// [`crate::handover`]. `Some` means the worktree is gone on purpose and
1833 /// the run can no longer be resumed from it ([`Self::released`]).
1834 #[serde(default)]
1835 pub released_to: Option<String>,
1836 /// Branches that outlived this run's released worktree and now belong to
1837 /// the run in [`Self::released_to`] (and to its pull request). A later
1838 /// fold must leave them alone.
1839 #[serde(default)]
1840 pub released_branches: Vec<String>,
1841 /// Existing branches and commits the task text names, and what the
1842 /// repository says about each (`crate::refs`). Unmerged ones seed the
1843 /// candidates; `base_commit` stays the comparison point.
1844 #[serde(default)]
1845 pub seeds: Vec<crate::refs::Seed>,
1846 /// Per-seat conversation state.
1847 #[serde(default)]
1848 pub seats: BTreeMap<String, SeatState>,
1849 /// Seats currently mid-answer, keyed by seat.
1850 ///
1851 /// An entry exists from the moment a prompt is sent until a reply (of any
1852 /// kind — success, failure, quota, drop) comes back, so its keys are
1853 /// exactly "who hasn't answered yet" for whichever node populated it. See
1854 /// [`ActiveSeat`] for why a reader still has to check a live daemon
1855 /// before trusting one of these as "running" rather than "abandoned".
1856 #[serde(default)]
1857 pub active: BTreeMap<String, ActiveSeat>,
1858 /// Process id of whichever `execute()` call last drove this run —
1859 /// written at the very top of that method, the same place
1860 /// [`Self::clear_active`] runs, so a fresh reentry always overwrites the
1861 /// pid a previous, possibly-dead process left behind.
1862 ///
1863 /// A daemon-claimed run already has a stronger signal
1864 /// (`daemon::is_working_on`), but a `magi run` / `magi review` typed
1865 /// straight into a terminal claims nothing there — before this field
1866 /// existed, [`report::active_seats`] had no way to tell that run apart
1867 /// from one a killed process abandoned, and printed the same "no live
1868 /// daemon claims this run" warning over a run that was, in fact, still
1869 /// answering. See [`Liveness`] for how this and the daemon claim combine.
1870 #[serde(default)]
1871 pub driver_pid: Option<u32>,
1872 /// The OS-reported moment [`Self::driver_pid`] started, recorded in the
1873 /// same breath as the pid itself — an opaque marker
1874 /// (`crate::proc::process_started_at`, epoch seconds as an integer
1875 /// string), compared only for equality. Older runs hold a locale-dependent
1876 /// string here; those read as `Unknown`, never `Dead`.
1877 ///
1878 /// A pid alone never proves a live process is *this run's* driver: pids
1879 /// get reused, sometimes within minutes on a busy machine, and a killed
1880 /// manual `magi run` whose pid a later, wholly unrelated process happens
1881 /// to receive would otherwise read back as `Liveness::Live` from that
1882 /// coincidence alone. [`Self::liveness`] re-queries the current holder
1883 /// of `driver_pid` and requires this marker to still match before
1884 /// trusting a live answer — a mismatch means a different process now
1885 /// answers to that number, and no marker to compare (an old run, or a
1886 /// platform this build could not ask at record time) means neither
1887 /// extreme can be proven.
1888 #[serde(default)]
1889 pub driver_started_at: Option<String>,
1890 /// The process named by [`Self::driver_pid`] has stopped driving this run:
1891 /// its graph walk returned, whatever the outcome. Cleared at the start of
1892 /// every walk, set as the last write of one.
1893 ///
1894 /// A long-lived `magi serve` records its own pid and keeps it after the
1895 /// run ends, so that pid answers alive with a matching identity for as
1896 /// long as the daemon lives, and every blocked, failed or parked run it
1897 /// ever drove would read as being worked on right now. A crash or kill
1898 /// never sets this, and needs nothing to: the pid is dead then.
1899 #[serde(default)]
1900 pub driver_exited: bool,
1901 /// Last observation of the winner's pull request, when a land loop ran.
1902 ///
1903 /// Persisted rather than derived from the event log because the phone asks
1904 /// two questions about a run that has opened a PR - how are its checks and
1905 /// which round is it on - and parsing prose out of events to answer them
1906 /// would break the first time an event message was reworded.
1907 #[serde(default)]
1908 pub pr: Option<PrRecord>,
1909 /// The post-merge release-bump step's outcome, when it got as far as
1910 /// having one to report. See [`ReleaseBump`].
1911 #[serde(default)]
1912 pub release_bump: Option<ReleaseBump>,
1913 /// The last look at how far the winner's tree trailed the landing base,
1914 /// and the rebase(s) tried to close that gap. `None` until the tree has a
1915 /// winner to check.
1916 #[serde(default)]
1917 pub base_sync: Option<BaseSync>,
1918 /// The design-deliberation stage's output, when `[graph] advise` ran it:
1919 /// one record per advisor seat, plus the synthesis blended into the
1920 /// implementer's prompt. `None` when the stage is off, has not run yet,
1921 /// or could not even resolve its seats - see
1922 /// [`crate::graph::Runner::advise`].
1923 #[serde(default)]
1924 pub advice: Option<crate::advise::Advice>,
1925 /// Whether the design-deliberation stage has already been attempted this
1926 /// run, whatever it produced. The idempotency marker `Runner::advise`
1927 /// checks on reentry, the same role [`Self::judge_skipped`] plays for
1928 /// `judge` - without it a resumed run whose stage failed (a misconfigured
1929 /// `[roles] advisors`, every seat quota'd) would re-run it, and re-spend
1930 /// the agent calls, on every single reentry before `implement`.
1931 #[serde(default)]
1932 pub advise_attempted: bool,
1933 /// Node log.
1934 #[serde(default)]
1935 pub events: Vec<Event>,
1936 /// Commands seats' own CLIs reported running, across every node — see
1937 /// [`JobRecord`]. Populated in [`crate::graph::wave`] as each seat
1938 /// answers, so a resumed run keeps what earlier waves already collected
1939 /// rather than losing it to a reentry. Empty on a record written before
1940 /// this existed, or wherever no adapter reads structured job events for
1941 /// the backend a seat used — both read as "no evidence", not "nothing
1942 /// ran".
1943 #[serde(default)]
1944 pub jobs: Vec<JobRecord>,
1945 /// Operator-triggered targeted fixes — see [`OperatorFixRequest`] and
1946 /// `SCHEMA`'s doc for schema 9. Empty on every record written before
1947 /// this existed, which reads correctly as "no operator fix ever
1948 /// requested".
1949 #[serde(default)]
1950 pub operator_fixes: Vec<OperatorFixRequest>,
1951 /// Absolute paths of the files the task was filed with (see
1952 /// `crate::queue::Task::attachments`), listed in the implementers' prompt
1953 /// and made readable to their seats. Refreshed from the task on every
1954 /// start and resume, so a file attached while the task was held reaches a
1955 /// resumed run. Additive and `#[serde(default)]`, so `SCHEMA` stays put.
1956 #[serde(default)]
1957 pub attachments: Vec<PathBuf>,
1958 /// Subjects of the commits a review-only run examines, oldest first, as
1959 /// they stood when the run opened. `Some` marks the run as reviewing
1960 /// existing work: the pull request title is taken from these rather than
1961 /// from the review prompt in `instruction`. Additive and
1962 /// `#[serde(default)]`, so `SCHEMA` stays put.
1963 #[serde(default)]
1964 pub reviewed_commits: Option<Vec<String>>,
1965 /// Who started this run and which task it serves — see [`Origin`] and
1966 /// `SCHEMA`'s doc for schema 13. `None` is a run recorded before origins
1967 /// existed, and is reported as unknown, never as an operator's.
1968 #[serde(default)]
1969 pub origin: Option<Origin>,
1970 /// Follow-up tasks filed from this run's open findings after it merged
1971 /// (`crate::followup`). Additive and `#[serde(default)]`, so `SCHEMA`
1972 /// stays put.
1973 #[serde(default)]
1974 pub followups: Vec<FollowupRecord>,
1975 /// Follow-up depth of the task this run served, remembered the first
1976 /// time it was read so deleting that task cannot reset the cap.
1977 #[serde(default)]
1978 pub followup_generation: Option<u32>,
1979 /// The pull-request comment naming the filed follow-ups was posted.
1980 #[serde(default)]
1981 pub followup_commented: bool,
1982}
1983
1984/// One follow-up task filed from a merged run. See [`RunState::followups`].
1985#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
1986pub struct FollowupRecord {
1987 /// Queue task id.
1988 pub task: String,
1989 /// Finding ids it covers.
1990 pub findings: Vec<String>,
1991}
1992
1993impl RunState {
1994 /// A fresh run.
1995 pub fn new(
1996 repo: PathBuf,
1997 base_branch: String,
1998 base_commit: String,
1999 instruction: String,
2000 config: Config,
2001 ) -> Self {
2002 let now = Timestamp::now();
2003 let seed = config.blind.seed.unwrap_or_else(crate::rng::entropy);
2004 Self {
2005 schema: SCHEMA,
2006 id: new_id(),
2007 repo,
2008 base_branch,
2009 base_commit,
2010 instruction,
2011 created_at: now,
2012 updated_at: now,
2013 status: RunStatus::Prep,
2014 seed,
2015 config,
2016 enabled_worktree_config: false,
2017 candidates: Vec::new(),
2018 judgements: Vec::new(),
2019 judge_skipped: false,
2020 deliberation: Vec::new(),
2021 votes: Vec::new(),
2022 tally: None,
2023 reviews: Vec::new(),
2024 gate: Vec::new(),
2025 gate_ran: false,
2026 gate_fixes: Vec::new(),
2027 rebase_fixes: Vec::new(),
2028 contested_handoff: None,
2029 land_armed_head: None,
2030 land_approval: None,
2031 pre_gate: Vec::new(),
2032 pre_gate_commit: None,
2033 merge: None,
2034 leaks: Vec::new(),
2035 quota: Vec::new(),
2036 handovers: Vec::new(),
2037 seat_epoch: 0,
2038 seat_history: BTreeMap::new(),
2039 withheld: Vec::new(),
2040 parked: false,
2041 released_to: None,
2042 released_branches: Vec::new(),
2043 seeds: Vec::new(),
2044 seats: BTreeMap::new(),
2045 active: BTreeMap::new(),
2046 driver_pid: None,
2047 driver_started_at: None,
2048 driver_exited: false,
2049 pr: None,
2050 release_bump: None,
2051 base_sync: None,
2052 advice: None,
2053 advise_attempted: false,
2054 attachments: Vec::new(),
2055 reviewed_commits: None,
2056 origin: None,
2057 followups: Vec::new(),
2058 followup_generation: None,
2059 followup_commented: false,
2060 events: Vec::new(),
2061 jobs: Vec::new(),
2062 operator_fixes: Vec::new(),
2063 }
2064 }
2065
2066 /// Directory holding this run's state and artifacts.
2067 pub fn dir(&self) -> PathBuf {
2068 run_dir(&self.id)
2069 }
2070
2071 /// Short form used in branch names and reports.
2072 pub fn short(&self) -> &str {
2073 short_of(&self.id)
2074 }
2075
2076 /// Branch name for a label.
2077 pub fn branch_for(&self, label: char) -> String {
2078 format!("magi/{}/{}", self.short(), label)
2079 }
2080
2081 /// Root of this run's worktrees.
2082 pub fn worktree_root(&self) -> PathBuf {
2083 self.config
2084 .graph
2085 .worktree_root
2086 .clone()
2087 .unwrap_or_else(default_worktree_root)
2088 .join(self.short())
2089 }
2090
2091 /// Record lockfiles a rescue commit withheld; a path already recorded by an
2092 /// earlier round is not repeated.
2093 pub fn note_withheld(&mut self, node: &str, strays: &[crate::git::Stray]) {
2094 for s in strays {
2095 if self.withheld.iter().any(|w| w.path == s.path) {
2096 continue;
2097 }
2098 self.event(
2099 node,
2100 format!(
2101 "withheld stray lockfile {} ({}; the directory uses {})",
2102 s.path, s.manager, s.kept_by
2103 ),
2104 );
2105 self.withheld.push(Withheld {
2106 path: s.path.clone(),
2107 manager: s.manager.clone(),
2108 kept_by: s.kept_by.clone(),
2109 node: node.to_owned(),
2110 at: Timestamp::now(),
2111 });
2112 }
2113 }
2114
2115 /// Note something in the run log and on the tracing stream.
2116 pub fn event(&mut self, node: &str, message: impl Into<String>) {
2117 let message = message.into();
2118 tracing::info!(node, "{message}");
2119 self.events.push(Event {
2120 at: Timestamp::now(),
2121 node: node.to_owned(),
2122 message,
2123 });
2124 }
2125
2126 /// The honest state of the final gate.
2127 ///
2128 /// Never derive this from `gate.is_empty()` alone anywhere else in the
2129 /// codebase — `NotRun` and `PassedWithNoCommands` both leave `gate`
2130 /// empty, and only this method (backed by [`Self::gate_ran`]) tells them
2131 /// apart. See `SCHEMA`'s doc for schema 7 for what conflating them used
2132 /// to do.
2133 pub fn gate_status(&self) -> GateStatus {
2134 if !self.gate_ran {
2135 GateStatus::NotRun
2136 } else if self.gate.is_empty() {
2137 GateStatus::PassedWithNoCommands
2138 } else if self.gate.iter().all(CommandOutcome::ok) {
2139 GateStatus::Passed
2140 } else {
2141 GateStatus::Failed
2142 }
2143 }
2144
2145 /// Record that `seat` was just sent a prompt for `node`, with the given
2146 /// wall-clock budget. `attempt` is 0 for the first ask and N for the Nth
2147 /// nudge or resume, purely for display — it does not change how the seat
2148 /// is treated.
2149 pub fn seat_started(
2150 &mut self,
2151 node: &str,
2152 seat: &str,
2153 timeout: std::time::Duration,
2154 attempt: usize,
2155 ) {
2156 self.active.insert(
2157 seat.to_owned(),
2158 ActiveSeat {
2159 node: node.to_owned(),
2160 started_at: Timestamp::now(),
2161 timeout_secs: timeout.as_secs(),
2162 attempt,
2163 task: None,
2164 command: None,
2165 index: None,
2166 total: None,
2167 },
2168 );
2169 }
2170
2171 /// Record that `seat` has answered, whatever the answer was.
2172 pub fn seat_finished(&mut self, seat: &str) {
2173 self.active.remove(seat);
2174 }
2175
2176 /// Record that `task` (`"e2e"` or `"gate"` — a shell-command list run
2177 /// outside any seat) has just started `command`, the `index`-th of
2178 /// `total`. Called at every command boundary, not once for the whole
2179 /// list: `verify.e2e` / `verify.gate` apply `timeout` per command, so
2180 /// this is the only way a reader can tell "how long is left" for
2181 /// whichever command is actually running right now, rather than a stale
2182 /// budget left over from the first one.
2183 #[allow(clippy::too_many_arguments)]
2184 pub fn task_command(
2185 &mut self,
2186 task: &str,
2187 node: &str,
2188 attempt: usize,
2189 command: &str,
2190 index: usize,
2191 total: usize,
2192 timeout: std::time::Duration,
2193 ) {
2194 self.active.insert(
2195 task.to_owned(),
2196 ActiveSeat {
2197 node: node.to_owned(),
2198 started_at: Timestamp::now(),
2199 timeout_secs: timeout.as_secs(),
2200 attempt,
2201 task: Some(task.to_owned()),
2202 command: Some(command.to_owned()),
2203 index: Some(index),
2204 total: Some(total),
2205 },
2206 );
2207 }
2208
2209 /// Record that `task` has finished its whole command list for this
2210 /// attempt.
2211 pub fn task_finished(&mut self, task: &str) {
2212 self.active.remove(task);
2213 }
2214
2215 /// The seats — never task entries — currently mid-answer. What
2216 /// `report::active_seats` and the phone's "who has not answered yet"
2217 /// note need: a seat's identifier is safe to show ([`ActiveSeat`]'s doc),
2218 /// so nothing here filters anything out beyond the type tag itself.
2219 pub fn seats_active(&self) -> impl Iterator<Item = (&String, &ActiveSeat)> {
2220 self.active.iter().filter(|(_, a)| a.task.is_none())
2221 }
2222
2223 /// The command-list tasks — never seat entries — currently running.
2224 /// Counterpart to [`Self::seats_active`]; see [`ActiveSeat::task`] for
2225 /// the tag both read.
2226 pub fn tasks_active(&self) -> impl Iterator<Item = (&String, &ActiveSeat)> {
2227 self.active.iter().filter(|(_, a)| a.task.is_some())
2228 }
2229
2230 /// Drop every seat this state still lists as answering, reporting whether
2231 /// anything was dropped.
2232 ///
2233 /// Called first thing in `execute`, on every entry — fresh, resumed, or
2234 /// recovering a stall — because an entry here only means something while
2235 /// the process that wrote it is still asking that seat something. A
2236 /// process killed mid-wave leaves its last batch of seats here with
2237 /// nobody left to clear them, and the next process to touch this run must
2238 /// not let that leftover read as "still going" before it has asked
2239 /// anyone anything.
2240 pub fn clear_active(&mut self) -> bool {
2241 if self.active.is_empty() {
2242 return false;
2243 }
2244 self.active.clear();
2245 true
2246 }
2247
2248 /// Does every seat this run still lists as [`Self::active`] sit past its
2249 /// own [`ActiveSeat::timeout_secs`]? `false` when nothing is active at
2250 /// all — an empty map is not evidence of anything overrunning.
2251 ///
2252 /// This alone is not proof the run is dead: a seat's own attempt can
2253 /// legitimately run a little past its budget while the process driving it
2254 /// is still tearing the attempt down. Every caller pairs this with its own
2255 /// `!live` reading (`daemon::is_working_on`) before treating the run as
2256 /// abandoned — this module cannot check that itself without depending on
2257 /// `crate::daemon`, and callers already have to ask that question anyway.
2258 #[must_use]
2259 pub fn active_all_overrun(&self, now: Timestamp) -> bool {
2260 !self.active.is_empty()
2261 && self
2262 .active
2263 .values()
2264 .all(|a| a.elapsed_secs(now) > a.timeout_secs as i64)
2265 }
2266
2267 /// Whether a process is actually still driving this run, given whether a
2268 /// daemon's heartbeat claims it and process-liveness/identity queries for
2269 /// [`Self::driver_pid`].
2270 ///
2271 /// A daemon claim wins outright when present — it is the stronger,
2272 /// independently-heartbeating signal. Absent that (every manual `magi
2273 /// run` / `magi review`, and every daemon-driven run whose daemon has
2274 /// since exited cleanly), `driver_pid` is asked directly. A live answer
2275 /// alone is not enough to trust, though: pids get reused, so `identity`
2276 /// re-queries whoever currently holds that pid and the result must still
2277 /// match [`Self::driver_started_at`] — the marker recorded at the same
2278 /// moment `driver_pid` was — before this reads `Live`. A mismatch means
2279 /// a *different* process now answers to that number, which is exactly as
2280 /// good as proof the original driver is gone, so that reads `Dead`. The
2281 /// marker is an epoch-seconds integer string; one that is not (a run
2282 /// recorded when it was a locale-dependent `ps` string) reads
2283 /// [`Liveness::Unknown`], never `Dead`. No
2284 /// marker to compare against (an old run, or a platform this build could
2285 /// not ask at record time) or a `None` from either query, and this
2286 /// cannot tell either way, so it reads [`Liveness::Unknown`] — never
2287 /// guessed as [`Liveness::Dead`] out of mere silence. A display that
2288 /// guessed "dead" out of missing information would be exactly the
2289 /// mtime-and-task-manager guessing this type exists to replace.
2290 ///
2291 /// Kept generic over `query` and `identity` so a test can inject answers
2292 /// without spawning a real process query — production code goes through
2293 /// [`Self::liveness`], which supplies [`crate::proc::pid_status`] and
2294 /// [`crate::proc::process_started_at`].
2295 #[must_use]
2296 pub fn liveness_with<F, G>(&self, daemon_claims: bool, query: F, identity: G) -> Liveness
2297 where
2298 F: FnOnce(u32) -> Option<bool>,
2299 G: FnOnce(u32) -> Option<String>,
2300 {
2301 if daemon_claims {
2302 return Liveness::Live;
2303 }
2304 // The driver said itself that it stopped; its pid may well be alive
2305 // (a daemon outlives the runs it drives), so it is not asked.
2306 if self.driver_exited {
2307 return Liveness::Dead;
2308 }
2309 let Some(pid) = self.driver_pid else {
2310 return Liveness::Unknown;
2311 };
2312 match query(pid) {
2313 Some(false) => Liveness::Dead,
2314 None => Liveness::Unknown,
2315 Some(true) => {
2316 let Some(recorded) = &self.driver_started_at else {
2317 return Liveness::Unknown;
2318 };
2319 // A marker in the old locale-dependent format can never be
2320 // compared reliably, so it proves nothing either way.
2321 if !crate::proc::is_identity_marker(recorded) {
2322 return Liveness::Unknown;
2323 }
2324 match identity(pid) {
2325 Some(current) if !crate::proc::is_identity_marker(¤t) => {
2326 Liveness::Unknown
2327 }
2328 Some(current) if *recorded == current => Liveness::Live,
2329 Some(_) => Liveness::Dead,
2330 None => Liveness::Unknown,
2331 }
2332 }
2333 }
2334 }
2335
2336 /// [`Self::liveness_with`], backed by the real process-liveness and
2337 /// identity queries.
2338 #[must_use]
2339 pub fn liveness(&self, daemon_claims: bool) -> Liveness {
2340 self.liveness_with(
2341 daemon_claims,
2342 crate::proc::pid_status,
2343 crate::proc::process_started_at,
2344 )
2345 }
2346
2347 /// Clear every seat this run still lists as active and fail it, unless it
2348 /// had already reached a terminal status some other way.
2349 ///
2350 /// Callers must already have proven this run is dead — [`Self::active_all_overrun`]
2351 /// plus their own `!live` reading — before calling this; it does not
2352 /// check either itself. Unlike [`Self::clear_active`] (dropping a resumed
2353 /// run's own stale wave before repopulating it, called unconditionally at
2354 /// the top of every `execute()`), this is a verdict: a run left this way
2355 /// has nothing left to repopulate the wave, ever, and must stop reading as
2356 /// `implementing` (or whichever node) forever.
2357 pub fn abandon(&mut self, by: &str) {
2358 let seats: Vec<String> = self.active.keys().cloned().collect();
2359 self.clear_active();
2360 if !self.status.done() {
2361 self.status = RunStatus::Failed;
2362 }
2363 self.event(
2364 by,
2365 format!(
2366 "abandoned: seat(s) {} left behind by a killed process, past their own \
2367 timeout with no live daemon claiming this run",
2368 seats.join(", ")
2369 ),
2370 );
2371 }
2372
2373 /// Flush to `run.json`, atomically, under the process-global [`home`].
2374 pub fn save(&mut self) -> Result<()> {
2375 let home = home();
2376 self.save_under(&home)
2377 }
2378
2379 /// [`Self::save`], rooted at an explicit `home` instead of the
2380 /// process-global one.
2381 ///
2382 /// For a caller that was already handed its own `home` explicitly — a
2383 /// housekeeping pass, mainly, for the same reason `Queue::at` and the
2384 /// daemon status path are parameters rather than resolved here (see
2385 /// `daemon::drive`'s own doc) — falling through to the global would write
2386 /// back through whichever directory some *other* process or test pinned
2387 /// into that `OnceLock` first, not the one this call was actually handed.
2388 pub fn save_under(&mut self, home: &Path) -> Result<()> {
2389 self.updated_at = Timestamp::now();
2390 let dir = home.join("runs").join(&self.id);
2391 std::fs::create_dir_all(&dir).with_context(|| format!("create {}", dir.display()))?;
2392 let body = serde_json::to_string_pretty(self).context("serialize run state")?;
2393 let tmp = dir.join("run.json.tmp");
2394 std::fs::write(&tmp, &body).with_context(|| format!("write {}", tmp.display()))?;
2395 std::fs::rename(&tmp, dir.join("run.json")).with_context(|| "replace run.json")?;
2396 Ok(())
2397 }
2398
2399 /// Load a run by id or unambiguous id prefix.
2400 pub fn load(id: &str) -> Result<Self> {
2401 let resolved = resolve_id(id)?;
2402 let path = run_dir(&resolved).join("run.json");
2403 let body =
2404 std::fs::read_to_string(&path).with_context(|| format!("read {}", path.display()))?;
2405 let state: Self =
2406 serde_json::from_str(&body).with_context(|| format!("parse {}", path.display()))?;
2407 migrate_schema(state)
2408 }
2409
2410 /// [`Self::load`], rooted at an explicit `home` instead of the
2411 /// process-global one, and for a full id rather than a prefix — a caller
2412 /// with its own `home` already has the exact id (from a `RunState` it
2413 /// already read, or from `Task::runs`) and has no `runs_root` to search
2414 /// for a prefix against in the first place. Same reasoning as
2415 /// [`Self::save_under`]: a caller holding its own `home` explicitly must
2416 /// not read back through whichever directory some *other* process or
2417 /// test pinned into the global [`home`] `OnceLock` first.
2418 pub fn load_under(id: &str, home: &Path) -> Result<Self> {
2419 let path = home.join("runs").join(id).join("run.json");
2420 let body =
2421 std::fs::read_to_string(&path).with_context(|| format!("read {}", path.display()))?;
2422 let state: Self =
2423 serde_json::from_str(&body).with_context(|| format!("parse {}", path.display()))?;
2424 migrate_schema(state)
2425 }
2426}
2427
2428pub(crate) fn migrate_schema(mut state: RunState) -> Result<RunState> {
2429 // Schema 5 predates deferred e2e. Its empty e2e lists therefore mean
2430 // "not configured", never "deferred"; serde's field defaults retain
2431 // exactly that representation while this migration permits resumes.
2432 if state.schema == 5 {
2433 state.schema = 6;
2434 }
2435 // Schema 6 predates `gate_ran` and could not tell "never attempted or
2436 // resource-blocked" apart from "ran with zero commands configured" — see
2437 // `SCHEMA`'s doc for schema 7. A non-empty `gate` is a real recorded
2438 // attempt either way, so it is trusted as `gate_ran = true` rather than
2439 // spent again; an empty one is simply handed back to the next `gate()`
2440 // call, which re-attempts it and, for the zero-commands case, resolves
2441 // instantly.
2442 if state.schema == 6 {
2443 state.gate_ran = !state.gate.is_empty();
2444 state.schema = 7;
2445 }
2446 // Schema 7's main review loop always checked `e2e` against the round's
2447 // own `head`, it just never wrote that fact into `verified_head` unless
2448 // a catch-up run had checked a *different* commit — see `SCHEMA`'s doc
2449 // for schema 8. Reconstructing `Some(head)` for a round whose `e2e` held
2450 // a real attempt restores a fact that was always true; `verified_at` has
2451 // no historical value to recover and stays `None`.
2452 if state.schema == 7 {
2453 for round in &mut state.reviews {
2454 if round.verified_head.is_none()
2455 && matches!(round.e2e_status(), E2eStatus::Passed | E2eStatus::Failed)
2456 {
2457 round.verified_head = Some(round.head.clone());
2458 }
2459 }
2460 state.schema = 8;
2461 }
2462 // Schema 8 predates `operator_fixes`. There is nothing to reconstruct —
2463 // an old run simply never had one requested — so `#[serde(default)]`
2464 // already left it as the correct empty `Vec`; this only advances the
2465 // version number.
2466 if state.schema == 8 {
2467 state.schema = 9;
2468 }
2469 // Schema 9 predates `RunStatus::VerifiedNoop` and
2470 // `Candidate::verified_noop`. Nothing to reconstruct: an old record never
2471 // made the claim, `#[serde(default)]` already reads `verified_noop` as
2472 // `None` on every candidate, and a `VerifiedNoop` status cannot appear in
2473 // a schema-9 record at all — see `SCHEMA`'s doc for schema 10. This only
2474 // advances the version number.
2475 if state.schema == 9 {
2476 state.schema = 10;
2477 }
2478 // Schema 10 predates `released_to`: no old run ever had its worktree
2479 // handed over, and `#[serde(default)]` reads exactly that. Only the
2480 // version number advances.
2481 if state.schema == 10 {
2482 state.schema = 11;
2483 }
2484 // Schema 11 predates `driver_exited`. A run that had already ended
2485 // Blocked / Failed / Stalled, or was parked in Landing (which hands its
2486 // daemon slot back), stopped walking the graph, but its recorded
2487 // pid may belong to a daemon still alive doing other work, which would pin
2488 // it as running for good; those are marked exited. Any other status keeps
2489 // `false`, and its pid is asked as before. This is an inference from
2490 // status, sound because a schema-11 record was written by a build that is
2491 // gone once this one is installed (and a daemon claim, which wins
2492 // regardless, still protects a run a live daemon is driving).
2493 if state.schema == 11 {
2494 if matches!(
2495 state.status,
2496 RunStatus::Blocked | RunStatus::Failed | RunStatus::Stalled | RunStatus::Landing
2497 ) {
2498 state.driver_exited = true;
2499 }
2500 state.schema = 12;
2501 }
2502 // Schema 12 predates `origin`. Nothing is reconstructed: `None` already
2503 // says "unknown", which is the truth for a run nobody recorded. Only the
2504 // version number advances.
2505 if state.schema == 12 {
2506 state.schema = SCHEMA;
2507 }
2508 if state.schema != SCHEMA {
2509 bail!(
2510 "run {} was written by a different magi (schema {}, this build \
2511 speaks {SCHEMA})",
2512 state.id,
2513 state.schema
2514 );
2515 }
2516 Ok(state)
2517}
2518
2519impl RunState {
2520 /// Whether a later attempt took this run's worktree over, so a resume has
2521 /// nothing left to continue from.
2522 pub fn released(&self) -> bool {
2523 self.released_to.is_some()
2524 }
2525
2526 /// The winning candidate, once the tally has run.
2527 pub fn winner(&self) -> Option<&Candidate> {
2528 let label = self.tally.as_ref()?.winner;
2529 self.candidates.iter().find(|c| c.label == label)
2530 }
2531
2532 /// Candidates eligible for judging.
2533 pub fn viable(&self) -> Vec<&Candidate> {
2534 self.candidates.iter().filter(|c| c.viable()).collect()
2535 }
2536
2537 /// Did every candidate write nothing, and every one of them back it with
2538 /// evidence [`crate::graph`]'s adoption guard accepted?
2539 ///
2540 /// All-or-nothing on purpose: one candidate declaring `NO CHANGE NEEDED`
2541 /// while another simply failed to produce anything is not agreement, it
2542 /// is one candidate's unverified claim next to an ordinary loss, and the
2543 /// run must still read as the `Failed` it is. Only ever meaningful when
2544 /// [`Self::viable`] is already empty — a run with any real patch to judge
2545 /// never reaches the caller that asks this.
2546 pub fn all_candidates_verified_noop(&self) -> bool {
2547 !self.candidates.is_empty()
2548 && self
2549 .candidates
2550 .iter()
2551 .all(|c| c.empty && c.verified_noop.is_some())
2552 }
2553
2554 /// Findings still open when the review loop stopped trying: the last
2555 /// round's, exactly when that round was not clean. Empty on a run that
2556 /// never reviewed, or whose last round was clean.
2557 ///
2558 /// This is the last round's findings regardless of what the fixer claims
2559 /// to have addressed in that same round: a round that stopped the loop
2560 /// (round budget spent, or no tree progress for
2561 /// [`crate::graph::STAGNANT_LIMIT`] rounds) never had a *following* round
2562 /// to confirm the fix actually landed, and the self-reported adoption
2563 /// count is not trusted for that judgement either — see
2564 /// [`ReviewRound::progressed`].
2565 pub fn open_findings(&self) -> Vec<&Finding> {
2566 match self.reviews.last() {
2567 Some(r) if !r.clean => r
2568 .reviews
2569 .iter()
2570 .flat_map(|rec| rec.findings.iter())
2571 .collect(),
2572 _ => Vec::new(),
2573 }
2574 }
2575
2576 /// Every finding raised in the most recent review round, regardless of
2577 /// that round's own severity mix — unlike [`Self::open_findings`], not
2578 /// filtered to a round that was not clean. This is the pool `magi fix`
2579 /// reports as available to pick from: a round can conclude clean (no
2580 /// finding blocked merge) while still carrying minor findings nobody
2581 /// has acted on.
2582 pub fn last_round_findings(&self) -> Vec<&Finding> {
2583 self.reviews
2584 .last()
2585 .into_iter()
2586 .flat_map(|r| r.reviews.iter())
2587 .flat_map(|rec| rec.findings.iter())
2588 .collect()
2589 }
2590
2591 /// Look up a finding by id anywhere in this run's review history,
2592 /// together with the round and reviewer record that raised it — the
2593 /// provenance `magi fix` snapshots onto [`OperatorFixFinding`].
2594 pub fn finding(&self, id: &str) -> Option<(&ReviewRound, &ReviewRecord, &Finding)> {
2595 self.reviews.iter().find_map(|round| {
2596 round.reviews.iter().find_map(|rec| {
2597 rec.findings
2598 .iter()
2599 .find(|f| f.id == id)
2600 .map(|f| (round, rec, f))
2601 })
2602 })
2603 }
2604
2605 /// Did this run reach a mergeable status (`Ready` or `Merged`) with
2606 /// review findings still open?
2607 ///
2608 /// That combination is the point of the review hand-off: the review
2609 /// round budget (or an unproductive round, see [`ReviewRound::progressed`])
2610 /// was spent while gate and e2e stayed green, so the run was handed off
2611 /// rather than blocked — but the findings did not disappear, and whoever
2612 /// reads the result should be told they are still there.
2613 pub fn handed_off_with_open_findings(&self) -> bool {
2614 matches!(self.status, RunStatus::Ready | RunStatus::Merged)
2615 && self.reviews.last().is_some_and(|r| !r.clean)
2616 }
2617
2618 /// Reached `Ready` because `[merge] mode = "none"` left it there by
2619 /// design, never to be picked up by the PR-polling merge watcher — as
2620 /// opposed to a `Ready` that is still a plausible landing candidate (a
2621 /// PR closed without merging, or a re-entry onto an already-concluded
2622 /// node). Both leave `status` at `Ready`; only this one leaves the
2623 /// winning branch permanently unwatched, which is what a caller needs to
2624 /// know before labelling the run in a listing.
2625 pub fn unmerged_by_design(&self) -> bool {
2626 self.status == RunStatus::Ready
2627 && self
2628 .merge
2629 .as_ref()
2630 .is_some_and(|m| m.mode == MergeMode::None)
2631 }
2632
2633 /// Did a step after the merge leave something only a human can finish?
2634 ///
2635 /// Derived, not a status: the merge happened, so `status` stays `Merged`
2636 /// and everything that branches on it keeps working. Display code asks
2637 /// this so a merged run with an unmerged release PR does not read as
2638 /// plain green.
2639 pub fn needs_attention(&self) -> bool {
2640 self.status == RunStatus::Merged
2641 && self
2642 .release_bump
2643 .as_ref()
2644 .is_some_and(|b| b.action_required.is_some())
2645 }
2646
2647 /// Local-time creation stamp for reports.
2648 pub fn created_local(&self) -> String {
2649 self.created_at
2650 .to_zoned(jiff::tz::TimeZone::system())
2651 .strftime("%Y-%m-%d %H:%M:%S")
2652 .to_string()
2653 }
2654
2655 /// Assert that this run is safe to delete.
2656 ///
2657 /// Refuses a run a live daemon is working on, and refuses any run whose
2658 /// candidate worktrees and branches have not been folded away with `magi
2659 /// fold`. The fold requirement is the real protection: it is what makes
2660 /// "delete" mean "remove a record" rather than "throw away a worktree
2661 /// somebody may still be editing".
2662 ///
2663 /// `in_flight` has to come from the caller, because a run's own status
2664 /// cannot answer the question. A daemon killed mid-run leaves its status at
2665 /// `implementing` forever, and a guard that trusted that would make every
2666 /// interrupted run permanently undeletable - the operator's only recourse
2667 /// being to edit `run.json` by hand, which is exactly the sort of thing
2668 /// this command exists to avoid. The queue already treats an orphaned
2669 /// `.lock` from a `SIGKILL`ed daemon the same way; this is that rule for
2670 /// runs.
2671 pub fn ensure_can_delete(&self, in_flight: bool) -> Result<()> {
2672 if in_flight {
2673 bail!(
2674 "run {} is being worked on by a live daemon right now",
2675 self.short()
2676 );
2677 }
2678 if self.candidates.iter().any(|c| !c.folded) {
2679 bail!(
2680 "run {} has unfolded candidates; fold first with `magi fold`",
2681 self.short()
2682 );
2683 }
2684 Ok(())
2685 }
2686}
2687
2688/// The short form of a commit, for a label a human or an LLM reads.
2689fn short(commit: &str) -> String {
2690 commit.chars().take(7).collect()
2691}
2692
2693/// The short form of a run id: the trailing block after the last `-`.
2694///
2695/// A free function as well as [`RunState::short`], because callers that have
2696/// only an id - an error message, a daemon status, a route handler - were
2697/// otherwise reimplementing the split, and two spellings of "short id" is one
2698/// rename away from branch names that no longer match their run.
2699pub fn short_of(id: &str) -> &str {
2700 id.split('-').next_back().unwrap_or(id)
2701}
2702
2703/// Where magi keeps its runs.
2704///
2705/// `MAGI_HOME` overrides the default, and [`set_home`] overrides both — which
2706/// is what lets the integration tests drive a whole graph without writing into
2707/// the operator's real history.
2708///
2709/// In a unit test build (`cfg(test)`), falling through to the real
2710/// `<data_local>/magi` is not a fallback worth having: it is exactly how
2711/// three broken fixture runs ended up in the operator's actual history and
2712/// were counted as `unreadable` by the deck. A test that reaches this point
2713/// forgot to call [`set_home`] (or set `MAGI_HOME`) - that is a bug in the
2714/// test, not a case to serve, so it panics instead of writing anywhere.
2715pub fn home() -> PathBuf {
2716 resolve_home(HOME.get().cloned(), std::env::var_os("MAGI_HOME"))
2717}
2718
2719/// The decision `home` makes, taking its two overrides as plain values
2720/// instead of reading the `OnceLock` and the environment itself.
2721///
2722/// Pulled out so the `cfg(test)` panic is asserted directly against a
2723/// `None, None` input, rather than racing every other unit test in the
2724/// binary for who touches the process-global `HOME` first.
2725fn resolve_home(pinned: Option<PathBuf>, magi_home_env: Option<std::ffi::OsString>) -> PathBuf {
2726 if let Some(dir) = pinned {
2727 return dir;
2728 }
2729 if let Some(dir) = magi_home_env {
2730 return PathBuf::from(dir);
2731 }
2732 #[cfg(test)]
2733 {
2734 panic!(
2735 "run::home() was reached in a test without run::set_home() or \
2736 MAGI_HOME; this would write into the operator's real \
2737 <data_local>/magi. Call `run::set_home(temp_dir)` before any \
2738 code path that touches a RunState."
2739 );
2740 }
2741 #[cfg(not(test))]
2742 {
2743 dirs::data_local_dir()
2744 .unwrap_or_else(|| PathBuf::from("."))
2745 .join("magi")
2746 }
2747}
2748
2749/// [`home`] without the test panic: `None` in a test that never pinned a
2750/// home, so best-effort writers (see [`crate::notices::raise`]) skip the write
2751/// instead of touching the operator's real state or aborting the test.
2752pub fn try_home() -> Option<PathBuf> {
2753 if cfg!(test) {
2754 HOME.get()
2755 .cloned()
2756 .or_else(|| std::env::var_os("MAGI_HOME").map(PathBuf::from))
2757 } else {
2758 Some(home())
2759 }
2760}
2761
2762/// Pin the run home for this process. The first call wins.
2763pub fn set_home(dir: PathBuf) {
2764 let _ = HOME.set(dir);
2765}
2766
2767/// A temp directory unique to this test process, created once and kept.
2768/// `set_home` is a first-wins `OnceLock`, so a fixed `temp_dir().join(..)`
2769/// would be shared by every concurrent `cargo test` process on the machine.
2770#[cfg(test)]
2771pub(crate) fn test_home() -> PathBuf {
2772 static DIR: std::sync::OnceLock<PathBuf> = std::sync::OnceLock::new();
2773 DIR.get_or_init(|| {
2774 tempfile::Builder::new()
2775 .prefix("magi-unit-home-")
2776 .tempdir()
2777 .expect("create the unit-test home")
2778 .keep()
2779 })
2780 .clone()
2781}
2782
2783/// [`set_home`] on [`test_home`]; the one way a unit test pins the home.
2784#[cfg(test)]
2785pub(crate) fn pin_test_home() {
2786 set_home(test_home());
2787}
2788
2789static HOME: std::sync::OnceLock<PathBuf> = std::sync::OnceLock::new();
2790
2791/// `<home>/runs`.
2792pub fn runs_root() -> PathBuf {
2793 home().join("runs")
2794}
2795
2796/// The worktree root a run uses when the config sets none: `~/wt/magi`.
2797///
2798/// One definition of the default, so the folder the janitor folds and the
2799/// folder the health view sizes cannot drift apart: a run with no configured
2800/// [`crate::config::Graph::worktree_root`] lays its worktrees exactly here.
2801pub fn default_worktree_root() -> PathBuf {
2802 dirs::home_dir()
2803 .unwrap_or_else(|| PathBuf::from("."))
2804 .join("wt")
2805 .join("magi")
2806}
2807
2808/// Directory for one run id.
2809pub fn run_dir(id: &str) -> PathBuf {
2810 runs_root().join(id)
2811}
2812
2813/// Every run id on disk, newest first.
2814///
2815/// A directory is a run because of its **name**, not because it holds a
2816/// readable `run.json`. A run whose very first save lost the machine's last
2817/// free bytes leaves `<id>/run.json.tmp` and nothing else, and filtering on
2818/// `run.json` made that run invisible everywhere: not in `magi list`, not in
2819/// `runs_unreadable`, not on the phone, so nothing could report it and no
2820/// route could clear it. `88c0` sat like that for two days. Unreadable is
2821/// counted, never hidden - the readers already say why each one cannot be
2822/// read, and `fold_unreadable` is how a record like this leaves.
2823pub fn list_ids() -> Vec<String> {
2824 list_ids_in(&runs_root())
2825}
2826
2827/// [`list_ids`] against an explicit runs root, for callers (and tests) that
2828/// must not depend on the process-global home.
2829pub fn list_ids_in(root: &Path) -> Vec<String> {
2830 let mut ids: Vec<String> = std::fs::read_dir(root)
2831 .into_iter()
2832 .flatten()
2833 .flatten()
2834 .filter(|e| e.path().is_dir())
2835 .map(|e| e.file_name().to_string_lossy().into_owned())
2836 .filter(|name| is_run_id(name))
2837 .collect();
2838 // Ids start with a sortable timestamp.
2839 ids.sort_unstable_by(|a, b| b.cmp(a));
2840 ids
2841}
2842
2843/// Does `name` have the shape [`new_id`] mints: `YYYYMMDD-HHMMSS-xxxx`?
2844///
2845/// The test for "this directory is a run", so a stray folder under
2846/// `<home>/runs` is not reported as a broken run.
2847///
2848/// The tag is checked for length and for being alphanumeric, not for being
2849/// hex: real ids are hex, but fixtures across this crate name runs
2850/// `...-dead` / `...-gone` / `...-once`, and a predicate that disowned those
2851/// would be asserting the fixtures' spelling rather than the shape.
2852pub fn is_run_id(name: &str) -> bool {
2853 let mut parts = name.split('-');
2854 let (Some(day), Some(time), Some(tag), None) =
2855 (parts.next(), parts.next(), parts.next(), parts.next())
2856 else {
2857 return false;
2858 };
2859 day.len() == 8
2860 && day.bytes().all(|b| b.is_ascii_digit())
2861 && time.len() == 6
2862 && time.bytes().all(|b| b.is_ascii_digit())
2863 && tag.len() == 4
2864 && tag.bytes().all(|b| b.is_ascii_alphanumeric())
2865}
2866
2867/// Expand an id prefix to exactly one run id.
2868pub fn resolve_id(prefix: &str) -> Result<String> {
2869 // A whole id names its directory, readable state or not: the run whose
2870 // `run.json` never landed still has to be reachable by `magi show` and
2871 // by the fold route, which is the only way its record ever leaves.
2872 if is_run_id(prefix) && run_dir(prefix).is_dir() {
2873 return Ok(prefix.to_owned());
2874 }
2875 let hits: Vec<String> = list_ids()
2876 .into_iter()
2877 .filter(|id| id.starts_with(prefix) || id.ends_with(prefix))
2878 .collect();
2879 match hits.len() {
2880 1 => Ok(hits.into_iter().next().expect("exactly one hit")),
2881 0 => bail!("no run matches `{prefix}`"),
2882 _ => bail!(
2883 "`{prefix}` matches {} runs: {}",
2884 hits.len(),
2885 hits.join(", ")
2886 ),
2887 }
2888}
2889
2890/// The most recent run, if any.
2891pub fn latest_id() -> Option<String> {
2892 list_ids().into_iter().next()
2893}
2894
2895/// `YYYYMMDD-HHMMSS-xxxx`, sortable and short enough for a branch name.
2896///
2897/// The four hex digits are fresh entropy, **not** `blind.seed`. They were the
2898/// seed, and a pinned seed then made the whole id a function of the second it
2899/// started in: two runs a second apart were distinguishable, two in the same
2900/// second were not. Everything keyed on the id collided with them - the run
2901/// directory, `artifacts/`, and the candidate worktrees under
2902/// `wt/magi/<short>/`.
2903///
2904/// `tests/common` pins the seed on purpose, so its integration tests all share
2905/// one suffix. On Windows the suite is slow enough that the seconds differ and
2906/// nothing showed; on Linux `graph_dropped_stream`'s three tests run inside
2907/// 16s, so two of them shared a run directory and the second read an artifact
2908/// the first had written (`impl-B-resume.out`) - a failure that looked like the
2909/// resume logic misbehaving and was really two runs in one directory.
2910///
2911/// A seed exists to make the *blind* decisions reproducible: label assignment
2912/// and per-judge presentation order. It was never meant to name the run, and
2913/// `RunState::seed` still carries it for what it is for.
2914fn new_id() -> String {
2915 let stamp = Zoned::now().strftime("%Y%m%d-%H%M%S");
2916 let entropy = crate::rng::entropy();
2917 format!("{stamp}-{:04x}", (entropy ^ (entropy >> 32)) & 0xffff)
2918}
2919
2920/// Keep the last `max` bytes of `text`, on a line boundary.
2921pub fn tail(text: &str, max: usize) -> String {
2922 if text.len() <= max {
2923 return text.to_owned();
2924 }
2925 let mut cut = text.len() - max;
2926 while cut < text.len() && !text.is_char_boundary(cut) {
2927 cut += 1;
2928 }
2929 let slice = &text[cut..];
2930 let start = slice.find('\n').map_or(0, |i| i + 1);
2931 format!(
2932 "[... {} earlier bytes omitted ...]\n{}",
2933 cut,
2934 &slice[start..]
2935 )
2936}
2937
2938/// Path of a run artifact.
2939pub fn artifact_path(run: &RunState, name: &str) -> PathBuf {
2940 run.dir().join("artifacts").join(name)
2941}
2942
2943/// Write an artifact, creating the directory if needed.
2944pub fn write_artifact(run: &RunState, name: &str, body: &str) -> Result<PathBuf> {
2945 let path = artifact_path(run, name);
2946 if let Some(parent) = path.parent() {
2947 std::fs::create_dir_all(parent).with_context(|| format!("create {}", parent.display()))?;
2948 }
2949 std::fs::write(&path, body).with_context(|| format!("write {}", path.display()))?;
2950 Ok(path)
2951}
2952
2953/// Read an artifact back, e.g. a stored patch on resume.
2954pub fn read_artifact(run: &RunState, name: &str) -> Option<String> {
2955 std::fs::read_to_string(artifact_path(run, name)).ok()
2956}
2957
2958#[cfg(test)]
2959mod tests {
2960 use crate::proc::Quiet as _;
2961
2962 #[test]
2963 fn test_home_is_private_stable_and_unique_per_process() {
2964 // Child mode: report this process's home and stop.
2965 if std::env::var_os("MAGI_HOME_PROBE").is_some() {
2966 println!("HOME={}", super::test_home().display());
2967 return;
2968 }
2969 let a = super::test_home();
2970 assert_eq!(a, super::test_home());
2971 assert!(a.is_dir() && a.starts_with(std::env::temp_dir()));
2972 let probe = || {
2973 let out = std::process::Command::new(std::env::current_exe().unwrap())
2974 .args([
2975 "--exact",
2976 "run::tests::test_home_is_private_stable_and_unique_per_process",
2977 "--nocapture",
2978 "--test-threads=1",
2979 ])
2980 .env("MAGI_HOME_PROBE", "1")
2981 .quiet()
2982 .output()
2983 .unwrap();
2984 String::from_utf8_lossy(&out.stdout)
2985 .lines()
2986 .find_map(|l| l.split_once("HOME=").map(|(_, h)| h.to_owned()))
2987 .expect("child reported a home")
2988 };
2989 let (b, c) = (probe(), probe());
2990 assert_ne!(b, c, "two processes must never share a unit-test home");
2991 assert_ne!(b, a.display().to_string());
2992 }
2993
2994 #[test]
2995 fn no_test_pins_a_fixed_temp_path_as_the_home() {
2996 let root = std::env::var_os("CARGO_MANIFEST_DIR")
2997 .map(PathBuf::from)
2998 .unwrap_or_else(|| PathBuf::from(env!("CARGO_MANIFEST_DIR")));
2999 let needle = ["set_home(std::env::temp_dir()", ".join(\"magi-"].concat();
3000 for e in std::fs::read_dir(root.join("src")).unwrap() {
3001 let p = e.unwrap().path();
3002 if p.extension().and_then(|x| x.to_str()) != Some("rs") {
3003 continue;
3004 }
3005 let text = std::fs::read_to_string(&p).unwrap();
3006 assert!(
3007 !text.contains(&needle),
3008 "{} pins a fixed temp home; use run::pin_test_home()",
3009 p.display()
3010 );
3011 }
3012 }
3013
3014 use super::*;
3015
3016 fn state() -> RunState {
3017 RunState::new(
3018 PathBuf::from("/repo"),
3019 "main".to_owned(),
3020 "abc1234def".to_owned(),
3021 "add retries".to_owned(),
3022 Config::default(),
3023 )
3024 }
3025
3026 #[test]
3027 fn superseded_is_terminal_but_not_resumable() {
3028 assert!(RunStatus::Superseded.done());
3029 assert!(!RunStatus::Superseded.resumable());
3030 assert_eq!(RunStatus::Superseded.as_str(), "superseded");
3031 assert!(RunStatus::AlreadyInBase.done());
3032 assert!(!RunStatus::AlreadyInBase.resumable());
3033 assert_eq!(RunStatus::AlreadyInBase.as_str(), "already_in_base");
3034 }
3035
3036 #[test]
3037 fn load_under_reads_back_exactly_what_save_under_wrote_at_an_explicit_home() {
3038 // Both rooted at an explicit `home` rather than the process-global
3039 // one - a caller with its own `home` (a test fixture, a housekeeping
3040 // pass) must round-trip through exactly that directory, never
3041 // through whichever home some other test in the same binary pinned
3042 // into the global `OnceLock` first.
3043 let dir = tempfile::tempdir().unwrap();
3044 let mut original = state();
3045 original.id = "20260101-000000-load".to_owned();
3046 original.status = RunStatus::Blocked;
3047 original.save_under(dir.path()).unwrap();
3048
3049 let reloaded = RunState::load_under(&original.id, dir.path()).unwrap();
3050 assert_eq!(reloaded.id, original.id);
3051 assert_eq!(reloaded.status, RunStatus::Blocked);
3052
3053 assert!(
3054 RunState::load_under("20260101-000000-none", dir.path()).is_err(),
3055 "an id with nothing saved under this home must not silently read something else"
3056 );
3057 }
3058
3059 #[test]
3060 fn resolve_home_prefers_the_pin_then_the_env_var() {
3061 let pinned = PathBuf::from("/pinned");
3062 assert_eq!(
3063 resolve_home(Some(pinned.clone()), Some("/env".into())),
3064 pinned,
3065 "a pin wins even over MAGI_HOME"
3066 );
3067 assert_eq!(
3068 resolve_home(None, Some("/env".into())),
3069 PathBuf::from("/env")
3070 );
3071 }
3072
3073 #[test]
3074 #[should_panic(expected = "run::set_home()")]
3075 fn resolve_home_refuses_to_fall_back_to_the_operators_real_home() {
3076 // Neither override present is exactly the state a test reaches by
3077 // forgetting `set_home`/`MAGI_HOME` - the accident that put three
3078 // broken fixture runs into the operator's real history. Asserted
3079 // against the pure decision directly, not `home()` itself, because
3080 // `HOME` is a process-wide `OnceLock` another test may have already
3081 // set - this must not depend on test execution order.
3082 resolve_home(None, None);
3083 }
3084
3085 #[test]
3086 fn a_run_is_named_by_shape_so_a_state_less_directory_is_still_a_run() {
3087 // The shape `new_id` mints. A directory answering to it is a run even
3088 // with no readable `run.json`: that is how a save that ran out of
3089 // disk stays visible instead of vanishing from every listing.
3090 assert!(is_run_id(&new_id()));
3091 assert!(is_run_id("20260904-014540-88c0"));
3092 // Not runs: a stray folder, a truncated id, a non-hex tag, and an id
3093 // with an extra segment (a worktree label, say).
3094 assert!(!is_run_id("scratch"));
3095 assert!(!is_run_id("20260904-014540"));
3096 assert!(!is_run_id("20260904-014540-88c0f"));
3097 assert!(!is_run_id("2026090x-014540-88c0"));
3098 assert!(!is_run_id("20260904-014540-88c0-A"));
3099 }
3100
3101 #[test]
3102 fn ids_are_sortable_and_short_suffixed() {
3103 let s = state();
3104 let parts: Vec<&str> = s.id.split('-').collect();
3105 assert_eq!(parts.len(), 3);
3106 assert_eq!(parts[0].len(), 8);
3107 assert_eq!(parts[1].len(), 6);
3108 assert_eq!(parts[2].len(), 4);
3109 assert_eq!(s.short(), parts[2]);
3110 }
3111
3112 #[test]
3113 fn branch_names_carry_the_label_not_the_author() {
3114 let s = state();
3115 let b = s.branch_for('B');
3116 assert_eq!(b, format!("magi/{}/B", s.short()));
3117 assert!(!b.contains("claude"));
3118 }
3119
3120 /// A pinned seed reproduces the blind decisions. It must **not** reproduce
3121 /// the run's identity.
3122 ///
3123 /// `assert_eq!(a.short(), b.short())` used to stand where the last
3124 /// assertion is now, and it was pinning the defect: with the id's suffix
3125 /// derived from the seed, two runs started in the same second were the
3126 /// same run as far as the filesystem was concerned - one directory, one
3127 /// `artifacts/`, one set of candidate worktrees. `tests/common` pins a
3128 /// seed for every integration test, so on Linux, where the suite is fast,
3129 /// two tests in `graph_dropped_stream` shared a directory and one read the
3130 /// other's artifact.
3131 #[test]
3132 fn a_pinned_seed_is_reproducible_but_never_the_run_id() {
3133 let mut cfg = Config::default();
3134 cfg.blind.seed = Some(1234);
3135 let a = RunState::new(
3136 PathBuf::from("/r"),
3137 "main".to_owned(),
3138 "c".to_owned(),
3139 "t".to_owned(),
3140 cfg.clone(),
3141 );
3142 let b = RunState::new(
3143 PathBuf::from("/r"),
3144 "main".to_owned(),
3145 "c".to_owned(),
3146 "t".to_owned(),
3147 cfg,
3148 );
3149 // What the seed is for: the same shuffles, run after run.
3150 assert_eq!(a.seed, 1234);
3151 assert_eq!(a.seed, b.seed);
3152 // What it is not for. Two runs are two runs, in the same second or
3153 // not, and everything keyed on the id depends on that.
3154 assert_ne!(
3155 a.id, b.id,
3156 "two runs sharing an id share a directory, artifacts and worktrees"
3157 );
3158 }
3159
3160 #[test]
3161 fn status_terminality() {
3162 assert!(RunStatus::Merged.done());
3163 assert!(RunStatus::Blocked.done());
3164 assert!(!RunStatus::Reviewing.done());
3165 }
3166
3167 fn overrun_seat(now: Timestamp, elapsed_secs: i64, timeout_secs: u64) -> ActiveSeat {
3168 ActiveSeat {
3169 node: "implement".to_owned(),
3170 started_at: now - jiff::SignedDuration::new(elapsed_secs, 0),
3171 timeout_secs,
3172 attempt: 0,
3173 task: None,
3174 command: None,
3175 index: None,
3176 total: None,
3177 }
3178 }
3179
3180 #[test]
3181 fn active_all_overrun_requires_every_seat_past_its_own_timeout() {
3182 let mut s = state();
3183 let now = Timestamp::now();
3184 assert!(
3185 !s.active_all_overrun(now),
3186 "nothing active is not evidence of anything"
3187 );
3188
3189 s.active
3190 .insert("impl-A".to_owned(), overrun_seat(now, 21_000, 3_600));
3191 assert!(
3192 s.active_all_overrun(now),
3193 "21000s elapsed against a 3600s budget"
3194 );
3195
3196 // A seat still well within its own budget means the run is not
3197 // provably dead, however far its sibling has overrun.
3198 s.active
3199 .insert("impl-B".to_owned(), overrun_seat(now, 0, 3_600));
3200 assert!(!s.active_all_overrun(now));
3201 }
3202
3203 /// A schema-11 run that ended Blocked cannot be pinned by a daemon pid
3204 /// that is still alive; one still mid-walk keeps asking the pid.
3205 #[test]
3206 fn migrating_schema_11_marks_only_ended_runs_as_exited() {
3207 for (status, exited) in [
3208 (RunStatus::Blocked, true),
3209 (RunStatus::Failed, true),
3210 (RunStatus::Stalled, true),
3211 (RunStatus::Landing, true),
3212 (RunStatus::Reviewing, false),
3213 ] {
3214 let mut s = state();
3215 s.schema = 11;
3216 s.status = status;
3217 let m = migrate_schema(s).unwrap();
3218 assert_eq!(m.schema, SCHEMA);
3219 assert_eq!(m.driver_exited, exited, "{status:?}");
3220 }
3221 }
3222
3223 /// A driver that recorded its own exit reads dead without its pid being
3224 /// asked: a daemon's pid outlives the runs it drove.
3225 #[test]
3226 fn an_exited_driver_is_dead_even_when_its_pid_answers_alive() {
3227 let mut s = state();
3228 s.driver_pid = Some(4242);
3229 s.driver_started_at = Some("1790000000".to_owned());
3230 s.driver_exited = true;
3231 let never = |_| -> Option<bool> { panic!("the pid must not be asked") };
3232 assert_eq!(
3233 s.liveness_with(false, never, |_| panic!("nor its identity")),
3234 Liveness::Dead
3235 );
3236 assert_eq!(s.liveness_with(true, never, |_| None), Liveness::Live);
3237 }
3238
3239 /// A daemon claim wins outright, whatever `driver_pid` or either query
3240 /// says — the stronger, independently-heartbeating signal. Neither query
3241 /// closure is even called: a daemon claim short-circuits before either
3242 /// one, which panicking closures here prove.
3243 #[test]
3244 fn liveness_reads_live_from_a_daemon_claim_alone() {
3245 let mut s = state();
3246 s.driver_pid = None;
3247 assert_eq!(
3248 s.liveness_with(
3249 true,
3250 |_| panic!("a daemon claim needs no pid query"),
3251 |_| panic!("a daemon claim needs no identity query")
3252 ),
3253 Liveness::Live,
3254 "a daemon claim needs no pid to back it up"
3255 );
3256 }
3257
3258 /// The gap `driver_pid` closes: no daemon claim (every manual `magi run`
3259 /// / `magi review`), but the recorded pid answers alive *and* the
3260 /// process currently holding it still carries the same start-time
3261 /// marker this run recorded — proof it is genuinely the same process,
3262 /// not merely the same number.
3263 #[test]
3264 fn liveness_reads_live_from_a_confirmed_pid_with_a_matching_identity() {
3265 let mut s = state();
3266 s.driver_pid = Some(4242);
3267 s.driver_started_at = Some("1790000000".to_owned());
3268 assert_eq!(
3269 s.liveness_with(
3270 false,
3271 |pid| {
3272 assert_eq!(pid, 4242);
3273 Some(true)
3274 },
3275 |pid| {
3276 assert_eq!(pid, 4242);
3277 Some("1790000000".to_owned())
3278 }
3279 ),
3280 Liveness::Live
3281 );
3282 }
3283
3284 /// No daemon claim and the recorded pid confirmed gone by the OS itself
3285 /// — dead outright, and the identity query is never even reached (a
3286 /// panicking closure proves it), since there is nothing left to
3287 /// corroborate.
3288 #[test]
3289 fn liveness_reads_dead_from_a_confirmed_dead_pid() {
3290 let mut s = state();
3291 s.driver_pid = Some(4242);
3292 assert_eq!(
3293 s.liveness_with(
3294 false,
3295 |_| Some(false),
3296 |_| panic!("a confirmed-dead pid needs no identity query")
3297 ),
3298 Liveness::Dead
3299 );
3300 }
3301
3302 /// The gap this task's review round exists to close: a killed manual
3303 /// run's pid gets handed to a wholly unrelated later process. `pid_status`
3304 /// alone would read that as `Live` — the reused pid really is alive —
3305 /// but the process now holding it started at a different moment than the
3306 /// one this run recorded, so this must read `Dead`, not `Live`: a
3307 /// mismatch is exactly as good as proof the original driver is gone.
3308 #[test]
3309 fn liveness_reads_dead_when_a_live_pid_no_longer_matches_the_recorded_start_time() {
3310 let mut s = state();
3311 s.driver_pid = Some(4242);
3312 s.driver_started_at = Some("1790000000".to_owned());
3313 assert_eq!(
3314 s.liveness_with(false, |_| Some(true), |_| Some("1790005400".to_owned())),
3315 Liveness::Dead,
3316 "the pid is alive, but under a different process than the one this run recorded"
3317 );
3318 }
3319
3320 /// Missing information never collapses to `Dead`: an old run with no
3321 /// `driver_pid` at all, a `driver_pid` this build could not query, a live
3322 /// pid with no recorded start time to compare (an even older run, before
3323 /// that field existed), and a live pid whose current identity this build
3324 /// could not re-query, all read as `Unknown` — never a guess in either
3325 /// direction.
3326 #[test]
3327 fn a_locale_format_marker_on_a_live_pid_reads_unknown_never_dead() {
3328 let mut s = state();
3329 s.driver_pid = Some(4242);
3330 for old in ["日 10/ 4 17:27:03 2026", "Sun Oct 4 17:27:03 2026"] {
3331 s.driver_started_at = Some(old.to_owned());
3332 assert_eq!(
3333 s.liveness_with(
3334 false,
3335 |_| Some(true),
3336 |_| panic!("an old-format marker needs no identity query")
3337 ),
3338 Liveness::Unknown,
3339 "{old}"
3340 );
3341 }
3342 }
3343
3344 #[test]
3345 fn integer_markers_compare_live_on_match_and_dead_on_difference() {
3346 let mut s = state();
3347 s.driver_pid = Some(4242);
3348 s.driver_started_at = Some("1790000000".to_owned());
3349 assert_eq!(
3350 s.liveness_with(false, |_| Some(true), |_| Some("1790000000".to_owned())),
3351 Liveness::Live
3352 );
3353 assert_eq!(
3354 s.liveness_with(false, |_| Some(true), |_| Some("1790000001".to_owned())),
3355 Liveness::Dead
3356 );
3357 }
3358
3359 #[test]
3360 fn liveness_never_guesses_out_of_missing_information() {
3361 let mut s = state();
3362 s.driver_pid = None;
3363 assert_eq!(
3364 s.liveness_with(
3365 false,
3366 |_| panic!("no pid to query"),
3367 |_| panic!("no pid to query")
3368 ),
3369 Liveness::Unknown,
3370 "no driver_pid recorded at all — an old run predating this field"
3371 );
3372
3373 s.driver_pid = Some(4242);
3374 assert_eq!(
3375 s.liveness_with(false, |_| None, |_| panic!("inconclusive already")),
3376 Liveness::Unknown,
3377 "a pid to ask, but the platform could not answer for it"
3378 );
3379
3380 s.driver_started_at = None;
3381 assert_eq!(
3382 s.liveness_with(false, |_| Some(true), |_| Some("anything".to_owned())),
3383 Liveness::Unknown,
3384 "a live pid, but no recorded marker to corroborate it against — an old run \
3385 predating `driver_started_at`"
3386 );
3387
3388 s.driver_started_at = Some("1790000000".to_owned());
3389 assert_eq!(
3390 s.liveness_with(false, |_| Some(true), |_| None),
3391 Liveness::Unknown,
3392 "a live pid and a recorded marker, but the identity re-query itself failed"
3393 );
3394 }
3395
3396 #[test]
3397 fn abandon_clears_active_and_fails_a_non_terminal_run() {
3398 let mut s = state();
3399 s.status = RunStatus::Implementing;
3400 let now = Timestamp::now();
3401 s.active
3402 .insert("impl-A".to_owned(), overrun_seat(now, 21_000, 3_600));
3403
3404 s.abandon("daemon");
3405
3406 assert!(s.active.is_empty());
3407 assert_eq!(s.status, RunStatus::Failed);
3408 assert!(
3409 s.events
3410 .last()
3411 .expect("an event was logged")
3412 .message
3413 .contains("impl-A"),
3414 "the event names the abandoned seat"
3415 );
3416 }
3417
3418 #[test]
3419 fn abandon_never_overwrites_a_status_already_terminal() {
3420 let mut s = state();
3421 s.status = RunStatus::Ready;
3422 let now = Timestamp::now();
3423 s.active
3424 .insert("impl-A".to_owned(), overrun_seat(now, 21_000, 3_600));
3425
3426 s.abandon("daemon");
3427
3428 assert!(s.active.is_empty());
3429 assert_eq!(
3430 s.status,
3431 RunStatus::Ready,
3432 "a run already done must not be relabelled Failed"
3433 );
3434 }
3435
3436 #[test]
3437 fn candidate_viability_excludes_empty_and_failed() {
3438 let mut c = Candidate {
3439 index: 0,
3440 label: 'A',
3441 agent: "a".to_owned(),
3442 branch: "b".to_owned(),
3443 worktree: PathBuf::from("/w"),
3444 summary: String::new(),
3445 stat: String::new(),
3446 files: 1,
3447 commits: 1,
3448 empty: false,
3449 failed: None,
3450 verified_noop: None,
3451 duration_ms: 0,
3452 folded: false,
3453 };
3454 assert!(c.viable());
3455 c.empty = true;
3456 assert!(!c.viable());
3457 c.empty = false;
3458 c.failed = Some("timeout".to_owned());
3459 assert!(!c.viable());
3460 }
3461
3462 #[test]
3463 fn build_failure_is_distinguished_from_a_failing_test() {
3464 let link_race = CommandOutcome {
3465 command: "cargo test".to_owned(),
3466 code: Some(1),
3467 output_tail: "LINK : fatal error LNK1104: cannot open file \
3468 'graph_dirty_tree-71d4dc8e.exe'\n\
3469 error: could not compile `magi-cli` (test \"graph_dirty_tree\")"
3470 .to_owned(),
3471 duration_ms: 500,
3472 resource_blocked: false,
3473 };
3474 assert!(!link_race.ok());
3475 assert!(link_race.build_failed());
3476
3477 let failing_test = CommandOutcome {
3478 command: "cargo test".to_owned(),
3479 code: Some(101),
3480 output_tail: "thread 'it_works' panicked at 'assertion failed'".to_owned(),
3481 duration_ms: 500,
3482 resource_blocked: false,
3483 };
3484 assert!(!failing_test.ok());
3485 assert!(
3486 !failing_test.build_failed(),
3487 "a real test failure must not be classed as a build failure"
3488 );
3489
3490 let passing = CommandOutcome {
3491 command: "cargo test".to_owned(),
3492 code: Some(0),
3493 output_tail: String::new(),
3494 duration_ms: 500,
3495 resource_blocked: false,
3496 };
3497 assert!(passing.ok());
3498 assert!(!passing.build_failed());
3499 }
3500
3501 #[test]
3502 fn tail_keeps_the_end_on_a_line_boundary() {
3503 let text = (0..100).map(|i| format!("line {i}\n")).collect::<String>();
3504 let t = tail(&text, 40);
3505 assert!(t.starts_with("[..."));
3506 assert!(t.ends_with("line 99\n"));
3507 assert!(t.len() < 120);
3508 assert_eq!(tail("short", 40), "short");
3509 }
3510
3511 #[test]
3512 fn tail_survives_multibyte_cuts() {
3513 let text = "あ".repeat(50);
3514 let t = tail(&text, 10);
3515 assert!(t.contains("earlier bytes omitted"));
3516 assert!(t.ends_with('あ'));
3517 }
3518
3519 fn finding(id: &str, severity: crate::verdict::Severity) -> crate::verdict::Finding {
3520 crate::verdict::Finding {
3521 id: id.to_owned(),
3522 severity,
3523 file: None,
3524 line: None,
3525 title: "x".to_owned(),
3526 detail: String::new(),
3527 }
3528 }
3529
3530 fn round(clean: bool, findings: Vec<crate::verdict::Finding>) -> ReviewRound {
3531 ReviewRound {
3532 round: 1,
3533 head: "h".to_owned(),
3534 verified_head: None,
3535 verified_at: None,
3536 reviews: vec![ReviewRecord {
3537 attempts: 0,
3538 reviewer: 1,
3539 agent: "a".to_owned(),
3540 summary: String::new(),
3541 findings,
3542 vote: None,
3543 failed: None,
3544 duration_ms: 0,
3545 }],
3546 e2e: Vec::new(),
3547 verify_retried: false,
3548 e2e_deferred: false,
3549 e2e_defer_reason: None,
3550 fix: None,
3551 blocking: 0,
3552 answered: 1,
3553 expected: 1,
3554 clean,
3555 progressed: false,
3556 vote_split: false,
3557 reconsideration: Vec::new(),
3558 verdict: None,
3559 }
3560 }
3561
3562 fn voted(
3563 findings: Vec<crate::verdict::Finding>,
3564 votes: &[ReviewVote],
3565 revotes: &[Option<ReviewVote>],
3566 ) -> ReviewRound {
3567 let mut r = round(false, findings);
3568 r.reviews = votes
3569 .iter()
3570 .enumerate()
3571 .map(|(i, v)| {
3572 let mut rec = r.reviews[0].clone();
3573 rec.reviewer = i + 1;
3574 rec.vote = Some(*v);
3575 if i > 0 {
3576 rec.findings = Vec::new();
3577 }
3578 rec
3579 })
3580 .collect();
3581 r.reconsideration = revotes
3582 .iter()
3583 .enumerate()
3584 .map(|(i, v)| ReviewRevoteRecord {
3585 reviewer: i + 1,
3586 agent: "a".to_owned(),
3587 vote: *v,
3588 reason: String::new(),
3589 failed: None,
3590 })
3591 .collect();
3592 r
3593 }
3594
3595 #[test]
3596 fn a_hand_off_is_contested_only_by_a_blocking_finding_and_a_reject_vote() {
3597 use crate::verdict::Severity::{Major, Minor};
3598 use ReviewVote::{Approve, Reject};
3599 let major = || vec![finding("R1-1-1", Major)];
3600 let minor = || vec![finding("R1-1-1", Minor)];
3601
3602 let c = voted(major(), &[Reject, Approve], &[])
3603 .contested_handoff()
3604 .expect("major + reject");
3605 assert_eq!(c.findings.len(), 1);
3606 assert_eq!(c.rejecters, vec![(1, "a".to_owned())]);
3607
3608 assert!(
3609 voted(minor(), &[Reject, Approve], &[])
3610 .contested_handoff()
3611 .is_none()
3612 );
3613 assert!(
3614 voted(major(), &[Approve, Approve], &[])
3615 .contested_handoff()
3616 .is_none()
3617 );
3618 assert!(
3619 voted(Vec::new(), &[Reject], &[])
3620 .contested_handoff()
3621 .is_none()
3622 );
3623 }
3624
3625 #[test]
3626 fn a_reject_withdrawn_in_the_revote_does_not_contest_and_an_unanswered_one_stands() {
3627 use crate::verdict::Severity::Major;
3628 use ReviewVote::{Approve, Reject};
3629 let major = || vec![finding("R1-1-1", Major)];
3630
3631 let withdrawn = voted(major(), &[Reject, Approve], &[Some(Approve), Some(Approve)]);
3632 assert!(withdrawn.contested_handoff().is_none());
3633
3634 let unanswered = voted(major(), &[Reject, Approve], &[None, Some(Approve)]);
3635 assert!(
3636 unanswered.contested_handoff().is_some(),
3637 "no revote falls back to the initial reject"
3638 );
3639
3640 let raised = voted(major(), &[Approve, Approve], &[Some(Reject), Some(Approve)]);
3641 assert!(raised.contested_handoff().is_some());
3642 }
3643
3644 #[test]
3645 fn e2e_status_tells_deferred_apart_from_not_configured() {
3646 let mut r = round(false, Vec::new());
3647 assert_eq!(r.e2e_status(), E2eStatus::NotConfigured);
3648
3649 r.e2e_deferred = true;
3650 assert_eq!(
3651 r.e2e_status(),
3652 E2eStatus::Deferred,
3653 "an empty e2e must not read as unconfigured once it was deferred on purpose"
3654 );
3655
3656 r.e2e = vec![CommandOutcome {
3657 command: "test".to_owned(),
3658 code: Some(0),
3659 output_tail: String::new(),
3660 duration_ms: 0,
3661 resource_blocked: false,
3662 }];
3663 assert_eq!(
3664 r.e2e_status(),
3665 E2eStatus::Passed,
3666 "a round with real outcomes is never read as deferred, even if the flag is still set"
3667 );
3668 }
3669
3670 #[test]
3671 fn e2e_status_reports_a_real_failure_as_failed_not_deferred() {
3672 let mut r = round(false, Vec::new());
3673 r.e2e = vec![CommandOutcome {
3674 command: "test".to_owned(),
3675 code: Some(1),
3676 output_tail: "boom".to_owned(),
3677 duration_ms: 0,
3678 resource_blocked: false,
3679 }];
3680 assert_eq!(r.e2e_status(), E2eStatus::Failed);
3681 }
3682
3683 #[test]
3684 fn e2e_status_never_reads_a_resource_block_as_a_failure() {
3685 // The exact shape of contention on the shared build cache: `e2e`
3686 // holds one outcome, and it is `resource_blocked`, never a command
3687 // that actually ran and produced a red exit code.
3688 let mut r = round(false, Vec::new());
3689 r.e2e = vec![CommandOutcome {
3690 command: "(waiting for the shared build cache)".to_owned(),
3691 code: None,
3692 output_tail: "contended".to_owned(),
3693 duration_ms: 0,
3694 resource_blocked: true,
3695 }];
3696 assert_eq!(
3697 r.e2e_status(),
3698 E2eStatus::ResourceBlocked,
3699 "magi's own inability to get a command to run must not read as a verdict on the \
3700 patch"
3701 );
3702 }
3703
3704 #[test]
3705 fn verification_summary_is_silent_when_there_is_nothing_worth_saying() {
3706 let mut r = round(true, Vec::new());
3707 assert!(
3708 r.verification_summary("h").is_none(),
3709 "no verify.e2e configured: nothing to surface"
3710 );
3711 r.e2e = vec![CommandOutcome {
3712 command: "test".to_owned(),
3713 code: Some(0),
3714 output_tail: String::new(),
3715 duration_ms: 0,
3716 resource_blocked: false,
3717 }];
3718 assert!(
3719 r.verification_summary("h").is_none(),
3720 "a green result needs no skepticism attached to it"
3721 );
3722 }
3723
3724 #[test]
3725 fn verification_summary_tells_the_current_head_apart_from_an_earlier_one() {
3726 let mut r = round(false, Vec::new());
3727 r.head = "h1".to_owned();
3728 r.e2e = vec![CommandOutcome {
3729 command: "test".to_owned(),
3730 code: Some(1),
3731 output_tail: "boom".to_owned(),
3732 duration_ms: 0,
3733 resource_blocked: false,
3734 }];
3735 r.verified_head = Some("h1".to_owned());
3736 r.verified_at = Some(Timestamp::now());
3737
3738 let fresh = r.verification_summary("h1").expect("a failure is surfaced");
3739 assert!(
3740 fresh.label.contains("this is the head being looked at now"),
3741 "{}",
3742 fresh.label
3743 );
3744 assert_eq!(fresh.tail.as_deref(), Some("$ test\nboom\n"));
3745
3746 let stale = r.verification_summary("h2").expect("still surfaced");
3747 assert!(
3748 stale.label.contains("an earlier head, since superseded"),
3749 "a result about a different commit than the one being looked at now must say so, \
3750 not read as current: {}",
3751 stale.label
3752 );
3753 }
3754
3755 #[test]
3756 fn verification_summary_marks_a_resource_block_and_a_deferral_distinctly_from_a_failure() {
3757 let mut r = round(false, Vec::new());
3758 r.e2e = vec![CommandOutcome {
3759 command: "(waiting for the shared build cache)".to_owned(),
3760 code: None,
3761 output_tail: "contended".to_owned(),
3762 duration_ms: 0,
3763 resource_blocked: true,
3764 }];
3765 let blocked = r
3766 .verification_summary("h")
3767 .expect("a resource block is still surfaced, never silent");
3768 assert!(blocked.label.contains("could not run"));
3769 // No command actually ran, but which operation was attempted is
3770 // still a fact worth showing — never silent past the label either.
3771 let tail = blocked
3772 .tail
3773 .expect("the attempted operation is still named");
3774 assert!(tail.contains("(waiting for the shared build cache)"));
3775 assert!(tail.contains("contended"));
3776
3777 let mut d = round(false, Vec::new());
3778 d.e2e_deferred = true;
3779 d.e2e_defer_reason = Some("2 blocking finding(s) already required a fix".to_owned());
3780 let deferred = d.verification_summary("h").expect("deferred is surfaced");
3781 assert!(deferred.label.contains("deferred to the fixer"));
3782 assert!(deferred.label.contains("2 blocking finding(s)"));
3783 assert!(deferred.tail.is_none());
3784 }
3785
3786 #[test]
3787 fn verification_summary_says_unknown_rather_than_guessing_a_time_or_a_commit() {
3788 let mut r = round(false, Vec::new());
3789 r.e2e = vec![CommandOutcome {
3790 command: "test".to_owned(),
3791 code: Some(1),
3792 output_tail: "boom".to_owned(),
3793 duration_ms: 0,
3794 resource_blocked: false,
3795 }];
3796 // verified_head/verified_at left at their default `None` — exactly
3797 // the shape a schema-7 round with no reconstructable timestamp has.
3798 let summary = r.verification_summary("h").expect("a failure is surfaced");
3799 assert!(summary.label.contains("commit unknown"));
3800 assert!(summary.label.contains("checked at: unknown"));
3801 }
3802
3803 #[test]
3804 fn gate_status_tells_not_run_apart_from_passed_with_no_commands() {
3805 let mut s = state();
3806 assert_eq!(s.gate_status(), GateStatus::NotRun);
3807
3808 s.gate_ran = true;
3809 assert_eq!(
3810 s.gate_status(),
3811 GateStatus::PassedWithNoCommands,
3812 "an empty gate must read as a real pass once gate_ran says it actually ran"
3813 );
3814
3815 s.gate = vec![CommandOutcome {
3816 command: "cargo make check".to_owned(),
3817 code: Some(0),
3818 output_tail: String::new(),
3819 duration_ms: 0,
3820 resource_blocked: false,
3821 }];
3822 assert_eq!(s.gate_status(), GateStatus::Passed);
3823
3824 s.gate[0].code = Some(1);
3825 assert_eq!(s.gate_status(), GateStatus::Failed);
3826
3827 s.gate_ran = false;
3828 assert_eq!(
3829 s.gate_status(),
3830 GateStatus::NotRun,
3831 "gate_ran false must win even over a non-empty gate left from a stale record"
3832 );
3833 }
3834
3835 #[test]
3836 fn open_findings_is_empty_when_the_last_round_was_clean() {
3837 let mut s = state();
3838 s.reviews = vec![round(
3839 true,
3840 vec![finding("R1-1-1", crate::verdict::Severity::Minor)],
3841 )];
3842 assert!(s.open_findings().is_empty());
3843 }
3844
3845 #[test]
3846 fn open_findings_reads_the_last_non_clean_round() {
3847 let mut s = state();
3848 s.reviews = vec![round(
3849 false,
3850 vec![finding("R1-1-1", crate::verdict::Severity::Major)],
3851 )];
3852 let open = s.open_findings();
3853 assert_eq!(open.len(), 1);
3854 assert_eq!(open[0].id, "R1-1-1");
3855 }
3856
3857 #[test]
3858 fn handed_off_with_open_findings_needs_a_mergeable_status_and_an_open_round() {
3859 let mut s = state();
3860 s.reviews = vec![round(
3861 false,
3862 vec![finding("R1-1-1", crate::verdict::Severity::Major)],
3863 )];
3864
3865 s.status = RunStatus::Blocked;
3866 assert!(
3867 !s.handed_off_with_open_findings(),
3868 "a blocked run is not a hand-off"
3869 );
3870
3871 s.status = RunStatus::Ready;
3872 assert!(s.handed_off_with_open_findings());
3873
3874 s.reviews = vec![round(true, Vec::new())];
3875 assert!(
3876 !s.handed_off_with_open_findings(),
3877 "a clean last round has nothing to hand off"
3878 );
3879 }
3880
3881 #[test]
3882 fn unmerged_by_design_is_only_ready_reached_via_merge_mode_none() {
3883 let mut s = state();
3884
3885 s.status = RunStatus::Ready;
3886 assert!(
3887 !s.unmerged_by_design(),
3888 "no merge outcome recorded at all must not be flagged"
3889 );
3890
3891 s.merge = Some(MergeOutcome {
3892 mode: MergeMode::None,
3893 ok: true,
3894 detail: "git merge --no-ff magi/x/A".to_owned(),
3895 empty: false,
3896 });
3897 assert!(
3898 s.unmerged_by_design(),
3899 "Ready reached through mode none is the case this exists to flag"
3900 );
3901
3902 // A PR closed without merging also leaves `status` at `Ready`, but
3903 // through `mode = "pr"` — a run that may still have been landable by
3904 // a person watching the PR, unlike the honest mode-none no-op.
3905 s.merge = Some(MergeOutcome {
3906 mode: MergeMode::Pr,
3907 ok: false,
3908 detail: "https://example.com/pr/1 was closed without merging".to_owned(),
3909 empty: false,
3910 });
3911 assert!(
3912 !s.unmerged_by_design(),
3913 "a closed pull request is a different Ready and must not be relabelled"
3914 );
3915
3916 // Same signal must not fire before the run actually got there.
3917 s.status = RunStatus::Gating;
3918 s.merge = Some(MergeOutcome {
3919 mode: MergeMode::None,
3920 ok: true,
3921 detail: "git merge --no-ff magi/x/A".to_owned(),
3922 empty: false,
3923 });
3924 assert!(
3925 !s.unmerged_by_design(),
3926 "status must actually be Ready, not merely have a stale mode-none merge record"
3927 );
3928 }
3929
3930 #[test]
3931 fn state_round_trips_through_json() {
3932 let s = state();
3933 let body = serde_json::to_string(&s).unwrap();
3934 let back: RunState = serde_json::from_str(&body).unwrap();
3935 assert_eq!(back.id, s.id);
3936 assert_eq!(back.instruction, "add retries");
3937 assert_eq!(back.status, RunStatus::Prep);
3938 }
3939
3940 #[test]
3941 fn a_round_recorded_before_e2e_deferral_existed_still_loads() {
3942 // Exactly the shape a pre-existing `run.json` has for a round: no
3943 // `e2e_deferred`, no `e2e_defer_reason`. Every round used to run e2e
3944 // unconditionally, so the honest reading of an old record's silence
3945 // on this is "it was not deferred" — `false`/`None`, not a load
3946 // failure and not a schema bump (see the `SCHEMA` doc comment: a
3947 // purely additive field whose absence has one unambiguous meaning
3948 // does not need one).
3949 let body = r#"{
3950 "round": 1,
3951 "head": "deadbeef",
3952 "reviews": [],
3953 "e2e": [],
3954 "verify_retried": false,
3955 "fix": null,
3956 "blocking": 0,
3957 "answered": 1,
3958 "expected": 1,
3959 "clean": true
3960 }"#;
3961 let r: ReviewRound = serde_json::from_str(body).expect("an old-shaped round must load");
3962 assert!(!r.e2e_deferred);
3963 assert!(r.e2e_defer_reason.is_none());
3964 assert_eq!(r.e2e_status(), E2eStatus::NotConfigured);
3965 }
3966
3967 #[test]
3968 fn schema_five_state_migrates_old_empty_e2e_and_legacy_verify_budget() {
3969 let mut value = serde_json::to_value(state()).expect("serialize state");
3970 let object = value.as_object_mut().expect("state object");
3971 object.insert("schema".to_owned(), serde_json::json!(5));
3972 let graph = object["config"]["graph"]
3973 .as_object_mut()
3974 .expect("graph object");
3975 graph.insert("timeout_review".to_owned(), serde_json::json!(3600));
3976 graph.remove("timeout_verify");
3977 let review = object["reviews"].as_array_mut().expect("reviews");
3978 review.push(serde_json::json!({
3979 "round": 1, "head": "old", "reviews": [], "e2e": [],
3980 "verify_retried": false, "blocking": 0, "answered": 1,
3981 "expected": 1, "clean": true
3982 }));
3983 let old: RunState = serde_json::from_value(value).expect("schema-5 shape parses");
3984 let migrated = migrate_schema(old).expect("schema 5 migrates");
3985 assert_eq!(migrated.schema, SCHEMA);
3986 assert_eq!(migrated.config.graph.verify_timeout(), 3600);
3987 assert_eq!(migrated.reviews[0].e2e_status(), E2eStatus::NotConfigured);
3988 }
3989
3990 #[test]
3991 fn schema_six_state_with_a_recorded_gate_migrates_to_gate_ran_true() {
3992 let mut value = serde_json::to_value(state()).expect("serialize state");
3993 let object = value.as_object_mut().expect("state object");
3994 object.insert("schema".to_owned(), serde_json::json!(6));
3995 object.insert(
3996 "gate".to_owned(),
3997 serde_json::json!([{
3998 "command": "cargo make check",
3999 "code": 0,
4000 "output_tail": "",
4001 "duration_ms": 0,
4002 "resource_blocked": false
4003 }]),
4004 );
4005 let old: RunState = serde_json::from_value(value).expect("schema-6 shape parses");
4006 let migrated = migrate_schema(old).expect("schema 6 migrates");
4007 assert_eq!(migrated.schema, SCHEMA);
4008 assert!(
4009 migrated.gate_ran,
4010 "a non-empty recorded gate is a real attempt, not an unrun one"
4011 );
4012 assert_eq!(migrated.gate_status(), GateStatus::Passed);
4013 }
4014
4015 #[test]
4016 fn schema_six_state_with_an_empty_gate_migrates_to_gate_ran_false_and_is_retried() {
4017 // The exact shape of the stuck `shoka` run this schema bump fixes:
4018 // `verify.gate` empty, `gate` empty, schema 6. It must come back as
4019 // "not yet run" so the next `gate()` call re-attempts it — and for a
4020 // repo with no gate commands configured, that resolves instantly to
4021 // `PassedWithNoCommands` instead of staying stuck forever.
4022 let mut value = serde_json::to_value(state()).expect("serialize state");
4023 let object = value.as_object_mut().expect("state object");
4024 object.insert("schema".to_owned(), serde_json::json!(6));
4025 object.insert("gate".to_owned(), serde_json::json!([]));
4026 let old: RunState = serde_json::from_value(value).expect("schema-6 shape parses");
4027 let migrated = migrate_schema(old).expect("schema 6 migrates");
4028 assert_eq!(migrated.schema, SCHEMA);
4029 assert!(
4030 !migrated.gate_ran,
4031 "an empty gate on schema 6 is ambiguous and must be treated as unrun"
4032 );
4033 assert_eq!(migrated.gate_status(), GateStatus::NotRun);
4034 }
4035
4036 #[test]
4037 fn schema_seven_state_reconstructs_verified_head_for_a_round_that_actually_ran_e2e() {
4038 // Schema 7's main review loop always checked `e2e` against the
4039 // round's own `head` — it just never wrote that into `verified_head`
4040 // unless a catch-up run had checked a *different* commit. Migrating
4041 // to schema 8 restores that always-true fact instead of leaving a
4042 // reader to assume it.
4043 let mut value = serde_json::to_value(state()).expect("serialize state");
4044 let object = value.as_object_mut().expect("state object");
4045 object.insert("schema".to_owned(), serde_json::json!(7));
4046 let reviews = object["reviews"].as_array_mut().expect("reviews");
4047 reviews.push(serde_json::json!({
4048 "round": 1, "head": "deadbeef", "reviews": [],
4049 "e2e": [{
4050 "command": "cargo test", "code": 0, "output_tail": "",
4051 "duration_ms": 0, "resource_blocked": false
4052 }],
4053 "verify_retried": false, "blocking": 0, "answered": 1,
4054 "expected": 1, "clean": true
4055 }));
4056 let old: RunState = serde_json::from_value(value).expect("schema-7 shape parses");
4057 let migrated = migrate_schema(old).expect("schema 7 migrates");
4058 assert_eq!(migrated.schema, SCHEMA);
4059 assert_eq!(
4060 migrated.reviews[0].verified_head.as_deref(),
4061 Some("deadbeef"),
4062 "a schema-7 round's main-loop e2e was always against its own head, even though the \
4063 field never said so"
4064 );
4065 assert!(
4066 migrated.reviews[0].verified_at.is_none(),
4067 "no historical timestamp exists to reconstruct; unknown stays unknown, not a \
4068 guessed 'now'"
4069 );
4070 }
4071
4072 #[test]
4073 fn schema_seven_state_leaves_a_deferred_round_with_no_verified_head() {
4074 let mut value = serde_json::to_value(state()).expect("serialize state");
4075 let object = value.as_object_mut().expect("state object");
4076 object.insert("schema".to_owned(), serde_json::json!(7));
4077 let reviews = object["reviews"].as_array_mut().expect("reviews");
4078 reviews.push(serde_json::json!({
4079 "round": 1, "head": "deadbeef", "reviews": [],
4080 "e2e": [], "e2e_deferred": true,
4081 "verify_retried": false, "blocking": 1, "answered": 1,
4082 "expected": 1, "clean": false
4083 }));
4084 let old: RunState = serde_json::from_value(value).expect("schema-7 shape parses");
4085 let migrated = migrate_schema(old).expect("schema 7 migrates");
4086 assert!(
4087 migrated.reviews[0].verified_head.is_none(),
4088 "a deferred round never ran e2e; there is nothing to reconstruct"
4089 );
4090 }
4091
4092 #[test]
4093 fn origin_round_trips_through_the_run_state() {
4094 let mut s = state();
4095 s.origin = Some(Origin::from_agent_env(
4096 Some(("4a7b".to_owned(), "chat".to_owned())),
4097 Some("20260930-092817-4f6f".to_owned()),
4098 ));
4099 let back: RunState =
4100 serde_json::from_str(&serde_json::to_string(&s).unwrap()).expect("parse back");
4101 assert_eq!(back.origin, s.origin);
4102 assert_eq!(
4103 back.origin.as_ref().unwrap().by,
4104 StartedBy::Chat {
4105 talk: "4a7b".to_owned()
4106 }
4107 );
4108 assert_eq!(
4109 origin_label(back.origin.as_ref()),
4110 "chat 4a7b, for task 4f6f"
4111 );
4112 }
4113
4114 #[test]
4115 fn a_schema_twelve_record_without_an_origin_loads_and_reads_as_unknown() {
4116 let mut value = serde_json::to_value(state()).expect("serialize state");
4117 let object = value.as_object_mut().expect("state object");
4118 object.insert("schema".to_owned(), serde_json::json!(12));
4119 object.remove("origin");
4120 let old: RunState = serde_json::from_value(value).expect("schema-12 shape parses");
4121 assert!(old.origin.is_none());
4122 let migrated = migrate_schema(old).expect("schema 12 migrates");
4123 assert_eq!(migrated.schema, SCHEMA);
4124 assert!(
4125 migrated.origin.is_none(),
4126 "an origin nobody recorded is not invented"
4127 );
4128 assert_eq!(
4129 origin_label(migrated.origin.as_ref()),
4130 "origin unknown (started before origins were recorded)"
4131 );
4132 }
4133
4134 #[test]
4135 fn origin_attributes_agents_by_node_and_never_by_guesswork() {
4136 let chat = Origin::from_agent_env(Some(("4a7b".to_owned(), "chat".to_owned())), None);
4137 assert_eq!(
4138 chat.by,
4139 StartedBy::Chat {
4140 talk: "4a7b".into()
4141 }
4142 );
4143 let seat = Origin::from_agent_env(
4144 Some(("20260930-092817-ec34".to_owned(), "implement".to_owned())),
4145 None,
4146 );
4147 assert_eq!(seat.label(), "implement@ec34");
4148 assert_eq!(Origin::from_agent_env(None, None), Origin::operator());
4149 assert_eq!(Origin::operator().label(), "operator");
4150 assert_eq!(Origin::queue("20260930-000000-4f6f").label(), "task 4f6f");
4151 assert_eq!(
4152 Origin::operator()
4153 .serving(Some("20260930-000000-4f6f".to_owned()))
4154 .label(),
4155 "operator, for task 4f6f"
4156 );
4157 }
4158
4159 #[test]
4160 fn schema_six_serialization_is_rejected_by_a_schema_five_reader() {
4161 let body = serde_json::to_value(state()).expect("serialize state");
4162 assert_eq!(body["schema"], serde_json::json!(SCHEMA));
4163 assert_ne!(body["schema"], serde_json::json!(5));
4164 }
4165
4166 #[test]
4167 fn seat_started_and_finished_track_who_has_not_answered_yet() {
4168 let mut s = state();
4169 s.seat_started("judge", "judge-1", std::time::Duration::from_secs(60), 0);
4170 s.seat_started("judge", "judge-2", std::time::Duration::from_secs(60), 0);
4171 assert_eq!(s.active.len(), 2, "both seats are still out");
4172
4173 s.seat_finished("judge-1");
4174 assert_eq!(
4175 s.active.keys().collect::<Vec<_>>(),
4176 vec!["judge-2"],
4177 "only the seat that answered drops out; judge-2 is still waited on"
4178 );
4179 }
4180
4181 /// `seats_active` / `tasks_active` are the accessors report/web read
4182 /// instead of `active` directly, so neither ever counts the other kind of
4183 /// entry as a seat — a `verify.e2e` task must never inflate a quorum or
4184 /// seat count, and a seat must never show up in a task listing.
4185 #[test]
4186 fn seats_active_and_tasks_active_never_cross_over() {
4187 let mut s = state();
4188 s.seat_started("judge", "judge-1", std::time::Duration::from_secs(60), 0);
4189 s.task_command(
4190 "e2e",
4191 "verify",
4192 0,
4193 "cargo test",
4194 1,
4195 2,
4196 std::time::Duration::from_secs(600),
4197 );
4198
4199 assert_eq!(
4200 s.seats_active()
4201 .map(|(k, _)| k.as_str())
4202 .collect::<Vec<_>>(),
4203 vec!["judge-1"]
4204 );
4205 assert_eq!(
4206 s.tasks_active()
4207 .map(|(k, _)| k.as_str())
4208 .collect::<Vec<_>>(),
4209 vec!["e2e"]
4210 );
4211
4212 // A command boundary updates the same entry in place — still one
4213 // task, never a second one accumulating alongside it.
4214 s.task_command(
4215 "e2e",
4216 "verify",
4217 0,
4218 "cargo clippy",
4219 2,
4220 2,
4221 std::time::Duration::from_secs(600),
4222 );
4223 assert_eq!(s.tasks_active().count(), 1);
4224 assert_eq!(s.active["e2e"].command.as_deref(), Some("cargo clippy"));
4225
4226 s.task_finished("e2e");
4227 assert!(s.tasks_active().next().is_none());
4228 assert_eq!(
4229 s.seats_active()
4230 .map(|(k, _)| k.as_str())
4231 .collect::<Vec<_>>(),
4232 vec!["judge-1"],
4233 "clearing the task must not touch the seat entry"
4234 );
4235 }
4236
4237 #[test]
4238 fn a_retry_is_recorded_as_a_later_attempt_on_the_same_seat() {
4239 let mut s = state();
4240 s.seat_started("review", "review-2", std::time::Duration::from_secs(30), 0);
4241 s.seat_finished("review-2");
4242 // A nudge re-asks the same seat; attempt says this is not the first
4243 // time, which is the only trace a nudge otherwise leaves behind.
4244 s.seat_started("review", "review-2", std::time::Duration::from_secs(30), 1);
4245 assert_eq!(s.active["review-2"].attempt, 1);
4246 }
4247
4248 #[test]
4249 fn active_seat_reports_elapsed_and_remaining_time() {
4250 let now = Timestamp::now();
4251 let started = now - jiff::SignedDuration::from_secs(30);
4252 let seat = ActiveSeat {
4253 node: "judge".to_owned(),
4254 started_at: started,
4255 timeout_secs: 100,
4256 attempt: 0,
4257 task: None,
4258 command: None,
4259 index: None,
4260 total: None,
4261 };
4262 assert_eq!(seat.elapsed_secs(now), 30);
4263 assert_eq!(seat.remaining_secs(now), 70);
4264 }
4265
4266 #[test]
4267 fn remaining_time_never_goes_negative_past_the_timeout() {
4268 // `agy`'s own print-timeout occasionally overruns by a hair before the
4269 // kill lands; a naive subtraction would print a negative "time left".
4270 let now = Timestamp::now();
4271 let started = now - jiff::SignedDuration::from_secs(200);
4272 let seat = ActiveSeat {
4273 node: "implement".to_owned(),
4274 started_at: started,
4275 timeout_secs: 100,
4276 attempt: 1,
4277 task: None,
4278 command: None,
4279 index: None,
4280 total: None,
4281 };
4282 assert_eq!(seat.remaining_secs(now), 0);
4283 }
4284
4285 #[test]
4286 fn clear_active_drops_stale_seats_and_reports_whether_it_did() {
4287 let mut s = state();
4288 assert!(!s.clear_active(), "nothing to clear on a fresh run");
4289 s.seat_started(
4290 "implement",
4291 "impl-B",
4292 std::time::Duration::from_secs(3600),
4293 0,
4294 );
4295 assert!(s.clear_active(), "a leftover entry is reported as cleared");
4296 assert!(s.active.is_empty());
4297 }
4298
4299 #[test]
4300 fn active_seat_carries_nothing_that_could_be_read_as_output_bytes() {
4301 // `agy` prints exactly one JSON object, at the very end (see
4302 // `agent::dropped_stream`'s doc comment) — a seat can sit at zero
4303 // captured bytes for its whole timeout while working normally. So
4304 // `ActiveSeat` records only the wall-clock facts (when it started,
4305 // its budget, which attempt), never a byte count, which is what
4306 // keeps a reader from being able to build "0 bytes => dead" out of
4307 // it even by accident.
4308 let seat = ActiveSeat {
4309 node: "implement".to_owned(),
4310 started_at: Timestamp::now(),
4311 timeout_secs: 60,
4312 attempt: 0,
4313 task: None,
4314 command: None,
4315 index: None,
4316 total: None,
4317 };
4318 let value = serde_json::to_value(&seat).unwrap();
4319 let keys: std::collections::BTreeSet<String> =
4320 value.as_object().unwrap().keys().cloned().collect();
4321 assert_eq!(
4322 keys,
4323 std::collections::BTreeSet::from([
4324 "node".to_owned(),
4325 "started_at".to_owned(),
4326 "timeout_secs".to_owned(),
4327 "attempt".to_owned(),
4328 ]),
4329 "a byte count here would be a lever to declare a silent-but-healthy seat dead, and \
4330 the task-only fields must stay absent (not null) on an ordinary seat entry"
4331 );
4332 }
4333
4334 /// The same guarantee as
4335 /// [`active_seat_carries_nothing_that_could_be_read_as_output_bytes`],
4336 /// extended to a task entry: `verify.e2e` / `verify.gate` are exactly as
4337 /// silent as `agy` between commands, so a running command-list task must
4338 /// never carry anything a reader could mistake for output-byte evidence
4339 /// either.
4340 #[test]
4341 fn task_active_seat_carries_nothing_that_could_be_read_as_output_bytes() {
4342 let seat = ActiveSeat {
4343 node: "verify".to_owned(),
4344 started_at: Timestamp::now(),
4345 timeout_secs: 600,
4346 attempt: 0,
4347 task: Some("e2e".to_owned()),
4348 command: Some("cargo test".to_owned()),
4349 index: Some(1),
4350 total: Some(3),
4351 };
4352 let value = serde_json::to_value(&seat).unwrap();
4353 let keys: std::collections::BTreeSet<String> =
4354 value.as_object().unwrap().keys().cloned().collect();
4355 assert_eq!(
4356 keys,
4357 std::collections::BTreeSet::from([
4358 "node".to_owned(),
4359 "started_at".to_owned(),
4360 "timeout_secs".to_owned(),
4361 "attempt".to_owned(),
4362 "task".to_owned(),
4363 "command".to_owned(),
4364 "index".to_owned(),
4365 "total".to_owned(),
4366 ]),
4367 );
4368 }
4369
4370 #[test]
4371 fn an_old_run_json_without_active_seats_still_loads() {
4372 // Schema did not bump for this field: an already-written run.json
4373 // simply lacks the key, and `#[serde(default)]` must fill it in
4374 // rather than fail the whole read.
4375 let s = state();
4376 let mut value = serde_json::to_value(&s).unwrap();
4377 value.as_object_mut().unwrap().remove("active");
4378 let back: RunState = serde_json::from_value(value).unwrap();
4379 assert!(back.active.is_empty());
4380 assert_eq!(back.schema, SCHEMA);
4381 }
4382
4383 #[test]
4384 fn an_old_run_json_without_jobs_still_loads() {
4385 // No schema bump for this field either, for the same reason: an
4386 // empty `jobs` list on an old record means exactly what it always
4387 // meant for that record — no adapter existed yet to report one —
4388 // and `#[serde(default)]` fills it in rather than failing the read.
4389 let s = state();
4390 let mut value = serde_json::to_value(&s).unwrap();
4391 value.as_object_mut().unwrap().remove("jobs");
4392 let back: RunState = serde_json::from_value(value).unwrap();
4393 assert!(back.jobs.is_empty());
4394 assert_eq!(back.schema, SCHEMA);
4395 }
4396
4397 #[test]
4398 fn ensure_can_delete_guards_live_and_unfolded_runs() {
4399 let mut s = state();
4400 // 1. A daemon is working on it right now.
4401 s.status = RunStatus::Prep;
4402 let err = s.ensure_can_delete(true).unwrap_err().to_string();
4403 assert!(err.contains("live daemon"), "{err}");
4404
4405 // 2. The same unfinished run with no daemon behind it is a leftover
4406 // from a killed process, and deletable. Without this an interrupted
4407 // run could never be removed: its status stays `prep` forever.
4408 assert!(s.ensure_can_delete(false).is_ok());
4409
4410 // 3. Unfolded candidates are refused either way — that is the guard
4411 // that stops a delete from discarding a worktree.
4412 s.status = RunStatus::Merged;
4413 s.candidates.push(Candidate {
4414 index: 0,
4415 label: 'A',
4416 agent: "a".to_owned(),
4417 branch: "b".to_owned(),
4418 worktree: PathBuf::from("/w"),
4419 summary: String::new(),
4420 stat: String::new(),
4421 files: 1,
4422 commits: 1,
4423 empty: false,
4424 failed: None,
4425 verified_noop: None,
4426 duration_ms: 0,
4427 folded: false,
4428 });
4429 let err = s.ensure_can_delete(false).unwrap_err().to_string();
4430 assert!(
4431 err.contains("magi fold"),
4432 "error must suggest `magi fold`: {err}"
4433 );
4434
4435 // 4. Folded and nobody working on it.
4436 s.candidates[0].folded = true;
4437 assert!(s.ensure_can_delete(false).is_ok());
4438 }
4439}
4440
4441impl RunState {
4442 /// A seed for a seat that changes agent, distinct on every call.
4443 pub fn next_seat_seed(&mut self) -> u64 {
4444 self.seat_epoch += 1;
4445 self.seed ^ self.seat_epoch.wrapping_mul(0x9E37_79B9_7F4A_7C15)
4446 }
4447}
4448
4449/// What kind of failure ended an agent's turn on a seat, for deciding whether
4450/// the seat is worth handing to the next roster agent.
4451#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
4452pub enum FailClass {
4453 /// A CLI rate limit.
4454 Quota,
4455 /// The turn outlived its budget.
4456 Timeout,
4457 /// Any other failure, with the message's shape (`failure_signature`,
4458 /// capped at 120 characters).
4459 Other(String),
4460}
4461
4462/// One reviewer seat's record across review rounds, so a round does not ask
4463/// an agent that already failed the seat while another one is answering.
4464///
4465/// `failed` is a *priority* set, not a bound: the per-round `tried` set in
4466/// `ask_json_wave` starts empty every round, so an agent that answered is
4467/// never locked out. A failed id is only asked again once nothing else on the
4468/// roster is left (once per round, and the rounds are `review_rounds`).
4469#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
4470pub struct SeatHistory {
4471 /// Roster ids that failed this seat and have not answered it since.
4472 #[serde(default)]
4473 pub failed: BTreeSet<String>,
4474 /// The agent that last answered this seat.
4475 #[serde(default)]
4476 pub last_ok: Option<String>,
4477 /// The class of the seat's most recent failure; cleared by an answer.
4478 #[serde(default)]
4479 pub last_fail: Option<FailClass>,
4480}