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
use alloc::{boxed::Box, vec, vec::Vec};
use core::{
    fmt,
    future::Future,
    marker::PhantomData,
    ops::ControlFlow,
    pin::Pin,
    task::{Context, Poll},
};

use async_sleep::{sleep, Sleepble};
use futures_util::{future::FusedFuture, FutureExt as _};
use pin_project_lite::pin_project;
use retry_policy::RetryPolicy;

use crate::error::Error;

//
type RetryFutureRepeater<T, E> =
    Box<dyn FnMut() -> Pin<Box<dyn Future<Output = Result<T, E>> + Send>> + Send>;

//
pin_project! {
    pub struct Retry<SLEEP, POL, T, E> {
        policy: POL,
        future_repeater: RetryFutureRepeater<T, E>,
        //
        state: State<T, E>,
        attempts: usize,
        errors: Option<Vec<E>>,
        //
        phantom: PhantomData<(SLEEP, T, E)>,
    }
}

impl<SLEEP, POL, T, E> fmt::Debug for Retry<SLEEP, POL, T, E>
where
    POL: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Retry")
            .field("policy", &self.policy)
            .field("future_repeater", &"")
            .finish()
    }
}

impl<SLEEP, POL, T, E> Retry<SLEEP, POL, T, E> {
    pub(crate) fn new(policy: POL, future_repeater: RetryFutureRepeater<T, E>) -> Self {
        Self {
            policy,
            future_repeater,
            //
            state: State::Pending,
            attempts: 0,
            errors: Some(vec![]),
            //
            phantom: PhantomData,
        }
    }
}

//
enum State<T, E> {
    Pending,
    Fut(Pin<Box<dyn Future<Output = Result<T, E>> + Send>>),
    Sleep(Pin<Box<dyn Future<Output = ()> + Send>>),
    Done,
}
impl<T, E> fmt::Debug for State<T, E> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            State::Pending => write!(f, "Pending"),
            State::Fut(_) => write!(f, "Fut"),
            State::Sleep(_) => write!(f, "Sleep"),
            State::Done => write!(f, "Done"),
        }
    }
}

//
pub fn retry<SLEEP, POL, F, Fut, T, E>(policy: POL, future_repeater: F) -> Retry<SLEEP, POL, T, E>
where
    SLEEP: Sleepble + 'static,
    POL: RetryPolicy<E>,
    F: Fn() -> Fut + Send + 'static,
    Fut: Future<Output = Result<T, E>> + Send + 'static,
{
    Retry::new(policy, Box::new(move || Box::pin(future_repeater())))
}

//
impl<SLEEP, POL, T, E> FusedFuture for Retry<SLEEP, POL, T, E>
where
    SLEEP: Sleepble + 'static,
    POL: RetryPolicy<E>,
{
    fn is_terminated(&self) -> bool {
        matches!(self.state, State::Done)
    }
}

//
impl<SLEEP, POL, T, E> Future for Retry<SLEEP, POL, T, E>
where
    SLEEP: Sleepble + 'static,
    POL: RetryPolicy<E>,
{
    type Output = Result<T, Error<E>>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.project();

        loop {
            match this.state {
                State::Pending => {
                    let future = (this.future_repeater)();

                    //
                    *this.state = State::Fut(future);

                    continue;
                }
                State::Fut(future) => {
                    match future.poll_unpin(cx) {
                        Poll::Ready(Ok(x)) => {
                            //
                            *this.state = State::Done;
                            *this.attempts = 0;
                            *this.errors = Some(Vec::new());

                            break Poll::Ready(Ok(x));
                        }
                        Poll::Ready(Err(err)) => {
                            //
                            *this.attempts += 1;

                            //
                            let ret = this.policy.next_step(&err, *this.attempts);

                            //
                            if let Some(errors) = this.errors.as_mut() {
                                errors.push(err)
                            } else {
                                unreachable!()
                            }

                            match ret {
                                ControlFlow::Continue(dur) => {
                                    //
                                    *this.state = State::Sleep(Box::pin(sleep::<SLEEP>(dur)));

                                    continue;
                                }
                                ControlFlow::Break(stop_reason) => {
                                    let errors = this.errors.take().expect("unreachable!()");

                                    //
                                    *this.state = State::Done;
                                    *this.attempts = 0;
                                    *this.errors = Some(Vec::new());

                                    break Poll::Ready(Err(Error::new(stop_reason, errors)));
                                }
                            }
                        }
                        Poll::Pending => {
                            break Poll::Pending;
                        }
                    }
                }
                State::Sleep(future) => match future.poll_unpin(cx) {
                    Poll::Ready(_) => {
                        //
                        *this.state = State::Pending;

                        continue;
                    }
                    Poll::Pending => {
                        break Poll::Pending;
                    }
                },
                State::Done => panic!("cannot poll Retry twice"),
            }
        }
    }
}

