Allow `#[derive(GraphQLInterface)]` and `#[graphql_interface]` on structs #1026

ilslv · 2022-02-21T12:32:55Z

Synopsis

After #1009 GraphQL interfaces are represented with traits acting as blueprints for methods names, arguments and return types.

Solution

To emphasise structural nature of GraphQL interfaces, allow representing them with structs:

#[derive(GraphQLInterface)]
#[graphql(for = Human)]
struct Character {
    id: String,
}

#[graphql_interface(for = Human)]
struct Character {
    id: String,
}

Checklist

# Conflicts: # integration_tests/juniper_tests/src/codegen/mod.rs # integration_tests/juniper_tests/src/codegen/scalar_attr_derive_input.rs # integration_tests/juniper_tests/src/codegen/scalar_attr_type_alias.rs # integration_tests/juniper_tests/src/codegen/scalar_value_transparent.rs # integration_tests/juniper_tests/src/custom_scalar.rs # juniper/CHANGELOG.md # juniper/src/lib.rs # juniper/src/types/scalars.rs # juniper/src/value/scalar.rs # juniper_codegen/src/derive_scalar_value.rs # juniper_codegen/src/graphql_scalar/attr.rs # juniper_codegen/src/graphql_scalar/derive.rs # juniper_codegen/src/graphql_scalar/mod.rs # juniper_codegen/src/lib.rs # juniper_codegen/src/result.rs

# Conflicts: # juniper/src/integrations/chrono.rs # juniper/src/integrations/chrono_tz.rs

# Conflicts: # integration_tests/codegen_fail/fail/scalar_value/missing_methods.stderr

# Conflicts: # integration_tests/codegen_fail/fail/scalar_value/missing_attributes.rs # integration_tests/codegen_fail/fail/scalar_value/missing_attributes.stderr # integration_tests/codegen_fail/fail/scalar_value/multiple_named_fields.rs # integration_tests/codegen_fail/fail/scalar_value/multiple_unnamed_fields.rs # integration_tests/juniper_tests/src/custom_scalar.rs # juniper/CHANGELOG.md # juniper/src/integrations/chrono.rs # juniper/src/integrations/chrono_tz.rs # juniper/src/value/scalar.rs # juniper_codegen/src/lib.rs

ilslv · 2022-03-10T12:13:06Z

FCM

