    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
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114

    /*
     * Copyright (C) 2022  Aravinth Manivannan <realaravinth@batsense.net>
     *
     * This program is free software: you can redistribute it and/or modify
     * it under the terms of the GNU Affero General Public License as
     * published by the Free Software Foundation, either version 3 of the
     * License, or (at your option) any later version.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU Affero General Public License for more details.
     *
     * You should have received a copy of the GNU Affero General Public License
     * along with this program.  If not, see <https://www.gnu.org/licenses/>.
     */
    use actix_web::{web, HttpResponse, Responder};
    use serde::{Deserialize, Serialize};

    use crate::{AppCtx, GIT_COMMIT_HASH, VERSION};

    #[derive(Clone, Debug, Deserialize, Serialize)]
    pub struct BuildDetails<'a> {
        pub version: &'a str,
        pub git_commit_hash: &'a str,
        pub source_code: &'a str,
    }

    pub mod routes {
        pub struct Meta {
            pub build_details: &'static str,
            pub health: &'static str,
        }

        impl Meta {
            pub const fn new() -> Self {
                Self {
                    build_details: "/api/v1/meta/build",
                    health: "/api/v1/meta/health",
                }
            }
        }
    }

    /// emits build details of the binary
    #[actix_web_codegen_const_routes::get(path = "crate::V1_API_ROUTES.meta.build_details")]
    #[tracing::instrument(name = "Fetch Build Details", skip(ctx))]
    async fn build_details(ctx: AppCtx) -> impl Responder {
        let build = BuildDetails {
            version: VERSION,
            git_commit_hash: GIT_COMMIT_HASH,
            source_code: &ctx.settings.source_code,
        };
        HttpResponse::Ok().json(build)
    }

    #[derive(Clone, Debug, Deserialize, Serialize)]
    /// Health check return datatype
    pub struct Health {
        db: bool,
    }

    /// checks all components of the system
    #[actix_web_codegen_const_routes::get(path = "crate::V1_API_ROUTES.meta.health")]
    #[tracing::instrument(name = "Fetch health", skip(ctx))]
    async fn health(ctx: crate::AppCtx) -> impl Responder {
        let res = Health {
            db: ctx.db.ping().await,
        };

        HttpResponse::Ok().json(res)
    }

    pub fn services(cfg: &mut web::ServiceConfig) {
        cfg.service(build_details);
        cfg.service(health);
    }

    #[cfg(test)]
    mod tests {
        use actix_web::{http::StatusCode, test};

        use crate::*;

        #[actix_rt::test]
        async fn build_details_works() {
            let (_dir, ctx) = tests::get_ctx().await;
            println!("[log] test configuration {:#?}", ctx.settings);
            let app = get_app!(ctx).await;

            let resp = get_request!(app, V1_API_ROUTES.meta.build_details);
            check_status!(resp, StatusCode::OK);
        }

        #[actix_rt::test]
        async fn health_works() {
            use actix_web::test;

            let (_dir, ctx) = tests::get_ctx().await;
            let app = get_app!(ctx).await;

            let resp = test::call_service(
                &app,
                test::TestRequest::get()
                    .uri(crate::V1_API_ROUTES.meta.health)
                    .to_request(),
            )
            .await;
            assert_eq!(resp.status(), StatusCode::OK);

            let health_resp: super::Health = test::read_body_json(resp).await;
            assert!(health_resp.db);
        }
    }