limiteron 0.1.1

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
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
//! Copyright (c) 2026, Kirky.X
//!
//! MIT License
//!
//! 限流器工厂模块
//!
//! 提供统一的限流器创建接口,支持通过配置动态创建各种限流器。
//!
//! # 特性
//!
//! - **统一创建接口** - 通过配置动态创建限流器
//! - **类型安全** - 编译时类型检查
//! - **扩展性强** - 易于添加新的限流器类型
//! - **错误处理** - 完善的错误信息和类型

use crate::config::LimiterConfig;
use crate::error::FlowGuardError;
use crate::limiters::{
    ConcurrencyLimiter, FixedWindowLimiter, Limiter, SlidingWindowLimiter, TokenBucketLimiter,
};
use std::sync::Arc;

/// 配置限制常量
///
/// 这些限制值基于以下考虑:
/// - MAX_TOKEN_BUCKET_CAPACITY: 防止内存过度消耗,假设每个令牌占用1字节,10M令牌约10MB内存
/// - MAX_TOKEN_BUCKET_REFILL_RATE: 防止CPU过度消耗,每秒100万次补充操作可能导致性能问题
/// - MAX_WINDOW_REQUESTS: 防止窗口数据结构过大,影响内存和性能
/// - MAX_CONCURRENT_REQUESTS: 防止并发控制结构过大,影响系统稳定性
const MAX_TOKEN_BUCKET_CAPACITY: u64 = 10_000_000;
const MAX_TOKEN_BUCKET_REFILL_RATE: u64 = 1_000_000;
const MAX_WINDOW_REQUESTS: u64 = 10_000_000;
const MAX_CONCURRENT_REQUESTS: u64 = 100_000;

/// 限流器工厂
///
/// 提供统一的限流器创建接口,支持从配置创建各种限流器。
///
/// # 示例
///
/// ```rust
/// use limiteron::factory::LimiterFactory;
/// use limiteron::config::LimiterConfig;
///
/// // 创建令牌桶限流器
/// let config = LimiterConfig::TokenBucket {
///     capacity: 1000,
///     refill_rate: 100,
/// };
/// let limiter = LimiterFactory::create(&config).unwrap();
/// ```
pub struct LimiterFactory;

impl LimiterFactory {
    /// 从配置创建限流器
    ///
    /// # 参数
    /// - `config`: 限流器配置
    ///
    /// # 返回
    /// - `Ok(Arc<dyn Limiter>)`: 创建成功的限流器
    /// - `Err(FlowGuardError)`: 创建失败
    ///
    /// # 示例
    ///
    /// ```rust
    /// use limiteron::factory::LimiterFactory;
    /// use limiteron::config::LimiterConfig;
    ///
    /// let config = LimiterConfig::TokenBucket {
    ///     capacity: 1000,
    ///     refill_rate: 100,
    /// };
    /// let limiter = LimiterFactory::create(&config).unwrap();
    /// ```
    pub fn create(config: &LimiterConfig) -> Result<Arc<dyn Limiter>, FlowGuardError> {
        match config {
            LimiterConfig::TokenBucket {
                capacity,
                refill_rate,
            } => Ok(Arc::new(TokenBucketLimiter::new(*capacity, *refill_rate))),
            LimiterConfig::SlidingWindow {
                window_size,
                max_requests,
            } => {
                let duration = Self::parse_window_size(window_size)?;
                Ok(Arc::new(SlidingWindowLimiter::new(duration, *max_requests)))
            }
            LimiterConfig::FixedWindow {
                window_size,
                max_requests,
            } => {
                let duration = Self::parse_window_size(window_size)?;
                Ok(Arc::new(FixedWindowLimiter::new(duration, *max_requests)))
            }
            LimiterConfig::Concurrency { max_concurrent } => {
                Ok(Arc::new(ConcurrencyLimiter::new(*max_concurrent)))
            }
            LimiterConfig::Quota {
                quota_type: _,
                limit: _limit,
                window: _window,
                overdraft: _,
            } => {
                // Quota 类型由QuotaController处理
                Err(FlowGuardError::LimitError(
                    "Quota 限流器类型需要由QuotaController处理".to_string(),
                ))
            }
            LimiterConfig::Custom { .. } => {
                // Custom 类型由CustomLimiterRegistry处理
                Err(FlowGuardError::LimitError(
                    "Custom 限流器类型需要由CustomLimiterRegistry处理".to_string(),
                ))
            }
        }
    }

