Relay Spec #6089

davimacedo · 2019-09-26T19:26:22Z

This PR aims to make the Parse GraphQL API compliant with the Relay Spec.

codecov · 2019-09-26T20:32:40Z

Codecov Report

Merging #6089 into master will decrease coverage by <.01%.
The diff coverage is 91.89%.

@@            Coverage Diff             @@
##           master    #6089      +/-   ##
==========================================
- Coverage   93.98%   93.97%   -0.01%     
==========================================
  Files         168      169       +1     
  Lines       11347    11525     +178     
==========================================
+ Hits        10664    10831     +167     
- Misses        683      694      +11

Impacted Files	Coverage Δ
src/GraphQL/transformers/outputType.js	`81.81% <0%> (ø)`	⬆️
src/GraphQL/loaders/parseClassTypes.js	`94.87% <100%> (+0.39%)`	⬆️
src/GraphQL/loaders/parseClassQueries.js	`97.87% <100%> (+0.19%)`	⬆️
src/GraphQL/loaders/usersQueries.js	`97.5% <100%> (+1.2%)`	⬆️
src/GraphQL/ParseGraphQLSchema.js	`97.07% <100%> (+0.05%)`	⬆️
src/GraphQL/loaders/defaultGraphQLTypes.js	`97.03% <100%> (+0.35%)`	⬆️
src/GraphQL/transformers/constraintType.js	`95% <100%> (+0.55%)`	⬆️
src/GraphQL/loaders/functionsMutations.js	`100% <100%> (ø)`	⬆️
src/GraphQL/loaders/parseClassMutations.js	`100% <100%> (ø)`	⬆️
src/GraphQL/loaders/filesMutations.js	`82.35% <78.57%> (+2.35%)`	⬆️
... and 9 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 6245996...ef8462b. Read the comment docs.

omairvaiyani · 2019-09-27T08:02:28Z

Good job man! Big PR - might be appropriate if you suggest a good way to split the reviewers for different files/sections so we can be more thorough

davimacedo · 2019-09-27T21:59:27Z

thanks @omairvaiyani it would be good if you guys could take a look and play around with the new schema. Then you could particularly review the changes related to the schema customization. But feel free to review any piece of code you want.

Moumouls · 2019-09-28T09:43:34Z

For my part, due to the massive changes, i'm going to start by a functionnal review with a live relay parse server.
I'll keep you informed.

douglasmuraoka

I've tested the new queries/mutations, schema customizations, and from my point of view, it looks good to me (however, I'm not a Relay expert, @Moumouls could provide better feedback on this part).
The only thing I'd like to comment is that sometimes I miss comments on code. That would make the code easier to understand and also we'd have some documentation that could prevent us from creating bugs.

src/GraphQL/helpers/objectsQueries.js

omairvaiyani · 2019-11-07T11:42:32Z

omairvaiyani

Functional review started

davimacedo · 2019-11-11T05:44:40Z

@omairvaiyani thanks for the review and feedback.

clientMutationId

It is present in all mutations both in the input and in the output. The output value is always equal to the one passed in the input. Relay uses this field to uniquely identify the mutations.

You can find more information here

global id

It is actually according to the specification. You can find the regular Parse id in the objectId field, but the id field is used for global identification. It is basically a base64 string built by the combination of the class name and the object id. By this way you can globally identify an object and retrieve any object of any class by using this id through the node query. Relay uses this for refetching the objects.

You can find mode information here

omairvaiyani · 2019-11-13T09:16:05Z

Got it, definitely not familiar enough with Relay spec to give more detailed feedback here. But in principle, the module is working on our codebase. Is there anything I can help to get this across the finish line?

Moumouls · 2019-11-15T20:34:22Z

The main tricky part of the relay implementation is the cursor, and it seems well implemented, i used the same logic in an old project.

I notice that in the SDL we have some objectId fields, i think we could remove now all reference to that field from the GraphQL API.

@davimacedo so here we will only support the Relay version for the GraphQL API ?
I think it could be time consuming to maintain 2 versions of the GQL API in the future

On the other hand, we could write some examples in the Parse GraphQL Doc to help GraphQL Beginners

