reqx 0.1.35

Rust HTTP transport client for API SDK libraries with retry, timeout, idempotency, proxy, and pluggable TLS backends
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
use std::collections::{BTreeMap, BTreeSet};
use std::sync::Arc;
use std::time::Duration;

use http::{HeaderMap, Method, StatusCode};
use rand::RngExt;

use crate::IDEMPOTENCY_KEY_HEADER;
use crate::error::{TimeoutPhase, TransportErrorKind};

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
/// Reason a retry was considered.
pub enum RetryReason {
    /// A retryable HTTP status was returned.
    Status(StatusCode),
    /// A retryable transport error occurred.
    Transport(TransportErrorKind),
    /// A retryable timeout occurred.
    Timeout(TimeoutPhase),
    /// Reading the response body failed after headers were received.
    ResponseBodyRead,
}

#[derive(Clone, Debug)]
/// Immutable context describing a retry decision.
pub struct RetryDecision {
    attempt: usize,
    max_attempts: usize,
    method: Method,
    uri: String,
    reason: RetryReason,
}

impl RetryDecision {
    pub(crate) fn new(
        attempt: usize,
        max_attempts: usize,
        method: Method,
        uri: String,
        reason: RetryReason,
    ) -> Self {
        Self {
            attempt,
            max_attempts,
            method,
            uri,
            reason,
        }
    }

    /// Returns the current attempt number, starting at `1`.
    pub fn attempt(&self) -> usize {
        self.attempt
    }

    /// Returns the maximum number of attempts allowed.
    pub fn max_attempts(&self) -> usize {
        self.max_attempts
    }

    /// Returns the request method.
    pub fn method(&self) -> &Method {
        &self.method
    }

    /// Returns the request URI with the crate's redaction rules applied.
    pub fn uri(&self) -> &str {
        &self.uri
    }

    /// Returns the reason this retry was considered.
    pub fn reason(&self) -> RetryReason {
        self.reason
    }

    /// Returns the retryable status, if the decision was triggered by status.
    pub fn status(&self) -> Option<StatusCode> {
        match self.reason {
            RetryReason::Status(status) => Some(status),
            _ => None,
        }
    }

    /// Returns the transport error kind, if the decision was transport-triggered.
    pub fn transport_error_kind(&self) -> Option<TransportErrorKind> {
        match self.reason {
            RetryReason::Transport(kind) => Some(kind),
            _ => None,
        }
    }

    /// Returns the timeout phase, if the decision was timeout-triggered.
    pub fn timeout_phase(&self) -> Option<TimeoutPhase> {
        match self.reason {
            RetryReason::Timeout(phase) => Some(phase),
            _ => None,
        }
    }

    /// Returns whether the retry was considered because body streaming failed.
    pub fn is_response_body_read_error(&self) -> bool {
        matches!(self.reason, RetryReason::ResponseBodyRead)
    }
}

/// Custom classifier that can override built-in retry decisions.
pub trait RetryClassifier: Send + Sync {
    /// Returns whether the request should be retried.
    fn should_retry(&self, decision: &RetryDecision) -> bool;
}

/// Predicate that decides whether a request is eligible for retries at all.
pub trait RetryEligibility: Send + Sync {
    /// Returns whether a request with `method` and `headers` may be retried.
    fn supports_retry(&self, method: &Method, headers: &HeaderMap) -> bool;
}

#[derive(Default)]
/// Retry eligibility that only allows idempotent methods or explicit idempotency keys.
pub struct StrictRetryEligibility;

impl RetryEligibility for StrictRetryEligibility {
    fn supports_retry(&self, method: &Method, headers: &HeaderMap) -> bool {
        request_supports_retry(method, headers)
    }
}

#[derive(Default)]
/// Retry eligibility that treats every request as retryable.
pub struct PermissiveRetryEligibility;

impl RetryEligibility for PermissiveRetryEligibility {
    fn supports_retry(&self, _method: &Method, _headers: &HeaderMap) -> bool {
        true
    }
}

