-
Notifications
You must be signed in to change notification settings - Fork 66
Fix Capacitor iOS binary SQLite param handling #905
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
Open
swhitt
wants to merge
1
commit into
powersync-ja:main
Choose a base branch
from
swhitt:sqlite-connector-fix
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@powersync/capacitor': patch | ||
| --- | ||
|
|
||
| Normalize binary SQLite parameters for Capacitor iOS so `Uint8Array` sync payloads can be passed through `powersync_control(...)` without hitting `Error in reading buffer`. |
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| export type IOSSqliteBufferParam = Record<string, number>; | ||
|
|
||
| export type NormalizedIOSSqliteParam = unknown | IOSSqliteBufferParam; | ||
|
|
||
| export function normalizeIOSSqliteParams(params: unknown[]): NormalizedIOSSqliteParam[] { | ||
| return params.map((param) => normalizeIOSSqliteParam(param)); | ||
| } | ||
|
|
||
| function normalizeIOSSqliteParam(value: unknown): NormalizedIOSSqliteParam { | ||
| if (value instanceof Uint8Array) { | ||
| return uint8ArrayToIOSBuffer(value); | ||
| } | ||
|
|
||
| if (value instanceof ArrayBuffer) { | ||
| return uint8ArrayToIOSBuffer(new Uint8Array(value)); | ||
| } | ||
|
|
||
| if (ArrayBuffer.isView(value)) { | ||
| return uint8ArrayToIOSBuffer(new Uint8Array(value.buffer, value.byteOffset, value.byteLength)); | ||
| } | ||
|
|
||
| return value; | ||
| } | ||
|
|
||
| function uint8ArrayToIOSBuffer(array: Uint8Array): IOSSqliteBufferParam { | ||
| // The Capacitor SQLite iOS bridge expects BLOB params as an index-keyed object | ||
| // with integer values. It does not accept typed arrays directly. | ||
| const result: IOSSqliteBufferParam = {}; | ||
| for (let i = 0; i < array.length; i++) { | ||
| result[String(i)] = array[i]; | ||
| } | ||
| return result; | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution! It's annoying that this workaround is required, but it is what it is.
This feels so absurdly inefficient that I think we should look into not using
line_binaryon Capacitor at all. Or maybe we need a hack to encode the blob as hex and then decode it withunhex(?)in SQLite. That's still inefficient and I think we should only do it on platforms where we need it.Out of curiosity, does this really work on Android or did you just test iOS? Anyway, can we return a regular JSON array here (e.g.
return [...array])? That should be slightly more efficient, but it's still not great.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re:
[...array], I think that'd skip the dict-based buffer path inCapacitorSQLite.swiftentirely. TheRecord<string, number>builds the shape the Swift side expects. Haven't tested Android. Agree onunhex(?)longer-term.