mae 0.3.9

Opinionated async Rust framework for building Mae-Technologies micro-services — app scaffolding, repo layer, middleware, and test utilities.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! Built-in health check handlers for mae applications.
//!
//! These three handlers are automatically registered by the `#[run_app]` macro
//! so every service gets liveness and readiness probes with zero service-level
//! code.
//!
//! # Endpoints
//!
//! | Route | Purpose | Success | Failure |
//! |---|---|---|---|
//! | `GET /health` | Liveness — always 200 | `{"status":"ok"}` | — |
//! | `GET /health-pg` | Postgres readiness | `{"status":"ok","db":"postgres"}` | 503 |
//! | `GET /health-neo` | Neo4j readiness | `{"status":"ok","db":"neo4j"}` | 503 |

use actix_web::{HttpResponse, get, web};
use sqlx::PgPool;

/// Liveness probe — always returns 200 `{"status":"ok"}`.
///
/// Registered automatically by the `#[run_app]` macro on `GET /health`.
#[get("/health")]
pub async fn health() -> HttpResponse {
    HttpResponse::Ok().json(serde_json::json!({"status": "ok"}))
}

/// Postgres readiness probe.
///
/// Runs `SELECT 1` against the injected [`PgPool`].
/// Returns 200 on success, 503 on failure.
///
/// Registered automatically by the `#[run_app]` macro on `GET /health-pg`.
#[get("/health-pg")]
pub async fn health_pg(pool: web::Data<PgPool>) -> HttpResponse {
    match sqlx::query("SELECT 1").execute(pool.get_ref()).await {
        Ok(_) => HttpResponse::Ok().json(serde_json::json!({"status": "ok", "db": "postgres"})),
        Err(_) => HttpResponse::ServiceUnavailable()
            .json(serde_json::json!({"status": "error", "db": "postgres"}))
    }
}

/// Neo4j readiness probe.
///
/// Runs `RETURN 1 AS _n` against the injected [`neo4rs::Graph`].
/// Returns 200 on success, 503 on failure.
///
/// Registered automatically by the `#[run_app]` macro on `GET /health-neo`.
#[get("/health-neo")]
pub async fn health_neo(graph: web::Data<neo4rs::Graph>) -> HttpResponse {
    match graph.run(neo4rs::query("RETURN 1 AS _n")).await {
        Ok(_) => HttpResponse::Ok().json(serde_json::json!({"status": "ok", "db": "neo4j"})),
        Err(_) => HttpResponse::ServiceUnavailable()
            .json(serde_json::json!({"status": "error", "db": "neo4j"}))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use actix_web::{App, test};

    #[actix_web::test]
    async fn health_always_returns_200() {
        let app = test::init_service(App::new().service(health)).await;
        let req = test::TestRequest::get().uri("/health").to_request();
        let resp = test::call_service(&app, req).await;
        assert_eq!(resp.status().as_u16(), 200u16);
    }
}