Use dynamic extension loading for Android.

Author: stevensJourney

demos/example-capacitor/package.json

@@ -19,7 +19,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@capacitor-community/sqlite": "^7.0.1",
+    "@capacitor-community/sqlite": "^7.0.2",
     "@capacitor/android": "^7.4.3",
     "@capacitor/core": "latest",
     "@capacitor/ios": "^7.4.3",

packages/capacitor/PowerSyncCapacitor.podspec

@@ -0,0 +1,29 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'PowerSyncCapacitor'
+  version = package['version']
+  if version.include?('-dev')
+    s.version = '0.0.0'
+  else
+    s.version = version
+  end
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+   s.dependency "SQLCipher", "~> 4.0"
+  s.public_header_files = 'ios/Sources/CPowerSyncPlugin/include/*.h'
+  s.ios.deployment_target = '14.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+  s.dependency "powersync-sqlite-core", "~> 0.4.6"
+   s.xcconfig = {
+    'OTHER_CFLAGS' => '$(inherited) -DSQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION=1',
+    'HEADER_SEARCH_PATHS' => '$(inherited) "$(PODS_ROOT)/SQLCipher"'
+  }
+end

packages/capacitor/PowersyncCapacitor.podspec

@@ -3,7 +3,7 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name = 'PowersyncCapacitor'
+  s.name = 'PowerSyncCapacitor'
   version = package['version']
   if version.include?('-dev')
     s.version = '0.0.0'
@@ -21,7 +21,7 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = '14.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
-  s.dependency "powersync-sqlite-core", "~> 0.4.4"
+  s.dependency "powersync-sqlite-core", "~> 0.4.6"
    s.xcconfig = {
     'OTHER_CFLAGS' => '$(inherited) -DSQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION=1',
     'HEADER_SEARCH_PATHS' => '$(inherited) "$(PODS_ROOT)/SQLCipher"'

packages/capacitor/android/build.gradle

@@ -3,7 +3,7 @@ ext {
     androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
     androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
     androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
-    powerSyncCoreVersion = project.hasProperty('powerSyncCoreVersion') ? rootProject.ext.powerSyncCoreVersion : '0.4.5'
+    powerSyncCoreVersion = project.hasProperty('powerSyncCoreVersion') ? rootProject.ext.powerSyncCoreVersion : '0.4.6'
 }
 
 buildscript {

packages/capacitor/android/src/main/cpp/powersync_capacitor_jni.c

@@ -1,54 +1,8 @@
 #include <jni.h>
-#include <dlfcn.h>
-#include <android/log.h>
-
-#define LOG_TAG "PowerSyncNative"
-
-// Forward declarations (no need for full struct definitions)
-typedef struct sqlite3 sqlite3;
-typedef struct sqlite3_api_routines sqlite3_api_routines;
-
-typedef int (*sqlite3_auto_extension_fn)(void (*xEntryPoint)(void));
-
-extern int sqlite3_powersync_init(
-    sqlite3 *db,                              // Database handle
-    const char **pzErrMsg,                    // Error message out parameter
-    const struct sqlite3_api_routines *pThunk // SQLite API routines
-);
 
+// SQLCipher enables dynamic loading of extensions. We don't need to do anything here.
 int register_powersync(void) {
-    void *handle = dlopen("libsqlcipher.so", RTLD_LAZY);
-    if (!handle) {
-        __android_log_print(ANDROID_LOG_WARN, LOG_TAG, "Failed to dlopen libsqlcipher.so, trying process handle");
-        // Try loading from the process itself
-        handle = dlopen(NULL, RTLD_LAZY);
-        if (!handle) {
-            __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, "Failed to dlopen process handle. SQLCipher symbols not found.");
-            return -1;
-        }
-    } else {
-        __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Successfully loaded libsqlcipher.so");
-    }
-
-    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Resolving sqlite3_auto_extension symbol");
-    sqlite3_auto_extension_fn auto_ext = (sqlite3_auto_extension_fn)dlsym(handle, "sqlite3_auto_extension");
-    if (!auto_ext) {
-        __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, "Failed to resolve sqlite3_auto_extension symbol");
-    }
-
-
-    if (!auto_ext) {
-        __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, "Required symbols not found. Aborting registration.");
-        dlclose(handle);
-        return -2;
-    }
-
-    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Registering powersync extension");
-    int result = auto_ext((void(*)(void))sqlite3_powersync_init);
-    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "register_powersync result: %d", result);
-    dlclose(handle);
-    __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, "Completed register_powersync");
-    return result;
+  return 0;
 }
 
 // JNI wrapper

