//! Shutdown notification and drain-and-exit sequence for server restarts. use crate::chat::ChatTransport; use crate::slog; use std::path::Path; use std::sync::Arc; // ── Shutdown notification ──────────────────────────────────────────────── /// The reason the server is shutting down. /// /// Used to select the appropriate shutdown message sent to active bot channels. #[derive(Clone, Debug, PartialEq)] pub enum ShutdownReason { /// The operator stopped the server manually (SIGINT / SIGTERM / ctrl-c). Manual, /// A rebuild-and-restart was requested (via MCP tool or bot command). Rebuild, } /// Sends a shutdown announcement to all configured bot channels. /// /// Wraps a [`ChatTransport`] together with the list of channel/room IDs the /// bot is active in. Calling [`notify`] is best-effort — failures are logged /// but never propagate, so shutdown is never blocked by a failed send. pub struct BotShutdownNotifier { transport: Arc, channels: Vec, bot_name: String, } impl BotShutdownNotifier { /// Create a notifier that will send shutdown/startup messages via `transport` to the given `channels`. pub fn new(transport: Arc, channels: Vec, bot_name: String) -> Self { Self { transport, channels, bot_name, } } /// Send a startup announcement to all configured channels. /// /// Called once per process start so users know the bot is online. /// Errors are logged and ignored — startup is never blocked by a failed send. pub async fn notify_startup(&self) { let msg = format!("{} is online.", self.bot_name); for channel in &self.channels { if let Err(e) = self.transport.send_message(channel, &msg, &msg).await { slog!("[startup] Failed to send startup message to {channel}: {e}"); } } } /// Send a shutdown message to all configured channels. /// /// Errors from individual sends are logged and ignored so that a single /// failing channel does not prevent messages from reaching the rest. pub async fn notify(&self, reason: ShutdownReason) { let msg = match reason { ShutdownReason::Manual => { format!("{} is going offline (server stopped).", self.bot_name) } ShutdownReason::Rebuild => { format!("{} is going offline to pick up a new build.", self.bot_name) } }; for channel in &self.channels { if let Err(e) = self.transport.send_message(channel, &msg, &msg).await { slog!("[shutdown] Failed to send shutdown message to {channel}: {e}"); } } } } // ── Shared shutdown sequence ───────────────────────────────────────────── /// Flush CRDT persistence, remove port files, and exit so Docker restarts /// the container with the new binary. Called by `upgrade_and_reexec` after /// the binary has been replaced on disk. pub async fn drain_and_exit(project_root: &Path, label: &str) -> ! { crate::crdt_state::flush_persistence(std::time::Duration::from_secs(5)).await; let port_file = project_root.join(".huskies_port"); if port_file.exists() { let _ = std::fs::remove_file(&port_file); } let cwd_port_file = std::path::Path::new(".huskies_port"); if cwd_port_file.exists() { let _ = std::fs::remove_file(cwd_port_file); } slog!("[{label}] Exiting for Docker restart with new binary"); std::process::exit(0) } // ── Tests ──────────────────────────────────────────────────────────────── #[cfg(test)] mod tests { use super::*; use crate::chat::MessageId; use async_trait::async_trait; use std::sync::Mutex; /// In-memory transport that records sent messages. struct CapturingTransport { sent: Mutex>, fail: bool, } impl CapturingTransport { fn new() -> Self { Self { sent: Mutex::new(Vec::new()), fail: false, } } fn failing() -> Self { Self { sent: Mutex::new(Vec::new()), fail: true, } } fn messages(&self) -> Vec<(String, String)> { self.sent.lock().unwrap().clone() } } #[async_trait] impl ChatTransport for CapturingTransport { async fn send_message( &self, room_id: &str, plain: &str, _html: &str, ) -> Result { if self.fail { return Err("send failed".to_string()); } self.sent .lock() .unwrap() .push((room_id.to_string(), plain.to_string())); Ok("msg-id".to_string()) } async fn edit_message( &self, _room_id: &str, _original_message_id: &str, _plain: &str, _html: &str, ) -> Result<(), String> { Ok(()) } async fn send_typing(&self, _room_id: &str, _typing: bool) -> Result<(), String> { Ok(()) } } #[tokio::test] async fn notify_manual_sends_to_all_channels() { let transport = Arc::new(CapturingTransport::new()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec!["#channel1".to_string(), "#channel2".to_string()], "Timmy".to_string(), ); notifier.notify(ShutdownReason::Manual).await; let msgs = transport.messages(); assert_eq!(msgs.len(), 2); assert_eq!(msgs[0].0, "#channel1"); assert_eq!(msgs[1].0, "#channel2"); // Message must indicate manual stop. assert!( msgs[0].1.contains("offline"), "expected 'offline' in manual message: {}", msgs[0].1 ); assert!( msgs[0].1.contains("stopped") || msgs[0].1.contains("manual"), "expected reason in manual message: {}", msgs[0].1 ); } #[tokio::test] async fn notify_rebuild_sends_rebuild_reason() { let transport = Arc::new(CapturingTransport::new()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec!["#general".to_string()], "Timmy".to_string(), ); notifier.notify(ShutdownReason::Rebuild).await; let msgs = transport.messages(); assert_eq!(msgs.len(), 1); // Message must indicate rebuild, not manual stop. assert!( msgs[0].1.contains("build") || msgs[0].1.contains("rebuild"), "expected rebuild reason in message: {}", msgs[0].1 ); } #[tokio::test] async fn notify_manual_and_rebuild_messages_are_distinct() { let transport_a = Arc::new(CapturingTransport::new()); let notifier_a = BotShutdownNotifier::new( Arc::clone(&transport_a) as Arc, vec!["C1".to_string()], "Bot".to_string(), ); notifier_a.notify(ShutdownReason::Manual).await; let transport_b = Arc::new(CapturingTransport::new()); let notifier_b = BotShutdownNotifier::new( Arc::clone(&transport_b) as Arc, vec!["C1".to_string()], "Bot".to_string(), ); notifier_b.notify(ShutdownReason::Rebuild).await; let manual_msg = &transport_a.messages()[0].1; let rebuild_msg = &transport_b.messages()[0].1; assert_ne!( manual_msg, rebuild_msg, "manual and rebuild messages must differ" ); } #[tokio::test] async fn notify_is_best_effort_failing_send_does_not_panic() { // A transport that always fails should not cause notify() to panic or // return an error — the failure is swallowed silently. let transport = Arc::new(CapturingTransport::failing()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec!["#channel".to_string()], "Timmy".to_string(), ); // Should complete without panicking. notifier.notify(ShutdownReason::Manual).await; } #[tokio::test] async fn notify_with_no_channels_is_noop() { let transport = Arc::new(CapturingTransport::new()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec![], "Timmy".to_string(), ); notifier.notify(ShutdownReason::Manual).await; assert!(transport.messages().is_empty()); } // -- notify_startup ------------------------------------------------------- #[tokio::test] async fn notify_startup_sends_online_message_to_all_channels() { let transport = Arc::new(CapturingTransport::new()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec!["#channel1".to_string(), "#channel2".to_string()], "Timmy".to_string(), ); notifier.notify_startup().await; let msgs = transport.messages(); assert_eq!(msgs.len(), 2); assert_eq!(msgs[0].0, "#channel1"); assert_eq!(msgs[1].0, "#channel2"); assert!( msgs[0].1.contains("online"), "expected 'online' in startup message: {}", msgs[0].1 ); assert!( msgs[0].1.contains("Timmy"), "expected bot name in startup message: {}", msgs[0].1 ); } #[tokio::test] async fn notify_startup_message_uses_bot_name() { let transport = Arc::new(CapturingTransport::new()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec!["#general".to_string()], "HAL".to_string(), ); notifier.notify_startup().await; let msgs = transport.messages(); assert_eq!(msgs[0].1, "HAL is online."); } #[tokio::test] async fn notify_startup_with_no_channels_is_noop() { let transport = Arc::new(CapturingTransport::new()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec![], "Timmy".to_string(), ); notifier.notify_startup().await; assert!(transport.messages().is_empty()); } #[tokio::test] async fn notify_startup_is_best_effort_failing_send_does_not_panic() { let transport = Arc::new(CapturingTransport::failing()); let notifier = BotShutdownNotifier::new( Arc::clone(&transport) as Arc, vec!["#channel".to_string()], "Timmy".to_string(), ); // Should complete without panicking. notifier.notify_startup().await; } #[tokio::test] async fn notify_startup_message_differs_from_shutdown_message() { let transport_start = Arc::new(CapturingTransport::new()); let notifier_start = BotShutdownNotifier::new( Arc::clone(&transport_start) as Arc, vec!["C1".to_string()], "Bot".to_string(), ); notifier_start.notify_startup().await; let transport_stop = Arc::new(CapturingTransport::new()); let notifier_stop = BotShutdownNotifier::new( Arc::clone(&transport_stop) as Arc, vec!["C1".to_string()], "Bot".to_string(), ); notifier_stop.notify(ShutdownReason::Manual).await; let startup_msg = &transport_start.messages()[0].1; let shutdown_msg = &transport_stop.messages()[0].1; assert_ne!( startup_msg, shutdown_msg, "startup and shutdown messages must differ" ); } }