#[cfg(feature = "std")]
#[cfg(test)]
mod tests {
    use super::*;

    use core::{
        sync::atomic::{AtomicUsize, Ordering},
        time::Duration,
    };

    use async_sleep::impl_tokio::Sleep;
    use once_cell::sync::Lazy;
    use retry_policy::{
        policies::SimplePolicy,
        retry_backoff::backoffs::FnBackoff,
        retry_predicate::predicates::{AlwaysPredicate, FnPredicate},
        StopReason,
    };

    #[tokio::test]
    async fn test_retry_with_max_retries_reached() {
        #[derive(Debug, PartialEq)]
        struct FError(usize);
        async fn f(n: usize) -> Result<(), FError> {
            Err(FError(n))
        }

        //
        let policy = SimplePolicy::new(
            AlwaysPredicate,
            3,
            FnBackoff::from(|_| Duration::from_millis(100)),
        );

        //
        let now = std::time::Instant::now();

        match retry::<Sleep, _, _, _, _, _>(policy, || f(0)).await {
            Ok(_) => panic!(""),
            Err(err) => {
                assert_eq!(&err.stop_reason, &StopReason::MaxRetriesReached);
                assert_eq!(err.errors(), &[FError(0), FError(0), FError(0), FError(0)]);
            }
        }

        let elapsed_dur = now.elapsed();
        assert!(elapsed_dur.as_millis() >= 300 && elapsed_dur.as_millis() <= 305);
    }

    #[tokio::test]
    async fn test_retry_with_max_retries_reached_for_tokio_spawn() {
        #[derive(Debug, PartialEq)]
        struct FError(usize);
        async fn f(n: usize) -> Result<(), FError> {
            Err(FError(n))
        }

        //
        let policy = SimplePolicy::new(
            AlwaysPredicate,
            3,
            FnBackoff::from(|_| Duration::from_millis(100)),
        );

        //
        tokio::spawn(async move {
            let now = std::time::Instant::now();

            match retry::<Sleep, _, _, _, _, _>(policy, || f(0)).await {
                Ok(_) => panic!(""),
                Err(err) => {
                    assert_eq!(&err.stop_reason, &StopReason::MaxRetriesReached);
                    assert_eq!(err.errors(), &[FError(0), FError(0), FError(0), FError(0)]);
                }
            }

            let elapsed_dur = now.elapsed();
            assert!(elapsed_dur.as_millis() >= 300 && elapsed_dur.as_millis() <= 305);
        });
    }

    #[tokio::test]
    async fn test_retry_with_predicate_failed() {
        #[derive(Debug, PartialEq)]
        struct FError(usize);
        async fn f(n: usize) -> Result<(), FError> {
            Err(FError(n))
        }

        //
        static N: Lazy<AtomicUsize> = Lazy::new(|| AtomicUsize::new(0));

        let policy = SimplePolicy::new(
            FnPredicate::from(|FError(n): &FError| vec![0, 1].contains(n)),
            3,
            FnBackoff::from(|_| Duration::from_millis(100)),
        );

        //
        let now = std::time::Instant::now();

        match retry::<Sleep, _, _, _, _, _>(policy, || f(N.fetch_add(1, Ordering::SeqCst))).await {
            Ok(_) => panic!(""),
            Err(err) => {
                assert_eq!(&err.stop_reason, &StopReason::PredicateFailed);
                assert_eq!(err.errors(), &[FError(0), FError(1), FError(2)]);
            }
        }

        let elapsed_dur = now.elapsed();
        assert!(elapsed_dur.as_millis() >= 200 && elapsed_dur.as_millis() <= 205);
    }
}