|
| 1 | +//! GraphQL support for [`anyhow::Error`]. |
| 2 | +//! |
| 3 | +//! # Example |
| 4 | +//! |
| 5 | +//! ```rust |
| 6 | +//! # use std::backtrace::Backtrace; |
| 7 | +//! use anyhow::anyhow; |
| 8 | +//! # use juniper::graphql_object; |
| 9 | +//! |
| 10 | +//! struct Root; |
| 11 | +//! |
| 12 | +//! #[graphql_object] |
| 13 | +//! impl Root { |
| 14 | +//! fn err() -> anyhow::Result<i32> { |
| 15 | +//! Err(anyhow!("errored!")) |
| 16 | +//! } |
| 17 | +//! } |
| 18 | +//! ``` |
| 19 | +//! |
| 20 | +//! # Backtrace |
| 21 | +//! |
| 22 | +//! Backtrace is supported in the same way as [`anyhow`] crate does: |
| 23 | +//! > If using the nightly channel, or stable with `features = ["backtrace"]`, a backtrace is |
| 24 | +//! > captured and printed with the error if the underlying error type does not already provide its |
| 25 | +//! > own. In order to see backtraces, they must be enabled through the environment variables |
| 26 | +//! > described in [`std::backtrace`]: |
| 27 | +//! > - If you want panics and errors to both have backtraces, set `RUST_BACKTRACE=1`; |
| 28 | +//! > - If you want only errors to have backtraces, set `RUST_LIB_BACKTRACE=1`; |
| 29 | +//! > - If you want only panics to have backtraces, set `RUST_BACKTRACE=1` and |
| 30 | +//! > `RUST_LIB_BACKTRACE=0`. |
| 31 | +
|
| 32 | +use crate::{FieldError, IntoFieldError, ScalarValue, Value}; |
| 33 | + |
| 34 | +impl<S: ScalarValue> IntoFieldError<S> for anyhow::Error { |
| 35 | + fn into_field_error(self) -> FieldError<S> { |
| 36 | + #[cfg(any(nightly, feature = "backtrace"))] |
| 37 | + let extensions = { |
| 38 | + let backtrace = self.backtrace().to_string(); |
| 39 | + if backtrace == "disabled backtrace" { |
| 40 | + Value::Null |
| 41 | + } else { |
| 42 | + let mut obj = crate::value::Object::with_capacity(1); |
| 43 | + _ = obj.add_field( |
| 44 | + "backtrace", |
| 45 | + Value::List( |
| 46 | + backtrace |
| 47 | + .split('\n') |
| 48 | + .map(|line| Value::Scalar(line.to_owned().into())) |
| 49 | + .collect(), |
| 50 | + ), |
| 51 | + ); |
| 52 | + Value::Object(obj) |
| 53 | + } |
| 54 | + }; |
| 55 | + #[cfg(not(any(nightly, feature = "backtrace")))] |
| 56 | + let extensions = Value::Null; |
| 57 | + |
| 58 | + FieldError::new(self, extensions) |
| 59 | + } |
| 60 | +} |
| 61 | + |
| 62 | +#[cfg(test)] |
| 63 | +mod test { |
| 64 | + use std::env; |
| 65 | + |
| 66 | + use anyhow::anyhow; |
| 67 | + use serial_test::serial; |
| 68 | + |
| 69 | + use crate::{ |
| 70 | + execute, graphql_object, graphql_value, graphql_vars, parser::SourcePosition, |
| 71 | + EmptyMutation, EmptySubscription, RootNode, |
| 72 | + }; |
| 73 | + |
| 74 | + #[tokio::test] |
| 75 | + #[serial] |
| 76 | + async fn simple() { |
| 77 | + struct Root; |
| 78 | + |
| 79 | + #[graphql_object] |
| 80 | + impl Root { |
| 81 | + fn err() -> anyhow::Result<i32> { |
| 82 | + Err(anyhow!("errored!")) |
| 83 | + } |
| 84 | + } |
| 85 | + |
| 86 | + let prev_env = env::var("RUST_BACKTRACE").ok(); |
| 87 | + env::set_var("RUST_BACKTRACE", "1"); |
| 88 | + |
| 89 | + const DOC: &str = r#"{ |
| 90 | + err |
| 91 | + }"#; |
| 92 | + |
| 93 | + let schema = RootNode::new( |
| 94 | + Root, |
| 95 | + EmptyMutation::<()>::new(), |
| 96 | + EmptySubscription::<()>::new(), |
| 97 | + ); |
| 98 | + |
| 99 | + let res = execute(DOC, None, &schema, &graphql_vars! {}, &()).await; |
| 100 | + |
| 101 | + assert!(res.is_ok(), "failed: {:?}", res.unwrap_err()); |
| 102 | + |
| 103 | + let (val, errs) = res.unwrap(); |
| 104 | + |
| 105 | + assert_eq!(val, graphql_value!(null)); |
| 106 | + assert_eq!(errs.len(), 1, "too many errors: {errs:?}"); |
| 107 | + |
| 108 | + let err = errs.first().unwrap(); |
| 109 | + |
| 110 | + assert_eq!(*err.location(), SourcePosition::new(14, 1, 12)); |
| 111 | + assert_eq!(err.path(), &["err"]); |
| 112 | + |
| 113 | + let err = err.error(); |
| 114 | + |
| 115 | + assert_eq!(err.message(), "errored!"); |
| 116 | + #[cfg(not(any(nightly, feature = "backtrace")))] |
| 117 | + assert_eq!(err.extensions(), &graphql_value!(null)); |
| 118 | + #[cfg(any(nightly, feature = "backtrace"))] |
| 119 | + assert_eq!( |
| 120 | + err.extensions() |
| 121 | + .as_object_value() |
| 122 | + .map(|ext| ext.contains_field("backtrace")), |
| 123 | + Some(true), |
| 124 | + "no `backtrace` in extensions: {err:?}", |
| 125 | + ); |
| 126 | + |
| 127 | + if let Some(val) = prev_env { |
| 128 | + env::set_var("RUST_BACKTRACE", val); |
| 129 | + } |
| 130 | + } |
| 131 | +} |
0 commit comments