Skip to content

Define 'execution' as in 'before execution begins' #894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: benjie/incremental-common
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion spec/Section 3 -- Type System.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@ information on the serialization of scalars in common JSON and other formats.
If a GraphQL service expects a scalar type as input to an argument, coercion is
observable and the rules must be well defined. If an input value does not match
a coercion rule, a _request error_ must be raised (input values are validated
before execution begins).
before _execution_ begins).

GraphQL has different constant literals to represent integer and floating-point
input values, and coercion rules may apply differently depending on which type
Expand Down
2 changes: 1 addition & 1 deletion spec/Section 4 -- Introspection.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ GraphQL supports type name introspection within any _selection set_ in an
operation, with the single exception of selections at the root of a subscription
operation. Type name introspection is accomplished via the meta-field
`__typename: String!` on any Object, Interface, or Union. It returns the name of
the concrete Object type at that point during execution.
the concrete Object type at that point during _execution_.

This is most often used when querying against Interface or Union types to
identify which actual Object type of the possible types has been returned.
Expand Down
120 changes: 71 additions & 49 deletions spec/Section 6 -- Execution.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ A GraphQL service generates a response from a request via execution.
- {extensions} (optional): A map reserved for implementation-specific additional
information.

Given this information, the result of {ExecuteRequest(schema, document,
operationName, variableValues, initialValue)} produces the response, to be
formatted according to the Response section below.
Given this information, the result of {Request(schema, document, operationName,
variableValues, initialValue)} produces the response, to be formatted according
to the Response section below.

Implementations should not add additional properties to a _request_, which may
conflict with future editions of the GraphQL specification. Instead,
Expand All @@ -33,27 +33,44 @@ Note: GraphQL requests do not require any specific serialization format or
transport mechanism. Message serialization and transport mechanisms should be
chosen by the implementing service.

## Executing Requests
## Processing Requests

To execute a request, the executor must have a parsed {Document} and a selected
<a name="#sec-Executing-Requests">
<!-- Legacy link, this section was previously titled "Executing Requests" -->
</a>

To process a request, the executor must have a parsed {Document} and a selected
operation name to run if the document defines multiple operations, otherwise the
document is expected to only contain a single operation. The result of the
request is determined by the result of executing this operation according to the
"Executing Operations” section below.
request is determined by the result of performing this operation according to
the "Performing Operations” section below.

The {Request()} algorithm contains the preamble for _execution_, handling
concerns such as determining the operation and coercing the inputs, before
passing the request on to the relevant algorithm for the operation's type which
then performs any other necessary preliminary steps (for example establishing
the source event stream for subscription operations) and then initiates
_execution_.

Note: An error raised before _execution_ begins will typically be a _request
error_, and once _execution_ begins will typically be an _execution error_.

:: We define _execution_ as the process of executing the operation's _root
selection set_ through {ExecuteRootSelectionSet()}, and hence _execution_ begins
when {ExecuteRootSelectionSet()} is called for the first time in a request.

ExecuteRequest(schema, document, operationName, variableValues, initialValue):
Request(schema, document, operationName, variableValues, initialValue):

- Let {operation} be the result of {GetOperation(document, operationName)}.
- Let {coercedVariableValues} be the result of {CoerceVariableValues(schema,
operation, variableValues)}.
- If {operation} is a query operation:
- Return {ExecuteQuery(operation, schema, coercedVariableValues,
initialValue)}.
- Return {Query(operation, schema, coercedVariableValues, initialValue)}.
- Otherwise if {operation} is a mutation operation:
- Return {ExecuteMutation(operation, schema, coercedVariableValues,
initialValue)}.
- Return {Mutation(operation, schema, coercedVariableValues, initialValue)}.
- Otherwise if {operation} is a subscription operation:
- Return {Subscribe(operation, schema, coercedVariableValues, initialValue)}.
- Return {Subscription(operation, schema, coercedVariableValues,
initialValue)}.

GetOperation(document, operationName):

Expand All @@ -68,27 +85,28 @@ GetOperation(document, operationName):

### Validating Requests

As explained in the Validation section, only requests which pass all validation
rules should be executed. If validation errors are known, they should be
reported in the list of "errors" in the response and the request must fail
without execution.
As explained in the Validation section, only operations from documents which
pass all validation rules should be executed. If validation errors are known,
they should be reported in the list of "errors" in the response and the request
must fail without execution.

