axol 0.2.0

Axol Web Framework
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
use std::borrow::Cow;
use std::panic::AssertUnwindSafe;
use std::pin::Pin;
use std::task::{Context, Poll};
use std::{convert::Infallible, net::SocketAddr, sync::Arc};

use crate::{
    ConnectInfo, DefaultErrorHook, Error, ErrorHook, Handler, ObservedRoute, OuterWrapState,
    RawPathExt, RequestHook, Wrap, WrapTarget,
};
use crate::{IntoResponse, Result, WrapState};
use async_trait::async_trait;
use axol_http::body::{BodyComponent, BodyWrapper};
use axol_http::header::HeaderMapConvertError;
use axol_http::{Body, StatusCode};
use axol_http::{request::Request, response::Response};
use futures::{FutureExt, Stream};
use http_body::Body as HttpBody;
use hyper::body::Incoming;
use hyper::{Request as HyperRequest, Response as HyperResponse};
use hyper_util::rt::{TokioExecutor, TokioIo};
use hyper_util::server::conn::auto;
use log::error;
use pin_project_lite::pin_project;
use tokio::io::{AsyncRead, AsyncWrite};
use tokio::net::{TcpListener, TcpStream};
#[cfg(feature = "trace")]
use tracing::Instrument;

use crate::Router;

#[cfg(feature = "tls")]
mod tls_acceptor;
#[cfg(feature = "tls")]
pub use tls_acceptor::*;

/// Source of inbound connections for a [`Server`].
///
/// hyper 1.x no longer ships a connection-accepting abstraction, so `axol` defines its own.
/// Implement this to serve over a transport other than the built-in TCP and TLS acceptors.
#[async_trait]
pub trait Acceptor: Send + 'static {
    /// The connected stream, already handed off any transport-level handshake.
    type Conn: AsyncRead + AsyncWrite + Unpin + Send + 'static;

    /// Accepts the next connection along with the peer address to report as [`ConnectInfo`].
    ///
    /// Returning an error is treated as non-fatal: the error is logged and the loop continues.
    async fn accept(&mut self) -> std::io::Result<(Self::Conn, SocketAddr)>;
}

/// Accepts plaintext TCP connections.
pub struct TcpAcceptor {
    listener: TcpListener,
    nodelay: bool,
}

impl TcpAcceptor {
    pub async fn bind(addr: SocketAddr) -> std::io::Result<Self> {
        Ok(Self {
            listener: TcpListener::bind(addr).await?,
            nodelay: false,
        })
    }

    pub fn from_listener(listener: TcpListener) -> Self {
        Self {
            listener,
            nodelay: false,
        }
    }

    pub fn set_nodelay(&mut self, nodelay: bool) {
        self.nodelay = nodelay;
    }

    /// The address actually bound, useful when binding to port 0.
    pub fn local_addr(&self) -> std::io::Result<SocketAddr> {
        self.listener.local_addr()
    }
}

#[async_trait]
impl Acceptor for TcpAcceptor {
    type Conn = TcpStream;

    async fn accept(&mut self) -> std::io::Result<(Self::Conn, SocketAddr)> {
        let (stream, addr) = self.listener.accept().await?;
        if self.nodelay {
            stream.set_nodelay(true)?;
        }
        Ok((stream, addr))
    }
}

/// An HTTP server bound to an [`Acceptor`], serving a [`Router`].
pub struct Server<A> {
    acceptor: A,
    router: Router,
}

impl Server<TcpAcceptor> {
    /// Binds a plaintext TCP server on `addr`.
    pub async fn bind(addr: SocketAddr, router: Router) -> std::io::Result<Self> {
        Ok(Self {
            acceptor: TcpAcceptor::bind(addr).await?,
            router,
        })
    }
}

impl<A: Acceptor> Server<A> {
    /// Builds a server over a custom [`Acceptor`].
    pub fn new(acceptor: A, router: Router) -> Self {
        Self { acceptor, router }
    }

    /// The address actually bound, useful when binding to port 0.
    pub fn local_addr(&self) -> std::io::Result<SocketAddr>
    where
        A: LocalAddr,
    {
        self.acceptor.local_addr()
    }
}

/// Acceptors that can report the address they are listening on.
pub trait LocalAddr {
    fn local_addr(&self) -> std::io::Result<SocketAddr>;
}

impl LocalAddr for TcpAcceptor {
    fn local_addr(&self) -> std::io::Result<SocketAddr> {
        TcpAcceptor::local_addr(self)
    }
}

impl<A: Acceptor + LocalAddr> LocalAddr for Server<A> {
    fn local_addr(&self) -> std::io::Result<SocketAddr> {
        self.acceptor.local_addr()
    }
}

pin_project! {
    struct BodyInputStream {
        #[pin]
        body: Incoming,
        ended: bool,
    }
}

