-
Notifications
You must be signed in to change notification settings - Fork 1.1k
[RFC] Add error path to response #230
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
Changes from all commits
af713aa
775589b
72a9c2c
72d5ab9
fd3cdea
70ae404
de1cc89
14f5e53
a8d7df1
59aaa22
f2eff64
b74fbb8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -125,6 +125,17 @@ error is a map. | |
If no errors were encountered during the requested operation, the `errors` | ||
entry should not be present in the result. | ||
|
||
If the `data` entry in the response is not present, the `errors` | ||
entry in the response must not be empty. It must contain at least one error. | ||
The errors it contains should indicate why no data was able to be returned. | ||
|
||
If the `data` entry in the response is present (including if it is the value | ||
{null}), the `errors` entry in the response may contain any errors that | ||
occurred during execution. If errors occurred during execution, it should | ||
contain those errors. | ||
|
||
**Error result format** | ||
|
||
Every error must contain an entry with the key `message` with a string | ||
description of the error intended for the developer as a guide to understand | ||
and correct the error. | ||
|
@@ -135,14 +146,103 @@ locations, where each location is a map with the keys `line` and `column`, both | |
positive numbers starting from `1` which describe the beginning of an | ||
associated 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 query. | ||
|
||
For example, if fetching one of the friends' names fails in the following | ||
query: | ||
|
||
```graphql | ||
{ | ||
hero(episode: $episode) { | ||
name | ||
heroFriends: friends { | ||
id | ||
name | ||
} | ||
} | ||
} | ||
``` | ||
|
||
The response might look like: | ||
|
||
```js | ||
{ | ||
"errors": [ | ||
{ | ||
"message": "Name for character with ID 1002 could not be fetched.", | ||
"locations": [ { "line": 6, "column": 7 } ], | ||
"path": [ "hero", "heroFriends", 1, "name" ] | ||
} | ||
], | ||
"data": { | ||
"hero": { | ||
"name": "R2-D2", | ||
"heroFriends": [ | ||
{ | ||
"id": "1000", | ||
"name": "Luke Skywalker" | ||
}, | ||
{ | ||
"id": "1002", | ||
"name": null | ||
}, | ||
{ | ||
"id": "1003", | ||
"name": "Leia Organa" | ||
} | ||
] | ||
} | ||
} | ||
} | ||
``` | ||
|
||
If the field which experienced an error was declared as `Non-Null`, the `null` | ||
result will bubble up to the next nullable field. In that case, the `path` | ||
for the error should include the full path to the result field where the error | ||
occurred, even if that field is not present in the response. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How would this apply to lists of That shadow tree would have numeric indices for lists that are never returned. Is that the intention? For example: type Foo {
listOfInts: [Int!]!
}
type Bar {
listOfFoos: [Foo!]!
} const Bar = new GraphQLObjectType({
name: 'Bar',
fields: (() => ({
listOfFoos: {
type: new GraphQLNonNull(new GraphQLList(new GraphQLNonNull(Foo))),
resolve: () => ([
{"listOfInts": [0, 1, 2, 3]},
{"listOfInts": [0, 1, 2, null]},
{"listOfInts": [0, 1, 2, 3]},
]);
},
}),
}); The result would be ["bar", "listOfFoos", 1, 3] Unless I'm misunderstanding? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes that is the intention - the error path includes path segments that go deeper than the actual JSON the client returned. If the client doesn't need those path segments it can ignore them, and the server doesn't really need to do any extra work to make it happen in standard execution. |
||
|
||
For example, if the `name` field from above had declared a `Non-Null` return | ||
type in the schema, the result would look different but the error reported would | ||
be the same: | ||
|
||
```js | ||
{ | ||
"errors": [ | ||
{ | ||
"message": "Name for character with ID 1002 could not be fetched.", | ||
"locations": [ { "line": 6, "column": 7 } ], | ||
"path": [ "hero", "heroFriends", 1, "name" ] | ||
} | ||
], | ||
"data": { | ||
"hero": { | ||
"name": "R2-D2", | ||
"heroFriends": [ | ||
{ | ||
"id": "1000", | ||
"name": "Luke Skywalker" | ||
}, | ||
null, | ||
{ | ||
"id": "1003", | ||
"name": "Leia Organa" | ||
} | ||
] | ||
} | ||
} | ||
} | ||
``` | ||
|
||
GraphQL servers may provide additional entries to error as they choose to | ||
produce more helpful or machine-readable errors, however future versions of the | ||
spec may describe additional entries to errors. | ||
|
||
If the `data` entry in the response is `null` or not present, the `errors` | ||
entry in the response must not be empty. It must contain at least one error. | ||
The errors it contains should indicate why no data was able to be returned. | ||
|
||
If the `data` entry in the response is not `null`, the `errors` entry in the | ||
response may contain any errors that occurred during execution. If errors | ||
occurred during execution, it should contain those errors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we include an example of this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!