Expose Firestore Bundles #2369
Merged
Expose Firestore Bundles #2369
Conversation
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
This moves the Bundle files to the their own package and deletes the duplicate Bundle class (the same class exists as BundleMetadata, but was merged incorrecly). BundleCache stays in local along with the other persistence classes.
BundleLoader is a port from Web, the tests are new since BundleLoader on Web only has integration tests. To make testing possible, I also added BundleListener
…e-android-sdk into mrschmidt/bundle/reader
Coverage ReportAffected SDKs
Test Logs
NotesHTML coverage reports can be produced locally with Head commit (eb792adb) is created by Prow via merging commits: b9d0318 11936cc. |
Binary Size ReportAffected SDKs
Test Logs
NotesHead commit (eb792adb) is created by Prow via merging commits: b9d0318 11936cc. |
Base automatically changed from
mrschmidt/bundle/loader
to
mrschmidt/bundle/master
February 1, 2021 17:31
wu-hui
requested changes
Feb 1, 2021
| @@ -51,7 +51,7 @@ | |||
| import org.json.JSONObject; | |||
|
|
|||
| /** A JSON serializer to deserialize Firestore Bundles. */ | |||
| class BundleSerializer { | |||
| public class BundleSerializer { | |||
There was a problem hiding this comment.
Not related to this line, in decodeDocument createTime is omitted..I think we don't use it in our SDK, but maybe we should include? Or is this intentional?
There was a problem hiding this comment.
We don't use createTime in the Mobile SDKs. The version we use is derived from updateTime.
| + "schema_version INTEGER)"); | ||
| + "schema_version INTEGER, " | ||
| + "total_documents INTEGER, " | ||
| + "total_bytes INTEGER)"); |
There was a problem hiding this comment.
total_documents and total_bytes are only used during loading, they are not of much use after it is loaded, and we should not persist them.
There was a problem hiding this comment.
I have added and removed these fields quite a few times now. Unfortunately, it seems easier to just include them in BundleMetadata, as the combined state can then be passed around in one object. Note that unlike JS, the BundleLoader cannot just grab these values from the JSON stream since they need to be deserialized first. If we want to omit these values from persistence, I think they are only two strategies:
- We create a BundleMetadata and a BundleMetadataDuringLoading and only use BundleMetadata in Storage
- We don't write these values to persistence and use -1 or similar values to populate BundleMetadata when we deserialize
Both of these options seems much less clean to me.
| @@ -501,6 +506,20 @@ private void doUnlisten(JSONArray unlistenSpec) throws Exception { | |||
| queue.runSync(() -> eventManager.removeQueryListener(listener)); | |||
| } | |||
|
|
|||
| private void doLoadBundle(String json) throws Exception { | |||
There was a problem hiding this comment.
This confuses me, how did spec tests run before this PR?
There was a problem hiding this comment.
They have "no-android" tags and didn't run before they were removed in this PR.
|
/retest |
1 similar comment
|
/retest |
|
@schmidt-sebastian: The following tests failed, say
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
WE HAVE REACHED THE END!
This PR adds the API endpoints, the SyncEngine logic and the integration tests for Bundles.
Some notable changes:
I rewrote EventAccumulator to support assertNoAdditionalEvents().
I added totalBytes/totalDocuments back to BundleMetadata as it made plumbing these values through much easier.