impl Stream for BodyInputStream {
    type Item = std::result::Result<BodyComponent, anyhow::Error>;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let this = self.project();
        if *this.ended {
            return Poll::Ready(None);
        }
        // http-body 1.x delivers data and trailers through one `poll_frame` channel.
        match this.body.poll_frame(cx) {
            Poll::Pending => Poll::Pending,
            Poll::Ready(None) => {
                *this.ended = true;
                Poll::Ready(None)
            }
            Poll::Ready(Some(Err(e))) => {
                *this.ended = true;
                Poll::Ready(Some(Err(e.into())))
            }
            Poll::Ready(Some(Ok(frame))) => {
                let frame = match frame.into_data() {
                    Ok(data) => return Poll::Ready(Some(Ok(BodyComponent::Data(data)))),
                    Err(frame) => frame,
                };
                match frame.into_trailers() {
                    Ok(trailers) => Poll::Ready(Some(
                        trailers
                            .try_into()
                            .map_err(|e: HeaderMapConvertError| e.into())
                            .map(BodyComponent::Trailers),
                    )),
                    // An unrecognized frame kind carries nothing we can surface; skip it.
                    Err(_) => {
                        cx.waker().wake_by_ref();
                        Poll::Pending
                    }
                }
            }
        }
    }
}

#[async_recursion::async_recursion]
pub(crate) async fn inner_handler(
    request_hooks: Vec<Arc<dyn RequestHook>>,
    wraps: Vec<Arc<dyn Wrap>>,
    handler: Arc<dyn Handler>,
    request: &mut Request,
) -> Result<Response> {
    for middleware in request_hooks {
        match middleware.handle_request(&mut *request).await {
            Ok(Some(x)) => return Ok(x),
            Err(Error::SkipMiddleware) | Ok(None) => (),
            Err(e) => return Err(e),
        }
    }
    let state = WrapState {
        wraps,
        target: WrapTarget::Handler(&*handler),
        request,
    };
    state.next().await
}

async fn request_phase(
    request_hooks: Vec<Arc<dyn RequestHook>>,
    wraps: Vec<Arc<dyn Wrap>>,
    outer_wraps: Vec<Arc<dyn Wrap>>,
    handler: Arc<dyn Handler>,
    request: &mut Request,
) -> Result<Response> {
    let outer_wrap_state = OuterWrapState {
        request_hooks,
        wraps,
        handler,
    };

    let state = WrapState {
        wraps: outer_wraps,
        target: WrapTarget::Phase(outer_wrap_state),
        request,
    };
    state.next().await
}

async fn handle_error(
    observed: &ObservedRoute<'_>,
    request: &mut Request,
    mut error: Error,
) -> Response {
    for middleware in &observed.error_hooks {
        match middleware.handle_error(request.parts(), &mut error).await {
            Ok(Some(x)) => return x,
            Err(Error::SkipMiddleware) | Ok(None) => (),
            Err(e) => {
                log::error!("error hook middleware failure: {e}");
            }
        }
    }
    DefaultErrorHook
        .handle_error(request.parts(), &mut error)
        .await
        .unwrap()
        .unwrap()
}

async fn handle_early_response(
    observed: &ObservedRoute<'_>,
    request: &mut Request,
    mut response: Response,
) -> Response {
    for middleware in &observed.early_response_hooks {
        match middleware
            .handle_response(request.parts(), &mut response)
            .await
        {
            Err(Error::SkipMiddleware) | Ok(()) => (),
            Err(error) => {
                return handle_error(observed, request, error).await;
            }
        }
    }
    response
}

async fn handle_late_response(
    observed: &ObservedRoute<'_>,
    request: &mut Request,
    response: &mut Response,
) {
    for middleware in &observed.late_response_hooks {
        middleware.handle_response(request.parts(), response).await;
    }
}

