Interface and union resolvers #149

koenpunt · 2018-10-19T09:24:57Z

This is a new version of #66.

I didn't test the generated files yet, but the test snapshot looks promising.

It generates a resolver for the interface and union types in the following shape;

export namespace MediaResolvers {
  export interface Type {
    __resolveType: GraphQLTypeResolver<Image | Video, Context>;
  }
}

And it generates a __isTypeOf resolver on types that implement an interface or are part of a union.

export namespace MediaResolvers {
  export interface Type {
    // ...
    __isTypeOf?: GraphQLIsTypeOfFn<Image | Video, Context>;
  }
}

Also, what's up with all the .tmp tests? Barely anything is covered with tests at the moment..

TODO

Ignore interfaces that are not implemented

packages/graphqlgen/src/tests/typescript/basic.test.ts

packages/graphqlgen/src/tests/typescript/__snapshots__/basic.test.ts.snap

packages/graphqlgen/src/generators/ts-generator.ts

schickling · 2018-10-20T11:15:50Z

Thanks a lot for this PR. Would you mind testing it locally, so we can merge this PR with confidence? 💪

Also, what's up with all the .tmp tests? Barely anything is covered with tests at the moment..

Yes, we're in the process of refactoring the tests as well. See #157.

koenpunt · 2018-10-20T12:11:33Z

Thanks a lot for this PR. Would you mind testing it locally, so we can merge this PR with confidence? 💪

Just updated some minor things, should be good now. As in, works on my machine.

koenpunt · 2018-10-20T12:14:17Z

For even better support I could also generate an interface type, which implements the interface's resolver fields, and can be used as a parent type to prevent writing resolvers for implementing types twice.

schickling · 2018-10-20T17:57:24Z

Thanks a lot @koenpunt. I've just taken a look. A few things:

Would you mind extending the scaffolding behavior as well?
What's the reason for the resolver to be __resolveType? instead of __resolveType?
Same for IUser? in the Resolvers interface
Same for __isTypeOf? in a particular resolver type

koenpunt · 2018-10-22T09:50:38Z

@schickling __resolveType indeed doesn't need to be optional, since the resolver itself is.
__isTypeOf is optional, because when the interface's resolver is defined (and thus __resolveType), this method is not necessary.

Regarding the scaffolding behavior; I'll be on a plane from Amsterdam to Las Vegas, and I expect that to be done when I land in about 14 hours.

schickling · 2018-10-22T12:22:51Z

Is my understanding correct that you either have to implement IUser + __resolveType or the __resolveType method for all types that implement an interface? Seems like we have three options to go from here:

Make both cases optionally typed (-> your current implementation)
Just allow one of the ways (I suggest IUser + __resolveType) and force it to be implemented. This allows for stricter type-safety.
Add a configuration option to let the user decide re (2)

What are your thoughts? I'm kind of leaning to (2) for now and eventually (3).

Have a safe flight 🛬

schickling · 2018-10-29T22:57:21Z

I had a quick chat with @leebyron. He suggested to go for option (1) as the graphql-js implementation will check at runtime that at least one of __resolveType or __isTypeOf is present.

@koenpunt are you still up to moving forward with this?

koenpunt · 2018-10-30T14:04:17Z

@schickling alright, good to know. Yeah I'm using the library already myself, so I kinda need it, but I have to rebase again etc.

koenpunt · 2018-11-05T15:04:51Z

I'm not going to work on this before #244 is merged, because I have a feeling I have to start over again once that lands...

schickling · 2018-11-07T16:24:59Z

#244 is now merged. Do you want to tackle this again? (Sorry for the overhead but I think the refactor was well worth it) 🙏

koenpunt · 2018-11-08T10:41:42Z

Do you want to tackle this again?

I will have a go at it tonight or tomorrow night

koenpunt · 2018-11-11T18:59:41Z

Typescript now works. For flow there are some types not being generated yet.

anotherhale · 2018-11-26T17:23:35Z

Is this close? This would greatly benefit a project that I am working on.

koenpunt · 2018-11-27T20:47:31Z

I'd like to get some input on what I created thus far. @schickling you have any remarks? Or are you totally fine with where this is going and are you just waiting for me to finish the flow implementation too?

koenpunt · 2018-12-12T14:19:16Z

@schickling do you have any feedback?

janheinrichmerker · 2018-12-18T00:34:23Z

@schickling This PR seems to be ready to merge. Is there anything missing?

jasonkuhrt

Overall this looks great @koenpunt thank-you!

packages/graphqlgen/src/generators/common.ts

packages/graphqlgen/src/tests/typescript/__snapshots__/basic.test.ts.snap

packages/graphqlgen/src/generators/common.ts

jasonkuhrt · 2018-12-20T03:42:11Z

Seems like we have three options to go from here:

@schickling I think there could be a fourth option actually, by leveraging a union to force developers into one of many valid implementations. Its like raising both options in your config option to the type level : )

That said, right now, I don't think the added implementation complexity is worth it; and the potential implications for type comprehensibility would need more consideration.

