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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
mod connection_type;
mod cursor;
mod edge;
mod page_info;
mod slice;

use crate::{Context, FieldResult, ObjectType};

pub use connection_type::Connection;
pub use cursor::Cursor;
pub use page_info::PageInfo;

/// Connection query operation
pub enum QueryOperation {
    /// Return all results
    None,
    /// Return all results after the cursor
    After {
        /// After this cursor
        after: Cursor,
    },
    /// Return all results before the cursor
    Before {
        /// Before this cursor
        before: Cursor,
    },
    /// Return all results between the cursors
    Between {
        /// After this cursor
        after: Cursor,
        /// But before this cursor
        before: Cursor,
    },
    /// Return the amount of results specified by `limit`, starting from the beginning
    First {
        /// The maximum amount of results to return
        limit: usize,
    },
    /// Return the amount of results specified by `limit`, starting after the cursor
    FirstAfter {
        /// The maximum amount of results to return
        limit: usize,
        /// After this cursor
        after: Cursor,
    },
    /// Return the amount of results specified by `limit`, starting from the beginning but ending before the cursor
    FirstBefore {
        /// The maximum amount of results to return
        limit: usize,
        /// Before this cursor
        before: Cursor,
    },
    /// Return the amount of results specified by `limit`, but between the cursors. Limit includes beginning results.
    FirstBetween {
        /// The maximum amount of results to return
        limit: usize,
        /// After this cursor
        after: Cursor,
        /// But before this cursor
        before: Cursor,
    },
    /// Return the amount of results specified by `limit`, but before the end
    Last {
        /// The maximum amount of results to return
        limit: usize,
    },
    /// Return the amount of results specified by `limit`, but before the end. Must not include anything before the cursor.
    LastAfter {
        /// The maximum amount of results to return
        limit: usize,
        /// After this cursor
        after: Cursor,
    },
    /// Return the amount of results specified by `limit`, but before the cursor
    LastBefore {
        /// The maximum amount of results to return
        limit: usize,
        /// Before this cursor
        before: Cursor,
    },
    /// Return the amount of results specified by `limit`, but between the cursors. Limit includes ending results.
    LastBetween {
        /// The maximum amount of results to return
        limit: usize,
        /// After this cursor
        after: Cursor,
        /// But before this cursor
        before: Cursor,
    },
    /// An invalid query was made. For example: sending `first` and `last` in the same query
    Invalid,
}

/// Empty edge extension object
#[async_graphql_derive::SimpleObject(internal)]
pub struct EmptyEdgeFields;

// Temporary struct for to store values for pattern matching
struct Pagination {
    after: Option<Cursor>,
    before: Option<Cursor>,
    first: Option<i32>,
    last: Option<i32>,
}

/// Data source of GraphQL Cursor Connections type
///
/// `Edge` is an extension object type that extends the edge fields, If you don't need it, you can use `EmptyEdgeFields`.
///
/// # References
/// (GraphQL Cursor Connections Specification)[https://facebook.github.io/relay/graphql/connections.htm]
///
/// # Examples
///
/// ```rust
/// use async_graphql::*;
/// use byteorder::{ReadBytesExt, BE};
///
/// struct QueryRoot;
///
/// #[SimpleObject]
/// struct DiffFields {
///     diff: i32,
/// }
///
/// struct Numbers;
///
/// #[DataSource]
/// impl DataSource for Numbers {
///     type Element = i32;
///     type EdgeFieldsObj = DiffFields;
///
///     async fn query_operation(&self, ctx: &Context<'_>, operation: &QueryOperation) -> FieldResult<Connection<Self::Element, Self::EdgeFieldsObj>> {
///         let (start, end) = match operation {
///             QueryOperation::First {limit} => {
///                 let start = 0;
///                 let end = start + *limit as i32;
///                 (start, end)
///             }
///             QueryOperation::Last {limit} => {
///                 let end = 0;
///                 let start = end - *limit as i32;
///                 (start, end)
///             }
///             QueryOperation::FirstAfter {after, limit} => {
///                 let start = base64::decode(after.to_string())
///                     .ok()
///                     .and_then(|data| data.as_slice().read_i32::<BE>().ok())
///                     .map(|idx| idx + 1)
///                     .unwrap_or(0);
///                 let end = start + *limit as i32;
///                 (start, end)
///             }
///             QueryOperation::LastBefore {before, limit} => {
///                 let end = base64::decode(before.to_string())
///                     .ok()
///                     .and_then(|data| data.as_slice().read_i32::<BE>().ok())
///                     .unwrap_or(0);
///                 let start = end - *limit as i32;
///                 (start, end)
///             }
///             // You should handle all cases instead of using a default like this
///             _ => (0, 10)
///         };
///
///         let nodes = (start..end).into_iter().map(|n| (base64::encode(n.to_be_bytes()).into(), DiffFields {diff: n - 1000}, n)).collect();
///         Ok(Connection::new(None, true, true, nodes))
///     }
/// }
///
/// #[Object]
/// impl QueryRoot {
///     async fn numbers(&self, ctx: &Context<'_>,
///         after: Option<Cursor>,
///         before: Option<Cursor>,
///         first: Option<i32>,
///         last: Option<i32>
///     ) -> FieldResult<Connection<i32, DiffFields>> {
///         Numbers.query(ctx, after, before, first, last).await
///     }
/// }
///
/// #[async_std::main]
/// async fn main() {
///     let schema = Schema::new(QueryRoot, EmptyMutation, EmptySubscription);
///
///     assert_eq!(schema.execute("{ numbers(first: 2) { edges { node } } }").await.unwrap().data, serde_json::json!({
///         "numbers": {
///             "edges": [
///                 {"node": 0},
///                 {"node": 1}
///             ]
///         },
///     }));
///
///     assert_eq!(schema.execute("{ numbers(last: 2) { edges { node diff } } }").await.unwrap().data, serde_json::json!({
///         "numbers": {
///             "edges": [
///                 {"node": -2, "diff": -1002},
///                 {"node": -1, "diff": -1001}
///             ]
///         },
///     }));
/// }
/// ```
#[async_trait::async_trait]
pub trait DataSource: Sync + Send {
    /// Record type
    type Element;

    /// Fields for Edge
    ///
    /// Is a type that implements `ObjectType` and can be defined by the procedure macro `#[Object]`.
    type EdgeFieldsObj: ObjectType + Send + Sync;

    /// Execute the query.
    async fn query(
        &self,
        ctx: &Context<'_>,
        after: Option<Cursor>,
        before: Option<Cursor>,
        first: Option<i32>,
        last: Option<i32>,
    ) -> FieldResult<Connection<Self::Element, Self::EdgeFieldsObj>> {
        let pagination = Pagination {
            first,
            last,
            before,
            after,
        };

        let operation = match pagination {
            // This is technically allowed according to the Relay Spec, but highly discouraged
            Pagination {
                first: Some(_),
                last: Some(_),
                before: _,
                after: _,
            } => QueryOperation::Invalid,
            Pagination {
                first: None,
                last: None,
                before: None,
                after: None,
            } => QueryOperation::None,
            Pagination {
                first: None,
                last: None,
                before: Some(before),
                after: None,
            } => QueryOperation::Before { before },
            Pagination {
                first: None,
                last: None,
                before: None,
                after: Some(after),
            } => QueryOperation::After { after },
            Pagination {
                first: None,
                last: None,
                before: Some(before),
                after: Some(after),
            } => QueryOperation::Between { after, before },
            Pagination {
                first: Some(limit),
                last: None,
                before: None,
                after: None,
            } => QueryOperation::First {
                limit: limit.max(0) as usize,
            },
            Pagination {
                first: Some(limit),
                last: None,
                before: Some(before),
                after: None,
            } => QueryOperation::FirstBefore {
                limit: limit.max(0) as usize,
                before,
            },
            Pagination {
                first: Some(limit),
                last: None,
                before: None,
                after: Some(after),
            } => QueryOperation::FirstAfter {
                limit: limit.max(0) as usize,
                after,
            },
            Pagination {
                first: Some(limit),
                last: None,
                before: Some(before),
                after: Some(after),
            } => QueryOperation::FirstBetween {
                limit: limit.max(0) as usize,
                after,
                before,
            },
            Pagination {
                first: None,
                last: Some(limit),
                before: None,
                after: None,
            } => QueryOperation::Last {
                limit: limit.max(0) as usize,
            },
            Pagination {
                first: None,
                last: Some(limit),
                before: Some(before),
                after: None,
            } => QueryOperation::LastBefore {
                limit: limit.max(0) as usize,
                before,
            },
            Pagination {
                first: None,
                last: Some(limit),
                before: None,
                after: Some(after),
            } => QueryOperation::LastAfter {
                limit: limit.max(0) as usize,
                after,
            },
            Pagination {
                first: None,
                last: Some(limit),
                before: Some(before),
                after: Some(after),
            } => QueryOperation::LastBetween {
                limit: limit.max(0) as usize,
                after,
                before,
            },
        };

        self.query_operation(ctx, &operation).await
    }

    /// Parses the parameters and executes the query,Usually you just need to implement this method.
    async fn query_operation(
        &self,
        ctx: &Context<'_>,
        operation: &QueryOperation,
    ) -> FieldResult<Connection<Self::Element, Self::EdgeFieldsObj>>;
}