use crate::error::BaseError;
use crate::plugin::PluginManager;
use crate::tools::Tools;
pub async fn wait_for_shutdown_signal() {
#[cfg(unix)]
{
use tokio::signal::unix::{signal, SignalKind};
match signal(SignalKind::terminate()) {
Ok(mut sigterm) => {
tokio::select! {
_ = tokio::signal::ctrl_c() => {
log::info!("收到 Ctrl+C,开始优雅停机");
}
_ = sigterm.recv() => {
log::info!("收到 SIGTERM,开始优雅停机");
}
}
}
Err(e) => {
log::warn!("注册 SIGTERM 处理失败,降级为仅监听 Ctrl+C: {}", e);
let _ = tokio::signal::ctrl_c().await;
log::info!("收到 Ctrl+C,开始优雅停机");
}
}
}
#[cfg(not(unix))]
{
let _ = tokio::signal::ctrl_c().await;
log::info!("收到 Ctrl+C,开始优雅停机");
}
}
pub async fn graceful_shutdown(
plugins: Option<&PluginManager>,
tools: &Tools,
) -> Result<(), BaseError> {
let mut plugin_err = None;
if let Some(pm) = plugins {
if let Err(e) = pm.shutdown().await {
log::error!("插件停机出错(继续 drain 连接池): {}", e);
plugin_err = Some(e);
}
}
tools.close().await;
log::info!("应用 Tools 资源已关闭");
match plugin_err {
Some(e) => Err(e),
None => Ok(()),
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::plugin::Plugin;
use crate::tools::ToolsBuilder;
use async_trait::async_trait;
use std::sync::{Arc, Mutex};
struct ShutdownRecorder {
name: String,
order: Arc<Mutex<Vec<String>>>,
}
#[async_trait]
impl Plugin for ShutdownRecorder {
fn name(&self) -> &str {
&self.name
}
async fn on_shutdown(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
self.order.lock().unwrap().push(self.name.clone());
Ok(())
}
}
struct PluginB(Arc<Mutex<Vec<String>>>);
#[async_trait]
impl Plugin for PluginB {
fn name(&self) -> &str {
"plugin_b"
}
fn dependencies(&self) -> &[&str] {
&["plugin_a"]
}
async fn on_shutdown(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
self.0.lock().unwrap().push("plugin_b".to_string());
Ok(())
}
}
struct PluginC(Arc<Mutex<Vec<String>>>);
#[async_trait]
impl Plugin for PluginC {
fn name(&self) -> &str {
"plugin_c"
}
fn dependencies(&self) -> &[&str] {
&["plugin_b"]
}
async fn on_shutdown(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
self.0.lock().unwrap().push("plugin_c".to_string());
Ok(())
}
}
struct ShutdownFailer;
#[async_trait]
impl Plugin for ShutdownFailer {
fn name(&self) -> &str {
"shutdown_failer"
}
async fn on_shutdown(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
Err("intentional shutdown failure".into())
}
}
#[tokio::test]
async fn test_graceful_shutdown_no_plugins() {
let tools = ToolsBuilder::new().build().expect("测试 Tools 应构建成功");
let result = graceful_shutdown(None, &tools).await;
assert!(
result.is_ok(),
"plugins=None 时 graceful_shutdown 应返回 Ok"
);
}
#[tokio::test]
async fn test_graceful_shutdown_plugin_error() {
let manager = PluginManager::new();
manager.register(ShutdownFailer).await.unwrap();
let tools = ToolsBuilder::new().build().expect("测试 Tools 应构建成功");
let result = graceful_shutdown(Some(&manager), &tools).await;
assert!(
result.is_err(),
"插件 shutdown 失败时 graceful_shutdown 应返回 Err"
);
if let Err(e) = result {
match &e {
BaseError::PluginLifecycleFailed {
plugin,
stage: crate::plugin::PluginLifecycleStage::Shutdown,
source,
} => {
assert_eq!(plugin, "shutdown_failer", "错误应指向 shutdown_failer");
assert_eq!(source.to_string(), "intentional shutdown failure");
}
other => panic!("期望 PluginLifecycleFailed,得到: {:?}", other),
}
assert_eq!(e.code(), 100008, "shutdown 阶段错误码不得漂移");
}
}
#[tokio::test]
async fn test_graceful_shutdown_order() {
let order = Arc::new(Mutex::new(Vec::new()));
let manager = PluginManager::new();
manager
.register(ShutdownRecorder {
name: "plugin_a".to_string(),
order: Arc::clone(&order),
})
.await
.unwrap();
manager.register(PluginB(Arc::clone(&order))).await.unwrap();
manager.register(PluginC(Arc::clone(&order))).await.unwrap();
let tools = ToolsBuilder::new().build().expect("测试 Tools 应构建成功");
let result = graceful_shutdown(Some(&manager), &tools).await;
assert!(result.is_ok(), "全部插件 shutdown 成功时应返回 Ok");
let recorded = order.lock().unwrap().clone();
assert_eq!(recorded.len(), 3, "应有 3 个插件被 shutdown");
assert_eq!(
recorded[0], "plugin_c",
"第一个关闭的应是 plugin_c(最内层依赖,逆拓扑序首位)"
);
assert_eq!(recorded[1], "plugin_b", "第二个关闭的应是 plugin_b");
assert_eq!(
recorded[2], "plugin_a",
"第三个关闭的应是 plugin_a(无依赖,应最后关闭)"
);
}
}