trillium-http 1.1.0

the http implementation for the trillium toolkit
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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
use futures_lite::{AsyncRead, AsyncWrite};
use std::{
    fmt,
    io::{Error, ErrorKind, IoSlice, Result},
    pin::Pin,
    task::{Context, Poll, ready},
};
use trillium_macros::AsyncRead;

#[doc(hidden)]
#[derive(AsyncRead)]
pub struct BufWriter<W> {
    #[async_read]
    inner: W,
    buffer: Vec<u8>,
    buffer_flushed: usize,
    max_buffer_bytes: usize,
}

impl<W: AsyncWrite + Unpin> BufWriter<W> {
    #[doc(hidden)]
    pub fn new_with_buffer(buffer: Vec<u8>, inner: W, max_buffer_bytes: usize) -> Self {
        Self {
            inner,
            buffer,
            buffer_flushed: 0,
            max_buffer_bytes,
        }
    }

    #[doc(hidden)]
    #[cfg(feature = "unstable")]
    pub fn inner(&mut self) -> &mut W {
        &mut self.inner
    }

    #[doc(hidden)]
    pub fn buffer_mut(&mut self) -> &mut Vec<u8> {
        &mut self.buffer
    }

    #[doc(hidden)]
    pub async fn copy_from<R: AsyncRead>(
        &mut self,
        reader: R,
        loops_per_yield: usize,
    ) -> Result<u64> {
        crate::copy::copy(reader, self, loops_per_yield).await
    }

    fn poll_flush_buf(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
        let Self {
            inner,
            buffer,
            buffer_flushed,
            ..
        } = &mut *self;

        while *buffer_flushed < buffer.len() {
            match ready!(Pin::new(&mut *inner).poll_write(cx, &buffer[*buffer_flushed..])) {
                Ok(0) => {
                    return Poll::Ready(Err(Error::new(
                        ErrorKind::WriteZero,
                        "Failed to write buffered data",
                    )));
                }
                Ok(n) => *buffer_flushed += n,
                Err(ref e) if e.kind() == ErrorKind::Interrupted => {}
                Err(e) => return Poll::Ready(Err(e)),
            }
        }

        buffer.clear();
        *buffer_flushed = 0;
        Poll::Ready(Ok(()))
    }
}

impl<W> fmt::Debug for BufWriter<W> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("BufWriter")
            .field("inner", &format_args!(".."))
            .field("buffer", &String::from_utf8_lossy(&self.buffer))
            .field("buffer_flushed", &self.buffer_flushed)
            .field("max_buffer_bytes", &self.max_buffer_bytes)
            .finish()
    }
}

impl<W: AsyncWrite + Unpin> AsyncWrite for BufWriter<W> {
    fn poll_write(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        additional: &[u8],
    ) -> Poll<Result<usize>> {
        let Self {
            inner,
            buffer,
            buffer_flushed,
            max_buffer_bytes,
        } = &mut *self;

        // Absorb into existing capacity if there's room
        if buffer.len() + additional.len() <= buffer.capacity() {
            buffer.extend_from_slice(additional);
            return Poll::Ready(Ok(additional.len()));
        }

        // Buffer would overflow capacity — flush pending via vectored write
        while *buffer_flushed < buffer.len() {
            let pending = &buffer[*buffer_flushed..];
            let written = ready!(
                Pin::new(&mut *inner)
                    .poll_write_vectored(cx, &[IoSlice::new(pending), IoSlice::new(additional)])
            )?;
            if written == 0 {
                return Poll::Ready(Err(Error::new(
                    ErrorKind::WriteZero,
                    "Failed to write buffered data",
                )));
            }
            let from_pending = written.min(pending.len());
            *buffer_flushed += from_pending;
            if *buffer_flushed >= buffer.len() {
                buffer.clear();
                *buffer_flushed = 0;
            }
            let from_additional = written - from_pending;
            if from_additional > 0 {
                return Poll::Ready(Ok(from_additional));
            }
        }

        // Buffer now empty after flushing — try absorbing again
        if additional.len() <= buffer.capacity() {
            buffer.extend_from_slice(additional);
            return Poll::Ready(Ok(additional.len()));
        }

        // Still too big for capacity — direct write, then absorb remainder only
        // if it fits within max_buffer_bytes. Externally-driven writes get
        // backpressure when the budget is exhausted. (poll_write_vectored is
        // internal-only and has no such cap; see comment there.)
        let written = ready!(Pin::new(&mut *inner).poll_write(cx, additional))?;
        if written == 0 {
            return Poll::Ready(Err(Error::new(ErrorKind::WriteZero, "write returned 0")));
        }
        let remainder = &additional[written..];
        if !remainder.is_empty() && remainder.len() <= *max_buffer_bytes {
            buffer.extend_from_slice(remainder);
            return Poll::Ready(Ok(additional.len()));
        }
        Poll::Ready(Ok(written))
    }

