hive-router 0.2.0

GraphQL router for Federation, part of the Hive platform
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use std::collections::{HashMap, HashSet};

use crate::config::error_masking::{ErrorMaskingConfig, ExtensionsMaskingConfig};
use crate::executor::response::graphql_error::{GraphQLError, GraphQLErrorExtensions};

pub struct ErrorMaskingRuntime {
    redacted_error_message: String,

    // Error masking for the error message, split by "all" and subgraph-specific
    default_error_masking: bool,
    per_subgraph_error_masking: HashMap<String, bool>,

    // Error masking for the error extensions, split by "all" and subgraph-specific
    default_extensions_masking: Option<RedactExtensionsPlan>,
    per_subgraph_extensions_masking: HashMap<String, Option<RedactExtensionsPlan>>,
}

impl ErrorMaskingRuntime {
    pub fn apply(&self, err: &mut GraphQLError) {
        if let Some(service_name) = &err.extensions.service_name {
            let should_mask_message = self
                .per_subgraph_error_masking
                .get(service_name)
                .copied()
                .unwrap_or(self.default_error_masking);

            if should_mask_message {
                err.message.clone_from(&self.redacted_error_message);
            }

            let extensions_masking_config = self
                .per_subgraph_extensions_masking
                .get(service_name)
                .and_then(|plan| plan.as_ref())
                .or(self.default_extensions_masking.as_ref());

            if let Some(plan) = extensions_masking_config {
                plan.apply(&mut err.extensions);
            }
        }
    }

    pub fn compile_from_config(config: &ErrorMaskingConfig) -> Option<Self> {
        if !config.enabled {
            return None;
        }

        Some(Self {
            redacted_error_message: config.redacted_error_message.clone(),
            default_error_masking: config.all.enabled,
            per_subgraph_error_masking: config
                .subgraphs
                .as_ref()
                .map(|subgraphs| {
                    subgraphs
                        .iter()
                        .map(|(name, cfg)| {
                            (name.clone(), cfg.enabled.unwrap_or(config.all.enabled))
                        })
                        .collect()
                })
                .unwrap_or_default(),
            default_extensions_masking: config.all.extensions.as_ref().map(|v| v.into()),
            per_subgraph_extensions_masking: config
                .subgraphs
                .as_ref()
                .map(|subgraphs| {
                    subgraphs
                        .iter()
                        .map(|(name, cfg)| {
                            (name.clone(), cfg.extensions.as_ref().map(|v| v.into()))
                        })
                        .collect()
                })
                .unwrap_or_default(),
        })
    }
}

enum RedactExtensionsPlan {
    Allow(Vec<String>),
    Deny(Vec<String>),
}

impl From<&ExtensionsMaskingConfig> for RedactExtensionsPlan {
    fn from(config: &ExtensionsMaskingConfig) -> Self {
        match config {
            ExtensionsMaskingConfig::AllowList { keys } => Self::Allow(keys.clone()),
            ExtensionsMaskingConfig::DenyList { keys } => Self::Deny(keys.clone()),
        }
    }
}

impl RedactExtensionsPlan {
    pub fn apply(&self, extensions: &mut GraphQLErrorExtensions) {
        match self {
            RedactExtensionsPlan::Allow(list) => {
                Self::apply_allow_list(extensions, list);
            }
            RedactExtensionsPlan::Deny(list) => {
                Self::apply_deny_list(extensions, list);
            }
        }
    }

    fn apply_deny_list(extensions: &mut GraphQLErrorExtensions, list: &[String]) {
        for removal_path in list {
            Self::remove_field(extensions, removal_path);
        }
    }

    fn apply_allow_list(extensions: &mut GraphQLErrorExtensions, list: &[String]) {
        let mut allow_code = false;
        let mut allow_service_name = false;
        let mut allow_affected_path = false;
        let mut allowed_keys = HashSet::new();

        for key in list {
            match key.as_str() {
                "code" => allow_code = true,
                "service" => allow_service_name = true,
                "affectedPath" => allow_affected_path = true,
                other => {
                    allowed_keys.insert(other);
                }
            }
        }

        if !allow_code {
            extensions.code = None;
        }

        if !allow_service_name {
            extensions.service_name = None;
        }

        if !allow_affected_path {
            extensions.affected_path = None;
        }

        extensions
            .extensions
            .retain(|key, _| allowed_keys.contains(key.as_str()));
    }

    fn remove_field(extensions: &mut GraphQLErrorExtensions, key: &str) {
        match key {
            "code" => {
                extensions.code = None;
            }
            "service" => {
                extensions.service_name = None;
            }
            "affectedPath" => {
                extensions.affected_path = None;
            }
            _ => {
                extensions.extensions.remove(key);
            }
        }
    }
}