kithara-net 0.0.1-alpha4

Streaming HTTP for audio: retry, timeout, byte ranges.
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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
use std::future::Future;

use async_trait::async_trait;
use bytes::Bytes;
use kithara_platform::{
    CancelToken,
    time::{Duration, sleep},
    tokio,
};
use url::Url;

mod kithara {
    pub(crate) use kithara_test_macros::mock;
}

use crate::{
    ByteStream,
    error::{NetError, Retryability},
    traits::Net,
    types::{Headers, RangeSpec, RetryPolicy},
};

pub struct DefaultRetryPolicy {
    policy: RetryPolicy,
}

impl DefaultRetryPolicy {
    pub fn new(policy: RetryPolicy) -> Self {
        Self { policy }
    }

    pub fn delay_for_attempt(&self, attempt: u32) -> Duration {
        self.policy.delay_for_attempt(attempt)
    }

    pub fn should_retry(&self, error: &NetError, attempt: u32) -> bool {
        if attempt >= self.policy.max_retries {
            return false;
        }

        error.retryability() == Retryability::Transient
    }
}

/// Retry decorator for Net implementations
pub struct RetryNet<N, P> {
    cancel: CancelToken,
    inner: N,
    retry_policy: P,
}

impl<N: Net, P: RetryPolicyTrait> RetryNet<N, P> {
    pub fn new(inner: N, retry_policy: P, cancel: CancelToken) -> Self {
        Self {
            cancel,
            inner,
            retry_policy,
        }
    }

    async fn retry_loop<F, Fut, T>(&self, mut op: F) -> Result<T, NetError>
    where
        F: FnMut() -> Fut,
        Fut: Future<Output = Result<T, NetError>>,
    {
        let max = self.retry_policy.max_attempts();
        for attempt in 0..=max {
            let error = match op().await {
                Ok(value) => return Ok(value),
                Err(error) => error,
            };
            if self.retry_policy.should_retry(&error, attempt) {
                let delay = self.retry_policy.delay_for_attempt(attempt);
                tokio::select! {
                    biased;
                    () = self.cancel.cancelled() => return Err(NetError::Cancelled),
                    () = sleep(delay) => {}
                }
                continue;
            }
            // Not retrying. A transient error after a NON-ZERO budget was
            // spent is promoted to a terminal `RetryExhausted` (Fatal) so
            // downstream (HLS settle, readers) treats it as a give-up, not a
            // transient retry signal. A genuinely fatal error (4xx, decode,
            // cancel) surfaces as-is; so does a transient error under
            // `max_retries == 0`, where the decorator is a deliberate
            // pass-through (no retries were promised, none were exhausted).
            return Err(
                if max > 0 && error.retryability() == Retryability::Transient {
                    NetError::RetryExhausted {
                        max_retries: max,
                        source: Box::new(error),
                    }
                } else {
                    error
                },
            );
        }
        // The `0..=max` loop always returns on its final iteration; this is an
        // unreachable terminal safety net.
        Err(NetError::RetryExhausted {
            max_retries: max,
            source: Box::new(NetError::Unimplemented),
        })
    }
}

#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
impl<N: Net, P: RetryPolicyTrait> Net for RetryNet<N, P> {
    async fn get_bytes(&self, url: Url, headers: Option<Headers>) -> Result<Bytes, NetError> {
        self.retry_loop(|| self.inner.get_bytes(url.clone(), headers.clone()))
            .await
    }

    async fn post_bytes(
        &self,
        url: Url,
        body: Bytes,
        headers: Option<Headers>,
    ) -> Result<Bytes, NetError> {
        self.retry_loop(|| {
            self.inner
                .post_bytes(url.clone(), body.clone(), headers.clone())
        })
        .await
    }

    async fn get_range(
        &self,
        url: Url,
        range: RangeSpec,
        headers: Option<Headers>,
    ) -> Result<ByteStream, NetError> {
        self.retry_loop(|| {
            self.inner
                .get_range(url.clone(), range.clone(), headers.clone())
        })
        .await
    }

