mailbridge 0.1.0

Provider-neutral transactional email library for Rust services
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

#[cfg(feature = "rate-limit")]
use std::collections::BTreeMap;
#[cfg(feature = "rate-limit")]
use std::num::NonZeroU32;
#[cfg(feature = "rate-limit")]
use std::sync::Arc;

#[cfg(feature = "rate-limit")]
use governor::{DefaultDirectRateLimiter, Quota, RateLimiter};

#[cfg(feature = "rate-limit")]
use crate::error::{MailError, Result};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RateLimitConfig {
    global_per_second: u32,
    domain_per_second: u32,
}

impl RateLimitConfig {
    pub const DEFAULT_GLOBAL_PER_SECOND: u32 = 20;
    pub const DEFAULT_DOMAIN_PER_SECOND: u32 = 5;

    #[must_use]
    pub const fn new(global_per_second: u32, domain_per_second: u32) -> Self {
        Self {
            global_per_second,
            domain_per_second,
        }
    }

    #[must_use]
    pub const fn global_per_second(&self) -> u32 {
        self.global_per_second
    }

    #[must_use]
    pub const fn domain_per_second(&self) -> u32 {
        self.domain_per_second
    }
}

impl Default for RateLimitConfig {
    fn default() -> Self {
        Self::new(
            Self::DEFAULT_GLOBAL_PER_SECOND,
            Self::DEFAULT_DOMAIN_PER_SECOND,
        )
    }
}

#[cfg(feature = "rate-limit")]
#[derive(Debug, Clone)]
pub struct MailRateLimiter {
    global: Arc<DefaultDirectRateLimiter>,
    domains: Arc<BTreeMap<String, Arc<DefaultDirectRateLimiter>>>,
    fallback_domain: Arc<DefaultDirectRateLimiter>,
}

#[cfg(feature = "rate-limit")]
impl MailRateLimiter {
    #[must_use]
    pub fn new(config: &RateLimitConfig, domains: impl IntoIterator<Item = String>) -> Self {
        let global = Arc::new(direct_limiter(config.global_per_second()));
        let fallback_domain = Arc::new(direct_limiter(config.domain_per_second()));
        let domains = domains
            .into_iter()
            .map(|domain| (domain, Arc::new(direct_limiter(config.domain_per_second()))))
            .collect();

        Self {
            global,
            domains: Arc::new(domains),
            fallback_domain,
        }
    }

    pub async fn wait(&self, domain: &str) {
        self.global.until_ready().await;
        self.domain_limiter(domain).until_ready().await;
    }

    /// Checks rate-limit capacity without waiting.
    ///
    /// # Errors
    ///
    /// Returns an error when the global or domain limiter has no immediate
    /// capacity.
    pub fn check(&self, domain: &str) -> Result<()> {
        self.global.check().map_err(|_| MailError::RateLimited)?;
        self.domain_limiter(domain)
            .check()
            .map_err(|_| MailError::RateLimited)?;
        Ok(())
    }

    fn domain_limiter(&self, domain: &str) -> &DefaultDirectRateLimiter {
        self.domains
            .get(domain)
            .map_or(self.fallback_domain.as_ref(), Arc::as_ref)
    }
}

#[cfg(feature = "rate-limit")]
fn direct_limiter(per_second: u32) -> DefaultDirectRateLimiter {
    RateLimiter::direct(Quota::per_second(non_zero_rate(per_second)))
}

#[cfg(feature = "rate-limit")]
fn non_zero_rate(value: u32) -> NonZeroU32 {
    NonZeroU32::new(value.max(1)).expect("rate limit was clamped to at least one")
}

#[cfg(all(test, feature = "rate-limit"))]
mod tests {
    use super::*;

    #[test]
    fn check_rejects_when_global_limit_is_exhausted() {
        let limiter =
            MailRateLimiter::new(&RateLimitConfig::new(1, 10), ["example.com".to_owned()]);

        assert!(limiter.check("example.com").is_ok());
        assert_eq!(
            limiter
                .check("example.com")
                .expect_err("second check fails"),
            MailError::RateLimited
        );
    }
}