volo-http 0.5.6

HTTP framework implementation of volo.
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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509

//! Request builder for building a request and sending to server
//!
//! See [`RequestBuilder`] for more details.

use std::{borrow::Cow, error::Error};

use faststr::FastStr;
use http::{
    header::{HeaderMap, HeaderName, HeaderValue},
    method::Method,
    uri::{PathAndQuery, Scheme, Uri},
    version::Version,
};
use motore::layer::Layer;
use volo::{
    client::{Apply, OneShotService, WithOptService},
    net::Address,
};

use super::{CallOpt, insert_header, target::Target};
use crate::{
    body::Body,
    context::ClientContext,
    error::{
        BoxError, ClientError,
        client::{Result, builder_error},
    },
    request::Request,
    response::Response,
    utils::consts,
};

/// The builder for building a request.
pub struct RequestBuilder<S, B = Body> {
    inner: S,
    target: Target,
    version: Option<Version>,
    request: Request<B>,
    status: Result<()>,
}

impl<S> RequestBuilder<S> {
    pub(super) fn new(inner: S) -> Self {
        Self {
            inner,
            target: Default::default(),
            version: None,
            request: Request::default(),
            status: Ok(()),
        }
    }

    /// Set the request body.
    pub fn data<D>(mut self, data: D) -> Self
    where
        D: TryInto<Body>,
        D::Error: Error + Send + Sync + 'static,
    {
        if self.status.is_err() {
            return self;
        }

        let body = match data.try_into() {
            Ok(body) => body,
            Err(err) => {
                self.status = Err(builder_error(err));
                return self;
            }
        };

        let (parts, _) = self.request.into_parts();
        self.request = Request::from_parts(parts, body);

        self
    }

    /// Set the request body as json from object with [`Serialize`](serde::Serialize).
    #[cfg(feature = "json")]
    pub fn json<T>(mut self, json: &T) -> Self
    where
        T: serde::Serialize,
    {
        if self.status.is_err() {
            return self;
        }

        let json = match crate::utils::json::serialize(json) {
            Ok(json) => json,
            Err(err) => {
                self.status = Err(builder_error(err));
                return self;
            }
        };

        let (mut parts, _) = self.request.into_parts();
        parts.headers.insert(
            http::header::CONTENT_TYPE,
            crate::utils::consts::APPLICATION_JSON,
        );
        self.request = Request::from_parts(parts, Body::from(json));

        self
    }

    /// Set the request body as form from object with [`Serialize`](serde::Serialize).
    #[cfg(feature = "form")]
    pub fn form<T>(mut self, form: &T) -> Self
    where
        T: serde::Serialize,
    {
        if self.status.is_err() {
            return self;
        }

        let form = match serde_urlencoded::to_string(form) {
            Ok(form) => form,
            Err(err) => {
                self.status = Err(builder_error(err));
                return self;
            }
        };

        let (mut parts, _) = self.request.into_parts();
        parts.headers.insert(
            http::header::CONTENT_TYPE,
            crate::utils::consts::APPLICATION_WWW_FORM_URLENCODED,
        );
        self.request = Request::from_parts(parts, Body::from(form));

        self
    }

    /// Set the request body as `multipart/form-data` from a
    /// [`Form`](crate::client::multipart::Form).
    ///
    /// This sets the `Content-Type` header to `multipart/form-data` with the boundary generated by
    /// the form, and encodes all fields (including file/reader parts, which are streamed lazily)
    /// into the request body.
    #[cfg(feature = "multipart")]
    pub fn multipart(mut self, form: crate::client::multipart::Form) -> Self {
        if self.status.is_err() {
            return self;
        }

        let content_type = form.content_type();
        let (mut parts, _) = self.request.into_parts();
        parts
            .headers
            .insert(http::header::CONTENT_TYPE, content_type);
        self.request = Request::from_parts(parts, form.into_body());

        self
    }
}

impl<S, B> RequestBuilder<S, B> {
    /// Set method for the request.
    pub fn method(mut self, method: Method) -> Self {
        *self.request.method_mut() = method;
        self
    }

    /// Get a reference to method in the request.
    pub fn method_ref(&self) -> &Method {
        self.request.method()
    }