    async fn head(&self, url: Url, headers: Option<Headers>) -> Result<Headers, NetError> {
        self.retry_loop(|| self.inner.head(url.clone(), headers.clone()))
            .await
    }

    async fn stream(&self, url: Url, headers: Option<Headers>) -> Result<ByteStream, NetError> {
        self.retry_loop(|| self.inner.stream(url.clone(), headers.clone()))
            .await
    }
}

#[kithara::mock(api = RetryPolicyMock)]
pub trait RetryPolicyTrait: Send + Sync {
    fn delay_for_attempt(&self, attempt: u32) -> Duration;
    fn max_attempts(&self) -> u32;
    fn should_retry(&self, error: &NetError, attempt: u32) -> bool;
}

impl RetryPolicyTrait for DefaultRetryPolicy {
    fn delay_for_attempt(&self, attempt: u32) -> Duration {
        self.delay_for_attempt(attempt)
    }

    fn max_attempts(&self) -> u32 {
        self.policy.max_retries
    }

    fn should_retry(&self, error: &NetError, attempt: u32) -> bool {
        self.should_retry(error, attempt)
    }
}

#[cfg(test)]
#[cfg(not(target_arch = "wasm32"))]
mod tests {
    mod kithara {
        pub(crate) use kithara_test_macros::test;
    }

    use std::{num::NonZeroU16, task::Poll};

    use futures::{pin_mut, poll, stream};
    use unimock::{MockFn, Unimock, matching};

    use super::*;
    use crate::traits::NetMock;

    fn test_url() -> Url {
        Url::parse("http://test.com").expect("BUG: hard-coded test URL is valid")
    }

    fn status_404() -> NetError {
        NetError::Status {
            status: NonZeroU16::new(404).expect("BUG: 404 is non-zero"),
            url: None,
            body: None,
        }
    }

    fn empty_stream() -> ByteStream {
        ByteStream::new(Headers::new(), Box::pin(stream::empty()))
    }

    fn fast_retry_policy(max_retries: u32) -> RetryPolicy {
        RetryPolicy {
            max_retries,
            base_delay: Duration::from_millis(1),
            max_delay: Duration::from_secs(1),
        }
    }

    fn retry_net(mock: Unimock, policy: RetryPolicy) -> RetryNet<Unimock, DefaultRetryPolicy> {
        RetryNet::new(mock, DefaultRetryPolicy::new(policy), CancelToken::never())
    }

    fn retry_net_default(mock: Unimock) -> RetryNet<Unimock, DefaultRetryPolicy> {
        retry_net(mock, RetryPolicy::default())
    }

    #[kithara::test]
    fn test_default_retry_policy_new() {
        let policy = RetryPolicy::default();
        let retry_policy = DefaultRetryPolicy::new(policy);
        assert_eq!(retry_policy.policy.max_retries, 3);
    }

    #[kithara::test]
    #[case(0, true, "first attempt should retry")]
    #[case(1, true, "second attempt should retry")]
    #[case(2, true, "third attempt should retry")]
    #[case(3, false, "fourth attempt should not retry (max=3)")]
    #[case(4, false, "fifth attempt should not retry")]
    fn test_default_retry_policy_should_retry_max_retries(
        #[case] attempt: u32,
        #[case] expected: bool,
        #[case] _desc: &str,
    ) {
        let policy = RetryPolicy::default();
        let retry_policy = DefaultRetryPolicy::new(policy);
        let error = NetError::Timeout;
        assert_eq!(retry_policy.should_retry(&error, attempt), expected);
    }

    #[kithara::test]
    fn test_default_retry_policy_should_not_retry_non_retryable() {
        let policy = RetryPolicy::default();
        let retry_policy = DefaultRetryPolicy::new(policy);
        let error = status_404();
        assert!(!retry_policy.should_retry(&error, 0));
    }

