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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use crate::{Pos, QueryPathNode, Value};
use std::fmt::{Debug, Display};
use thiserror::Error;

/// An error in the format of an input value.
#[derive(Debug)]
pub enum InputValueError {
    /// Custom input value parsing error.
    Custom(String),

    /// The type of input value does not match the expectation. Contains the value that was found.
    ExpectedType(Value),
}

impl<T: Display> From<T> for InputValueError {
    fn from(err: T) -> Self {
        InputValueError::Custom(err.to_string())
    }
}

impl InputValueError {
    /// Convert this error to a regular `Error` type.
    pub fn into_error(self, pos: Pos, expected_type: String) -> Error {
        match self {
            InputValueError::Custom(reason) => Error::Query {
                pos,
                path: None,
                err: QueryError::ParseInputValue { reason },
            },
            InputValueError::ExpectedType(value) => Error::Query {
                pos,
                path: None,
                err: QueryError::ExpectedInputType {
                    expect: expected_type,
                    actual: value,
                },
            },
        }
    }
}

/// An alias for `Result<T, InputValueError>`.
pub type InputValueResult<T> = std::result::Result<T, InputValueError>;

/// An error in a field resolver.
#[derive(Clone, Debug)]
pub struct FieldError(pub String, pub Option<serde_json::Value>);

impl FieldError {
    #[doc(hidden)]
    pub fn into_error(self, pos: Pos) -> Error {
        Error::Query {
            pos,
            path: None,
            err: QueryError::FieldError {
                err: self.0,
                extended_error: self.1,
            },
        }
    }

    #[doc(hidden)]
    pub fn into_error_with_path(self, pos: Pos, path: Option<&QueryPathNode<'_>>) -> Error {
        Error::Query {
            pos,
            path: path.and_then(|path| serde_json::to_value(path).ok()),
            err: QueryError::FieldError {
                err: self.0,
                extended_error: self.1,
            },
        }
    }
}

/// An alias for `Result<T, InputValueError>`.
pub type FieldResult<T> = std::result::Result<T, FieldError>;

impl<E: Display> From<E> for FieldError {
    fn from(err: E) -> Self {
        FieldError(format!("{}", err), None)
    }
}

/// An error which can be extended into a `FieldError`.
pub trait ErrorExtensions: Sized {
    /// Convert the error to a `FieldError`.
    fn extend(&self) -> FieldError;

    /// Add extensions to the error, using a callback to make the extensions.
    fn extend_with<C>(self, cb: C) -> FieldError
    where
        C: FnOnce(&Self) -> serde_json::Value,
    {
        let name = self.extend().0;

        if let Some(mut base) = self.extend().1 {
            let mut cb_res = cb(&self);
            if let Some(base_map) = base.as_object_mut() {
                if let Some(cb_res_map) = cb_res.as_object_mut() {
                    base_map.append(cb_res_map);
                }
                return FieldError(name, Some(serde_json::json!(base_map)));
            } else {
                return FieldError(name, Some(cb_res));
            }
        }

        FieldError(name, Some(cb(&self)))
    }
}

impl ErrorExtensions for FieldError {
    fn extend(&self) -> FieldError {
        self.clone()
    }
}

// implementing for &E instead of E gives the user the possibility to implement for E which does
// not conflict with this implementation acting as a fallback.
impl<E: std::fmt::Display> ErrorExtensions for &E {
    fn extend(&self) -> FieldError {
        FieldError(format!("{}", self), None)
    }
}

/// Extend a `Result`'s error value with [`ErrorExtensions`](trait.ErrorExtensions.html).
pub trait ResultExt<T, E>: Sized {
    /// Extend the error value of the result with the callback.
    fn extend_err<C>(self, cb: C) -> FieldResult<T>
    where
        C: FnOnce(&E) -> serde_json::Value;

    /// Extend the result to a `FieldResult`.
    fn extend(self) -> FieldResult<T>;
}

// This is implemented on E and not &E which means it cannot be used on foreign types.
// (see example).
impl<T, E> ResultExt<T, E> for std::result::Result<T, E>
where
    E: ErrorExtensions + Send + Sync + 'static,
{
    fn extend_err<C>(self, cb: C) -> FieldResult<T>
    where
        C: FnOnce(&E) -> serde_json::Value,
    {
        match self {
            Err(err) => Err(err.extend_with(|e| cb(e))),
            Ok(value) => Ok(value),
        }
    }

    fn extend(self) -> FieldResult<T> {
        match self {
            Err(err) => Err(err.extend()),
            Ok(value) => Ok(value),
        }
    }
}

/// An error processing a GraphQL query.
#[derive(Debug, Error, PartialEq)]
pub enum QueryError {
    /// The feature is not supported.
    #[error("Not supported.")]
    NotSupported,

    /// The actual input type did not match the expected input type.
    #[error("Expected input type \"{expect}\", found {actual}.")]
    ExpectedInputType {
        /// The expected input type.
        expect: String,

        /// The actual input type.
        actual: Value,
    },

    /// Parsing of an input value failed.
    #[error("Failed to parse input value: {reason}")]
    ParseInputValue {
        /// The reason for the failure to resolve.
        reason: String,
    },

    /// A field was not found on an object type.
    #[error("Cannot query field \"{field_name}\" on type \"{object}\".")]
    FieldNotFound {
        /// Field name
        field_name: String,

        /// Object name
        object: String,
    },

