static-web-server 3.0.0-beta.1

A cross-platform, high-performance and asynchronous web server for static files-serving.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
// This file is part of Static Web Server.
// See https://static-web-server.net/ for more information
// Copyright (C) 2019-present Jose Quintana <joseluisq.net>

//! Auto-compression module to compress responses body.
//!

// Part of the file is borrowed from <https://github.com/seanmonstar/warp/pull/513>*

#[cfg(any(feature = "compression", feature = "compression-brotli"))]
use async_compression::tokio::bufread::BrotliEncoder;
#[cfg(any(feature = "compression", feature = "compression-deflate"))]
use async_compression::tokio::bufread::DeflateEncoder;
#[cfg(any(feature = "compression", feature = "compression-gzip"))]
use async_compression::tokio::bufread::GzipEncoder;
#[cfg(any(feature = "compression", feature = "compression-zstd"))]
use async_compression::tokio::bufread::ZstdEncoder;

use headers::{ContentType, HeaderMap, HeaderMapExt, HeaderValue};
use http_body_util::BodyExt as _;
use hyper::{
    Method, Request, Response, StatusCode,
    header::{CONTENT_ENCODING, CONTENT_LENGTH},
};
use mime_guess::Mime;
use tokio_util::io::{ReaderStream, StreamReader};

use crate::body::Body;
use crate::error_page;
use crate::exts::headers::{AcceptEncoding, ContentCoding};
use crate::exts::http::{MethodExt, append_vary_accept_encoding};
use crate::exts::mime::MimeExt;
use crate::handler::RequestHandlerOpts;
use crate::settings::CompressionLevel;
use crate::{Error, Result};

/// Minimum response body size in bytes below which dynamic compression is skipped.
const MIN_COMPRESS_SIZE: usize = 200;

/// List of encodings that can be handled given enabled features.
const AVAILABLE_ENCODINGS: &[ContentCoding] = &[
    #[cfg(any(feature = "compression", feature = "compression-deflate"))]
    ContentCoding::DEFLATE,
    #[cfg(any(feature = "compression", feature = "compression-gzip"))]
    ContentCoding::GZIP,
    #[cfg(any(feature = "compression", feature = "compression-brotli"))]
    ContentCoding::BROTLI,
    #[cfg(any(feature = "compression", feature = "compression-zstd"))]
    ContentCoding::ZSTD,
];

/// Initializes dynamic compression.
pub fn init(enabled: bool, level: CompressionLevel, handler_opts: &mut RequestHandlerOpts) {
    handler_opts.compression = enabled;
    handler_opts.compression_level = level;

    const FORMATS: &[&str] = &[
        #[cfg(any(feature = "compression", feature = "compression-deflate"))]
        "deflate",
        #[cfg(any(feature = "compression", feature = "compression-gzip"))]
        "gzip",
        #[cfg(any(feature = "compression", feature = "compression-brotli"))]
        "brotli",
        #[cfg(any(feature = "compression", feature = "compression-zstd"))]
        "zstd",
    ];
    tracing::info!(
        enabled,
        formats = %FORMATS.join(","),
        compression_level = ?level,
        "auto compression"
    );
}

/// Post-processing to dynamically compress the response if necessary.
pub(crate) fn post_process<T>(
    opts: &RequestHandlerOpts,
    req: &Request<T>,
    mut resp: Response<Body>,
) -> Result<Response<Body>, Error> {
    if !opts.compression {
        return Ok(resp);
    }

    let is_precompressed = resp.headers().get(CONTENT_ENCODING).is_some();
    if is_precompressed {
        return Ok(resp);
    }

    // Compression content encoding varies so use a `Vary` header
    append_vary_accept_encoding(&mut resp);

    // Auto compression based on the `Accept-Encoding` header
    match auto(req.method(), req.headers(), opts.compression_level, resp) {
        Ok(resp) => Ok(resp),
        Err(err) => {
            tracing::error!("error during body compression: {:?}", err);
            error_page::error_response(
                req.uri(),
                req.method(),
                &StatusCode::INTERNAL_SERVER_ERROR,
                &opts.page404,
                &opts.page50x,
            )
        }
    }
}

