vakya 0.1.0-alpha.1

Completion-native HTTP building blocks for the Karmaio runtime
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
use crate::future::WorkBudget;
use karmaio::{
    buf::{BufResult, IoBuf, IoBufExt, IoVectoredBuf},
    io::AsyncWrite,
    runtime::{CancellationToken, FutureExt, operation_canceled},
};
use std::io;

/// Writes an owned scalar buffer completely and returns it on completion.
/// Cancellation requests remain attached until the operation returns its buffer.
/// Dropping this future cannot promise a return to the producer or its recycler.
pub(crate) async fn write_all<W, B>(
    writer: &mut W,
    buffer: B,
    cancellation: Option<CancellationToken>,
) -> BufResult<usize, B>
where
    W: AsyncWrite,
    B: IoBuf,
{
    let future = write_scalar(writer, buffer, cancellation);
    match cancellation {
        Some(token) => future.with_cancellation(token).await,
        None => future.await,
    }
}

/// Writes an owned vectored collection and returns every component on completion.
/// The cursor borrows no payload storage and never flattens the collection.
pub(crate) async fn write_vectored_all<W, V>(
    writer: &mut W,
    buffers: V,
    cancellation: Option<CancellationToken>,
) -> BufResult<usize, V>
where
    W: AsyncWrite,
    V: IoVectoredBuf,
{
    let future = write_vectors(writer, buffers, cancellation);
    match cancellation {
        Some(token) => future.with_cancellation(token).await,
        None => future.await,
    }
}

// Adapted from Karmaio's owned write-all loops: keep its slice types, add a
// cooperative budget and pre-submission cancellation checks, and use the same
// zero/over-report validation for both scalar and vectored writes.
async fn write_scalar<W: AsyncWrite, B: IoBuf>(
    writer: &mut W,
    mut buffer: B,
    cancellation: Option<CancellationToken>,
) -> BufResult<usize, B> {
    let length = buffer.as_init().len();
    let mut written = 0;
    let mut budget = WorkBudget::new();
    while written < length {
        budget.step().await;
        if cancellation.is_some_and(|token| token.is_cancel_requested()) {
            return BufResult(Err(operation_canceled()), buffer);
        }
        let view = buffer.slice(written..length);
        let (result, view) = writer.write(view).await.into_parts();
        buffer = view.into_inner();
        match checked_progress(result, length - written) {
            Ok(count) => {
                crate::trace::progress("write", count);
                written += count;
            }
            Err(error) => return BufResult(Err(error), buffer),
        }
    }
    BufResult(Ok(written), buffer)
}

async fn write_vectors<W: AsyncWrite, V: IoVectoredBuf>(
    writer: &mut W,
    mut buffers: V,
    cancellation: Option<CancellationToken>,
) -> BufResult<usize, V> {
    let length = buffers
        .iter_slice()
        .try_fold(0usize, |total, part| total.checked_add(part.len()));
    let Some(length) = length else {
        return BufResult(
            Err(io::Error::new(io::ErrorKind::InvalidInput, "buffer length overflow")),
            buffers,
        );
    };
    let mut written = 0;
    let mut budget = WorkBudget::new();
    while written < length {
        budget.step().await;
        if cancellation.is_some_and(|token| token.is_cancel_requested()) {
            return BufResult(Err(operation_canceled()), buffers);
        }
        let view = IoVectoredBuf::slice(buffers, written);
        let (result, view) = writer.write_vectored(view).await.into_parts();
        buffers = view.into_inner();
        match checked_progress(result, length - written) {
            Ok(count) => {
                crate::trace::progress("write_vectored", count);
                written += count;
            }
            Err(error) => return BufResult(Err(error), buffers),
        }
    }
    BufResult(Ok(written), buffers)
}

