Add cloud code resolver example #771
Conversation
|
I'll take a look tomorrow ! |
|
Sounds good. Shall I place it on the second level then (as a sibling with |
|
Yes. I believe it makes sense. You can wait for @Moumouls feedback. |
_includes/graphql/objects.md
Outdated
| const cartItemJson = savedCartItem.toJSON(); | ||
| Object.assign(cartItemJson, { id: cartItemId }); | ||
| return cartItemJson; |
There was a problem hiding this comment.
What you think about ES6 shortcuts
| const cartItemJson = savedCartItem.toJSON(); | |
| Object.assign(cartItemJson, { id: cartItemId }); | |
| return cartItemJson; | |
| // Convert to a JSON object to handle adding the base64 id property. | |
| return {...savedCartItem.toJSON(), id: cartItemId } |
There was a problem hiding this comment.
Very nice. Thank you.
_includes/graphql/objects.md
Outdated
| ```sh | ||
| # schema.graphql | ||
| extend type Mutation { | ||
| addToCart(id: ID!): CartItem! @resolve | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
We need to show how to pass the schema into the ParseGraphQL Server, here developers can think that a simple schema.graphql at the root of the folder can do the job
There was a problem hiding this comment.
Agreed. I could use the example found in this PR. It's the code I used in my own project.
I'm hesitant to include the custom schema setup code in this section, as it seems to only be a related topic, and not quite this same one. Would it be okay for me to include the custom schema setup in the Getting Started section instead? If so, it could be inserted in one of a couple places:
- In the
Using Express.Jssub-section (mixed in with the other ParseServer setup code), or - Given its own sub-section named something like,
Adding Custom Schema(I think I would prefer this method)
_includes/graphql/objects.md
Outdated
| **Note:** The `id` is a [Relay Global Object Identification](https://facebook.github.io/relay/graphql/objectidentification.htm); it's **not** a Parse `objectId`. Most of the time the `Relay Node Id` is a `Base64` of the `ParseClass` and the `objectId`. Cloud code does not recognize this type of `id`, so it must be converted to a Parse `objectId` for use in Cloud Code function queries. | ||
|
|
There was a problem hiding this comment.
To avoid some code like this
const decoded = Buffer.from(id, "base64").toString();
const itemObjectId = decoded.split(":")[1];
We need to inform developers that they can use graphql-relay lib.
May be add some reference about the graphql lib graphql-relay and the const { type, id } = fromGlobalId(globalId); method
Link: https://github.com/graphql/graphql-relay-js#object-identification
Lib: https://www.npmjs.com/package/graphql-relay
There was a problem hiding this comment.
Should I use my Buffer based code in the example, but add a text explanation and reference to the graphql lib as an optional solution, or should I dump the Buffer based code, use the graphql lib for the code example, and then reference the lib in the text?
With that lib available (thanks for mentioning it!) I personally would use it in my own projects, but there's something to be said for using code examples that are a bit more vanilla JS in the documentation too. Your preference?
|
@185driver also may be move your code to |
|
I thought it might be easier to make the changes suggested by @Moumouls and submit them here for review. Hopefully things are moving in the right direction. Further suggestions are welcome. |
_includes/graphql/customisation.md
Outdated
| ```sh | ||
| # schema.graphql | ||
| extend type Mutation { | ||
| addToCart(id: ID!): CartItem! @resolve | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Add a note/link to the getting started "Adding Custom Schema" section for better developer experience
There was a problem hiding this comment.
Will do, thanks for the reminder.
|
I've added the link back to Getting Started and to the GraphQL Relay lib as suggested. After adding the custom schema section, the cloud code resolver section felt incomplete without a balancing query section, so I added that. Suggestions to change or remove it are welcome. My feeling right now is that the two sections feel pretty complete and seem to fit together well. I believe the docs now provide someone like myself with enough official information to venture into Parse Server custom schema with a bit of confidence. |
There was a problem hiding this comment.
It looks pretty good to me. @Moumouls any additional change that you think we need here?
|
Everything looks good to me :) |
|
Good job guys! |
This PR is a response to a suggestion made in the Parse Community Forum to add a custom Cloud Code resolver example to Parse's GraphQL docs.
I think the example fits the need for a real-life scenario showing the usefulness of custom resolvers and includes examples of both decoding and encoding a
Relay Global Object Identification.The included example does not include a section on how to set up custom schema for use with a Cloud Code resolver on a Parse Server, as that is covered in the README.md file. However, my personal view, having encountered difficulty in finding the setup instructions after much searching of the docs earlier, is that custom schema setup instructions for Cloud Code resolver use should be added to the docs as well. This would make it easier for newer users to discover and use this excellent feature of Parse Server.
Additionally, this PR fixes a minor punctuation error in the definition of a
Relay Global Object Identification.