kitsune_p2p_fetch 0.4.0-dev.5

use tokio::time::{Duration, Instant};

use backon::{BackoffBuilder, FibonacciBackoff, FibonacciBuilder};

/// The number of times to retry a fetch before giving up.
pub const BACKOFF_RETRY_COUNT: usize = 8;

/// A backoff strategy for use when fetching data from remote nodes that appear to not be responding.
#[derive(Debug)]
pub struct FetchBackoff {
    backoff: FibonacciBackoff,
    current_wait: Duration,
    started_wait_at: Instant,
    expired: bool,
}

impl FetchBackoff {
    /// Create a new instance with the given initial delay.
    pub fn new(initial_delay: Duration) -> Self {
        let mut backoff = FibonacciBuilder::default()
            .with_jitter()
            .with_min_delay(initial_delay)
            .with_max_delay(6 * initial_delay)
            .with_max_times(BACKOFF_RETRY_COUNT)
            .build();

        Self {
            current_wait: backoff.next().expect("At least one backoff period"),
            started_wait_at: Instant::now(),
            backoff,
            expired: false,
        }
    }

    /// Check whether the backoff is ready to try again. It will return true once each time it is
    /// ready and then start the next delay so the consumer must make an attempt to use the backoff
    /// before calling this again.
    pub fn is_ready(&mut self) -> bool {
        if self.expired {
            return false;
        }

        if self.started_wait_at.elapsed() >= self.current_wait {
            self.advance();
            true
        } else {
            false
        }
    }

    /// Check whether the backoff has expired.
    pub fn is_expired(&self) -> bool {
        self.expired
    }

    fn advance(&mut self) {
        match self.backoff.next() {
            Some(d) => {
                self.current_wait = d;
                self.started_wait_at = Instant::now();
            }
            None => {
                self.expired = true;
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::backoff::BACKOFF_RETRY_COUNT;

    use super::FetchBackoff;
    use std::time::Duration;

    #[test]
    fn first_delay_is_initial_delay() {
        let initial_delay = Duration::from_secs(1);
        let mut backoff = FetchBackoff::new(initial_delay);

        // The backoff should not be ready due to the initial delay period
        assert!(!backoff.is_ready());

        // Account for jitter and check that the delay is roughly the initial delay
        assert!(initial_delay <= backoff.current_wait && backoff.current_wait < initial_delay * 2);
    }

    #[test]
    fn number_of_tries_is_limited() {
        let mut backoff = FetchBackoff::new(Duration::from_nanos(1));
        assert!(!backoff.is_expired());

        let mut num_tries = 0;
        for _ in 0..100 {
            if backoff.is_expired() {
                break;
            }

            while !backoff.is_ready() {
                std::thread::sleep(Duration::from_nanos(10));
            }

            num_tries += 1;
        }

        assert!(backoff.is_expired());
        assert!(!backoff.is_ready());
        assert_eq!(BACKOFF_RETRY_COUNT, num_tries);
    }
}