rama-http 0.3.0-rc1

rama http layers, services and other utilities
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264

//! provides a [`UriMatcher`] matcher for matching requests based on their URI.

use crate::Request;
use rama_core::{extensions::Extensions, telemetry::tracing};
use rama_net::uri::Uri;
use rama_utils::collections::smallvec::SmallVec;
use rama_utils::thirdparty::{regex::Regex, wildcard::Wildcard};
use std::io::Write as _;

#[derive(Debug, Clone)]
/// Matcher the request's URI, using a substring or regex pattern.
pub struct UriMatcher {
    engine: Engine,
}

#[derive(Debug, Clone)]
enum Engine {
    Re(Regex),
    Wc(Wildcard<'static>),
}

impl Engine {
    fn is_match(&self, s: &str) -> bool {
        match self {
            Self::Re(regex) => regex.is_match(s),
            Self::Wc(wildcard) => wildcard.is_match(s.as_bytes()),
        }
    }

    fn is_match_bytes(&self, bytes: &[u8]) -> bool {
        match self {
            Self::Re(regex) => std::str::from_utf8(bytes).map(|s| regex.is_match(s)).inspect_err(|err| {
                tracing::debug!(
                    "input byttes is not a valid utf-8 str: regex requires str: fallback to is_match=false; err = {err}",
                );
            }).unwrap_or_default(),
            Self::Wc(wildcard) => wildcard.is_match(bytes),
        }
    }
}

impl UriMatcher {
    #[must_use]
    /// create a new Uri matcher using a regex pattern.
    pub fn regex(re: Regex) -> Self {
        Self {
            engine: Engine::Re(re),
        }
    }

    #[must_use]
    /// create a new Uri matcher using a wildcard pattern.
    pub fn wildcard(wc: Wildcard<'static>) -> Self {
        Self {
            engine: Engine::Wc(wc),
        }
    }

    #[inline]
    pub(crate) fn matches_uri(&self, uri: &Uri) -> bool {
        match uri.authority() {
            Some(authority) => {
                let mut buffer = SmallVec::<[u8; 128]>::new();
                _ = write!(
                    &mut buffer,
                    "{}://{authority}{}",
                    uri.scheme_str().unwrap_or("http"),
                    uri.path_or_root().as_ref()
                );
                while buffer.last() == Some(&b'/') {
                    _ = buffer.pop();
                }
                self.engine.is_match_bytes(&buffer)
            }
            None => self.engine.is_match(uri.path_or_root().as_ref()),
        }
    }
}

impl From<Regex> for UriMatcher {
    fn from(re: Regex) -> Self {
        Self {
            engine: Engine::Re(re),
        }
    }
}

impl From<Wildcard<'static>> for UriMatcher {
    fn from(wc: Wildcard<'static>) -> Self {
        Self {
            engine: Engine::Wc(wc),
        }
    }
}

impl<Body> rama_core::matcher::Matcher<Request<Body>> for UriMatcher {
    fn matches(&self, _ext: Option<&Extensions>, req: &Request<Body>) -> bool {
        let uri = req.request_uri();
        // TODO: in future we probably do not want to go via request_uri,
        // as this allocates an entire uri even though we do not want query etc...
        self.matches_uri(&uri)
    }
}

#[cfg(test)]
mod test {
    use crate::header::HOST;
    use rama_core::matcher::Matcher as _;

    use super::*;

    #[test]
    fn matchest_uri_regex_match() {
        for (matcher, uri) in [
            (r"www\.example\.com", "http://www.example.com"),
            (r"(?i)www\.example\.com", "http://WwW.ExamplE.COM"),
            (
                r"(?i)^[^?]+\.(jpeg|png|gif|css)$",
                "http://www.example.com/assets/style.css?foo=bar",
            ),
            (
                r"(?i)^[^?]+\.(jpeg|png|gif|css)$",
                "http://www.example.com/image.png",
            ),
        ] {
            let matcher = UriMatcher::regex(Regex::new(matcher).unwrap());
            assert!(
                matcher.matches_uri(&(uri.parse().unwrap())),
                "({matcher:?}).matches_uri({uri})",
            );
        }
    }

