limiteron 0.2.6

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
// Copyright (c) 2026 Kirky.X
// SPDX-License-Identifier: MIT
//! 并发控制器模块
//!
//! 使用信号量实现并发控制。

use super::traits::Limiter;
use crate::error::LimiteronError;
use async_trait::async_trait;
use std::sync::Arc;
use std::time::Duration;

/// 并发控制器
///
/// 使用信号量实现并发控制,限制同时进行的操作数量。
/// 支持超时机制和取消操作。
///
/// # 特性
/// - 使用 tokio::sync::Semaphore 管理并发数
/// - 支持超时机制
/// - 支持取消操作
/// - 无死锁风险
/// - 支持依赖注入模式
///
/// # 示例
/// ```rust
/// use limiteron::limiters::ConcurrencyLimiter;
///
/// #[tokio::main]
/// async fn main() {
///     // 创建最大并发数为 10 的并发控制器
///     let limiter = ConcurrencyLimiter::new(10);
///
///     // 尝试获取许可
///     let permit = limiter.acquire(1).await.unwrap();
///     // 使用许可...
///     drop(permit); // 释放许可
/// }
/// ```
pub struct ConcurrencyLimiter {
    /// 信号量,用于管理并发数
    semaphore: Arc<tokio::sync::Semaphore>,
    /// 超时时间
    timeout: Option<Duration>,
    /// 最大并发数
    max_concurrent: u64,
}

/// ConcurrencyLimiter 构建器
///
/// 用于链式配置 ConcurrencyLimiter 实例。
///
/// # 示例
///
/// ```rust
/// use limiteron::limiters::ConcurrencyLimiter;
/// use std::time::Duration;
///
/// let limiter = ConcurrencyLimiter::builder()
///     .max_concurrent(10)
///     .timeout(Duration::from_secs(5))
///     .build();
/// ```
#[derive(Default)]
pub struct ConcurrencyLimiterBuilder {
    max_concurrent: Option<u64>,
    timeout: Option<Duration>,
    semaphore: Option<Arc<tokio::sync::Semaphore>>,
}

impl ConcurrencyLimiterBuilder {
    /// 创建新的 ConcurrencyLimiterBuilder
    pub fn new() -> Self {
        Self {
            max_concurrent: None,
            timeout: None,
            semaphore: None,
        }
    }

    /// 设置最大并发数
    pub fn max_concurrent(mut self, max_concurrent: u64) -> Self {
        self.max_concurrent = Some(max_concurrent);
        self
    }

    /// 设置超时时间
    pub fn timeout(mut self, timeout: Duration) -> Self {
        self.timeout = Some(timeout);
        self
    }

    /// 设置外部信号量(用于依赖注入)
    pub fn with_semaphore(mut self, semaphore: Arc<tokio::sync::Semaphore>) -> Self {
        self.semaphore = Some(semaphore);
        self
    }

    /// 构建 ConcurrencyLimiter 实例
    pub fn build(self) -> Result<ConcurrencyLimiter, LimiteronError> {
        if let Some(semaphore) = self.semaphore {
            return Ok(ConcurrencyLimiter {
                semaphore,
                timeout: self.timeout,
                max_concurrent: 0,
            });
        }

        let max_concurrent = self
            .max_concurrent
            .ok_or_else(|| LimiteronError::ConfigError("max_concurrent is required".to_string()))?;

        if max_concurrent == 0 {
            return Err(LimiteronError::ConfigError(
                "max_concurrent must be greater than 0".to_string(),
            ));
        }

        Ok(ConcurrencyLimiter {
            semaphore: Arc::new(tokio::sync::Semaphore::new(max_concurrent as usize)),
            timeout: self.timeout,
            max_concurrent,
        })
    }
}

impl ConcurrencyLimiter {
    /// 创建新的并发控制器
    ///
    /// # 参数
    /// - `max_concurrent`: 最大并发数
    ///
    /// # 示例
    /// ```rust
    /// use limiteron::limiters::ConcurrencyLimiter;
    ///
    /// let limiter = ConcurrencyLimiter::new(10);
    /// ```
    pub fn new(max_concurrent: u64) -> Self {
        Self {
            semaphore: Arc::new(tokio::sync::Semaphore::new(max_concurrent as usize)),
            timeout: None,
            max_concurrent,
        }
    }

    /// 创建带超时的并发控制器
    pub fn with_timeout(max_concurrent: u64, timeout: Duration) -> Self {
        Self {
            semaphore: Arc::new(tokio::sync::Semaphore::new(max_concurrent as usize)),
            timeout: Some(timeout),
            max_concurrent,
        }
    }