fn checked_progress(result: io::Result<usize>, remaining: usize) -> io::Result<usize> {
    match result {
        Ok(0) => Err(io::ErrorKind::WriteZero.into()),
        Ok(count) if count > remaining => Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "writer over-reported completion",
        )),
        // Return zero progress to the budgeted loop for a retry. Explicit
        // Karmaio cancellation is a distinct error, never Interrupted.
        Err(error) if error.kind() == io::ErrorKind::Interrupted => Ok(0),
        result => result,
    }
}

/// Writes optional protocol framing around one owned payload buffer.
///
/// Karmaio's owned vectored slice retains component offsets across
/// partial completions. The returned result strips the bounded framing buffers
/// and restores the original payload for body recycling.
pub(crate) async fn write_framed<W, P, D, S>(
    writer: &mut W,
    prefix: P,
    data: D,
    suffix: S,
    cancellation: Option<CancellationToken>,
) -> BufResult<usize, D>
where
    W: AsyncWrite,
    P: IoBuf,
    D: IoBuf,
    S: IoBuf,
{
    let buffers = (prefix, (data, (suffix,)));
    let (result, (_, (data, (_,)))) = write_vectored_all(writer, buffers, cancellation).await.into_parts();
    BufResult(result, data)
}

#[cfg(test)]
mod tests {
    use super::{write_all, write_framed, write_vectored_all};
    use bytes::Bytes;
    use karmaio::{
        buf::IoBuf,
        runtime::{is_operation_canceled, operation_canceled},
    };
    use std::{cell::Cell, io, rc::Rc};

    use crate::test_transport::{Gate, WriteStep, Writer};
    use karmaio::runtime::CancellationSource;
    use std::{
        future::Future,
        pin::pin,
        task::{Context, Poll, Waker},
    };

    struct TrackedData {
        bytes: &'static [u8],
        drops: Rc<Cell<usize>>,
    }

    impl IoBuf for TrackedData {
        fn as_init(&self) -> &[u8] {
            self.bytes
        }
    }

    impl Drop for TrackedData {
        fn drop(&mut self) {
            self.drops.set(self.drops.get() + 1);
        }
    }

    #[test]
    fn scalar_write_completes_through_every_partial_width() {
        karmaio::Runtime::new().unwrap().block_on(async {
            for width in 1..=6 {
                let mut writer = Writer::limited(width);
                let buffer = Bytes::from_static(b"abcdef");
                let (result, returned) = write_all(&mut writer, buffer, None).await.into_parts();

                assert_eq!(result.unwrap(), 6);
                assert_eq!(returned, b"abcdef"[..]);
                assert_eq!(writer.output, b"abcdef");
            }
        });
    }

    #[test]
    fn vectored_cursor_crosses_every_component_boundary() {
        karmaio::Runtime::new().unwrap().block_on(async {
            for width in 1..=9 {
                let mut writer = Writer::limited(width);
                let buffers = (
                    Bytes::from_static(b"abc"),
                    (
                        Bytes::new(),
                        (Bytes::from_static(b"de"), (Bytes::from_static(b"fghi"),)),
                    ),
                );
                let (result, returned) = write_vectored_all(&mut writer, buffers, None).await.into_parts();

                assert_eq!(result.unwrap(), 9);
                assert_eq!(returned.0, b"abc"[..]);
                assert_eq!(returned.1.1.0, b"de"[..]);
                assert_eq!(returned.1.1.1.0, b"fghi"[..]);
                assert_eq!(writer.output, b"abcdefghi");
            }
        });
    }

    #[test]
    fn framed_write_supports_chunk_and_zero_length_framing() {
        karmaio::Runtime::new().unwrap().block_on(async {
            let mut chunked = Writer::limited(1);
            let (result, data) = write_framed(
                &mut chunked,
                Bytes::from_static(b"4\r\n"),
                Bytes::from_static(b"body"),
                Bytes::from_static(b"\r\n"),
                None,
            )
            .await
            .into_parts();
            assert_eq!(result.unwrap(), 9);
            assert_eq!(data, b"body"[..]);
            assert_eq!(chunked.output, b"4\r\nbody\r\n");

            let mut fixed = Writer::limited(2);
            let (result, data) = write_framed(
                &mut fixed,
                Bytes::new(),
                Bytes::from_static(b"body"),
                Bytes::new(),
                None,
            )
            .await
            .into_parts();
            assert_eq!(result.unwrap(), 4);
            assert_eq!(data, b"body"[..]);
            assert_eq!(fixed.output, b"body");
        });
    }