    /// Set uri for building request.
    ///
    /// The uri will be split into two parts scheme+host and path+query. The scheme and host can be
    /// empty and it will be resolved as the target address. The path and query must exist and they
    /// are used to build the request uri.
    ///
    /// Note that only path and query will be set to the request uri. For setting the full uri, use
    /// `full_uri` instead.
    pub fn uri<U>(mut self, uri: U) -> Self
    where
        U: TryInto<Uri>,
        U::Error: Into<BoxError>,
    {
        if self.status.is_err() {
            return self;
        }
        let uri = match uri.try_into() {
            Ok(uri) => uri,
            Err(err) => {
                self.status = Err(builder_error(err));
                return self;
            }
        };
        if uri.host().is_some() {
            match Target::from_uri(&uri) {
                Ok(target) => self.target = target,
                Err(err) => {
                    self.status = Err(err);
                    return self;
                }
            }
        }
        let rela_uri = uri
            .path_and_query()
            .map(PathAndQuery::to_owned)
            .unwrap_or_else(|| PathAndQuery::from_static("/"))
            .into();
        *self.request.uri_mut() = rela_uri;

        self
    }

    /// Set query for the uri in request from object with [`Serialize`](serde::Serialize).
    #[cfg(feature = "query")]
    pub fn set_query<T>(mut self, query: &T) -> Self
    where
        T: serde::Serialize,
    {
        if self.status.is_err() {
            return self;
        }
        let query_str = match serde_urlencoded::to_string(query) {
            Ok(query) => query,
            Err(err) => {
                self.status = Err(builder_error(err));
                return self;
            }
        };

        // We should keep path only without query
        let path_str = self.request.uri().path();
        let mut path = String::with_capacity(path_str.len() + 1 + query_str.len());
        path.push_str(path_str);
        path.push('?');
        path.push_str(&query_str);
        let Ok(uri) = Uri::from_maybe_shared(path) else {
            // path part is from a valid uri, and the result of urlencoded must be valid.
            unreachable!();
        };

        *self.request.uri_mut() = uri;

        self
    }

    /// Get a reference to uri in the request.
    pub fn uri_ref(&self) -> &Uri {
        self.request.uri()
    }

    /// Set version of the HTTP request.
    ///
    /// If it is not set, the request will use HTTP/2 if it is enabled and supported by default.
    pub fn version(mut self, version: Version) -> Self {
        self.version = Some(version);
        self
    }

    /// Get a reference to version in the request.
    pub fn version_ref(&self) -> Option<Version> {
        self.version
    }

    /// Insert a header into the request header map.
    pub fn header<K, V>(mut self, key: K, value: V) -> Self
    where
        K: TryInto<HeaderName>,
        K::Error: Error + Send + Sync + 'static,
        V: TryInto<HeaderValue>,
        V::Error: Error + Send + Sync + 'static,
    {
        if self.status.is_err() {
            return self;
        }

        if let Err(err) = insert_header(self.request.headers_mut(), key, value) {
            self.status = Err(err);
        }

        self
    }

    /// Get a reference to headers in the request.
    pub fn headers(&self) -> &HeaderMap {
        self.request.headers()
    }

    /// Get a mutable reference to headers in the request.
    pub fn headers_mut(&mut self) -> &mut HeaderMap {
        self.request.headers_mut()
    }

    /// Set target address for the request.
    pub fn address<A>(mut self, address: A) -> Self
    where
        A: Into<Address>,
    {
        self.target = Target::from(address.into());
        self
    }

    /// Set target host for the request.
    ///
    /// It uses http with port 80 by default.
    ///
    /// For setting scheme and port, use [`Self::with_scheme`] and [`Self::with_port`] after
    /// specifying host.
    pub fn host<H>(mut self, host: H) -> Self
    where
        H: Into<Cow<'static, str>>,
    {
        // SAFETY: using HTTP is safe
        self.target = unsafe {
            Target::new_host_unchecked(
                Scheme::HTTP,
                FastStr::from(host.into()),
                consts::HTTP_DEFAULT_PORT,
            )
        };
        self
    }

    /// Set scheme for target of the request.
    pub fn with_scheme(mut self, scheme: Scheme) -> Self {
        if self.status.is_err() {
            return self;
        }
        if let Err(err) = self.target.set_scheme(scheme) {
            self.status = Err(err);
        }
        self
    }

    /// Set port for target address of this request.
    pub fn with_port(mut self, port: u16) -> Self {
        if self.status.is_err() {
            return self;
        }
        if let Err(err) = self.target.set_port(port) {
            self.status = Err(err);
        }
        self
    }

