Fix tests on watchOS simulator

Author: simolus3

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
       matrix:
         include:
           - os: macos-latest
-            targets: iosSimulatorArm64Test macosArm64Test jvmTest
+            targets: iosSimulatorArm64Test macosArm64Test watchosSimulatorArm64Test jvmTest
           - os: ubuntu-latest
             targets: testDebugUnitTest testReleaseUnitTest jvmTest lintKotlin
           - os: windows-latest

core/build.gradle.kts

@@ -6,6 +6,7 @@ import org.gradle.internal.os.OperatingSystem
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
 import org.jetbrains.kotlin.gradle.targets.jvm.tasks.KotlinJvmTest
 import org.jetbrains.kotlin.gradle.tasks.KotlinTest
+import org.jetbrains.kotlin.konan.target.Family
 
 
 plugins {
@@ -133,18 +134,16 @@ kotlin {
             compileTaskProvider {
                 compilerOptions.freeCompilerArgs.add("-Xexport-kdoc")
             }
-        }
 
-        /*
-        If we ever need macOS support:
-        {
-            binaries.withType<TestExecutable>().configureEach {
-                linkTaskProvider.dependsOn(downloadPowersyncDesktopBinaries)
-                linkerOpts("-lpowersync")
-                linkerOpts("-L", binariesFolder.map { it.dir("powersync") }.get().asFile.path)
+            if (this.target.konanTarget.family == Family.WATCHOS) {
+                // We're linking the core extension statically, which means that we need a cinterop
+                // to call powersync_init_static
+                cinterops.create("powersync_static") {
+                    packageName("com.powersync.static")
+                    headers(file("src/watchosMain/powersync_static.h"))
+                }
             }
         }
-         */
     }
 
     explicitApi()

core/src/appleMain/kotlin/com/powersync/DatabaseDriverFactory.ios.kt renamed to core/src/appleMain/kotlin/com/powersync/DatabaseDriverFactory.apple.kt

@@ -12,6 +12,7 @@ import co.touchlab.sqliter.sqlite3.sqlite3_enable_load_extension
 import co.touchlab.sqliter.sqlite3.sqlite3_load_extension
 import co.touchlab.sqliter.sqlite3.sqlite3_rollback_hook
 import co.touchlab.sqliter.sqlite3.sqlite3_update_hook
+import com.powersync.DatabaseDriverFactory.Companion.powerSyncExtensionPath
 import com.powersync.db.internal.InternalSchema
 import com.powersync.persistence.driver.NativeSqliteDriver
 import com.powersync.persistence.driver.wrapConnection
@@ -22,6 +23,7 @@ import kotlinx.cinterop.MemScope
 import kotlinx.cinterop.StableRef
 import kotlinx.cinterop.alloc
 import kotlinx.cinterop.asStableRef
+import kotlinx.cinterop.free
 import kotlinx.cinterop.nativeHeap
 import kotlinx.cinterop.ptr
 import kotlinx.cinterop.staticCFunction
@@ -132,38 +134,9 @@ public actual class DatabaseDriverFactory {
         connection: DatabaseConnection,
         driver: DeferredDriver,
     ) {
-        val ptr = connection.getDbPointer().getPointer(MemScope())
-        val extensionPath = powerSyncExtensionPath
-
-        // Enable extension loading
-        // We don't disable this after the fact, this should allow users to load their own extensions
-        // in future.
-        val enableResult = sqlite3_enable_load_extension(ptr, 1)
-        if (enableResult != SqliteErrorType.SQLITE_OK.code) {
-            throw PowerSyncException(
-                "Could not dynamically load the PowerSync SQLite core extension",
-                cause =
-                    Exception(
-                        "Call to sqlite3_enable_load_extension failed",
-                    ),
-            )
-        }
-
-        // A place to store a potential error message response
-        val errMsg = nativeHeap.alloc<CPointerVar<ByteVar>>()
-        val result =
-            sqlite3_load_extension(ptr, extensionPath, "sqlite3_powersync_init", errMsg.ptr)
-        if (result != SqliteErrorType.SQLITE_OK.code) {
-            val errorMessage = errMsg.value?.toKString() ?: "Unknown error"
-            throw PowerSyncException(
-                "Could not load the PowerSync SQLite core extension",
-                cause =
-                    Exception(
-                        "Calling sqlite3_load_extension failed with error: $errorMessage",
-                    ),
-            )
-        }
+        connection.loadPowerSyncSqliteCoreExtension()
 
+        val ptr = connection.getDbPointer().getPointer(MemScope())
         val driverRef = StableRef.create(driver)
 
         sqlite3_update_hook(
@@ -221,3 +194,41 @@ public actual class DatabaseDriverFactory {
         }
     }
 }