async fn do_handle_axol_response(
    router: Arc<Router>,
    address: SocketAddr,
    request: HyperRequest<Incoming>,
) -> Result<Response> {
    #[cfg_attr(not(feature = "ws"), allow(unused_mut))]
    let (mut parts, body) = request.into_parts();
    let size_hint = body.size_hint().lower() as usize;
    let extensions = axol_http::Extensions::new();
    // `http::Extensions` cannot be iterated, so named types are moved across individually.
    #[cfg(feature = "ws")]
    extensions.take_from_http::<hyper::upgrade::OnUpgrade>(&mut parts.extensions);
    let mut request = Request {
        method: parts
            .method
            .try_into()
            .map_err(|_| Error::Status(axol_http::StatusCode::MethodNotAllowed))?,
        uri: parts.uri,
        version: parts.version,
        headers: parts
            .headers
            .try_into()
            .map_err(|e: HeaderMapConvertError| Error::unprocessable_entity(e.to_string()))?,
        extensions,
        body: Body::Stream {
            size_hint: Some(size_hint),
            stream: Box::pin(BodyInputStream { body, ended: false }),
        },
    };
    let mut observed = router.resolve_path(request.method, request.uri.path());
    for (_, value) in observed.variables.0.iter_mut() {
        let decoded = percent_encoding::percent_decode_str(value)
            .decode_utf8()
            .map_err(|_| Error::BadUtf8)?;
        if let Cow::Owned(decoded) = decoded {
            *value = decoded;
        }
    }
    //TODO: make this extension gathering more efficient
    request.extensions.extend(&observed.extensions);
    request
        .extensions
        .insert(RawPathExt(std::mem::take(&mut observed.variables.0)));
    request.extensions.insert(ConnectInfo(address));

    #[cfg(feature = "trace")]
    let remote = address;
    #[cfg(feature = "trace")]
    let span = tracing::trace_span!("axol_http", %remote, uri = %request.uri);

    let wraps = std::mem::take(&mut observed.wraps);
    let outer_wraps = std::mem::take(&mut observed.outer_wraps);
    let request_hooks = std::mem::take(&mut observed.request_hooks);

    // we are not passing any interior mutability or mutability into the catch_unwind.
    // (that isn't dropped inside if a panic occurs)
    // TODO: this might not be a good idea, analyze how this could interact with application code
    let late_response = AssertUnwindSafe(async move {
        let mut late_response = match request_phase(
            request_hooks,
            wraps,
            outer_wraps,
            observed.route.clone(),
            &mut request,
        )
        .await
        {
            Ok(x) => handle_early_response(&observed, &mut request, x).await,
            Err(error) => handle_error(&observed, &mut request, error).await,
        };
        handle_late_response(&observed, &mut request, &mut late_response).await;
        late_response
    })
    .catch_unwind();

    #[cfg(feature = "trace")]
    let late_response = late_response.instrument(span.clone()).await;
    #[cfg(not(feature = "trace"))]
    let late_response = late_response.await;
    #[cfg(feature = "trace")]
    let _span = span.enter();
    // no more awaiting because of in-span

    let late_response = match late_response {
        Ok(x) => x,
        Err(e) => {
            let display = e
                .downcast::<String>()
                .map(|x| *x)
                .or_else(|e| e.downcast::<&'static str>().map(|x| x.to_string()))
                .unwrap_or_else(|e| format!("{e:?}"));
            error!("panic during handler/middlware: {display}");
            StatusCode::InternalServerError.into_response().unwrap()
        }
    };

    Ok(late_response)
}

async fn do_handle(
    router: Arc<Router>,
    address: SocketAddr,
    request: HyperRequest<Incoming>,
) -> std::result::Result<HyperResponse<BodyWrapper>, Infallible> {
    let is_head = request.method() == http::Method::HEAD;
    let mut response = match do_handle_axol_response(router, address, request).await {
        Ok(x) => x,
        Err(e) => e.into_response(),
    };

    if is_head {
        std::mem::take(&mut response.body);
    }

    let status: http::StatusCode = response.status.into();
    let mut builder = HyperResponse::builder()
        .status(status)
        .version(response.version);
    *builder.headers_mut().unwrap() = response.headers.into();
    //TODO: due to limitations in converting Arc <-> Box for unsized types, we can't pass extensions back atm
    *builder.extensions_mut().unwrap() = Default::default();
    Ok(builder
        .body(response.body.into())
        .expect("body conversion failed"))
}

impl<A: Acceptor> Server<A> {
    /// Serves until the accept loop terminates.
    pub async fn serve(self) -> std::io::Result<()> {
        self.serve_custom(|_| ()).await
    }

    /// Serves, letting `customize` adjust the hyper connection builder (timeouts, HTTP/2 knobs, ...).
    pub async fn serve_custom(
        mut self,
        customize: impl FnOnce(&mut auto::Builder<TokioExecutor>),
    ) -> std::io::Result<()> {
        self.router.set_paths("");
        let router = Arc::new(self.router);

        let mut builder = auto::Builder::new(TokioExecutor::new());
        customize(&mut builder);
        let builder = Arc::new(builder);

        loop {
            let (conn, address) = match self.acceptor.accept().await {
                Ok(x) => x,
                Err(e) => {
                    // A per-connection accept failure must not take the whole server down.
                    error!("error accepting connection: {e}");
                    continue;
                }
            };
            let router = router.clone();
            let builder = builder.clone();
            tokio::spawn(async move {
                let service =
                    hyper::service::service_fn(move |req| do_handle(router.clone(), address, req));
                // `with_upgrades` is required for websocket handlers to work.
                if let Err(e) = builder
                    .serve_connection_with_upgrades(TokioIo::new(conn), service)
                    .await
                {
                    log::debug!("error serving connection from {address}: {e}");
                }
            });
        }
    }
}