mini-static 0.29.0

A secure, async static file server with streaming, traversal protection, and connection limits.
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

use super::*;

use std::fs as std_fs;
use tempfile::TempDir;

fn metadata_for(dir: &TempDir, name: &str, contents: &[u8]) -> std_fs::Metadata {
    let path = dir.path().join(name);
    std_fs::write(&path, contents).unwrap();
    std_fs::metadata(&path).unwrap()
}

/// The validator must carry sub-second precision, since that is the entire justification
/// for serving an ETag instead of `Last-Modified`.
#[test]
fn an_etag_carries_a_sub_second_component() {
    let dir = TempDir::new().unwrap();
    let etag = generate_etag(&metadata_for(&dir, "a.txt", b"contents"));

    let (size, time) = etag
        .trim_matches('"')
        .split_once('-')
        .expect("format is \"<size>-<secs>.<nanos>\"");
    assert_eq!(size, "8");
    assert!(
        time.contains('.'),
        "expected a <secs>.<nanos> time component, got: {time}"
    );
}

/// The bug this format exists to prevent: two writes of equal length, close enough
/// together to share a whole second, previously produced identical ETags — so a client
/// revalidating against the first was told `304 Not Modified` while holding stale bytes.
#[test]
fn two_same_length_writes_in_quick_succession_differ() {
    let dir = TempDir::new().unwrap();

    let first = generate_etag(&metadata_for(&dir, "asset.js", b"aaaaa"));
    let second = generate_etag(&metadata_for(&dir, "asset.js", b"bbbbb"));

    assert_ne!(
        first, second,
        "an equal-length rewrite must change the validator"
    );
}

/// Length alone still distinguishes representations, including on a filesystem whose
/// timestamps are coarse enough to collide.
#[test]
fn different_lengths_produce_different_etags() {
    let dir = TempDir::new().unwrap();

    let short = generate_etag(&metadata_for(&dir, "a.txt", b"aa"));
    let long = generate_etag(&metadata_for(&dir, "b.txt", b"aaaaaaaa"));

    assert_ne!(short, long);
}

/// Nothing about the ETag may vary between two reads of an unchanged file, or every
/// revalidation would miss and the validator would be worthless.
#[test]
fn an_unchanged_file_keeps_its_etag() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("stable.txt");
    std_fs::write(&path, b"unchanged").unwrap();

    let first = generate_etag(&std_fs::metadata(&path).unwrap());
    let second = generate_etag(&std_fs::metadata(&path).unwrap());

    assert_eq!(first, second);
}