cloud-sdk 0.21.0

no_std-first multi-provider cloud SDK foundations.
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

use core::time::Duration;

use super::{
    ActionPollError, ActionPollStep, ActionPoller, ActionUpdate, PollContext, PollDecision,
    PollPolicy,
};
use crate::rate_limit::RateLimit;

struct Policy {
    decision: PollDecision,
    context: Option<PollContext>,
}

impl PollPolicy for Policy {
    type Error = ();

    fn decide(&mut self, context: PollContext) -> Result<PollDecision, Self::Error> {
        self.context = Some(context);
        Ok(self.decision)
    }
}

struct FailingPolicy;

impl PollPolicy for FailingPolicy {
    type Error = u8;

    fn decide(&mut self, _context: PollContext) -> Result<PollDecision, Self::Error> {
        Err(7)
    }
}

#[test]
fn caller_policy_receives_progress_and_rate_limit() {
    let rate_limit = RateLimit::new(3600, 3, 42).ok();
    let mut policy = Policy {
        decision: PollDecision::Delay(Duration::from_secs(2)),
        context: None,
    };
    let mut poller = ActionPoller::new();
    assert_eq!(
        poller.observe(ActionUpdate::<()>::Running, 25, rate_limit, &mut policy),
        Ok(ActionPollStep::Delay(Duration::from_secs(2)))
    );
    assert_eq!(
        policy.context,
        Some(PollContext {
            observation: 1,
            progress: 25,
            rate_limit,
        })
    );
    assert!(!poller.is_terminal());
}

#[test]
fn terminal_success_and_failure_bypass_delay_policy() {
    let mut policy = Policy {
        decision: PollDecision::Delay(Duration::from_secs(1)),
        context: None,
    };
    let mut succeeded = ActionPoller::new();
    assert_eq!(
        succeeded.observe(ActionUpdate::<u8>::Success, 100, None, &mut policy),
        Ok(ActionPollStep::Complete)
    );
    assert!(succeeded.is_terminal());
    assert_eq!(policy.context, None);

    let mut failed = ActionPoller::new();
    assert_eq!(
        failed.observe(ActionUpdate::Failed(7_u8), 60, None, &mut policy),
        Ok(ActionPollStep::Failed(7))
    );
    assert!(failed.is_terminal());
}

#[test]
fn terminal_failure_takes_precedence_over_progress_telemetry() {
    let mut policy = Policy {
        decision: PollDecision::Delay(Duration::from_secs(1)),
        context: None,
    };
    let mut poller = ActionPoller::new();
    assert!(
        poller
            .observe(ActionUpdate::<u8>::Running, 80, None, &mut policy)
            .is_ok()
    );
    assert_eq!(
        poller.observe(ActionUpdate::Failed(7_u8), 60, None, &mut policy),
        Ok(ActionPollStep::Failed(7))
    );
    assert!(poller.is_terminal());
    assert_eq!(poller.observations(), 2);

    let mut malformed_progress = ActionPoller::new();
    assert_eq!(
        malformed_progress.observe(ActionUpdate::Failed(9_u8), 255, None, &mut policy),
        Ok(ActionPollStep::Failed(9))
    );
}

#[test]
fn caller_policy_controls_cancel_and_timeout() {
    for (decision, expected) in [
        (PollDecision::Cancel, ActionPollStep::Cancelled),
        (PollDecision::Timeout, ActionPollStep::TimedOut),
    ] {
        let mut policy = Policy {
            decision,
            context: None,
        };
        let mut poller = ActionPoller::new();
        assert_eq!(
            poller.observe(ActionUpdate::<()>::Running, 0, None, &mut policy),
            Ok(expected)
        );
        assert!(poller.is_terminal());
    }
}

#[test]
fn policy_errors_are_preserved_without_advancing_the_poller() {
    let mut poller = ActionPoller::new();
    assert_eq!(
        poller.observe(ActionUpdate::<()>::Running, 10, None, &mut FailingPolicy,),
        Err(ActionPollError::Policy(7))
    );
    assert_eq!(poller.observations(), 0);
    assert!(!poller.is_terminal());
}

#[test]
fn rejects_busy_loops_progress_regression_and_post_terminal_polling() {
    let mut zero = Policy {
        decision: PollDecision::Delay(Duration::ZERO),
        context: None,
    };
    let mut poller = ActionPoller::new();
    assert_eq!(
        poller.observe(ActionUpdate::<()>::Running, 10, None, &mut zero),
        Err(ActionPollError::ZeroDelay)
    );
    assert_eq!(poller.observations(), 0);

    zero.decision = PollDecision::Delay(Duration::from_secs(1));
    assert!(
        poller
            .observe(ActionUpdate::<()>::Running, 10, None, &mut zero)
            .is_ok()
    );
    assert_eq!(
        poller.observe(ActionUpdate::<()>::Running, 9, None, &mut zero),
        Err(ActionPollError::ProgressRegressed)
    );
    assert_eq!(poller.observations(), 1);

    assert!(
        poller
            .observe(ActionUpdate::<()>::Success, 100, None, &mut zero)
            .is_ok()
    );
    assert_eq!(
        poller.observe(ActionUpdate::<()>::Success, 100, None, &mut zero),
        Err(ActionPollError::Terminal)
    );
}