    /// 批量创建限流器
    ///
    /// # 参数
    /// - `configs`: 限流器配置列表
    ///
    /// # 返回
    /// - `Ok(Vec<Arc<dyn Limiter>>)`: 创建成功的限流器列表
    /// - `Err(FlowGuardError)`: 创建失败
    ///
    /// # 示例
    ///
    /// ```rust
    /// use limiteron::factory::LimiterFactory;
    /// use limiteron::config::LimiterConfig;
    ///
    /// let configs = vec![
    ///     LimiterConfig::TokenBucket { capacity: 1000, refill_rate: 100 },
    ///     LimiterConfig::Concurrency { max_concurrent: 50 },
    /// ];
    /// let limiters = LimiterFactory::create_batch(&configs).unwrap();
    /// ```
    pub fn create_batch(
        configs: &[LimiterConfig],
    ) -> Result<Vec<Arc<dyn Limiter>>, FlowGuardError> {
        let mut limiters = Vec::with_capacity(configs.len());

        for (index, config) in configs.iter().enumerate() {
            let limiter = Self::create(config).map_err(|e| {
                FlowGuardError::LimitError(format!("创建第 {} 个限流器失败: {}", index + 1, e))
            })?;
            limiters.push(limiter);
        }

        Ok(limiters)
    }

    /// 解析窗口大小字符串
    ///
    /// # 参数
    /// - `window_size`: 窗口大小字符串(如 "1s", "1m", "1h")
    ///
    /// # 返回
    /// - `Ok(Duration)`: 解析成功的时间段
    /// - `Err(FlowGuardError)`: 解析失败
    ///
    /// # 支持的格式
    ///
    /// - `10s` - 10秒
    /// - `5m` - 5分钟  
    /// - `2h` - 2小时
    /// - `1d` - 1天
    ///
    /// # 示例
    ///
    /// ```rust
    /// use limiteron::factory::LimiterFactory;
    /// use std::time::Duration;
    ///
    /// let duration = LimiterFactory::parse_window_size("5m").unwrap();
    /// assert_eq!(duration, Duration::from_secs(300));
    /// ```
    pub fn parse_window_size(window_size: &str) -> Result<std::time::Duration, FlowGuardError> {
        if window_size.is_empty() {
            return Err(FlowGuardError::ConfigError("窗口大小不能为空".to_string()));
        }

        let (num_part, unit_part) = window_size.split_at(
            window_size
                .find(|c: char| c.is_alphabetic())
                .unwrap_or(window_size.len()),
        );

        let num_str = num_part.trim();
        let unit = unit_part.trim().to_lowercase();

        if num_str.is_empty() {
            return Err(FlowGuardError::ConfigError(
                "窗口大小格式错误:缺少数字部分".to_string(),
            ));
        }

        let num: u64 = num_str
            .parse()
            .map_err(|_| FlowGuardError::ConfigError(format!("无效的数字格式: {}", num_str)))?;

        if num == 0 {
            return Err(FlowGuardError::ConfigError("窗口大小必须大于0".to_string()));
        }

        let duration = match unit.as_str() {
            "s" | "sec" | "second" | "seconds" => std::time::Duration::from_secs(num),
            "m" | "min" | "minute" | "minutes" => std::time::Duration::from_secs(num * 60),
            "h" | "hr" | "hour" | "hours" => std::time::Duration::from_secs(num * 3600),
            "d" | "day" | "days" => std::time::Duration::from_secs(num * 86400),
            _ => {
                return Err(FlowGuardError::ConfigError(format!(
                    "不支持的单位: {}。支持的单位: s, m, h, d",
                    unit
                )));
            }
        };

        Ok(duration)
    }

