Refactor: Migrate Database Module to KMP Library Module (Finally 😮‍💨)

README.md

@@ -5,7 +5,12 @@
 > Please, consider using it for fun, and not for real password management. (until, we officially
 > release a stable release)
 >
-> Cuz, **`data is stored unencrypted`.. we planning to add encryption soon.**
+> Cuz, **`data is stored unencrypted`.. we're planning to add encryption soon.**
+
+> [!NOTE]
+> Currently, we are android-only, we will soon provide support for desktop (windows-only) using kotlin-multiplatform. but development will remain to android-first.
+>
+> then later-after will migrate to react-native and then passcodes will be multiplatform rather than being android-first. more information will be given in docs soon.
 
 <div align="center">
 

autofill/build.gradle.kts

@@ -53,7 +53,6 @@ dependencies {
     implementation(libs.material)
 
     // Data/Persistence (Room Bundle)
-    ksp(libs.room.compiler)
     implementation(libs.room.ktx)
 
     implementation(libs.coroutines.core)

build.gradle.kts

@@ -7,6 +7,7 @@ plugins {
     alias(libs.plugins.androidKmpLibrary) apply false
     alias(libs.plugins.kotlinSerialization) apply false
     alias(libs.plugins.ksp) apply false
+    alias (libs.plugins.androidx.room) apply false
     alias(libs.plugins.ossLicenses) apply false
 }
 

database/README.md

@@ -0,0 +1,5 @@
+# Test Notice.
+
+All the database code will be tested in android context. meaning, all migration and things will be tested based on android platform. as we are android first. and to some extent android-only.
+
+This is also true cuz, room migration are hard to test on every platform. there is no convenient way to test room migration for all platform.

database/build.gradle.kts

@@ -1,77 +1,66 @@
-import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import org.gradle.kotlin.dsl.provideDelegate
 
 plugins {
-    alias(libs.plugins.androidLibrary)
+    alias(libs.plugins.kotlinMultiplatform)
+    alias(libs.plugins.androidKmpLibrary)
     alias(libs.plugins.ksp)
+    alias (libs.plugins.androidx.room)
 }
 
 kotlin {
-    compilerOptions {
-        jvmTarget = JvmTarget.JVM_21
-    }
-}
-
-android {
-    namespace = "com.jeeldobariya.passcodes.database"
-    compileSdk {
-        version = release(36)
-    }
-
-    defaultConfig {
+    android {
+        compileSdk = 36
         minSdk = 26
+        namespace = "com.jeeldobariya.passcodes.database"
+        experimentalProperties["android.experimental.kmp.enableAndroidResources"] = true
 
-        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
-        consumerProguardFiles("consumer-rules.pro")
-    }
+        withHostTest {
+            isIncludeAndroidResources = true
+        }
 
-    sourceSets {
-        getByName("androidTest") {
-            assets.directories += "$projectDir/schemas"
+        // Opt-in to enable and configure device-side (instrumented) tests
+        withDeviceTest {
+            instrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+            execution = "HOST"
         }
     }
 
-    buildTypes {
-        getByName("release") {
-            isMinifyEnabled = false
+    sourceSets {
+        androidMain.dependencies {
+            implementation(libs.koin)
         }
 
-        create("staging") {
-            isMinifyEnabled = false
+        getByName("androidDeviceTest").dependencies {
+            implementation(libs.bundles.unit.test)
+            implementation(libs.androidx.junit)
+            implementation(libs.androidx.junit.ktx)
+            implementation(libs.androidx.runner)
+            implementation(libs.coroutines.test)
+            implementation(libs.androidx.room.testing)
         }
 
-        getByName("debug") {
-            isMinifyEnabled = false
+        commonMain.dependencies {
+            // Coroutines
+            implementation(libs.bundles.coroutines)
+
+            // Room
+            implementation(libs.androidx.room.runtime)
+            implementation(libs.sqlite.bundled)
+
+            // Dependency Injection
+            implementation(libs.koin)
         }
-    }
 
-    compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_21
-        targetCompatibility = JavaVersion.VERSION_21
+        commonTest.dependencies {
+            implementation(kotlin("test"))
+        }
     }
+}
 
-    ksp {
-        val location = "$projectDir/schemas"
-        arg("room.schemaLocation", location)
-    }
+room {
+    schemaDirectory("$projectDir/schemas")
 }
 
 dependencies {
-    implementation(libs.androidx.core.ktx)
-
-    // Data/Persistence (Room Bundle)
-    ksp(libs.room.compiler)
-    implementation(libs.room.ktx)
-
-    // Concurrency (Coroutines Bundle)
-    implementation(libs.bundles.coroutines)
-
-    // Dependency Injection
-    implementation(libs.koin)
-
-    androidTestImplementation(libs.bundles.unit.test)
-    androidTestImplementation(libs.androidx.junit)
-    androidTestImplementation(libs.androidx.junit.ktx)
-    androidTestImplementation(libs.androidx.runner)
-    androidTestImplementation(libs.coroutines.test)
-    androidTestImplementation(libs.room.testing)
+    add("kspAndroid", libs.androidx.room.compiler)
 }

database/src/androidTest/kotlin/com/jeeldobariya/passcodes/database/master/MasterDatabasePasswordsDaoTest.kt → database/src/androidDeviceTest/kotlin/com/jeeldobariya/passcodes/database/master/MasterDatabasePasswordsDaoTest.kt

@@ -3,20 +3,17 @@ package com.jeeldobariya.passcodes.database.master
 import android.content.Context
 import androidx.room.Room
 import androidx.test.core.app.ApplicationProvider
-import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.google.common.truth.Truth.assertThat
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.test.runTest
 import org.junit.After
 import org.junit.Before
 import org.junit.Test
-import org.junit.runner.RunWith
 import java.io.IOException
 
 /**
  * Instrumented test for the Room database, specifically testing the PasswordsDao.
  */
-@RunWith(AndroidJUnit4::class)
 class MasterDatabasePasswordsDaoTest {
 
     private lateinit var passwordsDao: PasswordsDao

database/src/androidTest/kotlin/com/jeeldobariya/passcodes/database/master/migration/Migration_1_2_Test.kt → database/src/androidDeviceTest/kotlin/com/jeeldobariya/passcodes/database/master/migration/Migration_1_2_Test.kt

@@ -12,8 +12,6 @@ import org.junit.runner.RunWith
 @RunWith(AndroidJUnit4::class)
 class MasterDatabaseMigration1To2Test {
 
-    private val TEST_DB = "migration-1-2-test"
-
     @get:Rule
     val helper = MigrationTestHelper(
         InstrumentationRegistry.getInstrumentation(),
@@ -22,7 +20,9 @@ class MasterDatabaseMigration1To2Test {
 
     @Test
     fun migrate_basicData() {
-        helper.createDatabase(TEST_DB, 1).apply {
+        val dbName = "test_db_migrate_basicData"
+
+        helper.createDatabase(dbName, 1).apply {
             execSQL("""
                 INSERT INTO passwords (id, domain, username, password, notes)
                 VALUES (1, 'example.com', 'user', 'pass', 'note')
@@ -31,7 +31,7 @@ class MasterDatabaseMigration1To2Test {
         }
 
         val migratedDb = helper.runMigrationsAndValidate(
-            TEST_DB, 2, true, MIGRATION_1_2
+            dbName, 2, true, MIGRATION_1_2
         )
 
         val cursor = migratedDb.query("SELECT * FROM passwords")
@@ -41,15 +41,17 @@ class MasterDatabaseMigration1To2Test {
 
     @Test
     fun migrate_emptyNotes_becomesNull() {
-        helper.createDatabase(TEST_DB, 1).apply {
+        val dbName = "test_db_migrate_emptyNotes_becomesNull"
+
+        helper.createDatabase(dbName, 1).apply {
             execSQL("""
                 INSERT INTO passwords (id, domain, username, password, notes)
                 VALUES (1, 'd', 'u', 'p', '')
             """)
             close()
         }
 
-        val db = helper.runMigrationsAndValidate(TEST_DB, 2, true, MIGRATION_1_2)
+        val db = helper.runMigrationsAndValidate(dbName, 2, true, MIGRATION_1_2)
 
         val cursor = db.query("SELECT notes FROM passwords WHERE id = 1")
         cursor.moveToFirst()
@@ -61,15 +63,17 @@ class MasterDatabaseMigration1To2Test {
 
     @Test
     fun migrate_urlGenerated() {
-        helper.createDatabase(TEST_DB, 1).apply {
+        val dbName = "test_db_migrate_urlGenerated"
+
+        helper.createDatabase(dbName, 1).apply {
             execSQL("""
                 INSERT INTO passwords (id, domain, username, password, notes)
                 VALUES (1, 'google.com', 'u', 'p', 'n')
             """)
             close()
         }
 
-        val db = helper.runMigrationsAndValidate(TEST_DB, 2, true, MIGRATION_1_2)
+        val db = helper.runMigrationsAndValidate(dbName, 2, true, MIGRATION_1_2)
 
         val cursor = db.query("SELECT url FROM passwords WHERE id = 1")
         cursor.moveToFirst()

database/src/androidMain/kotlin/com/jeeldobariya/passcodes/database/di/DatabaseModule.android.kt

@@ -0,0 +1,26 @@
+package com.jeeldobariya.passcodes.database.di
+
+import androidx.room.Room
+import com.jeeldobariya.passcodes.database.master.MasterDatabase
+import org.koin.android.ext.koin.androidContext
+import org.koin.dsl.module
+
+actual val databaseModule = module {
+    single {
+        MasterDatabase.createNewDatabase(
+            getDatabaseBuilder = {
+                val appContext = androidContext()
+                val dbFile = appContext.getDatabasePath("master.db")
+
+                Room.databaseBuilder<MasterDatabase>(
+                    context = appContext,
+                    name = dbFile.absolutePath
+                )
+            }
+        )
+    }
+
+    single {
+        get<MasterDatabase>().passwordsDao
+    }
+}

database/src/commonMain/kotlin/com/jeeldobariya/passcodes/database/di/DatabaseModule.kt

@@ -0,0 +1,6 @@
+package com.jeeldobariya.passcodes.database.di
+
+import org.koin.core.module.Module
+
+
+expect val databaseModule: Module

database/src/commonMain/kotlin/com/jeeldobariya/passcodes/database/master/MasterDatabase.kt

@@ -0,0 +1,35 @@
+package com.jeeldobariya.passcodes.database.master
+
+// import android.content.Context
+import androidx.room.ConstructedBy
+import androidx.room.Database
+import androidx.room.RoomDatabase
+import androidx.room.RoomDatabaseConstructor
+import androidx.sqlite.driver.bundled.BundledSQLiteDriver
+import com.jeeldobariya.passcodes.database.master.migration.MIGRATION_1_2
+
+@Database(
+    entities = [PasswordEntity::class],
+    version = 2,
+    exportSchema = true
+)
+@ConstructedBy(MasterDatabaseConstructor::class)
+abstract class MasterDatabase : RoomDatabase() {
+    abstract val passwordsDao: PasswordsDao
+
+    companion object {
+        fun createNewDatabase(
+            getDatabaseBuilder: () -> Builder<MasterDatabase>
+        ): MasterDatabase {
+            return getDatabaseBuilder()
+                .setDriver(BundledSQLiteDriver())
+                .addMigrations(MIGRATION_1_2)
+                .build()
+        }
+    }
+}
+
+@Suppress("KotlinNoActualForExpect")
+expect object MasterDatabaseConstructor : RoomDatabaseConstructor<MasterDatabase> {
+    override fun initialize(): MasterDatabase
+}

database/src/main/kotlin/com/jeeldobariya/passcodes/database/master/PasswordEntity.kt → database/src/commonMain/kotlin/com/jeeldobariya/passcodes/database/master/PasswordEntity.kt

@@ -5,7 +5,8 @@ import androidx.room.Entity
 import androidx.room.PrimaryKey
 
 @Entity(tableName = "passwords")
-data class PasswordEntity(
+data class
+PasswordEntity(
     @PrimaryKey(autoGenerate = true)
     val id: Int = 0,
     var domain: String,
@@ -18,4 +19,4 @@ data class PasswordEntity(
     var createdAt: String? = null,
     @ColumnInfo(name = "updated_at", defaultValue = "CURRENT_TIMESTAMP")
     var updatedAt: String? = null
-)
+)