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
//! Recording utilities for servers.
//!
//! [`Recording`](Recording) type can be used to get data usage.
//!
//! # Example
//!
//! ```rust,no_run
//! use std::net::SocketAddr;
//!
//! use axum::{
//!     handler::get,
//!     extract::Extension,
//!     Router,
//! };
//!
//! use axum_server::record::Recording;
//!
//! #[tokio::main]
//! async fn main() {
//!     let app = Router::new().route("/", get(handler));
//!
//!     axum_server::bind("127.0.0.1:3000")
//!         .serve_and_record(app)
//!         .await
//!         .unwrap();
//! }
//!
//! async fn handler(
//!     Extension(addr): Extension<SocketAddr>,
//!     Extension(rec): Extension<Recording>,
//! ) -> String {
//!     format!(
//!         "addr: {}\nbytes_sent: {}\nbytes_received: {}",
//!         addr,
//!         rec.bytes_sent(),
//!         rec.bytes_received()
//!     )
//! }
//! ```

use crate::server::http_server::{HttpServer, NoopAcceptor};
use crate::server::{Accept, Handle, MakeParts};

use std::io;
use std::pin::Pin;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use std::task::{Context, Poll};

use tokio::io::{AsyncRead, AsyncWrite, ReadBuf};

use http::uri::Scheme;

use tower_http::add_extension::AddExtension;
use tower_layer::Layer;

/// Type to access data that is being recorded in real-time.
#[derive(Default, Clone)]
pub struct Recording {
    inner: Arc<RecordingInner>,
}

#[derive(Default)]
struct RecordingInner {
    sent: AtomicUsize,
    received: AtomicUsize,
}

impl Recording {
    /// Get recorded outgoing bytes.
    ///
    /// Data might be changed between function calls.
    pub fn bytes_sent(&self) -> usize {
        self.inner.sent.load(Ordering::Acquire)
    }

    /// Get recorded incoming bytes.
    ///
    /// Data might be changed between function calls.
    pub fn bytes_received(&self) -> usize {
        self.inner.received.load(Ordering::Acquire)
    }
}

#[cfg(feature = "tls-rustls")]
impl<S, A> HttpServer<S, MakeRecordingParts<A>> {
    pub(crate) fn recording_new(scheme: Scheme, service: S, handle: Handle, acceptor: A) -> Self {
        HttpServer::new(scheme, service, handle, MakeRecordingParts::new(acceptor))
    }
}

impl<S> HttpServer<S, MakeRecordingParts<NoopAcceptor>> {
    pub(crate) fn recording_from_service(scheme: Scheme, service: S, handle: Handle) -> Self {
        HttpServer::new(scheme, service, handle, MakeRecordingParts::noop())
    }
}

#[derive(Clone)]
pub(crate) struct MakeRecordingParts<A> {
    acceptor: A,
}

impl<A> MakeRecordingParts<A> {
    fn new(acceptor: A) -> Self {
        Self { acceptor }
    }
}

impl MakeRecordingParts<NoopAcceptor> {
    fn noop() -> Self {
        MakeRecordingParts::new(NoopAcceptor)
    }
}

impl<A> MakeParts for MakeRecordingParts<A>
where
    A: Clone,
{
    type Layer = RecordingLayer;
    type Acceptor = RecordingAcceptor<A>;

    fn make_parts(&self) -> (Self::Layer, Self::Acceptor) {
        let recording = Recording::default();

        let layer = RecordingLayer::new(recording.clone());
        let acceptor = RecordingAcceptor::new(self.acceptor.clone(), recording);

        (layer, acceptor)
    }
}

#[derive(Clone)]
pub(crate) struct RecordingLayer {
    recording: Recording,
}

impl RecordingLayer {
    pub(crate) fn new(recording: Recording) -> Self {
        Self { recording }
    }
}

impl<S> Layer<S> for RecordingLayer {
    type Service = AddExtension<S, Recording>;

    fn layer(&self, service: S) -> Self::Service {
        AddExtension::new(service, self.recording.clone())
    }
}

#[derive(Clone)]
pub(crate) struct RecordingAcceptor<A> {
    inner: A,
    recording: Recording,
}

