Skip to main content

mytheclipse_queue/
worker_rate_limited.rs

1//! Rate-limited worker pool (feature `in-memory`).
2//!
3//! [`RateLimitedWorkerPool`] wraps [`crate::worker::WorkerPool`] with a
4//! [`crate::rate_limited::RateLimitedQueue`] to back-pressure dequeue when the
5//! token bucket is exhausted — preventing workers from hammering an upstream
6//! service faster than its rate limit allows.
7
8use crate::rate_limited::RateLimitedQueue;
9use crate::traits::Queue;
10use crate::worker::{JobHandler, WorkerConfig, WorkerPool};
11
12/// A `WorkerPool` whose dequeue is rate-limited via a token bucket.
13pub struct RateLimitedWorkerPool<Q: Queue + 'static> {
14    inner: WorkerPool<RateLimitedQueue<Q>>,
15}
16
17impl<Q: Queue + 'static> RateLimitedWorkerPool<Q> {
18    /// Creates a rate-limited worker pool wrapping `queue` with the given
19    /// token-bucket rate (tokens/sec) and burst capacity.
20    pub fn new(queue: Q, worker_cfg: WorkerConfig, rate_per_sec: f64, burst: u32) -> Self {
21        let limited = RateLimitedQueue::new(queue, rate_per_sec, burst);
22        Self {
23            inner: WorkerPool::with_config(limited, worker_cfg),
24        }
25    }
26
27    /// Starts workers consuming from `topic` with the given handler.
28    pub fn start<H>(&self, topic: &str, handler: H)
29    where
30        H: JobHandler + 'static,
31    {
32        self.inner.start(topic, handler);
33    }
34}
35
36#[cfg(test)]
37mod tests {
38    use super::*;
39
40    #[test]
41    fn constructs_rate_limited_pool() {
42        use crate::in_memory::InMemoryQueue;
43        let _pool =
44            RateLimitedWorkerPool::new(InMemoryQueue::new(), WorkerConfig::default(), 10.0, 5);
45        // smoke: just verifies construction
46    }
47}