garrison 0.9.0

Garrison - 面向 Rust 生态的一站式身份认证鉴权框架
Documentation
// Copyright (c) 2026 Kirky.X🌠
// SPDX-License-Identifier: Apache-2.0

//! axum 框架的健康检查路由集成:提供 `/health/live` 与 `/health/ready` 端点。

use super::HealthRegistry;
use axum::http::StatusCode;
use axum::response::{IntoResponse, Response};
use axum::routing::get;
use axum::Json;
use std::sync::Arc;

/// Liveness 探针 handler——进程存活即返回 200。
pub async fn live() -> impl IntoResponse {
    (
        StatusCode::OK,
        Json(serde_json::json!({"status": "healthy"})),
    )
}

/// Readiness 探针 handler——检查依赖项就绪状态。
///
/// 单项检查超时护栏(默认 5 秒,[`HealthRegistry::with_check_timeout`] 可配置)由
/// [`HealthRegistry::check_all`] 内部强制执行:挂起/panic 的检查按 `Unhealthy` 聚合,
/// 不会阻塞 axum worker task。
pub async fn ready(
    axum::extract::State(registry): axum::extract::State<Arc<HealthRegistry>>,
) -> Response {
    let report = registry.check_all().await;
    let status = match report.overall {
        super::HealthStatus::Healthy | super::HealthStatus::Degraded => StatusCode::OK,
        super::HealthStatus::Unhealthy => StatusCode::SERVICE_UNAVAILABLE,
    };
    (status, Json(report)).into_response()
}

/// 创建健康检查路由,挂载到 axum Router。
///
/// # 示例
///
/// ```ignore
/// use garrison::health::axum_routes::health_routes;
/// use garrison::health::HealthRegistry;
/// use std::sync::Arc;
///
/// let registry = Arc::new(HealthRegistry::new());
/// let app = axum::Router::new()
/// .merge(health_routes(registry));
/// ```
pub fn health_routes(registry: Arc<HealthRegistry>) -> axum::Router {
    axum::Router::new()
        .route("/health/live", get(live))
        .route("/health/ready", get(ready))
        .with_state(registry)
}