servers/
hint_headers.rs

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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use http::HeaderMap;
use tonic::metadata::MetadataMap;

// For the given format: `x-greptime-hints: auto_create_table=true, ttl=7d`
pub const HINTS_KEY: &str = "x-greptime-hints";

pub const HINT_KEYS: [&str; 6] = [
    "x-greptime-hint-auto_create_table",
    "x-greptime-hint-ttl",
    "x-greptime-hint-append_mode",
    "x-greptime-hint-merge_mode",
    "x-greptime-hint-physical_table",
    "x-greptime-hint-skip_wal",
];

pub(crate) fn extract_hints<T: ToHeaderMap>(headers: &T) -> Vec<(String, String)> {
    let mut hints = Vec::new();
    if let Some(value_str) = headers.get(HINTS_KEY) {
        value_str.split(',').for_each(|hint| {
            let mut parts = hint.splitn(2, '=');
            if let (Some(key), Some(value)) = (parts.next(), parts.next()) {
                hints.push((key.trim().to_string(), value.trim().to_string()));
            }
        });
        // If hints are provided in the `x-greptime-hints` header, ignore the rest of the headers
        return hints;
    }
    for key in HINT_KEYS.iter() {
        if let Some(value) = headers.get(key) {
            let new_key = key.replace("x-greptime-hint-", "");
            hints.push((new_key, value.trim().to_string()));
        }
    }
    hints
}

pub(crate) trait ToHeaderMap {
    fn get(&self, key: &str) -> Option<&str>;
}

impl ToHeaderMap for MetadataMap {
    fn get(&self, key: &str) -> Option<&str> {
        self.get(key).and_then(|v| v.to_str().ok())
    }
}

impl ToHeaderMap for HeaderMap {
    fn get(&self, key: &str) -> Option<&str> {
        self.get(key).and_then(|v| v.to_str().ok())
    }
}
#[cfg(test)]
mod tests {
    use http::header::{HeaderMap, HeaderValue};
    use tonic::metadata::{MetadataMap, MetadataValue};

    use super::*;

    #[test]
    fn test_extract_hints_with_full_header_map() {
        let mut headers = HeaderMap::new();
        headers.insert(
            "x-greptime-hint-auto_create_table",
            HeaderValue::from_static("true"),
        );
        headers.insert("x-greptime-hint-ttl", HeaderValue::from_static("3600d"));
        headers.insert(
            "x-greptime-hint-append_mode",
            HeaderValue::from_static("true"),
        );
        headers.insert(
            "x-greptime-hint-merge_mode",
            HeaderValue::from_static("false"),
        );
        headers.insert(
            "x-greptime-hint-physical_table",
            HeaderValue::from_static("table1"),
        );

        let hints = extract_hints(&headers);

        assert_eq!(hints.len(), 5);
        assert_eq!(
            hints[0],
            ("auto_create_table".to_string(), "true".to_string())
        );
        assert_eq!(hints[1], ("ttl".to_string(), "3600d".to_string()));
        assert_eq!(hints[2], ("append_mode".to_string(), "true".to_string()));
        assert_eq!(hints[3], ("merge_mode".to_string(), "false".to_string()));
        assert_eq!(
            hints[4],
            ("physical_table".to_string(), "table1".to_string())
        );
    }

    #[test]
    fn test_extract_hints_with_missing_keys() {
        let mut headers = HeaderMap::new();
        headers.insert(
            "x-greptime-hint-auto_create_table",
            HeaderValue::from_static("true"),
        );
        headers.insert("x-greptime-hint-ttl", HeaderValue::from_static("3600d"));

        let hints = extract_hints(&headers);

        assert_eq!(hints.len(), 2);
        assert_eq!(
            hints[0],
            ("auto_create_table".to_string(), "true".to_string())
        );
        assert_eq!(hints[1], ("ttl".to_string(), "3600d".to_string()));
    }

    #[test]
    fn test_extract_hints_all_in_one() {
        let mut headers = HeaderMap::new();
        headers.insert(
            "x-greptime-hints",
            HeaderValue::from_static(" auto_create_table=true, ttl =3600d, append_mode=true , merge_mode=false , physical_table= table1"),
        );

        let hints = extract_hints(&headers);

        assert_eq!(hints.len(), 5);
        assert_eq!(
            hints[0],
            ("auto_create_table".to_string(), "true".to_string())
        );
        assert_eq!(hints[1], ("ttl".to_string(), "3600d".to_string()));
        assert_eq!(hints[2], ("append_mode".to_string(), "true".to_string()));
        assert_eq!(hints[3], ("merge_mode".to_string(), "false".to_string()));
        assert_eq!(
            hints[4],
            ("physical_table".to_string(), "table1".to_string())
        );
    }

    #[test]
    fn test_extract_hints_with_metadata_map() {
        let mut metadata = MetadataMap::new();
        metadata.insert(
            "x-greptime-hint-auto_create_table",
            MetadataValue::from_static("true"),
        );
        metadata.insert("x-greptime-hint-ttl", MetadataValue::from_static("3600d"));
        metadata.insert(
            "x-greptime-hint-append_mode",
            MetadataValue::from_static("true"),
        );
        metadata.insert(
            "x-greptime-hint-merge_mode",
            MetadataValue::from_static("false"),
        );
        metadata.insert(
            "x-greptime-hint-physical_table",
            MetadataValue::from_static("table1"),
        );

        let hints = extract_hints(&metadata);

        assert_eq!(hints.len(), 5);
        assert_eq!(
            hints[0],
            ("auto_create_table".to_string(), "true".to_string())
        );
        assert_eq!(hints[1], ("ttl".to_string(), "3600d".to_string()));
        assert_eq!(hints[2], ("append_mode".to_string(), "true".to_string()));
        assert_eq!(hints[3], ("merge_mode".to_string(), "false".to_string()));
        assert_eq!(
            hints[4],
            ("physical_table".to_string(), "table1".to_string())
        );
    }

    #[test]
    fn test_extract_hints_with_partial_metadata_map() {
        let mut metadata = MetadataMap::new();
        metadata.insert(
            "x-greptime-hint-auto_create_table",
            MetadataValue::from_static("true"),
        );
        metadata.insert("x-greptime-hint-ttl", MetadataValue::from_static("3600d"));

        let hints = extract_hints(&metadata);

        assert_eq!(hints.len(), 2);
        assert_eq!(
            hints[0],
            ("auto_create_table".to_string(), "true".to_string())
        );
        assert_eq!(hints[1], ("ttl".to_string(), "3600d".to_string()));
    }
}