Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cloud_firestore): Firestore query snapshot with changes only #11539

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

bswhite1
Copy link

@bswhite1 bswhite1 commented Sep 1, 2023

Description

The current querySnapsot returns the list of all documents that match the query every time that a change occurs. For streams that return a large number of documents this an be an issue, as well as inefficient.

For instance, our use case requires us to keep a local cache of all documents returned by a query. When a single document is updated, querySnapshot will send a list all documents matching the query along with a list of the documents that were changed. All we need is that list of changes to update our local cache.

Since we have such a large number of documents in our streams, the querySnapshot was leading to issues with the method channels. We were getting ANR, and crashes while trying to pass data from the java to dart. This change has completely fixed these issues for us.

Changes were based on existing querySnapshot, to be backward compatible a new querySnapshotChanges was created that just removed the "docs".

I did not add any tests at this time. I can't seem to get the tests to run, even on a clean master branch. "melos run test:e2e:cloud_firestore" says, "Running", then "Installing" but then gets stuck on next step for 12 minutes and times out.

Has been in our custom flutterfire production library for over 2 months.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant