Merge pull request #147 from powersync-ja/native-static-link-sqlite

Link SQLite statically on native platforms

Author: simolus3

core/build.gradle.kts

@@ -1,4 +1,3 @@
-import com.android.build.gradle.internal.tasks.factory.dependsOn
 import com.powersync.plugins.sonatype.setupGithubRepository
 import de.undercouch.gradle.tasks.download.Download
 import org.gradle.internal.os.OperatingSystem
@@ -22,63 +21,6 @@ plugins {
     alias(libs.plugins.kotlin.atomicfu)
 }
 
-val sqliteVersion = "3450200"
-val sqliteReleaseYear = "2024"
-
-val sqliteSrcFolder =
-    project.layout.buildDirectory
-        .dir("native/sqlite")
-        .get()
-
-val downloadSQLiteSources by tasks.registering(Download::class) {
-    val zipFileName = "sqlite-amalgamation-$sqliteVersion.zip"
-    val destination = sqliteSrcFolder.file(zipFileName).asFile
-    src("https://www.sqlite.org/$sqliteReleaseYear/$zipFileName")
-    dest(destination)
-    onlyIfNewer(true)
-    overwrite(false)
-}
-
-val unzipSQLiteSources by tasks.registering(Copy::class) {
-    dependsOn(downloadSQLiteSources)
-
-    from(
-        zipTree(downloadSQLiteSources.get().dest).matching {
-            include("*/sqlite3.*")
-            exclude {
-                it.isDirectory
-            }
-            eachFile {
-                this.path = this.name
-            }
-        },
-    )
-    into(sqliteSrcFolder)
-}
-
-val buildCInteropDef by tasks.registering {
-    dependsOn(unzipSQLiteSources)
-
-    val interopFolder =
-        project.layout.buildDirectory
-            .dir("interop/sqlite")
-            .get()
-
-    val cFile = sqliteSrcFolder.file("sqlite3.c").asFile
-    val defFile = interopFolder.file("sqlite3.def").asFile
-
-    doFirst {
-        defFile.writeText(
-            """
-            package = com.powersync.sqlite3
-            ---
-
-            """.trimIndent() + cFile.readText(),
-        )
-    }
-    outputs.files(defFile)
-}
-
 val binariesFolder = project.layout.buildDirectory.dir("binaries/desktop")
 val downloadPowersyncDesktopBinaries by tasks.registering(Download::class) {
     description = "Download PowerSync core extensions for JVM builds and releases"
@@ -233,27 +175,11 @@ kotlin {
             compileTaskProvider {
                 compilerOptions.freeCompilerArgs.add("-Xexport-kdoc")
             }
-
-            cinterops.create("sqlite") {
-                val cInteropTask = tasks[interopProcessingTaskName]
-                cInteropTask.dependsOn(buildCInteropDef)
-                definitionFile =
-                    buildCInteropDef
-                        .get()
-                        .outputs.files.singleFile
-                compilerOpts.addAll(
-                    listOf(
-                        "-DHAVE_GETHOSTUUID=0",
-                        "-DSQLITE_ENABLE_LOAD_EXTENSION=1",
-                        "-DSQLITE_ENABLE_FTS5",
-                    ),
-                )
-            }
         }
 
         if (konanTarget.family == Family.IOS && konanTarget.name.contains("simulator")) {
             binaries.withType<TestExecutable>().configureEach {
-                linkTaskProvider.dependsOn(unzipPowersyncFramework)
+                linkTaskProvider.configure { dependsOn(unzipPowersyncFramework) }
                 linkerOpts("-framework", "powersync-sqlite-core")
                 val frameworkRoot =
                     binariesFolder
@@ -310,7 +236,7 @@ kotlin {
             implementation(libs.kotlinx.datetime)
             implementation(libs.stately.concurrency)
             implementation(libs.configuration.annotations)
-            api(project(":persistence"))
+            api(projects.persistence)
             api(libs.kermit)
         }
 
@@ -378,17 +304,6 @@ android {
                 .get()
                 .toInt()
         consumerProguardFiles("proguard-rules.pro")
-
-        @Suppress("UnstableApiUsage")
-        externalNativeBuild {
-            cmake {
-                arguments.addAll(
-                    listOf(
-                        "-DSQLITE3_SRC_DIR=${sqliteSrcFolder.asFile.absolutePath}",
-                    ),
-                )
-            }
-        }
     }
 
     sourceSets {
@@ -428,27 +343,4 @@ val testWithJava8 by tasks.registering(KotlinJvmTest::class) {
 }
 tasks.named("check").configure { dependsOn(testWithJava8) }
 
-afterEvaluate {
-    val buildTasks =
-        tasks.matching {
-            val taskName = it.name
-            if (taskName.contains("Clean")) {
-                return@matching false
-            }
-            if (taskName.contains("externalNative") ||
-                taskName.contains("CMake") ||
-                taskName.contains(
-                    "generateJsonModel",
-                )
-            ) {
-                return@matching true
-            }
-            return@matching false
-        }
-
-    buildTasks.forEach {
-        it.dependsOn(buildCInteropDef)
-    }
-}
-
 setupGithubRepository()

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

@@ -5,15 +5,14 @@ import co.touchlab.sqliter.DatabaseConfiguration.Logging
 import co.touchlab.sqliter.DatabaseConnection
 import co.touchlab.sqliter.interop.Logger
 import co.touchlab.sqliter.interop.SqliteErrorType
+import co.touchlab.sqliter.sqlite3.sqlite3_commit_hook
+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.db.internal.InternalSchema
 import com.powersync.persistence.driver.NativeSqliteDriver
 import com.powersync.persistence.driver.wrapConnection
-import com.powersync.sqlite3.sqlite3
-import com.powersync.sqlite3.sqlite3_commit_hook
-import com.powersync.sqlite3.sqlite3_enable_load_extension
-import com.powersync.sqlite3.sqlite3_load_extension
-import com.powersync.sqlite3.sqlite3_rollback_hook
-import com.powersync.sqlite3.sqlite3_update_hook
 import kotlinx.cinterop.ByteVar
 import kotlinx.cinterop.CPointerVar
 import kotlinx.cinterop.ExperimentalForeignApi
@@ -23,7 +22,6 @@ import kotlinx.cinterop.alloc
 import kotlinx.cinterop.asStableRef
 import kotlinx.cinterop.nativeHeap
 import kotlinx.cinterop.ptr
-import kotlinx.cinterop.reinterpret
 import kotlinx.cinterop.staticCFunction
 import kotlinx.cinterop.toKString
 import kotlinx.cinterop.value
@@ -103,7 +101,7 @@ public actual class DatabaseDriverFactory {
         connection: DatabaseConnection,
         driver: DeferredDriver,
     ) {
-        val basePointer = connection.getDbPointer().getPointer(MemScope())
+        val ptr = connection.getDbPointer().getPointer(MemScope())
         // Try and find the bundle path for the SQLite core extension.
         val bundlePath =
             NSBundle.bundleWithIdentifier("co.powersync.sqlitecore")?.bundlePath
@@ -116,10 +114,6 @@ public actual class DatabaseDriverFactory {
         // Construct full path to the shared library inside the bundle
         val extensionPath = bundlePath.let { "$it/powersync-sqlite-core" }
 
-        // We have a mix of SQLite operations. The SQliteR lib links to the system SQLite with `-lsqlite3`
-        // However we also include our own build of SQLite which is statically linked.
-        // Loading of extensions is only available using our version of SQLite's API
-        val ptr = basePointer.reinterpret<sqlite3>()
         // Enable extension loading
         // We don't disable this after the fact, this should allow users to load their own extensions
         // in future.
@@ -183,13 +177,8 @@ public actual class DatabaseDriverFactory {
     private fun deregisterSqliteBinding(connection: DatabaseConnection) {
         val basePtr = connection.getDbPointer().getPointer(MemScope())
 
-        // We have a mix of SQLite operations. The SQliteR lib links to the system SQLite with `-lsqlite3`
-        // However we also include our own build of SQLite which is statically linked.
-        // Loading of extensions is only available using our version of SQLite's API
-        val ptr = basePtr.reinterpret<sqlite3>()
-
         sqlite3_update_hook(
-            ptr,
+            basePtr,
             null,
             null,
         )

demos/supabase-todolist/iosApp/iosApp.xcodeproj/project.pbxproj

@@ -397,10 +397,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				OTHER_LDFLAGS = (
-					"$(inherited)",
-					"-lsqlite3",
-				);
+				OTHER_LDFLAGS = "$(inherited)";
 				PRODUCT_BUNDLE_IDENTIFIER = "${BUNDLE_ID}${TEAM_ID}";
 				PRODUCT_NAME = "${APP_NAME}";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -425,10 +422,7 @@
 					"$(inherited)",
 					"@executable_path/Frameworks",
 				);
-				OTHER_LDFLAGS = (
-					"$(inherited)",
-					"-lsqlite3",
-				);
+				OTHER_LDFLAGS = "$(inherited)";
 				PRODUCT_BUNDLE_IDENTIFIER = "${BUNDLE_ID}${TEAM_ID}";
 				PRODUCT_NAME = "${APP_NAME}";
 				PROVISIONING_PROFILE_SPECIFIER = "";

gradle/libs.versions.toml

@@ -18,6 +18,7 @@ uuid = "0.8.2"
 powersync-core = "0.3.12"
 sqlite-android = "3.45.0"
 sqlite-jdbc = "3.45.2.0"
+sqliter = "1.3.1"
 turbine = "1.2.0"
 
 sqlDelight = "2.0.2"
@@ -81,7 +82,8 @@ ktor-client-mock = { module = "io.ktor:ktor-client-mock", version.ref = "ktor" }
 ktor-serialization-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
 
-sqldelight-driver-ios = { module = "app.cash.sqldelight:native-driver", version.ref = "sqlDelight" }
+sqldelight-driver-native = { module = "app.cash.sqldelight:native-driver", version.ref = "sqlDelight" }
+sqliter = { module = "co.touchlab:sqliter-driver", version.ref = "sqliter" }
 sqldelight-driver-android = { module = "app.cash.sqldelight:android-driver", version.ref = "sqlDelight" }
 sqldelight-driver-jdbc = { module = "app.cash.sqldelight:sqlite-driver", version.ref = "sqlDelight" }
 requery-sqlite-android = { module = "com.github.requery:sqlite-android", version.ref = "sqlite-android" }

persistence/build.gradle.kts

@@ -36,7 +36,6 @@ kotlin {
     explicitApi()
 
     sourceSets {
-
         commonMain.dependencies {
             api(libs.bundles.sqldelight)
         }
@@ -53,7 +52,8 @@ kotlin {
         }
 
         iosMain.dependencies {
-            api(libs.sqldelight.driver.ios)
+            api(libs.sqldelight.driver.native)
+            api(projects.staticSqliteDriver)
         }
     }
 }
@@ -90,6 +90,8 @@ android {
 }
 
 sqldelight {
+    linkSqlite = false
+
     databases {
         create("PsDatabase") {
             packageName.set("com.powersync.persistence")

settings.gradle.kts

@@ -23,6 +23,7 @@ rootProject.name = "powersync-root"
 include(":core")
 include(":core-tests-android")
 include(":connectors:supabase")
+include("static-sqlite-driver")
 
 include(":dialect")
 include(":persistence")

static-sqlite-driver/README.md

@@ -0,0 +1 @@
+This project builds a `.klib` linking sqlite3 statically, without containing other Kotlin sources.