cloud-sdk 0.55.0

no_std-first provider-neutral 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

use super::super::{
    NumberedPageMetadata, NumberedPageObservation, NumberedPagination, OffsetPageMetadata,
    OffsetPageObservation, OffsetPagination, PageNumber, PagerControl, PagerDriver,
    PagerDriverError, PagerStep, PaginationBudget, PaginationError, PaginationLimits,
    SnapshotPolicy,
};

fn page(value: u64) -> PageNumber {
    PageNumber::new(value).unwrap_or_else(|_| unreachable!())
}

#[test]
fn offset_strategy_uses_the_same_driver_contract() {
    let limits = PaginationLimits::new(2, 10, 64).unwrap_or_else(|_| unreachable!());
    let strategy = OffsetPagination::new(
        0,
        2,
        PaginationBudget::new(limits, SnapshotPolicy::Forbidden),
    )
    .unwrap_or_else(|_| unreachable!());
    let mut pager = PagerDriver::new(strategy);
    assert_eq!(
        pager.next_request(PagerControl::Continue),
        Ok(PagerStep::Request(0))
    );
    let metadata = OffsetPageMetadata::new(0, 2, None, Some(1)).unwrap_or_else(|_| unreachable!());
    let boundary = pager.observe(OffsetPageObservation::new(metadata, 1, None, None));
    assert!(boundary.is_ok_and(|value| value.is_terminal()));
    assert_eq!(
        pager.next_request(PagerControl::Continue),
        Ok(PagerStep::Complete)
    );
}

fn driver(max_requests: u32) -> PagerDriver<NumberedPagination> {
    let limits = PaginationLimits::new(max_requests, 100, 64).unwrap_or_else(|_| unreachable!());
    let strategy = NumberedPagination::new(
        page(1),
        2,
        PaginationBudget::new(limits, SnapshotPolicy::Forbidden),
    )
    .unwrap_or_else(|_| unreachable!());
    PagerDriver::new(strategy)
}

fn observation(
    current: u64,
    next: Option<u64>,
    entries: usize,
) -> NumberedPageObservation<'static> {
    let metadata = NumberedPageMetadata::new(
        page(current),
        2,
        current.checked_sub(1).filter(|value| *value != 0).map(page),
        next.map(page),
        Some(page(next.unwrap_or(current))),
        None,
    )
    .unwrap_or_else(|_| unreachable!());
    NumberedPageObservation::new(metadata, entries, None, None)
}

#[test]
fn pager_sequences_requests_responses_and_completion() {
    let mut pager = driver(2);
    assert_eq!(
        pager.next_request(PagerControl::Continue),
        Ok(PagerStep::Request(page(1)))
    );
    assert_eq!(
        pager.next_request(PagerControl::Continue),
        Err(PagerDriverError::ResponsePending)
    );
    assert!(pager.observe(observation(1, Some(2), 2)).is_ok());
    assert_eq!(
        pager.next_request(PagerControl::Continue),
        Ok(PagerStep::Request(page(2)))
    );
    assert!(pager.observe(observation(2, None, 1)).is_ok());
    assert_eq!(
        pager.next_request(PagerControl::Continue),
        Ok(PagerStep::Complete)
    );
    assert!(pager.is_terminal());
}

#[test]
fn pager_cancellation_and_strategy_failures_are_fail_closed() {
    let mut cancelled = driver(2);
    assert_eq!(
        cancelled.next_request(PagerControl::Cancel),
        Ok(PagerStep::Cancelled)
    );
    assert_eq!(
        cancelled.next_request(PagerControl::Continue),
        Err(PagerDriverError::Terminal)
    );

    let mut pager = driver(2);
    assert_eq!(
        pager.observe(observation(1, None, 1)),
        Err(PagerDriverError::UnexpectedObservation)
    );
    assert!(pager.next_request(PagerControl::Continue).is_ok());
    assert_eq!(
        pager.observe(observation(2, None, 1)),
        Err(PagerDriverError::Strategy(
            PaginationError::UnexpectedPosition
        ))
    );
    assert_eq!(
        pager.next_request(PagerControl::Continue),
        Err(PagerDriverError::ResponsePending)
    );
}