vidi 0.1.0

Fast, robust, flexible, lightweight web framework for Rust
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

use std::{
    fmt::Debug,
    future::{Future, IntoFuture, Pending, pending},
    io,
    pin::{Pin, pin},
    sync::Arc,
    time::Duration,
};

#[cfg(any(feature = "http1", feature = "http2"))]
use hyper_util::server::conn::auto::Builder;
use hyper_util::{
    rt::{TokioExecutor, TokioIo},
    server::graceful::GracefulShutdown,
};
use tokio::io::{AsyncRead, AsyncWrite};

use crate::{Listener, Responder, Router};

/// TLS
#[cfg(any(feature = "native-tls", feature = "rustls"))]
pub mod tls;

#[cfg(any(feature = "http1", feature = "http2"))]
mod tcp;

#[cfg(all(unix, feature = "unix-socket"))]
mod unix;

/// Starts a server and serves the connections.
pub fn serve<L>(listener: L, router: Router) -> Server<L> {
    Server::<L>::new(listener, router)
}

/// A listening HTTP server that accepts connections.
#[derive(Debug)]
pub struct Server<L, S = Pending<()>> {
    listener: L,
    signal: S,
    tree: crate::Tree,
    builder: Builder<TokioExecutor>,
}

impl<L> Server<L> {
    /// Starts a [`Server`] with a listener and a [`Router`].
    pub fn new(listener: L, router: Router) -> Self {
        Self::with_builder(listener, router, Builder::new(TokioExecutor::new()))
    }

    /// Starts a [`Server`] with a listener, a [`Router`] and a [`Builder`].
    pub fn with_builder(listener: L, router: Router, builder: Builder<TokioExecutor>) -> Self {
        Server {
            listener,
            builder,
            signal: pending(),
            tree: router.into(),
        }
    }

    /// Specifies a signal for graceful shutdown.
    pub fn signal<S>(self, signal: S) -> Server<L, S> {
        Server {
            signal,
            tree: self.tree,
            builder: self.builder,
            listener: self.listener,
        }
    }
}

impl<L, S> IntoFuture for Server<L, S>
where
    L: Listener + Send + 'static,
    L::Io: AsyncRead + AsyncWrite + Send + Unpin,
    L::Addr: Send + Sync + Debug,
    S: Future + Send + 'static,
    S::Output: Send,
{
    type Output = io::Result<()>;
    type IntoFuture = Pin<Box<dyn Future<Output = Self::Output> + Send>>;

    fn into_future(self) -> Self::IntoFuture {
        let Self {
            tree,
            signal,
            builder,
            listener,
        } = self;

        Box::pin(async move {
            let graceful = GracefulShutdown::new();
            let tree = Arc::new(tree);
            let mut signal = pin!(signal);

            loop {
                tokio::select! {
                    conn = listener.accept() => {
                        let (stream, peer_addr) = match conn {
                            Ok(conn) => conn,
                            Err(err) => {
                                if !is_connection_error(&err) {
                                    tracing::error!("listener accept error: {err}");
                                    tokio::time::sleep(Duration::from_secs(1)).await;
                                }
                                continue;
                            }
                        };

                        tracing::trace!("incoming connection accepted: {:?}", peer_addr);

                        let peer_addr = Arc::new(peer_addr);

                        let stream = TokioIo::new(Box::pin(stream));

                        let responder = Responder::new(tree.clone(), Some(peer_addr.clone()));

                        let conn = builder.serve_connection_with_upgrades(stream, responder);

                        let conn = graceful.watch(conn.into_owned());

                        tokio::spawn(async move {
                            if let Err(err) = conn.await {
                                tracing::error!("connection error: {}", err);
                            }
                            tracing::trace!("connection dropped: {:?}", peer_addr);
                        });
                    },

                    _ = signal.as_mut() => {
                        drop(listener);
                        tracing::trace!("Signal received, starting shutdown");
                        break;
                    }
                }
            }

            tokio::select! {
                () = graceful.shutdown() => {
                    tracing::trace!("Gracefully shutdown!");
                },
                () = tokio::time::sleep(Duration::from_secs(10)) => {
                    tracing::error!("Waited 10 seconds for graceful shutdown, aborting...");
                }
            }

            Ok(())
        })
    }
}

fn is_connection_error(e: &io::Error) -> bool {
    matches!(
        e.kind(),
        io::ErrorKind::ConnectionRefused
            | io::ErrorKind::ConnectionAborted
            | io::ErrorKind::ConnectionReset
    )
}