packages/capacitor/android/src/main/java/com/powersync/capacitor/PowerSync.java

@@ -1,12 +1,8 @@
 package com.powersync.capacitor;
 
-import com.getcapacitor.Logger;
-
 public class PowerSync {
     static {
         System.loadLibrary("powersync_capacitor"); 
-        // Ensures we load this early before registering. 
-        System.loadLibrary("sqlcipher");
     }
 
     public static native int registerPowersync();

packages/capacitor/package.json

@@ -17,7 +17,7 @@
     "ios/Sources",
     "ios/Tests",
     "Package.swift",
-    "PowersyncCapacitor.podspec"
+    "PowerSyncCapacitor.podspec"
   ],
   "author": "",
   "license": "Apache-2.0",
@@ -48,6 +48,7 @@
     "build:prod": "pnpm build",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",
+    "test": "pnpm verify:android",
     "prepublishOnly": "pnpm build",
     "test:exports": "attw --pack ."
   },

packages/capacitor/src/adapter/CapacitorSQLiteAdapter.ts

@@ -89,14 +89,26 @@ export class CapacitorSQLiteAdapter extends BaseObserver<DBAdapterListener> impl
     await this._writeConnection.open();
 
     const { cacheSizeKb, journalSizeLimit, synchronous } = { ...DEFAULT_SQLITE_OPTIONS, ...this.options.sqliteOptions };
-    await this.writeConnection.query("SELECT powersync_update_hooks('install')");
+
     await this.writeConnection.query('PRAGMA journal_mode = WAL');
     await this.writeConnection.query(`PRAGMA journal_size_limit = ${journalSizeLimit}`);
     await this.writeConnection.query(`PRAGMA temp_store = memory`);
     await this.writeConnection.query(`PRAGMA synchronous = ${synchronous}`);
     await this.writeConnection.query(`PRAGMA cache_size = -${cacheSizeKb}`);
 
     await this._readConnection.open();
+
+    const platform = Capacitor.getPlatform();
+    if (platform == 'android') {
+      /**
+       * SQLCipher for Android enables dynamic loading of extensions.
+       * On iOS we use a static auto extension registration.
+       */
+      const extensionQuery = "SELECT load_extension('libpowersync.so', 'sqlite3_powersync_init')";
+      await this.writeConnection.query(extensionQuery);
+      await this.readConnection.query(extensionQuery);
+    }
+    await this.writeConnection.query("SELECT powersync_update_hooks('install')");
   }
 
   async close(): Promise<void> {

packages/capacitor/src/plugin/PowerSyncPlugin.ts

@@ -1,19 +1,12 @@
 export type RegistrationResponse = {
   /**
    * Zero for successful registration, non-zero for failure.
-   * - [Android] -1: SQLCipher library not found.
-   * - [Android] -2: Required symbols not found.
-   * - The result of sqlite3_auto_extension
    */
   responseCode: number;
 };
 
 export const messageForErrorCode = (code: number): string => {
   switch (code) {
-    case -1:
-      return '[Android] SQLCipher library not found';
-    case -2:
-      return '[Android] Required symbols not found';
     case 0:
       return 'Success';
     default:

packages/capacitor/src/sync/CapacitorSyncImplementation.ts

@@ -1,21 +1,12 @@
-import {
-  AbstractStreamingSyncImplementation,
-  AbstractStreamingSyncImplementationOptions,
-  LockOptions
-} from '@powersync/web';
+import { AbstractStreamingSyncImplementation, LockOptions } from '@powersync/web';
 import Lock from 'async-lock';
 
 export class CapacitorStreamingSyncImplementation extends AbstractStreamingSyncImplementation {
-  protected lock: Lock;
-  constructor(options: AbstractStreamingSyncImplementationOptions) {
-    // Super will store and provide default values for options
-    super(options);
-    this.lock = new Lock();
-  }
+  static GLOBAL_LOCK = new Lock();
 
   async obtainLock<T>(lockOptions: LockOptions<T>): Promise<T> {
     const identifier = `streaming-sync-${lockOptions.type}-${this.options.identifier}`;
-    return this.lock.acquire(identifier, async () => {
+    return CapacitorStreamingSyncImplementation.GLOBAL_LOCK.acquire(identifier, async () => {
       if (lockOptions.signal?.aborted) {
         throw new Error('Aborted');
       }