/// Create a wrapping handler that compresses the Body of a [`hyper::Response`]
/// using gzip, `deflate`, `brotli` or `zstd` if is specified in the `Accept-Encoding` header, adding
/// `content-encoding: <coding>` to the Response's [`HeaderMap`].
/// It also provides the ability to apply compression for text-based MIME types only.
pub fn auto(
    method: &Method,
    headers: &HeaderMap<HeaderValue>,
    level: CompressionLevel,
    resp: Response<Body>,
) -> Result<Response<Body>> {
    // Skip compression for HEAD and OPTIONS request methods
    if method.is_head() || method.is_options() {
        return Ok(resp);
    }

    // Compress response based on Accept-Encoding header
    if let Some(encoding) = get_preferred_encoding(headers) {
        tracing::trace!(
            "preferred encoding selected from the accept-encoding header: {:?}",
            encoding
        );

        // Skip compression for non-text-based MIME types
        if let Some(content_type) = resp.headers().typed_get::<ContentType>()
            && !Mime::from(content_type).is_compressible()
        {
            return Ok(resp);
        }

        // Skip compression for responses below the minimum size threshold.
        // Tiny payloads gain no benefit and the compression overhead can
        // make them larger than the original.
        if let Some(content_length) = resp
            .headers()
            .get(CONTENT_LENGTH)
            .and_then(|v| v.to_str().ok())
            .and_then(|v| v.parse::<usize>().ok())
            && content_length < MIN_COMPRESS_SIZE
        {
            tracing::trace!(
                "skipping compression: content-length ({content_length}) below minimum ({MIN_COMPRESS_SIZE})",
            );
            return Ok(resp);
        }

        #[cfg(any(feature = "compression", feature = "compression-gzip"))]
        if encoding == ContentCoding::GZIP {
            let (head, body) = resp.into_parts();
            return Ok(gzip(head, body, level));
        }

        #[cfg(any(feature = "compression", feature = "compression-deflate"))]
        if encoding == ContentCoding::DEFLATE {
            let (head, body) = resp.into_parts();
            return Ok(deflate(head, body, level));
        }

        #[cfg(any(feature = "compression", feature = "compression-brotli"))]
        if encoding == ContentCoding::BROTLI {
            let (head, body) = resp.into_parts();
            return Ok(brotli(head, body, level));
        }

        #[cfg(any(feature = "compression", feature = "compression-zstd"))]
        if encoding == ContentCoding::ZSTD {
            let (head, body) = resp.into_parts();
            return Ok(zstd(head, body, level));
        }

        tracing::trace!(
            "no compression feature matched the preferred encoding, probably not enabled or unsupported"
        );
    }

    Ok(resp)
}

/// Create a wrapping handler that compresses the Body of a [`Response`].
/// using gzip, adding `content-encoding: gzip` to the Response's [`HeaderMap`].
#[cfg(any(feature = "compression", feature = "compression-gzip"))]
#[cfg_attr(
    docsrs,
    doc(cfg(any(feature = "compression", feature = "compression-gzip")))
)]
pub fn gzip(
    mut head: http::response::Parts,
    body: Body,
    level: CompressionLevel,
) -> Response<Body> {
    const DEFAULT_COMPRESSION_LEVEL: i32 = 4;

    tracing::trace!("compressing response body on the fly using GZIP");

    let level = level.into_algorithm_level(DEFAULT_COMPRESSION_LEVEL);
    let body = crate::body::stream(ReaderStream::new(GzipEncoder::with_quality(
        StreamReader::new(body.into_data_stream()),
        level,
    )));
    let header = create_encoding_header(head.headers.remove(CONTENT_ENCODING), ContentCoding::GZIP);
    head.headers.remove(CONTENT_LENGTH);
    head.headers.insert(CONTENT_ENCODING, header);
    Response::from_parts(head, body)
}

/// Create a wrapping handler that compresses the Body of a [`Response`].
/// using deflate, adding `content-encoding: deflate` to the Response's [`HeaderMap`].
#[cfg(any(feature = "compression", feature = "compression-deflate"))]
#[cfg_attr(
    docsrs,
    doc(cfg(any(feature = "compression", feature = "compression-deflate")))
)]
pub fn deflate(
    mut head: http::response::Parts,
    body: Body,
    level: CompressionLevel,
) -> Response<Body> {
    const DEFAULT_COMPRESSION_LEVEL: i32 = 4;

    tracing::trace!("compressing response body on the fly using DEFLATE");

    let level = level.into_algorithm_level(DEFAULT_COMPRESSION_LEVEL);
    let body = crate::body::stream(ReaderStream::new(DeflateEncoder::with_quality(
        StreamReader::new(body.into_data_stream()),
        level,
    )));
    let header = create_encoding_header(
        head.headers.remove(CONTENT_ENCODING),
        ContentCoding::DEFLATE,
    );
    head.headers.remove(CONTENT_LENGTH);
    head.headers.insert(CONTENT_ENCODING, header);
    Response::from_parts(head, body)
}

