autumn-web 0.5.0

An opinionated, convention-over-configuration 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
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

//! Integration tests for first-class response compression (#974).
//!
//! Covers:
//! - Compressible dynamic response with `Accept-Encoding: gzip` → `Content-Encoding: gzip`
//! - `Vary: Accept-Encoding` present on all compressible responses
//! - Non-compressible content types are never compressed
//! - No double-compression when `Content-Encoding` is already set
//! - Compression is off by default (opt-in)

use autumn_web::config::{AutumnConfig, CompressionConfig};
use autumn_web::test::TestApp;
use autumn_web::{get, routes};
use axum::http::header;
use axum::response::{IntoResponse, Response};

// ── Handlers ─────────────────────────────────────────────────────────────────

const HTML_BODY: &str = concat!(
    "<!DOCTYPE html><html><body>",
    // Pad to ensure the body is large enough that gzip savings are positive.
    "Hello from Autumn! This is a compressible HTML response used to test ",
    "that the framework correctly applies gzip compression when the client ",
    "advertises Accept-Encoding: gzip. Lorem ipsum dolor sit amet. ",
    "Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet. ",
    "Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet. ",
    "</body></html>"
);

#[get("/html")]
async fn html_handler() -> impl IntoResponse {
    (
        [(header::CONTENT_TYPE, "text/html; charset=utf-8")],
        HTML_BODY,
    )
}

#[get("/json")]
async fn json_handler() -> impl IntoResponse {
    (
        [(header::CONTENT_TYPE, "application/json")],
        r#"{"message":"hello","data":"lorem ipsum dolor sit amet consectetur adipiscing elit sed do eiusmod"}"#,
    )
}

#[get("/png")]
async fn png_handler() -> impl IntoResponse {
    // Simulate a binary image response (non-compressible content type).
    (
        [(header::CONTENT_TYPE, "image/png")],
        b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00".as_slice(),
    )
}

#[get("/zip")]
async fn zip_handler() -> impl IntoResponse {
    // Simulate a dynamic zip archive download (already compressed — should not be re-compressed).
    (
        [(header::CONTENT_TYPE, "application/zip")],
        b"PK\x03\x04fake-zip-content-for-testing-purposes-only-padded".as_slice(),
    )
}

#[get("/pre-encoded")]
async fn pre_encoded_handler() -> Response {
    // Simulate a response that already has Content-Encoding set (e.g. pre-compressed asset).
    let mut resp = Response::new(axum::body::Body::from(vec![0u8; 32]));
    resp.headers_mut()
        .insert(header::CONTENT_ENCODING, "gzip".parse().unwrap());
    resp.headers_mut().insert(
        header::CONTENT_TYPE,
        "text/html; charset=utf-8".parse().unwrap(),
    );
    resp
}

// ── Helpers ───────────────────────────────────────────────────────────────────

fn compression_enabled_config() -> AutumnConfig {
    let mut config = AutumnConfig::default();
    config.compression.enabled = true;
    config
}

// ── Tests ─────────────────────────────────────────────────────────────────────

/// Compression is **off by default** — no Content-Encoding even with Accept-Encoding.
#[tokio::test]
async fn compression_disabled_by_default() {
    let app = TestApp::new().routes(routes![html_handler]).build();

    let resp = app
        .get("/html")
        .header("accept-encoding", "gzip")
        .send()
        .await;

    resp.assert_ok();
    assert_eq!(
        resp.header("content-encoding"),
        None,
        "compression must be opt-in; default config must not compress"
    );
}

/// When enabled and client sends `Accept-Encoding: gzip`, response is gzip-compressed.
#[tokio::test]
async fn gzip_compression_applied_when_enabled_and_accepted() {
    let app = TestApp::new()
        .routes(routes![html_handler])
        .config(compression_enabled_config())
        .build();

    let resp = app
        .get("/html")
        .header("accept-encoding", "gzip")
        .send()
        .await;

    resp.assert_ok();
    assert_eq!(
        resp.header("content-encoding"),
        Some("gzip"),
        "should have Content-Encoding: gzip when compression is enabled and client accepts gzip"
    );
    // Compressed body should not equal the raw body (it's a different byte sequence).
    assert_ne!(
        resp.body,
        HTML_BODY.as_bytes(),
        "compressed body must differ from raw body"
    );
}

