modo-rs 0.8.0

Rust web framework for small monolithic apps
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

use std::fmt;

/// Identifier extracted from an HTTP request by a [`TenantStrategy`](super::TenantStrategy).
///
/// Each variant corresponds to a particular extraction strategy. The
/// [`ApiKey`](Self::ApiKey) variant is **redacted** in both [`Display`](std::fmt::Display)
/// and [`Debug`](std::fmt::Debug) output to prevent accidental secret logging.
#[derive(Clone, PartialEq, Eq)]
pub enum TenantId {
    /// Tenant slug from [`subdomain()`](super::subdomain),
    /// [`path_prefix()`](super::path_prefix), or [`path_param()`](super::path_param).
    Slug(String),
    /// Full domain name from [`domain()`](super::domain) or the custom-domain
    /// branch of [`subdomain_or_domain()`](super::subdomain_or_domain).
    Domain(String),
    /// Opaque identifier from [`header()`](super::header).
    Id(String),
    /// Raw API key from [`api_key_header()`](super::api_key_header).
    /// **Redacted** in `Display` and `Debug`.
    ApiKey(String),
}

impl TenantId {
    /// Returns the inner string regardless of variant.
    pub fn as_str(&self) -> &str {
        match self {
            Self::Slug(s) | Self::Domain(s) | Self::Id(s) | Self::ApiKey(s) => s,
        }
    }
}

impl fmt::Display for TenantId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Slug(s) => write!(f, "slug:{s}"),
            Self::Domain(s) => write!(f, "domain:{s}"),
            Self::Id(s) => write!(f, "id:{s}"),
            Self::ApiKey(_) => write!(f, "apikey:[REDACTED]"),
        }
    }
}

impl fmt::Debug for TenantId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Slug(s) => f.debug_tuple("Slug").field(s).finish(),
            Self::Domain(s) => f.debug_tuple("Domain").field(s).finish(),
            Self::Id(s) => f.debug_tuple("Id").field(s).finish(),
            Self::ApiKey(_) => f.debug_tuple("ApiKey").field(&"[REDACTED]").finish(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn display_slug() {
        let id = TenantId::Slug("acme".into());
        assert_eq!(id.to_string(), "slug:acme");
    }

    #[test]
    fn display_domain() {
        let id = TenantId::Domain("acme.com".into());
        assert_eq!(id.to_string(), "domain:acme.com");
    }

    #[test]
    fn display_id() {
        let id = TenantId::Id("abc123".into());
        assert_eq!(id.to_string(), "id:abc123");
    }

    #[test]
    fn display_api_key_redacted() {
        let id = TenantId::ApiKey("sk_live_secret".into());
        assert_eq!(id.to_string(), "apikey:[REDACTED]");
    }

    #[test]
    fn debug_api_key_redacted() {
        let id = TenantId::ApiKey("sk_live_secret".into());
        let debug = format!("{:?}", id);
        assert!(!debug.contains("sk_live_secret"));
        assert!(debug.contains("REDACTED"));
    }

    #[test]
    fn as_str_returns_inner_value() {
        assert_eq!(TenantId::Slug("acme".into()).as_str(), "acme");
        assert_eq!(TenantId::Domain("acme.com".into()).as_str(), "acme.com");
        assert_eq!(TenantId::Id("abc123".into()).as_str(), "abc123");
        assert_eq!(TenantId::ApiKey("sk_live".into()).as_str(), "sk_live");
    }

    #[test]
    fn equality() {
        let a = TenantId::Slug("acme".into());
        let b = TenantId::Slug("acme".into());
        assert_eq!(a, b);

        let c = TenantId::Domain("acme".into());
        assert_ne!(a, c);
    }
}