    /// Get a reference to [`Target`].
    pub fn target_ref(&self) -> &Target {
        &self.target
    }

    /// Get a mutable reference to [`Target`].
    pub fn target_mut(&mut self) -> &mut Target {
        &mut self.target
    }

    /// Set a request body.
    pub fn body<B2>(self, body: B2) -> RequestBuilder<S, B2> {
        let (parts, _) = self.request.into_parts();
        let request = Request::from_parts(parts, body);

        RequestBuilder {
            inner: self.inner,
            target: self.target,
            version: self.version,
            request,
            status: self.status,
        }
    }

    /// Get a reference to body in the request.
    pub fn body_ref(&self) -> &B {
        self.request.body()
    }

    /// Add a new [`Layer`] to the front of request builder.
    ///
    /// Note that the [`Layer`] generated `Service` should be a [`OneShotService`].
    pub fn layer<L>(self, layer: L) -> RequestBuilder<L::Service, B>
    where
        L: Layer<S>,
    {
        RequestBuilder {
            inner: layer.layer(self.inner),
            target: self.target,
            version: self.version,
            request: self.request,
            status: self.status,
        }
    }

    /// Apply a [`CallOpt`] to the request.
    pub fn with_callopt(self, callopt: CallOpt) -> RequestBuilder<WithOptService<S, CallOpt>, B> {
        self.layer(WithOptLayer::new(callopt))
    }

    fn set_version(&mut self) {
        let ver = match self.version {
            Some(ver) => ver,
            None => {
                // Use HTTP/1.1 by default
                if cfg!(feature = "http1") {
                    Version::HTTP_11
                } else {
                    Version::HTTP_2
                }
            }
        };
        *self.request.version_mut() = ver;
    }

    /// Send the request and get the response.
    pub async fn send<RespBody>(mut self) -> Result<Response<RespBody>>
    where
        S: OneShotService<
                ClientContext,
                Request<B>,
                Response = Response<RespBody>,
                Error = ClientError,
            > + Send
            + Sync
            + 'static,
        B: Send + 'static,
    {
        self.set_version();
        self.status?;

        let mut cx = ClientContext::new();
        self.target.apply(&mut cx)?;
        self.inner.call(&mut cx, self.request).await
    }
}

struct WithOptLayer {
    opt: CallOpt,
}

impl WithOptLayer {
    const fn new(opt: CallOpt) -> Self {
        Self { opt }
    }
}

impl<S> Layer<S> for WithOptLayer {
    type Service = WithOptService<S, CallOpt>;

    fn layer(self, inner: S) -> Self::Service {
        WithOptService::new(inner, self.opt)
    }
}

#[cfg(all(test, feature = "multipart"))]
mod tests {
    use std::future::Future;

    use http::header::CONTENT_TYPE;
    use motore::service::Service;

    use super::*;
    use crate::{
        body::BodyConversion,
        client::{Client, multipart::Form, test_helpers::MockTransport},
    };

    struct InspectMultipartRequest;

    impl Service<ClientContext, Request> for InspectMultipartRequest {
        type Response = Response;
        type Error = ClientError;

        fn call(
            &self,
            _: &mut ClientContext,
            req: Request,
        ) -> impl Future<Output = Result<Self::Response>> + Send {
            async move {
                assert_eq!(req.method(), Method::POST);
                assert_eq!(req.uri(), "/upload");

                let content_type = req
                    .headers()
                    .get(CONTENT_TYPE)
                    .expect("multipart should set content-type")
                    .to_str()
                    .unwrap()
                    .to_owned();
                let boundary = content_type
                    .strip_prefix("multipart/form-data; boundary=")
                    .expect("content-type should include multipart boundary")
                    .to_owned();

                let (_, body) = req.into_parts();
                let body = body.into_string().await.unwrap();
                let expected = format!(
                    "--{boundary}\r\nContent-Disposition: form-data; \
                     name=\"field\"\r\n\r\nvalue\r\n--{boundary}--\r\n"
                );
                assert_eq!(body, expected);

                Ok(Response::default())
            }
        }
    }

    #[tokio::test]
    async fn multipart_sets_content_type_and_body() {
        let client = Client::builder()
            .mock(MockTransport::service(InspectMultipartRequest))
            .unwrap();
        let form = Form::new().text("field", "value");

        client.post("/upload").multipart(form).send().await.unwrap();
    }
}