/// JSON responses are also compressed.
#[tokio::test]
async fn json_response_compressed_when_enabled() {
    let app = TestApp::new()
        .routes(routes![json_handler])
        .config(compression_enabled_config())
        .build();

    let resp = app
        .get("/json")
        .header("accept-encoding", "gzip")
        .send()
        .await;

    resp.assert_ok();
    assert_eq!(
        resp.header("content-encoding"),
        Some("gzip"),
        "JSON should be compressed"
    );
}

/// `Vary: Accept-Encoding` must be present on compressible responses when compression is enabled.
#[tokio::test]
async fn vary_accept_encoding_set_on_compressible_response() {
    let app = TestApp::new()
        .routes(routes![html_handler])
        .config(compression_enabled_config())
        .build();

    // Even without Accept-Encoding the Vary header should tell caches the
    // response could differ by encoding.
    let resp = app.get("/html").send().await;

    resp.assert_ok();
    let vary = resp.header("vary").unwrap_or("");
    assert!(
        vary.to_lowercase().contains("accept-encoding"),
        "Vary: Accept-Encoding must be set on compressible responses; got Vary: {vary:?}"
    );
}

/// Binary / already-non-compressible content types (image/png) must not be compressed.
#[tokio::test]
async fn binary_content_type_not_compressed() {
    let app = TestApp::new()
        .routes(routes![png_handler])
        .config(compression_enabled_config())
        .build();

    let resp = app
        .get("/png")
        .header("accept-encoding", "gzip")
        .send()
        .await;

    resp.assert_ok();
    assert_eq!(
        resp.header("content-encoding"),
        None,
        "binary content types must not be compressed"
    );
}

/// Responses that already carry `Content-Encoding` must not be double-compressed.
#[tokio::test]
async fn no_double_compression_when_already_encoded() {
    let app = TestApp::new()
        .routes(routes![pre_encoded_handler])
        .config(compression_enabled_config())
        .build();

    let resp = app
        .get("/pre-encoded")
        .header("accept-encoding", "gzip")
        .send()
        .await;

    resp.assert_ok();
    // Content-Encoding should still be exactly "gzip" (the original), not "gzip, gzip".
    let ce = resp.header("content-encoding").unwrap_or("");
    assert_eq!(
        ce, "gzip",
        "double-compression must not occur; got Content-Encoding: {ce:?}"
    );
}

/// Without `Accept-Encoding` header, no compression is applied even when enabled.
#[tokio::test]
async fn no_compression_when_client_does_not_accept() {
    let app = TestApp::new()
        .routes(routes![html_handler])
        .config(compression_enabled_config())
        .build();

    let resp = app.get("/html").send().await;

    resp.assert_ok();
    assert_eq!(
        resp.header("content-encoding"),
        None,
        "no Accept-Encoding → no Content-Encoding"
    );
}

/// Archive content types (application/zip etc.) must not be compressed — they're
/// already compressed and re-compressing wastes CPU and increases transfer size.
#[tokio::test]
async fn archive_content_type_not_compressed() {
    let app = TestApp::new()
        .routes(routes![zip_handler])
        .config(compression_enabled_config())
        .build();

    let resp = app
        .get("/zip")
        .header("accept-encoding", "gzip")
        .send()
        .await;

    resp.assert_ok();
    assert_eq!(
        resp.header("content-encoding"),
        None,
        "application/zip must not be compressed by the framework"
    );
}

// ── Unit tests for CompressionConfig ─────────────────────────────────────────

#[test]
fn compression_config_disabled_by_default() {
    let config = CompressionConfig::default();
    assert!(!config.enabled, "compression must be off by default");
}

#[test]
fn compression_config_toml_round_trips() {
    let toml_str = r"
[compression]
enabled = true
";
    let config: AutumnConfig = toml::from_str(toml_str).unwrap();
    assert!(config.compression.enabled);
}

#[test]
fn compression_config_env_override() {
    use autumn_web::config::MockEnv;
    let env = MockEnv::new().with("AUTUMN_COMPRESSION__ENABLED", "true");
    let mut config = AutumnConfig::default();
    config.apply_env_overrides_with_env(&env);
    assert!(config.compression.enabled);
}