fregate 0.17.1

Framework for services creation
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

//! [`HeadersFilter`] definition
use crate::extensions::DeserializeExt;
use serde::{Deserialize, Deserializer};
use serde_json::Value;
use std::collections::HashSet;
use std::sync::OnceLock;

const SANITIZE_PTR: &str = "/sanitize";
const INCLUDE_PTR: &str = "/include";
const EXCLUDE_PTR: &str = "/exclude";

/// This is uninitialised unless you call [`crate::bootstrap()`] or [`crate::observability::init_tracing()`] functions.
/// If initialised but env variables are not set fregate will include all headers.
/// Expects string values separated with ',' or standalone "*" character meaning: all.
/// Example:
/// ```no_run
/// std::env::set_var("TEST_HEADERS_SANITIZE", "password,login,client_id");
/// std::env::set_var("TEST_HEADERS_EXCLUDE", "authorization");
/// std::env::set_var("TEST_HEADERS_INCLUDE", "*");
/// ```
/// In [`crate::extensions::HeaderFilterExt`] trait implementation will have next behaviour:
/// Include all headers except for "authorization" and sanitize "password,login,client_id" headers.
pub static HEADERS_FILTER: OnceLock<HeadersFilter> = OnceLock::new();

/// Headers filter options
#[derive(Debug, Clone)]
pub enum Filter {
    /// All headers
    All,
    /// Set of header names to filter
    Set(HashSet<String>),
}

/// Struct to save headers filters.
#[derive(Debug, Clone)]
pub struct HeadersFilter {
    /// Headers to be included.
    pub include: Filter,
    /// Headers to be excluded.
    pub exclude: Filter,
    /// Headers to be sanitized.
    pub sanitize: Filter,
}

impl<'de> Deserialize<'de> for HeadersFilter {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let config = Value::deserialize(deserializer)?;

        let sanitize: Option<String> = config
            .pointer_and_deserialize::<_, D::Error>(SANITIZE_PTR)
            .ok();
        let include: Option<String> = config
            .pointer_and_deserialize::<_, D::Error>(INCLUDE_PTR)
            .ok();
        let exclude: Option<String> = config
            .pointer_and_deserialize::<_, D::Error>(EXCLUDE_PTR)
            .ok();

        Ok(HeadersFilter {
            include: from_str_to_filter(include),
            exclude: from_str_to_filter(exclude),
            sanitize: from_str_to_filter(sanitize),
        })
    }
}

fn from_str_to_filter(str: Option<String>) -> Filter {
    str.map_or(Filter::Set(HashSet::default()), |str| {
        let str = str.trim();

        if str == "*" {
            Filter::All
        } else {
            Filter::Set(
                str.split(',')
                    .map(|field| field.trim().to_ascii_lowercase())
                    .collect::<HashSet<String>>(),
            )
        }
    })
}