limiteron 0.2.7

Unified flow control framework for Rust
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
// Copyright (c) 2026 Kirky.X
// SPDX-License-Identifier: MIT
//! 并行封禁检查器
//!
//! 专门负责高效的并行封禁检查,支持多种目标类型的并发验证。
//! 使用 `FuturesUnordered` 实现真正的并行提前退出机制。
//! 需要同时启用 `ban-manager` 和 `parallel-checker` feature。

use super::BanTarget;
use crate::error::{BanInfo, LimiteronError};
use crate::matchers::RequestContext;
use futures::stream::{FuturesUnordered, StreamExt};
use log::debug;
use std::sync::Arc;

use crate::ban::BanManager;

/// 并行封禁检查器
///
/// 提供高性能的多目标并行封禁检查功能。
/// 使用提前退出机制,一旦发现封禁立即返回,无需等待所有检查完成。
pub struct ParallelBanChecker {
    ban_manager: Arc<BanManager>,
}

impl ParallelBanChecker {
    /// 创建新的并行封禁检查器
    pub fn new(ban_manager: Arc<BanManager>) -> Self {
        Self { ban_manager }
    }

    /// 并行检查多个封禁目标(提前退出)
    ///
    /// 使用 `FuturesUnordered` 实现真正的并行提前退出机制:
    /// - 所有检查任务并行执行
    /// - 一旦发现第一个活跃封禁,立即返回,取消其他任务
    /// - 无需等待所有检查完成,提高性能
    pub async fn check_targets_parallel(
        &self,
        targets: &[BanTarget],
        _context: Option<&RequestContext>,
    ) -> Result<Option<BanInfo>, LimiteronError> {
        let start = std::time::Instant::now();

        debug!("开始并行封禁检查,目标数量: {}", targets.len());

        if targets.is_empty() {
            return Ok(None);
        }

        // 创建并行检查 futures 集合
        let mut check_futures = FuturesUnordered::new();

        for target in targets {
            let ban_manager = self.ban_manager.clone();
            let target_clone = target.clone();
            check_futures.push(async move {
                match ban_manager
                    .check_ban_priority(std::slice::from_ref(&target_clone))
                    .await
                {
                    Ok(Some(detail)) if detail.expires_at > chrono::Utc::now() => {
                        debug!(
                            "发现活跃封禁: 目标={:?}, 原因={}",
                            target_clone, detail.reason
                        );
                        Ok(Some(BanInfo::new(
                            detail.reason.clone(),
                            detail.expires_at,
                            detail.ban_times,
                        )))
                    }
                    Ok(_) => Ok(None),
                    Err(e) => Err(e),
                }
            });
        }

        // 按完成顺序处理结果,实现提前退出
        while let Some(result) = check_futures.next().await {
            match result {
                Ok(Some(ban_info)) => {
                    debug!("并行封禁检查完成(提前退出),耗时: {:?}", start.elapsed());
                    return Ok(Some(ban_info));
                }
                Ok(None) => continue,
                Err(e) => {
                    debug!("封禁检查出错: {}", e);
                    continue;
                }
            }
        }

        debug!("并行封禁检查完成,无封禁,耗时: {:?}", start.elapsed());
        Ok(None)
    }

    /// 快速检查单个封禁目标
    pub async fn check_single_target(
        &self,
        target: &BanTarget,
    ) -> Result<Option<BanInfo>, LimiteronError> {
        self.check_targets_parallel(std::slice::from_ref(target), None)
            .await
    }

    /// 检查用户ID是否被封禁
    pub async fn check_user_banned(
        &self,
        user_id: &str,
    ) -> Result<Option<BanInfo>, LimiteronError> {
        let target = BanTarget::UserId(user_id.to_string());
        self.check_single_target(&target).await
    }
}

#[cfg(test)]
#[allow(clippy::disallowed_types)]
mod tests {
    use super::*;
    use crate::ban::BanManager;
    use crate::error::StorageError;
    use crate::storage::{BanHistory, BanRecord, BanStorage};
    use async_trait::async_trait;
    use std::collections::HashMap;
    use tokio::sync::Mutex;

    struct TestBanStorage {
        bans: Mutex<HashMap<BanTarget, BanRecord>>,
    }

    impl TestBanStorage {
        fn new() -> Self {
            Self {
                bans: Mutex::new(HashMap::new()),
            }
        }
    }

    #[async_trait]
    impl BanStorage for TestBanStorage {
        async fn is_banned(&self, target: &BanTarget) -> Result<Option<BanRecord>, StorageError> {
            let bans = self.bans.lock().await;
            Ok(bans.get(target).cloned())
        }

