Remove binary_data field from protocol request #332
Merged
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: 1f1d25c The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 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 |
rkistner
previously approved these changes
Aug 20, 2025
simolus3
commented
Aug 20, 2025
modules/module-mongodb-storage/test/src/__snapshots__/storage_sync.test.ts.snap
Show resolved
Hide resolved
rkistner
approved these changes
Aug 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The
binary_datafield on sync requests is supposed to be true if clients will receive data as BSON documents instead of as JSON.Since the sync service knows which format it'll use, this field doesn't actually have to be set by clients at all. Indeed it's not supposed to, but the Rust client sends it anyway. This could lead to an inconsistency between
binary_databeing true and binary data actually being sent:Accept: application/vnd.powersync.bson-streamerrors ifbinary_datais not explicitly set to true in the request, because we're encoding values as BSON butbucketDataBatchthings it's JSON.binary_data: trueis a near-miss. This is what happens today with the Rust sync client, this only works because the unencoded events emitted bybucketDataBatchare serialized in thendjsontransformer.binary_datais now passed as a separate parameter to the sync stream.