    fn poll_write_vectored(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
        bufs: &[IoSlice<'_>],
    ) -> Poll<Result<usize>> {
        let Self {
            inner,
            buffer,
            buffer_flushed,
            ..
        } = &mut *self;
        let total: usize = bufs.iter().map(|b| b.len()).sum();
        if total == 0 {
            return Poll::Ready(Ok(0));
        }

        // Try to flush pending buffer alongside new slices
        let from_bufs = if *buffer_flushed < buffer.len() {
            let written = {
                let mut all = Vec::with_capacity(bufs.len() + 1);
                all.push(IoSlice::new(&buffer[*buffer_flushed..]));
                all.extend_from_slice(bufs);
                match Pin::new(&mut *inner).poll_write_vectored(cx, &all) {
                    Poll::Ready(Ok(0)) => {
                        return Poll::Ready(Err(Error::new(
                            ErrorKind::WriteZero,
                            "Failed to write buffered data",
                        )));
                    }
                    Poll::Ready(Ok(n)) => n,
                    Poll::Ready(Err(e)) => return Poll::Ready(Err(e)),
                    Poll::Pending => 0,
                }
            };

            let pending_len = buffer.len() - *buffer_flushed;
            let from_pending = written.min(pending_len);
            *buffer_flushed += from_pending;
            if *buffer_flushed >= buffer.len() {
                buffer.clear();
                *buffer_flushed = 0;
            }
            written - from_pending
        } else {
            match Pin::new(&mut *inner).poll_write_vectored(cx, bufs) {
                Poll::Ready(Ok(n)) => n,
                Poll::Ready(Err(e)) => return Poll::Ready(Err(e)),
                Poll::Pending => 0,
            }
        };

        // Absorb any unwritten bufs unconditionally. Unlike poll_write (which
        // honors max_buffer_bytes as a soft absorb budget for externally-driven
        // writes), poll_write_vectored is only reached from internal codec
        // paths with bytes already in memory — rejecting wouldn't save
        // allocation, it would just force the caller to retry with the same bytes.
        let mut skip = from_bufs;
        for buf in bufs {
            if skip >= buf.len() {
                skip -= buf.len();
            } else {
                buffer.extend_from_slice(&buf[skip..]);
                skip = 0;
            }
        }

        Poll::Ready(Ok(total))
    }

    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
        ready!(self.as_mut().poll_flush_buf(cx))?;
        Pin::new(&mut self.inner).poll_flush(cx)
    }

    fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
        ready!(self.as_mut().poll_flush_buf(cx))?;
        Pin::new(&mut self.inner).poll_close(cx)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use futures_lite::AsyncWriteExt;
    use pretty_assertions::assert_eq;
    #[derive(Default)]
    struct TestWrite {
        writes: Vec<Vec<u8>>,
        max_write: Option<usize>,
    }
    impl AsyncWrite for TestWrite {
        fn poll_write(
            mut self: Pin<&mut Self>,
            _cx: &mut Context<'_>,
            buf: &[u8],
        ) -> Poll<Result<usize>> {
            let written = self.max_write.map_or(buf.len(), |mw| mw.min(buf.len()));
            self.writes.push(buf[..written].to_vec());
            Poll::Ready(Ok(written))
        }

