h3x 0.2.0

High-performance zero-copy DHTTP/3 implementation
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
use std::{
    error::Error,
    task::{Context, Poll},
};

use bytes::Bytes;
use futures::future::{self, BoxFuture};
use http::Method;
use http_body::Body;
use http_body_util::{BodyExt, Empty, combinators::UnsyncBoxBody};
use snafu::{Report, ResultExt, Snafu};
use tracing::Instrument;

use crate::{
    message::stream::{
        MessageStreamError, ReadStream,
        hyper::{
            upgrade::{RemainStream, TakeoverSlot},
            write::SendMessageError,
        },
    },
    server::{Request, Response, UnresolvedRequest},
};

#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct TowerService<S>(pub S);

impl<S, RespBody> crate::server::Service for TowerService<S>
where
    S: tower_service::Service<
            http::Request<UnsyncBoxBody<Bytes, MessageStreamError>>,
            Response = http::Response<RespBody>,
            Error: Error + Send,
            Future: Send,
        > + Clone
        + Send
        + 'static,
    RespBody: Body<Data: Send, Error: Error + Send + 'static> + Send,
{
    type Future<'s> = BoxFuture<'s, ()>;

    fn serve<'s>(&self, req: &'s mut Request, resp: &'s mut Response) -> Self::Future<'s> {
        let mut service = self.0.clone();
        Box::pin(async move {
            if let Err(error) = future::poll_fn(|cx| service.poll_ready(cx)).await {
                tracing::debug!(error = %Report::from_error(error), "service cannot be ready");
                return;
            }

            let mut read_stream = Some(req.read_stream().take());
            let mut write_stream = resp.write_stream().take();
            resp.mark_taken_over();

            let is_connect = req.method() == Method::CONNECT;

            let (remain_write_stream_tx, remain_write_stream) = RemainStream::pending();
            let request = if is_connect {
                let remain_read_stream = RemainStream::immediately(
                    read_stream
                        .take()
                        .expect("connect request must have read stream"),
                );
                http::Request::builder()
                    .method(req.method())
                    .uri(req.uri())
                    .extension(TakeoverSlot::new(remain_read_stream))
                    .extension(TakeoverSlot::new(remain_write_stream.clone()))
                    .body(UnsyncBoxBody::new(Empty::new().map_err(|n| match n {})))
            } else {
                http::Request::builder()
                    .method(req.method())
                    .uri(req.uri())
                    .body(UnsyncBoxBody::new(
                        read_stream
                            .take()
                            .expect("non-connect request must have read stream")
                            .into_hyper_body(),
                    ))
            };

            let mut request = match request {
                Ok(request) => request,
                Err(error) => {
                    tracing::warn!(error = %Report::from_error(error), "failed to convert request, skip serving");
                    return;
                }
            };

            *request.headers_mut() = req.headers().clone();
            request.extensions_mut().insert(resp.agent().clone());
            request.extensions_mut().insert(req.stream_id());
            request.extensions_mut().insert(req.protocols().clone());
            if let Some(remote_agent) = req.agent().cloned() {
                request.extensions_mut().insert(remote_agent);
            }

            match service.call(request).await {
                Ok(response) => {
                    if let Err(error) = write_stream.send_hyper_response(response).await {
                        tracing::debug!(error = %Report::from_error(error), "failed to send response");
                    }
                    if is_connect {
                        // Flush the buffered response so the client receives
                        // it before the stream is handed to the upgrade layer.
                        _ = write_stream.flush().await;
                        _ = remain_write_stream_tx.send(write_stream);
                    } else {
                        _ = write_stream.close().await;
                    }
                }
                Err(error) => {
                    tracing::debug!(error = %Report::from_error(error), "service failed")
                }
            }
        })
    }
}

#[derive(Debug, Snafu)]
#[snafu(module)]
pub enum HandleRequestError<S: Error + 'static, B: Error + 'static> {
    #[snafu(display("failed to handle message stream"))]
    Stream { source: MessageStreamError },
    #[snafu(display("service error"))]
    Service { source: S },
    #[snafu(display("response body error"))]
    Body { source: B },
}

