octl_core/schema.rs
1//! On-disk state schema types per `design.md` §1.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5use serde_json::{Map, Value};
6
7/// The current state-on-disk schema version this crate writes.
8pub const STATE_SCHEMA_VERSION: u32 = 1;
9
10/// All state-schema versions this crate can read.
11pub const SUPPORTED_STATE_SCHEMAS: &[u32] = &[1];
12
13/// Crockford base32 alphabet in lowercase (excludes `i`, `l`, `o`, `u`). The
14/// charset for the bare ULID of a [`RunId`].
15const CROCKFORD_LOWER: &[u8] = b"0123456789abcdefghjkmnpqrstvwxyz";
16
17/// True iff every byte of `s` is a lowercase Crockford base32 character.
18fn all_crockford_lower(s: &str) -> bool {
19 s.bytes().all(|b| CROCKFORD_LOWER.contains(&b))
20}
21
22/// True iff `s` is a syntactically valid (possibly partial) prefix of a
23/// [`RunId`]: non-empty, no longer than a full ULID, every character a lowercase
24/// Crockford base32 digit, and a first character within ULID's `0..=7`
25/// timestamp bound. Used by the CLI to resolve an unambiguous run-id prefix
26/// (like `git`) — a value failing this is a malformed argument (`invalid_run_id`),
27/// not a legitimate-but-unknown prefix. The first-char bound is enforced because
28/// no valid `RunId` can begin outside `0..=7`, so an `8…`/`9…` prefix is
29/// impossible rather than merely absent — reporting it as malformed keeps the
30/// error class honest and consistent with how [`RunId::parse_str`] rejects a
31/// full-length id with the same leading digit.
32pub fn is_run_id_prefix(s: &str) -> bool {
33 !s.is_empty()
34 && s.len() <= RunId::LEN
35 && all_crockford_lower(s)
36 && matches!(s.as_bytes().first(), Some(b'0'..=b'7'))
37}
38
39/// Error returned when a typed identifier fails parse-time validation.
40///
41/// Every [`RunId`] and [`NodeId`] is
42/// constructed only through its `parse_str` constructor (or the equivalent
43/// validating `Deserialize`), so any value that reaches a path helper has
44/// already been checked for prefix, charset, and length. This is the
45/// path-traversal guard: a raw id containing `/`, `..`, or a leading dot can
46/// never be turned into one of these newtypes, so it can never name a file
47/// outside the run directory.
48#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
49pub enum IdValidationError {
50 /// The value carried the right prefix (or needs none) but its body had the
51 /// wrong length or used characters outside the permitted charset.
52 #[error("invalid {kind} id {value:?}: expected {expected}")]
53 InvalidFormat {
54 /// Which id type rejected the value (`run`, `node`).
55 kind: &'static str,
56 /// The offending raw value.
57 value: String,
58 /// Human-readable description of the accepted shape (e.g. `n-NNNN`).
59 expected: &'static str,
60 },
61 /// The value did not start with the id type's required prefix (`n-`).
62 #[error("invalid {kind} id: wrong prefix, expected {expected}")]
63 WrongPrefix {
64 /// Which id type rejected the value.
65 kind: &'static str,
66 /// Human-readable description of the accepted shape.
67 expected: &'static str,
68 },
69}
70
71impl IdValidationError {
72 /// The id type that rejected the value (`run`, `node`).
73 pub fn kind(&self) -> &'static str {
74 match self {
75 Self::InvalidFormat { kind, .. } | Self::WrongPrefix { kind, .. } => kind,
76 }
77 }
78
79 /// The accepted-shape hint, suitable for the `expected` field of a CLI
80 /// error envelope.
81 pub fn expected(&self) -> &'static str {
82 match self {
83 Self::InvalidFormat { expected, .. } | Self::WrongPrefix { expected, .. } => expected,
84 }
85 }
86}
87
88/// Generate the shared trait surface for a validated id newtype: `as_str`,
89/// `FromStr`, `Display`, `Debug`, `Ord` / `PartialOrd` (lexicographic over the
90/// inner string), `Serialize` (as the bare string), and a validating
91/// `Deserialize` (delegates to `parse_str`, so reading an old file with a
92/// malformed id fails loudly rather than silently widening the type). Each
93/// newtype supplies its own `parse_str` in a separate `impl` block.
94///
95/// `Ord` / `PartialOrd` are derived, so they forward to the inner `String`'s
96/// ordering — i.e. plain `&str` byte comparison. For the fixed-width ULID form
97/// ([`RunId`]) this preserves the natural time ordering ULIDs encode in their
98/// lexical sort.
99///
100/// CAVEAT — this ordering is lexical, *not* numeric or semantic: [`NodeId`] is
101/// `n-` + a variable-width number, so once the counter grows a digit the byte
102/// order diverges from the numeric order: `n-10000 < n-9999`. Do not sort
103/// `NodeId`s expecting ascending node number; parse the body if you need that.
104///
105/// The trait is provided for `BTreeMap`/`BTreeSet` keys and stable sorts.
106macro_rules! id_newtype {
107 ($(#[$m:meta])* $name:ident) => {
108 $(#[$m])*
109 #[derive(Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
110 pub struct $name(String);
111
112 impl $name {
113 /// The validated id as a string slice. There is no mutable or
114 /// owned-`String` accessor by design: the inner value can never be
115 /// mutated into an unvalidated state after construction.
116 pub fn as_str(&self) -> &str {
117 &self.0
118 }
119 }
120
121 impl std::str::FromStr for $name {
122 type Err = IdValidationError;
123
124 /// Parse via the newtype's own `parse_str`; lets callers use the
125 /// `str::parse` / `FromStr` ecosystem (`s.parse::<RunId>()?`).
126 fn from_str(s: &str) -> Result<Self, Self::Err> {
127 Self::parse_str(s)
128 }
129 }
130
131 impl std::fmt::Display for $name {
132 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
133 f.write_str(&self.0)
134 }
135 }
136
137 impl std::fmt::Debug for $name {
138 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
139 write!(f, "{}({:?})", stringify!($name), self.0)
140 }
141 }
142
143 impl serde::Serialize for $name {
144 fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
145 s.serialize_str(&self.0)
146 }
147 }
148
149 impl<'de> serde::Deserialize<'de> for $name {
150 fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
151 let s = String::deserialize(d)?;
152 Self::parse_str(&s).map_err(serde::de::Error::custom)
153 }
154 }
155 };
156}
157
158id_newtype! {
159 /// A validated run identifier: a lowercase ULID (26 Crockford base32
160 /// characters whose first character keeps the encoded timestamp within
161 /// ULID's 48-bit range). Mirrors what [`crate::new_run_id`] emits.
162 RunId
163}
164
165impl RunId {
166 /// Accepted-shape hint shared by every rejection.
167 const EXPECTED: &'static str = "26-char lowercase Crockford base32 ULID";
168 /// Canonical length of a ULID in Crockford base32. Public so CLI-side prefix
169 /// resolution can branch on "full id vs. prefix" without mirroring the
170 /// constant (which would silently drift if the id shape ever changed).
171 pub const LEN: usize = 26;
172
173 /// Parse and validate a `run_id`. Accepts only the 26-character lowercase
174 /// ULID shape; rejects wrong length, non-Crockford characters, and a first
175 /// character outside `0..=7` (which would overflow ULID's 48-bit timestamp).
176 pub fn parse_str(s: &str) -> Result<Self, IdValidationError> {
177 let reject = || IdValidationError::InvalidFormat {
178 kind: "run",
179 value: s.to_string(),
180 expected: Self::EXPECTED,
181 };
182 if s.len() != Self::LEN || !all_crockford_lower(s) {
183 return Err(reject());
184 }
185 // The first base32 char carries the top 5 bits of the 128-bit ULID;
186 // the 48-bit timestamp cannot overflow only if it is in `0..=7`.
187 if !(b'0'..=b'7').contains(&s.as_bytes()[0]) {
188 return Err(reject());
189 }
190 Ok(Self(s.to_string()))
191 }
192}
193
194id_newtype! {
195 /// A validated node identifier: `n-` followed by 4 or more ASCII digits
196 /// (e.g. `n-0001`). Mirrors what [`crate::format_node_id`] emits.
197 NodeId
198}
199
200impl NodeId {
201 /// Accepted-shape hint shared by every rejection.
202 const EXPECTED: &'static str = "n-NNNN (n- followed by 4-10 ASCII digits)";
203
204 /// Parse and validate a `node_id`. Requires the `n-` prefix followed by
205 /// 4 to 10 ASCII digits; rejects anything else (wrong prefix, too few or
206 /// too many digits, non-digit body). The 10-digit ceiling covers the full
207 /// `u32` counter range [`crate::format_node_id`] draws from while bounding
208 /// the filename length (a defense against `ENAMETOOLONG` from a forged id).
209 pub fn parse_str(s: &str) -> Result<Self, IdValidationError> {
210 let body = s.strip_prefix("n-").ok_or(IdValidationError::WrongPrefix {
211 kind: "node",
212 expected: Self::EXPECTED,
213 })?;
214 if (4..=10).contains(&body.len()) && body.bytes().all(|b| b.is_ascii_digit()) {
215 Ok(Self(s.to_string()))
216 } else {
217 Err(IdValidationError::InvalidFormat {
218 kind: "node",
219 value: s.to_string(),
220 expected: Self::EXPECTED,
221 })
222 }
223 }
224}
225
226/// The run/node kind enum (design.md §1.2).
227///
228/// The 0.2 subtractive cut removed the `code`, `orchestrate`, `orchestrated`,
229/// `bugfix`, and `make-skill` kinds (the interactive + DAG-driver topologies and
230/// the two phantom variants that were behaviourally `Spinoff`). The surviving
231/// kinds are all autonomous. [`Kind::Unknown`] is a read-only catch-all so a
232/// legacy on-disk run recorded under a since-removed kind still deserializes —
233/// `doctor` / `run list` report it, never delete it (ADR §D7).
234#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
235#[serde(rename_all = "kebab-case")]
236pub enum Kind {
237 /// Autonomous fire-and-forget task that merges itself back (`/worktree-spinoff`).
238 Spinoff,
239 /// Autonomous multi-source research worktree (`/worktree-research`).
240 Research,
241 /// Drives one architectural decision to an ADR (`/worktree-technical-decision`).
242 TechnicalDecision,
243 /// Parallel fan-out of many identical units (`/fan-out`).
244 FanOut,
245 /// A kind this build no longer models — a legacy run recorded on disk under a
246 /// kind removed in the 0.2 cut (`code` / `orchestrate` / `orchestrated` /
247 /// `bugfix` / `make-skill`), or any future/unknown wire value. Read-only:
248 /// `#[serde(other)]` maps every unrecognized kind here so `doctor` / `run
249 /// list` can still surface such a run rather than faulting on it (ADR §D7).
250 /// It is NEVER a creatable kind — it is absent from [`Kind::WIRE_NAMES`], so
251 /// no CLI surface or report validator accepts it as input.
252 #[serde(other)]
253 Unknown,
254}
255
256impl Kind {
257 /// The kebab-case wire name for this kind — the same string serde
258 /// (de)serializes via `rename_all = "kebab-case"`.
259 ///
260 /// The exhaustive `match` is deliberate: adding a `Kind` variant fails
261 /// to compile until its wire name is listed here, so [`Kind::WIRE_NAMES`]
262 /// and any caller that advertises the accepted kinds (e.g. the report
263 /// validator's `expected` hint) cannot silently drift from the enum.
264 #[must_use]
265 pub const fn wire_name(self) -> &'static str {
266 match self {
267 Kind::Spinoff => "spinoff",
268 Kind::Research => "research",
269 Kind::TechnicalDecision => "technical-decision",
270 Kind::FanOut => "fan-out",
271 Kind::Unknown => "unknown",
272 }
273 }
274
275 /// Every *creatable* kind's kebab-case wire name, in declaration order.
276 /// Single source of truth for "the set of accepted kinds" — see
277 /// [`Kind::wire_name`]. Excludes [`Kind::Unknown`], which is a read-only
278 /// catch-all, never a valid input.
279 pub const WIRE_NAMES: &'static [&'static str] = &[
280 Kind::Spinoff.wire_name(),
281 Kind::Research.wire_name(),
282 Kind::TechnicalDecision.wire_name(),
283 Kind::FanOut.wire_name(),
284 ];
285
286 /// Default how-run [`Lifecycle`] for a kind — the value a run gets when
287 /// created WITHOUT `--interactive`. Every kind defaults to autonomous; the 0.2
288 /// cut removed the `code` kind that used to imply interactivity, so
289 /// interactivity is no longer kind-derived — it is the explicit `--interactive`
290 /// flag ([`Lifecycle`] docs, design.md §2/§6). This method only seeds the
291 /// default; it must NOT be read as "this kind is (non-)interactive".
292 /// [`Kind::Unknown`] (a legacy on-disk run) reads as autonomous too; it is
293 /// never freshly supervised, so the value only ever feeds read-only display.
294 pub fn lifecycle(self) -> Lifecycle {
295 match self {
296 Kind::Spinoff
297 | Kind::Research
298 | Kind::TechnicalDecision
299 | Kind::FanOut
300 | Kind::Unknown => Lifecycle::Autonomous,
301 }
302 }
303
304 /// Whether this kind is a **top-level, single-node, autonomous worker** —
305 /// one detached agent that materializes its own worktree and self-merges,
306 /// with no children and no parent DAG driving it. These are exactly the
307 /// kinds eligible for the supervisor's bounded auto-retry on an empty-handed
308 /// `agent-died` (issue `autoretry-agent-died-worker`).
309 ///
310 /// Excludes `FanOut` (a multi-unit driver — its driver node has no agent of
311 /// its own) and [`Kind::Unknown`] (a legacy on-disk run, never freshly
312 /// supervised).
313 ///
314 /// The exhaustive `match` fails to compile when a new `Kind` is added, forcing
315 /// a deliberate eligibility decision rather than a silent default.
316 #[must_use]
317 pub fn is_autonomous_single_node_worker(self) -> bool {
318 match self {
319 Kind::Spinoff | Kind::Research | Kind::TechnicalDecision => true,
320 Kind::FanOut | Kind::Unknown => false,
321 }
322 }
323}
324
325/// How a run is driven — its **how-run** state (design.md §2, §6).
326///
327/// This is an **explicit told fact**, set once at `run create` from the
328/// `--interactive` flag and never transitioned. It is deliberately NOT derived
329/// from [`Kind`]: the 0.2 cut removed the `code` kind that used to carry
330/// interactivity accidentally, and interactivity is now orthogonal to topology —
331/// *any* run can be marked interactive (`told, not guessed`, `target-state-0.2.md
332/// §2`/§4). Do not reintroduce a `Kind`-derived inference; `Kind::lifecycle`
333/// exists only to seed the default for a run created without the flag.
334///
335/// `Lifecycle` is a *category*, not a progress signal — an agent tracking
336/// completion polls `manifest.status` (`Pending | Running | Done | Failed |
337/// Cancelled`), NEVER `lifecycle`, whose value never changes (state-integrity
338/// invariant 4).
339#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
340#[serde(rename_all = "kebab-case")]
341pub enum Lifecycle {
342 /// Agent runs to completion unattended; the supervisor adjudicates exit
343 /// (the told `worker.exited` fact, then the residual crash backstop).
344 Autonomous,
345 /// Human-driven: the supervisor **never** auto-terminalizes or auto-tears-down
346 /// from a dead pid or a worker exit — it waits for an explicit `run merge`
347 /// (→ teardown) or `run cancel`. The human owns the whole lifecycle
348 /// (design.md §6).
349 Interactive,
350}
351
352impl Lifecycle {
353 /// True for [`Lifecycle::Interactive`] — the human-driven, supervisor-hands-off
354 /// how-run state. The single predicate the supervisor consults to suppress its
355 /// automatic terminalization/teardown machinery (design.md §6).
356 #[must_use]
357 pub fn is_interactive(self) -> bool {
358 matches!(self, Lifecycle::Interactive)
359 }
360}
361
362/// Run/node status (design.md §1.2).
363///
364/// `Done`, `Failed`, and `Cancelled` are **terminal**: once a run or node
365/// reaches one of them its `status` must never change again. The reducer
366/// enforces this — `apply_run_status`, `apply_node_status`, and
367/// `apply_node_report` are all no-ops once [`Status::is_terminal`] holds — so
368/// a late-arriving event (e.g. an agent success report racing a `run cancel`)
369/// cannot resurrect a settled state. Only the `status` field is frozen;
370/// other projection fields may still be mutated by non-status events.
371#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
372#[serde(rename_all = "kebab-case")]
373pub enum Status {
374 /// Created but not yet started.
375 Pending,
376 /// Actively executing.
377 Running,
378 /// Stalled awaiting input (e.g. an open discussion).
379 Blocked,
380 /// Completed successfully (terminal).
381 Done,
382 /// Completed with failure (terminal).
383 Failed,
384 /// Terminated before completion by an operator or parent (terminal).
385 Cancelled,
386}
387
388impl Status {
389 /// True for the terminal states `Done | Failed | Cancelled`. A run or
390 /// node in a terminal state is settled: the reducer treats any further
391 /// *status* transition as a no-op. "Settled" applies to `status` only —
392 /// non-status projection fields (e.g. `Node::children` via
393 /// `child.spawned`, or manifest counters) can still change.
394 pub fn is_terminal(self) -> bool {
395 matches!(self, Status::Done | Status::Failed | Status::Cancelled)
396 }
397}
398
399/// Aggregate a set of node statuses into the run's rolled-up terminal status,
400/// or `None` when the run is not yet complete.
401///
402/// The single, shared roll-up rule — used both by the supervisor's per-tick
403/// `rollup_status` and by [`cancel_node`](crate::cancel_node)'s in-lock
404/// self-roll-up (so the two can never diverge). A **three-way** classification
405/// (design §2.5, "rollup terminalizes the run cancelled/done/failed once every
406/// node is terminal"):
407///
408/// - `None` if the set is empty (a freshly-created run must not vacuously
409/// complete) or if ANY node is still live (`Pending`/`Running`/`Blocked`);
410/// - `Some(Status::Failed)` if any node genuinely `Failed` (a real failure
411/// dominates the batch outcome);
412/// - `Some(Status::Cancelled)` if no node failed but at least one was
413/// `Cancelled` (a deliberate per-node/whole-run cancel — nothing failed, but
414/// the batch did not fully complete; branch-preserving work is untouched);
415/// - `Some(Status::Done)` when every node is `Done`.
416pub fn aggregate_terminal_status<I>(statuses: I) -> Option<Status>
417where
418 I: IntoIterator<Item = Status>,
419{
420 let mut any = false;
421 let mut any_failed = false;
422 let mut any_cancelled = false;
423 for s in statuses {
424 any = true;
425 match s {
426 Status::Done => {}
427 Status::Failed => any_failed = true,
428 Status::Cancelled => any_cancelled = true,
429 // Any live node means the run is not done yet.
430 Status::Pending | Status::Running | Status::Blocked => return None,
431 }
432 }
433 if !any {
434 return None;
435 }
436 Some(if any_failed {
437 Status::Failed
438 } else if any_cancelled {
439 Status::Cancelled
440 } else {
441 Status::Done
442 })
443}
444
445/// `manifest.json` (design.md §1.2).
446#[derive(Debug, Clone, Serialize, Deserialize)]
447pub struct Manifest {
448 /// State-schema version this file was written with.
449 pub schema_version: u32,
450 /// Watermark: the highest event `seq` whose projection fold is durably
451 /// committed. Events in `events.jsonl` with `seq > applied_seq` are
452 /// *unapplied tail* events — replayed into the projections on the next
453 /// lock acquisition before any new append (see
454 /// [`crate::events::append_and_apply_event`]). This is what makes
455 /// append-then-apply atomic across a reducer crash: the event log can run
456 /// ahead of the projections, but the gap is always healed before the next
457 /// writer observes stale state.
458 ///
459 /// `#[serde(default)]` so a legacy `manifest.json` written before this
460 /// field existed deserializes with `applied_seq = 0`. Such a manifest
461 /// self-migrates on its next write: the catch-up replay re-folds the whole
462 /// log — every event a no-op, because legacy state was already projected
463 /// synchronously under the old append-then-apply path — and advances the
464 /// watermark to `last_seq`. No separate migration pass or schema bump is
465 /// required (the field is purely additive to a derived-cache file).
466 #[serde(default)]
467 pub applied_seq: u64,
468 /// Unique run identifier (ULID). Validated on read.
469 pub run_id: RunId,
470 /// Kind of work this run performs.
471 pub kind: Kind,
472 /// How-run state (autonomous vs interactive), set once at `run create` from
473 /// the explicit `--interactive` flag — never transitioned. See [`Lifecycle`].
474 pub lifecycle: Lifecycle,
475 /// Human-readable run title.
476 pub title: String,
477 /// Current aggregate run status.
478 pub status: Status,
479 /// When the run was created.
480 pub created_at: DateTime<Utc>,
481 /// When the manifest was last modified.
482 pub updated_at: DateTime<Utc>,
483 /// Source repository the run operates on, if any.
484 pub source_repo: Option<String>,
485 /// Branch the run was started from, if any.
486 pub source_branch: Option<String>,
487 /// Root directory under which this run's worktrees live, if any.
488 pub worktree_root: Option<String>,
489 /// tmux session orchestratectl created to host this run's headless windows
490 /// (`--headless` / `--tmux-session <name>`), if any. `None` for a foreground
491 /// run whose window lives in the user's own session — that session is never
492 /// a teardown target. When set, the supervisor kills this session once its
493 /// last orchestratectl-owned window is torn down and only the synthetic
494 /// bootstrap shell window remains, so an empty headless session is not left
495 /// behind (issue `headless-tmux-session-not-torn-down`). `#[serde(default)]`
496 /// keeps a manifest written before this field existed readable.
497 #[serde(default)]
498 pub managed_tmux_session: Option<String>,
499 /// Completion-notification command registered at `run create --notify`,
500 /// if any. When the run reaches a terminal state (`done | failed |
501 /// cancelled`) the supervisor runs this command (at-least-once, deduped on a
502 /// durable `run.notified` marker event — the healthy path fires once, a
503 /// crash between firing and recording may re-fire) with `OCTL_RUN_ID` /
504 /// `OCTL_STATUS` / `OCTL_SUMMARY` (and `OCTL_RUN_KIND` / `OCTL_RUN_TITLE`)
505 /// in its environment, BEFORE teardown removes the worktree/window. This is
506 /// how a spawning session learns of completion without polling (issue
507 /// `no-completion-notification-to-parent`). `None` for a run created without
508 /// `--notify`; `#[serde(default)]` keeps a manifest written before this
509 /// field existed readable.
510 #[serde(default)]
511 pub notify_cmd: Option<String>,
512 /// The agent runtime selected for this run's worker
513 /// (`claude` | `pi`), resolved at `run create`
514 /// via the flag > env > config > default precedence and recorded here as
515 /// provenance. This is the *selected* harness — recorded before the worker is
516 /// spawned, so it reflects intent even if the spawn later fails. `None` for a
517 /// manifest written before this field existed
518 /// (`#[serde(default)]`) — such legacy runs predate harness selection and
519 /// were all `claude`. Surfaced on `run show` / `run list --json`.
520 #[serde(default)]
521 pub harness: Option<String>,
522 /// Number of nodes created in this run (denormalized counter).
523 pub node_count: u32,
524 /// Run that spawned this run, if it is itself a child.
525 pub parent_run_id: Option<RunId>,
526 /// Node in the parent run that spawned this run, if any.
527 pub parent_node_id: Option<NodeId>,
528}
529
530/// `(child_run_id, child_node_id)` pointer recorded in `Node::children`.
531#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
532pub struct ChildRef {
533 /// Run id of the spawned child. Validated on read.
534 pub run_id: RunId,
535 /// Node id within the child run. Validated on read.
536 pub node_id: NodeId,
537}
538
539/// `nodes/<node-id>.json` (design.md §1.3).
540#[derive(Debug, Clone, Serialize, Deserialize)]
541pub struct Node {
542 /// State-schema version this file was written with.
543 pub schema_version: u32,
544 /// Unique node identifier within its run (e.g. `n-0001`). Validated on
545 /// read; this is the projection's filename key, so it can never name a
546 /// path outside `nodes/`.
547 pub node_id: NodeId,
548 /// Run this node belongs to. Validated on read.
549 pub run_id: RunId,
550 /// Parent node within the same run, if this is a sub-node.
551 pub parent_node_id: Option<NodeId>,
552 /// Kind of work this node performs.
553 pub kind: Kind,
554 /// Current node status.
555 pub status: Status,
556 /// Task description / prompt driving the node, if recorded.
557 pub task: Option<String>,
558 /// Filesystem path of the node's git worktree, if created.
559 pub worktree_path: Option<String>,
560 /// Git branch the node works on, if any.
561 pub branch: Option<String>,
562 /// The commit SHA the node's branch/worktree was forked from at spawn
563 /// (the branch tip the moment `create.sh` materialized the worktree). It
564 /// is the fixed reference point that lets the supervisor tell "this branch
565 /// produced work that merged into source" from "this branch never diverged
566 /// from its fork point": a branch still at `base_sha` is trivially an
567 /// ancestor of its source branch but has merged nothing, so it must NOT be
568 /// reconciled to success or torn down (that would drop a live agent's
569 /// uncommitted work). Only a branch whose tip has moved past `base_sha`
570 /// *and* is now an ancestor of the run's `source_branch` is a confirmed
571 /// merge (issues `false-failed-after-merge` /
572 /// `supervisor-stuck-pending-after-self-merge`). `#[serde(default)]` keeps a
573 /// node written before this field existed readable (`None` → the
574 /// git-reconcile fallback simply does not fire for it).
575 #[serde(default)]
576 pub base_sha: Option<String>,
577 /// tmux window hosting the node's agent, if interactive. This is the
578 /// human-readable window *name* — not unique across sessions and blind to
579 /// non-default sockets. Kept for display and as the legacy liveness key;
580 /// prefer [`Node::tmux_identity`] when present.
581 pub tmux_window: Option<String>,
582 /// Fully-qualified tmux identity (`session:window_id` + socket path)
583 /// captured at spawn time. `None` for nodes registered before create.sh
584 /// emitted the qualified fields — those fall back to bare-name matching on
585 /// [`Node::tmux_window`]. New spawns always populate this when create.sh
586 /// returns it.
587 #[serde(default)]
588 pub tmux_identity: Option<TmuxIdentity>,
589 /// PID of the running agent process, if live.
590 pub agent_pid: Option<i32>,
591 /// Start time of the agent process, used to detect PID reuse.
592 pub agent_pid_start_time: Option<DateTime<Utc>>,
593 /// PID of the supervisor watching this node, if live.
594 pub supervisor_pid: Option<i32>,
595 /// Children this node has spawned.
596 #[serde(default)]
597 pub children: Vec<ChildRef>,
598 /// When the node started executing, if it has.
599 pub started_at: Option<DateTime<Utc>>,
600 /// When the node file was last modified.
601 pub updated_at: DateTime<Utc>,
602 /// The `node.report` payload that drove this node to its terminal status.
603 /// Set only by the report that actually transitions the node (Done /
604 /// Failed / Cancelled). Once the node is terminal it is frozen: a late
605 /// report against an already-settled node is dropped without overwriting
606 /// this field (see `reducer::apply_node_report`). So for a node cancelled
607 /// by `run cancel`, this holds the synthesized cancel report, not a
608 /// later-arriving agent report — that payload remains only in
609 /// `events.jsonl`.
610 pub last_report: Option<Value>,
611 /// Highest report `seq` consumed per child run id, for idempotent
612 /// report processing across supervisor restarts.
613 #[serde(default)]
614 pub last_processed_report_seq_by_child: Map<String, Value>,
615 /// Number of times the supervisor has auto-retried this node after an
616 /// empty-handed `agent-died` (issue `autoretry-agent-died-worker`). The
617 /// DURABLE, restart-safe bound on the bounded-retry loop: each `node.retry`
618 /// event increments it, and the watchdog terminalizes the run `failed` once
619 /// it reaches `RETRY_MAX_ATTEMPTS`. `#[serde(default)]` keeps a node written
620 /// before this field existed readable (`0` — never retried).
621 #[serde(default)]
622 pub retry_attempts: u32,
623 /// The **told** exit status of the node's worker process, recorded durably by
624 /// the `run-worker` launcher shim (`crates/octl-cli/src/run_worker.rs`) when
625 /// it `wait()`s on the agent it wrapped. This is a *fact*, not an inference:
626 /// the supervisor consumes it via the typed outcome table instead of guessing
627 /// completion from pid/pane/activity proxies (design.md §2.1, issue
628 /// `thin-exit-status-launcher`). A non-zero code or a terminating signal is a
629 /// `failed` worker; `code == 0` with no `explicit-merge` transition is the
630 /// *finished-but-unmerged* case that must stay non-terminal (attention-
631 /// required), NOT be auto-failed. `None` until the shim records an exit — or
632 /// forever, for a worker never launched through the shim (the crash backstop
633 /// still covers that path). `#[serde(default)]` keeps a node written before
634 /// this field existed readable.
635 #[serde(default)]
636 pub worker_exit: Option<WorkerExit>,
637 /// The in-flight `run merge` transaction for this node, if one has been
638 /// STARTED but not yet completed. `run merge` records a `merge.started`
639 /// event (setting this field) BEFORE it mutates git, because the merge spans
640 /// two durability domains — git refs and the event log — and is not atomic
641 /// across them (design.md §2.1b / A2, issue `merge-transaction-recovery`). A
642 /// crash after the git merge but before the terminal `explicit-merge`
643 /// `node.report` would otherwise strand the work *merged in source* with *no
644 /// merge event* → a false `failed`.
645 ///
646 /// This field is the durable op-log record that lets recovery finish or
647 /// reject that ONE known transaction deterministically, by OID — never a
648 /// general branch-content heuristic. It is set by [`crate::MergeTxn`]-carrying
649 /// `merge.started`, and cleared when the transaction resolves: a terminal
650 /// `node.report` (the merge completed) or a `merge.aborted` (recovery found
651 /// the git mutation never landed). `#[serde(default)]` keeps a node written
652 /// before this field existed readable (`None` — no in-flight merge).
653 ///
654 /// Boxed so the (rare) in-flight transaction does not inflate every `Node` /
655 /// `ProjectionOp` by the full [`MergeTxn`] footprint.
656 #[serde(default)]
657 pub pending_merge: Option<Box<MergeTxn>>,
658 /// The durable, monotonic timestamp of the FIRST tick on which the supervisor
659 /// observed this node's worker process confirmed-dead with no told
660 /// `worker.exited` and no merge — the anchor for the residual crash
661 /// backstop's fixed post-death grace (design.md §2.1a, issue
662 /// `typed-supervisor-outcomes`).
663 ///
664 /// The backstop is the ONLY place pid liveness still governs an outcome
665 /// (pid liveness is a pure crash backstop now, never a primary signal). When
666 /// the launcher shim's exit fact is lost — a hard kill of the shim, host
667 /// death — the supervisor never sees a `worker.exited` event, so it falls
668 /// back to "process confirmed gone → `failed`". The grace exists only to let
669 /// an in-flight `worker.exited` / merge append land before that fires: on the
670 /// first confirmed death the supervisor records this timestamp (via a
671 /// `node.death_observed` event) and DEFERS; it terminalizes `failed` only on a
672 /// later tick once a fixed short window has elapsed AND an exclusive-lock
673 /// re-read confirms no exit/merge landed in the race window.
674 ///
675 /// Persisted (not in-memory) so the grace survives a supervisor restart in the
676 /// window — a restart re-reads it rather than restarting the clock. First-write
677 /// -wins in the reducer, so the anchor is monotonic. `None` until the first
678 /// confirmed-death observation, or forever for a worker that exits cleanly
679 /// (the shim records `worker.exited` and the backstop never engages).
680 /// `#[serde(default)]` keeps a node written before this field existed readable.
681 #[serde(default)]
682 pub first_death_at: Option<DateTime<Utc>>,
683 /// An open, agent-authored request for a human decision. The worker records
684 /// this through `node.awaiting_input` instead of blocking on interactive
685 /// stdin. It remains non-terminal and is cleared by `node.input_resolved`, a
686 /// terminal `node.report`, or `node.retry`.
687 ///
688 /// `opened_at` is stamped from the event envelope and is therefore a durable,
689 /// monotonic grace-window anchor that survives supervisor restarts. The
690 /// original discussion objects are retained verbatim so read surfaces and
691 /// notification hooks can carry the question, options, and recommended
692 /// default without inventing a second advisory schema.
693 #[serde(default)]
694 pub awaiting_input: Option<Box<AwaitingInput>>,
695}
696
697/// Durable open-discussion state projected from `node.awaiting_input`.
698#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
699pub struct AwaitingInput {
700 /// Timestamp of the first open signal in the current unresolved generation.
701 pub opened_at: DateTime<Utc>,
702 /// Event sequence that opened this generation, used to deduplicate its
703 /// delayed parent notification independently from later generations.
704 pub event_seq: u64,
705 /// Validated report-shaped discussion objects. Each carries `topic`,
706 /// `options`, and `recommended_default`.
707 pub discussion_items: Vec<Value>,
708}
709
710/// A durable, in-flight `run merge` transaction recorded by `merge.started`
711/// BEFORE the git mutation, and the sole input to deterministic merge-crash
712/// recovery (design.md §2.1b / A2, issue `merge-transaction-recovery`).
713///
714/// `run merge` spans git refs and the event log and is not atomic across them.
715/// Recording the transaction — the exact source ref it will move, the OID it
716/// expects that ref to be at (`expected_source_oid`, the compare half of the
717/// compare-and-swap), and the worker's tip — lets the supervisor (or a retried
718/// `run merge`) resolve the ONE recorded transaction by OID after a crash:
719///
720/// - source ref still at `expected_source_oid` → the mutation never landed →
721/// REJECT (`merge.aborted`), preserving the worker's branch + work.
722/// - source ref moved off `expected_source_oid` AND the worker's content is
723/// integrated (rebase-robust content verification) → COMPLETE (append the
724/// `explicit-merge` `node.report` the crash prevented).
725/// - source ref moved unexpectedly but the worker's content is not integrated →
726/// fail closed (REJECT), preserving the work.
727#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
728pub struct MergeTxn {
729 /// Opaque unique id for this merge attempt. A fresh id per `run merge`
730 /// invocation (each attempt re-reads `expected_source_oid`), so recovery can
731 /// name exactly which transaction it resolved in the `merge.aborted` audit.
732 pub op_id: String,
733 /// The source/target ref this merge moves — `manifest.source_branch`
734 /// (`main`, or an integration branch). Recovery reads this ref's current OID
735 /// to decide the transaction's fate.
736 pub source_branch: String,
737 /// The worker branch whose commits are being merged (`node.branch`). Its
738 /// content is what recovery verifies is integrated into `source_branch`.
739 pub worker_branch: String,
740 /// The OID `source_branch` was at when the transaction was recorded — the
741 /// compare half of the compare-and-swap. If the ref is still here at recovery
742 /// time, the git mutation never landed.
743 pub expected_source_oid: String,
744 /// The worker branch tip at record time. Retained for the audit trail and as
745 /// a secondary landing signal; the authoritative completion check is
746 /// content-based (rebase-robust) against `source_branch`.
747 pub worker_oid: String,
748 /// The worker branch's fork point (`node.base_sha`), used to bound the
749 /// content check to the worker's own commits. `None` when unrecorded.
750 #[serde(default)]
751 pub base_sha: Option<String>,
752 /// PID of the `run merge` process driving the transaction, so recovery can
753 /// tell a still-in-progress merge (driver alive — leave it) from a crashed
754 /// one (driver gone — resolve it), never racing a live merge. `None` when
755 /// unrecorded.
756 #[serde(default)]
757 pub driver_pid: Option<i32>,
758 /// Start time of `driver_pid` in Unix seconds (the same representation the
759 /// pid-file liveness check records), guarding against PID reuse the way the
760 /// agent/supervisor liveness checks do — a recycled PID must not look alive.
761 /// `None` when the platform could not read it.
762 #[serde(default)]
763 pub driver_pid_start_secs: Option<u64>,
764 /// When the transaction was recorded.
765 pub started_at: DateTime<Utc>,
766}
767
768/// The observed exit status of a node's worker process, recorded by the
769/// `run-worker` launcher shim under the run lock (design.md §2.1 / A1).
770///
771/// Exactly one of `code` / `signal` is meaningful: a worker that returned
772/// normally carries `code = Some(n)` (and `signal = None`); a worker killed by a
773/// signal carries `signal = Some(s)` (and, on Unix, `code = None`). A recorded
774/// exit is a durable *told fact* — the supervisor reads it rather than inferring
775/// completion from liveness proxies.
776#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
777pub struct WorkerExit {
778 /// Normal-exit status code, if the worker was not killed by a signal.
779 #[serde(default)]
780 pub code: Option<i32>,
781 /// Terminating signal number, if the worker was killed by a signal.
782 #[serde(default)]
783 pub signal: Option<i32>,
784 /// When the shim observed the worker's exit.
785 pub at: DateTime<Utc>,
786}
787
788impl WorkerExit {
789 /// A clean exit: not signalled, and a zero return code. This is the *only*
790 /// success-shaped worker exit — but a clean exit alone is NOT a completed
791 /// unit (the worker may have finished-but-skipped `run merge`); merge is the
792 /// only success truth (design.md §2.6). Callers pair this with a merge check.
793 pub fn is_clean(self) -> bool {
794 self.signal.is_none() && self.code == Some(0)
795 }
796
797 /// A failed worker: killed by a signal, or a non-zero return code. Mutually
798 /// exclusive with [`WorkerExit::is_clean`].
799 pub fn is_failure(self) -> bool {
800 !self.is_clean()
801 }
802}
803
804/// A fully-qualified tmux window identity recorded at spawn time.
805///
806/// `tmux_window` (the human name) is not unique across sessions, and a bare
807/// `tmux list-windows -a` cannot see windows on a non-default socket. This
808/// triple pins the exact window the agent runs in — `session:window_id` is
809/// unique per server, `window_id` (the `@NNNN` form) survives renames, and
810/// `socket` disambiguates multiple tmux servers. The watchdog matches on this
811/// when present (design.md §8.1).
812///
813/// `pane_id` (the `%NN` form) pins the agent's *specific* pane within that
814/// window, recorded at spawn. Window-owning operations (`kill-window` teardown —
815/// the supervisor owns the whole window per the cleanup invariants) key off
816/// `window_id`; only per-pane operations that must not follow the window's
817/// *active* pane — chiefly `pipe-pane` agent-log capture — use `pane_id`. It is
818/// `None` for a run spawned before create.sh emitted the field; capture then
819/// falls back to `window_id` (issue `capture-agent-pane-by-pane-id`).
820///
821/// The watchdog's liveness probe still keys off `window_id` (correct for the
822/// single-pane autonomous path). A pane-aware liveness probe — needed so a split
823/// interactive window whose agent pane dies while a user shell pane survives is
824/// still seen as dead — is a follow-up (`watchdog-pane-aware-liveness`), not this
825/// change.
826#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
827pub struct TmuxIdentity {
828 /// Server socket path (`#{socket_path}`). `None` if create.sh could not
829 /// read it; the watchdog then queries tmux on its default socket.
830 #[serde(default)]
831 pub socket: Option<String>,
832 /// Session that owns the window (`#{session_name}`).
833 pub session: String,
834 /// Stable window id in `@NNNN` form (`#{window_id}`). Survives renames and
835 /// is unique within the server.
836 pub window_id: String,
837 /// Stable pane id in `%NN` form (`#{pane_id}`), recorded at spawn — the
838 /// agent's own pane. `None` for a run whose create.sh predates the field
839 /// (back-compat: old state deserializes with `pane_id: None`). Prefer
840 /// [`TmuxIdentity::capture_target`] over reading this directly.
841 #[serde(default)]
842 pub pane_id: Option<String>,
843}
844
845impl TmuxIdentity {
846 /// The tmux target for a per-pane operation that must hit the agent's own
847 /// pane, not the window's *active* pane: the recorded `pane_id` when
848 /// present, else the `window_id` (which resolves to the active pane).
849 ///
850 /// Used by agent-log capture (`pipe-pane`). Window-level operations
851 /// (`kill-window`, liveness) must NOT use this — they key off `window_id`
852 /// directly so they act on the whole window.
853 ///
854 /// A recorded `pane_id` is preferred only when non-empty; an empty string
855 /// (a directly-deserialized/corrupt state that the reducer/spawn normalizers
856 /// never produce) is treated as absent so capture never targets `-t ""`.
857 pub fn capture_target(&self) -> &str {
858 self.pane_id
859 .as_deref()
860 .filter(|id| !id.is_empty())
861 .unwrap_or(&self.window_id)
862 }
863}
864
865/// One event-log line (design.md §1.4).
866///
867/// `run_id` / `node_id` are the typed id newtypes, so deserializing an
868/// `events.jsonl` line validates the whole envelope on read: a malformed
869/// `run_id` or `node_id` fails the `serde` parse at the read boundary (the
870/// id newtypes' validating `Deserialize`) rather than being carried as an
871/// unvalidated `String` until some later path helper. The parse failure
872/// surfaces as whatever error the reader maps a bad line to — e.g. a
873/// newline-terminated bad line is [`Error::CorruptEventLog`] from both
874/// [`read_all_events`] and [`find_prior_with_key`], which share one physical
875/// reader and torn-tail policy. The reducer still performs its own per-event
876/// checks (envelope `run_id` matches the run it is folded into; `data`-borne
877/// ids parse), but the envelope ids can no longer be the unvalidated party.
878///
879/// [`read_all_events`]: crate::events::read_all_events
880/// [`find_prior_with_key`]: crate::events
881/// [`Error::CorruptEventLog`]: crate::Error::CorruptEventLog
882#[derive(Debug, Clone, Serialize, Deserialize)]
883pub struct Event {
884 /// Wall-clock timestamp the event was appended.
885 pub ts: DateTime<Utc>,
886 /// Monotonic per-run sequence number (recovered on append).
887 pub seq: u64,
888 /// Event kind discriminator (e.g. `node.created`, `discussion.opened`).
889 pub kind: String,
890 /// Run the event belongs to. Validated on read.
891 pub run_id: RunId,
892 /// Node the event concerns, when applicable. Validated on read.
893 #[serde(skip_serializing_if = "Option::is_none", default)]
894 pub node_id: Option<NodeId>,
895 /// Caller-supplied key used to dedupe retried appends.
896 #[serde(skip_serializing_if = "Option::is_none", default)]
897 pub idempotency_key: Option<String>,
898 /// Kind-specific payload applied by the reducer.
899 #[serde(default)]
900 pub data: Value,
901}
902
903#[cfg(test)]
904mod tests {
905 use super::*;
906
907 #[test]
908 fn aggregate_terminal_status_is_the_three_way_rule() {
909 use Status::{Blocked, Cancelled, Done, Failed, Pending, Running};
910 // Empty set → not complete.
911 assert_eq!(aggregate_terminal_status([]), None);
912 // Any live node → not complete.
913 for live in [Pending, Running, Blocked] {
914 assert_eq!(aggregate_terminal_status([Done, live]), None);
915 }
916 // All done → Done.
917 assert_eq!(aggregate_terminal_status([Done, Done]), Some(Done));
918 // Any failure dominates.
919 assert_eq!(aggregate_terminal_status([Done, Failed]), Some(Failed));
920 assert_eq!(aggregate_terminal_status([Failed, Cancelled]), Some(Failed));
921 // Cancelled (no failure) — pure or mixed with done.
922 assert_eq!(
923 aggregate_terminal_status([Cancelled, Cancelled]),
924 Some(Cancelled)
925 );
926 assert_eq!(
927 aggregate_terminal_status([Done, Cancelled]),
928 Some(Cancelled)
929 );
930 }
931
932 /// `Kind::wire_name` (and thus `Kind::WIRE_NAMES`) must stay identical
933 /// to what serde actually (de)serializes. If the `rename_all` routing
934 /// or a variant name ever diverges from `wire_name`, this fails — which
935 /// is what keeps the report validator's `expected` hint honest.
936 #[test]
937 fn wire_names_match_serde_round_trip() {
938 for &name in Kind::WIRE_NAMES {
939 let kind: Kind = serde_json::from_value(Value::String(name.to_string()))
940 .unwrap_or_else(|_| panic!("WIRE_NAMES entry {name:?} is not a valid Kind"));
941 assert_eq!(
942 serde_json::to_value(kind).unwrap(),
943 Value::String(name.to_string()),
944 "serde round-trip diverged from wire_name for {name:?}",
945 );
946 }
947 }
948
949 /// The bounded auto-retry eligibility gate (issue `autoretry-agent-died-worker`)
950 /// must include exactly the autonomous single-node worker kinds and exclude
951 /// the fan-out driver (and the read-only `Unknown` catch-all).
952 #[test]
953 fn autonomous_single_node_worker_set_is_exact() {
954 for k in [Kind::Spinoff, Kind::Research, Kind::TechnicalDecision] {
955 assert!(
956 k.is_autonomous_single_node_worker(),
957 "{k:?} should be retry-eligible"
958 );
959 assert_eq!(k.lifecycle(), Lifecycle::Autonomous);
960 }
961 for k in [
962 Kind::FanOut, // multi-unit driver
963 Kind::Unknown, // legacy on-disk run — never freshly supervised
964 ] {
965 assert!(
966 !k.is_autonomous_single_node_worker(),
967 "{k:?} must NOT be retry-eligible"
968 );
969 }
970 }
971
972 /// A legacy run recorded under a since-removed kind must still deserialize
973 /// to the read-only [`Kind::Unknown`] catch-all rather than faulting the
974 /// read — the ADR §D7 "report, never delete" contract for the on-disk
975 /// evidence corpus. Every creatable kind still round-trips to itself.
976 #[test]
977 fn removed_kinds_deserialize_to_unknown() {
978 for removed in [
979 "code",
980 "orchestrate",
981 "orchestrated",
982 "bugfix",
983 "make-skill",
984 ] {
985 let kind: Kind = serde_json::from_value(Value::String(removed.to_string()))
986 .expect("a removed kind must still deserialize, not fault");
987 assert_eq!(kind, Kind::Unknown, "{removed:?} should map to Unknown");
988 }
989 // A wholly unknown value maps there too (forward-compat).
990 assert_eq!(
991 serde_json::from_value::<Kind>(Value::String("future-kind".into())).unwrap(),
992 Kind::Unknown
993 );
994 // The surviving kinds are unaffected.
995 for &name in Kind::WIRE_NAMES {
996 let kind: Kind = serde_json::from_value(Value::String(name.to_string())).unwrap();
997 assert_ne!(kind, Kind::Unknown, "{name:?} must not fold to Unknown");
998 }
999 }
1000
1001 /// Back-compat acceptance criterion (issue `capture-agent-pane-by-pane-id`):
1002 /// a `TmuxIdentity` persisted before `pane_id` existed — with the field
1003 /// entirely absent, or written as an explicit `null` — must still
1004 /// deserialize, yielding `pane_id: None` and a `window_id` capture target.
1005 #[test]
1006 fn tmux_identity_deserializes_legacy_state_without_pane_id() {
1007 // Field entirely absent (a state file written by an older binary).
1008 let absent: TmuxIdentity = serde_json::from_value(serde_json::json!({
1009 "socket": null,
1010 "session": "octl",
1011 "window_id": "@42",
1012 }))
1013 .expect("legacy identity without pane_id must deserialize");
1014 assert_eq!(absent.pane_id, None);
1015 assert_eq!(absent.capture_target(), "@42");
1016
1017 // Field present but explicitly null.
1018 let null: TmuxIdentity = serde_json::from_value(serde_json::json!({
1019 "socket": null,
1020 "session": "octl",
1021 "window_id": "@42",
1022 "pane_id": null,
1023 }))
1024 .expect("identity with explicit null pane_id must deserialize");
1025 assert_eq!(null.pane_id, None);
1026 assert_eq!(null.capture_target(), "@42");
1027 }
1028
1029 /// `capture_target` prefers a recorded `pane_id` (`%NN`) over the window id,
1030 /// but treats an empty `pane_id` as absent (never targets `-t ""`).
1031 #[test]
1032 fn capture_target_prefers_nonempty_pane_id() {
1033 let with_pane = TmuxIdentity {
1034 socket: None,
1035 session: "octl".into(),
1036 window_id: "@42".into(),
1037 pane_id: Some("%7".into()),
1038 };
1039 assert_eq!(with_pane.capture_target(), "%7");
1040
1041 let empty_pane = TmuxIdentity {
1042 pane_id: Some(String::new()),
1043 ..with_pane.clone()
1044 };
1045 assert_eq!(empty_pane.capture_target(), "@42");
1046 }
1047}
1048
1049#[cfg(test)]
1050mod id_tests {
1051 use super::*;
1052
1053 /// Inputs every id type must reject — the path-traversal vectors plus the
1054 /// generic malformed cases called out in the issue's success criteria.
1055 const TRAVERSAL_VECTORS: &[&str] = &[
1056 "..",
1057 "../etc",
1058 "a/b",
1059 "a/../b",
1060 ".hidden",
1061 "./x",
1062 "foo/bar.json",
1063 "n-0001/../../etc",
1064 "",
1065 ];
1066
1067 #[test]
1068 fn run_id_accepts_generator_output_and_rejects_malformed() {
1069 let id = crate::new_run_id();
1070 assert!(
1071 RunId::parse_str(&id).is_ok(),
1072 "generator must validate: {id}"
1073 );
1074 for bad in [
1075 "tooshort",
1076 "01jxsnap0000000000000000000", // 27 chars
1077 "01JXSNAP000000000000000000", // uppercase
1078 "01jxiiiiiiiiiiiiiiiiiiiiii", // `i` not in Crockford
1079 "80000000000000000000000000", // first char exceeds ULID range
1080 "n-0001", // wrong shape entirely
1081 ] {
1082 assert!(RunId::parse_str(bad).is_err(), "expected reject: {bad:?}");
1083 }
1084 for bad in TRAVERSAL_VECTORS {
1085 assert!(
1086 RunId::parse_str(bad).is_err(),
1087 "traversal not rejected: {bad:?}"
1088 );
1089 }
1090 }
1091
1092 #[test]
1093 fn node_id_accepts_canonical_and_rejects_malformed() {
1094 for ok in ["n-0001", "n-0010", "n-123456"] {
1095 assert!(NodeId::parse_str(ok).is_ok(), "expected accept: {ok}");
1096 }
1097 // Wrong prefix is its own error variant.
1098 assert!(matches!(
1099 NodeId::parse_str("d-0001"),
1100 Err(IdValidationError::WrongPrefix { .. })
1101 ));
1102 assert!(matches!(
1103 NodeId::parse_str("0001"),
1104 Err(IdValidationError::WrongPrefix { .. })
1105 ));
1106 for bad in [
1107 "n-1", // too few digits
1108 "n-abcd", // non-digit body
1109 "n-", // empty body
1110 "n-00a1", // mixed
1111 "n-00000000000", // 11 digits — over the 10-digit ceiling
1112 ] {
1113 assert!(
1114 matches!(
1115 NodeId::parse_str(bad),
1116 Err(IdValidationError::InvalidFormat { .. })
1117 ),
1118 "expected InvalidFormat: {bad:?}",
1119 );
1120 }
1121 for bad in TRAVERSAL_VECTORS {
1122 assert!(
1123 NodeId::parse_str(bad).is_err(),
1124 "traversal not rejected: {bad:?}"
1125 );
1126 }
1127 }
1128
1129 #[test]
1130 fn deserialize_rejects_malformed_ids() {
1131 // The validating Deserialize impl is the on-read guard: a tampered
1132 // projection file whose key no longer validates must fail to parse.
1133 assert!(serde_json::from_str::<NodeId>("\"n-0001\"").is_ok());
1134 assert!(serde_json::from_str::<NodeId>("\"../../etc\"").is_err());
1135 assert!(serde_json::from_str::<NodeId>("\"n-../escape\"").is_err());
1136 }
1137
1138 #[test]
1139 fn serialize_round_trips_as_bare_string() {
1140 let nid = NodeId::parse_str("n-0042").unwrap();
1141 let json = serde_json::to_string(&nid).unwrap();
1142 assert_eq!(json, "\"n-0042\"");
1143 let back: NodeId = serde_json::from_str(&json).unwrap();
1144 assert_eq!(back, nid);
1145 assert_eq!(nid.as_str(), "n-0042");
1146 assert_eq!(nid.to_string(), "n-0042");
1147 }
1148
1149 #[test]
1150 fn error_exposes_kind_and_expected() {
1151 let err = NodeId::parse_str("n-x").unwrap_err();
1152 assert_eq!(err.kind(), "node");
1153 assert_eq!(err.expected(), "n-NNNN (n- followed by 4-10 ASCII digits)");
1154 }
1155
1156 #[test]
1157 fn event_deserialize_validates_envelope_ids() {
1158 // The whole `events.jsonl` envelope is now validated on read: the
1159 // typed `run_id` / `node_id` fields parse through the id newtypes, so
1160 // a malformed envelope id fails the deserialize rather than being
1161 // carried downstream as an unchecked string.
1162 let ok = r#"{"ts":"2026-06-12T00:00:00Z","seq":1,"kind":"node.created","run_id":"01jxsnap000000000000000000","node_id":"n-0001","data":{}}"#;
1163 assert!(serde_json::from_str::<Event>(ok).is_ok());
1164
1165 // Invalid `run_id` (not a 26-char ULID) fails the parse.
1166 let bad_run = r#"{"ts":"2026-06-12T00:00:00Z","seq":1,"kind":"run.status","run_id":"not-a-ulid","data":{}}"#;
1167 assert!(serde_json::from_str::<Event>(bad_run).is_err());
1168
1169 // Invalid top-level `node_id` (too few digits) also fails the parse.
1170 let bad_node = r#"{"ts":"2026-06-12T00:00:00Z","seq":1,"kind":"node.status","run_id":"01jxsnap000000000000000000","node_id":"n-1","data":{}}"#;
1171 assert!(serde_json::from_str::<Event>(bad_node).is_err());
1172 }
1173
1174 #[test]
1175 fn from_str_and_ord_delegate_to_inner() {
1176 use std::str::FromStr;
1177 // `FromStr` mirrors `parse_str`, so the `str::parse` ecosystem works.
1178 assert!(RunId::from_str("01jxsnap000000000000000000").is_ok());
1179 assert!("n-0001".parse::<NodeId>().is_ok());
1180 assert!("n-x".parse::<NodeId>().is_err());
1181
1182 // `Ord` is lexicographic over the inner string; for ULIDs that is the
1183 // natural time-encoded order.
1184 let a = RunId::parse_str("01jxsnap000000000000000000").unwrap();
1185 let b = RunId::parse_str("02jxsnap000000000000000000").unwrap();
1186 assert!(a < b);
1187 let mut v = vec![b.clone(), a.clone()];
1188 v.sort();
1189 assert_eq!(v, vec![a, b]);
1190 }
1191}