Implement `#[derive(GraphQLInterface)]` to use structs as GraphQL interfaces (#1026)

- support `#[graphql_interface]` on structs

tyranron

@ilslv overall good, but requires a little bit of polishing though.

tyranron · 2022-03-11T15:42:24Z

integration_tests/juniper_tests/src/codegen/interface_derive.rs

@@ -0,0 +1,2498 @@
+//! Tests for `#[derive(GraphQLInterface)]` macro.
+
+#![allow(dead_code)]


We better place this in codegen dirrectly, as it may appear in the user code frequently.

tyranron · 2022-03-11T15:47:25Z

juniper_codegen/src/graphql_interface/attr.rs

+
+    Ok(quote! {
+        #[allow(dead_code)]
+        #ast


Oh, right. You're doing this already. The issue is that we cannot place it with the proc_macro_derive.

Maybe we can generate some dummy global const stuff using type-asserting the struct or something like this instead?

tyranron · 2022-03-11T16:13:48Z

juniper_codegen/src/graphql_interface/attr.rs

-        "trait method should have a shared reference receiver `&self`",
-    );
+fn err_unnamed_field<T, S: Spanned>(span: &S) -> Option<T> {
+    ERR.emit_custom(span.span(), "expected named struct field");


I don't see this case covered in codegen failure tests. Please, add.

tyranron · 2022-03-11T16:16:03Z

juniper_codegen/src/graphql_interface/derive.rs

+        .unwrap_or_else(|| format_ident!("{}Value", struct_ident.to_string()));
+    let enum_ident = attr.r#enum.as_ref().map_or_else(
+        || format_ident!("{}ValueEnum", struct_ident.to_string()),
+        |c| format_ident!("{}Enum", c.inner().to_string()),


This code has become quite repetitive, so can be DRYed and factored out into a separate function for reusing.

tyranron · 2022-03-11T16:17:57Z

juniper_codegen/src/graphql_interface/derive.rs

+
+/// Emits "expected named struct field" [`syn::Error`] pointing to the given
+/// `span`.
+fn err_unnamed_field<T, S: Spanned>(span: &S) -> Option<T> {


Meh... do not duplicate code. Just reuse the one from a neigbour module.

…o derive-interface-on-structs

ilslv · 2022-03-25T06:52:46Z

@tyranron CI build on nightly fails because of briansmith/ring#1469 and from what I can tell this is a bug in recent nightly version and how it handles doc comments inside decl macros briansmith/ring#1470

# Conflicts: # juniper_codegen/src/common/parse/mod.rs

ilslv and others added 30 commits December 20, 2021 07:44

WIP

01d7cb8

WIP

205cfcd

WIP (with IsSubtype)

928cb9c

WIP (It looks like we're onto something)

3dad162

WIP (return to const assertions)

af04486

Make chrono scalars similar to the time

4ae8c5d

Remove FixedOffset scalar

279ae22

Corrections

bba4af8

Merge branch 'master' into chrono-scalars

ecf9179

It's alive!

15e527f

Merge branch 'master' into 1000-new-interfaces

cb9cad5

Use Field inside object's field resolver

7a78f9e

Add async object fields

5c2087c

Fix

e9c6046

Corrections

f2275a4

Fix Wrapped type for tuple with context

0739c3e

WIP (Make graphql_interface_new attribute work)

263d544

WIP (move to the new tests volume 1)

f4c48a6

WIP (move to the new tests volume 2)

a1df387

WIP (move to the new tests volume 3)

5040d68

WIP (move to the new tests volume 4)

f5533e3

WIP (move to the new tests volume 5)

527325c

WIP (move to the new tests volume 5)

704f079

WIP (refactor)

b84009e

WIP (refactor)

11345f7

WIP (moving to readable const asserts)

5e7230f

WIP (finally good const assert message)

d17ba4f

WIP (corrections)

8cb9b81

WIP (pretty field arguments check)

116cdd9

WIP (pretty subtype check)

7bd8c73

ilslv added 11 commits March 1, 2022 09:26

Corrections

aa8a345

Merge branch 'derive-scalar-value' into chrono-scalars

b28cc4a

# Conflicts: # juniper/src/integrations/chrono.rs # juniper/src/integrations/chrono_tz.rs

Corrections

641860b

Merge branch 'derive-scalar-value' into derive-interface-on-structs

4226d19

# Conflicts: # integration_tests/codegen_fail/fail/scalar_value/missing_methods.stderr

Merge branch 'chrono-scalars' into derive-interface-on-structs

466e7ae

WIP

b4a7370

Corrections

d443190

Corrections

f25488e

CHANGELOG

f4bbdaf

ilslv changed the title ~~Draft: Allow #[derive(GraphQLInterface)] and #[graphql_interface] on structs~~ Allow #[derive(GraphQLInterface)] and #[graphql_interface] on structs Mar 10, 2022

ilslv marked this pull request as ready for review March 10, 2022 12:33

ilslv requested a review from tyranron March 10, 2022 12:45

Corrections [skip ci]

c77fa9a

tyranron requested changes Mar 11, 2022

View reviewed changes

ilslv added 4 commits March 24, 2022 15:24

Corrections

6aa9b0b

Corrections

e9961ec

Merge remote-tracking branch 'origin/derive-interface-on-structs' int…

33ee5b0

…o derive-interface-on-structs

Merge branch 'master' into derive-interface-on-structs

a89162c

Corrections

499cdf9

ilslv requested a review from tyranron March 29, 2022 07:51

tyranron added 2 commits April 1, 2022 18:20

Merge branch 'master' into derive-interface-on-structs

b66452e

# Conflicts: # juniper_codegen/src/common/parse/mod.rs

Minor corrections

89fc491

tyranron approved these changes Apr 1, 2022

View reviewed changes

tyranron merged commit d0b56f9 into master Apr 1, 2022

tyranron deleted the derive-interface-on-structs branch April 1, 2022 18:10

tyranron added this to the 0.16.0 milestone Apr 13, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow `#[derive(GraphQLInterface)]` and `#[graphql_interface]` on structs #1026

Allow `#[derive(GraphQLInterface)]` and `#[graphql_interface]` on structs #1026

ilslv commented Feb 21, 2022 •

edited by tyranron

Loading

ilslv commented Mar 10, 2022

tyranron left a comment

tyranron Mar 11, 2022

tyranron Mar 11, 2022

tyranron Mar 11, 2022

tyranron Mar 11, 2022

tyranron Mar 11, 2022

ilslv commented Mar 25, 2022

		@@ -0,0 +1,2498 @@
		//! Tests for `#[derive(GraphQLInterface)]` macro.

		#![allow(dead_code)]

Allow #[derive(GraphQLInterface)] and #[graphql_interface] on structs #1026

Allow #[derive(GraphQLInterface)] and #[graphql_interface] on structs #1026

Conversation

ilslv commented Feb 21, 2022 • edited by tyranron Loading

Synopsis

Solution

Checklist

ilslv commented Mar 10, 2022

FCM

tyranron left a comment

Choose a reason for hiding this comment

tyranron Mar 11, 2022

Choose a reason for hiding this comment

tyranron Mar 11, 2022

Choose a reason for hiding this comment

tyranron Mar 11, 2022

Choose a reason for hiding this comment

tyranron Mar 11, 2022

Choose a reason for hiding this comment

tyranron Mar 11, 2022

Choose a reason for hiding this comment

ilslv commented Mar 25, 2022

Allow `#[derive(GraphQLInterface)]` and `#[graphql_interface]` on structs #1026

Allow `#[derive(GraphQLInterface)]` and `#[graphql_interface]` on structs #1026

ilslv commented Feb 21, 2022 •

edited by tyranron

Loading