Graphql object proc macro #333

theduke · 2019-03-08T20:30:36Z

This picks up form @ForsakenHarmony s work.

I squashed the commits down to one, but preserved the contribution.

Old pr: #181
( tried to push to @ForsakenHarmony s branch, but the force push apparently closed the old PR and I can't reopen it)

My commit finishes up the implementation.

Todo:

docs
some more tests
deprecate graphql_object! macro and replace it everywhere

NOTE: I decided to go for a different syntax than previously discussed.
Main motivation:

don't imply that you are actually implementing a trait
make IDEs work/not report errors.

Check the integration_tests/src/codegen/impl_object.rs file for the tests.

It looks like this:

#[juniper::impl_object(
  context = MyContext
)]
impl Query {
  fn whatever(ctx: &MyContext, arg: bool) -> bool {
    true
  }
}

theduke · 2019-03-08T20:38:13Z

@ForsakenHarmony thanks for starting this, and sorry it took so long for us to get the ball rolling.

codecov-io · 2019-03-08T21:17:43Z

Codecov Report

Merging #333 into master will decrease coverage by 1.96%.
The diff coverage is 32.41%.

@@            Coverage Diff             @@
##           master     #333      +/-   ##
==========================================
- Coverage   88.32%   86.36%   -1.97%     
==========================================
  Files         103      105       +2     
  Lines       14922    15348     +426     
==========================================
+ Hits        13180    13255      +75     
- Misses       1742     2093     +351

Impacted Files	Coverage Δ
juniper/src/macros/tests/object.rs	`92.15% <ø> (ø)`	⬆️
juniper/src/macros/interface.rs	`88.63% <ø> (-2.28%)`	⬇️
integration_tests/juniper_tests/src/lib.rs	`100% <ø> (ø)`	⬆️
juniper_warp/src/lib.rs	`93.17% <ø> (ø)`	⬆️
juniper_iron/src/lib.rs	`73.29% <ø> (ø)`	⬆️
juniper/src/types/base.rs	`91.01% <ø> (-0.7%)`	⬇️
juniper/src/lib.rs	`87.09% <ø> (ø)`	⬆️
juniper/src/macros/object.rs	`42.42% <ø> (-52.58%)`	⬇️
juniper_codegen/src/derive_object.rs	`0% <0%> (ø)`	⬆️
juniper_codegen/src/impl_object.rs	`0% <0%> (ø)`
... and 43 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 794568e...a2b2cc3. Read the comment docs.

mwilliammyers · 2019-03-16T04:41:53Z

@theduke Will this work with interfaces? It is currently not very ergonomic to have to implement a trait and use graphql_object!...

I might need to open a new issue but if using this with interfaces will not work then would it be possible to use a trait + graphql_interface! + GraphQLObject instead of a trait + graphql_interface! + a struct +graphql_object!

LegNeato

Looks pretty good. Does this increase the minimum rust version?

Formatting is failing
No Changelog entry

juniper_codegen/src/util.rs

theduke · 2019-03-23T13:48:53Z

@mwilliammyers interfaces are another topic, but we can definitely make these more convenient.

We can discuss in #295 .

theduke · 2019-05-07T09:48:48Z

@LegNeato

Alright! This was a lot of work, but it's ready now.

impl_object now supports all features of graphql_object!
all uses of graphql_object are replaced with impl_object, except the macro tests
book is updated
impl_object has decent documentation

A couple of notes:

Rust version

Sadly the Rust version must be bumped to 1.33 to allow for arbitrary tokens in a attribute.

Diagnostics

Error messages could be improved quite a bit in some cases with RFC 1566, but that doesn't seem close to stabilization.

Deprecation

#[deprecated] has no effect on macros, so I've settled on a big manual deprecation warning

Argument customization

Argument customization is pretty awkward right now.
We can substantially improve this once RFC 2565 is implemented.

For now we'll have to live with:

#[graphql(
  arguments(
    arg1(
       description = "..",
       default = true
    )
  )
)]
fn field(arg1: bool) ->  bool { arg1 }

