sark-http 0.28.3

HTTP wire types, semantics, codecs, and ownership invariants for Sark
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
452
453
454
use sark_http::payload::response::Method;

use dope_test::alloc::Tracker;
use o3::buffer::write::CopyError;
use request::scan;
use sark_http::h1::{
    field,
    head::{Boundary, Limit, ParseError, request, response},
};

#[global_allocator]
static ALLOCATOR: Tracker = Tracker::new();

#[test]
fn request_splits() {
    let wire = b"POST /items?q=1 HTTP/1.1\r\nHost: example.test\r\nContent-Length: 4\r\nConnection: keep-alive\r\n\r\nbody";
    let head_len = wire.len() - b"body".len();
    let fields = [
        (b"Host".as_slice(), b"example.test".as_slice()),
        (b"Content-Length".as_slice(), b"4".as_slice()),
        (b"Connection".as_slice(), b"keep-alive".as_slice()),
    ];
    for split in 0..=head_len {
        let state = scan::State::new(wire[..split].to_vec(), Limit::DEFAULT);
        let mut seen = 0;
        let mut emit = |field: field::Entry<'_>| {
            assert_eq!(
                Some((field.name(), field.value())),
                fields.get(seen).copied(),
                "field {seen} at split {split}"
            );
            seen += 1;
            Ok::<_, ()>(())
        };
        let first = (state.advance(&mut emit)).expect("first fragment at {split}");
        let parts = match first {
            scan::Progress::Complete(parts) => parts,
            scan::Progress::More(mut state) => {
                (state.try_extend(&wire[split..]))
                    .as_ref()
                    .expect("test operation must succeed");
                match state
                    .advance(&mut emit)
                    .expect("second fragment at {split}")
                {
                    scan::Progress::Complete(parts) => parts,
                    outcome => {
                        assert!(
                            matches!(outcome, scan::Progress::Complete(_)),
                            "second fragment at {split}"
                        );
                        return;
                    }
                }
            }
        };
        assert_eq!(parts.wire_len().get() as usize, head_len, "split {split}");
        assert_eq!(
            parts.as_ref().line(),
            (b"POST".as_slice(), b"/items?q=1".as_slice())
        );
        assert_eq!(seen, 3, "split {split}");
    }
}

#[test]
fn response_splits() {
    let wire =
        b"HTTP/1.1 204 No Content\r\nConnection: keep-alive\r\nContent-Length: 0\r\n\r\nnext";
    let head_len = wire
        .windows(4)
        .position(|bytes| bytes == b"\r\n\r\n")
        .expect("response fixture has a head terminator")
        + 4;
    let fields = [
        (b"Connection".as_slice(), b"keep-alive".as_slice()),
        (b"Content-Length".as_slice(), b"0".as_slice()),
    ];
    for split in 0..=head_len {
        response::State::with(
            wire[..split].to_vec(),
            Method::Other,
            Limit::DEFAULT,
            |mut source, progress| {
                let mut seen = 0usize;
                let (progress, parts) = {
                    let mut emit = |field: field::Entry<'_>| {
                        assert_eq!(
                            Some((field.name(), field.value())),
                            fields.get(seen).copied(),
                            "field {seen} at split {split}"
                        );
                        seen += 1;
                        Ok::<_, ()>(())
                    };
                    let (progress, first) = progress
                        .advance(&source, &mut emit)
                        .expect("test operation must succeed");
                    match first {
                        Some(parts) => (progress, parts),
                        None => {
                            source
                                .try_extend(&wire[split..])
                                .expect("append response suffix");
                            let (progress, parts) = progress
                                .advance(&source, &mut emit)
                                .expect("test operation must succeed");
                            (
                                progress,
                                parts.expect("second fragment completes the response head"),
                            )
                        }
                    }
                };
                assert_eq!(parts.wire_len().get() as usize, head_len, "split {split}");
                assert_eq!(parts.status().as_u16(), 204);
                assert_eq!(seen, 2, "split {split}");
                let mut replay = 0;
                let (_, again) = progress
                    .advance(&source, |_| -> Result<(), ()> {
                        replay += 1;
                        Ok(())
                    })
                    .expect("test operation must succeed");
                assert_eq!(
                    again
                        .expect("completed head remains available")
                        .wire_len()
                        .get() as usize,
                    head_len,
                    "repeat split {split}"
                );
                assert_eq!(replay, 0, "repeat split {split}");
            },
        );
    }
}

