resilient 0.1.0

A Rust resilience library providing retry, circuit breaker, timeout, bulkhead, and rate limiting policies
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
use std::{future::Future, sync::Arc, time::Duration};

use futures_util::future::BoxFuture;

use crate::policy::Policy;
use crate::timeout::TimeoutError;

// ---------------------------------------------------------------------------
// Internal helpers
// ---------------------------------------------------------------------------

/// Shared, boxed, async callback used by lifecycle hooks.
type Hook = Arc<dyn Fn() -> BoxFuture<'static, ()> + Send + Sync>;

// ---------------------------------------------------------------------------
// TimeoutPolicy — the main policy struct
// ---------------------------------------------------------------------------

/// A resilience policy that enforces a timeout on every operation.
///
/// When the configured duration elapses before the operation completes,
/// the policy returns a [`TimeoutError::Elapsed`].
///
/// # Defaults
///
/// | Setting      | Default  |
/// |--------------|----------|
/// | duration     | 30 s     |
/// | cancel       | `true`   |
///
/// # Example
///
/// ```ignore
/// use resilient::timeout::TimeoutPolicy;
/// use std::time::Duration;
///
/// let policy = TimeoutPolicy::default()
///     .with_timeout_secs(5)
///     .with_cancel(true);
/// ```
#[derive(Clone)]
pub struct TimeoutPolicy {
    /// Maximum time allowed for the operation.
    pub(crate) duration: Duration,
    /// If `true`, the future is cancelled on timeout (uses
    /// `tokio::time::timeout`).
    pub(crate) cancel: bool,
    /// Optional name used in timeout error messages for easier
    /// debugging.
    pub(crate) name: Option<String>,
    /// Async callback invoked when a timeout occurs.
    pub(crate) on_timeout: Option<Hook>,
    /// Async callback invoked when the operation succeeds.
    pub(crate) on_success: Option<Hook>,
    /// Async callback invoked when the operation fails (before
    /// timeout).
    pub(crate) on_failure: Option<Hook>,
}

// ---------------------------------------------------------------------------
// Builder — separate construction type
// ---------------------------------------------------------------------------

/// Builder for [`TimeoutPolicy`].
///
/// Every field has a sensible default so you only need to set what
/// differs from the defaults shown below.
///
/// | Field          | Default  |
/// |----------------|----------|
/// | `duration`     | 30 s     |
/// | `cancel`       | `true`   |
///
/// # Example
///
/// ```ignore
/// use resilient::timeout::Builder;
/// use std::time::Duration;
///
/// let policy = Builder::new()
///     .with_timeout_secs(10)
///     .with_on_timeout(|| async { eprintln!("timed out!") })
///     .build();
/// ```
pub struct Builder {
    duration: Duration,
    cancel: bool,
    name: Option<String>,
    on_timeout: Option<Hook>,
    on_success: Option<Hook>,
    on_failure: Option<Hook>,
}

impl Builder {
    /// Creates a new `Builder` with the default settings.
    ///
    /// Defaults:
    /// - `duration`: 30 seconds
    /// - `cancel`: `true`
    pub fn new() -> Self {
        Self {
            duration: Duration::from_secs(30),
            cancel: true,
            name: None,
            on_timeout: None,
            on_success: None,
            on_failure: None,
        }
    }

    /// Sets the timeout duration from a [`std::time::Duration`].
    pub fn with_timeout(mut self, duration: Duration) -> Self {
        self.duration = duration;
        self
    }

    /// Sets the timeout duration in **milliseconds**.
    pub fn with_timeout_millis(mut self, millis: u64) -> Self {
        self.duration = Duration::from_millis(millis);
        self
    }

    /// Sets the timeout duration in **seconds**.
    pub fn with_timeout_secs(mut self, secs: u64) -> Self {
        self.duration = Duration::from_secs(secs);
        self
    }

    /// Sets the timeout duration in **minutes**.
    pub fn with_timeout_minutes(mut self, mins: u64) -> Self {
        self.duration = Duration::from_secs(mins * 60);
        self
    }

    /// Sets the timeout duration in **hours**.
    pub fn with_timeout_hours(mut self, hours: u64) -> Self {
        self.duration = Duration::from_secs(hours * 3600);
        self
    }