Re-exports

I've fixed up the re-exports in juniper/src/lib.rs
We do not want to export the internal macros...

Also, I've started to manually re-export all items so rustdoc shows documentation for them.
We should actually add some documentation on them too but that's another PR.

outdated

theduke · 2019-05-12T05:24:24Z

@LegNeato ping

This commit implements a new proc macro `impl_object` that replaces the old graphql_object! macro. The code shares a lot of similarities with the GraphQLObject custom derive, so the code was unified to handle both more generically. Also, doc comment processing was standardized and improved.

This commit deprecates the graphql_object macro and replaces all of it's uses with the new impl_object proc macro. (Except for the old macro tests). This commit also adds new integration tests for impl_object.

Remove the internal macros from re-export. This was a mistake. Also, import each item from juniper_codegen manually to enable rustdoc integration.

juniper_codegen/Cargo.toml

Needed for releasing automation.

LegNeato · 2019-05-12T19:20:33Z

It uses a regex using "[^"]+" so I doubt that's it. Like I said I tested everything and was sure changing versions in codegen worked (even in CI) so something is wonky. As you can see on master the release job passed.

Patch juniper_codegen dev dependency on juniper.

theduke · 2019-05-12T19:39:45Z

Alright, found it. Needed to add the replacement config in juniper/release.toml.

LegNeato

Arguments look pretty ugly in this new world :-/. Also not really in love with impl_object name, but can't think of anything better right now.

juniper/src/macros/tests/field.rs

juniper/src/macros/tests/object.rs

juniper/src/macros/tests/union.rs

theduke · 2019-05-13T09:51:59Z

Arguments look pretty ugly in this new world

Yeah as mentioned above, arguments can become nicer once the accepted RFC for attributes on function parameters is implemented. That will enable

fn field(
  &self,
  #[graphql(default = true, description = "arg")]
  arg: bool,
) -> &str {

}

Also not really in love with impl_object name, but can't think of anything better right now.

Me neither.

I initially stuck with impl_object because of the name clash with graphql_object!, but since that is already replaced and removed from the docs, I think just object is the better choice.

theduke · 2019-05-14T06:46:04Z

Alright, let's do this.

PS: @LegNeato , please check gitter!

theduke requested a review from LegNeato March 8, 2019 20:30

theduke force-pushed the graphql-object-proc-macro branch from 8adea08 to ad8c8ea Compare March 8, 2019 20:46

theduke mentioned this pull request Mar 8, 2019

Add impl derive for graphql objects #181

Closed

theduke force-pushed the graphql-object-proc-macro branch 2 times, most recently from 77febb5 to 651007e Compare March 8, 2019 20:54

LegNeato added the enhancement Improvement of existing features or bugfix label Mar 9, 2019

LegNeato previously requested changes Mar 21, 2019

View reviewed changes

juniper_codegen/src/util.rs Show resolved Hide resolved

theduke force-pushed the graphql-object-proc-macro branch 2 times, most recently from f1b42fd to e045ee4 Compare May 7, 2019 09:20

theduke force-pushed the graphql-object-proc-macro branch 3 times, most recently from d798d38 to a3eebda Compare May 7, 2019 10:36

theduke requested a review from LegNeato May 7, 2019 11:43

theduke mentioned this pull request May 12, 2019

Create a new release #340

Closed

theduke force-pushed the graphql-object-proc-macro branch from a3eebda to 738a44e Compare May 12, 2019 08:32

theduke added 8 commits May 12, 2019 10:35

Deprecate graphql_object! and replace with impl_object

a993c16

This commit deprecates the graphql_object macro and replaces all of it's uses with the new impl_object proc macro. (Except for the old macro tests). This commit also adds new integration tests for impl_object.

Integration tests: impl_object refactor

bf50c3e

(book) impl_object refactor

693405a

(iron) impl_object refactor

1b30e01

(warp) impl_object refactor

f72f808

