2020-05-28 00:02:00 +00:00
|
|
|
//! Types for Relay-compliant server
|
|
|
|
|
2020-03-21 01:32:13 +00:00
|
|
|
mod connection_type;
|
2020-05-05 05:21:45 +00:00
|
|
|
mod cursor;
|
2020-03-19 09:20:12 +00:00
|
|
|
mod edge;
|
|
|
|
mod page_info;
|
|
|
|
|
2020-10-15 06:38:10 +00:00
|
|
|
use std::fmt::Display;
|
|
|
|
use std::future::Future;
|
|
|
|
|
2020-03-21 01:32:13 +00:00
|
|
|
pub use connection_type::Connection;
|
2020-05-28 00:02:00 +00:00
|
|
|
pub use cursor::CursorType;
|
|
|
|
pub use edge::Edge;
|
2020-05-05 22:52:04 +00:00
|
|
|
pub use page_info::PageInfo;
|
2020-03-19 09:20:12 +00:00
|
|
|
|
2021-11-13 13:41:58 +00:00
|
|
|
use crate::{Error, Result, SimpleObject};
|
|
|
|
|
2020-05-28 00:02:00 +00:00
|
|
|
/// Empty additional fields
|
2020-09-18 00:52:13 +00:00
|
|
|
#[derive(SimpleObject)]
|
2021-11-09 10:52:10 +00:00
|
|
|
#[graphql(internal, fake)]
|
2020-05-28 00:02:00 +00:00
|
|
|
pub struct EmptyFields;
|
2020-05-05 07:22:01 +00:00
|
|
|
|
2020-06-02 13:43:08 +00:00
|
|
|
/// Parses the parameters and executes the query.
|
|
|
|
///
|
2020-06-02 11:12:28 +00:00
|
|
|
/// # Examples
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
/// use async_graphql::*;
|
|
|
|
/// use async_graphql::connection::*;
|
|
|
|
///
|
|
|
|
/// struct QueryRoot;
|
|
|
|
///
|
|
|
|
/// struct Numbers;
|
|
|
|
///
|
2020-09-18 00:52:13 +00:00
|
|
|
/// #[derive(SimpleObject)]
|
2020-06-02 11:12:28 +00:00
|
|
|
/// struct Diff {
|
|
|
|
/// diff: i32,
|
|
|
|
/// }
|
|
|
|
///
|
2020-09-18 00:52:13 +00:00
|
|
|
/// #[Object]
|
2020-06-02 11:12:28 +00:00
|
|
|
/// impl QueryRoot {
|
|
|
|
/// async fn numbers(&self,
|
|
|
|
/// after: Option<String>,
|
|
|
|
/// before: Option<String>,
|
|
|
|
/// first: Option<i32>,
|
|
|
|
/// last: Option<i32>
|
Rework errors
This completely overhauls the error system used in async-graphql.
- `Error` has been renamed to `ServerError` and `FieldError` has been
renamed to just `Error`. This is because `FieldError` is by far the most
common error that users will have to use so it makes sense to use the
most obvious error name. Also, the current name didn't make sense as it
was used for things other than field errors, such as the data callback
for websockets.
- `ServerError` has been made completely opaque. Before it was an enum
of all the possible errors, but now it just contains an error message,
the locations, the path and extensions. It is a shame that we lose
information, it makes more sense as _conceptually_ GraphQL does not
provide that information. It also frees us to change the internals of
async-graphql a lot more.
- The path of errors is no longer an opaque JSON value but a regular
type, `Vec<PathSegment>`. The type duplication of `PathSegment` and
`QueryPathSegment` is unfortunate, I plan to work on this in the future.
- Now that `ServerError` is opaque, `RuleError` has been removed from
the public API, making it simpler.
- Additionally `QueryError` has been completely removed. Instead the
error messages are constructed ad-hoc; I took care to never repeat an
error message.
- Instead of constructing field-not-found errors inside the
implementations of field resolvers they now return `Option`s, where a
`None` value is representative of the field not being found.
- As an unfortunate consequence of the last change, self-referential
types based on the output of a subscription resolver can no longer be
created. This does not mean anything for users, but causes lifetime
issues in the implementation of merged objects. I fixed it with a bit of
a hack, but this'll have to be looked into further.
- `InputValueError` now has a generic parameter - it's kind of weird but
it's necessary for ergonomics. It also improves error messages.
- The `ErrorExtensions` trait has been removed. I didn't think the
`extend` method was necessary since `From` impls exist. But the
ergonomics are still there with a new trait `ExtendError`, which
is implemented for both errors and results.
- `Response` now supports serializing multiple errors. This allows for
nice things like having multiple validation errors not be awkwardly
shoved into a single error.
- When an error occurs in execution, data is sent as `null`. This is
slightly more compliant with the spec but the algorithm described in
<https://spec.graphql.org/June2018/#sec-Errors-and-Non-Nullability> has
yet to be implemented.
2020-09-29 19:06:44 +00:00
|
|
|
/// ) -> Result<Connection<usize, i32, EmptyFields, Diff>> {
|
2020-06-02 11:12:28 +00:00
|
|
|
/// query(after, before, first, last, |after, before, first, last| async move {
|
|
|
|
/// let mut start = after.map(|after| after + 1).unwrap_or(0);
|
|
|
|
/// let mut end = before.unwrap_or(10000);
|
|
|
|
/// if let Some(first) = first {
|
|
|
|
/// end = (start + first).min(end);
|
|
|
|
/// }
|
|
|
|
/// if let Some(last) = last {
|
|
|
|
/// start = if last > end - start {
|
|
|
|
/// end
|
|
|
|
/// } else {
|
|
|
|
/// end - last
|
|
|
|
/// };
|
|
|
|
/// }
|
|
|
|
/// let mut connection = Connection::new(start > 0, end < 10000);
|
|
|
|
/// connection.append(
|
|
|
|
/// (start..end).into_iter().map(|n|
|
|
|
|
/// Edge::with_additional_fields(n, n as i32, Diff{ diff: (10000 - n) as i32 })),
|
|
|
|
/// );
|
2021-11-13 13:41:58 +00:00
|
|
|
/// Ok::<_, Error>(connection)
|
2020-06-02 11:12:28 +00:00
|
|
|
/// }).await
|
|
|
|
/// }
|
|
|
|
/// }
|
|
|
|
///
|
2021-03-12 04:47:24 +00:00
|
|
|
/// tokio::runtime::Runtime::new().unwrap().block_on(async {
|
2020-06-02 11:12:28 +00:00
|
|
|
/// let schema = Schema::new(QueryRoot, EmptyMutation, EmptySubscription);
|
|
|
|
///
|
2020-10-12 02:17:05 +00:00
|
|
|
/// assert_eq!(schema.execute("{ numbers(first: 2) { edges { node diff } } }").await.into_result().unwrap().data, value!({
|
2020-06-02 11:12:28 +00:00
|
|
|
/// "numbers": {
|
|
|
|
/// "edges": [
|
|
|
|
/// {"node": 0, "diff": 10000},
|
|
|
|
/// {"node": 1, "diff": 9999},
|
|
|
|
/// ]
|
|
|
|
/// },
|
|
|
|
/// }));
|
|
|
|
///
|
2020-10-12 02:17:05 +00:00
|
|
|
/// assert_eq!(schema.execute("{ numbers(last: 2) { edges { node diff } } }").await.into_result().unwrap().data, value!({
|
2020-06-02 11:12:28 +00:00
|
|
|
/// "numbers": {
|
|
|
|
/// "edges": [
|
|
|
|
/// {"node": 9998, "diff": 2},
|
|
|
|
/// {"node": 9999, "diff": 1},
|
|
|
|
/// ]
|
|
|
|
/// },
|
|
|
|
/// }));
|
2021-03-12 04:47:24 +00:00
|
|
|
/// });
|
2020-06-02 11:12:28 +00:00
|
|
|
/// ```
|
2021-11-13 13:41:58 +00:00
|
|
|
pub async fn query<Cursor, Node, ConnectionFields, EdgeFields, F, R, E>(
|
2020-06-02 09:43:13 +00:00
|
|
|
after: Option<String>,
|
|
|
|
before: Option<String>,
|
|
|
|
first: Option<i32>,
|
|
|
|
last: Option<i32>,
|
2020-06-06 02:10:10 +00:00
|
|
|
f: F,
|
Rework errors
This completely overhauls the error system used in async-graphql.
- `Error` has been renamed to `ServerError` and `FieldError` has been
renamed to just `Error`. This is because `FieldError` is by far the most
common error that users will have to use so it makes sense to use the
most obvious error name. Also, the current name didn't make sense as it
was used for things other than field errors, such as the data callback
for websockets.
- `ServerError` has been made completely opaque. Before it was an enum
of all the possible errors, but now it just contains an error message,
the locations, the path and extensions. It is a shame that we lose
information, it makes more sense as _conceptually_ GraphQL does not
provide that information. It also frees us to change the internals of
async-graphql a lot more.
- The path of errors is no longer an opaque JSON value but a regular
type, `Vec<PathSegment>`. The type duplication of `PathSegment` and
`QueryPathSegment` is unfortunate, I plan to work on this in the future.
- Now that `ServerError` is opaque, `RuleError` has been removed from
the public API, making it simpler.
- Additionally `QueryError` has been completely removed. Instead the
error messages are constructed ad-hoc; I took care to never repeat an
error message.
- Instead of constructing field-not-found errors inside the
implementations of field resolvers they now return `Option`s, where a
`None` value is representative of the field not being found.
- As an unfortunate consequence of the last change, self-referential
types based on the output of a subscription resolver can no longer be
created. This does not mean anything for users, but causes lifetime
issues in the implementation of merged objects. I fixed it with a bit of
a hack, but this'll have to be looked into further.
- `InputValueError` now has a generic parameter - it's kind of weird but
it's necessary for ergonomics. It also improves error messages.
- The `ErrorExtensions` trait has been removed. I didn't think the
`extend` method was necessary since `From` impls exist. But the
ergonomics are still there with a new trait `ExtendError`, which
is implemented for both errors and results.
- `Response` now supports serializing multiple errors. This allows for
nice things like having multiple validation errors not be awkwardly
shoved into a single error.
- When an error occurs in execution, data is sent as `null`. This is
slightly more compliant with the spec but the algorithm described in
<https://spec.graphql.org/June2018/#sec-Errors-and-Non-Nullability> has
yet to be implemented.
2020-09-29 19:06:44 +00:00
|
|
|
) -> Result<Connection<Cursor, Node, ConnectionFields, EdgeFields>>
|
2020-06-02 09:43:13 +00:00
|
|
|
where
|
|
|
|
Cursor: CursorType + Send + Sync,
|
|
|
|
<Cursor as CursorType>::Error: Display + Send + Sync + 'static,
|
2020-06-06 00:00:21 +00:00
|
|
|
F: FnOnce(Option<Cursor>, Option<Cursor>, Option<usize>, Option<usize>) -> R,
|
2021-11-13 13:41:58 +00:00
|
|
|
R: Future<Output = Result<Connection<Cursor, Node, ConnectionFields, EdgeFields>, E>>,
|
|
|
|
E: Into<Error>,
|
2020-06-02 09:43:13 +00:00
|
|
|
{
|
|
|
|
if first.is_some() && last.is_some() {
|
|
|
|
return Err("The \"first\" and \"last\" parameters cannot exist at the same time".into());
|
|
|
|
}
|
|
|
|
|
|
|
|
let first = match first {
|
|
|
|
Some(first) if first < 0 => {
|
2020-06-15 04:06:15 +00:00
|
|
|
return Err("The \"first\" parameter must be a non-negative number".into());
|
2020-06-02 09:43:13 +00:00
|
|
|
}
|
|
|
|
Some(first) => Some(first as usize),
|
|
|
|
None => None,
|
|
|
|
};
|
|
|
|
|
|
|
|
let last = match last {
|
|
|
|
Some(last) if last < 0 => {
|
2020-06-15 04:06:15 +00:00
|
|
|
return Err("The \"last\" parameter must be a non-negative number".into());
|
2020-06-02 09:43:13 +00:00
|
|
|
}
|
|
|
|
Some(last) => Some(last as usize),
|
|
|
|
None => None,
|
|
|
|
};
|
|
|
|
|
|
|
|
let before = match before {
|
|
|
|
Some(before) => Some(Cursor::decode_cursor(&before)?),
|
|
|
|
None => None,
|
|
|
|
};
|
|
|
|
|
|
|
|
let after = match after {
|
|
|
|
Some(after) => Some(Cursor::decode_cursor(&after)?),
|
|
|
|
None => None,
|
|
|
|
};
|
|
|
|
|
2021-11-13 13:41:58 +00:00
|
|
|
f(after, before, first, last).await.map_err(Into::into)
|
2020-06-02 09:43:13 +00:00
|
|
|
}
|