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
use std::fmt::Debug;

use serde::{Deserialize, Serialize};

pub use crate::{
    cursor::Cursor,
    data_source::{DataSource, DataSourceRequest},
    error::Error,
    offset::Offset,
    request::Request,
    response::Response,
};

mod cursor;
mod data_source;
mod error;
mod offset;
mod request;
mod response;

pub async fn pagination<Item, Filters, OffsetValue>(
    data_source: impl DataSource<Item, Filters, OffsetValue>,
    request: Request<Filters>,
    default_limit: u16,
) -> Result<Response<Item>, Error>
where
    Item: Clone + for<'a> Deserialize<'a> + Offset<OffsetValue> + Serialize,
    Filters: Clone + for<'a> Deserialize<'a> + PartialEq + Serialize,
    OffsetValue: Clone + Debug + Default + for<'a> Deserialize<'a> + Serialize,
{
    let cursor = match request.after {
        Some(raw) => Cursor::<Filters, OffsetValue>::parse(raw).map(Some),
        _ => Ok(None),
    }?;
    let limit = request.limit;
    let offset = cursor.as_ref().map(|c| c.offset());

    let data_source_request =
        DataSourceRequest::new(request.filters, offset, limit.unwrap_or(default_limit));

    if let Some(cursor) = cursor {
        if cursor.req().filters() != data_source_request.filters() {
            return Err(Error::CursorAndParamsAreDifferent);
        }
    }

    let items = data_source
        .get_items(data_source_request.clone())
        .await
        .map_err(|e| Error::DataSourceFailed(e.to_string()))?;

    Response::from_items_and_req(items, data_source_request)
}

#[cfg(test)]
mod tests {
    use serde::{Deserialize, Serialize};

    use crate::data_source::{DataSource, DataSourceRequest};
    use crate::{pagination, Error, Offset, Request, Response};

    #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
    struct Filters {
        param1: Option<bool>,
        param2: Option<i64>,
    }

    impl Default for Filters {
        fn default() -> Self {
            Self {
                param1: Some(true),
                param2: Some(10),
            }
        }
    }

    const DEFAULT_LIMIT: u16 = 100;

    #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
    struct Item(i32);

    type OffsetValue = u64;

    impl Offset<OffsetValue> for Item {
        fn offset(&self) -> OffsetValue {
            last_item_timestamp()
        }
    }

    fn last_item_timestamp() -> OffsetValue {
        100
    }

    struct MockDataSource {
        get_items: fn(DataSourceRequest<Filters, OffsetValue>) -> anyhow::Result<Vec<Item>>,
    }

    impl Default for MockDataSource {
        fn default() -> Self {
            Self {
                get_items:
                    |req: DataSourceRequest<Filters, OffsetValue>| -> anyhow::Result<Vec<Item>> {
                        (0..req.limit_with_reserve())
                            .map(|i| Item(i as i32))
                            .map(Ok)
                            .collect()
                    },
            }
        }
    }

    #[async_trait::async_trait]
    impl DataSource<Item, Filters, OffsetValue> for MockDataSource {
        type Error = anyhow::Error;

        async fn get_items(
            &self,
            req: DataSourceRequest<Filters, OffsetValue>,
        ) -> Result<Vec<Item>, Self::Error> {
            (self.get_items)(req)
        }
    }

