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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
use crate::{Handler, MiddleWareHandler, Next, Request, Response, Result};
use async_trait::async_trait;
use chrono::Utc;

/// 请求耗时日志中间件
///
/// # 已弃用
///
/// 此中间件将在 v2.17.0 版本移除,请使用 [`Logger`](super::Logger) 替代。
///
/// `Logger` 相比 `RequestTimeLogger` 的改进:
/// - 使用 `Instant` 单调时钟替代 `Utc::now().time()`,避免跨午夜负值问题
/// - 使用 tracing 结构化字段替代位置参数字符串
/// - 安全获取客户端 IP,不再 panic
/// - 区分 4xx(WARN)和 5xx(ERROR)日志级别
///
/// ```rust
/// use silent::prelude::*;
/// use silent::middlewares::RequestTimeLogger;
///
/// let _ = RequestTimeLogger::new();
/// ```
#[deprecated(since = "2.15.0", note = "将在 v2.17.0 移除,请使用 Logger 替代")]
#[derive(Default, Clone)]
pub struct RequestTimeLogger;

#[allow(deprecated)]
impl RequestTimeLogger {
    pub fn new() -> Self {
        Self {}
    }
}

#[allow(deprecated)]
#[async_trait]
impl MiddleWareHandler for RequestTimeLogger {
    async fn handle(&self, req: Request, next: &Next) -> Result<Response> {
        let method = req.method().clone();
        let url = req.uri().to_string().clone();
        let http_version = req.version();
        let peer_addr = req.remote();
        let start_time = Utc::now().time();
        let res = next.call(req).await;
        let end_time = Utc::now().time();
        let req_time = end_time - start_time;
        Ok(match res {
            Ok(res) => {
                if res.status.as_u16() >= 400 {
                    tracing::warn!(
                        "{} {} {} {:?} {} {:?} {}",
                        peer_addr,
                        method,
                        url,
                        http_version,
                        res.status.as_u16(),
                        res.content_length().lower(),
                        req_time.num_nanoseconds().unwrap_or(0) as f64 / 1000000.0
                    );
                } else {
                    tracing::info!(
                        "{} {} {} {:?} {} {:?} {}",
                        peer_addr,
                        method,
                        url,
                        http_version,
                        res.status.as_u16(),
                        res.content_length().lower(),
                        req_time.num_nanoseconds().unwrap_or(0) as f64 / 1000000.0
                    );
                }
                res
            }
            Err(e) => {
                tracing::error!(
                    "{} {} {} {:?} {} {:?} {} {}",
                    peer_addr,
                    method,
                    url,
                    http_version,
                    e.status().as_u16(),
                    0,
                    req_time.num_nanoseconds().unwrap_or(0) as f64 / 1000000.0,
                    e.to_string()
                );
                e.into()
            }
        })
    }
}

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

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

    #[test]
    fn test_request_time_logger_new() {
        let logger = RequestTimeLogger::new();
        let _ = logger;
    }

    #[test]
    fn test_request_time_logger_default() {
        let logger = RequestTimeLogger::new();
        let _ = logger;
    }

    // ==================== Clone trait 测试 ====================

    #[test]
    fn test_request_time_logger_clone() {
        let logger1 = RequestTimeLogger::new();
        let logger2 = logger1.clone();
        let _ = logger1;
        let _ = logger2;
    }

    #[test]
    fn test_request_time_logger_clone_independent() {
        let logger1 = RequestTimeLogger::new();
        let logger2 = logger1.clone();

        // 两个实例应该独立存在
        let _ = logger1;
        let _ = logger2;
    }

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

    #[test]
    fn test_request_time_logger_type() {
        let logger = RequestTimeLogger::new();
        // 验证类型
        let _logger: RequestTimeLogger = logger;
    }

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

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

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

        let logger = RequestTimeLogger::new();

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

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
        let resp = result.unwrap();
        // 成功响应状态码应该是 200
        assert_eq!(resp.status.as_u16(), 200);
    }

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

        let logger = RequestTimeLogger::new();

        let route = Route::new("/").hook(logger).get(|_req: Request| async {
            let mut resp = Response::text("not found");
            resp.set_status(http::StatusCode::NOT_FOUND);
            Ok(resp)
        });

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
        let resp = result.unwrap();
        // 404 状态码应该触发 warn 日志
        assert_eq!(resp.status.as_u16(), 404);
    }

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

        let logger = RequestTimeLogger::new();

        let route = Route::new("/").hook(logger).get(|_req: Request| async {
            let mut resp = Response::text("internal error");
            resp.set_status(http::StatusCode::INTERNAL_SERVER_ERROR);
            Ok(resp)
        });

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
        let resp = result.unwrap();
        // 500 状态码应该触发 warn 日志
        assert_eq!(resp.status.as_u16(), 500);
    }

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

        let logger = RequestTimeLogger::new();

        let route = Route::new("/").hook(logger).get(|_req: Request| async {
            Err::<&str, _>(crate::SilentError::business_error(
                http::StatusCode::BAD_REQUEST,
                "bad request".to_string(),
            ))
        });

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        // RequestTimeLogger 会记录错误并转换为响应,所以返回成功
        assert!(result.is_ok());
        let resp = result.unwrap();
        // 错误状态码应该被保留
        assert_eq!(resp.status.as_u16(), 400);
    }

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

        let logger = RequestTimeLogger::new();

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

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

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

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

        let logger = RequestTimeLogger::new();

        let route = Route::new("/")
            .hook(logger)
            .get(|_req: Request| async { Ok(Response::text("response with body")) });

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
        let resp = result.unwrap();
        assert_eq!(resp.status.as_u16(), 200);
    }

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

        let logger = RequestTimeLogger::new();

        let route = Route::new("/").hook(logger).get(|_req: Request| async {
            let mut resp = Response::text("test response");
            resp.set_status(http::StatusCode::ACCEPTED);
            Ok(resp)
        });

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
        let resp = result.unwrap();
        // 中间件应该保留原始响应
        assert_eq!(resp.status.as_u16(), 202);
    }

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

        let logger = RequestTimeLogger::new();

        let route = Route::new("/")
            .hook(logger)
            .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 mut req = Request::empty();
                req.headers_mut()
                    .insert("x-real-ip", "127.0.0.1".parse().unwrap());
                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_request_time_logger_different_http_methods() {
        use crate::route::Route;

        let logger = RequestTimeLogger::new();

        let route = Route::new("/")
            .hook(logger)
            .get(|_req: Request| async { Ok("GET") })
            .post(|_req: Request| async { Ok("POST") })
            .put(|_req: Request| async { Ok("PUT") });

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

        // 测试 GET
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());
        *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.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());
        *req.method_mut() = http::Method::POST;
        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());

        // 测试 PUT
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());
        *req.method_mut() = http::Method::PUT;
        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
    }

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

        let logger = RequestTimeLogger::new();

        // 测试 2xx 成功状态
        let route1 = Route::new("/")
            .hook(logger.clone())
            .get(|_req: Request| async {
                let mut resp = Response::text("OK");
                resp.set_status(http::StatusCode::OK);
                Ok(resp)
            });

        // 测试 3xx 重定向状态
        let route2 = Route::new("/")
            .hook(logger.clone())
            .get(|_req: Request| async {
                let mut resp = Response::empty();
                resp.set_status(http::StatusCode::FOUND);
                Ok(resp)
            });

        // 测试 4xx 客户端错误
        let route3 = Route::new("/")
            .hook(logger.clone())
            .get(|_req: Request| async {
                let mut resp = Response::text("Bad Request");
                resp.set_status(http::StatusCode::BAD_REQUEST);
                Ok(resp)
            });

        // 测试 5xx 服务器错误
        let route4 = Route::new("/").hook(logger).get(|_req: Request| async {
            let mut resp = Response::text("Internal Server Error");
            resp.set_status(http::StatusCode::INTERNAL_SERVER_ERROR);
            Ok(resp)
        });

        for route in &[route1, route2, route3, route4] {
            let route = Route::new_root().append(route.clone());
            let mut req = Request::empty();
            req.headers_mut()
                .insert("x-real-ip", "127.0.0.1".parse().unwrap());
            let result: Result<Response> = route.call(req).await;
            assert!(result.is_ok());
        }
    }

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

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

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

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

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

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

        let logger1 = RequestTimeLogger::new();
        let logger2 = RequestTimeLogger::new();

        let route = Route::new("/")
            .hook(logger1)
            .hook(logger2)
            .get(|_req: Request| async { Ok("multiple loggers") });

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

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

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

        let logger = RequestTimeLogger::new();

        let route = Route::new("/").hook(logger).get(|_req: Request| async {
            let mut resp = Response::text("with headers");
            resp.headers_mut()
                .insert("X-Custom-Header", "test-value".parse().unwrap());
            Ok(resp)
        });

        let route = Route::new_root().append(route);
        let mut req = Request::empty();
        req.headers_mut()
            .insert("x-real-ip", "127.0.0.1".parse().unwrap());

        let result: Result<Response> = route.call(req).await;
        assert!(result.is_ok());
        let resp = result.unwrap();
        assert!(resp.headers().get("X-Custom-Header").is_some());
    }

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

        let logger = RequestTimeLogger::new();

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

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

        // 测试不同的 URL 路径(只测试会匹配的 URL)
        for url in &["/test", "/test?query=value", "/test?foo=bar&baz=qux"] {
            let mut req = Request::empty();
            req.headers_mut()
                .insert("x-real-ip", "127.0.0.1".parse().unwrap());
            *req.uri_mut() = url.parse().unwrap();
            let result: Result<Response> = route.call(req).await;
            assert!(result.is_ok());
        }
    }
}