fix(data): update all operations to return flattened response, null, or empty array response on error
#13179
Conversation
david-mcafee
changed the title
|
|
||
| export function getFactory( | ||
| client: ClientWithModels, | ||
| modelIntrospection: ModelIntrospectionSchema, | ||
| model: SchemaModel, | ||
| operation: ModelOperation, | ||
| useContext = false | ||
| useContext = false, |
There was a problem hiding this comment.
We have always used trailing commas, but this PR removed them during a Prettier upgrade.
Will discuss during standup, but it's worth us making a decision on this now so we can either 1) reformat the library, or 2) change our local config to avoid these changes being included in future PRs
| /** | ||
| * Handle errors for list and index query operations | ||
| */ | ||
| export function handleListGraphQlError(error: any) { |
There was a problem hiding this comment.
I considered using a single utility that accepted a flag (something like isList), but decided against it as this approach seems slightly less error prone / more straightforward to parse. This is only a slight preference, so if someone feels more strongly that handleListGraphQlError and handleSingularGraphQlError should be a single utility function, I'm happy to combine them.
david-mcafee
changed the title
null or empty array response on error
| * if `flattenedResult`, result is an actual record: | ||
| */ | ||
| if (flattenedResult) { | ||
| // TODO: custom selection set. current selection set is default selection set only |
There was a problem hiding this comment.
This is the same TODO that can be found with the existing implementation in the try block
| if (options?.selectionSet) { | ||
| return { data: flattenedResult, errors }; | ||
| } else { | ||
| // TODO: refactor to avoid destructuring here |
There was a problem hiding this comment.
This is the same TODO that can be found with the existing implementation in the try block
david-mcafee
changed the title
null or empty array response on errornull, or empty array response on error
Description of changes
NOTE:
These changes have been ported over to the
amplify-api-nextrepo, and a new PR has been created for the tests added to this repo:https://github.com/aws-amplify/amplify-api-next/pull/145/files
#13279
fix(data): update all operations to return flattened response, null, or empty array response on error
Note: unit tests will not pass until the related types PR has been merged.
As of today, there are several response shapes for
datareturned to the customer when an error is present.datacan be:nullnullvalue:{ getPost: null }{ getPost: { id: '1', title: 'Hello, World!' } }This PR handles each of the above scenarios for all model operations by flattening the error response when necessary, and returning either
nullor an empty array unless actual data is present.Issue #, if available
Description of how you validated changes
Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.