Remove internal macros from export + improve macro doc system.

52d7af2

Remove the internal macros from re-export. This was a mistake. Also, import each item from juniper_codegen manually to enable rustdoc integration.

(codegen) Remove (extern crate self) declaration

67b28c5

theduke force-pushed the graphql-object-proc-macro branch 2 times, most recently from d7a45f6 to e5226de Compare May 12, 2019 08:49

theduke added 2 commits May 12, 2019 10:49

Bump minimum rust version to 1.34

3cc142b

Formatting...

de12e0e

theduke force-pushed the graphql-object-proc-macro branch from e5226de to de12e0e Compare May 12, 2019 08:50

LegNeato reviewed May 12, 2019

View reviewed changes

juniper_codegen/Cargo.toml Outdated Show resolved Hide resolved

(codegen) Fix test dependency version to be exact.

552b4d0

Needed for releasing automation.

theduke force-pushed the graphql-object-proc-macro branch from 0ac8eaf to 552b4d0 Compare May 12, 2019 19:04

Fix release tooling for juniper_codegen

ffe00b9

Patch juniper_codegen dev dependency on juniper.

LegNeato requested changes May 13, 2019

View reviewed changes

juniper/src/macros/tests/field.rs Show resolved Hide resolved

juniper/src/macros/tests/object.rs Outdated Show resolved Hide resolved

juniper/src/macros/tests/union.rs Outdated Show resolved Hide resolved

theduke added 3 commits May 13, 2019 12:35

Formatting

db0d595

(codegen) Allow #[deprecated] on field in impl_object

520cac2

Rename impl_object to object.

29025e6

theduke force-pushed the graphql-object-proc-macro branch from a2b2cc3 to 29025e6 Compare May 13, 2019 19:15

LegNeato approved these changes May 13, 2019

View reviewed changes

theduke merged commit 61f288b into graphql-rust:master May 14, 2019

theduke mentioned this pull request May 14, 2019

FieldResult should implement GraphQLType #320

Closed

theduke mentioned this pull request Jun 30, 2020

Replace macros with proc_macros #295

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Graphql object proc macro #333

Graphql object proc macro #333

theduke commented Mar 8, 2019 •

edited

Loading

theduke commented Mar 8, 2019

codecov-io commented Mar 8, 2019 •

edited

Loading

mwilliammyers commented Mar 16, 2019

LegNeato left a comment

theduke commented Mar 23, 2019

theduke commented May 7, 2019 •

edited

Loading

theduke commented May 12, 2019

LegNeato commented May 12, 2019 •

edited

Loading

theduke commented May 12, 2019 •

edited

Loading

LegNeato left a comment

theduke commented May 13, 2019 •

edited

Loading

theduke commented May 14, 2019 •

edited

Loading

Graphql object proc macro #333

Graphql object proc macro #333

Conversation

theduke commented Mar 8, 2019 • edited Loading

theduke commented Mar 8, 2019

codecov-io commented Mar 8, 2019 • edited Loading

Codecov Report

mwilliammyers commented Mar 16, 2019

LegNeato left a comment

Choose a reason for hiding this comment

theduke commented Mar 23, 2019

theduke commented May 7, 2019 • edited Loading

Rust version

Diagnostics

Deprecation

Argument customization

Re-exports

theduke commented May 12, 2019

LegNeato commented May 12, 2019 • edited Loading

theduke commented May 12, 2019 • edited Loading

LegNeato left a comment

Choose a reason for hiding this comment

theduke commented May 13, 2019 • edited Loading

theduke commented May 14, 2019 • edited Loading

theduke commented Mar 8, 2019 •

edited

Loading

codecov-io commented Mar 8, 2019 •

edited

Loading

theduke commented May 7, 2019 •

edited

Loading

LegNeato commented May 12, 2019 •

edited

Loading

theduke commented May 12, 2019 •

edited

Loading

theduke commented May 13, 2019 •

edited

Loading

theduke commented May 14, 2019 •

edited

Loading