    /// An operation was missing from the query.
    #[error("Missing operation")]
    MissingOperation,

    /// The operation name was unknown.
    #[error("Unknown operation named \"{name}\"")]
    UnknownOperationNamed {
        /// Operation name for query.
        name: String,
    },

    /// The user attempted to query an object without selecting any subfields.
    #[error("Type \"{object}\" must have a selection of subfields.")]
    MustHaveSubFields {
        /// Object name
        object: String,
    },

    /// The schema does not have mutations.
    #[error("Schema is not configured for mutations.")]
    NotConfiguredMutations,

    /// The schema does not have subscriptions.
    #[error("Schema is not configured for subscriptions.")]
    NotConfiguredSubscriptions,

    /// The value does not exist in the enum.
    #[error("Invalid value for enum \"{ty}\".")]
    InvalidEnumValue {
        /// Enum type name
        ty: String,

        /// Enum value
        value: String,
    },

    /// A required field in an input object was not present.
    #[error("Required field \"{field_name}\" for InputObject \"{object}\" does not exist.")]
    RequiredField {
        /// Field name
        field_name: String,

        /// Object name
        object: &'static str,
    },

    /// A variable is used but not defined.
    #[error("Variable \"${var_name}\" is not defined")]
    VarNotDefined {
        /// Variable name
        var_name: String,
    },

    /// A directive was required but not provided.
    #[error(
        "Directive \"{directive}\" argument \"{arg_name}\" of type \"{arg_type}\" is required, but it was not provided."
    )]
    RequiredDirectiveArgs {
        /// Directive name
        directive: &'static str,

        /// Argument name
        arg_name: &'static str,

        /// Argument type
        arg_type: &'static str,
    },

    /// An unknown directive name was encountered.
    #[error("Unknown directive \"{name}\".")]
    UnknownDirective {
        /// Directive name
        name: String,
    },

    /// An unknown fragment was encountered.
    #[error("Unknown fragment \"{name}\".")]
    UnknownFragment {
        /// Fragment name
        name: String,
    },

    /// The query was too complex.
    // TODO: Expand on this
    #[error("Too complex")]
    TooComplex,

    /// The query was nested too deep.
    #[error("Too deep")]
    TooDeep,

    /// A field handler errored.
    #[error("Failed to resolve field: {err}")]
    FieldError {
        /// The error description.
        err: String,
        /// Extensions to the error provided through the [`ErrorExtensions`](trait.ErrorExtensions)
        /// or [`ResultExt`](trait.ResultExt) traits.
        extended_error: Option<serde_json::Value>,
    },

    /// Entity not found.
    #[error("Entity not found")]
    EntityNotFound,

    /// "__typename" must be an existing string.
    #[error("\"__typename\" must be an existing string")]
    TypeNameNotExists,
}

impl QueryError {
    /// Convert this error to a regular `Error` type.
    pub fn into_error(self, pos: Pos) -> Error {
        Error::Query {
            pos,
            path: None,
            err: self,
        }
    }
}

/// An error parsing the request.
#[derive(Debug, Error)]
pub enum ParseRequestError {
    /// An IO error occurred.
    #[error("{0}")]
    Io(#[from] std::io::Error),

    /// The request's syntax was invalid.
    #[error("Invalid request: {0}")]
    InvalidRequest(serde_json::Error),

    /// The request's files map was invalid.
    #[error("Invalid files map: {0}")]
    InvalidFilesMap(serde_json::Error),

    /// The request's multipart data was invalid.
    #[error("Invalid multipart data")]
    #[cfg(feature = "multipart")]
    InvalidMultipart(multer::Error),

    /// Missing "operators" part for multipart request.
    #[error("Missing \"operators\" part")]
    MissingOperatorsPart,

    /// Missing "map" part for multipart request.
    #[error("Missing \"map\" part")]
    MissingMapPart,

    /// It's not an upload operation
    #[error("It's not an upload operation")]
    NotUpload,

    /// Files were missing the request.
    #[error("Missing files")]
    MissingFiles,

    /// The request's payload is too large, and this server rejected it.
    #[error("Payload too large")]
    PayloadTooLarge,
}

#[cfg(feature = "multipart")]
impl From<multer::Error> for ParseRequestError {
    fn from(err: multer::Error) -> Self {
        match err {
            multer::Error::FieldSizeExceeded { .. } | multer::Error::StreamSizeExceeded { .. } => {
                ParseRequestError::PayloadTooLarge
            }
            _ => ParseRequestError::InvalidMultipart(err),
        }
    }
}

/// Verification error.
#[derive(Debug, PartialEq)]
pub struct RuleError {
    /// Location of this error in query string.
    pub locations: Vec<Pos>,

    /// A description of this error.
    pub message: String,
}

/// An error serving a GraphQL query.
#[derive(Debug, Error, PartialEq)]
pub enum Error {
    /// Parsing the query failed.
    #[error("Parse error: {0}")]
    Parse(#[from] crate::parser::Error),

    /// Processing the query failed.
    #[error("Query error: {err}")]
    Query {
        /// The position at which the processing failed.
        pos: Pos,

        /// Node path.
        path: Option<serde_json::Value>,

        /// The query error.
        err: QueryError,
    },

    /// The query statement verification failed.
    #[error("Rule error")]
    Rule {
        /// List of errors.
        errors: Vec<RuleError>,
    },
}