Only one way of dealing with ApolloError extensions #5294
Merged
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
In Apollo Server 2, we had two different ways to specify extensions to
`ApolloError`:
new ApolloError(message, code, {ext1: value})
new ApolloError(message, code, {extensions: {ext1: value}})
and two different ways to read those extensions back:
error.extensions.ext1
error.ext1
This also meant that the extension values showed up twice in the
user-exposed errors list.
In Apollo Server 3, we have just one way to do it: the first line of
each of those pairs. That is, we treat the third argument to the
ApolloError constructor as "the extensions", not "the extensions or
maybe something wrapping the extensions"; and we only put the extensions
on `error.extensions`, not directly on `error` as well. (Note that the
built in `code` and `exception` extensions already only lived on
`extensions` rather than showing up twice!)
If you try to use the old `{extensions: {...}}` method, the ApolloServer
constructor throws instead of creating an extension named `extensions`.
Fixes #3835.
glasser
added a commit
that referenced
this pull request
Jun 18, 2021
glasser
added a commit
that referenced
this pull request
Jun 18, 2021
glasser
added a commit
that referenced
this pull request
Jun 22, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In Apollo Server 2, we had two different ways to specify extensions to
ApolloError:and two different ways to read those extensions back:
This also meant that the extension values showed up twice in the
user-exposed errors list.
In Apollo Server 3, we have just one way to do it: the first line of
each of those pairs. That is, we treat the third argument to the
ApolloError constructor as "the extensions", not "the extensions or
maybe something wrapping the extensions"; and we only put the extensions
on
error.extensions, not directly onerroras well. (Note that thebuilt in
codeandexceptionextensions already only lived onextensionsrather than showing up twice!)If you try to use the old
{extensions: {...}}method, the ApolloServerconstructor throws instead of creating an extension named
extensions.Fixes #3835.