brakes 0.1.1

A distributed rate limiting library
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

use brakes::{
    backend::local::Memory,
    types::{token_bucket::TokenBucket, RateLimiterError},
};

#[test]
fn invalid_cache_discard() {
    use brakes::{types::fixed_window::FixedWindow, RateLimiter};
    use std::time::Duration;

    let key = "key";
    let backend = Memory::new();

    let fixed_window_limiter = RateLimiter::builder()
        .with_backend(backend.clone())
        .with_limiter(FixedWindow::new(100, Duration::from_millis(1000)))
        .with_conflict_strategy(brakes::RetryStrategy::RetryAndDeny(1))
        .build();

    let token_limiter = RateLimiter::builder()
        .with_backend(backend)
        .with_limiter(TokenBucket::new(100, Duration::from_millis(1000)))
        .with_conflict_strategy(brakes::RetryStrategy::RetryAndDeny(1))
        .with_discard_invalid_cache_entries(true)
        .build();

    assert!(fixed_window_limiter.is_ratelimited(key).is_ok());
    assert!(token_limiter.is_ratelimited(key).is_ok());
}

#[test]
fn invalid_cache_default() {
    use brakes::{types::fixed_window::FixedWindow, RateLimiter};
    use std::time::Duration;

    let key = "key";
    let backend = Memory::new();

    let fixed_window_limiter = RateLimiter::builder()
        .with_backend(backend.clone())
        .with_limiter(FixedWindow::new(100, Duration::from_millis(1000)))
        .with_conflict_strategy(brakes::RetryStrategy::RetryAndDeny(1))
        .build();

    let token_limiter = RateLimiter::builder()
        .with_backend(backend)
        .with_limiter(TokenBucket::new(100, Duration::from_millis(1000)))
        .with_conflict_strategy(brakes::RetryStrategy::RetryAndDeny(1))
        .build();

    assert!(fixed_window_limiter.is_ratelimited(key).is_ok());
    assert!(token_limiter.is_ratelimited(key).is_ok());
}

#[test]
fn invalid_cache_no_discard() {
    use brakes::{types::fixed_window::FixedWindow, RateLimiter};
    use std::time::Duration;

    let key = "key";
    let backend = Memory::new();

    let fixed_window_limiter = RateLimiter::builder()
        .with_backend(backend.clone())
        .with_limiter(FixedWindow::new(100, Duration::from_millis(1000)))
        .with_conflict_strategy(brakes::RetryStrategy::RetryAndDeny(1))
        .build();

    let token_limiter = RateLimiter::builder()
        .with_backend(backend)
        .with_limiter(TokenBucket::new(100, Duration::from_millis(1000)))
        .with_conflict_strategy(brakes::RetryStrategy::RetryAndDeny(1))
        .with_discard_invalid_cache_entries(false)
        .build();

    assert!(fixed_window_limiter.is_ratelimited(key).is_ok());

    let res = token_limiter.is_ratelimited(key);
    assert!(res.is_err());
    assert!(matches!(
        res,
        Err(RateLimiterError::WrongLimiterInstanceType)
    ));
}