    #[test]
    fn io_failure_after_progress_returns_payload_once() {
        karmaio::Runtime::new().unwrap().block_on(async {
            let drops = Rc::new(Cell::new(0));
            let data = TrackedData {
                bytes: b"payload",
                drops: Rc::clone(&drops),
            };
            let mut writer = Writer::new([
                WriteStep::Limit(2),
                WriteStep::Limit(2),
                WriteStep::Error(io::Error::other("failed")),
            ]);

            let (result, data) = write_framed(
                &mut writer,
                Bytes::from_static(b"prefix"),
                data,
                Bytes::from_static(b"suffix"),
                None,
            )
            .await
            .into_parts();

            assert_eq!(result.unwrap_err().kind(), io::ErrorKind::Other);
            assert_eq!(drops.get(), 0);
            drop(data);
            assert_eq!(drops.get(), 1);
        });
    }

    #[test]
    fn confirmed_cancellation_returns_payload_once() {
        karmaio::Runtime::new().unwrap().block_on(async {
            for canceled_on_call in [1, 2] {
                let drops = Rc::new(Cell::new(0));
                let data = TrackedData {
                    bytes: b"payload",
                    drops: Rc::clone(&drops),
                };
                let mut steps: Vec<_> = (1..canceled_on_call).map(|_| WriteStep::Limit(3)).collect();
                steps.push(WriteStep::Error(operation_canceled()));
                let mut writer = Writer::new(steps);

                let (result, data) = write_framed(
                    &mut writer,
                    Bytes::from_static(b"prefix"),
                    data,
                    Bytes::from_static(b"suffix"),
                    None,
                )
                .await
                .into_parts();

                assert!(is_operation_canceled(result.as_ref().unwrap_err()));
                assert_eq!(drops.get(), 0);
                drop(data);
                assert_eq!(drops.get(), 1);
            }
        });
    }

    #[test]
    fn control_buffers_cover_heads_final_chunks_and_trailers() {
        karmaio::Runtime::new().unwrap().block_on(async {
            let mut writer = Writer::limited(2);
            for control in [
                Bytes::from_static(b"HTTP/1.1 200 OK\r\n\r\n"),
                Bytes::from_static(b"0\r\n\r\n"),
                Bytes::from_static(b"0\r\nX-End: yes\r\n\r\n"),
            ] {
                let (result, _) = write_all(&mut writer, control, None).await.into_parts();
                result.unwrap();
            }
            assert_eq!(
                writer.output,
                b"HTTP/1.1 200 OK\r\n\r\n0\r\n\r\n0\r\nX-End: yes\r\n\r\n"
            );
        });
    }
    #[test]
    fn zero_and_invalid_completions_preserve_scalar_and_vectored_buffers() {
        karmaio::Runtime::new().unwrap().block_on(async {
            for (count, kind) in [(0, io::ErrorKind::WriteZero), (100, io::ErrorKind::InvalidData)] {
                let bytes = Bytes::from_static(b"body");
                let pointer = bytes.as_ptr();
                let mut writer = Writer::new([WriteStep::Report(count)]);
                let (result, returned) = write_all(&mut writer, bytes, None).await.into_parts();
                assert_eq!(result.unwrap_err().kind(), kind);
                assert_eq!(returned.as_ptr(), pointer);
                let mut writer = Writer::new([WriteStep::Report(count)]);
                let (result, (returned,)) = write_vectored_all(&mut writer, (returned,), None).await.into_parts();
                assert_eq!(result.unwrap_err().kind(), kind);
                assert_eq!(returned.as_ptr(), pointer);
            }
        });
    }

