renox-core 1.0.0

Runtime of the Renox web framework: routing, views, database and models, validation, auth, queue, scheduler, mail, storage. Use it through the `renox` crate.
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

//! `GET /health` for load balancers and uptime checks: 200 when the database
//! answers, 503 otherwise, with details as JSON. Not affected by maintenance
//! mode or sessions.

use std::time::Duration;

use axum::Json;
use axum::Router;
use axum::extract::State;
use axum::http::StatusCode;
use axum::routing::get;
use serde_json::{Value, json};

use crate::AppState;

pub(crate) fn router() -> Router<AppState> {
    Router::new().route("/health", get(health))
}

async fn health(State(state): State<AppState>) -> (StatusCode, Json<Value>) {
    // Not decoded: `1` is an INT4 on PostgreSQL but an INTEGER (i64) on SQLite.
    let ping = crate::db::sql("SELECT 1").fetch_one(&state.db);
    let database = match tokio::time::timeout(Duration::from_secs(2), ping).await {
        Ok(Ok(_)) => Ok(()),
        Ok(Err(err)) => Err(err.to_string()),
        Err(_) => Err("timed out".to_owned()),
    };
    let queue = match &database {
        Ok(()) => {
            let pending = state.queue.pending().await.ok();
            let failed: Option<i64> = crate::db::sql("SELECT COUNT(*) FROM failed_jobs")
                .scalar(&state.db)
                .await
                .ok();
            json!({ "pending": pending, "failed": failed })
        }
        Err(_) => Value::Null,
    };
    let maintenance = crate::maintenance::status(&state.config.storage_path).is_some();
    let status = if database.is_ok() {
        StatusCode::OK
    } else {
        StatusCode::SERVICE_UNAVAILABLE
    };
    let body = json!({
        "status": if database.is_ok() { "ok" } else { "error" },
        "database": database.err().unwrap_or_else(|| "ok".to_owned()),
        "queue": queue,
        "maintenance": maintenance,
    });
    (status, Json(body))
}