feat: [API] Merge non-GraphQL spec error fields into GraphQLError.extensions #401
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // | ||
| // Copyright 2018-2020 Amazon.com, | ||
| // Inc. or its affiliates. All Rights Reserved. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
|
|
||
| import Foundation | ||
| import Amplify | ||
|
|
||
| extension GraphQLResponseDecoder { | ||
|
|
||
| static func decodeErrors(graphQLErrors: [JSONValue]) throws -> [GraphQLError] { | ||
| var responseErrors = [GraphQLError]() | ||
| for error in graphQLErrors { | ||
| do { | ||
| let responseError = try decode(graphQLErrorJSON: error) | ||
| responseErrors.append(responseError) | ||
| } catch let decodingError as DecodingError { | ||
| throw APIError(error: decodingError) | ||
| } catch { | ||
| throw APIError.unknown(""" | ||
| Unexpected failure while decoding GraphQL response containing errors: | ||
| \(String(describing: graphQLErrors)) | ||
| """, "", error) | ||
| } | ||
| } | ||
|
|
||
| return responseErrors | ||
| } | ||
|
|
||
| static func decode(graphQLErrorJSON: JSONValue) throws -> GraphQLError { | ||
| let serializedJSON = try JSONEncoder().encode(graphQLErrorJSON) | ||
| let decoder = JSONDecoder() | ||
| decoder.dateDecodingStrategy = ModelDateFormatting.decodingStrategy | ||
| let graphQLError = try decoder.decode(GraphQLError.self, from: serializedJSON) | ||
| return mergeExtensions(from: graphQLErrorJSON, graphQLError: graphQLError) | ||
| } | ||
|
|
||
| /// Merge fields which are not in the generic GraphQL error json over into the `GraphQLError.extensions` | ||
| /// This is the opinionated implementation of the plugin to store service errors which do not conform to the | ||
| /// GraphQL Error spec (https://spec.graphql.org/June2018/#sec-Errors) | ||
| private static func mergeExtensions(from graphQLErrorJSON: JSONValue, graphQLError: GraphQLError) -> GraphQLError { | ||
|
|
||
| var mergedExtensions = [String: JSONValue]() | ||
| if let graphQLErrorExtensions = graphQLError.extensions { | ||
| mergedExtensions = graphQLErrorExtensions | ||
| } | ||
|
|
||
| guard case let .object(graphQLErrorObject) = graphQLErrorJSON else { | ||
| return graphQLError | ||
| } | ||
|
|
||
| graphQLErrorObject.forEach { key, value in | ||
| if key == "message" || | ||
| key == "locations" || | ||
| key == "path" || | ||
| key == "extensions" || | ||
| mergedExtensions.keys.contains(key) { | ||
|
There was a problem hiding this comment. you could have a list of keys and then append the |
||
| return | ||
| } | ||
|
|
||
| mergedExtensions[key] = value | ||
| } | ||
|
|
||
| return GraphQLError(message: graphQLError.message, | ||
| locations: graphQLError.locations, | ||
| path: graphQLError.path, | ||
| extensions: !mergedExtensions.isEmpty ? mergedExtensions : nil) | ||
|
There was a problem hiding this comment. instead of the |
||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
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.
should that second argument contain something? Does the "report to AWS" suggestion fit here?
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.
it looks like we already do that when exposed to the developer