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
85
86
87
88

use std::{thread::sleep, time::Duration};

use brakes::{
    backend::local::Memory,
    types::{
        fixed_window::FixedWindow, leaky_bucket::LeakyBucket, sliding_window::SlidingWindowCounter,
        token_bucket::TokenBucket,
    },
    RateLimiter,
};

#[test]
fn fixed_window() {
    let limiter = RateLimiter::builder()
        .with_backend(Memory::new())
        .with_limiter(FixedWindow::new(2, Duration::from_secs(1)))
        .build();
    for i in 0..5 {
        let result = limiter.is_ratelimited("ip");
        assert!(result.is_ok() == (i < 2))
    }
    sleep(Duration::from_secs(1));
    for i in 0..5 {
        let result = limiter.is_ratelimited("ip");
        assert!(result.is_ok() == (i < 2))
    }
    let usage = limiter
        .get_usage("ip")
        .unwrap()
        .as_fixed_window_instance()
        .unwrap();
    assert_eq!(usage.window_count(), 2);
}

#[test]
fn sliding_window_counter() {
    let limiter = RateLimiter::builder()
        .with_backend(Memory::new())
        .with_limiter(SlidingWindowCounter::new(5, Duration::from_millis(100)))
        .build();

    // uniform across the first window
    for _ in 0..5 {
        let result = limiter.is_ratelimited("ip");
        sleep(Duration::from_millis(15));
        assert!(result.is_ok())
    }
}

#[test]
fn token_bucket() {
    let limiter = RateLimiter::builder()
        .with_backend(Memory::new())
        .with_limiter(TokenBucket::new(5, Duration::from_millis(100)))
        .build();
    for i in 0..6 {
        let result = limiter.is_ratelimited("ip");
        assert!(result.is_ok() == (i < 5))
    }

    // let the bucket fill with 2 tokens
    sleep(Duration::from_millis(200));

    for i in 0..5 {
        let result = limiter.is_ratelimited("ip");
        assert!(result.is_ok() == (i < 2))
    }
}

#[test]
fn leaky_bucket() {
    let limiter = RateLimiter::builder()
        .with_backend(Memory::new())
        .with_limiter(LeakyBucket::new(5, Duration::from_millis(100)))
        .build();
    for i in 0..6 {
        let result = limiter.is_ratelimited("ip");
        assert!(result.is_ok() == (i < 5))
    }

    // let the bucket leak 2 requests
    sleep(Duration::from_millis(200));

    for i in 0..5 {
        let result = limiter.is_ratelimited("ip");
        assert!(result.is_ok() == (i < 2))
    }
}