rullst-core 12.3.0

Core runtime, routing engine, and telemetry for the Rullst framework suite.
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

//! Percent-encoded object paths for public storage URLs.

use std::fmt::Write;

/// Percent-encodes every byte of each `/`-separated key segment except the
/// RFC 3986 unreserved set `A-Z a-z 0-9 - . _ ~` (uppercase hex).
///
/// `key` must already be normalized, so `/` only separates segments. A `#`,
/// `?`, `%`, space or non-ASCII byte therefore stays part of the object key
/// instead of starting a fragment or query or being re-decoded.
pub(super) fn encode_key_path(key: &str) -> String {
    let mut encoded = String::with_capacity(key.len());
    for byte in key.bytes() {
        if byte == b'/' || byte.is_ascii_alphanumeric() || matches!(byte, b'-' | b'.' | b'_' | b'~')
        {
            encoded.push(char::from(byte));
        } else {
            // Writing into a `String` cannot fail.
            let _ = write!(encoded, "%{byte:02X}");
        }
    }
    encoded
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
mod tests {
    use super::encode_key_path;
    use crate::storage::{LocalDriver, Storage};

    #[test]
    fn key_segments_are_percent_encoded_but_separators_are_kept() {
        assert_eq!(
            encode_key_path("courses/1/lesson.txt"),
            "courses/1/lesson.txt"
        );
        assert_eq!(encode_key_path("a-b_c.d~e"), "a-b_c.d~e");
        assert_eq!(
            encode_key_path("reports/Q1 #2?.pdf"),
            "reports/Q1%20%232%3F.pdf"
        );
        assert_eq!(encode_key_path("100%/ação"), "100%25/a%C3%A7%C3%A3o");
        assert_eq!(encode_key_path("a+b=c&d:e"), "a%2Bb%3Dc%26d%3Ae");
    }

    #[test]
    fn cloud_urls_keep_reserved_characters_inside_the_object_key() {
        let s3 = Storage::s3("assets", "us-east-1");
        let r2 = Storage::r2("assets", "account");

        assert_eq!(
            s3.url("reports/Q1 #2.pdf").unwrap(),
            "https://assets.s3.us-east-1.amazonaws.com/reports/Q1%20%232.pdf"
        );
        assert_eq!(
            r2.url("reports/ação?.pdf").unwrap(),
            "https://account.r2.cloudflarestorage.com/assets/reports/a%C3%A7%C3%A3o%3F.pdf"
        );
    }

    #[tokio::test]
    async fn local_urls_are_public_paths_not_filesystem_paths() {
        let absolute = Storage::local("/srv/app/storage");
        let relative = Storage::local("storage");
        let driver = LocalDriver::new("/srv/app/storage");

        for storage in [&absolute, &relative] {
            assert_eq!(storage.url("a.png").unwrap(), "/storage/a.png");
            assert_eq!(
                storage.url("avatars/my photo#1.png").unwrap(),
                "/storage/avatars/my%20photo%231.png"
            );
        }
        // Both local URL helpers resolve the same object to the same URL.
        assert_eq!(
            driver.url("avatars/my photo#1.png").await.unwrap(),
            absolute.url("avatars/my photo#1.png").unwrap()
        );
        assert!(!absolute.url("a.png").unwrap().contains("/srv/app"));
    }
}