I'm going to use it (Relay API) intensely, in a project during the next 4 month.
I suggest to merge this PR, keep the beta notice on the GraphQL implementation.
If we do not notice to much bugs after the beta release we could remove the beta flag (may be beginning of 2020 #ANewYearForParse) ?

Moumouls · 2019-11-15T20:37:58Z

@davimacedo And a huge big up for your tremendous work

omairvaiyani · 2019-11-16T12:39:17Z

@Moumouls

I notice that in the SDL we have some objectId fields, i think we could remove now all reference to that field from the GraphQL API.

Could you describe what, if any, limitations the Relay spec introduces vs the current implementation? For example, removing the objectId field, do you think that'll have any knock-on effects for users, or is using the globalId going to be relatively straightforward for existing Parse users?

The docs will essentially make or break our efforts here, if we're to release Relay asap, I suggest we start the docs asap.

Moumouls · 2019-11-19T22:17:19Z

@omairvaiyani Relay do not introduce any limitations, it's a major upgrade in a GraphQL API life:

Better caching with globalID for front end clients (like Apollo Client)
GlobalID: Allow further
Powerfull pagination system with Cursors
Global normalization with Connection and Node Interface

Currently Relay Spec is the most advanced/robust GraphQL Extension Spec that exists.

To avoid a dual codebase on the GraphQL implementation i think we need to only keep one spec:

The Custom one inspired from the Parse vocabulary: for existing Parse Developers, I don't think it's going to attract new developers
The Relay one, the best of GraphQL Spec on top of Parse: existing Parse Developers can learn new terms (with a short tuto on the docs), it can potentially attract new developers searching a powerfull and easy to use GraphQL Server

If we choose one and we choose to only keep the Relay implementation, we need to keep only one ID System: Relay Global Id 😄 (objectId will probably cause confusion)

@omairvaiyani and yes you are right, we need to start a little tutorial on the GraphQL Parse Docs to help developers on boarding 👍

Have I answered your questions? @omairvaiyani

PS: Global ID is really easy to understand and to decode (juste a Base64) i think it's not a problem for developers. And if developers need assistance we can add a Global ID Decoder on the parse-dashboard to convert GlobalID to objectID ?

omairvaiyani · 2019-11-20T10:17:47Z

@Moumouls I'm completely with you in that using Relay will make Parse much more enticing to GraphQL developers. And I trust your opinion on robustness/stability. I still have some qualms about the omittance of objectId - mainly because current Parse developers will have extensively used it across their cloud codebase, as well as front-end codebase. If these developers were to make use of GraphQL on Parse, they will most likely make an abstraction layer on their GraphQL client's to serialize/deserialize the objectId- so from that point of view, it shouldn't be a problem. It might be just an annoying extra-step when using the playground to not see the objectId anywhere, which is why I think we should maintain the field, even if it's not used to perform the queries.

Moumouls · 2019-11-27T16:30:49Z

@omairvaiyani agree with you let's keep the objectId field

Moumouls · 2019-11-27T16:31:41Z

Are we ready to merge this one @omairvaiyani @davimacedo ?

omairvaiyani · 2019-11-28T12:04:24Z

I'm happy with it, we could do with some directionality from the core-team around tackling the documentation

Moumouls · 2019-11-30T19:32:14Z

I started a documentation here for a complete release of the GraphQL implementation: parse-community/docs#688
@omairvaiyani

davimacedo · 2019-12-02T04:38:27Z

That's awesome guys! I think we are ready to merge. But it would be good to have the docs ready for the new Parse Server release (maybe 4.0?). I can help on this as well if you need @Moumouls. Sorry about the delay on answering this thread. I was pretty busy in the past few weeks but I should have more available time during December.

* Install graphql-relay * Add relayNodeInterface to ParseGraphQLSchema * Add support to global id * Add support to global id in other operations * Fix sort by glboal id * Fix where by global id * Introduce IdWhereInput * Add Relay object identification tests * Client mutation id on createFile mutation * Client mutation id on callCloudCode mutation * Client mutation id on signUp mutation * Client mutation id on logIn mutation * Client mutation id on logOut mutation * Client mutation id on createClass mutation * Client mutation id on updateClass mutation * Client mutation id on deleteClass mutation * Client mutation id on create object mutation * Improve Viewer type * Client mutation id on update object mutation * Client mutation id on delete object mutation * Introducing connections * Fix tests * Add pagination test * Fix file location * Fix postgres tests * Add comments * Tests to calculateSkipAndLimit

davimacedo added 24 commits September 22, 2019 14:37

Install graphql-relay

7cdc3c9

Merge branch 'upstream' into relaySpec3

eff3ed4

Add relayNodeInterface to ParseGraphQLSchema

1283986

Add support to global id

d2e30e8

Add support to global id in other operations

d75b3ec

Fix sort by glboal id

8edc480

Fix where by global id

94e0053

Introduce IdWhereInput

f108051

Add Relay object identification tests

b536f5b

Client mutation id on createFile mutation

dd0d451

Client mutation id on callCloudCode mutation

58b9dd9

Client mutation id on signUp mutation

337140f

Client mutation id on logIn mutation

9d689f1

Client mutation id on logOut mutation

0288ebb

Client mutation id on createClass mutation

204dfff

Client mutation id on updateClass mutation

21b474c

Client mutation id on deleteClass mutation

8fac91a

Client mutation id on create object mutation

8a68f19

Improve Viewer type

3422419

Client mutation id on update object mutation

e9fe1c5

Client mutation id on delete object mutation

ab8a49a

Introducing connections

789731d

Fix tests

f6635cc

Add pagination test

b388751

davimacedo changed the title ~~Relay spec3~~ Relay Spec Sep 26, 2019

davimacedo requested review from Moumouls, douglasmuraoka and omairvaiyani September 26, 2019 19:26

davimacedo mentioned this pull request Sep 26, 2019

Relay spec #5913

Closed

5 tasks

Fix file location

928b831

Merge branch 'master' into relaySpec3

0abcbbd

davimacedo force-pushed the relaySpec3 branch from 4f8e6df to 0abcbbd Compare October 4, 2019 03:21

douglasmuraoka approved these changes Oct 7, 2019

View reviewed changes

src/GraphQL/helpers/objectsQueries.js Show resolved Hide resolved

omairvaiyani reviewed Nov 7, 2019

View reviewed changes

davimacedo added 3 commits November 10, 2019 21:56

Merge upstream

a2473e1

Add comments

35683d1

Tests to calculateSkipAndLimit

ee44932

Moumouls approved these changes Nov 15, 2019

View reviewed changes

davimacedo added 2 commits December 1, 2019 20:42

Merge upstream

cc8b77e

Merging again

ef8462b

davimacedo merged commit a9066e2 into parse-community:master Dec 2, 2019

snyk-bot mentioned this pull request Mar 28, 2022

refactor: upgrade apollo-server-express from 2.25.2 to 3.6.3 #7903

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Relay Spec #6089

Relay Spec #6089

davimacedo commented Sep 26, 2019

codecov bot commented Sep 26, 2019 •

edited

Loading

omairvaiyani commented Sep 27, 2019

davimacedo commented Sep 27, 2019

Moumouls commented Sep 28, 2019

douglasmuraoka left a comment

omairvaiyani commented Nov 7, 2019 •

edited

Loading

omairvaiyani left a comment

davimacedo commented Nov 11, 2019

omairvaiyani commented Nov 13, 2019

Moumouls commented Nov 15, 2019

Moumouls commented Nov 15, 2019

omairvaiyani commented Nov 16, 2019

Moumouls commented Nov 19, 2019

omairvaiyani commented Nov 20, 2019 •

edited

Loading

Moumouls commented Nov 27, 2019 •

edited

Loading

Moumouls commented Nov 27, 2019

omairvaiyani commented Nov 28, 2019

Moumouls commented Nov 30, 2019 •

edited

Loading

davimacedo commented Dec 2, 2019

Relay Spec #6089

Relay Spec #6089

Conversation

davimacedo commented Sep 26, 2019

codecov bot commented Sep 26, 2019 • edited Loading

Codecov Report

omairvaiyani commented Sep 27, 2019

davimacedo commented Sep 27, 2019

Moumouls commented Sep 28, 2019

douglasmuraoka left a comment

Choose a reason for hiding this comment

omairvaiyani commented Nov 7, 2019 • edited Loading

omairvaiyani left a comment

Choose a reason for hiding this comment

davimacedo commented Nov 11, 2019

clientMutationId

global id

omairvaiyani commented Nov 13, 2019

Moumouls commented Nov 15, 2019

Moumouls commented Nov 15, 2019

omairvaiyani commented Nov 16, 2019

Moumouls commented Nov 19, 2019

omairvaiyani commented Nov 20, 2019 • edited Loading

Moumouls commented Nov 27, 2019 • edited Loading

Moumouls commented Nov 27, 2019

omairvaiyani commented Nov 28, 2019

Moumouls commented Nov 30, 2019 • edited Loading

davimacedo commented Dec 2, 2019

codecov bot commented Sep 26, 2019 •

edited

Loading

omairvaiyani commented Nov 7, 2019 •

edited

Loading

omairvaiyani commented Nov 20, 2019 •

edited

Loading

Moumouls commented Nov 27, 2019 •

edited

Loading

Moumouls commented Nov 30, 2019 •

edited

Loading