Allow option to conform to Relay spec

[goldcaddy77]

• https://relay.dev/graphql/connections.htm
• https://graphql.org/learn/pagination/

[goldcaddy77]

@FOSSforlife Making good progress here: #340

[bedeho]

Hi, what is the status on this? Is there anything we can do to help advance this along sooner, we would love to ship with this feature as part of an upcoming release.

[goldcaddy77]

Hey, I put this on hold to work on various items for Warthog V3. Will dust it off right now and see if I can push it through.

[bedeho]

Would mean the world to us, thank you so much, how could we keep up with that? Please let us know if you crack open a PR or something at some point.

[goldcaddy77]

I worked on it a bunch tonight... Still need to wire things up in BaseService. I can probably finish it up tomorrow night.

[bedeho]

Fantastic!

[goldcaddy77]

Did a bunch more work last night - getting close: #408. Just need one more push.

[goldcaddy77]

One more push got things very close: https://github.com/goldcaddy77/warthog/pull/408/commits . You can start playing with it on branch issue-338-relay-spec if you want. I need more tests though before I want to merge it down.

[bedeho]

Great, will ask one of our guys to try using it asap and provide feedback.

[metmirr]

@goldcaddy77 I tried to play with it on that branch but I am getting errors. For example, I created a sample model named User and then I tried to run warthog codegen it failed with these errors:

src/modules/user/user.resolver.ts:26:30 - error TS2344: Type 'UserWhereInput' does not satisfy the constraint 'WhereInput'.
  Type 'UserWhereInput' is not assignable to type 'WhereExpression'.
    Index signature is missing in type 'UserWhereInput'.

26     return this.service.find<UserWhereInput>(where, orderBy, limit, offset, fields);
                                ~~~~~~~~~~~~~~
src/modules/user/user.resolver.ts:31:33 - error TS2558: Expected 0 type arguments, but got 1.

31     return this.service.findOne<UserWhereUniqueInput>(where);
                                   ~~~~~~~~~~~~~~~~~~~~
src/modules/user/user.resolver.ts:52:38 - error TS2345: Argument of type 'UserWhereUniqueInput' is not assignable to parameter of type 'WhereExpression'.
  Index signature is missing in type 'UserWhereUniqueInput'.

52     return this.service.update(data, where, userId);

Building and installing warthog:

1. Build warthog from issue-338-relay-spec branch - yarn build
2. Install the version from step 1 - yarn add /path/to/warthog.tgz

[goldcaddy77]

I'm working on this now and plan on having this merged in the next few hours.

[goldcaddy77]

Merged: #408

Let me know if this works. You can find usage here:

• warthog/src/core/BaseService.test.ts

  Line 67 in eeddc26

  describe('findConnection', () => {

• warthog/src/test/modules/dish/dish.resolver.ts

  Lines 110 to 116 in eeddc26

  	@Query(() => DishConnection)
  	async dishConnection(
  	@Args() { where, orderBy, ...pageOptions }: DishConnectionWhereArgs,
  	@RawFields() fields: object
  	): Promise<DishConnection> {
  	return this.service.findConnection<DishWhereInput>(where, orderBy, pageOptions, fields) as any;
  	}

[goldcaddy77]

@bedeho / @metmirr let me know how this works. Currently porting it to V3 as well.

[bedeho]

Hopefully, @metmirr can get back to you by Monday ;)

[metmirr]

@goldcaddy77 by following the usage in the tests I was able to create a connection. Now my question is cli is not generating connection related ObjectType, ArgType etc. So do I need to define these types for every resolver that I have? For the Dish example you have defined DishEdge, DishConnection, ConnectionPageInputOptions, and DishConnectionWhereArgs

[goldcaddy77]

Hi, yes for now you do need to create those manually, but we can add an option to auto-generate them pretty easily. Feel free to take a stab. You'll just need to add the additional functions to https://github.com/goldcaddy77/warthog/blob/main/src/schema/TypeORMConverter.ts and call them in https://github.com/goldcaddy77/warthog/blob/main/src/schema/SchemaGenerator.ts

[goldcaddy77]

@metmirr going to track the auto-gen for Connection queries in #331, closing.