feat: support hooking into execute stream (defer/stream) #429
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.
This PR is built upon #428 and serves as a POC for hoking into the phases where execute returns an AsyncIterable (which will be introduced as part of the next GraphQL major release for defer/stream support). Today, returning AsyncIterable from execute is already supported by various GraphQL servers such as graphql-helix, graphql-ws and graphql over Socket.io.
Adding this to envelop is a breaking change as the type signature of the
ExecuteDone
hook changes. The result type is nowAsyncIterable<ExecutionResult> | ExecutionResult
. Furthermore, the type signature ofexecute
is changed to now returnAsyncIterable<ExecutionResult> | ExecutionResult
.