#[derive(Clone)]
/// Retry policy covering attempts, backoff, and retryable failure classes.
///
/// See also:
///
/// - `examples/resilience_controls.rs`
/// - `examples/retry_classifier.rs`
///
/// # Example
///
/// ```
/// use std::time::Duration;
///
/// use reqx::prelude::RetryPolicy;
/// use reqx::TransportErrorKind;
///
/// let policy = RetryPolicy::standard()
///     .max_attempts(4)
///     .base_backoff(Duration::from_millis(100))
///     .max_backoff(Duration::from_secs(1))
///     .transport_retry_window(TransportErrorKind::Connect, 2);
///
/// let _ = policy;
/// ```
pub struct RetryPolicy {
    max_attempts: usize,
    base_backoff: Duration,
    max_backoff: Duration,
    jitter_ratio: f64,
    retryable_status_codes: BTreeSet<u16>,
    retryable_transport_error_kinds: BTreeSet<TransportErrorKind>,
    retryable_timeout_phases: BTreeSet<TimeoutPhase>,
    retry_on_response_body_read_error: bool,
    status_retry_windows: BTreeMap<u16, usize>,
    transport_retry_windows: BTreeMap<TransportErrorKind, usize>,
    timeout_retry_windows: BTreeMap<TimeoutPhase, usize>,
    response_body_read_retry_window: Option<usize>,
    retry_classifier: Option<Arc<dyn RetryClassifier>>,
}

impl std::fmt::Debug for RetryPolicy {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("RetryPolicy")
            .field("max_attempts", &self.max_attempts)
            .field("base_backoff", &self.base_backoff)
            .field("max_backoff", &self.max_backoff)
            .field("jitter_ratio", &self.jitter_ratio)
            .field("retryable_status_codes", &self.retryable_status_codes)
            .field(
                "retryable_transport_error_kinds",
                &self.retryable_transport_error_kinds,
            )
            .field("retryable_timeout_phases", &self.retryable_timeout_phases)
            .field(
                "retry_on_response_body_read_error",
                &self.retry_on_response_body_read_error,
            )
            .field("status_retry_windows", &self.status_retry_windows)
            .field("transport_retry_windows", &self.transport_retry_windows)
            .field("timeout_retry_windows", &self.timeout_retry_windows)
            .field(
                "response_body_read_retry_window",
                &self.response_body_read_retry_window,
            )
            .finish()
    }
}

impl RetryPolicy {
    /// Returns a policy that disables retries.
    pub fn disabled() -> Self {
        Self {
            max_attempts: 1,
            base_backoff: Duration::from_millis(200),
            max_backoff: Duration::from_secs(2),
            jitter_ratio: 0.0,
            retryable_status_codes: default_retryable_status_codes(),
            retryable_transport_error_kinds: default_retryable_transport_error_kinds(),
            retryable_timeout_phases: default_retryable_timeout_phases(),
            retry_on_response_body_read_error: true,
            status_retry_windows: BTreeMap::new(),
            transport_retry_windows: BTreeMap::new(),
            timeout_retry_windows: BTreeMap::new(),
            response_body_read_retry_window: None,
            retry_classifier: None,
        }
    }

    /// Returns the default SDK retry policy.
    pub fn standard() -> Self {
        Self {
            max_attempts: 3,
            base_backoff: Duration::from_millis(200),
            max_backoff: Duration::from_secs(2),
            jitter_ratio: 0.2,
            retryable_status_codes: default_retryable_status_codes(),
            retryable_transport_error_kinds: default_retryable_transport_error_kinds(),
            retryable_timeout_phases: default_retryable_timeout_phases(),
            retry_on_response_body_read_error: true,
            status_retry_windows: BTreeMap::new(),
            transport_retry_windows: BTreeMap::new(),
            timeout_retry_windows: BTreeMap::new(),
            response_body_read_retry_window: None,
            retry_classifier: None,
        }
    }

    /// Sets the maximum number of attempts, including the first try.
    pub fn max_attempts(mut self, max_attempts: usize) -> Self {
        self.max_attempts = max_attempts.max(1);
        self
    }

    /// Sets the base exponential backoff delay.
    pub fn base_backoff(mut self, base_backoff: Duration) -> Self {
        self.base_backoff = base_backoff.max(Duration::from_millis(1));
        if self.max_backoff < self.base_backoff {
            self.max_backoff = self.base_backoff;
        }
        self
    }

