Cleanup error related code #1914
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
👷 Deploy request for apollo-federation-docs pending review.Visit the deploys page to approve it
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
added 6 commits
June 28, 2022 10:42
We had a `GraphQLErrorArgs` type that was almost equivalent to the graphql-js `GraphQLErrorOptions`, and the reason being that the later was added recently-ish, but keeping that slight inconsistency doesn't make sense and this commit fixes. It does imply mimicking the new `GraphQLError` constructor signature which have the message first and the options, while we had put the message inside the options on our side, so this imply changing all the call sites, but it's one-off easy-if-annoying fix, so just went with it.
That `error` was early that never was kept up-to-date with other changes. In practice, it was called in one of 2 ways: 1. to check for code assertions (programmer errors). We have an `assert` method we use for this consistently and this commit use it for those usages. 2. for genuine graphql errors. But for those, we weren't giving a proper error code, so this commit switch to using the machinery from `error.ts` to handle those. The result being that this `error()` method has been removed.
Noticed while working on the errors that we were duplicating the error code that handled errors during the validation of a "field set", and that's easy enough to make dryer.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 started with wanting to remove our usages of the now deprecated
GraphQLErrorthat takes all arguments positionally (it's been deprecated by graphql-js in favour of a version that take a newGraphQLErrorOptionstype).Looking at this however, I noticed a few related cleanup and improvements that are in that PR. In particular:
GraphQLErrorParamsinerror.tswhich was almost the same thanGraphQLErrorOptions. The only difference being that we included themessagein our own, while graphql-js decide to keep the message separate. It didn't felt meaningful to keep our own version just for what, so the first commit switch to extracting themessageas it's own argument in our own error code and reusingGraphQLErrorOptions.new GraphQLError(...)but should really have been using a proper error code.I'll note that this later point means that this patch introduce a few new error codes. As the error code doc is trying to track when code have been introduced, I've tentatively marked those as "adding: 2.1.0" but don't see this as any commitment: if the review of this slips by 2.1.0, I'll just update those pre-commit (once I know for sure where it lands).