impl<A> RecordingAcceptor<A> {
    pub(crate) fn new(inner: A, recording: Recording) -> Self {
        Self { inner, recording }
    }
}

impl<I, A> Accept<I> for RecordingAcceptor<A>
where
    I: AsyncRead + AsyncWrite + Unpin + Send + 'static,
    A: Accept<RecordingStream<I>>,
{
    type Conn = A::Conn;
    type Future = A::Future;

    fn accept(&self, stream: I) -> Self::Future {
        let rec_stream = RecordingStream::new(stream, self.recording.clone());

        self.inner.accept(rec_stream)
    }
}

pub(crate) struct RecordingStream<I> {
    inner: I,
    recording: Recording,
}

impl<I> RecordingStream<I> {
    pub(crate) fn new(inner: I, recording: Recording) -> Self {
        Self { inner, recording }
    }
}

impl<I> AsyncRead for RecordingStream<I>
where
    I: AsyncRead + AsyncWrite + Unpin,
{
    fn poll_read(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &mut ReadBuf<'_>,
    ) -> Poll<io::Result<()>> {
        let result = Pin::new(&mut self.inner).poll_read(cx, buf);

        self.recording
            .inner
            .received
            .fetch_add(buf.filled().len(), Ordering::Release);

        result
    }
}

impl<I> AsyncWrite for RecordingStream<I>
where
    I: AsyncRead + AsyncWrite + Unpin,
{
    fn poll_write(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        buf: &[u8],
    ) -> Poll<io::Result<usize>> {
        self.recording
            .inner
            .sent
            .fetch_add(buf.len(), Ordering::Release);

        Pin::new(&mut self.inner).poll_write(cx, buf)
    }

    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Pin::new(&mut self.inner).poll_flush(cx)
    }

    fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
        Pin::new(&mut self.inner).poll_shutdown(cx)
    }
}

#[cfg(test)]
mod tests {
    use super::Recording;

    use crate::server::tests::{empty_request, http_client, into_text};
    use crate::{Handle, Server};

    use axum::{extract::Extension, handler::get};
    use tower_service::Service;
    use tower_util::ServiceExt;

    #[ignore]
    #[tokio::test]
    async fn test_record() {
        let app = get(handler);

        let handle = Handle::new();
        let server = Server::new()
            .bind("127.0.0.1:0")
            .bind("127.0.0.1:0")
            .handle(handle.clone())
            .serve_and_record(app);

        tokio::spawn(server);

        handle.listening().await;

        let addrs = handle.listening_addrs().unwrap();
        println!("listening addrs: {:?}", addrs);

        for addr in addrs {
            let mut client = http_client(addr).await.unwrap();

            let req = empty_request(&format!("http://127.0.0.1:{}/", addr.port()));

            let resp = client.ready_and().await.unwrap().call(req).await.unwrap();

            assert_ne!(into_text(resp).await, "0");
        }
    }

    #[cfg(feature = "tls-rustls")]
    use crate::server::tls::tests::{https_client, CERTIFICATE, PRIVATE_KEY};

    #[ignore]
    #[tokio::test]
    #[cfg(feature = "tls-rustls")]
    async fn test_tls_record() {
        let key = PRIVATE_KEY.as_bytes().to_vec();
        let cert = CERTIFICATE.as_bytes().to_vec();

        let app = get(handler);

        let handle = Handle::new();
        let server = Server::new()
            .bind_rustls("127.0.0.1:0")
            .bind_rustls("127.0.0.1:0")
            .private_key(key)
            .certificate(cert)
            .handle(handle.clone())
            .serve_and_record(app);

        tokio::spawn(server);

        handle.listening().await;

        let addrs = handle.listening_addrs().unwrap();
        println!("listening addrs: {:?}", addrs);

        for addr in addrs {
            let mut client = https_client(addr).await.unwrap();

            let req = empty_request(&format!("http://127.0.0.1:{}/", addr.port()));

            let resp = client.ready_and().await.unwrap().call(req).await.unwrap();

            assert_ne!(into_text(resp).await, "0");
        }
    }

    async fn handler(Extension(rec): Extension<Recording>) -> String {
        format!("{}", rec.bytes_received())
    }
}