    /// Sets the maximum backoff delay.
    pub fn max_backoff(mut self, max_backoff: Duration) -> Self {
        self.max_backoff = max_backoff.max(self.base_backoff);
        self
    }

    /// Sets the random jitter ratio applied to computed backoffs.
    pub fn jitter_ratio(mut self, jitter_ratio: f64) -> Self {
        self.jitter_ratio = jitter_ratio.clamp(0.0, 1.0);
        self
    }

    /// Replaces the set of retryable HTTP status codes.
    pub fn retryable_status_codes(mut self, codes: impl IntoIterator<Item = u16>) -> Self {
        self.retryable_status_codes = codes.into_iter().collect();
        self
    }

    /// Replaces the set of retryable transport error kinds.
    pub fn retryable_transport_error_kinds(
        mut self,
        kinds: impl IntoIterator<Item = TransportErrorKind>,
    ) -> Self {
        self.retryable_transport_error_kinds = kinds.into_iter().collect();
        self
    }

    /// Replaces the set of retryable timeout phases.
    pub fn retryable_timeout_phases(
        mut self,
        phases: impl IntoIterator<Item = TimeoutPhase>,
    ) -> Self {
        self.retryable_timeout_phases = phases.into_iter().collect();
        self
    }

    /// Enables or disables retries after response body read failures.
    pub fn retry_on_response_body_read_error(mut self, retry: bool) -> Self {
        self.retry_on_response_body_read_error = retry;
        self
    }

    /// Sets a per-status retry window measured in maximum attempts.
    pub fn status_retry_window(mut self, status: u16, max_attempts: usize) -> Self {
        self.status_retry_windows
            .insert(status, max_attempts.max(1));
        self
    }

    /// Sets a per-transport-kind retry window measured in maximum attempts.
    pub fn transport_retry_window(mut self, kind: TransportErrorKind, max_attempts: usize) -> Self {
        self.transport_retry_windows
            .insert(kind, max_attempts.max(1));
        self
    }

    /// Sets a per-timeout-phase retry window measured in maximum attempts.
    pub fn timeout_retry_window(mut self, phase: TimeoutPhase, max_attempts: usize) -> Self {
        self.timeout_retry_windows
            .insert(phase, max_attempts.max(1));
        self
    }

    /// Sets the retry window for response body read failures.
    pub fn response_body_read_retry_window(mut self, max_attempts: usize) -> Self {
        self.response_body_read_retry_window = Some(max_attempts.max(1));
        self
    }

    /// Sets a custom classifier that can override the built-in retry rules.
    pub fn retry_classifier(mut self, retry_classifier: Arc<dyn RetryClassifier>) -> Self {
        self.retry_classifier = Some(retry_classifier);
        self
    }

    pub(crate) fn configured_max_attempts(&self) -> usize {
        self.max_attempts
    }

    pub(crate) fn configured_max_backoff(&self) -> Duration {
        self.max_backoff
    }

    fn should_retry_status(&self, status: StatusCode) -> bool {
        self.retryable_status_codes.contains(&status.as_u16())
    }

    pub(crate) fn is_retryable_status(&self, status: StatusCode) -> bool {
        self.should_retry_status(status)
    }

    fn is_within_retry_window(limit: Option<usize>, attempt: usize) -> bool {
        match limit {
            Some(limit) => attempt < limit.max(1),
            None => true,
        }
    }

    pub(crate) fn should_retry_decision(&self, decision: &RetryDecision) -> bool {
        if let Some(retry_classifier) = &self.retry_classifier {
            return retry_classifier.should_retry(decision);
        }
        match decision.reason() {
            RetryReason::Status(status) => {
                let window = self.status_retry_windows.get(&status.as_u16()).copied();
                self.should_retry_status(status)
                    && Self::is_within_retry_window(window, decision.attempt())
            }
            RetryReason::Transport(kind) => {
                let window = self.transport_retry_windows.get(&kind).copied();
                self.retryable_transport_error_kinds.contains(&kind)
                    && Self::is_within_retry_window(window, decision.attempt())
            }
            RetryReason::Timeout(phase) => {
                let window = self.timeout_retry_windows.get(&phase).copied();
                self.retryable_timeout_phases.contains(&phase)
                    && Self::is_within_retry_window(window, decision.attempt())
            }
            RetryReason::ResponseBodyRead => {
                self.retry_on_response_body_read_error
                    && Self::is_within_retry_window(
                        self.response_body_read_retry_window,
                        decision.attempt(),
                    )
            }
        }
    }

