# survey.rs - source
Source of the Rust file `src/api/v1/survey.rs`.

    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
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255

    /*
     * Copyright (C) 2023  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::ServiceConfig;
    use actix_web::{web, HttpResponse, Responder};
    use serde::{Deserialize, Serialize};

    use crate::errors::*;
    use crate::AppData;

    pub fn services(cfg: &mut ServiceConfig) {
        cfg.service(download);
        cfg.service(secret);
    }

    pub mod routes {
        pub struct Survey {
            pub download: &'static str,
            pub secret: &'static str,
        }

        impl Survey {
            pub const fn new() -> Self {
                Self {
                    download: "/api/v1/survey/takeout/{survey_id}/get",
                    secret: "/api/v1/survey/secret",
                }
            }

            pub fn get_download_route(&self, survey_id: &str, page: usize) -> String {
                format!(
                    "{}?page={}",
                    self.download.replace("{survey_id}", survey_id),
                    page
                )
            }
        }
    }

    #[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
    pub struct Page {
        pub page: usize,
    }

    /// emits build details of the bninary
    #[my_codegen::get(path = "crate::V1_API_ROUTES.survey.download")]
    async fn download(
        data: AppData,
        page: web::Query<Page>,
        psuedo_id: web::Path<uuid::Uuid>,
    ) -> ServiceResult<impl Responder> {
        const LIMIT: usize = 50;
        let offset = LIMIT as isize * ((page.page as isize) - 1);
        let offset = if offset < 0 { 0 } else { offset };
        let psuedo_id = psuedo_id.into_inner();
        let campaign_id = data
            .db
            .analytics_get_capmaign_id_from_psuedo_id(&psuedo_id.to_string())
            .await?;
        let data = data
            .db
            .analytics_fetch(&campaign_id, LIMIT, offset as usize)
            .await?;
        Ok(HttpResponse::Ok().json(data))
    }

    #[derive(Serialize, Deserialize)]
    struct SurveySecretUpload {
        secret: String,
        auth_token: String,
    }

    /// mCaptcha/survey upload secret route
    #[my_codegen::post(path = "crate::V1_API_ROUTES.survey.secret")]
    async fn secret(
        data: AppData,
        payload: web::Json<SurveySecretUpload>,
    ) -> ServiceResult<impl Responder> {
        match data.survey_secrets.get(&payload.auth_token) {
            Some(survey_instance_url) => {
                let payload = payload.into_inner();
                data.survey_secrets.set(survey_instance_url, payload.secret);
                data.survey_secrets.rm(&payload.auth_token);
                Ok(HttpResponse::Ok())
            }
            None => Err(ServiceError::WrongPassword),
        }
    }

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

        use super::*;
        use crate::api::v1::mcaptcha::get_random;
        use crate::tests::*;
        use crate::*;

        #[actix_rt::test]
        async fn survey_works_pg() {
            let data = crate::tests::pg::get_data().await;
            survey_registration_works(data.clone()).await;
            survey_works(data).await;
        }

        #[actix_rt::test]
        async fn survey_works_maria() {
            let data = crate::tests::maria::get_data().await;
            survey_registration_works(data.clone()).await;
            survey_works(data).await;
        }

        pub async fn survey_registration_works(data: ArcData) {
            let data = &data;
            let app = get_app!(data).await;

            let survey_instance_url = "http://survey_registration_works.survey.example.org";

            let key = get_random(20);

            let msg = SurveySecretUpload {
                auth_token: key.clone(),
                secret: get_random(32),
            };

            // should fail with ServiceError::WrongPassword since auth token is not loaded into
            // keystore
            bad_post_req_test_no_auth(
                data,
                V1_API_ROUTES.survey.secret,
                &msg,
                errors::ServiceError::WrongPassword,
            )
            .await;

            // load auth token into key store, should succeed
            data.survey_secrets
                .set(key.clone(), survey_instance_url.to_owned());
            let resp = test::call_service(
                &app,
                post_request!(&msg, V1_API_ROUTES.survey.secret).to_request(),
            )
            .await;
            assert_eq!(resp.status(), StatusCode::OK);
            // uploaded secret must be in keystore
            assert_eq!(
                data.survey_secrets.get(survey_instance_url).unwrap(),
                msg.secret
            );

            // should fail since mCaptcha/survey secret upload auth tokens are single-use
            bad_post_req_test_no_auth(
                data,
                V1_API_ROUTES.survey.secret,
                &msg,
                errors::ServiceError::WrongPassword,
            )
            .await;
        }

        pub async fn survey_works(data: ArcData) {
            const NAME: &str = "survetuseranalytics";
            const PASSWORD: &str = "longpassworddomain";
            const EMAIL: &str = "survetuseranalytics@a.com";
            let data = &data;

            delete_user(data, NAME).await;

            register_and_signin(data, NAME, EMAIL, PASSWORD).await;
            // create captcha
            let (_, _signin_resp, key) = add_levels_util(data, NAME, PASSWORD).await;
            let app = get_app!(data).await;

            let page = 1;
            let tmp_id = uuid::Uuid::new_v4();
            let download_rotue = V1_API_ROUTES
                .survey
                .get_download_route(&tmp_id.to_string(), page);

            let download_req = test::call_service(
                &app,
                test::TestRequest::get().uri(&download_rotue).to_request(),
            )
            .await;
            assert_eq!(download_req.status(), StatusCode::NOT_FOUND);

            data.db
                .analytics_create_psuedo_id_if_not_exists(&key.key)
                .await
                .unwrap();

            let psuedo_id = data
                .db
                .analytics_get_psuedo_id_from_capmaign_id(&key.key)
                .await
                .unwrap();

            for i in 0..60 {
                println!("[{i}] Saving analytics");
                let analytics = db_core::CreatePerformanceAnalytics {
                    time: 0,
                    difficulty_factor: 0,
                    worker_type: "wasm".into(),
                };
                data.db.analysis_save(&key.key, &analytics).await.unwrap();
            }

            for p in 1..3 {
                let download_rotue = V1_API_ROUTES.survey.get_download_route(&psuedo_id, p);
                println!("page={p}, download={download_rotue}");

                let download_req = test::call_service(
                    &app,
                    test::TestRequest::get().uri(&download_rotue).to_request(),
                )
                .await;
                assert_eq!(download_req.status(), StatusCode::OK);
                let analytics: Vec<db_core::PerformanceAnalytics> =
                    test::read_body_json(download_req).await;
                if p == 1 {
                    assert_eq!(analytics.len(), 50);
                } else if p == 2 {
                    assert_eq!(analytics.len(), 10);
                } else {
                    assert_eq!(analytics.len(), 0);
                }
            }

            let download_rotue = V1_API_ROUTES.survey.get_download_route(&psuedo_id, 0);
            data.db
                .analytics_delete_all_records_for_campaign(&key.key)
                .await
                .unwrap();

            let download_req = test::call_service(
                &app,
                test::TestRequest::get().uri(&download_rotue).to_request(),
            )
            .await;
            assert_eq!(download_req.status(), StatusCode::NOT_FOUND);
        }
    }