    #[kithara::test]
    #[case(0, Duration::ZERO, "first attempt no delay")]
    #[case(1, Duration::from_millis(100), "second attempt base delay")]
    #[case(2, Duration::from_millis(200), "third attempt 2x delay")]
    #[case(3, Duration::from_millis(400), "fourth attempt 4x delay")]
    fn test_default_retry_policy_delay_for_attempt(
        #[case] attempt: u32,
        #[case] expected: Duration,
        #[case] _desc: &str,
    ) {
        let policy = RetryPolicy {
            base_delay: Duration::from_millis(100),
            max_delay: Duration::from_secs(10),
            max_retries: 5,
        };
        let retry_policy = DefaultRetryPolicy::new(policy);
        assert_eq!(retry_policy.delay_for_attempt(attempt), expected);
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_get_bytes_success_first_try() {
        let mock = Unimock::new(
            NetMock::get_bytes
                .some_call(matching!(_, _))
                .returns(Ok(Bytes::from("success"))),
        );
        let retry_net = retry_net_default(mock);

        let url = test_url();
        let result = retry_net.get_bytes(url, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_get_bytes_retry_then_success() {
        let mock = Unimock::new((
            NetMock::get_bytes
                .next_call(matching!(_, _))
                .returns(Err(NetError::Timeout)),
            NetMock::get_bytes
                .next_call(matching!(_, _))
                .returns(Err(NetError::Timeout)),
            NetMock::get_bytes
                .next_call(matching!(_, _))
                .returns(Ok(Bytes::from("success"))),
        ));
        let retry_net = retry_net(mock, fast_retry_policy(3));

        let url = test_url();
        let result = retry_net.get_bytes(url, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_get_bytes_max_retries_exhausted() {
        let mock = Unimock::new(
            NetMock::get_bytes
                .each_call(matching!(_, _))
                .returns(Err(NetError::Timeout)),
        );
        let retry_net = retry_net(mock, fast_retry_policy(2));

        let url = test_url();
        let result = retry_net.get_bytes(url, None).await;

        assert!(result.is_err());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_get_bytes_non_retryable_error() {
        let mock = Unimock::new(
            NetMock::get_bytes
                .some_call(matching!(_, _))
                .returns(Err(status_404())),
        );
        let retry_net = retry_net_default(mock);

        let url = test_url();
        let result = retry_net.get_bytes(url, None).await;

        assert!(result.is_err());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_post_bytes_success_first_try() {
        let mock = Unimock::new(
            NetMock::post_bytes
                .some_call(matching!(_, _, _))
                .returns(Ok(Bytes::from("created"))),
        );
        let retry_net = retry_net_default(mock);

        let url = test_url();
        let result = retry_net
            .post_bytes(url, Bytes::from("payload"), None)
            .await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_post_bytes_retry_then_success() {
        let mock = Unimock::new((
            NetMock::post_bytes
                .next_call(matching!(_, _, _))
                .returns(Err(NetError::Timeout)),
            NetMock::post_bytes
                .next_call(matching!(_, _, _))
                .returns(Err(NetError::Timeout)),
            NetMock::post_bytes
                .next_call(matching!(_, _, _))
                .returns(Ok(Bytes::from("created"))),
        ));
        let retry_net = retry_net(mock, fast_retry_policy(3));

        let url = test_url();
        let result = retry_net
            .post_bytes(url, Bytes::from("payload"), None)
            .await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_post_bytes_non_retryable_error() {
        let mock = Unimock::new(
            NetMock::post_bytes
                .some_call(matching!(_, _, _))
                .returns(Err(status_404())),
        );
        let retry_net = retry_net_default(mock);

        let url = test_url();
        let result = retry_net
            .post_bytes(url, Bytes::from("payload"), None)
            .await;

        assert!(result.is_err());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_stream_success() {
        let mock = Unimock::new(
            NetMock::stream
                .some_call(matching!(_, _))
                .answers(&|_, _, _| Ok(empty_stream())),
        );
        let retry_net = retry_net_default(mock);

        let url = test_url();
        let result = retry_net.stream(url, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_stream_retry_then_success() {
        let mock = Unimock::new((
            NetMock::stream
                .next_call(matching!(_, _))
                .answers(&|_, _, _| Err(NetError::Timeout)),
            NetMock::stream
                .next_call(matching!(_, _))
                .answers(&|_, _, _| Err(NetError::Timeout)),
            NetMock::stream
                .next_call(matching!(_, _))
                .answers(&|_, _, _| Ok(empty_stream())),
        ));
        let retry_net = retry_net(mock, fast_retry_policy(3));

        let url = test_url();
        let result = retry_net.stream(url, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_get_range_success() {
        let mock = Unimock::new(
            NetMock::get_range
                .some_call(matching!(_, _, _))
                .answers(&|_, _, _, _| Ok(empty_stream())),
        );
        let retry_net = retry_net_default(mock);

        let url = test_url();
        let range = RangeSpec::new(0, None);
        let result = retry_net.get_range(url, range, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_get_range_retry_then_success() {
        let mock = Unimock::new((
            NetMock::get_range
                .next_call(matching!(_, _, _))
                .answers(&|_, _, _, _| Err(NetError::Timeout)),
            NetMock::get_range
                .next_call(matching!(_, _, _))
                .answers(&|_, _, _, _| Err(NetError::Timeout)),
            NetMock::get_range
                .next_call(matching!(_, _, _))
                .answers(&|_, _, _, _| Ok(empty_stream())),
        ));
        let retry_net = retry_net(mock, fast_retry_policy(3));

        let url = test_url();
        let range = RangeSpec::new(0, None);
        let result = retry_net.get_range(url, range, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_head_success() {
        let mock = Unimock::new(
            NetMock::head
                .some_call(matching!(_, _))
                .returns(Ok(Headers::new())),
        );
        let retry_net = retry_net_default(mock);

        let url = test_url();
        let result = retry_net.head(url, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_head_retry_then_success() {
        let mock = Unimock::new((
            NetMock::head
                .next_call(matching!(_, _))
                .returns(Err(NetError::Timeout)),
            NetMock::head
                .next_call(matching!(_, _))
                .returns(Err(NetError::Timeout)),
            NetMock::head
                .next_call(matching!(_, _))
                .returns(Ok(Headers::new())),
        ));
        let retry_net = retry_net(mock, fast_retry_policy(3));

        let url = test_url();
        let result = retry_net.head(url, None).await;

        assert!(result.is_ok());
    }

    #[kithara::test]
    fn test_retry_policy_trait_max_attempts() {
        let policy = RetryPolicy {
            base_delay: Duration::from_millis(100),
            max_delay: Duration::from_secs(10),
            max_retries: 5,
        };
        let retry_policy = DefaultRetryPolicy::new(policy);
        assert_eq!(retry_policy.max_attempts(), 5);
    }

    #[kithara::test]
    fn test_retry_policy_trait_delay() {
        let policy = RetryPolicy {
            base_delay: Duration::from_millis(50),
            max_delay: Duration::from_secs(10),
            max_retries: 3,
        };
        let retry_policy = DefaultRetryPolicy::new(policy);
        assert_eq!(retry_policy.delay_for_attempt(0), Duration::ZERO);
        assert_eq!(retry_policy.delay_for_attempt(1), Duration::from_millis(50));
    }

    #[kithara::test(tokio)]
    async fn test_retry_net_cancel_interrupts_sleep() {
        let mock = Unimock::new(
            NetMock::get_bytes
                .each_call(matching!(_, _))
                .returns(Err(NetError::Timeout)),
        );
        let policy = RetryPolicy {
            base_delay: Duration::from_secs(10),
            max_delay: Duration::from_secs(10),
            max_retries: 3,
        };
        let cancel = CancelToken::never();
        let retry_net = RetryNet::new(mock, DefaultRetryPolicy::new(policy), cancel.clone());

        let url = test_url();
        let result = retry_net.get_bytes(url, None);
        pin_mut!(result);

        assert!(
            matches!(poll!(result.as_mut()), Poll::Pending),
            "retry must park in the retry-delay branch before cancellation"
        );
        cancel.cancel();

        let result = result.await;

        assert!(matches!(result, Err(NetError::Cancelled)));
    }
}