Typically validation is performed in the context of a request immediately before
execution, however a GraphQL service may execute a request without immediately
validating it if that exact same request is known to have been validated before.
A GraphQL service should only execute requests which _at some point_ were known
to be free of any validation errors, and have since not changed.
calling {Request()}, however a GraphQL service may process a request without
immediately validating the document if that exact same document is known to have
been validated before. A GraphQL service should only execute operations which
_at some point_ were known to be free of any validation errors, and have since
not changed.

For example: the request may be validated during development, provided it does
not later change, or a service may validate a request once and memoize the
result to avoid validating the same request again in the future.
For example: the document may be validated during development, provided it does
not later change, or a service may validate a document once and memoize the
result to avoid validating the same document again in the future.

### Coercing Variable Values

If the operation has defined any variables, then the values for those variables
need to be coerced using the input coercion rules of variable's declared type.
If a _request error_ is encountered during input coercion of variable values,
then the operation fails without execution.
then the request fails without _execution_.

CoerceVariableValues(schema, operation, variableValues):

Expand Down Expand Up @@ -123,7 +141,11 @@ CoerceVariableValues(schema, operation, variableValues):

Note: This algorithm is very similar to {CoerceArgumentValues()}.

## Executing Operations
## Performing Operations

<a name="#sec-Executing-Operations">
<!-- Legacy link, this section was previously titled "Executing Operations" -->
</a>

The type system, as described in the "Type System" section of the spec, must
provide a query root operation type. If mutations or subscriptions are
Expand All @@ -136,9 +158,9 @@ If the operation is a query, the result of the operation is the result of
executing the operation’s _root selection set_ with the query root operation
type.

An initial value may be provided when executing a query operation.
An initial value may be provided when performing a query operation.

ExecuteQuery(query, schema, variableValues, initialValue):
Query(query, schema, variableValues, initialValue):

- Let {queryType} be the root Query type in {schema}.
- Assert: {queryType} is an Object type.
Expand All @@ -156,7 +178,7 @@ It is expected that the top level fields in a mutation operation perform
side-effects on the underlying data system. Serial execution of the provided
mutations ensures against race conditions during these side-effects.

ExecuteMutation(mutation, schema, variableValues, initialValue):
Mutation(mutation, schema, variableValues, initialValue):

- Let {mutationType} be the root Mutation type in {schema}.
- Assert: {mutationType} is an Object type.
Expand All @@ -168,12 +190,13 @@ ExecuteMutation(mutation, schema, variableValues, initialValue):

If the operation is a subscription, the result is an _event stream_ called the
_response stream_ where each event in the event stream is the result of
executing the operation for each new event on an underlying _source stream_.
executing the operation’s _root selection set_ for each new event on an
underlying _source stream_.

Executing a subscription operation creates a persistent function on the service
Performing a subscription operation creates a persistent function on the service
that maps an underlying _source stream_ to a returned _response stream_.

Subscribe(subscription, schema, variableValues, initialValue):
Subscription(subscription, schema, variableValues, initialValue):

- Let {sourceStream} be the result of running
{CreateSourceEventStream(subscription, schema, variableValues, initialValue)}.
Expand All @@ -182,9 +205,9 @@ Subscribe(subscription, schema, variableValues, initialValue):
variableValues)}.
- Return {responseStream}.

Note: In a large-scale subscription system, the {Subscribe()} and
{ExecuteSubscriptionEvent()} algorithms may be run on separate services to
maintain predictable scaling properties. See the section below on Supporting
Note: In a large-scale subscription system, the {Subscription()} and
{SubscriptionEvent()} algorithms may be run on separate services to maintain
predictable scaling properties. See the section below on Supporting
Subscriptions at Scale.

As an example, consider a chat application. To subscribe to new messages posted
Expand Down Expand Up @@ -303,9 +326,8 @@ MapSourceToResponseEvent(sourceStream, subscription, schema, variableValues):

- Let {responseStream} be a new _event stream_.
- When {sourceStream} emits {sourceValue}:
- Let {response} be the result of running
{ExecuteSubscriptionEvent(subscription, schema, variableValues,
sourceValue)}.
- Let {response} be the result of running {SubscriptionEvent(subscription,
schema, variableValues, sourceValue)}.
- If internal {error} was raised:
- Cancel {sourceStream}.
- Complete {responseStream} with {error}.
Expand All @@ -319,21 +341,21 @@ MapSourceToResponseEvent(sourceStream, subscription, schema, variableValues):
- Complete {responseStream} normally.
- Return {responseStream}.