    #[test]
    fn partial_writes_use_original_payload_addresses_and_retry_interrupted() {
        karmaio::Runtime::new().unwrap().block_on(async {
            let bytes = Bytes::from_static(b"body");
            let pointer = bytes.as_ptr() as usize;
            let steps = || {
                [
                    WriteStep::Limit(2),
                    WriteStep::Error(io::ErrorKind::Interrupted.into()),
                    WriteStep::Limit(2),
                ]
            };
            let mut writer = Writer::new(steps());
            let (result, bytes) = write_all(&mut writer, bytes, None).await.into_parts();
            assert_eq!(result.unwrap(), 4);
            assert_eq!(writer.output, b"body");
            assert_eq!(writer.pointers, [pointer, pointer + 2]);
            let mut writer = Writer::new(steps());
            let (result, (bytes,)) = write_vectored_all(&mut writer, (bytes,), None).await.into_parts();
            assert_eq!(result.unwrap(), 4);
            assert_eq!(writer.output, b"body");
            assert_eq!(writer.pointers, [pointer, pointer + 2]);
            assert_eq!(bytes.as_ptr() as usize, pointer);
        });
    }

    #[test]
    fn ready_writes_yield_and_observe_cancel_before_another_submission() {
        karmaio::Runtime::new().unwrap().block_on(async {
            for vectored in [false, true] {
                let source = CancellationSource::new();
                let mut writer = Writer::limited(1);
                let bytes = Bytes::from(vec![0; 100]);
                {
                    let mut future = pin!(async {
                        if vectored {
                            write_framed(&mut writer, Bytes::new(), bytes, Bytes::new(), Some(source.token())).await
                        } else {
                            write_all(&mut writer, bytes, Some(source.token())).await
                        }
                    });
                    let mut cx = Context::from_waker(Waker::noop());
                    assert!(future.as_mut().poll(&mut cx).is_pending());
                    source.cancel();
                    let Poll::Ready(result) = future.as_mut().poll(&mut cx) else {
                        panic!("canceled retry did not complete")
                    };
                    assert!(is_operation_canceled(result.0.as_ref().unwrap_err()));
                    assert_eq!(result.1.len(), 100);
                }
                assert_eq!(writer.submissions, 16);
                assert_eq!(writer.output.len(), 16);
            }
        });
    }

    #[test]
    fn pending_cancel_and_success_races_return_payload_only_after_completion() {
        karmaio::Runtime::new().unwrap().block_on(async {
            for success in [false, true] {
                let source = CancellationSource::new();
                let observed = Gate::default();
                let complete = Gate::default();
                let drops = Rc::new(Cell::new(0));
                let data = TrackedData {
                    bytes: b"body",
                    drops: drops.clone(),
                };
                let mut writer = Writer::new([
                    WriteStep::AfterCancel {
                        token: source.token(),
                        observed: observed.clone(),
                        complete: complete.clone(),
                    },
                    if success {
                        WriteStep::Limit(4)
                    } else {
                        WriteStep::Error(operation_canceled())
                    },
                ]);
                let mut future = pin!(write_framed(
                    &mut writer,
                    Bytes::new(),
                    data,
                    Bytes::new(),
                    Some(source.token())
                ));
                let mut cx = Context::from_waker(Waker::noop());
                assert!(future.as_mut().poll(&mut cx).is_pending());
                source.cancel();
                assert!(future.as_mut().poll(&mut cx).is_pending());
                assert!(observed.is_open());
                assert_eq!(drops.get(), 0);
                complete.open();
                let Poll::Ready(result) = future.as_mut().poll(&mut cx) else {
                    panic!("completion not observed")
                };
                assert_eq!(drops.get(), 0);
                if success {
                    assert_eq!(result.0.unwrap(), 4);
                } else {
                    assert!(is_operation_canceled(result.0.as_ref().unwrap_err()));
                }
                drop(result.1);
                assert_eq!(drops.get(), 1);
            }
        });
    }
}