/// Create a wrapping handler that compresses the Body of a [`Response`].
/// using brotli, adding `content-encoding: br` to the Response's [`HeaderMap`].
#[cfg(any(feature = "compression", feature = "compression-brotli"))]
#[cfg_attr(
    docsrs,
    doc(cfg(any(feature = "compression", feature = "compression-brotli")))
)]
pub fn brotli(
    mut head: http::response::Parts,
    body: Body,
    level: CompressionLevel,
) -> Response<Body> {
    const DEFAULT_COMPRESSION_LEVEL: i32 = 4;

    tracing::trace!("compressing response body on the fly using BROTLI");

    let level = level.into_algorithm_level(DEFAULT_COMPRESSION_LEVEL);
    let body = crate::body::stream(ReaderStream::new(BrotliEncoder::with_quality(
        StreamReader::new(body.into_data_stream()),
        level,
    )));
    let header =
        create_encoding_header(head.headers.remove(CONTENT_ENCODING), ContentCoding::BROTLI);
    head.headers.remove(CONTENT_LENGTH);
    head.headers.insert(CONTENT_ENCODING, header);
    Response::from_parts(head, body)
}

/// Create a wrapping handler that compresses the Body of a [`Response`].
/// using zstd, adding `content-encoding: zstd` to the Response's [`HeaderMap`].
#[cfg(any(feature = "compression", feature = "compression-zstd"))]
#[cfg_attr(
    docsrs,
    doc(cfg(any(feature = "compression", feature = "compression-zstd")))
)]
pub fn zstd(
    mut head: http::response::Parts,
    body: Body,
    level: CompressionLevel,
) -> Response<Body> {
    const DEFAULT_COMPRESSION_LEVEL: i32 = 3;

    tracing::trace!("compressing response body on the fly using ZSTD");

    let level = level.into_algorithm_level(DEFAULT_COMPRESSION_LEVEL);
    let body = crate::body::stream(ReaderStream::new(ZstdEncoder::with_quality(
        StreamReader::new(body.into_data_stream()),
        level,
    )));
    let header = create_encoding_header(head.headers.remove(CONTENT_ENCODING), ContentCoding::ZSTD);
    head.headers.remove(CONTENT_LENGTH);
    head.headers.insert(CONTENT_ENCODING, header);
    Response::from_parts(head, body)
}

/// Given an optional existing encoding header, appends to the existing or creates a new one.
pub fn create_encoding_header(existing: Option<HeaderValue>, coding: ContentCoding) -> HeaderValue {
    if let Some(val) = existing
        && let Ok(str_val) = val.to_str()
    {
        return HeaderValue::from_str(&[str_val, ", ", coding.as_str()].concat())
            .unwrap_or_else(|_| coding.into());
    }
    coding.into()
}

/// Try to get the preferred `content-encoding` via the `accept-encoding` header.
#[inline(always)]
pub fn get_preferred_encoding(headers: &HeaderMap<HeaderValue>) -> Option<ContentCoding> {
    if let Some(ref accept_encoding) = headers.typed_get::<AcceptEncoding>() {
        tracing::trace!("request with accept-encoding header: {:?}", accept_encoding);

        for encoding in accept_encoding.sorted_encodings() {
            if AVAILABLE_ENCODINGS.contains(&encoding) {
                return Some(encoding);
            }
        }
    }
    None
}

/// Get the `content-encodings` via the `accept-encoding` header.
#[inline(always)]
pub fn get_encodings(headers: &HeaderMap<HeaderValue>) -> Vec<ContentCoding> {
    if let Some(ref accept_encoding) = headers.typed_get::<AcceptEncoding>() {
        tracing::trace!("request with accept-encoding header: {:?}", accept_encoding);

        return accept_encoding
            .sorted_encodings()
            .filter(|encoding| AVAILABLE_ENCODINGS.contains(encoding))
            .collect::<Vec<_>>();
    }
    vec![]
}