    /// 创建 ConcurrencyLimiterBuilder 用于链式配置
    pub fn builder() -> ConcurrencyLimiterBuilder {
        ConcurrencyLimiterBuilder::new()
    }

    /// 使用依赖注入创建 ConcurrencyLimiter 实例
    pub fn with_dependencies(
        semaphore: Arc<tokio::sync::Semaphore>,
        timeout: Option<Duration>,
    ) -> Self {
        Self {
            semaphore,
            timeout,
            max_concurrent: 0,
        }
    }

    /// 获取最大并发数
    pub fn max_concurrent(&self) -> u64 {
        self.max_concurrent
    }

    /// 获取超时时间
    pub fn timeout(&self) -> Option<Duration> {
        self.timeout
    }

    /// 获取许可并执行操作
    pub async fn acquire(
        &self,
        cost: u64,
    ) -> Result<tokio::sync::SemaphorePermit<'_>, LimiteronError> {
        let cost_u32 = cost as u32;
        if cost_u32 as u64 != cost {
            return Err(LimiteronError::LimitError(
                "许可数量超出 u32 范围".to_string(),
            ));
        }

        let permit = match self.timeout {
            Some(timeout) => tokio::time::timeout(timeout, self.semaphore.acquire_many(cost_u32))
                .await
                .map_err(|_| LimiteronError::LimitError("获取许可超时".to_string()))?
                .map_err(|_| LimiteronError::LimitError("信号量已关闭".to_string()))?,
            None => self
                .semaphore
                .acquire_many(cost_u32)
                .await
                .map_err(|_| LimiteronError::LimitError("信号量已关闭".to_string()))?,
        };

        Ok(permit)
    }

    /// 获取当前可用的许可数(仅用于测试)
    #[cfg(test)]
    fn available_permits(&self) -> usize {
        self.semaphore.available_permits()
    }

    /// 尝试获取许可(非阻塞)
    #[cfg(test)]
    fn try_acquire(&self, cost: u64) -> Result<tokio::sync::SemaphorePermit<'_>, LimiteronError> {
        let cost_u32 = cost as u32;
        if cost_u32 as u64 != cost {
            return Err(LimiteronError::LimitError(
                "许可数量超出 u32 范围".to_string(),
            ));
        }

        self.semaphore
            .try_acquire_many(cost_u32)
            .map_err(|e| LimiteronError::LimitError(format!("获取许可失败: {:?}", e)))
    }
}

