# meta.rs - source
Source of the Rust file `src/api/v1/meta.rs`.
Keywords: rust, rustlang, rust-lang

      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
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150

    /*
    * Copyright (C) 2021  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 derive_builder::Builder;
    use libmcaptcha::redis::{Redis, RedisConfig};
    use serde::{Deserialize, Serialize};

    use crate::data::SystemGroup;
    use crate::AppData;
    use crate::{GIT_COMMIT_HASH, VERSION};

    #[derive(Clone, Debug, Deserialize, Builder, Serialize)]
    pub struct BuildDetails {
        pub version: &'static str,
        pub git_commit_hash: &'static 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",
                }
            }
        }
    }

    /// emmits build details of the bninary
    #[my_codegen::get(path = "crate::V1_API_ROUTES.meta.build_details")]
    async fn build_details() -> impl Responder {
        let build = BuildDetails {
            version: VERSION,
            git_commit_hash: GIT_COMMIT_HASH,
        };
        HttpResponse::Ok().json(build)
    }

    #[derive(Clone, Debug, Deserialize, Builder, Serialize)]
    /// Health check return datatype
    pub struct Health {
        db: bool,
        #[serde(skip_serializing_if = "Self::is_redis")]
        redis: Option<bool>,
    }

    impl Health {
        fn is_redis(redis: &Option<bool>) -> bool {
            redis.is_none()
        }
    }

    /// checks all components of the system
    #[my_codegen::get(path = "crate::V1_API_ROUTES.meta.health")]
    async fn health(data: AppData) -> impl Responder {
        use sqlx::Connection;

        let mut resp_builder = HealthBuilder::default();
        resp_builder.db(false);
        resp_builder.redis = None;

        if let Ok(mut con) = data.db.acquire().await {
            if con.ping().await.is_ok() {
                resp_builder.db(true);
            }
        };

        if let SystemGroup::Redis(_) = data.captcha {
            if let Ok(r) = Redis::new(RedisConfig::Single(
                crate::SETTINGS.redis.as_ref().unwrap().url.clone(),
            ))
            .await
            {
                let status = r.get_client().ping().await;
                resp_builder.redis = Some(Some(status));
            } else {
                resp_builder.redis = Some(Some(false));
            }
        };

        HttpResponse::Ok().json(resp_builder.build().unwrap())
    }

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

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

        use super::*;
        use crate::api::v1::services;
        use crate::*;

        #[actix_rt::test]
        async fn build_details_works() {
            let app = test::init_service(App::new().configure(services)).await;

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

        #[actix_rt::test]
        async fn health_works() {
            println!("{}", V1_API_ROUTES.meta.health);
            let data = Data::new().await;
            let app = get_app!(data).await;

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

            let health_resp: Health = test::read_body_json(resp).await;
            assert!(health_resp.db);
            assert_eq!(health_resp.redis, Some(true));
        }
    }