@anotherhale Yes I think its close. I will be checking in with @timsuchanek about it this week.

packages/graphqlgen/src/tests/typescript/__snapshots__/large-schema.test.ts.snap

packages/graphqlgen/src/generators/ts-generator.ts

packages/graphqlgen/src/source-helper.ts

jasonkuhrt · 2019-01-20T14:36:39Z

I'm not 100% convinced but all things considered I think overall a good next step is to merge this and make a 0.6.0-rc1 release. There's a lot of refactoring I want to do, and from reading the comments flow type may not be 100% complete, but I think shipping something for TypeScript users is worth it. The release notes will be clear that flowtype support is not guaranteed.

packages/graphqlgen/src/generators/ts-generator.ts

…on types

maggo · 2019-01-23T15:33:20Z

Hi @jasonkuhrt I'm sooo happy that this is being implemented! Gave me a headache all day before I found the PR. Just discovered an issue though:

The generated resolvers' index.ts doesn't seem to include the Interface resolvers. Since the resolvers are all optional you won't discover this when copying the scaffolding, only after executing them. I guess this is a bug?

jasonkuhrt · 2019-01-23T18:09:39Z

@maggo cheers : )

Bug or feature, either way, feel free to create an issue, supply some context/example and we can discuss further there 👍 Thanks!

koenpunt · 2019-01-24T09:48:35Z

@jasonkuhrt Nice to see this is merged, since this means I soon no longer have to run my own fork to use graphqlgen. However I have to say that I don't really like how you "hijacked" this PR without notice.

Also, your modifications caused a generation issue, that wasn't there before:

    args: {},
     ctx: Context,
     info: GraphQLResolveInfo
-  ) => Channel | null | Promise<Channel | null>;
+  ) =>
+    | Channel
+    | Channel
+    | Channel
+    | null
+    | null
+    | Promise<Channel | Channel | Channel | null | null>;

And lastly I'm wondering why you removed the InterfaceTypes, because that's something that is actually really useful, and is now again a blocker for using the official version.

jasonkuhrt · 2019-01-24T14:51:21Z

However I have to say that I don't really like how you "hijacked" this PR without notice.

Sorry to hear that, it was actually to give you credit on master branch. It felt to me the least I could to thank you for the contribution. However I forgot or neglected to post a notice about continuing work on this branch (whereas I did do that on some other PRs). So, sorry that you were taken by surprise 🙏. I don't think I was seriously expecting a reply from you so that probably contributed to lowering my communication standards. Thanks for sharing your feeling on this.

Also, your modifications caused a generation issue, that wasn't there before:

We're currently in an rc stage. If you could create a new issue with context that would be helpful toward getting a fix out.

And lastly I'm wondering why you removed the InterfaceTypes, because that's something that is actually really useful, and is now again a blocker for using the official version.

Could you elaborate? Ideally in a new issue, thanks!

jasonkuhrt · 2019-01-25T03:30:30Z

Also, your modifications caused a generation issue, that wasn't there before:

@koenpunt fixed duplicate null 17cdb85

koenpunt mentioned this pull request Oct 19, 2018

Generate resolvers for interfaces and union types #66

Closed

koenpunt commented Oct 19, 2018

View reviewed changes

packages/graphqlgen/src/tests/typescript/basic.test.ts Outdated Show resolved Hide resolved

koenpunt commented Oct 19, 2018

View reviewed changes

packages/graphqlgen/src/tests/typescript/__snapshots__/basic.test.ts.snap Outdated Show resolved Hide resolved

koenpunt commented Oct 19, 2018

View reviewed changes

packages/graphqlgen/src/tests/typescript/__snapshots__/basic.test.ts.snap Outdated Show resolved Hide resolved

koenpunt commented Oct 19, 2018

View reviewed changes

packages/graphqlgen/src/generators/ts-generator.ts Outdated Show resolved Hide resolved

Weakky force-pushed the master branch from eabd13d to ce962ab Compare November 1, 2018 13:15

koenpunt added 2 commits November 15, 2018 22:03

generate resolvers for interface and union types

9a03ca1

generate interfaces for fields of graphql interfaces

64b6547

jasonkuhrt added the kind/feature label Dec 16, 2018

This was referenced Dec 17, 2018

Union type safety #346

Closed

Interface type safety #347

Closed

jasonkuhrt reviewed Dec 20, 2018

View reviewed changes

packages/graphqlgen/src/generators/common.ts Outdated Show resolved Hide resolved

packages/graphqlgen/src/tests/typescript/__snapshots__/basic.test.ts.snap Outdated Show resolved Hide resolved

jasonkuhrt reviewed Dec 20, 2018

View reviewed changes

packages/graphqlgen/src/generators/common.ts Outdated Show resolved Hide resolved

refactor confusing idents

c2d464a

jasonkuhrt reviewed Jan 18, 2019

View reviewed changes

packages/graphqlgen/src/tests/typescript/__snapshots__/large-schema.test.ts.snap Outdated Show resolved Hide resolved