    /// 验证限流器配置
    ///
    /// # 参数
    /// - `config`: 要验证的限流器配置
    ///
    /// # 返回
    /// - `Ok(())`: 验证通过
    /// - `Err(FlowGuardError)`: 验证失败
    ///
    /// # 示例
    ///
    /// ```rust
    /// use limiteron::factory::LimiterFactory;
    /// use limiteron::config::LimiterConfig;
    ///
    /// let config = LimiterConfig::TokenBucket { capacity: 1000, refill_rate: 100 };
    /// LimiterFactory::validate_config(&config).unwrap();
    /// ```

    /// 验证窗口配置(适用于滑动窗口和固定窗口)
    fn validate_window_config(
        window_size: &str,
        max_requests: u64,
        limiter_type: &str,
    ) -> Result<(), FlowGuardError> {
        Self::parse_window_size(window_size)?;
        if max_requests == 0 {
            return Err(FlowGuardError::ConfigError(format!(
                "{}最大请求数必须大于0",
                limiter_type
            )));
        }
        if max_requests > MAX_WINDOW_REQUESTS {
            return Err(FlowGuardError::ConfigError(format!(
                "{}最大请求数过大,最大值为{}",
                limiter_type, MAX_WINDOW_REQUESTS
            )));
        }
        Ok(())
    }

    pub fn validate_config(config: &LimiterConfig) -> Result<(), FlowGuardError> {
        match config {
            LimiterConfig::TokenBucket {
                capacity,
                refill_rate,
            } => {
                if *capacity == 0 {
                    return Err(FlowGuardError::ConfigError(
                        "令牌桶容量必须大于0".to_string(),
                    ));
                }
                if *refill_rate == 0 {
                    return Err(FlowGuardError::ConfigError(
                        "令牌桶补充速率必须大于0".to_string(),
                    ));
                }
                if *capacity > MAX_TOKEN_BUCKET_CAPACITY {
                    return Err(FlowGuardError::ConfigError(format!(
                        "令牌桶容量过大,最大值为{}",
                        MAX_TOKEN_BUCKET_CAPACITY
                    )));
                }
                if *refill_rate > MAX_TOKEN_BUCKET_REFILL_RATE {
                    return Err(FlowGuardError::ConfigError(format!(
                        "令牌桶补充速率过大,最大值为{}",
                        MAX_TOKEN_BUCKET_REFILL_RATE
                    )));
                }
            }
            LimiterConfig::SlidingWindow {
                window_size,
                max_requests,
            } => {
                Self::validate_window_config(window_size, *max_requests, "滑动窗口")?;
            }
            LimiterConfig::FixedWindow {
                window_size,
                max_requests,
            } => {
                Self::validate_window_config(window_size, *max_requests, "固定窗口")?;
            }
            LimiterConfig::Concurrency { max_concurrent } => {
                if *max_concurrent == 0 {
                    return Err(FlowGuardError::ConfigError(
                        "并发限制数必须大于0".to_string(),
                    ));
                }
                if *max_concurrent > MAX_CONCURRENT_REQUESTS {
                    return Err(FlowGuardError::ConfigError(format!(
                        "并发限制数过大,最大值为{}",
                        MAX_CONCURRENT_REQUESTS
                    )));
                }
            }
            LimiterConfig::Quota { .. } => {
                // Quota 类型由QuotaController处理
                return Err(FlowGuardError::LimitError(
                    "Quota 限流器类型需要由QuotaController处理".to_string(),
                ));
            }
            LimiterConfig::Custom { .. } => {
                // Custom 类型由CustomLimiterRegistry处理
                return Err(FlowGuardError::LimitError(
                    "Custom 限流器类型需要由CustomLimiterRegistry处理".to_string(),
                ));
            }
        }

        Ok(())
    }
}

