Skip to main content

magi/
notices.rs

1//! Durable attention-report outbox, reconciled into task/run chats by
2//! [`crate::notice_delivery`]. Reports are facts to investigate, never decisions
3//! or owner authority. The compatibility list remains for deferred delivery.
4//!
5//! Keys name kind + subject, never prose. Repeats update evidence without
6//! another page; only a newer cause or severity escalation advances delivery.
7//! Chat drafts persist their receipt key atomically before outbox acknowledgement.
8//! Read/dismissed legacy history is never replayed, and pending unread records
9//! are never evicted by the history cap.
10
11use std::path::{Path, PathBuf};
12
13use anyhow::{Context, Result, bail};
14use jiff::Timestamp;
15use serde::{Deserialize, Serialize};
16
17/// On-disk format. A file is refused only when its own schema is *greater*
18/// than this one; every field added later must carry `#[serde(default)]`.
19pub const SCHEMA: u32 = 1;
20
21/// The history cap. Pending unread deliveries are exempt.
22pub const CAP: usize = 200;
23
24/// How serious a notice is. Ordered so a rise is a plain comparison.
25#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
26#[serde(rename_all = "lowercase")]
27pub enum Severity {
28    /// Worth knowing, nothing to do.
29    Info,
30    /// Something needs a look soon.
31    Warn,
32    /// Something failed and stays failed until someone acts.
33    Error,
34}
35
36/// Where a notice points, when it points anywhere.
37#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
38#[serde(tag = "kind", rename_all = "lowercase")]
39pub enum Link {
40    /// A run, by id.
41    Run {
42        /// The run id.
43        id: String,
44    },
45    /// A queued task, by id.
46    Task {
47        /// The task id.
48        id: String,
49    },
50    /// An external page, such as a pull request.
51    Url {
52        /// The address.
53        url: String,
54    },
55}
56
57/// One thing the operator should know.
58#[derive(Debug, Clone, Serialize, Deserialize)]
59pub struct Notice {
60    /// Stable file-name-safe id derived from [`Notice::key`].
61    pub id: String,
62    /// Deduplication key: kind and subject, never prose.
63    pub key: String,
64    /// How serious.
65    pub severity: Severity,
66    /// What happened.
67    pub message: String,
68    /// Where it points, when it points anywhere.
69    #[serde(default)]
70    pub link: Option<Link>,
71    /// First raised.
72    pub first_at: Timestamp,
73    /// Last raised.
74    pub last_at: Timestamp,
75    /// How many times this key was raised.
76    #[serde(default = "one")]
77    pub count: u32,
78    /// When it was marked read.
79    #[serde(default)]
80    pub read_at: Option<Timestamp>,
81    /// When it was dismissed; the tombstone.
82    #[serde(default)]
83    pub dismissed_at: Option<Timestamp>,
84    /// The task and run ids this notice is about. A question whose `run`
85    /// names one of them already pages the operator for the same cause.
86    #[serde(default)]
87    pub subjects: Vec<String>,
88    /// Run association when the display link points elsewhere (for example a PR).
89    #[serde(default)]
90    pub related_run: Option<String>,
91    /// The question that carries this notice as context, when it was filed
92    /// already read for that reason. Never a tombstone: a recurrence with a
93    /// newer cause or higher severity is unread again.
94    #[serde(default)]
95    pub covered_by: Option<String>,
96    /// When the cause this notice reports began (a task's `held_at`). A
97    /// question filed before it is about an older cause and does not cover
98    /// it; `None` keeps the broad coverage of notices without one.
99    #[serde(default)]
100    pub since: Option<Timestamp>,
101    /// Producer-defined cause identity (phase and immutable target), never prose.
102    #[serde(default)]
103    pub cause: Option<String>,
104    /// On-disk format version.
105    #[serde(default = "schema")]
106    pub schema: u32,
107    /// Persistent incarnation, so pruning history cannot reuse a chat receipt.
108    /// Legacy records keep their original receipt key.
109    #[serde(default)]
110    pub delivery_id: Option<String>,
111    /// Delivery generation, advanced only by the shared page decision.
112    #[serde(default = "one")]
113    pub generation: u32,
114    /// Last generation durably accepted by a chat.
115    #[serde(default)]
116    pub delivered: u32,
117}
118
119fn one() -> u32 {
120    1
121}
122
123fn schema() -> u32 {
124    SCHEMA
125}
126
127impl Notice {
128    /// A notice of `severity` for `key`.
129    pub fn new(severity: Severity, key: &str, message: impl Into<String>) -> Self {
130        let now = Timestamp::now();
131        Self {
132            id: id_of(key),
133            key: key.to_owned(),
134            severity,
135            message: message.into(),
136            link: None,
137            first_at: now,
138            last_at: now,
139            count: 1,
140            read_at: None,
141            dismissed_at: None,
142            subjects: Vec::new(),
143            related_run: None,
144            covered_by: None,
145            since: None,
146            cause: None,
147            schema: SCHEMA,
148            delivery_id: Some(format!("{now}-{:016x}", crate::rng::entropy())),
149            generation: 1,
150            delivered: 0,
151        }
152    }
153
154    /// Name the task / run ids this notice is about.
155    pub fn about<I, S>(mut self, subjects: I) -> Self
156    where
157        I: IntoIterator<Item = S>,
158        S: Into<String>,
159    {
160        self.subjects = subjects.into_iter().map(Into::into).collect();
161        self
162    }
163
164    /// Associate a run independently of the display link.
165    pub fn for_run(mut self, run: Option<String>) -> Self {
166        self.related_run = run;
167        self
168    }
169
170    /// An [`Severity::Info`] notice.
171    pub fn info(key: &str, message: impl Into<String>) -> Self {
172        Self::new(Severity::Info, key, message)
173    }
174
175    /// A [`Severity::Warn`] notice.
176    pub fn warn(key: &str, message: impl Into<String>) -> Self {
177        Self::new(Severity::Warn, key, message)
178    }
179
180    /// An [`Severity::Error`] notice.
181    pub fn error(key: &str, message: impl Into<String>) -> Self {
182        Self::new(Severity::Error, key, message)
183    }
184
185    /// Record when the reported cause began.
186    pub fn since(mut self, at: Option<Timestamp>) -> Self {
187        self.since = at;
188        self
189    }
190
191    /// Distinguish material producer state transitions without keying on wording.
192    pub fn cause(mut self, cause: impl Into<String>) -> Self {
193        self.cause = Some(cause.into());
194        self
195    }
196
197    /// Attach a link.
198    pub fn link(mut self, link: Link) -> Self {
199        self.link = Some(link);
200        self
201    }
202
203    /// Neither read nor dismissed.
204    pub fn unread(&self) -> bool {
205        self.read_at.is_none() && self.dismissed_at.is_none()
206    }
207
208    /// Fold a repeat into this notice. Wording updates evidence; a newer cause
209    /// or higher severity makes it unread and advances delivery.
210    ///
211    /// Returns whether this raise should page the operator: it relit the
212    /// notice (higher severity or newer cause) and no open question
213    /// already carries it. This is the only place that decides.
214    pub fn raise_again(&mut self, again: &Notice, now: Timestamp) -> bool {
215        self.count = self.count.saturating_add(1);
216        let previous_last_at = self.last_at;
217        self.last_at = now;
218        if again.link.is_some() {
219            self.link = again.link.clone();
220        }
221        if again.related_run.is_some() {
222            self.related_run = again.related_run.clone();
223        }
224        if !again.subjects.is_empty() {
225            self.subjects = again.subjects.clone();
226        }
227        let escalated = again.severity > self.severity;
228        // Legacy history lacks a cause timestamp. Only a cause that began
229        // after the saved raise is news; replaying that old failure is not.
230        // A previously covering question can also prove a new uncovered cause.
231        let newer_cause = match (self.since, again.since) {
232            (Some(old), Some(new)) => new > old,
233            (None, Some(new)) => {
234                new > previous_last_at || (self.covered_by.is_some() && again.covered_by.is_none())
235            }
236            _ => false,
237        };
238        self.since = self.since.max(again.since);
239        // Wording is evidence, never a reason to spend another agent turn.
240        let changed_cause = again
241            .cause
242            .as_ref()
243            .is_some_and(|cause| self.cause.as_ref() != Some(cause));
244        if again.cause.is_some() {
245            self.cause = again.cause.clone();
246        }
247        let relit = escalated || newer_cause || changed_cause;
248        self.message = again.message.clone();
249        if relit {
250            self.generation = self.generation.saturating_add(1);
251            self.severity = self.severity.max(again.severity);
252            self.read_at = None;
253            self.dismissed_at = None;
254            self.covered_by = None;
255        }
256        // A question already pages for this cause: keep the record, skip the
257        // second page. A higher severity is news the question did not carry.
258        if let Some(q) = &again.covered_by
259            && !escalated
260            && self.unread()
261        {
262            self.read_at = Some(now);
263            self.covered_by = Some(q.clone());
264        }
265        relit && self.covered_by.is_none()
266    }
267
268    /// Mark read, keeping the first read time.
269    pub fn mark_read(&mut self, now: Timestamp) {
270        if self.read_at.is_none() {
271            self.read_at = Some(now);
272        }
273    }
274
275    /// Tombstone: read and hidden from the list.
276    pub fn dismiss(&mut self, now: Timestamp) {
277        self.mark_read(now);
278        if self.dismissed_at.is_none() {
279            self.dismissed_at = Some(now);
280        }
281    }
282
283    /// Legacy exhausted-deputy warnings belong on the question card now.
284    /// Match only this retired namespace, not `deputy-turn:` failures.
285    fn obsolete(&self) -> bool {
286        self.key.starts_with("deputy:")
287    }
288
289    /// Whether this notice belongs in the notification centre and bell.
290    fn visible(&self) -> bool {
291        !self.obsolete() && self.dismissed_at.is_none()
292    }
293
294    /// Pruning order: obsolete, dismissed, read, then unread.
295    fn keep_rank(&self) -> u8 {
296        if self.obsolete() {
297            0
298        } else if self.dismissed_at.is_some() {
299            1
300        } else if self.read_at.is_some() {
301            2
302        } else {
303            3
304        }
305    }
306}
307
308/// A stable, file-name-safe id for a key: a readable slug plus FNV-1a of the
309/// whole key. Not `DefaultHasher`, whose output may change between builds and
310/// would strand every existing file's dedupe.
311pub fn id_of(key: &str) -> String {
312    let mut hash: u64 = 0xcbf2_9ce4_8422_2325;
313    for b in key.bytes() {
314        hash ^= u64::from(b);
315        hash = hash.wrapping_mul(0x0100_0000_01b3);
316    }
317    let slug: String = key
318        .chars()
319        .map(|c| {
320            if c.is_ascii_alphanumeric() {
321                c.to_ascii_lowercase()
322            } else {
323                '-'
324            }
325        })
326        .take(32)
327        .collect();
328    format!("{slug}-{hash:016x}")
329}
330
331/// Whether `id` could have come from [`id_of`]. Checked before any path is
332/// built from a request.
333fn valid_id(id: &str) -> bool {
334    !id.is_empty()
335        && id.len() <= 64
336        && id
337            .bytes()
338            .all(|b| b.is_ascii_lowercase() || b.is_ascii_digit() || b == b'-')
339}
340
341/// How long a caller waits for a notice's lock before proceeding without it.
342const LOCK_WAIT: std::time::Duration = std::time::Duration::from_secs(5);
343
344/// Age after which a lock file is taken to belong to a dead process.
345const LOCK_STALE: std::time::Duration = std::time::Duration::from_secs(10);
346
347/// Distinguishes temp files written by threads of one process.
348static TMP_SEQ: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0);
349
350/// A notice store on disk.
351#[derive(Debug, Clone)]
352pub struct Notices {
353    root: PathBuf,
354}
355
356impl Notices {
357    /// The operator's notices, `<home>/notifications`.
358    pub fn open() -> Self {
359        Self::at(crate::run::home().join("notifications"))
360    }
361
362    /// A store at an explicit root; tests use this.
363    pub fn at(root: PathBuf) -> Self {
364        Self { root }
365    }
366
367    /// Directory holding the notice files.
368    pub fn root(&self) -> &Path {
369        &self.root
370    }
371
372    fn path_of(&self, id: &str) -> PathBuf {
373        self.root.join(format!("{id}.json"))
374    }
375
376    fn put(&self, n: &Notice) -> Result<()> {
377        std::fs::create_dir_all(&self.root)
378            .with_context(|| format!("create {}", self.root.display()))?;
379        let body = serde_json::to_string_pretty(n).context("serialize notice")?;
380        let path = self.path_of(&n.id);
381        // Unique per write: two processes raising or marking the same notice
382        // must not share a temp file, or the second rename finds it gone.
383        let tmp = path.with_extension(format!(
384            "json.{}.{}.tmp",
385            std::process::id(),
386            TMP_SEQ.fetch_add(1, std::sync::atomic::Ordering::Relaxed)
387        ));
388        std::fs::write(&tmp, body).with_context(|| format!("write {}", tmp.display()))?;
389        if let Err(e) = std::fs::rename(&tmp, &path) {
390            let _ = std::fs::remove_file(&tmp);
391            return Err(e).with_context(|| format!("replace {}", path.display()));
392        }
393        Ok(())
394    }
395
396    /// Load one notice by id.
397    pub fn get(&self, id: &str) -> Result<Notice> {
398        if !valid_id(id) {
399            bail!("`{id}` is not a notification id");
400        }
401        read_path(&self.path_of(id))
402    }
403
404    /// Run a read-modify-write of one notice under its lock file.
405    ///
406    /// `magi serve`, `magi web` and the CLI all update the same files, and a
407    /// unique temp file only makes each write atomic - it does not stop one
408    /// process saving a stale read over another's newer raise. The lock is an
409    /// exclusive-create file beside the notice; a holder that died is broken
410    /// after [`LOCK_STALE`], and a caller that cannot get it in
411    /// [`LOCK_WAIT`] proceeds anyway rather than lose the notice.
412    fn locked<T>(&self, id: &str, f: impl FnOnce() -> Result<T>) -> Result<T> {
413        std::fs::create_dir_all(&self.root)
414            .with_context(|| format!("create {}", self.root.display()))?;
415        let lock = self.root.join(format!("{id}.lock"));
416        let start = std::time::Instant::now();
417        let retry = crate::lock_file::Retry::new(Some(start + LOCK_WAIT));
418        let mut held = false;
419        while start.elapsed() < LOCK_WAIT {
420            match retry.create(&lock) {
421                Ok(_) => {
422                    held = true;
423                    break;
424                }
425                Err(_) => {
426                    let stale = std::fs::metadata(&lock)
427                        .and_then(|m| m.modified())
428                        .ok()
429                        .and_then(|t| t.elapsed().ok())
430                        .is_some_and(|age| age > LOCK_STALE);
431                    if stale {
432                        let _ = std::fs::remove_file(&lock);
433                    } else {
434                        std::thread::sleep(std::time::Duration::from_millis(5));
435                    }
436                }
437            }
438        }
439        let out = f();
440        if held {
441            let _ = std::fs::remove_file(&lock);
442        }
443        out
444    }
445
446    /// File a notice, folding it into an existing one with the same key.
447    pub fn raise(&self, incoming: Notice) -> Result<Notice> {
448        self.raise_paged(incoming).map(|(n, _)| n)
449    }
450
451    /// File through the common page decision, including explicit-store producers.
452    pub fn raise_with(
453        &self,
454        mut incoming: Notice,
455        notify: &crate::config::Notify,
456    ) -> Result<Notice> {
457        if let Some(home) = self.root.parent()
458            && let Some(q) = covering_question(home, &incoming)
459        {
460            incoming.covered_by = Some(q);
461        }
462        let (notice, page) = self.raise_paged(incoming)?;
463        if page {
464            send_page(
465                Page {
466                    run: notice
467                        .related_run
468                        .clone()
469                        .or_else(|| match &notice.link {
470                            Some(Link::Run { id }) => Some(id.clone()),
471                            _ => None,
472                        })
473                        .unwrap_or_default(),
474                    summary: notice.message.clone(),
475                },
476                Some(notify.clone()),
477            );
478        }
479        Ok(notice)
480    }
481
482    /// [`Notices::raise`], also saying whether the raise should page.
483    pub fn raise_paged(&self, incoming: Notice) -> Result<(Notice, bool)> {
484        let out = self.locked(&incoming.id.clone(), || {
485            let now = Timestamp::now();
486            let (stored, page) = match read_path(&self.path_of(&incoming.id)) {
487                Ok(mut existing) => {
488                    let page = existing.raise_again(&incoming, now);
489                    (existing, page)
490                }
491                Err(_) => {
492                    let mut fresh = incoming;
493                    if fresh.covered_by.is_some() {
494                        fresh.read_at = Some(now);
495                    }
496                    let page = fresh.covered_by.is_none();
497                    (fresh, page)
498                }
499            };
500            self.put(&stored)?;
501            Ok((stored, page))
502        })?;
503        self.prune();
504        Ok(out)
505    }
506
507    /// Mark every unread notice about `subject` read, recording `question` as
508    /// the card that carries it. Best-effort per notice.
509    pub fn cover(&self, question: &crate::ask::Question) {
510        for n in self.all() {
511            if n.unread() && covers(question, &n) {
512                let _ = self.update(&n.id, |n| {
513                    // Re-checked under the lock: a newer cause may have
514                    // landed since `all()` read it.
515                    if n.unread() && covers(question, n) {
516                        n.mark_read(Timestamp::now());
517                        n.covered_by = Some(question.id.clone());
518                    }
519                });
520            }
521        }
522    }
523
524    /// Load, change and save one notice under its lock.
525    pub(crate) fn update(&self, id: &str, change: impl FnOnce(&mut Notice)) -> Result<Notice> {
526        if !valid_id(id) {
527            bail!("`{id}` is not a notification id");
528        }
529        self.locked(id, || {
530            let mut n = read_path(&self.path_of(id))?;
531            change(&mut n);
532            self.put(&n)?;
533            Ok(n)
534        })
535    }
536
537    /// Every notice on disk, unreadable files skipped, newest first.
538    pub(crate) fn all(&self) -> Vec<Notice> {
539        let mut all: Vec<Notice> = std::fs::read_dir(&self.root)
540            .into_iter()
541            .flatten()
542            .flatten()
543            .map(|e| e.path())
544            .filter(|p| p.extension().is_some_and(|x| x == "json"))
545            .filter_map(|p| read_path(&p).ok())
546            .collect();
547        all.sort_by(|a, b| b.last_at.cmp(&a.last_at).then_with(|| a.id.cmp(&b.id)));
548        all
549    }
550
551    /// What the bell lists: visible, current notices, newest first.
552    pub fn list(&self) -> Vec<Notice> {
553        self.all().into_iter().filter(Notice::visible).collect()
554    }
555
556    /// How many notices are unread.
557    pub fn count_unread(&self) -> usize {
558        self.list().iter().filter(|n| n.unread()).count()
559    }
560
561    /// Mark read, keeping the first read time.
562    pub fn mark_read(&self, id: &str) -> Result<Notice> {
563        let now = Timestamp::now();
564        self.update(id, |n| n.mark_read(now))
565    }
566
567    /// Mark every unread notice read; returns how many changed.
568    pub fn mark_all_read(&self) -> Result<usize> {
569        let now = Timestamp::now();
570        let mut changed = 0;
571        for n in self.list().into_iter().filter(Notice::unread) {
572            // Re-read under the lock: a raise since the scan may have made it
573            // a different, still-unread notice, which stays as it is.
574            let done = self.update(&n.id, |n| n.mark_read(now));
575            if done.is_ok() {
576                changed += 1;
577            }
578        }
579        Ok(changed)
580    }
581
582    /// Tombstone: read and hidden from the list.
583    pub fn dismiss(&self, id: &str) -> Result<Notice> {
584        let now = Timestamp::now();
585        self.update(id, |n| n.dismiss(now))
586    }
587
588    /// Keep at most [`CAP`] files. Best-effort.
589    fn prune(&self) {
590        let mut all = self.all();
591        if all.len() <= CAP {
592            return;
593        }
594        // Most worth keeping first; drop the tail.
595        all.sort_by(|a, b| {
596            b.keep_rank()
597                .cmp(&a.keep_rank())
598                .then_with(|| b.last_at.cmp(&a.last_at))
599        });
600        for n in all
601            .split_off(CAP)
602            .into_iter()
603            .filter(|n| n.obsolete() || !n.unread() || n.delivered >= n.generation)
604        {
605            let _ = std::fs::remove_file(self.path_of(&n.id));
606        }
607    }
608
609    /// Change token for the stream. Hashes every file's name and mtime, so a
610    /// prune or delete moves it as surely as a write does (a max-mtime would
611    /// not move when the newest file is not the one removed).
612    pub fn revision(&self) -> u64 {
613        use std::hash::{Hash as _, Hasher as _};
614        let mut entries: Vec<(std::ffi::OsString, u128)> = std::fs::read_dir(&self.root)
615            .into_iter()
616            .flatten()
617            .flatten()
618            .filter(|e| e.path().extension().is_some_and(|x| x == "json"))
619            .map(|e| {
620                let at = e
621                    .metadata()
622                    .and_then(|m| m.modified())
623                    .ok()
624                    .and_then(|t| t.duration_since(std::time::UNIX_EPOCH).ok())
625                    .map_or(0, |d| d.as_nanos());
626                (e.file_name(), at)
627            })
628            .collect();
629        if entries.is_empty() {
630            return 0;
631        }
632        entries.sort();
633        let mut h = std::collections::hash_map::DefaultHasher::new();
634        entries.hash(&mut h);
635        h.finish()
636    }
637}
638
639fn read_path(path: &Path) -> Result<Notice> {
640    let body = std::fs::read_to_string(path).with_context(|| format!("read {}", path.display()))?;
641    let n: Notice =
642        serde_json::from_str(&body).with_context(|| format!("parse {}", path.display()))?;
643    if n.schema > SCHEMA {
644        bail!(
645            "notice {} was written by a newer magi (schema {}, this build speaks up to {SCHEMA})",
646            n.id,
647            n.schema
648        );
649    }
650    Ok(n)
651}
652
653/// A non-empty optional detail, trimmed for display. Never rewrites saved prose.
654pub(crate) fn detail(value: Option<&str>) -> Option<&str> {
655    clean_text(value)
656}
657
658/// Short explanation of a CLI turn that produced no usable response.
659pub(crate) fn turn_status(code: Option<i32>, timed_out: bool, quota_exhausted: bool) -> String {
660    let mut parts = vec![exit_status(code)];
661    if timed_out {
662        parts.push("time limit reached".to_owned());
663    }
664    if quota_exhausted {
665        parts.push("quota exhausted".to_owned());
666    }
667    parts.join("; ")
668}
669
670/// A currently open registered question associated with this notice, if any.
671/// `covered_by` records historical deduplication, not current answerability.
672pub(crate) fn answerable_question(n: &Notice, questions: &crate::ask::Questions) -> Option<String> {
673    let direct = n.covered_by.as_deref().or_else(|| {
674        ["question:", "deputy-turn:", "repair-owner:", "action:"]
675            .iter()
676            .find_map(|prefix| n.key.strip_prefix(prefix))
677    });
678    let release = if direct.is_none() && n.key.starts_with("release-pr:") {
679        questions
680            .root()
681            .parent()
682            .and_then(|home| crate::release_watch::question_for_notice(home, &n.key))
683    } else {
684        None
685    };
686    let id = direct.or(release.as_deref())?;
687    questions
688        .get(id)
689        .ok()
690        .filter(|q| q.status.open())
691        .map(|q| q.id)
692}
693
694/// The notice for a run that ended Blocked, Stalled or Failed, if it did.
695///
696/// A parked run was only asked to stop, so it is not news. A run that left a
697/// pull request behind still is: the PR is waiting on someone. Keyed on the
698/// run with a message free of anything that varies between attempts.
699pub fn run_ended(state: &crate::run::RunState) -> Option<Notice> {
700    use crate::run::RunStatus;
701    let failed = matches!(
702        state.status,
703        RunStatus::Blocked | RunStatus::Stalled | RunStatus::Failed
704    );
705    (failed && !state.parked).then(|| {
706        Notice::error(
707            &format!("run:{}", state.id),
708            format!(
709                "Run {} ended {}. {}",
710                state.id,
711                state.status.as_str(),
712                run_cause(state)
713            ),
714        )
715        .link(Link::Run {
716            id: state.id.clone(),
717        })
718        .about([state.id.clone()])
719        .since(Some(
720            state
721                .passes
722                .last()
723                .map(|p| p.started_at)
724                .unwrap_or(state.created_at),
725        ))
726    })
727}
728
729/// The notice for a pull request that merged while checks were red.
730///
731/// Keyed on the run. `summary` names the repository, pull request and failing
732/// checks: with no notify command configured this is the only place the
733/// operator learns them. A run merges once, so the wording cannot churn.
734pub fn merged_red(run_id: &str, summary: &str) -> Notice {
735    Notice::warn(&format!("merged-red:{run_id}"), summary).link(Link::Run {
736        id: run_id.to_owned(),
737    })
738}
739
740/// Human-readable process status for operator-facing failure details.
741pub fn exit_status(code: Option<i32>) -> String {
742    match code {
743        Some(code) => format!("exit code {code}"),
744        None => "exit code unavailable".to_owned(),
745    }
746}
747
748/// Trims text and drops empty values or meaningless placeholder phrases like `"(no reason given)"`.
749pub fn clean_text(s: Option<&str>) -> Option<&str> {
750    s.map(str::trim)
751        .filter(|t| !t.is_empty() && *t != "(no reason given)" && *t != "(none)")
752}
753
754/// Formats a list of identifiers or items into human-readable comma-separated prose.
755/// Returns `None` if the list is empty or contains only blank entries.
756pub fn format_list<T: AsRef<str>>(items: &[T]) -> Option<String> {
757    let non_empty: Vec<&str> = items
758        .iter()
759        .map(|s| s.as_ref().trim())
760        .filter(|s| !s.is_empty())
761        .collect();
762    if non_empty.is_empty() {
763        None
764    } else {
765        Some(non_empty.join(", "))
766    }
767}
768
769/// Ensures a sentence ends with a single period and has no trailing whitespace.
770pub fn ensure_sentence(text: &str) -> String {
771    let trimmed = text.trim();
772    if trimmed.is_empty() {
773        return String::new();
774    }
775    let trimmed_dot = trimmed.trim_end_matches('.');
776    format!("{trimmed_dot}.")
777}
778
779/// The notice for a task the machine or its attempt budget has held, if it is.
780///
781/// Called from [`crate::queue::Queue::put`], which every task transition goes
782/// through, so a hold made anywhere - the loop, the conductor, triage, a
783/// dependency removed from under a blocked task - is announced. A hold the
784/// operator placed by hand is their own action and is not news. Keyed on the
785/// task, with wording free of anything that varies between retries.
786///
787/// Falls back to [`crate::queue::Task::last_error`] when `hold_reason` is
788/// empty, the same fallback `crate::triage`'s question detail uses: a record
789/// written before `Task::fail`/`Task::handed_off` started copying `why` into
790/// `hold_reason` too would otherwise still read "no reason recorded" even
791/// though the run said exactly why it stopped.
792pub fn task_held(task: &crate::queue::Task) -> Option<Notice> {
793    use crate::queue::{HoldSource, TaskStatus};
794    if task.status != TaskStatus::Held || task.hold_source != Some(HoldSource::Machine) {
795        return None;
796    }
797    let why = clean_text(task.hold_reason.as_deref())
798        .or_else(|| clean_text(task.last_error.as_deref()))
799        .unwrap_or("no reason recorded");
800    let why_sentence = why.trim_end_matches('.');
801    Some(
802        Notice::warn(
803            &format!("task:{}", task.id),
804            format!("Task {} is held: {why_sentence}.", task.short()),
805        )
806        .link(Link::Task {
807            id: task.id.clone(),
808        })
809        .about([task.id.clone()])
810        .since(task.held_at),
811    )
812}
813
814/// The notice for a conductor concern raised after explicit resumption without
815/// verified new blocking evidence.
816///
817/// Informational: preserves the task state without re-blocking on old evidence,
818/// explains that no state changed and no reply is required, and attaches a link
819/// to the task. Any proposed question text is omitted to avoid soliciting an
820/// answer to an unregistered question.
821pub fn conductor_resumption(
822    task_id: &str,
823    task_short: &str,
824    reason: Option<&str>,
825    blocked_by: &[String],
826    evidence: &[String],
827    has_question: bool,
828) -> Notice {
829    let mut parts: Vec<String> = Vec::new();
830    parts.push(format!(
831        "Conductor raised a concern for task {task_short} after explicit resumption, but its state was not changed because no verified new blocking evidence was found."
832    ));
833
834    if let Some(r) = clean_text(reason) {
835        parts.push(format!("Concern: {}.", r.trim_end_matches('.')));
836    }
837
838    if has_question {
839        parts.push("An unregistered question was proposed; no reply is required.".to_owned());
840    }
841
842    if let Some(deps) = format_list(blocked_by) {
843        parts.push(format!("Proposed dependencies: {deps}."));
844    }
845
846    if let Some(ev) = format_list(evidence) {
847        parts.push(format!("Cited evidence: {ev}."));
848    }
849
850    parts.push("Existing holds and questions still apply.".to_owned());
851    parts.push(
852        "No reply to this notice is needed. To hold this task, use manual hold via the queue."
853            .to_owned(),
854    );
855
856    Notice::warn(&format!("conductor-resumption:{task_id}"), parts.join(" "))
857        .link(Link::Task {
858            id: task_id.to_owned(),
859        })
860        .about([task_id.to_owned()])
861}
862
863/// The notice for a run whose graph returned an error before it settled.
864pub fn run_stopped(id: &str, state: &crate::run::RunState) -> Notice {
865    Notice::error(
866        &format!("run:{id}"),
867        format!("Run {} stopped with an error. {}", id, run_cause(state)),
868    )
869    .link(Link::Run { id: id.to_owned() })
870    .about([id.to_owned()])
871    .since(Some(
872        state
873            .passes
874            .last()
875            .map(|p| p.started_at)
876            .unwrap_or(state.created_at),
877    ))
878}
879
880/// Last recorded graph evidence; immediate errors are attached by the caller.
881fn run_cause(state: &crate::run::RunState) -> String {
882    let cause = state
883        .prep_failure
884        .as_deref()
885        .or_else(|| state.resource_block.as_ref().map(|b| b.detail.as_str()))
886        .or_else(|| {
887            state
888                .candidate_preservation
889                .values()
890                .next()
891                .map(String::as_str)
892        })
893        .or_else(|| state.events.last().map(|e| e.message.as_str()));
894    cause
895        .and_then(|s| s.lines().find(|line| !line.trim().is_empty()))
896        .unwrap_or("No cause recorded; inspect the run.")
897        .to_owned()
898}
899
900/// One page for the operator's `[notify]` command.
901#[derive(Debug, Clone, PartialEq, Eq)]
902pub struct Page {
903    /// The run id when the notice links to a run, else empty.
904    pub run: String,
905    /// The notice message.
906    pub summary: String,
907}
908
909/// Set once by `main`: until then no notice fires the command, so a unit or
910/// integration test that pins a home never reaches the operator's real config.
911static PAGER: std::sync::OnceLock<()> = std::sync::OnceLock::new();
912
913/// Let notices fire the `[notify]` command in this process.
914pub fn install_pager() {
915    let _ = PAGER.set(());
916}
917
918/// The production sender. Fire and forget on its own thread with its own
919/// runtime, so it works with or without an ambient one and never blocks the
920/// producer; `ask::notify_text` bounds the command by `NOTIFY_TIMEOUT`.
921/// `notify` is the producer's own config, else the machine layer's.
922fn send_page(page: Page, notify: Option<crate::config::Notify>) {
923    if PAGER.get().is_none() {
924        return;
925    }
926    let spawned = std::thread::Builder::new()
927        .name("notice-pager".into())
928        .spawn(move || {
929            let notify = notify.unwrap_or_else(machine_notify);
930            if notify.command.is_empty() {
931                return;
932            }
933            let rt = match tokio::runtime::Builder::new_current_thread()
934                .enable_all()
935                .build()
936            {
937                Ok(rt) => rt,
938                Err(e) => return tracing::warn!("could not page about a notification: {e:#}"),
939            };
940            if let Err(e) = rt.block_on(crate::ask::notify_text(&notify, &page.run, &page.summary))
941            {
942                tracing::warn!("could not page about a notification: {e:#}");
943            }
944        });
945    if let Err(e) = spawned {
946        tracing::warn!("could not page about a notification: {e:#}");
947    }
948}
949
950/// `[notify]` from the machine layer alone; a producer with no repo config
951/// cannot name a better one. Unreadable is no command, with a warning.
952fn machine_notify() -> crate::config::Notify {
953    let layers: Vec<PathBuf> = crate::config::Config::machine_layer()
954        .into_iter()
955        .filter(|p| p.is_file())
956        .collect();
957    match crate::config::Config::load_layers(&layers) {
958        Ok(c) => c.notify,
959        Err(e) => {
960            tracing::warn!("could not read [notify] for a notification: {e:#}");
961            Default::default()
962        }
963    }
964}
965
966/// The one function producers call. Best-effort by construction: a notice that
967/// cannot be filed is a `tracing::warn`, never a reason to fail the run, the
968/// loop or the request that wanted to mention it.
969pub fn raise(notice: Notice) {
970    if let Some(home) = crate::run::try_home() {
971        raise_in(&home, notice);
972    }
973}
974
975/// [`raise`] for a producer that already holds the repo's `[notify]`.
976pub fn raise_with(notice: Notice, notify: &crate::config::Notify) {
977    if let Some(home) = crate::run::try_home() {
978        raise_in_with(&home, notice, &|page| send_page(page, Some(notify.clone())));
979    }
980}
981
982/// Does open question `q` already page the operator for what `n` reports?
983///
984/// The cause is decided by what each side is about, not by when it happened:
985/// a conductor / triage question exists *because* its task is held, so it
986/// covers that task's hold and handover notices whenever it was filed; a
987/// question raised from inside a run (any other seat node) covers that run's
988/// ended / stopped notices and never a task hold. Exact match on
989/// `Question::run` (a task id for the former, a run id for the latter). The
990/// land approval and release questions are to-dos, not duplicates, and cover
991/// nothing.
992///
993/// A notice with a `since` (a task hold's start) is covered only by a question
994/// filed at or after it: one filed earlier is about an older cause, and
995/// letting it silence a new hold would hide a fresh failure behind a stale
996/// card. Missing a duplicate costs one extra page; hiding a failure costs the
997/// failure. A notice without `since` keeps the broad rule.
998pub fn covers(q: &crate::ask::Question, n: &Notice) -> bool {
999    // Delivery alone proves no relationship to a later failure in the same
1000    // run pass. Retired questions only retain coverage already recorded while
1001    // they were open; never infer a cause match from the run ID or pass start.
1002    let recorded_coverage =
1003        q.routed_chat.is_some() && n.covered_by.as_deref() == Some(q.id.as_str());
1004    if !(q.status.open() || recorded_coverage) || !n.subjects.contains(&q.run) {
1005        return false;
1006    }
1007    if n.since.is_some_and(|since| q.asked_at < since) {
1008        return false;
1009    }
1010    let about_task = n.key.starts_with("task:") || n.key.starts_with("handover:");
1011    let about_run = n.key.starts_with("run:");
1012    match q.node.as_str() {
1013        crate::bump::NOTICE_NODE | crate::land::APPROVAL_NODE => false,
1014        _ if q.run_names_task() => about_task,
1015        _ => about_run,
1016    }
1017}
1018
1019fn covering_question(home: &Path, n: &Notice) -> Option<String> {
1020    if n.subjects.is_empty() {
1021        return None;
1022    }
1023    crate::ask::Questions::at(home.join("questions"))
1024        .list()
1025        .into_iter()
1026        .find(|q| covers(q, n))
1027        .map(|q| q.id)
1028}
1029
1030/// A question was just filed for `run`: quiet the unread notices about it.
1031pub fn quiet_for(home: &Path, question: &crate::ask::Question) {
1032    Notices::at(home.join("notifications")).cover(question);
1033}
1034
1035/// [`raise`] into an explicit magi home, for callers that already carry one
1036/// (the janitor) and so must not reach for the process-global.
1037pub fn raise_in(home: &Path, notice: Notice) {
1038    raise_in_with(home, notice, &|page| send_page(page, None));
1039}
1040
1041/// [`raise_in`] with the pager injected. `send` is called only when the raise
1042/// should page (see [`Notice::raise_again`]); it must not block.
1043pub fn raise_in_with(home: &Path, mut notice: Notice, send: &dyn Fn(Page)) {
1044    if let Some(q) = covering_question(home, &notice) {
1045        notice.covered_by = Some(q);
1046    }
1047    match Notices::at(home.join("notifications")).raise_paged(notice) {
1048        Ok((n, true)) => send(Page {
1049            run: n
1050                .related_run
1051                .clone()
1052                .or_else(|| match &n.link {
1053                    Some(Link::Run { id }) => Some(id.clone()),
1054                    _ => None,
1055                })
1056                .unwrap_or_default(),
1057            summary: n.message.clone(),
1058        }),
1059        Ok(_) => {}
1060        Err(e) => tracing::warn!("could not file a notification: {e:#}"),
1061    }
1062}
1063
1064#[cfg(test)]
1065mod tests {
1066    use super::*;
1067
1068    #[test]
1069    fn notification_details_omit_blanks_and_explain_process_results() {
1070        assert_eq!(detail(None), None);
1071        assert_eq!(detail(Some(" \n\t")), None);
1072        assert_eq!(detail(Some(" concern ")), Some("concern"));
1073        assert_eq!(exit_status(Some(7)), "exit code 7");
1074        assert_eq!(exit_status(None), "exit code unavailable");
1075        assert_eq!(
1076            turn_status(None, true, true),
1077            "exit code unavailable; time limit reached; quota exhausted"
1078        );
1079        let mut task = held_task();
1080        task.hold_reason = Some("   ".into());
1081        task.last_error = Some(" failure recorded ".into());
1082        assert!(
1083            task_held(&task)
1084                .unwrap()
1085                .message
1086                .ends_with("failure recorded.")
1087        );
1088    }
1089
1090    #[test]
1091    fn resumption_notice_and_external_page_are_informational() {
1092        let dir = tempfile::tempdir().unwrap();
1093        let n = conductor_resumption(
1094            "t1",
1095            "t1",
1096            Some("Inspection remains a concern."),
1097            &["dep1".into(), " ".into()],
1098            &[],
1099            false,
1100        );
1101        assert!(n.message.contains("Concern: Inspection remains a concern."));
1102        assert!(n.message.contains("Proposed dependencies: dep1."));
1103        assert!(n.message.contains("its state was not changed"));
1104        assert!(
1105            n.message
1106                .contains("Existing holds and questions still apply")
1107        );
1108        assert!(n.message.contains("No reply to this notice is needed"));
1109        assert_eq!(n.link, Some(Link::Task { id: "t1".into() }));
1110        let sent = pages(dir.path(), n.clone());
1111        assert_eq!(sent[0].summary, n.message);
1112        assert!(pages(dir.path(), n).is_empty(), "repeat remains silent");
1113        let empty = conductor_resumption("t2", "t2", Some(" "), &[], &[], false);
1114        for absent in [
1115            "Concern:",
1116            "Proposed dependencies:",
1117            "Some(",
1118            "None",
1119            "[]",
1120            "question:",
1121            "evidence:",
1122            "?",
1123        ] {
1124            assert!(!empty.message.contains(absent), "{absent}");
1125        }
1126    }
1127
1128    #[test]
1129    fn only_currently_open_registered_questions_have_response_links() {
1130        let dir = tempfile::tempdir().unwrap();
1131        let q = ask(dir.path(), "t1", "conduct");
1132        let questions = crate::ask::Questions::at(dir.path().join("questions"));
1133        let mut n = Notice::warn("task:t1", "held");
1134        n.covered_by = Some(q.id.clone());
1135        assert_eq!(answerable_question(&n, &questions), Some(q.id.clone()));
1136        questions
1137            .update(&q.id, |q| {
1138                q.answer(crate::ask::Answer::Text("continue".into()))
1139            })
1140            .unwrap();
1141        assert_eq!(answerable_question(&n, &questions), None);
1142        let abandoned = ask(dir.path(), "t2", "conduct");
1143        let failure = Notice::warn(&format!("question:{}", abandoned.id), "delivery failed");
1144        assert_eq!(
1145            answerable_question(&failure, &questions),
1146            Some(abandoned.id.clone())
1147        );
1148        questions
1149            .update(&abandoned.id, |q| {
1150                q.abandon("run gone");
1151                Ok(())
1152            })
1153            .unwrap();
1154        assert_eq!(answerable_question(&failure, &questions), None);
1155        n.covered_by = Some("missing".into());
1156        assert_eq!(answerable_question(&n, &questions), None);
1157        assert_eq!(
1158            answerable_question(
1159                &conductor_resumption("t1", "t1", None, &[], &[], false),
1160                &questions
1161            ),
1162            None
1163        );
1164    }
1165
1166    #[test]
1167    fn legacy_deputy_warnings_are_hidden_without_hiding_other_namespaces() {
1168        let (_dir, s) = store();
1169        // No question lookup: these may belong to deleted or settled questions.
1170        for key in ["deputy:open", "deputy:answered", "deputy:deleted"] {
1171            s.raise(Notice::warn(key, "old exhausted warning")).unwrap();
1172        }
1173        let keys = ["deputy-turn:open", "deputyish:open", "deputy", "task:open"];
1174        for key in keys {
1175            s.raise(Notice::warn(key, "still relevant")).unwrap();
1176        }
1177        assert_eq!(s.list().len(), keys.len());
1178        assert_eq!(s.count_unread(), keys.len());
1179        assert!(s.list().iter().all(|n| keys.contains(&n.key.as_str())));
1180        assert_eq!(s.mark_all_read().unwrap(), keys.len());
1181        assert_eq!(s.count_unread(), 0);
1182        assert!(s.get(&id_of("deputy:open")).unwrap().unread());
1183    }
1184
1185    #[test]
1186    fn obsolete_deputy_warnings_are_pruned_before_current_notices() {
1187        let (_dir, s) = store();
1188        for i in 0..CAP {
1189            let id = s
1190                .raise(Notice::info(&format!("current:{i}"), "keep"))
1191                .unwrap()
1192                .id;
1193            s.dismiss(&id).unwrap();
1194        }
1195        // Even a newer unread legacy warning cannot evict a current tombstone.
1196        s.raise(Notice::warn("deputy:old", "obsolete")).unwrap();
1197        assert!(s.get(&id_of("deputy:old")).is_err());
1198        assert_eq!(s.all().len(), CAP);
1199        assert!(s.all().iter().all(|n| n.key.starts_with("current:")));
1200    }
1201
1202    #[test]
1203    fn process_exit_status_is_readable_even_without_a_code() {
1204        assert_eq!(exit_status(Some(1)), "exit code 1");
1205        assert_eq!(exit_status(None), "exit code unavailable");
1206    }
1207
1208    fn store() -> (tempfile::TempDir, Notices) {
1209        let dir = tempfile::tempdir().unwrap();
1210        let s = Notices::at(dir.path().join("notifications"));
1211        (dir, s)
1212    }
1213
1214    #[test]
1215    fn a_red_merge_notice_is_keyed_on_the_run_and_raised_once() {
1216        let (_d, s) = store();
1217        let n = merged_red("run-1", "Merged a/b PR #1 with red checks: x (u)");
1218        assert_eq!(n.key, "merged-red:run-1");
1219        assert_eq!(
1220            n.link,
1221            Some(Link::Run {
1222                id: "run-1".to_owned()
1223            })
1224        );
1225        s.raise(merged_red(
1226            "run-1",
1227            "Merged a/b PR #1 with red checks: x (u)",
1228        ))
1229        .unwrap();
1230        s.raise(merged_red(
1231            "run-1",
1232            "Merged a/b PR #1 with red checks: x (u)",
1233        ))
1234        .unwrap();
1235        assert_eq!(s.list().len(), 1);
1236    }
1237
1238    #[test]
1239    fn producer_cause_transitions_page_once_without_using_message_prose() {
1240        let (dir, store) = store();
1241        let sent = std::cell::RefCell::new(Vec::new());
1242        let raise = |cause: &str, message: &str| {
1243            raise_in_with(
1244                dir.path(),
1245                Notice::warn("release-pr:pr", message).cause(cause),
1246                &|p| sent.borrow_mut().push(p),
1247            )
1248        };
1249        raise("approval:h1", "approval is needed");
1250        let id = id_of("release-pr:pr");
1251        store.mark_read(&id).unwrap();
1252        raise("approval:h1", "approval wording updated");
1253        assert!(!store.get(&id).unwrap().unread());
1254        raise("merge-failed:h1", "merge refused");
1255        assert!(store.get(&id).unwrap().unread());
1256        assert_eq!(sent.borrow().len(), 2);
1257        assert_eq!(store.get(&id).unwrap().generation, 2);
1258        store.mark_read(&id).unwrap();
1259        raise("merge-failed:h1", "merge refusal wording updated");
1260        assert_eq!(sent.borrow().len(), 2);
1261        assert!(!store.get(&id).unwrap().unread());
1262    }
1263
1264    #[test]
1265    fn a_repeat_updates_evidence_without_relighting_it() {
1266        let now = Timestamp::now();
1267        let mut n = Notice::warn("task:1", "held");
1268        n.mark_read(now);
1269        n.raise_again(&Notice::warn("task:1", "held"), now);
1270        assert_eq!(n.count, 2);
1271        assert!(n.read_at.is_some(), "identical repeat stays read");
1272        n.raise_again(&Notice::warn("task:1", "held differently"), now);
1273        assert!(!n.unread());
1274        assert_eq!(n.message, "held differently");
1275    }
1276
1277    #[test]
1278    fn a_rise_in_severity_resurrects_a_dismissed_notice_but_a_repeat_does_not() {
1279        let now = Timestamp::now();
1280        let mut n = Notice::warn("task:x", "m");
1281        n.dismiss(now);
1282        n.raise_again(&Notice::warn("task:x", "m"), now);
1283        assert!(n.dismissed_at.is_some(), "tombstone holds");
1284        n.raise_again(&Notice::error("k", "m"), now);
1285        assert!(n.unread());
1286        assert_eq!(n.severity, Severity::Error);
1287        // Severity never falls on a repeat.
1288        n.raise_again(&Notice::info("k", "other"), now);
1289        assert_eq!(n.severity, Severity::Error);
1290    }
1291
1292    #[test]
1293    fn adding_link_on_repeat_updates_link_without_relighting_read_or_dismissed() {
1294        let now = Timestamp::now();
1295        // 1. Read notice
1296        let mut read_notice = Notice::warn("task:1", "held");
1297        read_notice.mark_read(now);
1298        let link_to_add = Link::Task { id: "1".to_owned() };
1299        let again = Notice::warn("task:1", "held").link(link_to_add.clone());
1300        let relit = read_notice.raise_again(&again, now);
1301        assert!(!relit, "link-only update must not page/relight");
1302        assert!(read_notice.read_at.is_some(), "read notice stays read");
1303        assert_eq!(read_notice.link, Some(link_to_add.clone()));
1304
1305        // 2. Dismissed notice
1306        let mut dismissed_notice = Notice::warn("task:2", "held");
1307        dismissed_notice.dismiss(now);
1308        let link_to_add_2 = Link::Task { id: "2".to_owned() };
1309        let again_2 = Notice::warn("task:2", "held").link(link_to_add_2.clone());
1310        let relit_2 = dismissed_notice.raise_again(&again_2, now);
1311        assert!(!relit_2, "link-only update must not page/relight");
1312        assert!(dismissed_notice.dismissed_at.is_some(), "tombstone holds");
1313        assert_eq!(dismissed_notice.link, Some(link_to_add_2));
1314    }
1315
1316    #[test]
1317    fn identical_raises_share_one_file() {
1318        let (_d, s) = store();
1319        for _ in 0..5 {
1320            s.raise(Notice::error("run:abc", "blocked")).unwrap();
1321        }
1322        let all = s.list();
1323        assert_eq!(all.len(), 1);
1324        assert_eq!(all[0].count, 5);
1325        assert_eq!(s.count_unread(), 1);
1326    }
1327
1328    #[test]
1329    fn transitions_persist_and_dismissed_leave_the_list() {
1330        let (_d, s) = store();
1331        let a = s.raise(Notice::info("a", "one")).unwrap();
1332        let b = s.raise(Notice::warn("b", "two")).unwrap();
1333        assert_eq!(s.count_unread(), 2);
1334        s.mark_read(&a.id).unwrap();
1335        assert_eq!(s.count_unread(), 1);
1336        s.dismiss(&b.id).unwrap();
1337        assert_eq!(s.count_unread(), 0);
1338        assert_eq!(s.list().len(), 1);
1339        s.raise(Notice::warn("b", "two")).unwrap();
1340        assert_eq!(
1341            s.list().len(),
1342            1,
1343            "a tombstone survives a same-message raise"
1344        );
1345        s.raise(Notice::info("c", "three")).unwrap();
1346        assert_eq!(s.mark_all_read().unwrap(), 1);
1347        assert_eq!(s.count_unread(), 0);
1348    }
1349
1350    #[test]
1351    fn the_list_is_newest_first() {
1352        let (_d, s) = store();
1353        let mut old = Notice::info("old", "old");
1354        old.last_at = "2020-01-01T00:00:00Z".parse().unwrap();
1355        s.put(&old).unwrap();
1356        s.raise(Notice::info("new", "new")).unwrap();
1357        let keys: Vec<_> = s.list().into_iter().map(|n| n.key).collect();
1358        assert_eq!(keys, ["new", "old"]);
1359    }
1360
1361    #[test]
1362    fn the_cap_prunes_dismissed_then_read_then_oldest() {
1363        let (_d, s) = store();
1364        let keep = s.raise(Notice::error("keep", "unread")).unwrap();
1365        let gone = s.raise(Notice::info("gone", "dismissed")).unwrap();
1366        s.dismiss(&gone.id).unwrap();
1367        for i in 0..CAP - 1 {
1368            s.raise(Notice::info(&format!("k{i}"), "x")).unwrap();
1369        }
1370        let files = std::fs::read_dir(s.root()).unwrap().count();
1371        assert_eq!(files, CAP);
1372        assert!(
1373            s.get(&keep.id).is_ok(),
1374            "an unread notice outlives a dismissed one"
1375        );
1376        assert!(s.get(&gone.id).is_err(), "the dismissed one went first");
1377    }
1378
1379    #[test]
1380    fn revision_moves_on_write_and_on_removal() {
1381        let (_d, s) = store();
1382        assert_eq!(s.revision(), 0);
1383        let a = s.raise(Notice::info("a", "m")).unwrap();
1384        let r1 = s.revision();
1385        assert_ne!(r1, 0);
1386        s.raise(Notice::info("b", "m")).unwrap();
1387        let r2 = s.revision();
1388        assert_ne!(r1, r2);
1389        std::fs::remove_file(s.path_of(&a.id)).unwrap();
1390        assert_ne!(s.revision(), r2);
1391    }
1392
1393    #[test]
1394    fn ids_are_stable_and_untrusted_ids_are_refused() {
1395        assert_eq!(id_of("run:1"), id_of("run:1"));
1396        assert_ne!(id_of("run:1"), id_of("run-1"));
1397        assert!(valid_id(&id_of("release-bump:20260101-abc")));
1398        let (_d, s) = store();
1399        for bad in ["", "../x", "a/b", "A", "x.json"] {
1400            assert!(s.get(bad).is_err(), "{bad}");
1401        }
1402    }
1403
1404    #[test]
1405    fn a_newer_schema_is_refused_and_an_older_reads() {
1406        let (_d, s) = store();
1407        let mut n = Notice::info("k", "m");
1408        n.schema = SCHEMA + 1;
1409        s.put(&n).unwrap();
1410        assert!(s.get(&n.id).is_err());
1411        let old = r#"{"id":"x-1","key":"x","severity":"warn","message":"m",
1412            "first_at":"2020-01-01T00:00:00Z","last_at":"2020-01-01T00:00:00Z"}"#;
1413        std::fs::write(s.path_of("x-1"), old).unwrap();
1414        assert_eq!(s.get("x-1").unwrap().count, 1);
1415    }
1416
1417    fn state(status: crate::run::RunStatus) -> crate::run::RunState {
1418        let mut st = crate::run::RunState::new(
1419            std::path::PathBuf::from("/repo"),
1420            "main".to_owned(),
1421            "abc1234def".to_owned(),
1422            "task".to_owned(),
1423            crate::config::Config::default(),
1424        );
1425        st.status = status;
1426        st
1427    }
1428
1429    #[test]
1430    fn a_run_that_ended_badly_is_news_unless_it_only_parked() {
1431        use crate::run::RunStatus;
1432        for bad in [RunStatus::Blocked, RunStatus::Stalled, RunStatus::Failed] {
1433            let st = state(bad);
1434            let n = run_ended(&st).expect("news");
1435            assert_eq!(n.key, format!("run:{}", st.id));
1436            assert_eq!(n.severity, Severity::Error);
1437        }
1438        assert!(run_ended(&state(RunStatus::Merged)).is_none());
1439        let mut parked = state(RunStatus::Stalled);
1440        parked.parked = true;
1441        assert!(run_ended(&parked).is_none());
1442    }
1443
1444    #[test]
1445    fn concurrent_writers_of_one_key_all_succeed() {
1446        let (_d, s) = store();
1447        let handles: Vec<_> = (0..8)
1448            .map(|_| {
1449                let s = s.clone();
1450                std::thread::spawn(move || {
1451                    for _ in 0..20 {
1452                        s.raise(Notice::warn("same", "m")).unwrap();
1453                    }
1454                })
1455            })
1456            .collect();
1457        for h in handles {
1458            h.join().unwrap();
1459        }
1460        assert_eq!(s.list().len(), 1);
1461        let stray = std::fs::read_dir(s.root())
1462            .unwrap()
1463            .flatten()
1464            .filter(|e| e.path().extension().is_some_and(|x| x == "tmp"))
1465            .count();
1466        assert_eq!(stray, 0);
1467    }
1468
1469    #[test]
1470    fn a_dead_holders_lock_is_broken_and_no_lock_is_left_behind() {
1471        let (_d, s) = store();
1472        let n = s.raise(Notice::info("k", "m")).unwrap();
1473        let lock = s.root().join(format!("{}.lock", n.id));
1474        std::fs::write(&lock, "").unwrap();
1475        let old = std::time::SystemTime::now() - std::time::Duration::from_secs(60);
1476        std::fs::File::options()
1477            .write(true)
1478            .open(&lock)
1479            .unwrap()
1480            .set_modified(old)
1481            .unwrap();
1482        s.mark_read(&n.id).unwrap();
1483        assert!(!lock.exists());
1484        assert!(s.get(&n.id).unwrap().read_at.is_some());
1485    }
1486
1487    #[test]
1488    fn only_a_machine_hold_is_a_task_notice() {
1489        let mut t = crate::queue::Task::new(
1490            "t".to_owned(),
1491            "do it".to_owned(),
1492            std::path::PathBuf::from("/repo"),
1493            crate::queue::Source::Human,
1494        );
1495        assert!(task_held(&t).is_none());
1496        t.hold_manual(None);
1497        assert!(task_held(&t).is_none(), "the operator's own hold");
1498        t.hold_machine(Some("missing blocker".to_owned()));
1499        let n = task_held(&t).expect("machine hold");
1500        assert_eq!(n.key, format!("task:{}", t.id));
1501        assert!(n.message.contains("missing blocker"));
1502    }
1503
1504    fn held_task() -> crate::queue::Task {
1505        let mut t = crate::queue::Task::new(
1506            "t".to_owned(),
1507            "do it".to_owned(),
1508            std::path::PathBuf::from("/repo"),
1509            crate::queue::Source::Human,
1510        );
1511        t.hold_machine(Some("branch b is checked out".to_owned()));
1512        t
1513    }
1514
1515    fn ask(home: &Path, run: &str, node: &str) -> crate::ask::Question {
1516        let mut q = crate::ask::Question::new(
1517            run.to_owned(),
1518            node.to_owned(),
1519            "conductor".to_owned(),
1520            "cannot resume".to_owned(),
1521            String::new(),
1522            Vec::new(),
1523        );
1524        crate::ask::Questions::at(home.join("questions"))
1525            .put(&mut q)
1526            .unwrap();
1527        q
1528    }
1529
1530    fn unread(home: &Path) -> usize {
1531        Notices::at(home.join("notifications")).count_unread()
1532    }
1533
1534    #[test]
1535    fn a_hold_with_an_open_question_for_the_task_pages_once() {
1536        let dir = tempfile::tempdir().unwrap();
1537        let mut t = held_task();
1538        let q = ask(dir.path(), &t.id, "conduct");
1539        crate::queue::Queue::at(dir.path().join("queue"))
1540            .put(&mut t)
1541            .unwrap();
1542        let s = Notices::at(dir.path().join("notifications"));
1543        assert_eq!(s.count_unread(), 0);
1544        let n = s.list().pop().expect("the record is kept");
1545        assert_eq!(n.covered_by.as_deref(), Some(q.id.as_str()));
1546        assert!(n.message.contains("checked out"));
1547    }
1548
1549    #[test]
1550    fn a_refused_handover_without_a_question_pages_once() {
1551        let dir = tempfile::tempdir().unwrap();
1552        let q = crate::queue::Queue::at(dir.path().join("queue"));
1553        let mut t = held_task();
1554        t.hold_for_handover(Some("magi/x/A".to_owned()), "checked out".to_owned());
1555        q.put(&mut t).unwrap();
1556        q.put(&mut t).unwrap();
1557        let s = Notices::at(dir.path().join("notifications"));
1558        assert_eq!(s.list().len(), 1);
1559        assert_eq!(s.list()[0].key, format!("task:{}", t.id));
1560        assert_eq!(s.count_unread(), 1);
1561    }
1562
1563    #[test]
1564    fn an_older_question_does_not_silence_a_new_hold() {
1565        for node in ["deps", "conduct", "triage"] {
1566            let dir = tempfile::tempdir().unwrap();
1567            let mut t = crate::queue::Task::new(
1568                "t".to_owned(),
1569                "do it".to_owned(),
1570                std::path::PathBuf::from("/repo"),
1571                crate::queue::Source::Human,
1572            );
1573            let old = ask(dir.path(), &t.id, node);
1574            std::thread::sleep(std::time::Duration::from_millis(5));
1575            t.hold_machine(Some("new failure".to_owned()));
1576            crate::queue::Queue::at(dir.path().join("queue"))
1577                .put(&mut t)
1578                .unwrap();
1579            let s = Notices::at(dir.path().join("notifications"));
1580            let n = s.list().pop().unwrap();
1581            assert_eq!(n.covered_by, None, "{node} question {}", old.id);
1582            assert_eq!(s.count_unread(), 1);
1583        }
1584    }
1585
1586    #[test]
1587    fn a_legacy_covered_notice_pages_for_a_new_uncovered_hold() {
1588        let (_d, s) = store();
1589        let mut legacy = Notice::warn("task:x", "held");
1590        legacy.covered_by = Some("q1".to_owned());
1591        let id = legacy.id.clone();
1592        s.raise(legacy).unwrap();
1593        assert!(!s.get(&id).unwrap().unread());
1594        s.raise(Notice::warn("task:x", "held").since(Some(Timestamp::now())))
1595            .unwrap();
1596        let n = s.get(&id).unwrap();
1597        assert!(n.unread());
1598        assert_eq!(n.covered_by, None);
1599    }
1600
1601    #[test]
1602    fn a_newer_cause_relights_a_dismissed_notice() {
1603        let (_d, s) = store();
1604        let t0 = Timestamp::now();
1605        let first = Notice::warn("task:x", "held").since(Some(t0));
1606        let id = first.id.clone();
1607        s.raise(first).unwrap();
1608        s.dismiss(&id).unwrap();
1609        s.raise(Notice::warn("task:x", "held").since(Some(t0)))
1610            .unwrap();
1611        assert!(!s.get(&id).unwrap().unread(), "same cause stays dismissed");
1612        let later = t0 + std::time::Duration::from_secs(1);
1613        s.raise(Notice::warn("task:x", "held").since(Some(later)))
1614            .unwrap();
1615        assert!(s.get(&id).unwrap().unread());
1616    }
1617
1618    #[test]
1619    fn a_hold_with_no_question_still_notifies() {
1620        let dir = tempfile::tempdir().unwrap();
1621        let mut t = held_task();
1622        crate::queue::Queue::at(dir.path().join("queue"))
1623            .put(&mut t)
1624            .unwrap();
1625        assert_eq!(unread(dir.path()), 1);
1626    }
1627
1628    #[test]
1629    fn a_question_for_another_task_does_not_suppress() {
1630        let dir = tempfile::tempdir().unwrap();
1631        let mut t = held_task();
1632        ask(dir.path(), "some-other-task", "conduct");
1633        crate::queue::Queue::at(dir.path().join("queue"))
1634            .put(&mut t)
1635            .unwrap();
1636        assert_eq!(unread(dir.path()), 1);
1637    }
1638
1639    #[test]
1640    fn a_question_filed_after_the_hold_quiets_it_once() {
1641        let dir = tempfile::tempdir().unwrap();
1642        let mut t = held_task();
1643        crate::queue::Queue::at(dir.path().join("queue"))
1644            .put(&mut t)
1645            .unwrap();
1646        assert_eq!(unread(dir.path()), 1);
1647        let q = ask(dir.path(), &t.id, "conduct");
1648        assert_eq!(unread(dir.path()), 0);
1649        // A later update of the same question does not run the hook again.
1650        let s = Notices::at(dir.path().join("notifications"));
1651        let id = s.list()[0].id.clone();
1652        s.update(&id, |n| n.read_at = None).unwrap();
1653        let mut again = crate::ask::Questions::at(dir.path().join("questions"))
1654            .get(&q.id)
1655            .unwrap();
1656        crate::ask::Questions::at(dir.path().join("questions"))
1657            .put(&mut again)
1658            .unwrap();
1659        assert_eq!(unread(dir.path()), 1);
1660    }
1661
1662    #[test]
1663    fn a_blocked_run_with_an_open_question_is_quiet() {
1664        let dir = tempfile::tempdir().unwrap();
1665        ask(dir.path(), "run-1", "implement");
1666        raise_in(
1667            dir.path(),
1668            Notice::error("run:run-1", "Run r ended blocked.").about(["run-1"]),
1669        );
1670        assert_eq!(unread(dir.path()), 0);
1671        raise_in(
1672            dir.path(),
1673            Notice::error("run:run-2", "Run r ended blocked.").about(["run-2"]),
1674        );
1675        assert_eq!(unread(dir.path()), 1);
1676    }
1677
1678    #[test]
1679    fn escalation_makes_a_covered_notice_unread_again() {
1680        let dir = tempfile::tempdir().unwrap();
1681        ask(dir.path(), "t1", "conduct");
1682        raise_in(dir.path(), Notice::warn("task:t1", "held").about(["t1"]));
1683        assert_eq!(unread(dir.path()), 0);
1684        raise_in(dir.path(), Notice::error("task:t1", "held").about(["t1"]));
1685        assert_eq!(unread(dir.path()), 1);
1686    }
1687
1688    #[test]
1689    fn covers_matches_run_exactly_and_ignores_release_questions() {
1690        let dir = tempfile::tempdir().unwrap();
1691        let n = Notice::warn("task:x", "m").about(["t1"]);
1692        let q = ask(dir.path(), "t1", "conduct");
1693        assert!(covers(&q, &n));
1694        assert!(!covers(&q, &Notice::warn("task:x", "m")));
1695        assert!(!covers(&q, &Notice::warn("task:x", "m").about(["t"])));
1696        let release = ask(dir.path(), "t1", crate::bump::NOTICE_NODE);
1697        assert!(!covers(&release, &n));
1698    }
1699
1700    #[test]
1701    fn a_run_question_does_not_swallow_a_task_hold_and_vice_versa() {
1702        let dir = tempfile::tempdir().unwrap();
1703        ask(dir.path(), "t1", "implement");
1704        raise_in(dir.path(), Notice::warn("task:t1", "held").about(["t1"]));
1705        assert_eq!(unread(dir.path()), 1);
1706        ask(dir.path(), "r1", "conduct");
1707        raise_in(dir.path(), Notice::error("run:r1", "ended").about(["r1"]));
1708        assert_eq!(unread(dir.path()), 2);
1709    }
1710
1711    #[test]
1712    fn a_conduct_question_covers_the_hold_however_late_it_was_filed() {
1713        let dir = tempfile::tempdir().unwrap();
1714        let mut q = crate::ask::Question::new(
1715            "t1".to_owned(),
1716            "conduct".to_owned(),
1717            "conductor".to_owned(),
1718            "s".to_owned(),
1719            String::new(),
1720            Vec::new(),
1721        );
1722        q.asked_at = Timestamp::from_second(Timestamp::now().as_second() - 3600).unwrap();
1723        crate::ask::Questions::at(dir.path().join("questions"))
1724            .put(&mut q)
1725            .unwrap();
1726        raise_in(dir.path(), Notice::warn("task:t1", "held").about(["t1"]));
1727        assert_eq!(unread(dir.path()), 0);
1728    }
1729
1730    fn pages(home: &Path, n: Notice) -> Vec<Page> {
1731        let sent = std::cell::RefCell::new(Vec::new());
1732        raise_in_with(home, n, &|p| sent.borrow_mut().push(p));
1733        sent.into_inner()
1734    }
1735
1736    #[test]
1737    fn a_page_fires_on_new_causes_and_escalation_only() {
1738        let dir = tempfile::tempdir().unwrap();
1739        let h = dir.path();
1740        let n = || Notice::warn("run:p1", "stopped").link(Link::Run { id: "p1".into() });
1741        let first = pages(h, n());
1742        assert_eq!(
1743            first,
1744            vec![Page {
1745                run: "p1".into(),
1746                summary: "stopped".into()
1747            }]
1748        );
1749        assert!(pages(h, n()).is_empty(), "identical re-raise is silent");
1750        assert!(pages(h, Notice::warn("run:p1", "stopped again")).is_empty());
1751        assert_eq!(pages(h, Notice::error("run:p1", "stopped again")).len(), 1);
1752        assert!(pages(h, Notice::error("run:p1", "stopped again")).is_empty());
1753    }
1754
1755    #[test]
1756    fn a_non_run_link_leaves_run_empty() {
1757        let dir = tempfile::tempdir().unwrap();
1758        let n = Notice::warn("task:t1", "held").link(Link::Task { id: "t1".into() });
1759        assert_eq!(pages(dir.path(), n)[0].run, "");
1760    }
1761
1762    #[test]
1763    fn a_dismissed_tombstone_ignores_wording_changes() {
1764        let dir = tempfile::tempdir().unwrap();
1765        let h = dir.path();
1766        pages(h, Notice::warn("disk:r", "low"));
1767        Notices::at(h.join("notifications"))
1768            .dismiss(&id_of("disk:r"))
1769            .unwrap();
1770        assert!(pages(h, Notice::warn("disk:r", "low")).is_empty());
1771        assert!(pages(h, Notice::warn("disk:r", "lower")).is_empty());
1772    }
1773
1774    #[test]
1775    fn a_newer_cause_pages_again() {
1776        let dir = tempfile::tempdir().unwrap();
1777        let h = dir.path();
1778        let at = |s: i64| Some(Timestamp::from_second(s).unwrap());
1779        let n = |s| Notice::warn("task:t2", "held").since(at(s));
1780        assert_eq!(pages(h, n(100)).len(), 1);
1781        assert!(pages(h, n(100)).is_empty());
1782        assert_eq!(pages(h, n(200)).len(), 1);
1783    }
1784
1785    #[test]
1786    fn a_covered_notice_does_not_page() {
1787        let dir = tempfile::tempdir().unwrap();
1788        let h = dir.path();
1789        let q = ask(h, "r9", "implement");
1790        let n = || Notice::error("run:r9", "ended").about(["r9".to_owned()]);
1791        assert!(pages(h, n()).is_empty());
1792        let stored = Notices::at(h.join("notifications"))
1793            .get(&id_of("run:r9"))
1794            .unwrap();
1795        assert_eq!(stored.covered_by.as_deref(), Some(q.id.as_str()));
1796        assert!(pages(h, n()).is_empty());
1797    }
1798
1799    #[test]
1800    fn a_failing_sender_path_never_propagates() {
1801        // A pager that cannot run its command only warns.
1802        let notify = crate::config::Notify {
1803            command: vec!["magi-no-such-program-xyz".into()],
1804        };
1805        let rt = tokio::runtime::Builder::new_current_thread()
1806            .enable_all()
1807            .build()
1808            .unwrap();
1809        let r = rt.block_on(crate::ask::notify_text(&notify, "", "x"));
1810        assert!(r.is_err());
1811        // `send_page` without an installed pager is a no-op and cannot panic.
1812        send_page(
1813            Page {
1814                run: String::new(),
1815                summary: "x".into(),
1816            },
1817            Some(notify),
1818        );
1819    }
1820
1821    #[test]
1822    fn formatting_helpers_clean_text_and_lists() {
1823        assert_eq!(clean_text(None), None);
1824        assert_eq!(clean_text(Some("")), None);
1825        assert_eq!(clean_text(Some("   ")), None);
1826        assert_eq!(clean_text(Some("(no reason given)")), None);
1827        assert_eq!(clean_text(Some("(none)")), None);
1828        assert_eq!(clean_text(Some("  real reason  ")), Some("real reason"));
1829
1830        let empty: Vec<String> = Vec::new();
1831        assert_eq!(format_list(&empty), None);
1832        assert_eq!(format_list(&["", "  "]), None);
1833        assert_eq!(format_list(&["task-1"]), Some("task-1".into()));
1834        assert_eq!(format_list(&["a", "b", "c"]), Some("a, b, c".into()));
1835
1836        assert_eq!(ensure_sentence(""), "");
1837        assert_eq!(ensure_sentence("hello"), "hello.");
1838        assert_eq!(ensure_sentence("hello."), "hello.");
1839        assert_eq!(ensure_sentence("hello.."), "hello.");
1840    }
1841
1842    #[test]
1843    fn conductor_resumption_notice_is_readable_and_non_soliciting() {
1844        let task_id = "20261017-000000-abcd";
1845        let task_short = "abcd";
1846        let reason = "awaiting manual review";
1847        let blocked_by = vec!["dep-1".to_owned(), "dep-2".to_owned()];
1848        let evidence = vec!["check-failed".to_owned()];
1849        let has_question = true;
1850
1851        let notice = conductor_resumption(
1852            task_id,
1853            task_short,
1854            Some(reason),
1855            &blocked_by,
1856            &evidence,
1857            has_question,
1858        );
1859
1860        assert_eq!(notice.key, format!("conductor-resumption:{task_id}"));
1861        assert_eq!(notice.severity, Severity::Warn);
1862        assert_eq!(
1863            notice.link,
1864            Some(Link::Task {
1865                id: task_id.to_owned()
1866            })
1867        );
1868        assert_eq!(notice.subjects, vec![task_id.to_owned()]);
1869
1870        let msg = &notice.message;
1871        // Contains concise understandable prose explaining what happened
1872        assert!(msg.contains("Conductor raised a concern for task abcd after explicit resumption"));
1873        assert!(msg.contains("Concern: awaiting manual review."));
1874        assert!(msg.contains("Proposed dependencies: dep-1, dep-2."));
1875        assert!(msg.contains("Cited evidence: check-failed."));
1876        // Explicitly clarifies that no reply is required
1877        assert!(msg.contains("No reply to this notice is needed."));
1878        // No raw Debug formatting or dumped structures
1879        assert!(!msg.contains("Some("));
1880        assert!(!msg.contains("None"));
1881        assert!(!msg.contains("[]"));
1882        assert!(!msg.contains("{:?}"));
1883    }
1884
1885    #[test]
1886    fn conductor_resumption_notice_omits_empty_details() {
1887        let task_id = "20261017-000000-abcd";
1888        let notice = conductor_resumption(task_id, "abcd", None, &[], &[], false);
1889
1890        let msg = &notice.message;
1891        assert!(!msg.contains("Concern:"));
1892        assert!(!msg.contains("Proposed dependencies:"));
1893        assert!(!msg.contains("Cited evidence:"));
1894        assert!(!msg.contains("unregistered question"));
1895        assert!(!msg.contains("None"));
1896        assert!(!msg.contains("[]"));
1897        assert!(msg.contains("No reply to this notice is needed."));
1898    }
1899}