    #[test]
    fn matchest_uri_wildcard_match() {
        for (matcher, uri) in [
            (r"*www.example.com", "http://www.example.com"),
            (r"*.css", "http://www.example.com/assets/style.css"),
            (r"*.css", "http://www.example.com/assets/style.css?foo=bar"),
            (
                r"*example.com/foo/*/baz",
                "http://www.example.com/foo/bar/42/baz",
            ),
        ] {
            let matcher = UriMatcher::wildcard(Wildcard::new(matcher.as_bytes()).unwrap());
            assert!(
                matcher.matches_uri(&(uri.parse().unwrap())),
                "({matcher:?}).matches_uri({uri})",
            );
        }
    }

    #[test]
    fn matchest_uri_regex_no_match() {
        for (matcher, uri) in [
            ("www.example.com", "http://WwW.ExamplE.COM"),
            (
                r"(?i)^[^?]+\.(jpeg|png|gif|css)(\?|\z)",
                "http://www.example.com/?style.css",
            ),
        ] {
            let matcher = UriMatcher::regex(Regex::new(matcher).unwrap());
            assert!(
                !matcher.matches_uri(&(uri.parse().unwrap())),
                "!({matcher:?}).matches_uri({uri})",
            );
        }
    }

    #[test]
    fn matchest_uri_wildcard_no_match() {
        for (matcher, uri) in [
            ("http://example.com", "www.example.com"),
            (r"*.png", "http://www.example.com/style.css"),
        ] {
            let matcher = UriMatcher::wildcard(Wildcard::new(matcher.as_bytes()).unwrap());
            // accept both absolute and bare authority-form test targets
            let uri_parsed = uri
                .parse::<Uri>()
                .or_else(|_| Uri::parse_authority_form(uri))
                .unwrap();
            assert!(
                !matcher.matches_uri(&uri_parsed),
                "!({matcher:?}).matches_uri({uri})",
            );
        }
    }

    #[test]
    fn uri_matches_regex_req() {
        for (matcher, req) in [
            (
                r"(?i)http://www\.example\.com",
                Request::builder()
                    .uri(Uri::parse_authority_form("WwW.ExamplE.COM").unwrap())
                    .body(())
                    .unwrap(),
            ),
            (
                r"(?i)^[^?]+\.(jpeg|png|gif|css)(\?|\z)",
                Request::builder()
                    .uri("http://www.example.com/assets/style.css?foo=bar")
                    .body(())
                    .unwrap(),
            ),
            (
                "/foo/bar",
                Request::builder().uri("/foo/bar").body(()).unwrap(),
            ),
            (
                "example.com/foo/bar",
                Request::builder()
                    .uri("/foo/bar")
                    .header(HOST, "example.com")
                    .body(())
                    .unwrap(),
            ),
        ] {
            let matcher = UriMatcher::regex(Regex::new(matcher).unwrap());
            assert!(
                matcher.matches(None, &req),
                "matcher: {matcher:?}; req: {req:?}"
            );
        }
    }

    #[test]
    fn uri_matches_wildcard_req() {
        for (matcher, req) in [
            (
                r"*://www.example.com",
                Request::builder()
                    .uri(Uri::parse_authority_form("www.example.com").unwrap())
                    .body(())
                    .unwrap(),
            ),
            (
                r"*/*.css",
                Request::builder()
                    .uri("http://www.example.com/assets/style.css?foo=bar")
                    .body(())
                    .unwrap(),
            ),
            (
                "/foo/bar",
                Request::builder().uri("/foo/bar").body(()).unwrap(),
            ),
            (
                "http://example.com/*/bar",
                Request::builder()
                    .uri("/foo/bar")
                    .header(HOST, "example.com")
                    .body(())
                    .unwrap(),
            ),
        ] {
            let matcher = UriMatcher::wildcard(Wildcard::new(matcher.as_bytes()).unwrap());
            assert!(
                matcher.matches(None, &req),
                "matcher: {matcher:?}; req: {req:?}"
            );
        }
    }
}