-
Notifications
You must be signed in to change notification settings - Fork 428
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- implement `IntoFieldError` for `anyhow::Error` - add `anyhow` and `backtrace` Cargo features
- Loading branch information
Showing
6 changed files
with
144 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| //! GraphQL support for [`anyhow::Error`]. | ||
| //! | ||
| //! # Example | ||
| //! | ||
| //! ```rust | ||
| //! # use std::backtrace::Backtrace; | ||
| //! use anyhow::anyhow; | ||
| //! # use juniper::graphql_object; | ||
| //! | ||
| //! struct Root; | ||
| //! | ||
| //! #[graphql_object] | ||
| //! impl Root { | ||
| //! fn err() -> anyhow::Result<i32> { | ||
| //! Err(anyhow!("errored!")) | ||
| //! } | ||
| //! } | ||
| //! ``` | ||
| //! | ||
| //! # Backtrace | ||
| //! | ||
| //! Backtrace is supported in the same way as [`anyhow`] crate does: | ||
| //! > If using the nightly channel, or stable with `features = ["backtrace"]`, a backtrace is | ||
| //! > captured and printed with the error if the underlying error type does not already provide its | ||
| //! > own. In order to see backtraces, they must be enabled through the environment variables | ||
| //! > described in [`std::backtrace`]: | ||
| //! > - If you want panics and errors to both have backtraces, set `RUST_BACKTRACE=1`; | ||
| //! > - If you want only errors to have backtraces, set `RUST_LIB_BACKTRACE=1`; | ||
| //! > - If you want only panics to have backtraces, set `RUST_BACKTRACE=1` and | ||
| //! > `RUST_LIB_BACKTRACE=0`. | ||
| use crate::{FieldError, IntoFieldError, ScalarValue, Value}; | ||
|
|
||
| impl<S: ScalarValue> IntoFieldError<S> for anyhow::Error { | ||
| fn into_field_error(self) -> FieldError<S> { | ||
| #[cfg(any(nightly, feature = "backtrace"))] | ||
| let extensions = { | ||
| let backtrace = self.backtrace().to_string(); | ||
| if backtrace == "disabled backtrace" { | ||
| Value::Null | ||
| } else { | ||
| let mut obj = crate::value::Object::with_capacity(1); | ||
| _ = obj.add_field( | ||
| "backtrace", | ||
| Value::List( | ||
| backtrace | ||
| .split('\n') | ||
| .map(|line| Value::Scalar(line.to_owned().into())) | ||
| .collect(), | ||
| ), | ||
| ); | ||
| Value::Object(obj) | ||
| } | ||
| }; | ||
| #[cfg(not(any(nightly, feature = "backtrace")))] | ||
| let extensions = Value::Null; | ||
|
|
||
| FieldError::new(self, extensions) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use std::env; | ||
|
|
||
| use anyhow::anyhow; | ||
| use serial_test::serial; | ||
|
|
||
| use crate::{ | ||
| execute, graphql_object, graphql_value, graphql_vars, parser::SourcePosition, | ||
| EmptyMutation, EmptySubscription, RootNode, | ||
| }; | ||
|
|
||
| #[tokio::test] | ||
| #[serial] | ||
| async fn simple() { | ||
| struct Root; | ||
|
|
||
| #[graphql_object] | ||
| impl Root { | ||
| fn err() -> anyhow::Result<i32> { | ||
| Err(anyhow!("errored!")) | ||
| } | ||
| } | ||
|
|
||
| let prev_env = env::var("RUST_BACKTRACE").ok(); | ||
| env::set_var("RUST_BACKTRACE", "1"); | ||
|
|
||
| const DOC: &str = r#"{ | ||
| err | ||
| }"#; | ||
|
|
||
| let schema = RootNode::new( | ||
| Root, | ||
| EmptyMutation::<()>::new(), | ||
| EmptySubscription::<()>::new(), | ||
| ); | ||
|
|
||
| let res = execute(DOC, None, &schema, &graphql_vars! {}, &()).await; | ||
|
|
||
| assert!(res.is_ok(), "failed: {:?}", res.unwrap_err()); | ||
|
|
||
| let (val, errs) = res.unwrap(); | ||
|
|
||
| assert_eq!(val, graphql_value!(null)); | ||
| assert_eq!(errs.len(), 1, "too many errors: {errs:?}"); | ||
|
|
||
| let err = errs.first().unwrap(); | ||
|
|
||
| assert_eq!(*err.location(), SourcePosition::new(14, 1, 12)); | ||
| assert_eq!(err.path(), &["err"]); | ||
|
|
||
| let err = err.error(); | ||
|
|
||
| assert_eq!(err.message(), "errored!"); | ||
| #[cfg(not(any(nightly, feature = "backtrace")))] | ||
| assert_eq!(err.extensions(), &graphql_value!(null)); | ||
| #[cfg(any(nightly, feature = "backtrace"))] | ||
| assert_eq!( | ||
| err.extensions() | ||
| .as_object_value() | ||
| .map(|ext| ext.contains_field("backtrace")), | ||
| Some(true), | ||
| "no `backtrace` in extensions: {err:?}", | ||
| ); | ||
|
|
||
| if let Some(val) = prev_env { | ||
| env::set_var("RUST_BACKTRACE", val); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters