Preserve input body when attribute macro expansion fails (#1245, #1244)

tyranron · web-flow · commit f363b0d79ef0 · 2024-01-30T16:41:11.000+01:00
diff --git a/juniper_codegen/CHANGELOG.md b/juniper_codegen/CHANGELOG.md
@@ -10,7 +10,7 @@ All user visible changes to `juniper_codegen` crate will be documented in this f
 
 ### BC Breaks
 
-- `#[graphql_object]` and `#[graphql_subscription]` expansions now preserve defined `impl` blocks "as is" and reuse defined methods in opaque way. ([#971])
+- `#[graphql_object]` and `#[graphql_subscription]` expansions now preserve defined `impl` blocks "as is" and reuse defined methods in opaque way. ([#971], [#1245])
 - Renamed `rename = "<policy>"` attribute argument to `rename_all = "<policy>"` (following `serde` style). ([#971])
 - Redesigned `#[graphql_interface]` macro: ([#1009])
     - Removed support for `dyn` attribute argument (interface values as trait objects).
@@ -61,6 +61,7 @@ All user visible changes to `juniper_codegen` crate will be documented in this f
 [#1051]: /../../issues/1051
 [#1054]: /../../pull/1054
 [#1157]: /../../pull/1157
+[#1245]: /../../pull/1245
 
 
 
diff --git a/juniper_codegen/src/common/diagnostic.rs b/juniper_codegen/src/common/diagnostic.rs
@@ -2,7 +2,9 @@ use std::fmt;
 
 use proc_macro2::Span;
 
-pub(crate) use self::polyfill::{abort_if_dirty, emit_error, entry_point, Diagnostic, ResultExt};
+pub(crate) use self::polyfill::{
+    abort_if_dirty, emit_error, entry_point, entry_point_with_preserved_body, Diagnostic, ResultExt,
+};
 
 /// URL of the GraphQL specification (October 2021 Edition).
 pub(crate) const SPEC_URL: &str = "https://spec.graphql.org/October2021";
@@ -258,6 +260,18 @@ mod polyfill {
 
     /// This is the entry point for a macro to support [`Diagnostic`]s.
     pub(crate) fn entry_point<F>(f: F) -> proc_macro::TokenStream
+    where
+        F: FnOnce() -> proc_macro::TokenStream + UnwindSafe,
+    {
+        entry_point_with_preserved_body(TokenStream::new(), f)
+    }
+
+    /// This is the entry point for an attribute macro to support [`Diagnostic`]s, while preserving
+    /// the `body` input [`proc_macro::TokenStream`] on errors.
+    pub(crate) fn entry_point_with_preserved_body<F>(
+        body: impl Into<TokenStream>,
+        f: F,
+    ) -> proc_macro::TokenStream
     where
         F: FnOnce() -> proc_macro::TokenStream + UnwindSafe,
     {
@@ -267,7 +281,9 @@ mod polyfill {
         ENTERED_ENTRY_POINT.with(|flag| flag.set(flag.get() - 1));
 
         let gen_error = || {
-            quote! { #( #err_storage )* }
+            let body = body.into();
+
+            quote! { #body #( #err_storage )* }
         };
 
         match caught {
diff --git a/juniper_codegen/src/lib.rs b/juniper_codegen/src/lib.rs
@@ -756,7 +756,7 @@ pub fn derive_scalar(input: TokenStream) -> TokenStream {
 /// [`ScalarValue`]: juniper::ScalarValue
 #[proc_macro_attribute]
 pub fn graphql_scalar(attr: TokenStream, body: TokenStream) -> TokenStream {
-    diagnostic::entry_point(|| {
+    diagnostic::entry_point_with_preserved_body(body.clone(), || {
         graphql_scalar::attr::expand(attr.into(), body.into())
             .unwrap_or_abort()
             .into()
@@ -1318,7 +1318,7 @@ pub fn derive_scalar_value(input: TokenStream) -> TokenStream {
 /// [4]: https://doc.rust-lang.org/stable/std/primitive.unit.html
 #[proc_macro_attribute]
 pub fn graphql_interface(attr: TokenStream, body: TokenStream) -> TokenStream {
-    diagnostic::entry_point(|| {
+    diagnostic::entry_point_with_preserved_body(body.clone(), || {
         self::graphql_interface::attr::expand(attr.into(), body.into())
             .unwrap_or_abort()
             .into()
@@ -1825,7 +1825,7 @@ pub fn derive_object(body: TokenStream) -> TokenStream {
 /// [1]: https://spec.graphql.org/October2021#sec-Objects
 #[proc_macro_attribute]
 pub fn graphql_object(attr: TokenStream, body: TokenStream) -> TokenStream {
-    diagnostic::entry_point(|| {
+    diagnostic::entry_point_with_preserved_body(body.clone(), || {
         self::graphql_object::attr::expand(attr.into(), body.into())
             .unwrap_or_abort()
             .into()
@@ -1879,7 +1879,7 @@ pub fn graphql_object(attr: TokenStream, body: TokenStream) -> TokenStream {
 /// [1]: https://spec.graphql.org/October2021#sec-Subscription
 #[proc_macro_attribute]
 pub fn graphql_subscription(attr: TokenStream, body: TokenStream) -> TokenStream {
-    diagnostic::entry_point(|| {
+    diagnostic::entry_point_with_preserved_body(body.clone(), || {
         self::graphql_subscription::attr::expand(attr.into(), body.into())
             .unwrap_or_abort()
             .into()
@@ -2486,7 +2486,7 @@ pub fn derive_union(body: TokenStream) -> TokenStream {
 /// [4]: https://doc.rust-lang.org/stable/std/primitive.unit.html
 #[proc_macro_attribute]
 pub fn graphql_union(attr: TokenStream, body: TokenStream) -> TokenStream {
-    diagnostic::entry_point(|| {
+    diagnostic::entry_point_with_preserved_body(body.clone(), || {
         self::graphql_union::attr::expand(attr.into(), body.into())
             .unwrap_or_abort()
             .into()
diff --git a/tests/codegen/fail/interface/struct/attr_fields_duplicate.stderr b/tests/codegen/fail/interface/struct/attr_fields_duplicate.stderr
@@ -4,3 +4,9 @@ error: GraphQL interface must have a different name for each field
   |
 4 | struct Character {
   | ^^^^^^
+
+error: cannot find attribute `graphql` in this scope
+ --> fail/interface/struct/attr_fields_duplicate.rs:7:7
+  |
+7 |     #[graphql(name = "id")]
+  |       ^^^^^^^
diff --git a/tests/codegen/fail/interface/trait/fields_duplicate.stderr b/tests/codegen/fail/interface/trait/fields_duplicate.stderr
@@ -4,3 +4,9 @@ error: GraphQL interface must have a different name for each field
   |
 4 | trait Character {
   | ^^^^^
+
+error: cannot find attribute `graphql` in this scope
+ --> fail/interface/trait/fields_duplicate.rs:7:7
+  |
+7 |     #[graphql(name = "id")]
+  |       ^^^^^^^
diff --git a/tests/codegen/fail/interface/trait/wrong_syntax.rs b/tests/codegen/fail/interface/trait/wrong_syntax.rs
@@ -0,0 +1,13 @@
+use juniper::graphql_interface;
+
+#[graphql_interface]
+trait Character {
+    fn id(&self) -> &str;
+
+    #[graphql(ignore)]
+    fn id2(&self) -> &str {
+        self.self.id()
+    }
+}
+
+fn main() {}
diff --git a/tests/codegen/fail/interface/trait/wrong_syntax.stderr b/tests/codegen/fail/interface/trait/wrong_syntax.stderr
@@ -0,0 +1,22 @@
+error: #[graphql_interface] attribute is applicable to trait and struct definitions only
+ --> fail/interface/trait/wrong_syntax.rs:3:1
+  |
+3 | #[graphql_interface]
+  | ^^^^^^^^^^^^^^^^^^^^
+  |
+  = note: this error originates in the attribute macro `graphql_interface` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error: cannot find attribute `graphql` in this scope
+ --> fail/interface/trait/wrong_syntax.rs:7:7
+  |
+7 |     #[graphql(ignore)]
+  |       ^^^^^^^
+
+error[E0609]: no field `self` on type `&Self`
+ --> fail/interface/trait/wrong_syntax.rs:9:14
+  |
+4 | trait Character {
+  | --------------- type parameter 'Self' declared here
+...
+9 |         self.self.id()
+  |              ^^^^
diff --git a/tests/codegen/fail/object/attr_field_double_underscored.rs b/tests/codegen/fail/object/attr_field_double_underscored.rs
@@ -3,7 +3,7 @@ use juniper::graphql_object;
 struct ObjA;
 
 #[graphql_object]
-impl Character for ObjA {
+impl ObjA {
     fn __id(&self) -> &str {
         "funA"
     }
diff --git a/tests/codegen/fail/object/attr_field_double_underscored.stderr b/tests/codegen/fail/object/attr_field_double_underscored.stderr
@@ -1,7 +1,6 @@
-error: #[graphql_object] attribute is applicable to non-trait `impl` blocks only
- --> fail/object/attr_field_double_underscored.rs:5:1
+error: All types and directives defined within a schema must not have a name which begins with `__` (two underscores), as this is used exclusively by GraphQL’s introspection system.
+       · note: https://spec.graphql.org/October2021#sec-Schema
+ --> fail/object/attr_field_double_underscored.rs:7:8
   |
-5 | #[graphql_object]
-  | ^^^^^^^^^^^^^^^^^
-  |
-  = note: this error originates in the attribute macro `graphql_object` (in Nightly builds, run with -Z macro-backtrace for more info)
+7 |     fn __id(&self) -> &str {
+  |        ^^^^
diff --git a/tests/codegen/fail/object/attr_fields_duplicate.stderr b/tests/codegen/fail/object/attr_fields_duplicate.stderr
@@ -4,3 +4,9 @@ error: GraphQL object must have a different name for each field
   |
 6 | impl ObjA {
   |      ^^^^
+
+error: cannot find attribute `graphql` in this scope
+  --> fail/object/attr_fields_duplicate.rs:11:7
+   |
+11 |     #[graphql(name = "id")]
+   |       ^^^^^^^
diff --git a/tests/codegen/fail/object/attr_wrong_syntax.rs b/tests/codegen/fail/object/attr_wrong_syntax.rs
@@ -0,0 +1,14 @@
+use juniper::graphql_object;
+
+struct MyObject {
+    my_field: i32,
+}
+
+#[graphql_object]
+impl MyObject {
+    fn my_field(&self) -> i32 {
+        self.self.my_field
+    }
+}
+
+fn main() {}
diff --git a/tests/codegen/fail/object/attr_wrong_syntax.stderr b/tests/codegen/fail/object/attr_wrong_syntax.stderr
@@ -0,0 +1,15 @@
+error: #[graphql_object] attribute is applicable to non-trait `impl` blocks only
+ --> fail/object/attr_wrong_syntax.rs:7:1
+  |
+7 | #[graphql_object]
+  | ^^^^^^^^^^^^^^^^^
+  |
+  = note: this error originates in the attribute macro `graphql_object` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error[E0609]: no field `self` on type `&MyObject`
+  --> fail/object/attr_wrong_syntax.rs:10:14
+   |
+10 |         self.self.my_field
+   |              ^^^^ unknown field
+   |
+   = note: available fields are: `my_field`
diff --git a/tests/codegen/fail/subscription/argument_double_underscored.rs b/tests/codegen/fail/subscription/argument_double_underscored.rs
@@ -1,14 +1,15 @@
-use std::pin::Pin;
+use std::{future, pin::Pin};
 
+use futures::{stream, Stream};
 use juniper::graphql_subscription;
 
-type Stream<'a, I> = Pin<Box<dyn futures::Stream<Item = I> + Send + 'a>>;
+type BoxStream<'a, I> = Pin<Box<dyn Stream<Item = I> + Send + 'a>>;
 
 struct Obj;
 
 #[graphql_subscription]
 impl Obj {
-    async fn id(&self, __num: i32) -> Stream<'static, &'static str> {
+    async fn id(&self, __num: i32) -> BoxStream<'static, &'static str> {
         Box::pin(stream::once(future::ready("funA")))
     }
 }
diff --git a/tests/codegen/fail/subscription/argument_double_underscored.stderr b/tests/codegen/fail/subscription/argument_double_underscored.stderr
@@ -1,6 +1,6 @@
 error: All types and directives defined within a schema must not have a name which begins with `__` (two underscores), as this is used exclusively by GraphQL’s introspection system.
        · note: https://spec.graphql.org/October2021#sec-Schema
-  --> fail/subscription/argument_double_underscored.rs:11:24
+  --> fail/subscription/argument_double_underscored.rs:12:24
    |
-11 |     async fn id(&self, __num: i32) -> Stream<'static, &'static str> {
+12 |     async fn id(&self, __num: i32) -> BoxStream<'static, &'static str> {
    |                        ^^^^^
diff --git a/tests/codegen/fail/subscription/argument_non_input_type.rs b/tests/codegen/fail/subscription/argument_non_input_type.rs
@@ -1,9 +1,9 @@
-use std::pin::Pin;
+use std::{future, pin::Pin};
 
-use futures::{future, stream};
+use futures::{stream, Stream};
 use juniper::{graphql_subscription, GraphQLObject};
 
-type Stream<'a, I> = Pin<Box<dyn futures::Stream<Item = I> + Send + 'a>>;
+type BoxStream<'a, I> = Pin<Box<dyn Stream<Item = I> + Send + 'a>>;
 
 #[derive(GraphQLObject)]
 struct ObjA {
@@ -14,7 +14,7 @@ struct ObjB;
 
 #[graphql_subscription]
 impl ObjB {
-    async fn id(&self, obj: ObjA) -> Stream<'static, &'static str> {
+    async fn id(&self, obj: ObjA) -> BoxStream<'static, &'static str> {
         Box::pin(stream::once(future::ready("funA")))
     }
 }
diff --git a/tests/codegen/fail/subscription/argument_non_input_type.stderr b/tests/codegen/fail/subscription/argument_non_input_type.stderr
@@ -1,15 +1,15 @@
 warning: unused variable: `obj`
   --> fail/subscription/argument_non_input_type.rs:17:24
    |
-17 |     async fn id(&self, obj: ObjA) -> Stream<'static, &'static str> {
+17 |     async fn id(&self, obj: ObjA) -> BoxStream<'static, &'static str> {
    |                        ^^^ help: if this is intentional, prefix it with an underscore: `_obj`
    |
    = note: `#[warn(unused_variables)]` on by default
 
 error[E0277]: the trait bound `ObjA: IsInputType<__S>` is not satisfied
   --> fail/subscription/argument_non_input_type.rs:17:29
    |
-17 |     async fn id(&self, obj: ObjA) -> Stream<'static, &'static str> {
+17 |     async fn id(&self, obj: ObjA) -> BoxStream<'static, &'static str> {
    |                             ^^^^ the trait `IsInputType<__S>` is not implemented for `ObjA`
    |
    = help: the following other types implement trait `IsInputType<S>`:
@@ -29,7 +29,7 @@ error[E0277]: the trait bound `ObjA: FromInputValue<__S>` is not satisfied
 15 | #[graphql_subscription]
    | ----------------------- required by a bound introduced by this call
 16 | impl ObjB {
-17 |     async fn id(&self, obj: ObjA) -> Stream<'static, &'static str> {
+17 |     async fn id(&self, obj: ObjA) -> BoxStream<'static, &'static str> {
    |                             ^^^^ the trait `FromInputValue<__S>` is not implemented for `ObjA`
    |
    = help: the following other types implement trait `FromInputValue<S>`:
@@ -72,7 +72,7 @@ error[E0277]: the trait bound `ObjA: FromInputValue<__S>` is not satisfied
 error[E0277]: the trait bound `ObjA: FromInputValue<__S>` is not satisfied
   --> fail/subscription/argument_non_input_type.rs:17:29
    |
-17 |     async fn id(&self, obj: ObjA) -> Stream<'static, &'static str> {
+17 |     async fn id(&self, obj: ObjA) -> BoxStream<'static, &'static str> {
    |                             ^^^^ the trait `FromInputValue<__S>` is not implemented for `ObjA`
    |
    = help: the following other types implement trait `FromInputValue<S>`:
diff --git a/tests/codegen/fail/subscription/argument_wrong_default_array.rs b/tests/codegen/fail/subscription/argument_wrong_default_array.rs
@@ -1,9 +1,9 @@
-use std::pin::Pin;
+use std::{future, pin::Pin};
 
-use futures::{future, stream};
+use futures::{stream, Stream};
 use juniper::graphql_subscription;
 
-type Stream<'a, I> = Pin<Box<dyn futures::Stream<Item = I> + Send + 'a>>;
+type BoxStream<'a, I> = Pin<Box<dyn Stream<Item = I> + Send + 'a>>;
 
 struct ObjA;
 
@@ -12,7 +12,7 @@ impl ObjA {
     async fn wrong(
         &self,
         #[graphql(default = [true, false, false])] input: [bool; 2],
-    ) -> Stream<'static, bool> {
+    ) -> BoxStream<'static, bool> {
         Box::pin(stream::once(future::ready(input[0])))
     }
 }
diff --git a/tests/codegen/fail/subscription/field_double_underscored.rs b/tests/codegen/fail/subscription/field_double_underscored.rs
@@ -1,14 +1,15 @@
-use std::pin::Pin;
+use std::{future, pin::Pin};
 
+use futures::{stream, Stream};
 use juniper::graphql_subscription;
 
-type Stream<'a, I> = Pin<Box<dyn futures::Stream<Item = I> + Send + 'a>>;
+type BoxStream<'a, I> = Pin<Box<dyn Stream<Item = I> + Send + 'a>>;
 
 struct ObjA;
 
 #[graphql_subscription]
-impl Character for ObjA {
-    async fn __id() -> Stream<'static, &'static str> {
+impl ObjA {
+    async fn __id() -> BoxStream<'static, &'static str> {
         Box::pin(stream::once(future::ready("funA")))
     }
 }
diff --git a/tests/codegen/fail/subscription/field_double_underscored.stderr b/tests/codegen/fail/subscription/field_double_underscored.stderr
@@ -1,7 +1,6 @@
-error: #[graphql_subscription] attribute is applicable to non-trait `impl` blocks only
- --> fail/subscription/field_double_underscored.rs:9:1
-  |
-9 | #[graphql_subscription]
-  | ^^^^^^^^^^^^^^^^^^^^^^^
-  |
-  = note: this error originates in the attribute macro `graphql_subscription` (in Nightly builds, run with -Z macro-backtrace for more info)
+error: All types and directives defined within a schema must not have a name which begins with `__` (two underscores), as this is used exclusively by GraphQL’s introspection system.
+       · note: https://spec.graphql.org/October2021#sec-Schema
+  --> fail/subscription/field_double_underscored.rs:12:14
+   |
+12 |     async fn __id() -> BoxStream<'static, &'static str> {
+   |              ^^^^
diff --git a/tests/codegen/fail/subscription/field_non_output_return_type.rs b/tests/codegen/fail/subscription/field_non_output_return_type.rs
@@ -1,9 +1,9 @@
-use std::pin::Pin;
+use std::{future, pin::Pin};
 
-use futures::{future, stream};
+use futures::{stream, Stream};
 use juniper::{graphql_subscription, GraphQLInputObject};
 
-type Stream<'a, I> = Pin<Box<dyn futures::Stream<Item = I> + Send + 'a>>;
+type BoxStream<'a, I> = Pin<Box<dyn Stream<Item = I> + Send + 'a>>;
 
 #[derive(GraphQLInputObject)]
 struct ObjB {
@@ -14,7 +14,7 @@ struct ObjA;
 
 #[graphql_subscription]
 impl ObjA {
-    async fn id(&self) -> Stream<'static, ObjB> {
+    async fn id(&self) -> BoxStream<'static, ObjB> {
         Box::pin(stream::once(future::ready(ObjB { id: 34 })))
     }
 }
diff --git a/tests/codegen/fail/subscription/field_not_async.rs b/tests/codegen/fail/subscription/field_not_async.rs
diff --git a/tests/codegen/fail/subscription/field_not_async.stderr b/tests/codegen/fail/subscription/field_not_async.stderr
diff --git a/tests/codegen/fail/subscription/fields_duplicate.rs b/tests/codegen/fail/subscription/fields_duplicate.rs
diff --git a/tests/codegen/fail/subscription/fields_duplicate.stderr b/tests/codegen/fail/subscription/fields_duplicate.stderr
diff --git a/tests/codegen/fail/subscription/name_double_underscored.rs b/tests/codegen/fail/subscription/name_double_underscored.rs
diff --git a/tests/codegen/fail/subscription/name_double_underscored.stderr b/tests/codegen/fail/subscription/name_double_underscored.stderr
diff --git a/tests/codegen/fail/subscription/wrong_syntax.rs b/tests/codegen/fail/subscription/wrong_syntax.rs
diff --git a/tests/codegen/fail/subscription/wrong_syntax.stderr b/tests/codegen/fail/subscription/wrong_syntax.stderr
diff --git a/tests/codegen/fail/union/trait_with_attr_on_method.stderr b/tests/codegen/fail/union/trait_with_attr_on_method.stderr

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ use juniper::graphql_object;`
`3`	`3`	`struct ObjA;`
`4`	`4`
`5`	`5`	`#[graphql_object]`
`6`		`-impl Character for ObjA {`
	`6`	`+impl ObjA {`
`7`	`7`	`fn __id(&self) -> &str {`
`8`	`8`	`"funA"`
`9`	`9`	`}`