diff --git a/cspell.yml b/cspell.yml index e8aa73355..8bc4a231c 100644 --- a/cspell.yml +++ b/cspell.yml @@ -4,6 +4,7 @@ ignoreRegExpList: - /[a-z]{2,}'s/ words: # Terms of art + - deprioritization - endianness - interoperation - monospace diff --git a/spec/Section 3 -- Type System.md b/spec/Section 3 -- Type System.md index d32b08566..e5a955a9b 100644 --- a/spec/Section 3 -- Type System.md +++ b/spec/Section 3 -- Type System.md @@ -794,8 +794,9 @@ And will yield the subset of each object type queried: When querying an Object, the resulting mapping of fields are conceptually ordered in the same order in which they were encountered during execution, excluding fragments for which the type does not apply and fields or fragments -that are skipped via `@skip` or `@include` directives. This ordering is -correctly produced when using the {CollectFields()} algorithm. +that are skipped via `@skip` or `@include` directives or temporarily skipped via +`@defer`. This ordering is correctly produced when using the {CollectFields()} +algorithm. Response serialization formats capable of representing ordered maps should maintain this ordering. Serialization formats which can only represent unordered @@ -1942,6 +1943,11 @@ by a validator, executor, or client tool such as a code generator. GraphQL implementations should provide the `@skip` and `@include` directives. +GraphQL implementations are not required to implement the `@defer` and `@stream` +directives. If either or both of these directives are implemented, they must be +implemented according to this specification. GraphQL implementations that do not +support these directives must not make them available via introspection. + GraphQL implementations that support the type system definition language must provide the `@deprecated` directive if representing deprecated portions of the schema. @@ -2162,3 +2168,99 @@ to the relevant IETF specification. ```graphql example scalar UUID @specifiedBy(url: "https://tools.ietf.org/html/rfc4122") ``` + +### @defer + +```graphql +directive @defer( + label: String + if: Boolean! = true +) on FRAGMENT_SPREAD | INLINE_FRAGMENT +``` + +The `@defer` directive may be provided for fragment spreads and inline fragments +to inform the executor to delay the execution of the current fragment to +indicate deprioritization of the current fragment. A query with `@defer` +directive will cause the request to potentially return multiple responses, where +non-deferred data is delivered in the initial response and data deferred is +delivered in a subsequent response. `@include` and `@skip` take precedence over +`@defer`. + +```graphql example +query myQuery($shouldDefer: Boolean) { + user { + name + ...someFragment @defer(label: "someLabel", if: $shouldDefer) + } +} +fragment someFragment on User { + id + profile_picture { + uri + } +} +``` + +#### @defer Arguments + +- `if: Boolean! = true` - When `true`, fragment _should_ be deferred (See + [related note](#note-088b7)). When `false`, fragment will not be deferred and + data will be included in the initial response. Defaults to `true` when + omitted. +- `label: String` - May be used by GraphQL clients to identify the data from + responses and associate it with the corresponding defer directive. If + provided, the GraphQL service must add it to the corresponding payload. + `label` must be unique label across all `@defer` and `@stream` directives in a + document. `label` must not be provided as a variable. + +### @stream + +```graphql +directive @stream( + label: String + if: Boolean! = true + initialCount: Int = 0 +) on FIELD +``` + +The `@stream` directive may be provided for a field of `List` type so that the +backend can leverage technology such as asynchronous iterators to provide a +partial list in the initial response, and additional list items in subsequent +responses. `@include` and `@skip` take precedence over `@stream`. + +```graphql example +query myQuery($shouldStream: Boolean) { + user { + friends(first: 10) { + nodes @stream(label: "friendsStream", initialCount: 5, if: $shouldStream) + } + } +} +``` + +#### @stream Arguments + +- `if: Boolean! = true` - When `true`, field _should_ be streamed (See + [related note](#note-088b7)). When `false`, the field will not be streamed and + all list items will be included in the initial response. Defaults to `true` + when omitted. +- `label: String` - May be used by GraphQL clients to identify the data from + responses and associate it with the corresponding stream directive. If + provided, the GraphQL service must add it to the corresponding payload. + `label` must be unique label across all `@defer` and `@stream` directives in a + document. `label` must not be provided as a variable. +- `initialCount: Int` - The number of list items the service should return as + part of the initial response. If omitted, defaults to `0`. A field error will + be raised if the value of this argument is less than `0`. + +Note: The ability to defer and/or stream parts of a response can have a +potentially significant impact on application performance. Developers generally +need clear, predictable control over their application's performance. It is +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 +that ignores the `@defer` and/or `@stream` directives. This also applies to the +`initialCount` argument on the `@stream` directive. Clients _must_ be able to +process a streamed response that contains a different number of initial list +items than what was specified in the `initialCount` argument. diff --git a/spec/Section 5 -- Validation.md b/spec/Section 5 -- Validation.md index dceec126b..1e8fbd6d7 100644 --- a/spec/Section 5 -- Validation.md +++ b/spec/Section 5 -- Validation.md @@ -422,6 +422,7 @@ FieldsInSetCanMerge(set): {set} including visiting fragments and inline fragments. - Given each pair of members {fieldA} and {fieldB} in {fieldsForName}: - {SameResponseShape(fieldA, fieldB)} must be true. + - {SameStreamDirective(fieldA, fieldB)} must be true. - If the parent types of {fieldA} and {fieldB} are equal or if either is not an Object Type: - {fieldA} and {fieldB} must have identical field names. @@ -455,6 +456,16 @@ SameResponseShape(fieldA, fieldB): - If {SameResponseShape(subfieldA, subfieldB)} is false, return false. - Return true. +SameStreamDirective(fieldA, fieldB): + +- If neither {fieldA} nor {fieldB} has a directive named `stream`. + - Return true. +- If both {fieldA} and {fieldB} have a directive named `stream`. + - Let {streamA} be the directive named `stream` on {fieldA}. + - Let {streamB} be the directive named `stream` on {fieldB}. + - If {streamA} and {streamB} have identical sets of arguments, return true. +- Return false. + **Explanatory Text** If multiple field selections with the same response names are encountered during @@ -1517,6 +1528,174 @@ query ($foo: Boolean = true, $bar: Boolean = false) { } ``` +### Defer And Stream Directives Are Used On Valid Root Field + +** Formal Specification ** + +- For every {directive} in a document. +- Let {directiveName} be the name of {directive}. +- Let {mutationType} be the root Mutation type in {schema}. +- Let {subscriptionType} be the root Subscription type in {schema}. +- If {directiveName} is "defer" or "stream": + - The parent type of {directive} must not be {mutationType} or + {subscriptionType}. + +**Explanatory Text** + +The defer and stream directives are not allowed to be used on root fields of the +mutation or subscription type. + +For example, the following document will not pass validation because `@defer` +has been used on a root mutation field: + +```raw graphql counter-example +mutation { + ... @defer { + mutationField + } +} +``` + +### Defer And Stream Directives Are Used On Valid Operations + +** Formal Specification ** + +- Let {subscriptionFragments} be the empty set. +- For each {operation} in a document: + - If {operation} is a subscription operation: + - Let {fragments} be every fragment referenced by that {operation} + transitively. + - For each {fragment} in {fragments}: + - Let {fragmentName} be the name of {fragment}. + - Add {fragmentName} to {subscriptionFragments}. +- For every {directive} in a document: + - If {directiveName} is not "defer" or "stream": + - Continue to the next {directive}. + - Let {ancestor} be the ancestor operation or fragment definition of + {directive}. + - If {ancestor} is a fragment definition: + - If the fragment name of {ancestor} is not present in + {subscriptionFragments}: + - Continue to the next {directive}. + - If {ancestor} is not a subscription operation: + - Continue to the next {directive}. + - Let {if} be the argument named "if" on {directive}. + - {if} must be defined. + - Let {argumentValue} be the value passed to {if}. + - {argumentValue} must be a variable, or the boolean value "false". + +**Explanatory Text** + +The defer and stream directives can not be used to defer or stream data in +subscription operations. If these directives appear in a subscription operation +they must be disabled using the "if" argument. This rule will not permit any +defer or stream directives on a subscription operation that cannot be disabled +using the "if" argument. + +For example, the following document will not pass validation because `@defer` +has been used in a subscription operation with no "if" argument defined: + +```raw graphql counter-example +subscription sub { + newMessage { + ... @defer { + body + } + } +} +``` + +### Defer And Stream Directive Labels Are Unique + +** Formal Specification ** + +- Let {labelValues} be an empty set. +- For every {directive} in the document: + - Let {directiveName} be the name of {directive}. + - If {directiveName} is "defer" or "stream": + - For every {argument} in {directive}: + - Let {argumentName} be the name of {argument}. + - Let {argumentValue} be the value passed to {argument}. + - If {argumentName} is "label": + - {argumentValue} must not be a variable. + - {argumentValue} must not be present in {labelValues}. + - Append {argumentValue} to {labelValues}. + +**Explanatory Text** + +The `@defer` and `@stream` directives each accept an argument "label". This +label may be used by GraphQL clients to uniquely identify response payloads. If +a label is passed, it must not be a variable and it must be unique within all +other `@defer` and `@stream` directives in the document. + +For example the following document is valid: + +```graphql example +{ + dog { + ...fragmentOne + ...fragmentTwo @defer(label: "dogDefer") + } + pets @stream(label: "petStream") { + name + } +} + +fragment fragmentOne on Dog { + name +} + +fragment fragmentTwo on Dog { + owner { + name + } +} +``` + +For example, the following document will not pass validation because the same +label is used in different `@defer` and `@stream` directives.: + +```raw graphql counter-example +{ + dog { + ...fragmentOne @defer(label: "MyLabel") + } + pets @stream(label: "MyLabel") { + name + } +} + +fragment fragmentOne on Dog { + name +} +``` + +### Stream Directives Are Used On List Fields + +**Formal Specification** + +- For every {directive} in a document. +- Let {directiveName} be the name of {directive}. +- If {directiveName} is "stream": + - Let {adjacent} be the AST node the directive affects. + - {adjacent} must be a List type. + +**Explanatory Text** + +GraphQL directive locations do not provide enough granularity to distinguish the +type of fields used in a GraphQL document. Since the stream directive is only +valid on list fields, an additional validation rule must be used to ensure it is +used correctly. + +For example, the following document will only pass validation if `field` is +defined as a List type in the associated schema. + +```graphql counter-example +query { + field @stream(initialCount: 0) +} +``` + ## Variables ### Variable Uniqueness diff --git a/spec/Section 6 -- Execution.md b/spec/Section 6 -- Execution.md index f357069f9..5f690f311 100644 --- a/spec/Section 6 -- Execution.md +++ b/spec/Section 6 -- Execution.md @@ -31,6 +31,10 @@ request is determined by the result of executing this operation according to the ExecuteRequest(schema, document, operationName, variableValues, initialValue): +Note: the execution assumes implementing language supports coroutines. +Alternatively, the socket can provide a write buffer pointer to allow +{ExecuteRequest()} to directly write payloads into the buffer. + - Let {operation} be the result of {GetOperation(document, operationName)}. - Let {coercedVariableValues} be the result of {CoerceVariableValues(schema, operation, variableValues)}. @@ -128,15 +132,28 @@ An initial value may be provided when executing a query operation. ExecuteQuery(query, schema, variableValues, initialValue): +- Let {subsequentPayloads} be an empty list. - Let {queryType} be the root Query type in {schema}. - Assert: {queryType} is an Object type. - Let {selectionSet} be the top level Selection Set in {query}. - Let {data} be the result of running {ExecuteSelectionSet(selectionSet, - queryType, initialValue, variableValues)} _normally_ (allowing - parallelization). + queryType, initialValue, variableValues, subsequentPayloads)} _normally_ + (allowing parallelization). - Let {errors} be the list of all _field error_ raised while executing the selection set. -- Return an unordered map containing {data} and {errors}. +- If {subsequentPayloads} is empty: + - Return an unordered map containing {data} and {errors}. +- If {subsequentPayloads} is not empty: + - Let {initialResponse} be an unordered map containing {data}, {errors}, and + an entry named {hasNext} with the value {true}. + - Let {iterator} be the result of running + {YieldSubsequentPayloads(initialResponse, subsequentPayloads)}. + - For each {payload} yielded by {iterator}: + - If a termination signal is received: + - Send a termination signal to {iterator}. + - Return. + - Otherwise: + - Yield {payload}. ### Mutation @@ -150,14 +167,27 @@ mutations ensures against race conditions during these side-effects. ExecuteMutation(mutation, schema, variableValues, initialValue): +- Let {subsequentPayloads} be an empty list. - Let {mutationType} be the root Mutation type in {schema}. - Assert: {mutationType} is an Object type. - Let {selectionSet} be the top level Selection Set in {mutation}. - Let {data} be the result of running {ExecuteSelectionSet(selectionSet, - mutationType, initialValue, variableValues)} _serially_. + mutationType, initialValue, variableValues, subsequentPayloads)} _serially_. - Let {errors} be the list of all _field error_ raised while executing the selection set. -- Return an unordered map containing {data} and {errors}. +- If {subsequentPayloads} is empty: + - Return an unordered map containing {data} and {errors}. +- If {subsequentPayloads} is not empty: + - Let {initialResponse} be an unordered map containing {data}, {errors}, and + an entry named {hasNext} with the value {true}. + - Let {iterator} be the result of running + {YieldSubsequentPayloads(initialResponse, subsequentPayloads)}. + - For each {payload} yielded by {iterator}: + - If a termination signal is received: + - Send a termination signal to {iterator}. + - Return. + - Otherwise: + - Yield {payload}. ### Subscription @@ -290,9 +320,10 @@ MapSourceToResponseEvent(sourceStream, subscription, schema, variableValues): - Return a new event stream {responseStream} which yields events as follows: - For each {event} on {sourceStream}: - - Let {response} be the result of running + - Let {executionResult} be the result of running {ExecuteSubscriptionEvent(subscription, schema, variableValues, event)}. - - Yield an event containing {response}. + - For each {response} yielded by {executionResult}: + - Yield an event containing {response}. - When {responseStream} completes: complete this event stream. ExecuteSubscriptionEvent(subscription, schema, variableValues, initialValue): @@ -321,6 +352,53 @@ Unsubscribe(responseStream): - Cancel {responseStream} +## Yield Subsequent Payloads + +If an operation contains subsequent payload records resulting from `@stream` or +`@defer` directives, the {YieldSubsequentPayloads} algorithm defines how the +payloads should be processed. + +YieldSubsequentPayloads(initialResponse, subsequentPayloads): + +- Let {initialRecords} be any items in {subsequentPayloads} with a completed + {dataExecution}. +- Initialize {initialIncremental} to an empty list. +- For each {record} in {initialRecords}: + - Remove {record} from {subsequentPayloads}. + - If {isCompletedIterator} on {record} is {true}: + - Continue to the next record in {records}. + - Let {payload} be the completed result returned by {dataExecution}. + - Append {payload} to {initialIncremental}. +- If {initialIncremental} is not empty: + - Add an entry to {initialResponse} named `incremental` containing the value + {incremental}. +- Yield {initialResponse}. +- While {subsequentPayloads} is not empty: + - If a termination signal is received: + - For each {record} in {subsequentPayloads}: + - If {record} contains {iterator}: + - Send a termination signal to {iterator}. + - Return. + - Wait for at least one record in {subsequentPayloads} to have a completed + {dataExecution}. + - Let {subsequentResponse} be an unordered map with an entry {incremental} + initialized to an empty list. + - Let {records} be the items in {subsequentPayloads} with a completed + {dataExecution}. + - For each {record} in {records}: + - Remove {record} from {subsequentPayloads}. + - If {isCompletedIterator} on {record} is {true}: + - Continue to the next record in {records}. + - Let {payload} be the completed result returned by {dataExecution}. + - Append {payload} to the {incremental} entry on {subsequentResponse}. + - If {subsequentPayloads} is empty: + - Add an entry to {subsequentResponse} named `hasNext` with the value + {false}. + - Otherwise, if {subsequentPayloads} is not empty: + - Add an entry to {subsequentResponse} named `hasNext` with the value + {true}. + - Yield {subsequentResponse} + ## Executing Selection Sets To execute a selection set, the object value being evaluated and the object type @@ -331,10 +409,13 @@ First, the selection set is turned into a grouped field set; then, each represented field in the grouped field set produces an entry into a response map. -ExecuteSelectionSet(selectionSet, objectType, objectValue, variableValues): +ExecuteSelectionSet(selectionSet, objectType, objectValue, variableValues, path, +subsequentPayloads, asyncRecord): -- Let {groupedFieldSet} be the result of {CollectFields(objectType, - selectionSet, variableValues)}. +- If {path} is not provided, initialize it to an empty list. +- If {subsequentPayloads} is not provided, initialize it to the empty set. +- Let {groupedFieldSet} and {deferredGroupedFieldsList} be the result of + {CollectFields(objectType, selectionSet, variableValues)}. - Initialize {resultMap} to an empty ordered map. - For each {groupedFieldSet} as {responseKey} and {fields}: - Let {fieldName} be the name of the first entry in {fields}. Note: This value @@ -343,8 +424,12 @@ ExecuteSelectionSet(selectionSet, objectType, objectValue, variableValues): {objectType}. - If {fieldType} is defined: - Let {responseValue} be {ExecuteField(objectType, objectValue, fieldType, - fields, variableValues)}. + fields, variableValues, path, subsequentPayloads, asyncRecord)}. - Set {responseValue} as the value for {responseKey} in {resultMap}. +- For each {deferredGroupFieldSet} and {label} in {deferredGroupedFieldsList} + - Call {ExecuteDeferredFragment(label, objectType, objectValue, + deferredGroupFieldSet, path, variableValues, asyncRecord, + subsequentPayloads)} - Return {resultMap}. Note: {resultMap} is ordered by which fields appear first in the operation. This @@ -359,9 +444,71 @@ either resolving to {null} if allowed or further propagated to a parent field. If this occurs, any sibling fields which have not yet executed or have not yet yielded a value may be cancelled to avoid unnecessary work. +Additionally, async payload records in {subsequentPayloads} must be filtered if +their path points to a location that has resolved to {null} due to propagation +of a field error. This is described in +[Filter Subsequent Payloads](#sec-Filter-Subsequent-Payloads). These async +payload records must be removed from {subsequentPayloads} and their result must +not be sent to clients. If these async records have not yet executed or have not +yet yielded a value they may also be cancelled to avoid unnecessary work. + Note: See [Handling Field Errors](#sec-Handling-Field-Errors) for more about this behavior. +### Filter Subsequent Payloads + +When a field error is raised, there may be async payload records in +{subsequentPayloads} with a path that points to a location that has been removed +or set to null due to null propagation. These async payload records must be +removed from subsequent payloads and their results must not be sent to clients. + +In {FilterSubsequentPayloads}, {nullPath} is the path which has resolved to null +after propagation as a result of a field error. {currentAsyncRecord} is the +async payload record where the field error was raised. {currentAsyncRecord} will +not be set for field errors that were raised during the initial execution +outside of {ExecuteDeferredFragment} or {ExecuteStreamField}. + +FilterSubsequentPayloads(subsequentPayloads, nullPath, currentAsyncRecord): + +- For each {asyncRecord} in {subsequentPayloads}: + - If {asyncRecord} is the same record as {currentAsyncRecord}: + - Continue to the next record in {subsequentPayloads}. + - Initialize {index} to zero. + - While {index} is less then the length of {nullPath}: + - Initialize {nullPathItem} to the element at {index} in {nullPath}. + - Initialize {asyncRecordPathItem} to the element at {index} in the {path} + of {asyncRecord}. + - If {nullPathItem} is not equivalent to {asyncRecordPathItem}: + - Continue to the next record in {subsequentPayloads}. + - Increment {index} by one. + - Remove {asyncRecord} from {subsequentPayloads}. Optionally, cancel any + incomplete work in the execution of {asyncRecord}. + +For example, assume the field `alwaysThrows` is a `Non-Null` type that always +raises a field error: + +```graphql example +{ + myObject { + ... @defer { + name + } + alwaysThrows + } +} +``` + +In this case, only one response should be sent. The async payload record +associated with the `@defer` directive should be removed and its execution may +be cancelled. + +```json example +{ + "data": { "myObject": null }, + "hasNext": false +} +``` + ### Normal and Serial Execution Normally the executor can execute the entries in a grouped field set in whatever @@ -458,13 +605,24 @@ A correct executor must generate the following result for that selection set: } ``` +When subsections contain a `@stream` or `@defer` directive, these subsections +are no longer required to execute serially. Execution of the deferred or +streamed sections of the subsection may be executed in parallel, as defined in +{ExecuteStreamField} and {ExecuteDeferredFragment}. + ### Field Collection Before execution, the selection set is converted to a grouped field set by calling {CollectFields()}. Each entry in the grouped field set is a list of fields that share a response key (the alias if defined, otherwise the field name). This ensures all fields with the same response key (including those in -referenced fragments) are executed at the same time. +referenced fragments) are executed at the same time. A deferred selection set's +fields will not be included in the grouped field set. Rather, a record +representing the deferred fragment and additional context will be stored in a +list. The executor revisits and resumes execution for the list of deferred +fragment records after the initial execution is initiated. This deferred +execution would ‘re-execute’ fields with the same response key that were present +in the grouped field set. As an example, collecting the fields of this selection set would collect two instances of the field `a` and one of field `b`: @@ -489,10 +647,13 @@ The depth-first-search order of the field groups produced by {CollectFields()} is maintained through execution, ensuring that fields appear in the executed response in a stable and predictable order. -CollectFields(objectType, selectionSet, variableValues, visitedFragments): +CollectFields(objectType, selectionSet, variableValues, visitedFragments, +deferredGroupedFieldsList): - If {visitedFragments} is not provided, initialize it to the empty set. - Initialize {groupedFields} to an empty ordered map of lists. +- If {deferredGroupedFieldsList} is not provided, initialize it to an empty + list. - For each {selection} in {selectionSet}: - If {selection} provides the directive `@skip`, let {skipDirective} be that directive. @@ -512,9 +673,16 @@ CollectFields(objectType, selectionSet, variableValues, visitedFragments): - Append {selection} to the {groupForResponseKey}. - If {selection} is a {FragmentSpread}: - Let {fragmentSpreadName} be the name of {selection}. - - If {fragmentSpreadName} is in {visitedFragments}, continue with the next - {selection} in {selectionSet}. - - Add {fragmentSpreadName} to {visitedFragments}. + - If {fragmentSpreadName} provides the directive `@defer` and its {if} + argument is not {false} and is not a variable in {variableValues} with the + value {false}: + - Let {deferDirective} be that directive. + - If this execution is for a subscription operation, raise a _field + error_. + - If {deferDirective} is not defined: + - If {fragmentSpreadName} is in {visitedFragments}, continue with the next + {selection} in {selectionSet}. + - Add {fragmentSpreadName} to {visitedFragments}. - Let {fragment} be the Fragment in the current Document whose name is {fragmentSpreadName}. - If no such {fragment} exists, continue with the next {selection} in @@ -523,9 +691,18 @@ CollectFields(objectType, selectionSet, variableValues, visitedFragments): - If {DoesFragmentTypeApply(objectType, fragmentType)} is false, continue with the next {selection} in {selectionSet}. - Let {fragmentSelectionSet} be the top-level selection set of {fragment}. + - If {deferDirective} is defined: + - Let {label} be the value or the variable to {deferDirective}'s {label} + argument. + - Let {deferredGroupedFields} be the result of calling + {CollectFields(objectType, fragmentSelectionSet, variableValues, + visitedFragments, deferredGroupedFieldsList)}. + - Append a record containing {label} and {deferredGroupedFields} to + {deferredGroupedFieldsList}. + - Continue with the next {selection} in {selectionSet}. - Let {fragmentGroupedFieldSet} be the result of calling {CollectFields(objectType, fragmentSelectionSet, variableValues, - visitedFragments)}. + visitedFragments, deferredGroupedFieldsList)}. - For each {fragmentGroup} in {fragmentGroupedFieldSet}: - Let {responseKey} be the response key shared by all fields in {fragmentGroup}. @@ -538,16 +715,34 @@ CollectFields(objectType, selectionSet, variableValues, visitedFragments): fragmentType)} is false, continue with the next {selection} in {selectionSet}. - Let {fragmentSelectionSet} be the top-level selection set of {selection}. + - If {InlineFragment} provides the directive `@defer` and its {if} argument + is not {false} and is not a variable in {variableValues} with the value + {false}: + - Let {deferDirective} be that directive. + - If this execution is for a subscription operation, raise a _field + error_. + - If {deferDirective} is defined: + - Let {label} be the value or the variable to {deferDirective}'s {label} + argument. + - Let {deferredGroupedFields} be the result of calling + {CollectFields(objectType, fragmentSelectionSet, variableValues, + visitedFragments, deferredGroupedFieldsList)}. + - Append a record containing {label} and {deferredGroupedFields} to + {deferredGroupedFieldsList}. + - Continue with the next {selection} in {selectionSet}. - Let {fragmentGroupedFieldSet} be the result of calling {CollectFields(objectType, fragmentSelectionSet, variableValues, - visitedFragments)}. + visitedFragments, deferredGroupedFieldsList)}. - For each {fragmentGroup} in {fragmentGroupedFieldSet}: - Let {responseKey} be the response key shared by all fields in {fragmentGroup}. - Let {groupForResponseKey} be the list in {groupedFields} for {responseKey}; if no such list exists, create it as an empty list. - Append all items in {fragmentGroup} to {groupForResponseKey}. -- Return {groupedFields}. +- Return {groupedFields}, {deferredGroupedFieldsList} and {visitedFragments}. + +Note: The steps in {CollectFields()} evaluating the `@skip` and `@include` +directives may be applied in either order since they apply commutatively. DoesFragmentTypeApply(objectType, fragmentType): @@ -561,8 +756,56 @@ DoesFragmentTypeApply(objectType, fragmentType): - if {objectType} is a possible type of {fragmentType}, return {true} otherwise return {false}. -Note: The steps in {CollectFields()} evaluating the `@skip` and `@include` -directives may be applied in either order since they apply commutatively. +#### Async Payload Record + +An Async Payload Record is either a Deferred Fragment Record or a Stream Record. +All Async Payload Records are structures containing: + +- {label}: value derived from the corresponding `@defer` or `@stream` directive. +- {path}: a list of field names and indices from root to the location of the + corresponding `@defer` or `@stream` directive. +- {iterator}: The underlying iterator if created from a `@stream` directive. +- {isCompletedIterator}: a boolean indicating the payload record was generated + from an iterator that has completed. +- {errors}: a list of field errors encountered during execution. +- {dataExecution}: A result that can notify when the corresponding execution has + completed. + +#### Execute Deferred Fragment + +ExecuteDeferredFragment(label, objectType, objectValue, groupedFieldSet, path, +variableValues, parentRecord, subsequentPayloads): + +- Let {deferRecord} be an async payload record created from {label} and {path}. +- Initialize {errors} on {deferRecord} to an empty list. +- Let {dataExecution} be the asynchronous future value of: + - Let {payload} be an unordered map. + - Initialize {resultMap} to an empty ordered map. + - For each {groupedFieldSet} as {responseKey} and {fields}: + - Let {fieldName} be the name of the first entry in {fields}. Note: This + value is unaffected if an alias is used. + - Let {fieldType} be the return type defined for the field {fieldName} of + {objectType}. + - If {fieldType} is defined: + - Let {responseValue} be {ExecuteField(objectType, objectValue, fieldType, + fields, variableValues, path, subsequentPayloads, asyncRecord)}. + - Set {responseValue} as the value for {responseKey} in {resultMap}. + - Append any encountered field errors to {errors}. + - If {parentRecord} is defined: + - Wait for the result of {dataExecution} on {parentRecord}. + - If {errors} is not empty: + - Add an entry to {payload} named `errors` with the value {errors}. + - If a field error was raised, causing a {null} to be propagated to + {responseValue}: + - Add an entry to {payload} named `data` with the value {null}. + - Otherwise: + - Add an entry to {payload} named `data` with the value {resultMap}. + - If {label} is defined: + - Add an entry to {payload} named `label` with the value {label}. + - Add an entry to {payload} named `path` with the value {path}. + - Return {payload}. +- Set {dataExecution} on {deferredFragmentRecord}. +- Append {deferRecord} to {subsequentPayloads}. ## Executing Fields @@ -572,16 +815,19 @@ coerces any provided argument values, then resolves a value for the field, and finally completes that value either by recursively executing another selection set or coercing a scalar value. -ExecuteField(objectType, objectValue, fieldType, fields, variableValues): +ExecuteField(objectType, objectValue, fieldType, fields, variableValues, path, +subsequentPayloads, asyncRecord): - Let {field} be the first entry in {fields}. - Let {fieldName} be the field name of {field}. +- Append {fieldName} to {path}. - Let {argumentValues} be the result of {CoerceArgumentValues(objectType, field, variableValues)} - Let {resolvedValue} be {ResolveFieldValue(objectType, objectValue, fieldName, argumentValues)}. -- Return the result of {CompleteValue(fieldType, fields, resolvedValue, - variableValues)}. +- Let {result} be the result of calling {CompleteValue(fieldType, fields, + resolvedValue, variableValues, path, subsequentPayloads, asyncRecord)}. +- Return {result}. ### Coercing Field Arguments @@ -650,6 +896,12 @@ As an example, this might accept the {objectType} `Person`, the {field} {"soulMate"}, and the {objectValue} representing John Lennon. It would be expected to yield the value representing Yoko Ono. +List values are resolved similarly. For example, {ResolveFieldValue} might also +accept the {objectType} `MusicBand`, the {field} {"members"}, and the +{objectValue} representing the Beatles. It would be expected to yield a +collection of values representing John Lennon, Paul McCartney, Ringo Starr and +George Harrison. + ResolveFieldValue(objectType, objectValue, fieldName, argumentValues): - Let {resolver} be the internal function provided by {objectType} for @@ -660,30 +912,110 @@ ResolveFieldValue(objectType, objectValue, fieldName, argumentValues): Note: It is common for {resolver} to be asynchronous due to relying on reading an underlying database or networked service to produce a value. This necessitates the rest of a GraphQL executor to handle an asynchronous execution -flow. +flow. In addition, an implementation for collections may leverage asynchronous +iterators or asynchronous generators provided by many programming languages. +This may be particularly helpful when used in conjunction with the `@stream` +directive. ### Value Completion After resolving the value for a field, it is completed by ensuring it adheres to the expected return type. If the return type is another Object type, then the -field execution process continues recursively. - -CompleteValue(fieldType, fields, result, variableValues): +field execution process continues recursively. If the return type is a List +type, each member of the resolved collection is completed using the same value +completion process. In the case where `@stream` is specified on a field of list +type, value completion iterates over the collection until the number of items +yielded items satisfies `initialCount` specified on the `@stream` directive. + +#### Execute Stream Field + +ExecuteStreamField(label, iterator, index, fields, innerType, path, +parentRecord, variableValues, subsequentPayloads): + +- Let {streamRecord} be an async payload record created from {label}, {path}, + and {iterator}. +- Initialize {errors} on {streamRecord} to an empty list. +- Let {itemPath} be {path} with {index} appended. +- Let {dataExecution} be the asynchronous future value of: + - Wait for the next item from {iterator}. + - If an item is not retrieved because {iterator} has completed: + - Set {isCompletedIterator} to {true} on {streamRecord}. + - Return {null}. + - Let {payload} be an unordered map. + - If an item is not retrieved because of an error: + - Append the encountered error to {errors}. + - Add an entry to {payload} named `items` with the value {null}. + - Otherwise: + - Let {item} be the item retrieved from {iterator}. + - Let {data} be the result of calling {CompleteValue(innerType, fields, + item, variableValues, itemPath, subsequentPayloads, parentRecord)}. + - Append any encountered field errors to {errors}. + - Increment {index}. + - Call {ExecuteStreamField(label, iterator, index, fields, innerType, path, + streamRecord, variableValues, subsequentPayloads)}. + - If a field error was raised, causing a {null} to be propagated to {data}, + and {innerType} is a Non-Nullable type: + - Add an entry to {payload} named `items` with the value {null}. + - Otherwise: + - Add an entry to {payload} named `items` with a list containing the value + {data}. + - If {errors} is not empty: + - Add an entry to {payload} named `errors` with the value {errors}. + - If {label} is defined: + - Add an entry to {payload} named `label` with the value {label}. + - Add an entry to {payload} named `path` with the value {itemPath}. + - If {parentRecord} is defined: + - Wait for the result of {dataExecution} on {parentRecord}. + - Return {payload}. +- Set {dataExecution} on {streamRecord}. +- Append {streamRecord} to {subsequentPayloads}. + +CompleteValue(fieldType, fields, result, variableValues, path, +subsequentPayloads, asyncRecord): - If the {fieldType} is a Non-Null type: - Let {innerType} be the inner type of {fieldType}. - Let {completedResult} be the result of calling {CompleteValue(innerType, - fields, result, variableValues)}. + fields, result, variableValues, path)}. - If {completedResult} is {null}, raise a _field error_. - Return {completedResult}. - If {result} is {null} (or another internal value similar to {null} such as {undefined}), return {null}. - If {fieldType} is a List type: - If {result} is not a collection of values, raise a _field error_. + - Let {field} be the first entry in {fields}. - Let {innerType} be the inner type of {fieldType}. - - Return a list where each list item is the result of calling - {CompleteValue(innerType, fields, resultItem, variableValues)}, where - {resultItem} is each item in {result}. + - If {field} provides the directive `@stream` and its {if} argument is not + {false} and is not a variable in {variableValues} with the value {false} and + {innerType} is the outermost return type of the list type defined for + {field}: + - Let {streamDirective} be that directive. + - If this execution is for a subscription operation, raise a _field error_. + - Let {initialCount} be the value or variable provided to + {streamDirective}'s {initialCount} argument. + - If {initialCount} is less than zero, raise a _field error_. + - Let {label} be the value or variable provided to {streamDirective}'s + {label} argument. + - Let {iterator} be an iterator for {result}. + - Let {items} be an empty list. + - Let {index} be zero. + - While {result} is not closed: + - If {streamDirective} is defined and {index} is greater than or equal to + {initialCount}: + - Call {ExecuteStreamField(label, iterator, index, fields, innerType, + path, asyncRecord, subsequentPayloads)}. + - Return {items}. + - Otherwise: + - Wait for the next item from {result} via the {iterator}. + - If an item is not retrieved because of an error, raise a _field error_. + - Let {resultItem} be the item retrieved from {result}. + - Let {itemPath} be {path} with {index} appended. + - Let {resolvedItem} be the result of calling {CompleteValue(innerType, + fields, resultItem, variableValues, itemPath, subsequentPayloads, + asyncRecord)}. + - Append {resolvedItem} to {items}. + - Increment {index}. + - Return {items}. - If {fieldType} is a Scalar or Enum type: - Return the result of {CoerceResult(fieldType, result)}. - If {fieldType} is an Object, Interface, or Union type: @@ -693,8 +1025,8 @@ CompleteValue(fieldType, fields, result, variableValues): - Let {objectType} be {ResolveAbstractType(fieldType, result)}. - Let {subSelectionSet} be the result of calling {MergeSelectionSets(fields)}. - Return the result of evaluating {ExecuteSelectionSet(subSelectionSet, - objectType, result, variableValues)} _normally_ (allowing for - parallelization). + objectType, result, variableValues, path, subsequentPayloads, asyncRecord)} + _normally_ (allowing for parallelization). **Coercing Results** @@ -802,6 +1134,147 @@ resolves to {null}, then the entire list must resolve to {null}. If the `List` type is also wrapped in a `Non-Null`, the field error continues to propagate upwards. +When a field error is raised inside `ExecuteDeferredFragment` or +`ExecuteStreamField`, the defer and stream payloads act as error boundaries. +That is, the null resulting from a `Non-Null` type cannot propagate outside of +the boundary of the defer or stream payload. + +If a field error is raised while executing the selection set of a fragment with +the `defer` directive, causing a {null} to propagate to the object containing +this fragment, the {null} should not propagate any further. In this case, the +associated Defer Payload's `data` field must be set to {null}. + +For example, assume the `month` field is a `Non-Null` type that raises a field +error: + +```graphql example +{ + birthday { + ... @defer(label: "monthDefer") { + month + } + ... @defer(label: "yearDefer") { + year + } + } +} +``` + +Response 1, the initial response is sent: + +```json example +{ + "data": { "birthday": {} }, + "hasNext": true +} +``` + +Response 2, the defer payload for label "monthDefer" is sent. The {data} entry +has been set to {null}, as this {null} as propagated as high as the error +boundary will allow. + +```json example +{ + "incremental": [ + { + "path": ["birthday"], + "label": "monthDefer", + "data": null + } + ], + "hasNext": false +} +``` + +Response 3, the defer payload for label "yearDefer" is sent. The data in this +payload is unaffected by the previous null error. + +```json example +{ + "incremental": [ + { + "path": ["birthday"], + "label": "yearDefer", + "data": { "year": "2022" } + } + ], + "hasNext": false +} +``` + +If the `stream` directive is present on a list field with a Non-Nullable inner +type, and a field error has caused a {null} to propagate to the list item, the +{null} should not propagate any further, and the associated Stream Payload's +`item` field must be set to {null}. + +For example, assume the `films` field is a `List` type with an `Non-Null` inner +type. In this case, the second list item raises a field error: + +```graphql example +{ + films @stream(initialCount: 1) +} +``` + +Response 1, the initial response is sent: + +```json example +{ + "data": { "films": ["A New Hope"] }, + "hasNext": true +} +``` + +Response 2, the first stream payload is sent. The {items} entry has been set to +{null}, as this {null} as propagated as high as the error boundary will allow. + +```json example +{ + "incremental": [ + { + "path": ["films", 1], + "items": null + } + ], + "hasNext": false +} +``` + +In this alternative example, assume the `films` field is a `List` type without a +`Non-Null` inner type. In this case, the second list item also raises a field +error: + +```graphql example +{ + films @stream(initialCount: 1) +} +``` + +Response 1, the initial response is sent: + +```json example +{ + "data": { "films": ["A New Hope"] }, + "hasNext": true +} +``` + +Response 2, the first stream payload is sent. The {items} entry has been set to +a list containing {null}, as this {null} has only propagated as high as the list +item. + +```json example +{ + "incremental": [ + { + "path": ["films", 1], + "items": [null] + } + ], + "hasNext": false +} +``` + If all fields from the root of the request to the source of the field error return `Non-Null` types, then the {"data"} entry in the response should be {null}. diff --git a/spec/Section 7 -- Response.md b/spec/Section 7 -- Response.md index 8dcd9234c..db50408fa 100644 --- a/spec/Section 7 -- Response.md +++ b/spec/Section 7 -- Response.md @@ -10,7 +10,7 @@ the case that any _field error_ was raised on a field and was replaced with ## Response Format -A response to a GraphQL request must be a map. +A response to a GraphQL request must be a map or a response stream of maps. If the request raised any errors, the response map must contain an entry with key `errors`. The value of this entry is described in the "Errors" section. If @@ -22,14 +22,40 @@ key `data`. The value of this entry is described in the "Data" section. If the request failed before execution, due to a syntax error, missing information, or validation error, this entry must not be present. +When the response of the GraphQL operation is a response stream, the first value +will be the initial response. All subsequent values may contain an `incremental` +entry, containing a list of Defer or Stream payloads. + +The `label` and `path` entries on Defer and Stream payloads are used by clients +to identify the `@defer` or `@stream` directive from the GraphQL operation that +triggered this response to be included in an `incremental` entry on a value +returned by the response stream. When a label is provided, the combination of +these two entries will be unique across all Defer and Stream payloads returned +in the response stream. + +If the response of the GraphQL operation is a response stream, each response map +must contain an entry with key `hasNext`. The value of this entry is `true` for +all but the last response in the stream. The value of this entry is `false` for +the last response of the stream. This entry must not be present for GraphQL +operations that return a single response map. + +The GraphQL service may determine there are no more values in the response +stream after a previous value with `hasNext` equal to `true` has been emitted. +In this case the last value in the response stream should be a map without +`data` and `incremental` entries, and a `hasNext` entry with a value of `false`. + The response map may also contain an entry with key `extensions`. This entry, if set, must have a map as its value. This entry is reserved for implementors to extend the protocol however they see fit, and hence there are no additional -restrictions on its contents. +restrictions on its contents. When the response of the GraphQL operation is a +response stream, implementors may send subsequent response maps containing only +`hasNext` and `extensions` entries. Defer and Stream payloads may also contain +an entry with the key `extensions`, also reserved for implementors to extend the +protocol however they see fit. To ensure future changes to the protocol do not break existing services and clients, the top level response map must not contain any entries other than the -three described above. +five described above. Note: When `errors` is present in the response, it may be helpful for it to appear first when serialized to make it more clear when errors are present in a @@ -107,14 +133,8 @@ syntax element. If an error can be associated to a particular field in the GraphQL result, it must contain an entry with the key `path` that details the path of the response field which experienced the error. This allows clients to identify whether a -`null` result is intentional or caused by a runtime error. - -This field should be a list of path segments starting at the root of the -response and ending with the field associated with the error. Path segments that -represent fields should be strings, and path segments that represent list -indices should be 0-indexed integers. If the error happens in an aliased field, -the path to the error should use the aliased name, since it represents a path in -the response, not in the request. +`null` result is intentional or caused by a runtime error. The value of this +field is described in the [Path](#sec-Path) section. For example, if fetching one of the friends' names fails in the following operation: @@ -244,6 +264,161 @@ discouraged. } ``` +### Incremental + +The `incremental` entry in the response is a non-empty list of Defer or Stream +payloads. If the response of the GraphQL operation is a response stream, this +field may appear on both the initial and subsequent values. + +For example, a query containing both defer and stream: + +```graphql example +query { + person(id: "cGVvcGxlOjE=") { + ...HomeWorldFragment @defer(label: "homeWorldDefer") + name + films @stream(initialCount: 1, label: "filmsStream") { + title + } + } +} +fragment HomeWorldFragment on Person { + homeWorld { + name + } +} +``` + +The response stream might look like: + +Response 1, the initial response does not contain any deferred or streamed +results. + +```json example +{ + "data": { + "person": { + "name": "Luke Skywalker", + "films": [{ "title": "A New Hope" }] + } + }, + "hasNext": true +} +``` + +Response 2, contains the defer payload and the first stream payload. + +```json example +{ + "incremental": [ + { + "label": "homeWorldDefer", + "path": ["person"], + "data": { "homeWorld": { "name": "Tatooine" } } + }, + { + "label": "filmsStream", + "path": ["person", "films", 1], + "items": [{ "title": "The Empire Strikes Back" }] + } + ], + "hasNext": true +} +``` + +Response 3, contains the final stream payload. In this example, the underlying +iterator does not close synchronously so {hasNext} is set to {true}. If this +iterator did close synchronously, {hasNext} would be set to {false} and this +would be the final response. + +```json example +{ + "incremental": [ + { + "label": "filmsStream", + "path": ["person", "films", 2], + "items": [{ "title": "Return of the Jedi" }] + } + ], + "hasNext": true +} +``` + +Response 4, contains no incremental payloads. {hasNext} set to {false} indicates +the end of the response stream. This response is sent when the underlying +iterator of the `films` field closes. + +```json example +{ + "hasNext": false +} +``` + +#### Stream payload + +A stream payload is a map that may appear as an item in the `incremental` entry +of a response. A stream payload is the result of an associated `@stream` +directive in the operation. A stream payload must contain `items` and `path` +entries and may contain `label`, `errors`, and `extensions` entries. + +##### Items + +The `items` entry in a stream payload is a list of results from the execution of +the associated @stream directive. This output will be a list of the same type of +the field with the associated `@stream` directive. If `items` is set to `null`, +it indicates that an error has caused a `null` to bubble up to a field higher +than the list field with the associated `@stream` directive. + +#### Defer payload + +A defer payload is a map that may appear as an item in the `incremental` entry +of a response. A defer payload is the result of an associated `@defer` directive +in the operation. A defer payload must contain `data` and `path` entries and may +contain `label`, `errors`, and `extensions` entries. + +##### Data + +The `data` entry in a Defer payload will be of the type of a particular field in +the GraphQL result. The adjacent `path` field will contain the path segments of +the field this data is associated with. If `data` is set to `null`, it indicates +that an error has caused a `null` to bubble up to a field higher than the field +that contains the fragment with the associated `@defer` directive. + +#### Path + +A `path` field allows for the association to a particular field in a GraphQL +result. This field should be a list of path segments starting at the root of the +response and ending with the field to be associated with. Path segments that +represent fields should be strings, and path segments that represent list +indices should be 0-indexed integers. If the path is associated to an aliased +field, the path should use the aliased name, since it represents a path in the +response, not in the request. + +When the `path` field is present on a Stream payload, it indicates that the +`items` field represents the partial result of the list field containing the +corresponding `@stream` directive. All but the non-final path segments must +refer to the location of the list field containing the corresponding `@stream` +directive. The final segment of the path list must be a 0-indexed integer. This +integer indicates that this result is set at a range, where the beginning of the +range is at the index of this integer, and the length of the range is the length +of the data. + +When the `path` field is present on a Defer payload, it indicates that the +`data` field represents the result of the fragment containing the corresponding +`@defer` directive. The path segments must point to the location of the result +of the field containing the associated `@defer` directive. + +When the `path` field is present on an "Error result", it indicates the response +field which experienced the error. + +#### Label + +Stream and Defer payloads may contain a string field `label`. This `label` is +the same label passed to the `@defer` or `@stream` directive associated with the +response. This allows clients to identify which `@defer` or `@stream` directive +is associated with this value. `label` will not be present if the corresponding +`@defer` or `@stream` directive is not passed a `label` argument. + ## Serialization Format GraphQL does not require a specific serialization format. However, clients