    pub(crate) fn backoff_for_retry(&self, retry_index: usize) -> Duration {
        let capped_exponent = retry_index.saturating_sub(1).min(31) as u32;
        let multiplier = 1_u128 << capped_exponent;
        let base_ms = self.base_backoff.as_millis().max(1);
        let max_ms = self.max_backoff.as_millis().max(base_ms);
        let delay_ms = base_ms
            .saturating_mul(multiplier)
            .min(max_ms)
            .min(u64::MAX as u128) as u64;
        self.apply_jitter(Duration::from_millis(delay_ms))
    }

    fn apply_jitter(&self, backoff: Duration) -> Duration {
        if self.jitter_ratio <= f64::EPSILON {
            return backoff;
        }

        let backoff_ms = backoff.as_millis().min(u64::MAX as u128) as u64;
        if backoff_ms <= 1 {
            return backoff;
        }
        let max_backoff_ms = self.max_backoff.as_millis().min(u64::MAX as u128) as u64;

        let jitter_span = ((backoff_ms as f64) * self.jitter_ratio).round().max(1.0) as u64;
        let low = backoff_ms.saturating_sub(jitter_span);
        let high = backoff_ms.saturating_add(jitter_span).max(low);
        let mut rng = rand::rng();
        let sampled_ms = rng.random_range(low..=high).min(max_backoff_ms.max(1));
        Duration::from_millis(sampled_ms)
    }
}

impl Default for RetryPolicy {
    fn default() -> Self {
        Self::standard()
    }
}

fn default_retryable_status_codes() -> BTreeSet<u16> {
    [429_u16, 500, 502, 503, 504].into_iter().collect()
}

fn default_retryable_transport_error_kinds() -> BTreeSet<TransportErrorKind> {
    [
        TransportErrorKind::Dns,
        TransportErrorKind::Connect,
        TransportErrorKind::Read,
    ]
    .into_iter()
    .collect()
}

fn default_retryable_timeout_phases() -> BTreeSet<TimeoutPhase> {
    [TimeoutPhase::Transport, TimeoutPhase::ResponseBody]
        .into_iter()
        .collect()
}

pub(crate) fn request_supports_retry(method: &Method, headers: &HeaderMap) -> bool {
    is_method_idempotent(method) || headers.get(IDEMPOTENCY_KEY_HEADER).is_some()
}

fn is_method_idempotent(method: &Method) -> bool {
    matches!(
        *method,
        Method::GET | Method::HEAD | Method::PUT | Method::DELETE | Method::OPTIONS | Method::TRACE
    )
}

#[cfg(test)]
mod tests {
    use super::{RetryDecision, RetryPolicy, RetryReason};
    use http::{Method, StatusCode};

    #[test]
    fn jittered_backoff_never_exceeds_configured_max_backoff() {
        let policy = RetryPolicy::standard()
            .base_backoff(std::time::Duration::from_millis(100))
            .max_backoff(std::time::Duration::from_millis(120))
            .jitter_ratio(1.0);

        for _ in 0..256 {
            let backoff = policy.backoff_for_retry(3);
            assert!(backoff <= std::time::Duration::from_millis(120));
        }
    }

    #[test]
    fn retry_decision_accessors_reflect_reason() {
        let decision = RetryDecision::new(
            1,
            3,
            Method::GET,
            "https://api.example.com/v1/items".to_owned(),
            RetryReason::Status(StatusCode::TOO_MANY_REQUESTS),
        );

        assert_eq!(decision.attempt(), 1);
        assert_eq!(decision.max_attempts(), 3);
        assert_eq!(decision.method(), &Method::GET);
        assert_eq!(decision.uri(), "https://api.example.com/v1/items");
        assert_eq!(decision.status(), Some(StatusCode::TOO_MANY_REQUESTS));
        assert_eq!(decision.transport_error_kind(), None);
        assert_eq!(decision.timeout_phase(), None);
        assert!(!decision.is_response_body_read_error());
    }
}