limtr 0.2.0

Implement rate limits for all sort of applications and scenarios.
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

#![allow(dead_code)]

use std::future::Future;
use std::time::Duration;
use tokio::time::sleep;
use crate::{Error, Feature, FeatureRaw, Limtr};


#[repr(u16)]
#[derive(Copy, Clone, Debug)]
enum F {
    A,
    B,
    C,
}

impl Feature for F {
    fn into_feature(self) -> FeatureRaw {
        self as FeatureRaw
    }
}

async fn validate_update<F: Future<Output=Result<u64, Error>>>(future: F, blocked: bool) {
    let exp = future.await.unwrap();
    if blocked {
        assert_ne!(exp, 0);
    } else {
        assert_eq!(exp, 0);
    }
}

#[tokio::test]
async fn single_call() {
    let limtr = Limtr::new(16);

    const ID: &'static str = "single_call";
    const FEATURE: F = F::A;
    const SECONDS: u32 = 10;
    const MAX_CALLS: usize = 1;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        true,
    ).await;
}

#[tokio::test]
async fn multiple_calls() {
    let limtr = Limtr::new(16);

    const ID: &'static str = "multiple_calls";
    const FEATURE: F = F::A;
    const SECONDS: u32 = 10;
    const MAX_CALLS: usize = 3;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        true,
    ).await;
}

#[tokio::test]
async fn clear_calls() {
    let limtr = Limtr::new(16);

    const ID: &'static str = "clear_calls";
    const FEATURE: F = F::A;
    const SECONDS: u32 = 1;
    const MAX_CALLS: usize = 2;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    sleep(Duration::from_millis(1500)).await;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    sleep(Duration::from_millis(1500)).await;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;
}

#[tokio::test]
async fn block_check() {
    let limtr = Limtr::new(16);

    const ID: &'static str = "block_check";
    const FEATURE: F = F::A;
    const SECONDS: u32 = 3;
    const MAX_CALLS: usize = 2;

    assert_eq!(limtr.get_limit_local(ID, FEATURE).await.unwrap(), 0);

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    assert_eq!(limtr.get_limit_local(ID, FEATURE).await.unwrap(), 0);

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        false,
    ).await;

    validate_update(
        limtr.update_limit_local(ID, FEATURE, SECONDS, MAX_CALLS),
        true,
    ).await;

    assert_ne!(limtr.get_limit_local(ID, FEATURE).await.unwrap(), 0);

    sleep(Duration::from_secs(SECONDS as _)).await;

    assert_eq!(limtr.get_limit_local(ID, FEATURE).await.unwrap(), 0);
}