    /// Whether the underlying `tokio::time::timeout` mechanism is
    /// used to cancel the future on timeout.  Default: `true`.
    pub fn with_cancel(mut self, cancel: bool) -> Self {
        self.cancel = cancel;
        self
    }

    /// Attaches a human-readable name to the policy.
    ///
    /// The name appears inside the error message of
    /// [`TimeoutError::Elapsed`], which helps identify which policy
    /// triggered when multiple timeouts are in play.
    pub fn with_name(mut self, name: impl ToString) -> Self {
        self.name = Some(name.to_string());
        self
    }

    /// Registers an async callback that fires **on timeout**.
    ///
    /// The callback runs **after** the timeout error has occurred but
    /// before it is returned to the caller.  It receives no
    /// arguments; use it for logging, metrics, or side-effects.
    pub fn with_on_timeout<F, Fut>(mut self, f: F) -> Self
    where
        F: Fn() -> Fut + Send + Sync + 'static,
        Fut: Future<Output = ()> + Send + 'static,
    {
        self.on_timeout = Some(Arc::new(move || -> BoxFuture<'static, ()> {
            Box::pin(f())
        }));
        self
    }

    /// Registers an async callback that fires **on success**.
    ///
    /// The callback runs after the inner future returns `Ok`.
    pub fn with_on_success<F, Fut>(mut self, f: F) -> Self
    where
        F: Fn() -> Fut + Send + Sync + 'static,
        Fut: Future<Output = ()> + Send + 'static,
    {
        self.on_success = Some(Arc::new(move || -> BoxFuture<'static, ()> {
            Box::pin(f())
        }));
        self
    }

    /// Registers an async callback that fires **on failure** (non-timeout
    /// error).
    ///
    /// The callback runs after the inner future returns `Err` (but
    /// before the timeout would have fired).
    pub fn with_on_failure<F, Fut>(mut self, f: F) -> Self
    where
        F: Fn() -> Fut + Send + Sync + 'static,
        Fut: Future<Output = ()> + Send + 'static,
    {
        self.on_failure = Some(Arc::new(move || -> BoxFuture<'static, ()> {
            Box::pin(f())
        }));
        self
    }

    /// Consumes the `Builder` and produces a ready-to-use
    /// [`TimeoutPolicy`].
    pub fn build(self) -> TimeoutPolicy {
        TimeoutPolicy {
            duration: self.duration,
            cancel: self.cancel,
            name: self.name,
            on_timeout: self.on_timeout,
            on_success: self.on_success,
            on_failure: self.on_failure,
        }
    }
}

// ---------------------------------------------------------------------------
// TimeoutPolicy convenience setters (builder-style on the struct itself)
// ---------------------------------------------------------------------------

impl TimeoutPolicy {
    /// Overrides the timeout duration from a [`std::time::Duration`].
    pub fn with_timeout(mut self, duration: Duration) -> Self {
        self.duration = duration;
        self
    }

    /// Overrides the timeout duration in **milliseconds**.
    pub fn with_timeout_millis(mut self, millis: u64) -> Self {
        self.duration = Duration::from_millis(millis);
        self
    }

    /// Overrides the timeout duration in **seconds**.
    pub fn with_timeout_secs(mut self, secs: u64) -> Self {
        self.duration = Duration::from_secs(secs);
        self
    }

    /// Overrides the timeout duration in **minutes**.
    pub fn with_timeout_minutes(mut self, mins: u64) -> Self {
        self.duration = Duration::from_secs(mins * 60);
        self
    }

    /// Overrides the timeout duration in **hours**.
    pub fn with_timeout_hours(mut self, hours: u64) -> Self {
        self.duration = Duration::from_secs(hours * 3600);
        self
    }
}

// ---------------------------------------------------------------------------
// Convenience `run` method (same signature pattern as Pipeline::run)
// ---------------------------------------------------------------------------

