request_rate_limiter/
keyed.rs

1//! Keyed rate limiting functionality.
2//!
3//! This module provides rate limiting with per-key isolation, allowing independent
4//! rate limiting across different clients, users, or request types.
5
6use std::{fmt::Debug, hash::Hash, time::Duration};
7
8use async_trait::async_trait;
9use dashmap::DashMap;
10
11use crate::{
12    algorithms::RateLimitAlgorithm,
13    limiter::{DefaultRateLimiter, RateLimiter, RequestOutcome, Token},
14};
15
16/// Controls the rate of requests over time with per-key rate limiting.
17///
18/// Each key maintains its own rate limit state, allowing for independent
19/// rate limiting across different clients, users, or request types.
20#[async_trait]
21pub trait RateLimiterKeyed<K>: Sync
22where
23    K: Hash + Eq + Send + Sync,
24{
25    /// Acquire permission to make a request for a specific key. Waits until a token is available.
26    async fn acquire(&self, key: &K) -> Token;
27
28    /// Acquire permission to make a request for a specific key with a timeout.
29    /// Returns a token if successful.
30    async fn acquire_timeout(&self, key: &K, duration: Duration) -> Option<Token>;
31
32    /// Release the token and record the outcome of the request for the specific key.
33    /// The response time is calculated from when the token was acquired.
34    async fn release(&self, key: &K, token: Token, outcome: Option<RequestOutcome>);
35}
36
37/// A keyed rate limiter that maintains separate rate limiters for each key.
38///
39/// Uses DashMap for efficient concurrent access to per-key rate limiters.
40/// Each key gets its own independent rate limiter instance.
41#[derive(Debug)]
42pub struct DefaultRateLimiterKeyed<T, K>
43where
44    T: RateLimitAlgorithm + Debug + Clone,
45    K: Hash + Eq + Send + Sync,
46{
47    limiters: DashMap<K, DefaultRateLimiter<T>>,
48    algorithm: T,
49}
50
51impl<T, K> DefaultRateLimiterKeyed<T, K>
52where
53    T: RateLimitAlgorithm + Debug + Clone,
54    K: Hash + Eq + Clone + Send + Sync,
55{
56    /// Create a new keyed rate limiter with the given algorithm factory function.
57    /// Each key will get a fresh instance of the algorithm created by calling the factory.
58    pub fn new(algorithm: T) -> Self {
59        Self {
60            limiters: DashMap::new(),
61            algorithm,
62        }
63    }
64
65    /// Get or create a rate limiter for the given key.
66    /// Uses entry API for better performance and reduced contention.
67    fn get_or_create_limiter(&self, key: &K) -> DefaultRateLimiter<T> {
68        if let Some(limiter) = self.limiters.get(key) {
69            return limiter.value().clone();
70        }
71
72        let limiter_ref = self
73            .limiters
74            .entry(key.clone())
75            .or_insert_with(|| DefaultRateLimiter::new(self.algorithm.clone()));
76
77        limiter_ref.value().clone()
78    }
79
80    /// Get the number of active keys being tracked.
81    pub fn active_keys(&self) -> usize {
82        self.limiters.len()
83    }
84
85    /// Remove a key and its associated rate limiter.
86    /// Returns true if the key existed and was removed.
87    pub fn remove_key(&self, key: &K) -> bool {
88        self.limiters.remove(key).is_some()
89    }
90
91    /// Clear all keys and their associated rate limiters.
92    pub fn clear(&self) {
93        self.limiters.clear();
94    }
95}
96
97#[async_trait]
98impl<T, K> RateLimiterKeyed<K> for DefaultRateLimiterKeyed<T, K>
99where
100    T: RateLimitAlgorithm + Send + Clone + Sync + Debug,
101    K: Hash + Eq + Clone + Send + Sync,
102{
103    async fn acquire(&self, key: &K) -> Token {
104        let limiter = self.get_or_create_limiter(key);
105        limiter.acquire().await
106    }
107
108    async fn acquire_timeout(&self, key: &K, duration: Duration) -> Option<Token> {
109        let limiter = self.get_or_create_limiter(key);
110        limiter.acquire_timeout(duration).await
111    }
112
113    async fn release(&self, key: &K, token: Token, outcome: Option<RequestOutcome>) {
114        let limiter = self.get_or_create_limiter(key);
115        limiter.release(token, outcome).await
116    }
117}
118
119#[cfg(test)]
120mod tests {
121    use crate::{
122        algorithms::Fixed,
123        keyed::{DefaultRateLimiterKeyed, RateLimiterKeyed},
124        limiter::RequestOutcome,
125    };
126
127    #[tokio::test]
128    async fn keyed_rate_limiter_works_independently_per_key() {
129        let limiter = DefaultRateLimiterKeyed::<_, String>::new(Fixed::new(1));
130
131        let key1 = "key1".to_string();
132        let key2 = "key2".to_string();
133        // Acquire tokens for different keys - should work independently
134        let token1 = limiter.acquire(&key1).await;
135        let token2 = limiter.acquire(&key2).await;
136
137        // Both should succeed because they're different keys
138        limiter
139            .release(&key1, token1, Some(RequestOutcome::Success))
140            .await;
141        limiter
142            .release(&key2, token2, Some(RequestOutcome::Success))
143            .await;
144
145        assert_eq!(limiter.active_keys(), 2);
146    }
147
148    #[tokio::test]
149    async fn keyed_rate_limiter_manages_keys() {
150        let limiter = DefaultRateLimiterKeyed::<_, String>::new(Fixed::new(10));
151
152        // Create limiters for multiple keys
153        let _token1 = limiter.acquire(&"user1".to_string()).await;
154        let _token2 = limiter.acquire(&"user2".to_string()).await;
155        let _token3 = limiter.acquire(&"user3".to_string()).await;
156
157        assert_eq!(limiter.active_keys(), 3);
158
159        // Remove one key
160        assert!(limiter.remove_key(&"user2".to_string()));
161        assert_eq!(limiter.active_keys(), 2);
162
163        // Try to remove non-existent key
164        assert!(!limiter.remove_key(&"nonexistent".to_string()));
165
166        // Clear all keys
167        limiter.clear();
168        assert_eq!(limiter.active_keys(), 0);
169    }
170}
request_rate_limiter/keyed.rs

request_rate_limiter/
keyed.rs
