rapina 0.8.0

A fast, type-safe web framework for Rust inspired by FastAPI
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
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

//! Integration tests for the caching layer.

use http::StatusCode;
use rapina::cache::{CACHE_STATUS_HEADER, CacheConfig};
use rapina::prelude::*;
use rapina::testing::TestClient;

#[tokio::test]
async fn test_cache_miss_then_hit() {
    let app = Rapina::new()
        .with_introspection(false)
        .with_cache(CacheConfig::in_memory(100))
        .await
        .unwrap()
        .router(
            Router::new().route(http::Method::GET, "/data", |_, _, _| async {
                let mut response = http::Response::builder()
                    .status(StatusCode::OK)
                    .header("content-type", "application/json")
                    .body(http_body_util::Full::new(bytes::Bytes::from(
                        r#"{"value":42}"#,
                    )))
                    .unwrap();
                response
                    .headers_mut()
                    .insert("x-rapina-cache-ttl", http::HeaderValue::from_static("60"));
                response
            }),
        );

    let client = TestClient::new(app).await;

    // First request: MISS
    let response = client.get("/data").send().await;
    assert_eq!(response.status(), StatusCode::OK);
    assert_eq!(response.headers().get(CACHE_STATUS_HEADER).unwrap(), "MISS");
    assert_eq!(response.text(), r#"{"value":42}"#);

    // Second request: HIT
    let response = client.get("/data").send().await;
    assert_eq!(response.status(), StatusCode::OK);
    assert_eq!(response.headers().get(CACHE_STATUS_HEADER).unwrap(), "HIT");
    assert_eq!(response.text(), r#"{"value":42}"#);
}

#[tokio::test]
async fn test_cache_strips_internal_ttl_header() {
    let app = Rapina::new()
        .with_introspection(false)
        .with_cache(CacheConfig::in_memory(100))
        .await
        .unwrap()
        .router(
            Router::new().route(http::Method::GET, "/data", |_, _, _| async {
                let mut response = http::Response::builder()
                    .status(StatusCode::OK)
                    .body(http_body_util::Full::new(bytes::Bytes::from("ok")))
                    .unwrap();
                response
                    .headers_mut()
                    .insert("x-rapina-cache-ttl", http::HeaderValue::from_static("30"));
                response
            }),
        );

    let client = TestClient::new(app).await;
    let response = client.get("/data").send().await;

    // Internal header should be stripped
    assert!(response.headers().get("x-rapina-cache-ttl").is_none());
}

#[tokio::test]
async fn test_cache_does_not_cache_without_ttl_header() {
    use std::sync::Arc;
    use std::sync::atomic::{AtomicU32, Ordering};

    let counter = Arc::new(AtomicU32::new(0));
    let counter_clone = counter.clone();

    let app = Rapina::new()
        .with_introspection(false)
        .with_cache(CacheConfig::in_memory(100))
        .await
        .unwrap()
        .router(
            Router::new().route(http::Method::GET, "/data", move |_, _, _| {
                let counter = counter_clone.clone();
                async move {
                    let n = counter.fetch_add(1, Ordering::Relaxed);
                    format!("call {}", n)
                }
            }),
        );

    let client = TestClient::new(app).await;

    let r1 = client.get("/data").send().await;
    let r2 = client.get("/data").send().await;

    // Without TTL header, no caching — handler runs each time
    assert!(r1.headers().get(CACHE_STATUS_HEADER).is_none());
    assert!(r2.headers().get(CACHE_STATUS_HEADER).is_none());
    assert_ne!(r1.text(), r2.text());
}

#[tokio::test]
async fn test_mutation_invalidates_cache() {
    let app = Rapina::new()
        .with_introspection(false)
        .with_cache(CacheConfig::in_memory(100))
        .await
        .unwrap()
        .router(
            Router::new()
                .route(http::Method::GET, "/items", |_, _, _| async {
                    let mut response = http::Response::builder()
                        .status(StatusCode::OK)
                        .body(http_body_util::Full::new(bytes::Bytes::from("items")))
                        .unwrap();
                    response
                        .headers_mut()
                        .insert("x-rapina-cache-ttl", http::HeaderValue::from_static("60"));
                    response
                })
                .route(http::Method::POST, "/items", |_, _, _| async {
                    StatusCode::CREATED
                }),
        );

    let client = TestClient::new(app).await;

    // Populate cache
    let response = client.get("/items").send().await;
    assert_eq!(response.headers().get(CACHE_STATUS_HEADER).unwrap(), "MISS");

    // Verify cache hit
    let response = client.get("/items").send().await;
    assert_eq!(response.headers().get(CACHE_STATUS_HEADER).unwrap(), "HIT");

    // Mutation should invalidate
    let response = client.post("/items").send().await;
    assert_eq!(response.status(), StatusCode::CREATED);

    // Should be a miss again
    let response = client.get("/items").send().await;
    assert_eq!(response.headers().get(CACHE_STATUS_HEADER).unwrap(), "MISS");
}

#[tokio::test]
async fn test_cache_preserves_response_headers() {
    let app = Rapina::new()
        .with_introspection(false)
        .with_cache(CacheConfig::in_memory(100))
        .await
        .unwrap()
        .router(
            Router::new().route(http::Method::GET, "/data", |_, _, _| async {
                let mut response = http::Response::builder()
                    .status(StatusCode::OK)
                    .header("content-type", "application/json")
                    .header("x-custom", "preserved")
                    .body(http_body_util::Full::new(bytes::Bytes::from("{}")))
                    .unwrap();
                response
                    .headers_mut()
                    .insert("x-rapina-cache-ttl", http::HeaderValue::from_static("60"));
                response
            }),
        );

    let client = TestClient::new(app).await;

    // Populate cache
    client.get("/data").send().await;

    // Cache hit should preserve original headers
    let response = client.get("/data").send().await;
    assert_eq!(response.headers().get(CACHE_STATUS_HEADER).unwrap(), "HIT");
    assert_eq!(
        response.headers().get("content-type").unwrap(),
        "application/json"
    );
    assert_eq!(response.headers().get("x-custom").unwrap(), "preserved");
}

#[tokio::test]
async fn test_cache_only_caches_get() {
    let app = Rapina::new()
        .with_introspection(false)
        .with_cache(CacheConfig::in_memory(100))
        .await
        .unwrap()
        .router(
            Router::new().route(http::Method::POST, "/data", |_, _, _| async {
                let mut response = http::Response::builder()
                    .status(StatusCode::CREATED)
                    .body(http_body_util::Full::new(bytes::Bytes::from("created")))
                    .unwrap();
                response
                    .headers_mut()
                    .insert("x-rapina-cache-ttl", http::HeaderValue::from_static("60"));
                response
            }),
        );

    let client = TestClient::new(app).await;

    // POST requests should not be cached even with TTL header
    let response = client.post("/data").send().await;
    assert_eq!(response.status(), StatusCode::CREATED);
    assert!(response.headers().get(CACHE_STATUS_HEADER).is_none());
}

#[tokio::test]
async fn test_cache_query_params_affect_key() {
    let app = Rapina::new()
        .with_introspection(false)
        .with_cache(CacheConfig::in_memory(100))
        .await
        .unwrap()
        .router(
            Router::new().route(http::Method::GET, "/search", |req, _, _| async move {
                let query = req.uri().query().unwrap_or("none").to_string();
                let mut response = http::Response::builder()
                    .status(StatusCode::OK)
                    .body(http_body_util::Full::new(bytes::Bytes::from(query)))
                    .unwrap();
                response
                    .headers_mut()
                    .insert("x-rapina-cache-ttl", http::HeaderValue::from_static("60"));
                response
            }),
        );

    let client = TestClient::new(app).await;

    // Different query params should produce different cache keys
    let r1 = client.get("/search?q=rust").send().await;
    assert_eq!(r1.headers().get(CACHE_STATUS_HEADER).unwrap(), "MISS");

    let r2 = client.get("/search?q=python").send().await;
    assert_eq!(r2.headers().get(CACHE_STATUS_HEADER).unwrap(), "MISS");

    // Same query should hit
    let r3 = client.get("/search?q=rust").send().await;
    assert_eq!(r3.headers().get(CACHE_STATUS_HEADER).unwrap(), "HIT");
    assert_eq!(r3.text(), "q=rust");
}