#[cfg(test)]
#[cfg(any(feature = "compression", feature = "compression-gzip"))]
mod tests {
    use super::*;
    use crate::body;
    use crate::settings::CompressionLevel;
    use http::header::{ACCEPT_ENCODING, CONTENT_TYPE};
    use hyper::{Method, Response};

    /// Build a `Response<Body>` with a text content-type header,
    /// a content-length header, and a body of `size` bytes.
    fn text_response_with_size(size: usize) -> Response<Body> {
        let body = body::full(vec![b'x'; size]);
        let mut resp = Response::new(body);
        resp.headers_mut()
            .insert(CONTENT_TYPE, "text/html".parse().unwrap());
        resp.headers_mut()
            .insert(CONTENT_LENGTH, size.to_string().parse().unwrap());
        resp
    }

    /// Build a `Response<Body>` without any `Content-Length` header.
    fn text_response_without_length() -> Response<Body> {
        let body = body::full(b"hello world".as_slice());
        let mut resp = Response::new(body);
        resp.headers_mut()
            .insert(CONTENT_TYPE, "text/html".parse().unwrap());
        resp
    }

    /// Build a simple GET `HeaderMap` with an Accept-Encoding: gzip header.
    fn accept_gzip_headers() -> HeaderMap<HeaderValue> {
        let mut h = HeaderMap::new();
        h.insert(ACCEPT_ENCODING, "gzip".parse().unwrap());
        h
    }

    // Minimum-size threshold tests

    #[test]
    fn small_response_below_threshold_is_not_compressed() {
        let resp = text_response_with_size(MIN_COMPRESS_SIZE - 1);
        let headers = accept_gzip_headers();
        let result = auto(&Method::GET, &headers, CompressionLevel::Default, resp).unwrap();
        // no content-encoding should be set
        assert!(
            result.headers().get(CONTENT_ENCODING).is_none(),
            "responses below {MIN_COMPRESS_SIZE} bytes must not be compressed"
        );
    }

    #[test]
    fn response_at_threshold_is_compressed() {
        let resp = text_response_with_size(MIN_COMPRESS_SIZE);
        let headers = accept_gzip_headers();
        let result = auto(&Method::GET, &headers, CompressionLevel::Default, resp).unwrap();
        assert!(
            result.headers().get(CONTENT_ENCODING).is_some(),
            "responses at exactly {MIN_COMPRESS_SIZE} bytes must be compressed"
        );
    }

    #[test]
    fn response_above_threshold_is_compressed() {
        let resp = text_response_with_size(MIN_COMPRESS_SIZE + 1);
        let headers = accept_gzip_headers();
        let result = auto(&Method::GET, &headers, CompressionLevel::Default, resp).unwrap();
        assert!(
            result.headers().get(CONTENT_ENCODING).is_some(),
            "responses above {MIN_COMPRESS_SIZE} bytes must be compressed"
        );
    }

    #[test]
    fn response_without_content_length_is_compressed() {
        let resp = text_response_without_length();
        let headers = accept_gzip_headers();
        let result = auto(&Method::GET, &headers, CompressionLevel::Default, resp).unwrap();
        assert!(
            result.headers().get(CONTENT_ENCODING).is_some(),
            "responses without Content-Length must still be compressed (safe default)"
        );
    }

    #[test]
    fn small_response_head_method_is_not_compressed() {
        let resp = text_response_with_size(MIN_COMPRESS_SIZE - 1);
        let headers = accept_gzip_headers();
        let result = auto(&Method::HEAD, &headers, CompressionLevel::Default, resp).unwrap();
        assert!(
            result.headers().get(CONTENT_ENCODING).is_none(),
            "HEAD requests are never compressed regardless of size"
        );
    }

    #[test]
    fn non_compressible_content_type_is_not_compressed() {
        let body = body::full(vec![b'x'; MIN_COMPRESS_SIZE + 100]);
        let mut resp = Response::new(body);
        resp.headers_mut()
            .insert(CONTENT_TYPE, "image/png".parse().unwrap());
        resp.headers_mut().insert(
            CONTENT_LENGTH,
            (MIN_COMPRESS_SIZE + 100).to_string().parse().unwrap(),
        );
        let headers = accept_gzip_headers();
        let result = auto(&Method::GET, &headers, CompressionLevel::Default, resp).unwrap();
        assert!(
            result.headers().get(CONTENT_ENCODING).is_none(),
            "non-compressible content-types are never compressed"
        );
    }
}