impl TimeoutPolicy {
    pub async fn run<F, Fut, T, E>(&self, mut f: F) -> Result<T, E>
    where
        F: FnMut() -> Fut + Send,
        Fut: Future<Output = Result<T, E>> + Send,
        T: Send,
        E: Send + From<TimeoutError>,
    {
        let this = self.clone();

        if this.cancel {
            match tokio::time::timeout(this.duration, f()).await {
                Ok(Ok(val)) => {
                    if let Some(ref cb) = this.on_success {
                        cb().await;
                    }
                    Ok(val)
                }
                Ok(Err(e)) => {
                    if let Some(ref cb) = this.on_failure {
                        cb().await;
                    }
                    Err(e)
                }
                Err(_elapsed) => {
                    if let Some(ref cb) = this.on_timeout {
                        cb().await;
                    }
                    Err(TimeoutError::Elapsed {
                        duration: this.duration,
                        name: this.name,
                    }
                    .into())
                }
            }
        } else {
            let result = f().await;
            match &result {
                Ok(_) => {
                    if let Some(ref cb) = this.on_success {
                        cb().await;
                    }
                }
                Err(_) => {
                    if let Some(ref cb) = this.on_failure {
                        cb().await;
                    }
                }
            }
            result
        }
    }

    pub async fn run_with_timeout<F, Fut, T, E>(&self, mut f: F) -> Result<T, TimeoutError>
    where
        F: FnMut() -> Fut + Send,
        Fut: Future<Output = Result<T, E>> + Send,
        T: Send,
        E: Send + Sync + 'static + std::error::Error,
    {
        let this = self.clone();

        if this.cancel {
            match tokio::time::timeout(this.duration, f()).await {
                Ok(Ok(val)) => {
                    if let Some(ref cb) = this.on_success {
                        cb().await;
                    }
                    Ok(val)
                }
                Ok(Err(e)) => {
                    if let Some(ref cb) = this.on_failure {
                        cb().await;
                    }
                    Err(TimeoutError::Returning(Box::new(e)))
                }
                Err(_elapsed) => {
                    if let Some(ref cb) = this.on_timeout {
                        cb().await;
                    }
                    Err(TimeoutError::Elapsed {
                        duration: this.duration,
                        name: this.name,
                    })
                }
            }
        } else {
            let result = f().await;
            match &result {
                Ok(_) => {
                    if let Some(ref cb) = this.on_success {
                        cb().await;
                    }
                }
                Err(_) => {
                    if let Some(ref cb) = this.on_failure {
                        cb().await;
                    }
                }
            }
            result.map_err(|e| TimeoutError::Returning(Box::new(e)))
        }
    }
}

// ---------------------------------------------------------------------------
// Default implementations
// ---------------------------------------------------------------------------

impl Default for TimeoutPolicy {
    fn default() -> Self {
        Builder::new().build()
    }
}

impl Default for Builder {
    fn default() -> Self {
        Self::new()
    }
}

// ---------------------------------------------------------------------------
// Policy trait implementation
// ---------------------------------------------------------------------------

impl<T, E> Policy<T, E> for TimeoutPolicy
where
    E: Send + From<TimeoutError>,
{
    fn call<F, Fut>(&self, f: &mut F) -> impl Future<Output = Result<T, E>> + Send
    where
        F: FnMut() -> Fut + Send,
        Fut: Future<Output = Result<T, E>> + Send,
        T: Send,
        E: Send,
    {
        let this = self.clone();

        async move {
            if this.cancel {
                match tokio::time::timeout(this.duration, f()).await {
                    Ok(Ok(val)) => {
                        if let Some(ref cb) = this.on_success {
                            cb().await;
                        }
                        Ok(val)
                    }
                    Ok(Err(e)) => {
                        if let Some(ref cb) = this.on_failure {
                            cb().await;
                        }
                        Err(e)
                    }
                    Err(_elapsed) => {
                        if let Some(ref cb) = this.on_timeout {
                            cb().await;
                        }
                        Err(TimeoutError::Elapsed {
                            duration: this.duration,
                            name: this.name,
                        }
                        .into())
                    }
                }
            } else {
                let result = f().await;
                match &result {
                    Ok(_) => {
                        if let Some(ref cb) = this.on_success {
                            cb().await;
                        }
                    }
                    Err(_) => {
                        if let Some(ref cb) = this.on_failure {
                            cb().await;
                        }
                    }
                }
                result
            }
        }
    }
}