puerto 0.10.0

Puerto — Rust full-stack DDD framework CLI. Scaffolds Clean Architecture projects with auto-wired DI, SQLx support, and zero manual wiring. Formerly puerto-framework.
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

//! Liveness and readiness probes, served outside the OpenAPI service.
//!
//! `GET /health` answers *is the process up?* — nothing more. `GET /health/ready` answers *can it
//! serve traffic?* by asking the dependencies (the database, in a `--db` project). The two are
//! separate on purpose: a liveness-only probe reports a stack whose database is down as healthy,
//! and an orchestrator that restarts on a failed *readiness* check restarts a process that was fine.

use poem::{handler, http::StatusCode};

/// Liveness: the process answers.
#[handler]
pub fn liveness() -> &'static str {
    "ok"
}

/// The readiness response: 200 when every dependency answered, 503 otherwise. `bootstrap.rs` calls
/// it with the result of its dependency checks — or `true` when the project has none.
pub fn readiness(ready: bool) -> (StatusCode, &'static str) {
    if ready {
        (StatusCode::OK, "ready")
    } else {
        (StatusCode::SERVICE_UNAVAILABLE, "not ready")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn should_answer_200_when_dependencies_are_ready() {
        // Act
        let (status, body) = readiness(true);

        // Assert
        assert_eq!(status, StatusCode::OK);
        assert_eq!(body, "ready");
    }

    #[test]
    fn should_answer_503_when_a_dependency_is_down() {
        // Act
        let (status, _) = readiness(false);

        // Assert
        assert_eq!(status, StatusCode::SERVICE_UNAVAILABLE);
    }
}