athena_rs 0.76.0

WIP Database API gateway
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

//! Helpers that look for the `rehydrate=true` query parameter so callers can opt in to cache warming.
use actix_web::HttpRequest;

/// Returns `true` when `?rehydrate=true` is present so upstream services can refresh caches.
///
/// # Parameters
///
/// - `req`: Incoming HTTP request whose query string is scanned.
///
/// # Returns
///
/// - `bool`: `true` when the query string contains `rehydrate=true`, otherwise `false`.
///
/// # Example
///
/// ```rust,no_run
/// # use actix_web::test::TestRequest;
/// # use actix_web::HttpRequest;
/// # use athena_rs::api::cache::rehydrate::check_rehydrate;
/// # async fn doc_example() {
/// let req = TestRequest::default().uri("/something?rehydrate=true").to_http_request();
/// assert!(check_rehydrate(&req).await);
/// # }
/// ```
pub async fn check_rehydrate(req: &HttpRequest) -> bool {
    req.query_string()
        .split('&')
        .find(|&q| q == "rehydrate=true")
        .is_some()
}

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

    #[actix_web::test]
    async fn returns_true_when_present() {
        let req: HttpRequest = TestRequest::default()
            .uri("/path?rehydrate=true")
            .to_http_request();
        assert!(check_rehydrate(&req).await);
    }

    #[actix_web::test]
    async fn returns_false_when_missing() {
        let req: HttpRequest = TestRequest::default()
            .uri("/path?foo=bar")
            .to_http_request();
        assert!(!check_rehydrate(&req).await);
    }
}