#[test]
fn request_grammar() {
    let cases = [
        (
            b"GET / HTTP/1.1\r\nHost: example.test\r\nX-abcdefghijklmnopqrstuvwxyz0123456789-ABCDEFGHIJKLMNOPQRSTUVWXYZ: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\r\n\r\n"
                .as_slice(),
            true,
        ),
        (b"GET / HTTP/1.1\r\nHost: example.test\r\n Folded: no\r\n\r\n".as_slice(), false),
        (b"GET / HTTP/1.1\r\nHost: example.test\n\n".as_slice(), false),
        (b"GET / HTTP/1.1\r\nHost: example.test\r\nX-A: a\0b\r\n\r\n".as_slice(), false),
        (b"GET / HTTP/1.1\r\nHost: example.test\r".as_slice(), false),
    ];
    for (wire, accepted) in cases {
        let mut whole = Vec::new();
        let complete = request::Parts::parse(wire, Limit::DEFAULT, |field| {
            whole.push((field.name_span(), field.value_span()));
            Ok::<_, ()>(())
        })
        .is_ok_and(|parts| parts.is_some_and(|head| head.wire_len().get() as usize == wire.len()));
        assert_eq!(complete, accepted);

        for split in 0..=wire.len() {
            let state = scan::State::new(wire[..split].to_vec(), Limit::DEFAULT);
            let mut part = Vec::new();
            let mut emit = |field: field::Entry<'_>| {
                part.push((field.name_span(), field.value_span()));
                Ok::<_, ()>(())
            };
            let first = state.advance(&mut emit);
            let split_ok = match first {
                Ok(scan::Progress::Complete(head)) => head.wire_len().get() as usize == wire.len(),
                Ok(scan::Progress::More(mut state)) => {
                    (state.try_extend(&wire[split..]))
                        .as_ref()
                        .expect("test operation must succeed");
                    match state.advance(&mut emit) {
                        Ok(scan::Progress::Complete(head)) => {
                            head.wire_len().get() as usize == wire.len()
                        }
                        Ok(scan::Progress::More(_)) => false,
                        Err((source, error)) => {
                            assert_eq!(source, wire);
                            assert!(!matches!(error, ParseError::Sink(())));
                            false
                        }
                    }
                }
                Err((source, error)) => {
                    assert_eq!(source, &wire[..split]);
                    assert!(!matches!(error, ParseError::Sink(())));
                    false
                }
            };
            assert_eq!(split_ok, complete, "split {split}: {wire:?}");
            assert!((part) == (whole), "field spans at split {split}: {wire:?}");
        }
    }
}

#[test]
fn request_sink_stops() {
    let wire = b"GET / HTTP/1.1\r\nHost: example.test\r\nX-Later: skipped\r\n\r\n";
    let state = scan::State::new(wire.as_slice(), Limit::DEFAULT);
    let mut seen = 0;
    let result = state.advance(|field| {
        seen += 1;
        assert_eq!(
            (field.name(), field.value()),
            (b"Host".as_slice(), b"example.test".as_slice())
        );
        Err::<(), _>("stop")
    });
    assert!(matches!(result.err(), Some((source, ParseError::Sink("stop"))) if source == wire));
    assert_eq!(seen, 1);
}

#[test]
fn response_sink_stops() {
    let wire = b"HTTP/1.1 200 OK\r\nContent-Length: 0\r\n\r\n";
    let source = wire.to_vec();
    let pointer = source[wire.len() - 5..].as_ptr();
    response::State::with(source, Method::Other, Limit::DEFAULT, |source, progress| {
        let mut seen = 0;
        let error = progress
            .advance(&source, |field| {
                seen += 1;
                assert_eq!(
                    (field.name(), field.value()),
                    (b"Content-Length".as_slice(), b"0".as_slice())
                );
                Err::<(), _>(field.value())
            })
            .err()
            .expect("sink stops progress");
        assert!(matches!(error, ParseError::Sink(value)
            if value == b"0" && value.as_ptr() == pointer));
        assert_eq!(source.as_ref(), wire);
        assert_eq!(seen, 1);
    });
}

#[test]
fn start_line_limit() {
    let wire = b"GET /\r";
    let limit = Limit::DEFAULT.with_bytes(5);
    let mut fields = 0;
    let complete = request::Parts::parse(wire, limit, |_| -> Result<(), ()> {
        fields += 1;
        Ok(())
    });
    assert!(matches!(
        complete,
        Err(ParseError::Boundary(Boundary::TooLarge {
            actual: 7,
            limit: 5
        }))
    ));
    let state = scan::State::new(wire[..5].to_vec(), limit);
    let mut state = match state
        .advance(|_| -> Result<(), ()> {
            fields += 1;
            Ok(())
        })
        .expect("the prefix is incomplete")
    {
        scan::Progress::More(state) => state,
        outcome => {
            assert!(
                matches!(outcome, scan::Progress::More(_)),
                "the prefix is incomplete"
            );
            return;
        }
    };
    (state.try_extend(&wire[5..]))
        .as_ref()
        .expect("test operation must succeed");
    assert!(matches!(state.advance(|_| -> Result<(), ()> {
            fields += 1;
            Ok(())
        }).err(), Some((source, ParseError::Boundary(Boundary::TooLarge { actual: 7, limit: 5 }))) if source == wire));
    assert_eq!(fields, 0);
}