#[async_trait]
impl Limiter for ConcurrencyLimiter {
    async fn allow(&self, cost: u64) -> Result<bool, LimiteronError> {
        let cost_u32 = cost as u32;
        if cost_u32 as u64 != cost {
            return Err(LimiteronError::LimitError(
                "许可数量超出 u32 范围".to_string(),
            ));
        }

        match self.semaphore.try_acquire_many(cost_u32) {
            Ok(_permit) => Ok(true),
            Err(_) => Ok(false),
        }
    }
}

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

    #[tokio::test]
    async fn test_concurrency_basic() {
        let limiter = ConcurrencyLimiter::new(10);

        let permit = limiter.acquire(1).await.unwrap();
        assert_eq!(limiter.available_permits(), 9);
        drop(permit);
        assert_eq!(limiter.available_permits(), 10);
    }

    #[tokio::test]
    async fn test_concurrency_try_acquire() {
        let limiter = ConcurrencyLimiter::new(2);

        // 保存 permit 以保持许可占用
        let permit1 = limiter.try_acquire(1);
        let permit2 = limiter.try_acquire(1);
        let permit3 = limiter.try_acquire(1);

        assert!(permit1.is_ok(), "第一次获取应该成功");
        assert!(permit2.is_ok(), "第二次获取应该成功");
        assert!(permit3.is_err(), "第三次获取应该失败,因为已达上限");

        // permit1 和 permit2 在此处 drop,释放许可
    }

    #[tokio::test]
    async fn test_concurrency_builder() {
        let limiter = ConcurrencyLimiter::builder()
            .max_concurrent(5)
            .timeout(Duration::from_secs(1))
            .build()
            .unwrap();
        assert_eq!(limiter.max_concurrent(), 5);
        assert_eq!(limiter.timeout(), Some(Duration::from_secs(1)));
    }

    #[tokio::test]
    async fn test_concurrency_builder_missing_max_concurrent() {
        let result = ConcurrencyLimiter::builder().build();
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_concurrency_builder_zero_max_concurrent() {
        let result = ConcurrencyLimiter::builder().max_concurrent(0).build();
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_concurrency_builder_with_semaphore() {
        let semaphore = Arc::new(tokio::sync::Semaphore::new(20));
        let limiter = ConcurrencyLimiter::builder()
            .with_semaphore(semaphore)
            .build()
            .unwrap();
        assert_eq!(limiter.available_permits(), 20);
    }

    #[tokio::test]
    async fn test_concurrency_with_timeout() {
        let limiter = ConcurrencyLimiter::with_timeout(2, Duration::from_millis(100));
        assert_eq!(limiter.max_concurrent(), 2);
        assert_eq!(limiter.timeout(), Some(Duration::from_millis(100)));
    }

    #[tokio::test]
    async fn test_concurrency_with_dependencies() {
        let semaphore = Arc::new(tokio::sync::Semaphore::new(15));
        let limiter =
            ConcurrencyLimiter::with_dependencies(semaphore, Some(Duration::from_secs(2)));
        assert_eq!(limiter.available_permits(), 15);
        assert_eq!(limiter.timeout(), Some(Duration::from_secs(2)));
    }

    #[tokio::test]
    async fn test_concurrency_multiple_acquire() {
        let limiter = ConcurrencyLimiter::new(3);
        let p1 = limiter.acquire(1).await.unwrap();
        let p2 = limiter.acquire(1).await.unwrap();
        let p3 = limiter.acquire(1).await.unwrap();
        assert_eq!(limiter.available_permits(), 0);
        drop(p1);
        assert_eq!(limiter.available_permits(), 1);
        drop(p2);
        drop(p3);
        assert_eq!(limiter.available_permits(), 3);
    }

    #[tokio::test]
    async fn test_concurrency_acquire_cost() {
        let limiter = ConcurrencyLimiter::new(10);
        let p = limiter.acquire(5).await.unwrap();
        assert_eq!(limiter.available_permits(), 5);
        drop(p);
        assert_eq!(limiter.available_permits(), 10);
    }

    #[tokio::test]
    async fn test_concurrency_limiter_trait() {
        use super::super::traits::Limiter;
        let limiter = ConcurrencyLimiter::new(2);
        // allow() uses try_acquire_many which immediately releases the permit,
        // so each call should succeed independently
        assert!(limiter.allow(1).await.unwrap());
        assert!(limiter.allow(1).await.unwrap());
        assert!(limiter.allow(1).await.unwrap());
    }

    #[tokio::test]
    async fn test_concurrency_limiter_trait_overflows_u32() {
        use super::super::traits::Limiter;
        let limiter = ConcurrencyLimiter::new(10);
        let result = limiter.allow(u64::from(u32::MAX) + 1).await;
        assert!(result.is_err());
        match result {
            Err(LimiteronError::LimitError(msg)) => {
                assert!(msg.contains("u32"));
            }
            _ => panic!("expected LimitError for u32 overflow"),
        }
    }

    #[tokio::test]
    async fn test_concurrency_acquire_overflows_u32() {
        let limiter = ConcurrencyLimiter::new(10);
        let result = limiter.acquire(u64::from(u32::MAX) + 1).await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_concurrency_try_acquire_overflows_u32() {
        let limiter = ConcurrencyLimiter::new(10);
        let result = limiter.try_acquire(u64::from(u32::MAX) + 1);
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_concurrency_acquire_timeout() {
        let limiter = ConcurrencyLimiter::with_timeout(1, Duration::from_millis(50));
        // Acquire the only permit
        let permit = limiter.acquire(1).await.unwrap();
        // Second acquire should time out
        let result = limiter.acquire(1).await;
        assert!(result.is_err());
        match result {
            Err(LimiteronError::LimitError(msg)) => {
                assert!(msg.contains("超时"));
            }
            _ => panic!("expected timeout error"),
        }
        drop(permit);
    }

    #[test]
    fn test_concurrency_builder_default() {
        let builder = ConcurrencyLimiterBuilder::default();
        assert!(builder.max_concurrent.is_none());
        assert!(builder.timeout.is_none());
        assert!(builder.semaphore.is_none());
    }

    #[tokio::test]
    async fn test_concurrency_allow_returns_false_when_exhausted() {
        use super::super::traits::Limiter;
        let limiter = ConcurrencyLimiter::new(1);
        // Hold the permit via acquire (keeps it held)
        let _permit = limiter.acquire(1).await.unwrap();
        // allow() uses try_acquire_many - should return Ok(false) since exhausted
        let result = limiter.allow(1).await.unwrap();
        assert!(!result);
    }

    #[tokio::test]
    async fn test_concurrency_builder_new_default_equivalent() {
        let b1 = ConcurrencyLimiterBuilder::new();
        let b2 = ConcurrencyLimiterBuilder::default();
        assert!(b1.max_concurrent.is_none() == b2.max_concurrent.is_none());
    }
}