gazelle_api 0.9.1

Gazelle API Client
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

use crate::RateLimiter;
use std::time::{Duration, SystemTime};

const LIMIT_COUNT: usize = 5;
const LIMIT_DURATION: Duration = Duration::from_secs(10);
const LIMIT_DURATION_SHORT: Duration = Duration::from_millis(250);

#[test]
fn test_get_wait_duration_empty() {
    // Arrange
    let mut limiter = RateLimiter::new(LIMIT_COUNT, LIMIT_DURATION);

    // Act
    let wait = limiter.get_wait_duration();
    print_duration("Wait", wait);

    // Assert
    assert!(wait.is_none());
}

#[test]
fn test_get_wait_duration_available() {
    // Arrange
    let mut limiter = RateLimiter::new(LIMIT_COUNT, LIMIT_DURATION);
    let now = SystemTime::now();
    for _ in 0..(LIMIT_COUNT - 1) {
        limiter.requests.push_back(now);
    }

    // Act
    let wait = limiter.get_wait_duration();
    print_duration("Wait", wait);

    // Assert
    assert!(wait.is_none());
}

#[test]
fn test_get_wait_duration_full() {
    // Arrange
    let mut limiter = RateLimiter::new(LIMIT_COUNT, LIMIT_DURATION);
    let now = SystemTime::now();
    for _ in 0..LIMIT_COUNT {
        limiter.requests.push_back(now);
    }

    // Act
    let wait = limiter.get_wait_duration();
    print_duration("Wait", wait);

    // Assert
    assert!(wait.is_some());
    assert!(approximately_equals(
        wait.unwrap(),
        LIMIT_DURATION,
        Duration::from_millis(100)
    ));
}

#[test]
fn test_execute_available() {
    // Arrange
    let mut limiter = RateLimiter::new(LIMIT_COUNT, LIMIT_DURATION);
    let now = SystemTime::now();
    for _ in 0..(LIMIT_COUNT - 1) {
        limiter.requests.push_back(now);
    }

    // Act
    let now = SystemTime::now();
    let wait = limiter.execute();
    let elapsed = now.elapsed().expect("elapsed should not fail");
    print_duration("Wait", wait);
    print_duration("Elapsed", Some(elapsed));

    // Assert
    assert!(wait.is_none());
    assert!(approximately_equals(
        elapsed,
        Duration::from_secs(0),
        Duration::from_millis(50)
    ));
}

#[test]
fn test_execute_full() {
    // Arrange
    let mut limiter = RateLimiter::new(LIMIT_COUNT, LIMIT_DURATION_SHORT);
    let now = SystemTime::now();
    for _ in 0..LIMIT_COUNT {
        limiter.requests.push_back(now);
    }

    // Act
    let now = SystemTime::now();
    let wait = limiter.execute();
    let elapsed = now.elapsed().expect("elapsed should not fail");
    print_duration("Wait", wait);
    print_duration("Elapsed", Some(elapsed));

    // Assert
    assert!(wait.is_some());
    assert!(approximately_equals(
        wait.unwrap(),
        LIMIT_DURATION_SHORT,
        Duration::from_millis(50)
    ));
    assert!(approximately_equals(
        elapsed,
        LIMIT_DURATION_SHORT,
        Duration::from_millis(50)
    ));
}

fn approximately_equals(d1: Duration, d2: Duration, tolerance: Duration) -> bool {
    if d1 > d2 {
        d1.checked_sub(d2).unwrap() <= tolerance
    } else {
        d2.checked_sub(d1).unwrap() <= tolerance
    }
}

fn print_duration(name: &str, duration: Option<Duration>) {
    if let Some(duration) = duration {
        println!("{name} duration: {:.3} seconds", duration.as_secs_f64());
    } else {
        println!("{name} duration: None");
    }
}