#[test]
fn resumed_line_bounds_head() {
    let wire = b"GET / HTTP/1.1\r\nHost: x\r\n\r\npayload beyond the head limit";
    let limit = Limit::DEFAULT.with_bytes(27);
    let state = scan::State::new(wire[..15].to_vec(), limit);
    let mut fields = 0;
    let mut state = match state
        .advance(|_| -> Result<(), ()> {
            fields += 1;
            Ok(())
        })
        .expect("the prefix is incomplete")
    {
        scan::Progress::More(state) => state,
        outcome => {
            assert!(
                matches!(outcome, scan::Progress::More(_)),
                "the prefix is incomplete"
            );
            return;
        }
    };
    assert_eq!(fields, 0);
    (state.try_extend(&wire[15..]))
        .as_ref()
        .expect("test operation must succeed");
    let parts = match state
        .advance(|field| {
            assert_eq!(
                (field.name(), field.value()),
                (b"Host".as_slice(), b"x".as_slice())
            );
            fields += 1;
            Ok::<(), ()>(())
        })
        .expect("the complete head ends inside the limit")
    {
        scan::Progress::Complete(parts) => parts,
        outcome => {
            assert!(
                matches!(outcome, scan::Progress::Complete(_)),
                "the complete head ends inside the limit"
            );
            return;
        }
    };
    assert_eq!(parts.wire_len().get(), 27);
    assert_eq!(parts.as_ref().line(), (b"GET".as_slice(), b"/".as_slice()));
    assert_eq!(fields, 1);
}

#[test]
fn copy_preserves_progress() {
    let prefix = b"GET / HTTP/1.1\r\nHost: example.test\r\n";
    let state = scan::State::new(prefix.as_slice(), Limit::DEFAULT);
    let mut fields = 0;
    let state = match state
        .advance(|_| {
            fields += 1;
            Ok::<_, ()>(())
        })
        .expect("valid prefix")
    {
        scan::Progress::More(state) => state,
        outcome => {
            assert!(
                matches!(outcome, scan::Progress::More(_)),
                "unfinished head retains its state"
            );
            return;
        }
    };
    assert_eq!(fields, 1);
    let target = Vec::with_capacity(128);
    let (result, activity) = Tracker::measure(|| state.try_copy(target));
    assert_eq!(activity, [0; 4]);
    let mut state = match result {
        Ok(state) => state,
        outcome => {
            assert!(outcome.is_ok(), "empty target accepts the exact prefix");
            return;
        }
    };
    assert_eq!(state.as_ref(), prefix);
    state
        .try_extend(b"Connection: close\r\n\r\n")
        .expect("append remaining head");
    let parts = match state
        .advance(|field| {
            assert_eq!(field.name(), b"Connection");
            fields += 1;
            Ok::<_, ()>(())
        })
        .expect("complete copied head")
    {
        scan::Progress::Complete(parts) => parts,
        outcome => {
            assert!(
                matches!(outcome, scan::Progress::Complete(_)),
                "copied head completes"
            );
            return;
        }
    };
    assert_eq!(parts.as_ref().line(), (b"GET".as_slice(), b"/".as_slice()));
    let end = parts.wire_len();
    let route = parts.into_route();
    assert_eq!(route.as_ref().method(), "GET");
    assert_eq!(route.as_ref().target(), "/");
    let source = route.into_source();
    assert_eq!(source.len(), end.get() as usize);
    assert_eq!(fields, 2);
}

#[test]
fn copy_rejects_prefix() {
    let source = b"GET / HTTP/1.1\r\nHost: example.test\r\n";
    let state = scan::State::new(source.as_slice(), Limit::DEFAULT);
    let target = vec![b'x'];
    let (result, activity) = Tracker::measure(|| state.try_copy(target));
    assert_eq!(activity, [0; 4]);
    let (target, cause) = result
        .err()
        .expect("nonempty destination rejects relocation");
    assert_eq!(state.as_ref(), source);
    assert_eq!(target, b"x");
    assert!(matches!(cause, CopyError::Prefix(len) if len.get() == 1));
    let mut state = match state.try_copy(Vec::with_capacity(128)) {
        Ok(state) => state,
        outcome => {
            assert!(
                outcome.is_ok(),
                "retained parser can retry with an empty owner"
            );
            return;
        }
    };
    state
        .try_extend(b"\r\n")
        .expect("complete the original head");
    assert!(matches!(
        state.advance(|_| Ok::<_, ()>(())),
        Ok(scan::Progress::Complete(_))
    ));
}

#[test]
fn copy_rejects_capacity() {
    use o3::buffer::storage::inline;
    let prefix = b"GET / HTTP/1.1\r\nHost: example.test\r\n";
    let state = scan::State::new(prefix.as_slice(), Limit::DEFAULT);
    let target = inline::Bytes::<4>::new();
    let (result, activity) = Tracker::measure(|| state.try_copy(target));
    assert_eq!(activity, [0; 4]);
    let (target, cause) = result.err().expect("the prefix exceeds the destination");
    let cause = match cause {
        CopyError::Write(cause) => cause,
        outcome => {
            assert!(
                matches!(outcome, CopyError::Write(_)),
                "the empty destination fails only its write admission"
            );
            return;
        }
    };
    let (required, room) = cause.into_parts();
    assert_eq!(required.get(), prefix.len());
    assert_eq!(room, 4);
    assert_eq!(state.as_ref(), prefix);
    assert!(target.is_empty());
}