silent 2.16.1

Silent Web Framework
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
use crate::{Handler, MiddleWareHandler, Next, Request, Response, Result, SilentError};
use async_trait::async_trait;
use cookie::{Cookie, CookieJar};
use http::{StatusCode, header};

#[derive(Debug, Default)]
pub struct CookieMiddleware {}

impl CookieMiddleware {
    pub(crate) fn new() -> Self {
        Self::default()
    }
}

#[async_trait]
impl MiddleWareHandler for CookieMiddleware {
    async fn handle(&self, mut req: Request, next: &Next) -> Result<Response> {
        let mut jar = CookieJar::new();
        if let Some(cookies) = req.headers().get(header::COOKIE) {
            for cookie_str in cookies
                .to_str()
                .map_err(|e| {
                    SilentError::business_error(
                        StatusCode::BAD_REQUEST,
                        format!("Failed to parse cookie: {e}"),
                    )
                })?
                .split(';')
                .map(|s| s.trim())
            {
                if let Ok(cookie) = Cookie::parse_encoded(cookie_str).map(|c| c.into_owned()) {
                    jar.add_original(cookie);
                }
            }
        }
        req.extensions_mut().insert(jar.clone());
        let mut res = next.call(req).await?;
        if let Some(cookie_jar) = res.extensions().get::<CookieJar>() {
            for cookie in cookie_jar.delta().cloned() {
                jar.add(cookie)
            }
            res.extensions_mut().insert(jar);
        } else {
            res.extensions_mut().insert(jar);
        };
        Ok(res)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Arc;

    // ==================== 构造函数测试 ====================

    #[test]
    fn test_cookie_middleware_new() {
        let middleware = CookieMiddleware::new();
        let _ = middleware;
    }

    #[test]
    fn test_cookie_middleware_default() {
        let middleware = CookieMiddleware::default();
        let _ = middleware;
    }

    // ==================== Debug trait 测试 ====================

    #[test]
    fn test_cookie_middleware_debug() {
        let middleware = CookieMiddleware::new();
        let debug_str = format!("{:?}", middleware);
        assert!(debug_str.contains("CookieMiddleware"));
    }

    // ==================== 类型验证测试 ====================

    #[test]
    fn test_cookie_middleware_type() {
        let middleware = CookieMiddleware::new();
        let _middleware: CookieMiddleware = middleware;
    }

    #[test]
    fn test_cookie_middleware_size() {
        use std::mem::size_of;
        let size = size_of::<CookieMiddleware>();
        // CookieMiddleware 是空结构体(ZST)
        assert_eq!(size, 0);
    }

    // ==================== 集成测试 ====================

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_parse_request_cookies() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                // 验证请求中的 Cookie 被 CookieJar 解析并存储
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("parsed")
            });

        let route = Route::new_root().append(route);

        // 创建带有 Cookie 的请求
        let mut req = Request::empty();
        req.headers_mut().insert(
            header::COOKIE,
            "session=abc123; user=testuser".parse().unwrap(),
        );

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_with_response_cookies() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                // 在响应中添加 Cookie
                let jar = req
                    .extensions()
                    .get::<CookieJar>()
                    .cloned()
                    .unwrap_or_default();
                let mut resp = Response::text("cookies set");
                resp.extensions_mut().insert(jar);
                Ok(resp)
            });

        let route = Route::new_root().append(route);
        let req = Request::empty();

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_no_cookies() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                // 没有 Cookie 头时应该有一个空的 CookieJar
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("no cookies")
            });

        let route = Route::new_root().append(route);
        let req = Request::empty();

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_malformed_cookie_value() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                // 即使某些 Cookie 解析失败,中间件仍应继续处理
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("test")
            });

        let route = Route::new_root().append(route);

        // 创建包含格式错误的 Cookie(无效的 UTF-8)
        let mut req = Request::empty();
        // 使用包含无效 UTF-8 的字节序列
        let invalid_bytes = &[0xFF, 0xFE, 0xFD];
        req.headers_mut().insert(
            header::COOKIE,
            hyper::header::HeaderValue::from_bytes(invalid_bytes).unwrap(),
        );

        let result: Result<Response> = route.call(req).await;
        // 应该返回错误,因为 Cookie 头包含无效的 UTF-8
        assert!(result.is_err());
        if let Err(e) = result {
            assert_eq!(e.status(), StatusCode::BAD_REQUEST);
        }
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_multiple_cookies() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("multiple cookies")
            });

        let route = Route::new_root().append(route);

        // 创建包含多个 Cookie 的请求
        let mut req = Request::empty();
        req.headers_mut().insert(
            header::COOKIE,
            "cookie1=value1; cookie2=value2; cookie3=value3"
                .parse()
                .unwrap(),
        );

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_cookie_with_spaces() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("spaces")
            });

        let route = Route::new_root().append(route);

        // 创建包含空格的 Cookie
        let mut req = Request::empty();
        req.headers_mut().insert(
            header::COOKIE,
            "name1 = value1 ; name2=value2".parse().unwrap(),
        );

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_empty_cookie_value() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("empty value")
            });

        let route = Route::new_root().append(route);

        // 创建包含空值的 Cookie
        let mut req = Request::empty();
        req.headers_mut()
            .insert(header::COOKIE, "cookie1=; cookie2=value2".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_preserves_original_cookies() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                // 验证原始 Cookie 被保存
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("preserved")
            });

        let route = Route::new_root().append(route);

        let mut req = Request::empty();
        req.headers_mut()
            .insert(header::COOKIE, "session=xyz789".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_response_has_cookie_jar() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|_req: Request| async { Ok("response test") });

        let route = Route::new_root().append(route);
        let req = Request::empty();

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());

        let resp = result.unwrap();
        // 响应应该有 CookieJar(即使是空的)
        let jar = resp.extensions().get::<CookieJar>();
        assert!(jar.is_some());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_concurrent_requests() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|_req: Request| async { Ok("concurrent") });

        let route: Arc<Route> = Arc::new(Route::new_root().append(route));

        // 并发多个请求
        let tasks = (0..5).map(|_| {
            let route = Arc::clone(&route);
            tokio::spawn(async move {
                let req = Request::empty();
                let result: Result<Response> = route.call(req).await;
                result
            })
        });

        for task in tasks {
            let result = task.await.unwrap();
            assert!(result.is_ok());
        }
    }

    // ==================== 边界条件测试 ====================

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_single_cookie() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("single")
            });

        let route = Route::new_root().append(route);

        let mut req = Request::empty();
        req.headers_mut()
            .insert(header::COOKIE, "only_one=value".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_cookie_with_special_chars() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("special chars")
            });

        let route = Route::new_root().append(route);

        // 创建包含特殊字符的 Cookie(URL 编码)
        let mut req = Request::empty();
        req.headers_mut().insert(
            header::COOKIE,
            "name=value%20with%20spaces".parse().unwrap(),
        );

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_chain_with_other_middleware() {
        use crate::middlewares::ExceptionHandler;
        use crate::route::Route;

        let cookie_middleware = CookieMiddleware::new();
        let exception_handler =
            ExceptionHandler::new(|result: Result<Response>, _configs| async move { result });

        let route = Route::new("/")
            .hook(cookie_middleware)
            .hook(exception_handler)
            .get(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("chained")
            });

        let route = Route::new_root().append(route);
        let req = Request::empty();

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

    #[cfg(feature = "server")]
    #[tokio::test]
    async fn test_cookie_middleware_different_http_methods() {
        use crate::route::Route;

        let middleware = CookieMiddleware::new();

        let route = Route::new("/")
            .hook(middleware)
            .get(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("GET")
            })
            .post(|req: Request| async move {
                let jar = req.extensions().get::<CookieJar>();
                assert!(jar.is_some());
                Ok("POST")
            });

        let route = Route::new_root().append(route);

        // 测试 GET
        let mut req = Request::empty();
        *req.method_mut() = http::Method::GET;
        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());

        // 测试 POST
        let mut req = Request::empty();
        *req.method_mut() = http::Method::POST;
        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }
}