Sync progress #555
Merged
Sync progress #555
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
🦋 Changeset detectedLatest commit: 1de9e65 The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 packages
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 |
packages/common/src/client/sync/stream/AbstractStreamingSyncImplementation.ts
Outdated
Show resolved
Hide resolved
stevensJourney
previously approved these changes
May 2, 2025
stevensJourney
approved these changes
May 2, 2025
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.
This implements the sync progress API for the JavaScript SDKs.
The overall API is very similar to the one exposed by the other SDKs:
SyncDataFlowStatus, which needs to be transferrable from workers, adds a newInternalProgressInformationfield tracking progress across different buckets. Users are encouraged not to use that directly though.downloadProgressgetter is added toSyncStatuswith the same interface we expose for Dart and Kotlin: AnuntilCompletiongetter and auntilPriority(priority)method. They both return a structure making the total and downloaded operations available (as well as a relative progress indicator).I've added unit tests for this through the Node SDK, because that's easier to test with a local core extension build than the Web / RN SDKs that need subsequent builds. I think we should eventually share tests between the SDKs to be sure we're not missing anything, but I think this already points towards the implementation working :)