Fix Capacitor iOS binary parameter handling in SQLite adapter

Author: swhitt

.changeset/wobbly-octopi-juggle.md

@@ -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`.

packages/capacitor/src/adapter/CapacitorSQLiteAdapter.ts

@@ -18,6 +18,7 @@ import {
 import { PowerSyncCore } from '../plugin/PowerSyncCore.js';
 import { messageForErrorCode } from '../plugin/PowerSyncPlugin.js';
 import { CapacitorSQLiteOpenFactoryOptions, DEFAULT_SQLITE_OPTIONS } from './CapacitorSQLiteOpenFactory.js';
+import { normalizeIOSSqliteParams } from './sqliteParams.js';
 /**
  * Monitors the execution time of a query and logs it to the performance timeline.
  */
@@ -39,13 +40,15 @@ class CapacitorConnectionPool extends BaseObserver<DBAdapterListener> implements
   protected initializedPromise: Promise<void>;
   protected writeMutex: Mutex;
   protected readMutex: Mutex;
+  protected readonly platform: string;
 
   constructor(protected options: CapacitorSQLiteOpenFactoryOptions) {
     super();
     this._writeConnection = null;
     this._readConnection = null;
     this.writeMutex = new Mutex();
     this.readMutex = new Mutex();
+    this.platform = Capacitor.getPlatform();
     this.initializedPromise = this.init();
   }
 
@@ -98,8 +101,7 @@ class CapacitorConnectionPool extends BaseObserver<DBAdapterListener> implements
 
     await this._readConnection.open();
 
-    const platform = Capacitor.getPlatform();
-    if (platform == 'android') {
+    if (this.platform == 'android') {
       /**
        * SQLCipher for Android enables dynamic loading of extensions.
        * On iOS we use a static auto extension registration.
@@ -118,8 +120,10 @@ class CapacitorConnectionPool extends BaseObserver<DBAdapterListener> implements
   }
 
   protected generateLockContext(db: SQLiteDBConnection): LockContext {
+    const normalizeParams = (params: any[]) => (this.platform == 'ios' ? normalizeIOSSqliteParams(params) : params);
+
     const _query = async (query: string, params: any[] = []) => {
-      const result = await db.query(query, params);
+      const result = await db.query(query, normalizeParams(params));
       const arrayResult = result.values ?? [];
       return {
         rowsAffected: 0,
@@ -132,13 +136,11 @@ class CapacitorConnectionPool extends BaseObserver<DBAdapterListener> implements
     };
 
     const _execute = async (query: string, params: any[] = []): Promise<QueryResult> => {
-      const platform = Capacitor.getPlatform();
-
       if (db.getConnectionReadOnly()) {
         return _query(query, params);
       }
 
-      if (platform == 'android') {
+      if (this.platform == 'android') {
         // Android: use query for SELECT and executeSet for mutations
         // We cannot use `run` here for both cases.
         if (query.toLowerCase().trim().startsWith('select')) {
@@ -158,7 +160,7 @@ class CapacitorConnectionPool extends BaseObserver<DBAdapterListener> implements
       }
 
       // iOS (and other platforms): use run("all")
-      const result = await db.run(query, params, false, 'all');
+      const result = await db.run(query, normalizeParams(params), false, 'all');
       const resultSet = result.changes?.values ?? [];
       return {
         insertId: result.changes?.lastId,
@@ -207,7 +209,7 @@ class CapacitorConnectionPool extends BaseObserver<DBAdapterListener> implements
       let result = await db.executeSet(
         params.map((param) => ({
           statement: query,
-          values: param
+          values: normalizeParams(param)
         }))
       );
 

packages/capacitor/src/adapter/sqliteParams.ts

@@ -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;
+}