jasonkuhrt reviewed Jan 18, 2019

View reviewed changes

packages/graphqlgen/src/generators/ts-generator.ts Outdated Show resolved Hide resolved

jasonkuhrt reviewed Jan 19, 2019

View reviewed changes

packages/graphqlgen/src/source-helper.ts Outdated Show resolved Hide resolved

jasonkuhrt added 14 commits January 18, 2019 20:24

refactor extractGraphQLInterfaces

b598963

optimize extractGraphQLInterfaces

4843b2e

refactor: explicit null

73c7fa0

chore: check types script

18bc848

fix type errors

f1e36c6

refactor: rename field to carry semantic meaning

77ea258

reduce diff

6c4120b

reduce diff

7f8cfae

fix type errors

67b3cef

fix

362b432

refactor: dry up unions/interfaces map creations

8f510f8

remove unused fixture code

60fa23e

fix benchmark type errors

be26c46

if an interface is unused it should not emit types

bae0833

jasonkuhrt reviewed Jan 20, 2019

View reviewed changes

packages/graphqlgen/src/generators/ts-generator.ts Outdated Show resolved Hide resolved

jasonkuhrt added 2 commits January 20, 2019 15:16

do not generate gql object resolver extends interface

cfb0133

if unions/interfaces not used do not import respective field resoluti…

fffef27

…on types

jasonkuhrt merged commit eb2f3cf into prisma-labs:master Jan 20, 2019

koenpunt mentioned this pull request Jan 24, 2019

generate interfaces for graphql interfaces #412

Closed

koenpunt deleted the interface-and-union-resolvers branch January 24, 2019 10:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Interface and union resolvers #149

Interface and union resolvers #149

koenpunt commented Oct 19, 2018 •

edited by jasonkuhrt

Loading

schickling commented Oct 20, 2018

koenpunt commented Oct 20, 2018 •

edited

Loading

koenpunt commented Oct 20, 2018 •

edited

Loading

schickling commented Oct 20, 2018 •

edited

Loading

koenpunt commented Oct 22, 2018

schickling commented Oct 22, 2018

schickling commented Oct 29, 2018

koenpunt commented Oct 30, 2018

koenpunt commented Nov 5, 2018 •

edited

Loading

schickling commented Nov 7, 2018

koenpunt commented Nov 8, 2018

koenpunt commented Nov 11, 2018

anotherhale commented Nov 26, 2018

koenpunt commented Nov 27, 2018

koenpunt commented Dec 12, 2018

janheinrichmerker commented Dec 18, 2018

jasonkuhrt left a comment •

edited

Loading

jasonkuhrt commented Dec 20, 2018 •

edited

Loading

jasonkuhrt commented Jan 20, 2019

maggo commented Jan 23, 2019

jasonkuhrt commented Jan 23, 2019 •

edited

Loading

koenpunt commented Jan 24, 2019

jasonkuhrt commented Jan 24, 2019

jasonkuhrt commented Jan 25, 2019 •

edited

Loading

Interface and union resolvers #149

Interface and union resolvers #149

Conversation

koenpunt commented Oct 19, 2018 • edited by jasonkuhrt Loading

TODO

schickling commented Oct 20, 2018

koenpunt commented Oct 20, 2018 • edited Loading

koenpunt commented Oct 20, 2018 • edited Loading

schickling commented Oct 20, 2018 • edited Loading

koenpunt commented Oct 22, 2018

schickling commented Oct 22, 2018

schickling commented Oct 29, 2018

koenpunt commented Oct 30, 2018

koenpunt commented Nov 5, 2018 • edited Loading

schickling commented Nov 7, 2018

koenpunt commented Nov 8, 2018

koenpunt commented Nov 11, 2018

anotherhale commented Nov 26, 2018

koenpunt commented Nov 27, 2018

koenpunt commented Dec 12, 2018

janheinrichmerker commented Dec 18, 2018

jasonkuhrt left a comment • edited Loading

Choose a reason for hiding this comment

jasonkuhrt commented Dec 20, 2018 • edited Loading

jasonkuhrt commented Jan 20, 2019

maggo commented Jan 23, 2019

jasonkuhrt commented Jan 23, 2019 • edited Loading

koenpunt commented Jan 24, 2019

jasonkuhrt commented Jan 24, 2019

jasonkuhrt commented Jan 25, 2019 • edited Loading

koenpunt commented Oct 19, 2018 •

edited by jasonkuhrt

Loading

koenpunt commented Oct 20, 2018 •

edited

Loading

koenpunt commented Oct 20, 2018 •

edited

Loading

schickling commented Oct 20, 2018 •

edited

Loading

koenpunt commented Nov 5, 2018 •

edited

Loading

jasonkuhrt left a comment •

edited

Loading

jasonkuhrt commented Dec 20, 2018 •

edited

Loading

jasonkuhrt commented Jan 23, 2019 •

edited

Loading

jasonkuhrt commented Jan 25, 2019 •

edited

Loading