    #[tokio::test]
    async fn pagination_sanity_check() {
        let mock_data_source = MockDataSource::default();

        let req = Request {
            filters: Filters {
                param1: Some(true),
                param2: Some(10),
            },
            limit: Some(10),
            after: None,
        };

        let result = pagination::<Item, Filters, OffsetValue>(mock_data_source, req, 0)
            .await
            .unwrap();

        assert_eq!(result, Response {
            // {"offset":100,"req":{"param1":true,"param2":10,"offset":100,"limit":4}}
            last_cursor: Some("eyJvZmZzZXQiOjEwMCwicmVxIjp7InBhcmFtMSI6dHJ1ZSwicGFyYW0yIjoxMCwib2Zmc2V0IjpudWxsLCJsaW1pdCI6MTB9fQ==".to_owned()),
            has_next_page: true,
            data: vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9].into_iter().map(Item).collect::<Vec<_>>(),
        });
    }

    #[tokio::test]
    async fn pagination_last_test() {
        let mock_data_source = MockDataSource {
            get_items: |params: DataSourceRequest<Filters, OffsetValue>| {
                (0..params.limit_with_reserve() - 2)
                    .map(|i| Item(i as i32))
                    .map(Ok)
                    .collect()
            },
        };

        let req = Request {
            filters: Filters {
                param1: Some(true),
                param2: Some(10),
            },
            limit: Some(10),
            after: None,
        };

        let result = pagination::<Item, Filters, OffsetValue>(mock_data_source, req, DEFAULT_LIMIT)
            .await
            .unwrap();
        assert_eq!(result.data.len(), 9);
        assert!(!result.has_next_page);
    }

    #[tokio::test]
    async fn pagination_empty_test() {
        let mock_data_source = MockDataSource {
            get_items: |_| Ok(vec![]),
        };

        let req = Request {
            filters: Filters {
                param1: Some(true),
                param2: Some(10),
            },
            limit: Some(4),
            after: None,
        };

        let result = pagination::<Item, Filters, OffsetValue>(mock_data_source, req, DEFAULT_LIMIT)
            .await
            .unwrap();
        assert_eq!(result.data.len(), 0);
        assert!(!result.has_next_page);
    }

    #[tokio::test]
    async fn pagination_with_default_limit_test() {
        let req = Request {
            filters: Filters {
                param1: Some(true),
                param2: Some(10),
            },
            limit: None,
            after: None,
        };

        let result = pagination::<Item, Filters, OffsetValue>(MockDataSource::default(), req, 7)
            .await
            .unwrap();
        assert_eq!(result.data.len(), 7);
        assert!(result.has_next_page);
    }

    #[tokio::test]
    async fn pagination_from_cursor_test() {
        // {"param1":"true","param2":"10","offset":100,"limit":"4"}
        let after = Some("eyJvZmZzZXQiOjEwMCwicmVxIjp7InBhcmFtMSI6dHJ1ZSwicGFyYW0yIjoxMCwib2Zmc2V0IjoxMDAsImxpbWl0Ijo0fX0=".to_owned());

        let req = Request {
            filters: Filters {
                param1: Some(true),
                param2: Some(10),
            },
            limit: Some(4),
            after,
        };

        let result =
            pagination::<Item, Filters, OffsetValue>(MockDataSource::default(), req, DEFAULT_LIMIT)
                .await
                .unwrap();
        assert_eq!(result.data.len(), 4);
        assert!(result.has_next_page);
    }

    #[tokio::test]
    async fn cursor_and_params_together() {
        let mock_data_source = MockDataSource::default();

        // {"param1":"true","param2":"10","offset":100,"limit":"4"}
        let after = Some("eyJvZmZzZXQiOjEwMCwicmVxIjp7InBhcmFtMSI6dHJ1ZSwicGFyYW0yIjoxMCwib2Zmc2V0IjoxMDAsImxpbWl0Ijo0fX0=".to_string());

        let req = Request {
            filters: Filters {
                param1: Some(true),
                param2: Some(10),
            },
            limit: Some(4),
            after,
        };

        let result = pagination::<Item, Filters, OffsetValue>(mock_data_source, req, 10)
            .await
            .unwrap();
        assert_eq!(result.data.len(), 4);
        assert!(result.has_next_page);
    }

    #[tokio::test]
    async fn error_if_cursor_and_params_is_different() {
        let mock_data_source = MockDataSource::default();

        // {"param1":"true","param2":"10","offset":100,"limit":"4"}
        let after = Some("eyJvZmZzZXQiOjEwMCwicmVxIjp7InBhcmFtMSI6dHJ1ZSwicGFyYW0yIjoxMCwib2Zmc2V0IjoxMDAsImxpbWl0Ijo0fX0=".to_owned());

        let req = Request {
            filters: Filters {
                param1: Some(false),
                param2: Some(1),
            },
            limit: Some(4),
            after,
        };

        let result = pagination::<Item, Filters, OffsetValue>(mock_data_source, req, 10)
            .await
            .err()
            .unwrap();
        assert_eq!(result, Error::CursorAndParamsAreDifferent);
    }
}