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
use crate::registry::Registry;
use crate::{registry, Context, ContextSelectionSet, Error, QueryError, Result, ID};
use graphql_parser::query::{Field, Value};
use graphql_parser::Pos;
use std::borrow::Cow;
use std::future::Future;
use std::pin::Pin;

/// Represents a GraphQL type
///
/// All GraphQL types implement this trait, such as `Scalar`, `Object`, `Union` ...
pub trait Type {
    /// Type the name.
    fn type_name() -> Cow<'static, str>;

    /// Qualified typename.
    fn qualified_type_name() -> String {
        format!("{}!", Self::type_name())
    }

    /// Introspection type name
    ///
    /// Is the return value of field `__typename`, the interface and union should return the current type, and the others return `Type::type_name`.
    fn introspection_type_name(&self) -> Cow<'static, str> {
        Self::type_name()
    }

    /// Create type information in the registry and return qualified typename.
    fn create_type_info(registry: &mut registry::Registry) -> String;

    /// Returns a `GlobalID` that is unique among all types.
    fn global_id(id: ID) -> ID {
        base64::encode(format!("{}:{}", Self::type_name(), id)).into()
    }

    /// Parse `GlobalID`.
    fn from_global_id(id: ID) -> Option<ID> {
        let v: Vec<&str> = id.splitn(2, ':').collect();
        if v.len() != 2 {
            return None;
        }
        if v[0] != Self::type_name() {
            return None;
        }
        Some(v[1].to_string().into())
    }
}

/// Represents a GraphQL input value
pub trait InputValueType: Type + Sized {
    /// Parse from `Value`
    fn parse(value: &Value) -> Option<Self>;
}

/// Represents a GraphQL output value
#[async_trait::async_trait]
pub trait OutputValueType: Type {
    /// Resolve an output value to `serde_json::Value`.
    async fn resolve(
        value: &Self,
        ctx: &ContextSelectionSet<'_>,
        pos: Pos,
    ) -> Result<serde_json::Value>;
}

#[allow(missing_docs)]
pub type BoxFieldFuture<'a> =
    Pin<Box<dyn Future<Output = Result<(String, serde_json::Value)>> + 'a + Send>>;

/// Represents a GraphQL object
#[async_trait::async_trait]
pub trait ObjectType: OutputValueType {
    /// This function returns true of type `EmptyMutation` only
    #[doc(hidden)]
    fn is_empty() -> bool {
        false
    }

    /// Resolves a field value and outputs it as a json value `serde_json::Value`.
    async fn resolve_field(&self, ctx: &Context<'_>, field: &Field) -> Result<serde_json::Value>;

    /// Collect the fields with the `name` inline object
    fn collect_inline_fields<'a>(
        &'a self,
        name: &str,
        pos: Pos,
        _ctx: &ContextSelectionSet<'a>,
        _futures: &mut Vec<BoxFieldFuture<'a>>,
    ) -> Result<()> {
        Err(Error::Query {
            pos,
            path: None,
            err: QueryError::UnrecognizedInlineFragment {
                object: Self::type_name().to_string(),
                name: name.to_string(),
            },
        })
    }
}

/// Represents a GraphQL input object
pub trait InputObjectType: InputValueType {}

/// Represents a GraphQL scalar
///
/// You can implement the trait to create a custom scalar.
///
/// # Examples
///
/// ```rust
/// use async_graphql::*;
///
/// struct MyInt(i32);
///
/// impl Scalar for MyInt {
///     fn type_name() -> &'static str {
///         "MyInt"
///     }
///
///     fn parse(value: &Value) -> Option<Self> {
///         if let Value::Int(n) = value {
///             Some(MyInt(n.as_i64().unwrap() as i32))
///         } else {
///             None
///         }
///     }
///
///     fn to_json(&self) -> Result<serde_json::Value> {
///         Ok(self.0.into())
///     }
/// }
///
/// impl_scalar!(MyInt); // // Don't forget this one
/// ```
pub trait Scalar: Sized + Send {
    /// The type name of a scalar.
    fn type_name() -> &'static str;

