Spec edits for incremental delivery, Section 3 only #1132
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yaacovCR
reviewed
Jan 8, 2025
| highly recommended that GraphQL services honor the `@defer` and `@stream` | ||
| directives on each execution. However, the specification allows advanced use | ||
| cases where the service can determine that it is more performant to not defer | ||
| and/or stream. Therefore, GraphQL clients _must_ be able to process a response |
There was a problem hiding this comment.
I think we discussed around this proposal that the @defer (and maybe @stream?) directives would have to be honored or not honored (with responses inlined) in the same fashion as applied to each item in a list. I think this would be important to mention, as this allows clients to cache their determinations as to whether the defer was inlined. This is relied on, for example, in graphql/graphql-js#4319 which introduces a transformer from the new format to the legacy version.1
Footnotes
-
Note that the transformer functionality grew a bit unwieldy and will be probably be spun off if useful to a separate library outside
graphql-js. ↩
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extracted from the full PR (#1110) and targeting an integration branch to aid in review.
Helpful reference material:
Response format examples: graphql/defer-stream-wg#69
GraphQL Conf talk: https://www.youtube.com/watch?v=LEyDeNoobT0