saluki_io/net/util/retry/
mod.rs

1mod backoff;
2pub use self::backoff::ExponentialBackoff;
3
4mod classifier;
5pub use self::classifier::{HttpRetryPredicate, RetryClassifier, StandardHttpClassifier};
6
7mod lifecycle;
8pub use self::lifecycle::StandardHttpRetryLifecycle;
9
10mod policy;
11pub use self::policy::{NoopRetryPolicy, RollingExponentialBackoffRetryPolicy};
12
13mod queue;
14pub use self::queue::{DiskUsageRetrieverImpl, EventContainer, PushResult, RetryQueue, Retryable};
15
16/// A batteries-included retry policy suitable for HTTP-based clients.
17pub type DefaultHttpRetryPolicy<B = ()> =
18    RollingExponentialBackoffRetryPolicy<StandardHttpClassifier<B>, StandardHttpRetryLifecycle>;
19
20impl<B: 'static> DefaultHttpRetryPolicy<B> {
21    /// Creates a new retry policy adapted to HTTP-based clients with the given exponential backoff strategy.
22    ///
23    /// This policy uses the standard HTTP classifier ([`StandardHttpClassifier`]) and retry lifecycle ([`StandardHttpRetryLifecycle`]).
24    pub fn with_backoff(backoff: ExponentialBackoff) -> Self {
25        Self::with_backoff_and_classifier(backoff, StandardHttpClassifier::new())
26    }
27
28    /// Creates a new retry policy adapted to HTTP-based clients with the given exponential backoff strategy and a
29    /// pre-built [`StandardHttpClassifier`].
30    ///
31    /// This is the same as [`DefaultHttpRetryPolicy::with_backoff`], but allows the caller to supply a classifier that
32    /// has been customized (for example, with additional [`HttpRetryPredicate`]s via
33    /// [`StandardHttpClassifier::with_predicate`]).
34    pub fn with_backoff_and_classifier(backoff: ExponentialBackoff, classifier: StandardHttpClassifier<B>) -> Self {
35        RollingExponentialBackoffRetryPolicy::new(classifier, backoff).with_retry_lifecycle(StandardHttpRetryLifecycle)
36    }
37}
38
39#[cfg(test)]
40mod tests {
41    use std::{sync::Arc, time::Duration};
42
43    use http::{Request, Response, StatusCode};
44    use tower::retry::Policy;
45
46    use super::*;
47
48    type BoxError = Box<dyn std::error::Error + Send + Sync>;
49    type TestRequest = Request<()>;
50
51    fn test_backoff() -> ExponentialBackoff {
52        ExponentialBackoff::with_jitter(Duration::from_millis(1), Duration::from_millis(10), 2.0)
53    }
54
55    fn test_request() -> TestRequest {
56        Request::builder()
57            .method("POST")
58            .uri("http://localhost/intake")
59            .body(())
60            .unwrap()
61    }
62
63    fn ok_response(status: StatusCode) -> Result<Response<()>, BoxError> {
64        Ok(Response::builder().status(status).body(()).unwrap())
65    }
66
67    fn would_retry(policy: &mut DefaultHttpRetryPolicy, status: StatusCode) -> bool {
68        let mut request = test_request();
69        let mut response = ok_response(status);
70        Policy::<TestRequest, Response<()>, BoxError>::retry(policy, &mut request, &mut response).is_some()
71    }
72
73    #[tokio::test]
74    async fn default_http_retry_policy_with_backoff_uses_default_classifier() {
75        let mut policy = DefaultHttpRetryPolicy::with_backoff(test_backoff());
76
77        assert!(!would_retry(&mut policy, StatusCode::OK));
78        assert!(!would_retry(&mut policy, StatusCode::FORBIDDEN));
79        assert!(!would_retry(&mut policy, StatusCode::BAD_REQUEST));
80        assert!(would_retry(&mut policy, StatusCode::INTERNAL_SERVER_ERROR));
81        assert!(would_retry(&mut policy, StatusCode::TOO_MANY_REQUESTS));
82    }
83
84    #[tokio::test]
85    async fn default_http_retry_policy_with_backoff_and_classifier_threads_predicate() {
86        // Build a classifier that flips 403 to retriable, then ensure the constructed policy honors it.
87        let predicate: HttpRetryPredicate = Arc::new(|response| response.status() == StatusCode::FORBIDDEN);
88        let classifier = StandardHttpClassifier::new().with_predicate(predicate);
89        let mut policy = DefaultHttpRetryPolicy::with_backoff_and_classifier(test_backoff(), classifier);
90
91        assert!(would_retry(&mut policy, StatusCode::FORBIDDEN));
92        // Other status codes still follow default classifier behavior.
93        assert!(!would_retry(&mut policy, StatusCode::OK));
94        assert!(!would_retry(&mut policy, StatusCode::UNAUTHORIZED));
95        assert!(would_retry(&mut policy, StatusCode::INTERNAL_SERVER_ERROR));
96    }
97}
saluki_io/net/util/retry/mod.rs

saluki_io/net/util/retry/
mod.rs
