rama-http 0.2.0

rama http layers, services and other utilities
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
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378

//! Similar to [`super::header_config::HeaderConfigLayer`],
//! but storing the [`Default`] value of type `T` in case
//! the header with the given [`HeaderName`] is present
//! and has a bool-like value.

use crate::{HeaderName, Request, utils::HeaderValueGetter};
use rama_core::{
    Context, Layer, Service,
    error::{BoxError, ErrorExt, OpaqueError},
};
use rama_utils::macros::define_inner_service_accessors;
use std::{fmt, marker::PhantomData};

/// A [`Service`] which stores the [`Default`] value of type `T` in case
/// the header with the given [`HeaderName`] is present
/// and has a bool-like value.
pub struct HeaderOptionValueService<T, S> {
    inner: S,
    header_name: HeaderName,
    optional: bool,
    _marker: PhantomData<fn() -> T>,
}

impl<T, S> HeaderOptionValueService<T, S> {
    /// Create a new [`HeaderOptionValueService`].
    ///
    /// Alias for [`HeaderOptionValueService::required`] if `!optional`
    /// and [`HeaderOptionValueService::optional`] if `optional`.
    pub const fn new(inner: S, header_name: HeaderName, optional: bool) -> Self {
        Self {
            inner,
            header_name,
            optional,
            _marker: PhantomData,
        }
    }

    define_inner_service_accessors!();

    /// Create a new [`HeaderOptionValueService`] with the given inner service
    /// and header name, on which optionally create the value,
    /// and which will fail if the header is missing.
    pub const fn required(inner: S, header_name: HeaderName) -> Self {
        Self::new(inner, header_name, false)
    }

    /// Create a new [`HeaderOptionValueService`] with the given inner service
    /// and header name, on which optionally create the value,
    /// and which will gracefully accept if the header is missing.
    pub const fn optional(inner: S, header_name: HeaderName) -> Self {
        Self::new(inner, header_name, true)
    }
}

impl<T, S: fmt::Debug> fmt::Debug for HeaderOptionValueService<T, S> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("HeaderOptionValueService")
            .field("inner", &self.inner)
            .field("header_name", &self.header_name)
            .field("optional", &self.optional)
            .field(
                "_marker",
                &format_args!("{}", std::any::type_name::<fn() -> T>()),
            )
            .finish()
    }
}

impl<T, S> Clone for HeaderOptionValueService<T, S>
where
    S: Clone,
{
    fn clone(&self) -> Self {
        Self {
            inner: self.inner.clone(),
            header_name: self.header_name.clone(),
            optional: self.optional,
            _marker: PhantomData,
        }
    }
}

impl<T, S, State, Body, E> Service<State, Request<Body>> for HeaderOptionValueService<T, S>
where
    S: Service<State, Request<Body>, Error = E>,
    T: Default + Clone + Send + Sync + 'static,
    State: Clone + Send + Sync + 'static,
    Body: Send + Sync + 'static,
    E: Into<BoxError> + Send + Sync + 'static,
{
    type Response = S::Response;
    type Error = BoxError;

    async fn serve(
        &self,
        mut ctx: Context<State>,
        request: Request<Body>,
    ) -> Result<Self::Response, Self::Error> {
        match request.header_str(&self.header_name) {
            Ok(str_value) => {
                let str_value = str_value.trim();
                if str_value == "1" || str_value.eq_ignore_ascii_case("true") {
                    ctx.insert(T::default());
                } else if str_value != "0" && !str_value.eq_ignore_ascii_case("false") {
                    return Err(OpaqueError::from_display(format!(
                        "invalid '{}' header option: '{}'",
                        self.header_name, str_value
                    ))
                    .into_boxed());
                }
            }
            Err(err) => {
                if self.optional && matches!(err, crate::utils::HeaderValueErr::HeaderMissing(_)) {
                    tracing::debug!(
                        error = %err,
                        header_name = %self.header_name,
                        "failed to determine header option",
                    );
                    return self.inner.serve(ctx, request).await.map_err(Into::into);
                } else {
                    return Err(err
                        .with_context(|| format!("determine '{}' header option", self.header_name))
                        .into_boxed());
                }
            }
        };
        self.inner.serve(ctx, request).await.map_err(Into::into)
    }
}

/// Layer which stores the [`Default`] value of type `T` in case
/// the header with the given [`HeaderName`] is present
/// and has a bool-like value.
pub struct HeaderOptionValueLayer<T> {
    header_name: HeaderName,
    optional: bool,
    _marker: PhantomData<fn() -> T>,
}

impl<T> fmt::Debug for HeaderOptionValueLayer<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("HeaderOptionValueLayer")
            .field("header_name", &self.header_name)
            .field("optional", &self.optional)
            .field(
                "_marker",
                &format_args!("{}", std::any::type_name::<fn() -> T>()),
            )
            .finish()
    }
}

impl<T> Clone for HeaderOptionValueLayer<T> {
    fn clone(&self) -> Self {
        Self {
            header_name: self.header_name.clone(),
            optional: self.optional,
            _marker: PhantomData,
        }
    }
}

impl<T> HeaderOptionValueLayer<T> {
    /// Create a new [`HeaderOptionValueLayer`] with the given header name,
    /// on which optionally create the valu,
    /// and which will fail if the header is missing.
    pub fn required(header_name: HeaderName) -> Self {
        Self {
            header_name,
            optional: false,
            _marker: PhantomData,
        }
    }