Note: Since {ExecuteSubscriptionEvent()} handles all _execution error_, and
_request error_ only occur during {CreateSourceEventStream()}, the only
remaining error condition handled from {ExecuteSubscriptionEvent()} are internal
exceptional errors not described by this specification.
Note: Since {SubscriptionEvent()} handles all _execution error_, and _request
error_ only occur during {CreateSourceEventStream()}, the only remaining error
condition handled from {SubscriptionEvent()} are internal exceptional errors not
described by this specification.

ExecuteSubscriptionEvent(subscription, schema, variableValues, initialValue):
SubscriptionEvent(subscription, schema, variableValues, initialValue):

- Let {subscriptionType} be the root Subscription type in {schema}.
- Assert: {subscriptionType} is an Object type.
- Let {rootSelectionSet} be the _root selection set_ in {subscription}.
- Return {ExecuteRootSelectionSet(variableValues, initialValue,
subscriptionType, rootSelectionSet, "normal")}.

Note: The {ExecuteSubscriptionEvent()} algorithm is intentionally similar to
{ExecuteQuery()} since this is how each event result is produced.
Note: The {SubscriptionEvent()} algorithm is intentionally similar to {Query()}
since this is how each event result is produced.

#### Unsubscribe

Expand Down Expand Up @@ -628,7 +650,7 @@ A valid GraphQL executor can resolve the four fields in whatever order it chose
(however of course `birthday` must be resolved before `month`, and `address`
before `street`).

When executing a mutation, the selections in the top most selection set will be
When performing a mutation, the selections in the top most selection set will be
executed in serial order, starting with the first appearing field textually.

When executing a grouped field set serially, the executor must consider each
Expand Down Expand Up @@ -775,9 +797,9 @@ CoerceArgumentValues(objectType, field, variableValues):
Any _request error_ raised as a result of input coercion during
{CoerceArgumentValues()} should be treated instead as an _execution error_.

Note: Variable values are not coerced because they are expected to be coerced
before executing the operation in {CoerceVariableValues()}, and valid operations
must only allow usage of variables of appropriate types.
Note: Variable values are not coerced because they are expected to be coerced by
{CoerceVariableValues()} before _execution_ begins, and valid operations must
only allow usage of variables of appropriate types.

### Value Resolution

Expand Down
18 changes: 11 additions & 7 deletions spec/Section 7 -- Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ key {"errors"}. The value of this entry is described in the "Errors" section. If
the request completed without raising any errors, this entry must not be
present.

If the request included execution, the response map must contain an entry with
If the request included _execution_, the response map must contain an entry with
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.
Expand Down Expand Up @@ -89,20 +89,24 @@ found at `["hero", "friends"]`, the hero's first friend at

### Data

The {"data"} entry in the response will be the result of the execution of the
The {"data"} entry in the response will be the result of the _execution_ of the
requested operation. If the operation was a query, this output will be an object
of the query root operation type; if the operation was a mutation, this output
will be an object of the mutation root operation type.

The response data is the result of accumulating the resolved result of all
response positions during execution.

If an error was raised before execution begins, the {"data"} entry should not be
present in the response.
If an error was raised before _execution_ begins, the {"data"} entry should not
be present in the response.

If an error was raised during the execution that prevented a valid response, the
If an error was raised during _execution_ that prevented a valid response, the
{"data"} entry in the response should be `null`.

Note: Request errors (including those raised during {ExecuteRequest()}) occur
before _execution_ begins; when a request error is raised the {"data"} entry
should not be present in the result.

### Errors

The {"errors"} entry in the response is a non-empty list of errors raised during
Expand All @@ -119,12 +123,12 @@ was able to be returned.

If the {"data"} entry in the response is present (including if it is the value
{null}), the {"errors"} entry must be present if and only if one or more
_execution error_ was raised during execution.
_execution error_ was raised during _execution_.

**Request Errors**

:: A _request error_ is an error raised during a _request_ which results in no
response data. Typically raised before execution begins, a request error may
response data. Typically raised before _execution_ begins, a request error may
occur due to a parse grammar or validation error in the _Document_, an inability
to determine which operation to execute, or invalid input values for variables.

Expand Down