impl<S: Error + 'static, B: Error + 'static> From<SendMessageError<B>>
    for HandleRequestError<S, B>
{
    fn from(source: SendMessageError<B>) -> Self {
        match source {
            SendMessageError::Stream { source } => HandleRequestError::Stream { source },
            SendMessageError::Body { source } => HandleRequestError::Body { source },
        }
    }
}

impl<S, RespBody, ServiceE> tower_service::Service<UnresolvedRequest> for TowerService<S>
where
    S: tower_service::Service<
            http::Request<UnsyncBoxBody<Bytes, MessageStreamError>>,
            Response = http::Response<RespBody>,
            Error = ServiceE,
            Future: Send,
        > + Clone
        + Send
        + 'static,
    ServiceE: Error + 'static,
    RespBody: Body<Data: Send, Error: Error + Send + 'static> + Send,
{
    type Response = ();

    type Error = HandleRequestError<ServiceE, RespBody::Error>;

    type Future = BoxFuture<'static, Result<Self::Response, Self::Error>>;

    fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        self.0
            .poll_ready(cx)
            .map_err(|source| HandleRequestError::Service { source })
    }

    fn call(
        &mut self,
        UnresolvedRequest {
            request_stream,
            remote_agent,
            mut response_stream,
            local_agent,
            stream_id,
            protocols,
        }: UnresolvedRequest,
    ) -> Self::Future {
        let span = tracing::info_span!(
            "handle_request",
            method = tracing::field::Empty,
            uri = tracing::field::Empty
        );

        let mut service = self.0.clone();
        let future = async move {
            future::poll_fn(|cx| service.poll_ready(cx))
                .await
                .context(handle_request_error::ServiceSnafu)?;

            let mut request = request_stream
                .into_hyper_request()
                .await
                .context(handle_request_error::StreamSnafu)?
                .map(UnsyncBoxBody::new);
            tracing::Span::current()
                .record("method", request.method().as_str())
                .record("uri", request.uri().to_string());

            tracing::trace!("converted request stream to hyper request, serving...");
            let is_connect = request.method() == Method::CONNECT;
            let (remain_write_stream_tx, remain_write_stream) = RemainStream::pending();

            request.extensions_mut().insert(local_agent);
            if let Some(remote_agent) = remote_agent {
                request.extensions_mut().insert(remote_agent);
            }
            request.extensions_mut().insert(stream_id);
            request.extensions_mut().insert(protocols);
            if is_connect
                && request
                    .extensions()
                    .get::<TakeoverSlot<ReadStream>>()
                    .is_some()
            {
                request
                    .extensions_mut()
                    .insert(TakeoverSlot::new(remain_write_stream.clone()));
            }

            let response = service
                .call(request)
                .await
                .context(handle_request_error::ServiceSnafu)?;

            response_stream.send_hyper_response(response).await?;
            if is_connect {
                response_stream
                    .flush()
                    .await
                    .context(handle_request_error::StreamSnafu)?;
                _ = remain_write_stream_tx.send(response_stream);
            } else {
                response_stream
                    .close()
                    .await
                    .context(handle_request_error::StreamSnafu)?;
            }

            Ok(())
        };
        Box::pin(future.instrument(span))
    }
}

#[derive(Default, Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct HyperService<S>(pub S);