    /// Create a new [`HeaderOptionValueLayer`] with the given header name,
    /// on which optionally create the valu,
    /// and which will gracefully accept if the header is missing.
    pub fn optional(header_name: HeaderName) -> Self {
        Self {
            header_name,
            optional: true,
            _marker: PhantomData,
        }
    }
}

impl<T, S> Layer<S> for HeaderOptionValueLayer<T> {
    type Service = HeaderOptionValueService<T, S>;

    fn layer(&self, inner: S) -> Self::Service {
        HeaderOptionValueService::new(inner, self.header_name.clone(), self.optional)
    }

    fn into_layer(self, inner: S) -> Self::Service {
        HeaderOptionValueService::new(inner, self.header_name, self.optional)
    }
}

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

    #[derive(Debug, Clone, Default)]
    struct UnitValue;

    #[tokio::test]
    async fn test_header_option_value_required_happy_path() {
        let test_cases = [
            ("1", true),
            ("true", true),
            ("True", true),
            ("TrUE", true),
            ("TRUE", true),
            ("0", false),
            ("false", false),
            ("False", false),
            ("FaLsE", false),
            ("FALSE", false),
        ];
        for (str_value, expected_output) in test_cases {
            let request = Request::builder()
                .method(Method::GET)
                .uri("https://www.example.com")
                .header("x-unit-value", str_value)
                .body(())
                .unwrap();

            let inner_service = rama_core::service::service_fn(
                move |ctx: Context<()>, _req: Request<()>| async move {
                    assert_eq!(expected_output, ctx.contains::<UnitValue>());
                    Ok::<_, std::convert::Infallible>(())
                },
            );

            let service = HeaderOptionValueService::<UnitValue, _>::required(
                inner_service,
                HeaderName::from_static("x-unit-value"),
            );

            service.serve(Context::default(), request).await.unwrap();
        }
    }

    #[tokio::test]
    async fn test_header_option_value_optional_found() {
        let test_cases = [
            ("1", true),
            ("true", true),
            ("True", true),
            ("TrUE", true),
            ("TRUE", true),
            ("0", false),
            ("false", false),
            ("False", false),
            ("FaLsE", false),
            ("FALSE", false),
        ];
        for (str_value, expected_output) in test_cases {
            let request = Request::builder()
                .method(Method::GET)
                .uri("https://www.example.com")
                .header("x-unit-value", str_value)
                .body(())
                .unwrap();

            let inner_service = rama_core::service::service_fn(
                move |ctx: Context<()>, _req: Request<()>| async move {
                    assert_eq!(expected_output, ctx.contains::<UnitValue>());
                    Ok::<_, std::convert::Infallible>(())
                },
            );

            let service = HeaderOptionValueService::<UnitValue, _>::optional(
                inner_service,
                HeaderName::from_static("x-unit-value"),
            );

            service.serve(Context::default(), request).await.unwrap();
        }
    }

    #[tokio::test]
    async fn test_header_option_value_optional_missing() {
        let request = Request::builder()
            .method(Method::GET)
            .uri("https://www.example.com")
            .body(())
            .unwrap();

        let inner_service =
            rama_core::service::service_fn(async |ctx: Context<()>, _req: Request<()>| {
                assert!(!ctx.contains::<UnitValue>());

                Ok::<_, std::convert::Infallible>(())
            });

        let service = HeaderOptionValueService::<UnitValue, _>::optional(
            inner_service,
            HeaderName::from_static("x-unit-value"),
        );

        service.serve(Context::default(), request).await.unwrap();
    }

    #[tokio::test]
    async fn test_header_option_value_required_missing_header() {
        let request = Request::builder()
            .method(Method::GET)
            .uri("https://www.example.com")
            .body(())
            .unwrap();

        let inner_service = rama_core::service::service_fn(async |_: Request<()>| {
            Ok::<_, std::convert::Infallible>(())
        });

        let service = HeaderOptionValueService::<UnitValue, _>::required(
            inner_service,
            HeaderName::from_static("x-unit-value"),
        );

        let result = service.serve(Context::default(), request).await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_header_option_value_required_invalid_value() {
        let test_cases = ["", "foo", "yes"];

        for test_case in test_cases {
            let request = Request::builder()
                .method(Method::GET)
                .uri("https://www.example.com")
                .header("x-unit-value", test_case)
                .body(())
                .unwrap();

            let inner_service = rama_core::service::service_fn(async |_: Request<()>| {
                Ok::<_, std::convert::Infallible>(())
            });

            let service = HeaderOptionValueService::<UnitValue, _>::required(
                inner_service,
                HeaderName::from_static("x-unit-value"),
            );

            let result = service.serve(Context::default(), request).await;
            assert!(result.is_err());
        }
    }

    #[tokio::test]
    async fn test_header_option_value_optional_invalid_value() {
        let test_cases = ["", "foo", "yes"];

        for test_case in test_cases {
            let request = Request::builder()
                .method(Method::GET)
                .uri("https://www.example.com")
                .header("x-unit-value", test_case)
                .body(())
                .unwrap();

            let inner_service = rama_core::service::service_fn(async |_: Request<()>| {
                Ok::<_, std::convert::Infallible>(())
            });

            let service = HeaderOptionValueService::<UnitValue, _>::optional(
                inner_service,
                HeaderName::from_static("x-unit-value"),
            );

            let result = service.serve(Context::default(), request).await;
            assert!(result.is_err());
        }
    }
}