throttle-kit 1.1.0

Rate limiting for Rust — GCRA algorithm with in-memory and Redis backends, Tower layer integration
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

// Tests exercise hostile inputs directly; unwrap/expect, slicing, and
// panicking asserts are the test signal here.
#![allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::indexing_slicing,
    clippy::panic
)]

//! Property-based tests for throttle-kit crate.

use proptest::prelude::*;
use std::time::Duration;

use throttle_kit::{Quota, RateLimitResult};

#[test]
fn quota_per_second_interval_correct() {
    proptest!(|(n in 1u32..10_000u32)| {
        let q = Quota::per_second(n);
        let expected = Duration::from_secs_f64(1.0 / n as f64);
        prop_assert!((q.interval().as_secs_f64() - expected.as_secs_f64()).abs() < 0.001);
    });
}

#[test]
fn quota_per_minute_interval_correct() {
    proptest!(|(n in 1u32..10_000u32)| {
        let q = Quota::per_minute(n);
        let expected = Duration::from_secs_f64(60.0 / n as f64);
        prop_assert!((q.interval().as_secs_f64() - expected.as_secs_f64()).abs() < 0.001);
    });
}

#[test]
fn quota_per_hour_interval_correct() {
    proptest!(|(n in 1u32..10_000u32)| {
        let q = Quota::per_hour(n);
        let expected = Duration::from_secs_f64(3600.0 / n as f64);
        prop_assert!((q.interval().as_secs_f64() - expected.as_secs_f64()).abs() < 0.001);
    });
}

#[test]
fn quota_interval_always_positive() {
    proptest!(|(n in 1u32..100_000u32)| {
        let q = Quota::per_second(n);
        prop_assert!(q.interval() > Duration::ZERO);
    });
}

#[test]
fn quota_burst_matches_rate() {
    proptest!(|(n in 1u32..10_000u32)| {
        let q = Quota::per_second(n);
        prop_assert_eq!(q.burst, n);
    });
}

#[test]
fn quota_allow_burst_overrides() {
    proptest!(|(n in 1u32..1_000u32, burst in 1u32..10_000u32)| {
        let q = Quota::per_second(n).allow_burst(burst);
        prop_assert_eq!(q.burst, burst);
    });
}

#[test]
fn quota_clone_preserves_values() {
    proptest!(|(n in 1u32..10_000u32)| {
        let q = Quota::per_second(n);
        // Quota is `Copy` as of 1.1.0; `.clone()` stays valid API, so
        // clone-by-value semantics are asserted explicitly here.
        #[allow(clippy::clone_on_copy)]
        let cloned = q.clone();
        prop_assert_eq!(q.burst, cloned.burst);
        prop_assert_eq!(q.interval(), cloned.interval());
    });
}

#[test]
fn rate_limit_result_headers_always_3() {
    proptest!(|(remaining in 0u64..1_000u64, limit in 1u64..1_000u64)| {
        let r = RateLimitResult {
            allowed: true,
            remaining,
            reset_at: std::time::Instant::now(),
            limit,
            retry_after: None,
        };
        let headers = r.headers();
        prop_assert_eq!(headers.len(), 3);
        prop_assert_eq!(headers[0].0, "X-RateLimit-Limit");
        prop_assert_eq!(headers[1].0, "X-RateLimit-Remaining");
        prop_assert_eq!(headers[2].0, "X-RateLimit-Reset");
    });
}