        fn poll_write_vectored(
            self: Pin<&mut Self>,
            cx: &mut Context<'_>,
            bufs: &[IoSlice<'_>],
        ) -> Poll<Result<usize>> {
            self.poll_write(cx, &bufs.iter().map(|s| &**s).collect::<Vec<_>>().concat())
        }

        fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>> {
            Poll::Ready(Ok(()))
        }

        fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>> {
            Poll::Ready(Ok(()))
        }
    }

    impl TestWrite {
        fn new(max_write: Option<usize>) -> Self {
            Self {
                max_write,
                ..Self::default()
            }
        }

        fn data(&self) -> Vec<u8> {
            self.writes.concat()
        }
    }

    fn rand_bytes<const LEN: usize>() -> [u8; LEN] {
        std::array::from_fn(|_| fastrand::u8(..))
    }

    #[test]
    fn entire_content_shorter_than_capacity() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<90>();
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            bw.write_all(&data).await.unwrap();
            assert_eq!(bw.inner.writes.len(), 0);
            bw.flush().await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data]);
        });
    }

    #[test]
    fn longer_than_capacity_but_still_a_single_write() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<200>();
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            bw.write_all(&data).await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data]);
            bw.flush().await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data]);
        });
    }

    #[test]
    fn multiple_writes() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<250>();
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            // 200 bytes > capacity, goes direct to inner
            bw.write_all(&data[..200]).await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data[..200]]);
            // 50 bytes fits in capacity, absorbed into buffer
            bw.write_all(&data[200..]).await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data[..200]]);
            // flush sends the buffered 50 bytes
            bw.flush().await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data[..200], &data[200..]]);
        });
    }

    #[test]
    fn overflow_is_vectored() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<101>();
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            bw.write_all(&data[..50]).await.unwrap();
            bw.write_all(&data[50..]).await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data]);
            bw.flush().await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data]);
        });
    }

    #[test]
    fn max_write() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<200>();
            let mut tw = TestWrite::new(Some(50));
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            bw.write_all(&data[..10]).await.unwrap();
            bw.write_all(&data[10..20]).await.unwrap();
            bw.write_all(&data[20..45]).await.unwrap();
            bw.write_all(&data[45..125]).await.unwrap();
            bw.write_all(&data[125..]).await.unwrap();
            // Small writes absorbed into buffer, then vectored flushes align to
            // inner's max_write (50), producing uniform 50-byte writes
            assert_eq!(
                &bw.inner.writes,
                &[&data[0..50], &data[50..100], &data[100..150]]
            );
            bw.flush().await.unwrap();
            assert_eq!(
                &bw.inner.writes,
                &[&data[0..50], &data[50..100], &data[100..150], &data[150..]]
            );
        });
    }

    #[test]
    fn write_boundary_is_exactly_buffer_len() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<200>();
            let mut tw = TestWrite::new(Some(50));
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            bw.write_all(&data[..10]).await.unwrap();
            bw.write_all(&data[10..20]).await.unwrap();
            bw.write_all(&data[20..50]).await.unwrap();
            bw.write_all(&data[50..125]).await.unwrap();
            bw.write_all(&data[125..]).await.unwrap();
            // Same pattern as max_write — buffer absorption smooths out the
            // different input split points into uniform max_write-sized writes
            assert_eq!(
                &bw.inner.writes,
                &[&data[0..50], &data[50..100], &data[100..150]]
            );
            bw.flush().await.unwrap();
            assert_eq!(
                &bw.inner.writes,
                &[&data[0..50], &data[50..100], &data[100..150], &data[150..]]
            );
        });
    }

    #[test]
    fn buffer_is_exactly_full() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<200>();
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            bw.write_all(&data[..100]).await.unwrap();
            bw.write_all(&data[100..]).await.unwrap();
            assert_eq!(&bw.inner.writes, &[&data]);
            bw.flush().await.unwrap();
            assert_eq!(&bw.inner.data(), &data);
        });
    }

    fn test_x<const SIZE: usize>(capacity: usize, max_write: Option<usize>, split: usize) {
        futures_lite::future::block_on(async {
            for _ in 0..100 {
                let data = rand_bytes::<SIZE>();
                let mut tw = TestWrite::new(max_write);
                let mut bw =
                    BufWriter::new_with_buffer(Vec::with_capacity(capacity), &mut tw, capacity);
                bw.write_all(&data[..split]).await.unwrap();
                bw.write_all(&data[split..]).await.unwrap();
                bw.flush().await.unwrap();
                assert_eq!(
                    &bw.inner.data(),
                    &data,
                    "test_x({},{:?},{split})",
                    bw.buffer.capacity(),
                    bw.inner.max_write
                );
            }
        });
    }

    #[test]
    fn known_bad() {
        test_x::<200>(188, Some(47), 123);
    }

    #[test]
    fn random() {
        for _ in 0..100 {
            test_x::<200>(
                fastrand::usize(1..200),
                Some(fastrand::usize(1..200)),
                fastrand::usize(1..200),
            );
        }
    }

    #[test]
    fn buffer_mut_after_body_streaming() {
        futures_lite::future::block_on(async {
            let body = rand_bytes::<500>();
            let trailer = b"trailer-content\r\n";
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(50), &mut tw, 1024);

            // Simulate body streaming
            bw.write_all(&body).await.unwrap();

            // Append trailers via buffer_mut — this was broken before
            bw.buffer_mut().extend_from_slice(trailer);

            // Flush should send trailers
            bw.flush().await.unwrap();

            let mut expected = body.to_vec();
            expected.extend_from_slice(trailer);
            assert_eq!(bw.inner.data(), expected);
        });
    }

    #[test]
    fn backpressure_absorption() {
        futures_lite::future::block_on(async {
            let data = rand_bytes::<200>();
            let mut tw = TestWrite::new(Some(30));
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(10), &mut tw, 200);
            // Write more than inner can accept at once — remainder should be absorbed
            bw.write_all(&data).await.unwrap();
            bw.flush().await.unwrap();
            assert_eq!(bw.inner.data(), data);
        });
    }

    #[test]
    fn write_vectored_basic() {
        futures_lite::future::block_on(async {
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            let a = b"hello ";
            let b = b"world";
            let bufs = [IoSlice::new(a), IoSlice::new(b)];
            let n = AsyncWriteExt::write_vectored(&mut bw, &bufs).await.unwrap();
            assert_eq!(n, 11);
            bw.flush().await.unwrap();
            assert_eq!(bw.inner.data(), b"hello world");
        });
    }

    #[test]
    fn write_vectored_with_pending_buffer() {
        futures_lite::future::block_on(async {
            let mut tw = TestWrite::new(None);
            let mut bw = BufWriter::new_with_buffer(Vec::new(), &mut tw, 100);
            // Put some content in the buffer via buffer_mut
            bw.buffer_mut().extend_from_slice(b"header: value\r\n");

            let a = b"hello ";
            let b = b"world";
            let bufs = [IoSlice::new(a), IoSlice::new(b)];
            let n = AsyncWriteExt::write_vectored(&mut bw, &bufs).await.unwrap();
            assert_eq!(n, 11);
            bw.flush().await.unwrap();
            assert_eq!(bw.inner.data(), b"header: value\r\nhello world");
        });
    }

    #[test]
    fn write_vectored_partial_absorbs_remainder() {
        futures_lite::future::block_on(async {
            // inner can only write 4 bytes at a time
            let mut tw = TestWrite::new(Some(4));
            let mut bw = BufWriter::new_with_buffer(Vec::with_capacity(100), &mut tw, 100);
            let bufs = [
                IoSlice::new(b"aaa"),
                IoSlice::new(b"bbb"),
                IoSlice::new(b"ccc"),
            ];
            let n = AsyncWriteExt::write_vectored(&mut bw, &bufs).await.unwrap();
            // Reports full 9 bytes written despite inner only accepting 4
            assert_eq!(n, 9);
            // Inner got first 4 bytes
            assert_eq!(&bw.inner.writes, &[b"aaab"]);
            // Remaining 5 bytes absorbed into buffer
            bw.flush().await.unwrap();
            assert_eq!(bw.inner.data(), b"aaabbbccc");
        });
    }
}