    /// The description of a scalar.
    fn description() -> Option<&'static str> {
        None
    }

    /// Parse a scalar value, return `Some(Self)` if successful, otherwise return `None`.
    fn parse(value: &Value) -> Option<Self>;

    /// Checks for a valid scalar value.
    ///
    /// The default implementation is to try to parse it, and in some cases you can implement this on your own to improve performance.
    fn is_valid(value: &Value) -> bool {
        Self::parse(value).is_some()
    }

    /// Convert the scalar value to json value.
    fn to_json(&self) -> Result<serde_json::Value>;
}

#[macro_export]
#[doc(hidden)]
macro_rules! impl_scalar_internal {
    ($ty:ty) => {
        impl crate::Type for $ty {
            fn type_name() -> std::borrow::Cow<'static, str> {
                std::borrow::Cow::Borrowed(<$ty as crate::Scalar>::type_name())
            }

            fn create_type_info(registry: &mut crate::registry::Registry) -> String {
                registry.create_type::<$ty, _>(|_| crate::registry::Type::Scalar {
                    name: <$ty as crate::Scalar>::type_name().to_string(),
                    description: <$ty>::description(),
                    is_valid: |value| <$ty as crate::Scalar>::is_valid(value),
                })
            }
        }

        impl crate::InputValueType for $ty {
            fn parse(value: &crate::Value) -> Option<Self> {
                <$ty as crate::Scalar>::parse(value)
            }
        }

        #[allow(clippy::ptr_arg)]
        #[async_trait::async_trait]
        impl crate::OutputValueType for $ty {
            async fn resolve(
                value: &Self,
                _: &crate::ContextSelectionSet<'_>,
                _pos: crate::Pos,
            ) -> crate::Result<serde_json::Value> {
                value.to_json()
            }
        }
    };
}

/// After implementing the `Scalar` trait, you must call this macro to implement some additional traits.
#[macro_export]
macro_rules! impl_scalar {
    ($ty:ty) => {
        impl async_graphql::Type for $ty {
            fn type_name() -> std::borrow::Cow<'static, str> {
                std::borrow::Cow::Borrowed(<$ty as async_graphql::Scalar>::type_name())
            }

            fn create_type_info(registry: &mut async_graphql::registry::Registry) -> String {
                registry.create_type::<$ty, _>(|_| async_graphql::registry::Type::Scalar {
                    name: <$ty as async_graphql::Scalar>::type_name().to_string(),
                    description: <$ty>::description(),
                    is_valid: |value| <$ty as async_graphql::Scalar>::is_valid(value),
                })
            }
        }

        impl async_graphql::InputValueType for $ty {
            fn parse(value: &async_graphql::Value) -> Option<Self> {
                <$ty as async_graphql::Scalar>::parse(value)
            }
        }

        #[allow(clippy::ptr_arg)]
        #[async_graphql::async_trait::async_trait]
        impl async_graphql::OutputValueType for $ty {
            async fn resolve(
                value: &Self,
                _: &async_graphql::ContextSelectionSet<'_>,
                _pos: async_graphql::Pos,
            ) -> async_graphql::Result<serde_json::Value> {
                value.to_json()
            }
        }
    };
}

impl<T: Type + Send + Sync> Type for &T {
    fn type_name() -> Cow<'static, str> {
        T::type_name()
    }

    fn create_type_info(registry: &mut Registry) -> String {
        T::create_type_info(registry)
    }
}

#[async_trait::async_trait]
impl<T: OutputValueType + Send + Sync> OutputValueType for &T {
    #[allow(clippy::trivially_copy_pass_by_ref)]
    async fn resolve(
        value: &Self,
        ctx: &ContextSelectionSet<'_>,
        pos: Pos,
    ) -> Result<serde_json::Value> {
        T::resolve(*value, ctx, pos).await
    }
}