fix(data-schema): skip null items in observeQuery - #796
Open
Tharaka-Chathuranga wants to merge 1 commit into
Open
Tharaka-Chathuranga wants to merge 1 commit into
Tharaka-Chathuranga wants to merge 1 commit into
Conversation
🦋 Changeset detectedLatest commit: c113220 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This file contains hidden or 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
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.
Problem
observeQuerycrashes withTypeError: Cannot read properties of null (reading 'id')when a subscription event arrives without an item.AppSync sends
{ data: { onCreateTodo: null }, errors: [...] }when the mutation that fired the event didn't return every required field. This is common withobserveQuery, because it subscribes with every field by default. It's also why passing a smallerselectionSetmakes the error go away.observeQuerypassed thatnullitem tofindIndexByFields, which threw. The error happens inside the subscription'snexthandler, so the subscriber'serrorcallback never runs and the app gets an uncaught exception.Issue number, if available: Fixes #655
Changes
observeQuery.ts: skip subscription events that have no item. Everything else works the same.2-expected-use/subscribe-to-real-time-events.ts. It sends empty create, update and delete events, then a normal create, and checks that:errorcallback isn't called@aws-amplify/data-schema.One thing I left alone: the
errorson those empty events are still dropped, the same as before. Sending them tosubscriber.errorwould close the whole observable, which felt like the wrong trade-off here. Happy to follow up if you'd like them surfaced another way.Corresponding docs PR, if applicable: N/A
Validation
mainwith the same stack trace as the issue, and passes with the fix.yarn checkpasses locally (build, test, lint, check:api, check:type-perf).Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.