|
| 1 | +//! The text a bot reads when a message arrives (spec 9.3). The first line |
| 2 | +//! always says who sent it; bots are told so in their rules. |
| 3 | +
|
| 4 | +use crate::protocol::{MessageKind, Task}; |
| 5 | + |
| 6 | +/// Who the first line names. |
| 7 | +#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| 8 | +pub enum Sender<'a> { |
| 9 | + Owner, |
| 10 | + Bot { |
| 11 | + handle: &'a str, |
| 12 | + }, |
| 13 | + /// The daemon, e.g. to say a task expired. |
| 14 | + Botloft, |
| 15 | +} |
| 16 | + |
| 17 | +#[derive(Debug, Clone, Copy)] |
| 18 | +pub struct Envelope<'a> { |
| 19 | + pub from: Sender<'a>, |
| 20 | + /// Display name of the crew. |
| 21 | + pub crew: &'a str, |
| 22 | + pub kind: MessageKind, |
| 23 | + /// The task a `task`, `result` or `system` message is about. |
| 24 | + pub task: Option<&'a Task>, |
| 25 | + pub body: &'a str, |
| 26 | +} |
| 27 | + |
| 28 | +impl Envelope<'_> { |
| 29 | + /// Renders the envelope as of `now_ms`, which sets the relative deadline. |
| 30 | + pub fn render(&self, now_ms: i64) -> String { |
| 31 | + let mut header = format!("[botloft] from {} · crew {}", self.sender(), self.crew); |
| 32 | + if let Some(task) = self.task { |
| 33 | + let detail = match self.kind { |
| 34 | + MessageKind::Task => { |
| 35 | + format!("task {} · {}", task.id, due(task.deadline_at, now_ms)) |
| 36 | + } |
| 37 | + MessageKind::Result => format!("result of task {} · {}", task.id, task.status), |
| 38 | + MessageKind::Note | MessageKind::System => { |
| 39 | + format!("task {} · {}", task.id, task.status) |
| 40 | + } |
| 41 | + }; |
| 42 | + header.push_str(" · "); |
| 43 | + header.push_str(&detail); |
| 44 | + } |
| 45 | + let mut text = header; |
| 46 | + if let Sender::Bot { handle } = self.from { |
| 47 | + text.push_str(&format!("\nReply with send_message(to: \"{handle}\").")); |
| 48 | + if let (MessageKind::Task, Some(task)) = (self.kind, self.task) { |
| 49 | + text.push_str(&format!( |
| 50 | + " When the task is done, call complete_task(task_id: \"{}\").", |
| 51 | + task.id |
| 52 | + )); |
| 53 | + } |
| 54 | + } |
| 55 | + text.push_str("\n\n"); |
| 56 | + text.push_str(self.body); |
| 57 | + text |
| 58 | + } |
| 59 | + |
| 60 | + fn sender(&self) -> String { |
| 61 | + match self.from { |
| 62 | + // No `@`: a bot may well be called "Owner". |
| 63 | + Sender::Owner => "the owner".to_owned(), |
| 64 | + Sender::Bot { handle } => format!("@{handle}"), |
| 65 | + Sender::Botloft => "Botloft".to_owned(), |
| 66 | + } |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +/// Time left until `deadline_ms`, rounded for a reader who does not know |
| 71 | +/// the current time. |
| 72 | +fn due(deadline_ms: i64, now_ms: i64) -> String { |
| 73 | + let left = deadline_ms.saturating_sub(now_ms); |
| 74 | + if left <= 0 { |
| 75 | + return "overdue".to_owned(); |
| 76 | + } |
| 77 | + let minutes = (left + 59_999) / 60_000; |
| 78 | + if minutes < 90 { |
| 79 | + format!("due in {minutes} min") |
| 80 | + } else { |
| 81 | + format!("due in {} h", (minutes + 30) / 60) |
| 82 | + } |
| 83 | +} |
| 84 | + |
| 85 | +#[cfg(test)] |
| 86 | +mod tests { |
| 87 | + use super::*; |
| 88 | + use crate::ids::{BotId, CrewId, TaskId}; |
| 89 | + use crate::protocol::TaskStatus; |
| 90 | + |
| 91 | + const MINUTE: i64 = 60_000; |
| 92 | + |
| 93 | + fn task(deadline_at: i64, status: TaskStatus) -> Task { |
| 94 | + Task { |
| 95 | + id: "tsk_01J9Z3K8M4Q7R2T5V8X1Y4Z6A0" |
| 96 | + .parse::<TaskId>() |
| 97 | + .expect("id"), |
| 98 | + crew_id: CrewId::generate(), |
| 99 | + requester_bot_id: BotId::generate(), |
| 100 | + assignee_bot_id: BotId::generate(), |
| 101 | + status, |
| 102 | + deadline_at, |
| 103 | + hops: 1, |
| 104 | + origin_task_id: None, |
| 105 | + result: None, |
| 106 | + created_at: 0, |
| 107 | + updated_at: 0, |
| 108 | + } |
| 109 | + } |
| 110 | + |
| 111 | + fn envelope<'a>(from: Sender<'a>, kind: MessageKind, task: Option<&'a Task>) -> Envelope<'a> { |
| 112 | + Envelope { |
| 113 | + from, |
| 114 | + crew: "Site", |
| 115 | + kind, |
| 116 | + task, |
| 117 | + body: "Check the build.\nThanks!", |
| 118 | + } |
| 119 | + } |
| 120 | + |
| 121 | + #[test] |
| 122 | + fn a_task_names_its_id_deadline_and_how_to_finish_it() { |
| 123 | + let task = task(120 * MINUTE, TaskStatus::Open); |
| 124 | + let text = envelope( |
| 125 | + Sender::Bot { handle: "revisor" }, |
| 126 | + MessageKind::Task, |
| 127 | + Some(&task), |
| 128 | + ) |
| 129 | + .render(0); |
| 130 | + assert_eq!( |
| 131 | + text, |
| 132 | + "[botloft] from @revisor · crew Site · task tsk_01J9Z3K8M4Q7R2T5V8X1Y4Z6A0 · due in 2 h\n\ |
| 133 | + Reply with send_message(to: \"revisor\"). When the task is done, \ |
| 134 | + call complete_task(task_id: \"tsk_01J9Z3K8M4Q7R2T5V8X1Y4Z6A0\").\n\ |
| 135 | + \n\ |
| 136 | + Check the build.\nThanks!" |
| 137 | + ); |
| 138 | + } |
| 139 | + |
| 140 | + #[test] |
| 141 | + fn owner_notes_have_no_reply_line() { |
| 142 | + let text = envelope(Sender::Owner, MessageKind::Note, None).render(0); |
| 143 | + assert_eq!( |
| 144 | + text, |
| 145 | + "[botloft] from the owner · crew Site\n\nCheck the build.\nThanks!" |
| 146 | + ); |
| 147 | + } |
| 148 | + |
| 149 | + #[test] |
| 150 | + fn results_and_notices_carry_the_task_status() { |
| 151 | + let done = task(0, TaskStatus::Done); |
| 152 | + let result = envelope( |
| 153 | + Sender::Bot { handle: "writer" }, |
| 154 | + MessageKind::Result, |
| 155 | + Some(&done), |
| 156 | + ) |
| 157 | + .render(0); |
| 158 | + assert!(result.starts_with( |
| 159 | + "[botloft] from @writer · crew Site · result of task tsk_01J9Z3K8M4Q7R2T5V8X1Y4Z6A0 · done\n\ |
| 160 | + Reply with send_message(to: \"writer\").\n\n" |
| 161 | + )); |
| 162 | + let expired = task(0, TaskStatus::Expired); |
| 163 | + let notice = envelope(Sender::Botloft, MessageKind::System, Some(&expired)).render(0); |
| 164 | + assert!(notice.starts_with( |
| 165 | + "[botloft] from Botloft · crew Site · task tsk_01J9Z3K8M4Q7R2T5V8X1Y4Z6A0 · expired\n\n" |
| 166 | + )); |
| 167 | + } |
| 168 | + |
| 169 | + #[test] |
| 170 | + fn deadlines_read_as_time_left() { |
| 171 | + assert_eq!(due(0, 0), "overdue"); |
| 172 | + assert_eq!(due(1, 0), "due in 1 min"); |
| 173 | + assert_eq!(due(45 * MINUTE, 0), "due in 45 min"); |
| 174 | + assert_eq!(due(89 * MINUTE, 0), "due in 89 min"); |
| 175 | + assert_eq!(due(90 * MINUTE, 0), "due in 2 h"); |
| 176 | + assert_eq!(due(26 * 60 * MINUTE, 0), "due in 26 h"); |
| 177 | + assert_eq!(due(0, 5 * MINUTE), "overdue"); |
| 178 | + } |
| 179 | +} |
0 commit comments