impl<S, RespBody> crate::server::Service for HyperService<S>
where
    S: hyper::service::Service<
            http::Request<UnsyncBoxBody<Bytes, MessageStreamError>>,
            Response = http::Response<RespBody>,
            Error: Error + Send,
            Future: Send,
        > + Clone
        + Send
        + 'static,
    RespBody: Body<Data: Send, Error: Error + Send + 'static> + Send,
{
    type Future<'s> = BoxFuture<'s, ()>;

    fn serve<'s>(&self, req: &'s mut Request, resp: &'s mut Response) -> Self::Future<'s> {
        let service = self.0.clone();
        Box::pin(async move {
            let mut read_stream = Some(req.read_stream().take());
            let mut write_stream = resp.write_stream().take();
            resp.mark_taken_over();

            let is_connect = req.method() == Method::CONNECT;

            let (remain_write_stream_tx, remain_write_stream) = RemainStream::pending();
            let request = if is_connect {
                let remain_read_stream = RemainStream::immediately(
                    read_stream
                        .take()
                        .expect("connect request must have read stream"),
                );
                http::Request::builder()
                    .method(req.method())
                    .uri(req.uri())
                    .extension(TakeoverSlot::new(remain_read_stream))
                    .extension(TakeoverSlot::new(remain_write_stream.clone()))
                    .body(UnsyncBoxBody::new(Empty::new().map_err(|n| match n {})))
            } else {
                http::Request::builder()
                    .method(req.method())
                    .uri(req.uri())
                    .body(UnsyncBoxBody::new(
                        read_stream
                            .take()
                            .expect("non-connect request must have read stream")
                            .into_hyper_body(),
                    ))
            };

            let mut request = match request {
                Ok(request) => request,
                Err(error) => {
                    tracing::warn!(error = %Report::from_error(error), "failed to convert request, skip serving");
                    return;
                }
            };

            *request.headers_mut() = req.headers().clone();
            request.extensions_mut().insert(resp.agent().clone());
            request.extensions_mut().insert(req.stream_id());
            request.extensions_mut().insert(req.protocols().clone());
            if let Some(remote_agent) = req.agent().cloned() {
                request.extensions_mut().insert(remote_agent);
            }

            match service.call(request).await {
                Ok(response) => {
                    if let Err(error) = write_stream.send_hyper_response(response).await {
                        tracing::debug!(error = %Report::from_error(error), "failed to send response");
                    }
                    if is_connect {
                        _ = write_stream.flush().await;
                        _ = remain_write_stream_tx.send(write_stream);
                    } else {
                        _ = write_stream.close().await;
                    }
                }
                Err(error) => {
                    tracing::debug!(error = %Report::from_error(error), "service failed")
                }
            }
        })
    }
}

impl<S, RespBody, ServiceE> tower_service::Service<UnresolvedRequest> for HyperService<S>
where
    S: hyper::service::Service<
            http::Request<UnsyncBoxBody<Bytes, MessageStreamError>>,
            Response = http::Response<RespBody>,
            Error = ServiceE,
            Future: Send,
        > + Clone
        + Send
        + 'static,
    ServiceE: Error + 'static,
    RespBody: Body<Data: Send, Error: Error + Send + 'static> + Send,
{
    type Response = ();

    type Error = HandleRequestError<ServiceE, RespBody::Error>;

    type Future = BoxFuture<'static, Result<Self::Response, Self::Error>>;

    fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Poll::Ready(Ok(()))
    }

    fn call(
        &mut self,
        UnresolvedRequest {
            request_stream,
            remote_agent,
            mut response_stream,
            local_agent,
            stream_id,
            protocols,
        }: UnresolvedRequest,
    ) -> Self::Future {
        let span = tracing::info_span!(
            "handle_request",
            method = tracing::field::Empty,
            uri = tracing::field::Empty
        );

        let service = self.0.clone();
        let future = async move {
            let mut request = request_stream
                .into_hyper_request()
                .await
                .context(handle_request_error::StreamSnafu)?
                .map(UnsyncBoxBody::new);
            tracing::Span::current()
                .record("method", request.method().as_str())
                .record("uri", request.uri().to_string());

            tracing::trace!("converted request stream to hyper request, serving...");
            let is_connect = request.method() == Method::CONNECT;
            let (remain_write_stream_tx, remain_write_stream) = RemainStream::pending();

            request.extensions_mut().insert(local_agent);
            if let Some(remote_agent) = remote_agent {
                request.extensions_mut().insert(remote_agent);
            }
            request.extensions_mut().insert(stream_id);
            request.extensions_mut().insert(protocols);
            if is_connect
                && request
                    .extensions()
                    .get::<TakeoverSlot<ReadStream>>()
                    .is_some()
            {
                request
                    .extensions_mut()
                    .insert(TakeoverSlot::new(remain_write_stream.clone()));
            }

            let response = service
                .call(request)
                .await
                .context(handle_request_error::ServiceSnafu)?;

            response_stream.send_hyper_response(response).await?;
            if is_connect {
                response_stream
                    .flush()
                    .await
                    .context(handle_request_error::StreamSnafu)?;
                _ = remain_write_stream_tx.send(response_stream);
            } else {
                response_stream
                    .close()
                    .await
                    .context(handle_request_error::StreamSnafu)?;
            }

            Ok(())
        };
        Box::pin(future.instrument(span))
    }
}