// ============================================================================
// 单元测试
// ============================================================================

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

    #[test]
    fn test_create_token_bucket() {
        let config = LimiterConfig::TokenBucket {
            capacity: 1000,
            refill_rate: 100,
        };

        let limiter = LimiterFactory::create(&config);
        assert!(limiter.is_ok());
    }

    #[test]
    fn test_create_sliding_window() {
        let config = LimiterConfig::SlidingWindow {
            window_size: "1m".to_string(),
            max_requests: 60,
        };

        let limiter = LimiterFactory::create(&config);
        assert!(limiter.is_ok());
    }

    #[test]
    fn test_create_fixed_window() {
        let config = LimiterConfig::FixedWindow {
            window_size: "30s".to_string(),
            max_requests: 30,
        };

        let limiter = LimiterFactory::create(&config);
        assert!(limiter.is_ok());
    }

    #[test]
    fn test_create_concurrency() {
        let config = LimiterConfig::Concurrency { max_concurrent: 50 };

        let limiter = LimiterFactory::create(&config);
        assert!(limiter.is_ok());
    }

    #[test]
    fn test_create_batch() {
        let configs = vec![
            LimiterConfig::TokenBucket {
                capacity: 1000,
                refill_rate: 100,
            },
            LimiterConfig::Concurrency { max_concurrent: 50 },
        ];

        let limiters = LimiterFactory::create_batch(&configs);
        assert!(limiters.is_ok());
        assert_eq!(limiters.unwrap().len(), 2);
    }

    #[test]
    fn test_parse_window_size_seconds() {
        let duration = LimiterFactory::parse_window_size("10s");
        assert!(duration.is_ok());
        assert_eq!(duration.unwrap(), Duration::from_secs(10));
    }

    #[test]
    fn test_parse_window_size_minutes() {
        let duration = LimiterFactory::parse_window_size("5m");
        assert!(duration.is_ok());
        assert_eq!(duration.unwrap(), Duration::from_secs(5 * 60));
    }

    #[test]
    fn test_parse_window_size_hours() {
        let duration = LimiterFactory::parse_window_size("2h");
        assert!(duration.is_ok());
        assert_eq!(duration.unwrap(), Duration::from_secs(2 * 3600));
    }

    #[test]
    fn test_parse_window_size_days() {
        let duration = LimiterFactory::parse_window_size("1d");
        assert!(duration.is_ok());
        assert_eq!(duration.unwrap(), Duration::from_secs(24 * 3600));
    }

    #[test]
    fn test_parse_window_size_invalid() {
        let duration = LimiterFactory::parse_window_size("invalid");
        assert!(duration.is_err());
    }

    #[test]
    fn test_parse_window_size_empty() {
        let duration = LimiterFactory::parse_window_size("");
        assert!(duration.is_err());
    }

    #[test]
    fn test_parse_window_size_zero() {
        let duration = LimiterFactory::parse_window_size("0s");
        assert!(duration.is_err());
    }

    #[test]
    fn test_validate_token_bucket_valid() {
        let config = LimiterConfig::TokenBucket {
            capacity: 1000,
            refill_rate: 100,
        };

        let result = LimiterFactory::validate_config(&config);
        assert!(result.is_ok());
    }

    #[test]
    fn test_validate_token_bucket_invalid_capacity() {
        let config = LimiterConfig::TokenBucket {
            capacity: 0,
            refill_rate: 100,
        };

        let result = LimiterFactory::validate_config(&config);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_token_bucket_invalid_refill() {
        let config = LimiterConfig::TokenBucket {
            capacity: 1000,
            refill_rate: 0,
        };

        let result = LimiterFactory::validate_config(&config);
        assert!(result.is_err());
    }

    #[test]
    fn test_validate_concurrency_valid() {
        let config = LimiterConfig::Concurrency { max_concurrent: 50 };

        let result = LimiterFactory::validate_config(&config);
        assert!(result.is_ok());
    }

    #[test]
    fn test_validate_concurrency_invalid() {
        let config = LimiterConfig::Concurrency { max_concurrent: 0 };

        let result = LimiterFactory::validate_config(&config);
        assert!(result.is_err());
    }
}