+
+internal fun DatabaseConnection.loadPowerSyncSqliteCoreExtensionDynamically() {
+    val ptr = getDbPointer().getPointer(MemScope())
+    val extensionPath = powerSyncExtensionPath
+
+    // Enable extension loading
+    // We don't disable this after the fact, this should allow users to load their own extensions
+    // in future.
+    val enableResult = sqlite3_enable_load_extension(ptr, 1)
+    if (enableResult != SqliteErrorType.SQLITE_OK.code) {
+        throw PowerSyncException(
+            "Could not dynamically load the PowerSync SQLite core extension",
+            cause =
+                Exception(
+                    "Call to sqlite3_enable_load_extension failed",
+                ),
+        )
+    }
+
+    // A place to store a potential error message response
+    val errMsg = nativeHeap.alloc<CPointerVar<ByteVar>>()
+    val result =
+        sqlite3_load_extension(ptr, extensionPath, "sqlite3_powersync_init", errMsg.ptr)
+    val resultingError = errMsg.value
+    nativeHeap.free(errMsg)
+    if (result != SqliteErrorType.SQLITE_OK.code) {
+        val errorMessage = resultingError?.toKString() ?: "Unknown error"
+        throw PowerSyncException(
+            "Could not load the PowerSync SQLite core extension",
+            cause =
+                Exception(
+                    "Calling sqlite3_load_extension failed with error: $errorMessage",
+                ),
+        )
+    }
+}
+
+internal expect fun DatabaseConnection.loadPowerSyncSqliteCoreExtension()

core/src/appleTest/kotlin/com/powersync/DatabaseDriverFactoryTest.kt

@@ -1,10 +1,16 @@
 package com.powersync
 
+import kotlin.experimental.ExperimentalNativeApi
 import kotlin.test.Test
 
 class DatabaseDriverFactoryTest {
+    @OptIn(ExperimentalNativeApi::class)
     @Test
     fun findsPowerSyncFramework() {
-        DatabaseDriverFactory.powerSyncExtensionPath
+        if (Platform.osFamily != OsFamily.WATCHOS) {
+            // On watchOS targets, there's no special extension path because we expect to link the
+            // PowerSync extension statically due to platform restrictions.
+            DatabaseDriverFactory.powerSyncExtensionPath
+        }
     }
 }

core/src/iosMain/kotlin/com/powersync/DatabaseDriverFactory.ios.kt

@@ -0,0 +1,7 @@
+package com.powersync
+
+import co.touchlab.sqliter.DatabaseConnection
+
+internal actual fun DatabaseConnection.loadPowerSyncSqliteCoreExtension() {
+    loadPowerSyncSqliteCoreExtensionDynamically()
+}

core/src/macosMain/kotlin/com/powersync/DatabaseDriverFactory.macos.kt

@@ -0,0 +1,7 @@
+package com.powersync
+
+import co.touchlab.sqliter.DatabaseConnection
+
+internal actual fun DatabaseConnection.loadPowerSyncSqliteCoreExtension() {
+    loadPowerSyncSqliteCoreExtensionDynamically()
+}

core/src/watchosMain/kotlin/com/powersync/DatabaseDriverFactory.watchos.kt

@@ -0,0 +1,17 @@
+package com.powersync
+
+import co.touchlab.sqliter.DatabaseConnection
+import com.powersync.static.powersync_init_static
+
+internal actual fun DatabaseConnection.loadPowerSyncSqliteCoreExtension() {
+    val rc = powersync_init_static()
+    if (rc != 0) {
+        throw PowerSyncException(
+            "Could not load the PowerSync SQLite core extension",
+            cause =
+                Exception(
+                    "Calling powersync_init_static returned result code $rc",
+                ),
+        )
+    }
+}

core/src/watchosMain/powersync_static.h

@@ -0,0 +1 @@
+int powersync_init_static();

plugins/build-plugin/src/main/kotlin/SharedBuildPlugin.kt

@@ -24,7 +24,7 @@ class SharedBuildPlugin : Plugin<Project> {
                 .toString()
 
         val frameworkUrl =
-            "https://github.com/powersync-ja/powersync-sqlite-core/releases/download/v$coreVersion/powersync-sqlite-core.xcframework.zip"
+            "file:/Users/simon/src/powersync-sqlite-core/powersync-sqlite-core.xcframework.zip"
 
         val downloadPowersyncFramework =
             project.tasks.register("downloadPowersyncFramework", Download::class.java) {