        async fn save(&self, record: &BanRecord) -> Result<(), StorageError> {
            let mut bans = self.bans.lock().await;
            bans.insert(record.target.clone(), record.clone());
            Ok(())
        }

        async fn get_history(
            &self,
            _target: &BanTarget,
        ) -> Result<Option<BanHistory>, StorageError> {
            Ok(None)
        }
        async fn increment_ban_times(&self, _target: &BanTarget) -> Result<u64, StorageError> {
            Ok(0)
        }
        async fn get_ban_times(&self, _target: &BanTarget) -> Result<u64, StorageError> {
            Ok(0)
        }
        async fn remove_ban(&self, target: &BanTarget) -> Result<(), StorageError> {
            let mut bans = self.bans.lock().await;
            bans.remove(target);
            Ok(())
        }
        async fn cleanup_expired_bans(&self) -> Result<u64, StorageError> {
            Ok(0)
        }
        async fn list_bans(
            &self,
            _active_only: bool,
            _offset: u64,
            _limit: u64,
        ) -> Result<Vec<BanRecord>, StorageError> {
            Ok(Vec::new())
        }
        fn as_any(&self) -> &dyn std::any::Any {
            self
        }
    }

    #[tokio::test]
    async fn test_parallel_ban_checker() {
        let ban_storage = Arc::new(TestBanStorage::new());
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage.clone())
                .build()
                .await
                .unwrap(),
        );

        // Setup ban
        let banned_user = BanTarget::UserId("banned_user".to_string());
        let record = BanRecord {
            target: banned_user.clone(),
            ban_times: 1,
            duration: std::time::Duration::from_secs(3600),
            banned_at: chrono::Utc::now(),
            expires_at: chrono::Utc::now() + chrono::Duration::seconds(3600),
            is_manual: true,
            reason: "Test ban".to_string(),
        };
        ban_storage.save(&record).await.unwrap();

        let checker = ParallelBanChecker::new(ban_manager);

        // 测试多个目标的并行检查
        let targets = vec![
            BanTarget::UserId("test_user".to_string()),
            BanTarget::Ip("192.168.1.1".to_string()),
            BanTarget::Mac("AA:BB:CC:DD:EE:FF".to_string()),
        ];

        let result = checker
            .check_targets_parallel(&targets, None)
            .await
            .unwrap();
        assert!(result.is_none());

        // 测试单个目标检查
        let user_result = checker.check_user_banned("banned_user").await.unwrap();
        assert!(user_result.is_some());
    }

    #[tokio::test]
    async fn test_check_targets_parallel_empty_returns_none() {
        // 覆盖 targets.is_empty() 提前返回 Ok(None) 分支
        let ban_storage = Arc::new(TestBanStorage::new());
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage)
                .build()
                .await
                .unwrap(),
        );
        let checker = ParallelBanChecker::new(ban_manager);

        let empty_targets: Vec<BanTarget> = vec![];
        let result = checker
            .check_targets_parallel(&empty_targets, None)
            .await
            .unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn test_check_single_target_no_ban() {
        let ban_storage = Arc::new(TestBanStorage::new());
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage)
                .build()
                .await
                .unwrap(),
        );
        let checker = ParallelBanChecker::new(ban_manager);

        let target = BanTarget::Ip("10.0.0.1".to_string());
        let result = checker.check_single_target(&target).await.unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn test_check_user_banned_no_ban() {
        let ban_storage = Arc::new(TestBanStorage::new());
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage)
                .build()
                .await
                .unwrap(),
        );
        let checker = ParallelBanChecker::new(ban_manager);

        let result = checker.check_user_banned("innocent_user").await.unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn test_check_targets_parallel_with_active_ban() {
        let ban_storage = Arc::new(TestBanStorage::new());
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage.clone())
                .build()
                .await
                .unwrap(),
        );

        // Setup active ban on IP
        let banned_ip = BanTarget::Ip("203.0.113.5".to_string());
        let record = BanRecord {
            target: banned_ip.clone(),
            ban_times: 2,
            duration: std::time::Duration::from_secs(7200),
            banned_at: chrono::Utc::now(),
            expires_at: chrono::Utc::now() + chrono::Duration::seconds(7200),
            is_manual: false,
            reason: "Rate limit abuse".to_string(),
        };
        ban_storage.save(&record).await.unwrap();

        let checker = ParallelBanChecker::new(ban_manager);

        let targets = vec![
            BanTarget::UserId("user_a".to_string()),
            banned_ip,
            BanTarget::Mac("00:11:22:33:44:55".to_string()),
        ];

        let result = checker
            .check_targets_parallel(&targets, None)
            .await
            .unwrap();
        assert!(result.is_some());
        let info = result.unwrap();
        assert_eq!(info.reason(), "Rate limit abuse");
        assert_eq!(info.ban_times(), 2);
    }

    #[tokio::test]
    async fn test_check_single_target_with_ban() {
        let ban_storage = Arc::new(TestBanStorage::new());
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage.clone())
                .build()
                .await
                .unwrap(),
        );

        let banned_mac = BanTarget::Mac("AA:BB:CC:DD:EE:FF".to_string());
        let record = BanRecord {
            target: banned_mac.clone(),
            ban_times: 1,
            duration: std::time::Duration::from_secs(3600),
            banned_at: chrono::Utc::now(),
            expires_at: chrono::Utc::now() + chrono::Duration::seconds(3600),
            is_manual: true,
            reason: "Manual ban".to_string(),
        };
        ban_storage.save(&record).await.unwrap();

        let checker = ParallelBanChecker::new(ban_manager);
        let result = checker.check_single_target(&banned_mac).await.unwrap();
        assert!(result.is_some());
        let info = result.unwrap();
        assert_eq!(info.reason(), "Manual ban");
    }

    #[tokio::test]
    async fn test_check_user_banned_with_ban() {
        let ban_storage = Arc::new(TestBanStorage::new());
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage.clone())
                .build()
                .await
                .unwrap(),
        );

        let banned_user = BanTarget::UserId("bad_actor".to_string());
        let record = BanRecord {
            target: banned_user.clone(),
            ban_times: 3,
            duration: std::time::Duration::from_secs(86400),
            banned_at: chrono::Utc::now(),
            expires_at: chrono::Utc::now() + chrono::Duration::seconds(86400),
            is_manual: true,
            reason: "Repeat offender".to_string(),
        };
        ban_storage.save(&record).await.unwrap();

        let checker = ParallelBanChecker::new(ban_manager);
        let result = checker.check_user_banned("bad_actor").await.unwrap();
        assert!(result.is_some());
        let info = result.unwrap();
        assert_eq!(info.reason(), "Repeat offender");
        assert_eq!(info.ban_times(), 3);
    }

    /// 测试并行检查中存储返回错误时的错误路径
    /// 覆盖 check_targets_parallel 内 Err(e) 分支(line 76, 89, 90)
    #[tokio::test]
    async fn test_check_targets_parallel_storage_error() {
        // 这个存储总是从 is_banned 返回错误
        struct ErrorBanStorage;

        #[async_trait]
        impl BanStorage for ErrorBanStorage {
            async fn is_banned(
                &self,
                _target: &BanTarget,
            ) -> Result<Option<BanRecord>, StorageError> {
                Err(StorageError::ConnectionError("test error".to_string()))
            }
            async fn save(&self, _record: &BanRecord) -> Result<(), StorageError> {
                Ok(())
            }
            async fn get_history(
                &self,
                _target: &BanTarget,
            ) -> Result<Option<BanHistory>, StorageError> {
                Ok(None)
            }
            async fn increment_ban_times(&self, _target: &BanTarget) -> Result<u64, StorageError> {
                Ok(0)
            }
            async fn get_ban_times(&self, _target: &BanTarget) -> Result<u64, StorageError> {
                Ok(0)
            }
            async fn remove_ban(&self, _target: &BanTarget) -> Result<(), StorageError> {
                Ok(())
            }
            async fn cleanup_expired_bans(&self) -> Result<u64, StorageError> {
                Ok(0)
            }
            async fn list_bans(
                &self,
                _active_only: bool,
                _offset: u64,
                _limit: u64,
            ) -> Result<Vec<BanRecord>, StorageError> {
                Ok(Vec::new())
            }
            fn as_any(&self) -> &dyn std::any::Any {
                self
            }
        }

        let ban_storage: Arc<ErrorBanStorage> = Arc::new(ErrorBanStorage);
        let ban_manager = Arc::new(
            BanManager::builder()
                .with_storage(ban_storage)
                .build()
                .await
                .unwrap(),
        );
        let checker = ParallelBanChecker::new(ban_manager);

        // 使用 IP 目标:check_ban_priority 对 IP 用 `?` 传播错误,
        // 从而触发 parallel_checker 内 Err(e) 分支(line 76, 89, 90)
        let targets = vec![BanTarget::Ip("203.0.113.99".to_string())];

        // 即使存储返回错误,check_targets_parallel 应继续并最终返回 Ok(None)
        let result = checker
            .check_targets_parallel(&targets, None)
            .await
            .unwrap();
        assert!(result.is_none());
    }
}