Auto Migration failing when just adding 2 new columns to existing table [200818663]

Duplicate

of 246362513

Bug

Status Update

No update yet.

Description

pa...@outlook.com

created issue #1

Sep 22, 2021 11:43PM

Component used: Room Version used: 2.4.0-alpha04 Devices/Android versions reproduced on: Android Pixel 4A

I have an entity where I only added a new column "newColumn" between database version 1 to database version 2

@Entity(
    tableName = "SubMain",
    foreignKeys = [
        ForeignKey(
            entity = MainEntity::class,
            parentColumns = ["id"],
            childColumns = ["subId"],
            onDelete = ForeignKey.CASCADE
        ),
        ForeignKey(
            entity = SideEntity::class,
            parentColumns = ["id"],
            childColumns = ["sideId"],
            onDelete = ForeignKey.NO_ACTION
        )
    ],
    indices = [
        Index("subId"),
        Index("sideId")
    ]
)
open class SubMainEntity {

    @PrimaryKey
    @ColumnInfo(name = "id")
    var id = "random id generation goes here"

    @ColumnInfo(name = "subId")
    var subId: String? = ""

    @ColumnInfo(name = "sideId")
    var sideId: Int? = null

    @ColumnInfo(name = "text")
    var text: String? = ""

    @ColumnInfo(name = "newColumn", defaultValue = "0")
    var newColumn = false <- this is the new column I added

}

I have configured the database as such

@Database(
    version = 2,
    entities = [
        SubMainEntity::class
    ],
    autoMigrations = [
        AutoMigration(from = 1, to = 2)
    ]
)
@TypeConverters(Converters::class)
abstract class AppVolatileDatabase : RoomDatabase() { ... }

And when I run the app after the new schema files have already been generated, the app crashes and this is the error snippet that shows in the console (formatted for easier reading)

Expected:
TableInfo{name='SubMain', columns={
newColumn=Column{name='newColumn', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=0, defaultValue='0'},
subId=Column{name='subId', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
sideId=Column{name='sideId', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'},
id=Column{name='id', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=1, defaultValue='null'},
text=Column{name='text', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
foreignKeys=[
ForeignKey{referenceTable='Side', onDelete='NO ACTION', onUpdate='NO ACTION', columnNames=[sideId], referenceColumnNames=[id]},
ForeignKey{referenceTable='Sub', onDelete='CASCADE', onUpdate='NO ACTION', columnNames=[subId], referenceColumnNames=[id]}
],
indices=[
Index{name='index_SubMain_subId', unique=false, columns=[subId]},
Index{name='index_SubMain_sideId', unique=false, columns=[sideId]}
]}

Found:
TableInfo{name='SubMain', columns={
subId=Column{name='subId', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
sideId=Column{name='sideId', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'},
id=Column{name='id', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=1, defaultValue='null'},
text=Column{name='text', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'},
foreignKeys=[
ForeignKey{referenceTable='Sub', onDelete='CASCADE', onUpdate='NO ACTION', columnNames=[subId], referenceColumnNames=[id]},
ForeignKey{referenceTable='Side', onDelete='NO ACTION', onUpdate='NO ACTION', columnNames=[sideId], referenceColumnNames=[id]}
],
indices=[
Index{name='index_SubMain_subId', unique=false, columns=[subId]},
Index{name='index_SubMain_sideId', unique=false, columns=[sideId]}
]}

When I attach a debug point to TableInfo it stops at

        if (columns != null ? !columns.equals(tableInfo.columns) : tableInfo.columns != null) {
            return false;
        }

because the table count is different, which makes sense to be different since I have added a new column to the existing table, but for some reason the migration logic is not account for that even though it is very suggested that auto migrations should work straight away when we just add a new column to an existing table: https://developer.android.com/training/data-storage/room/migrating-db-versions

And the blog as well also discusses straight automigration logic for just adding a new column to exiting tables: https://medium.com/androiddevelopers/room-auto-migrations-d5370b0ca6eb

What am I doing wrong here, or is this a bug? I cannot find anything in the documentation to solve this for myself.

Comments

pa...@outlook.com <pa...@outlook.com> #2Sep 22, 2021 11:44PM

Can you share your Gradle build file and how room-compiler is being setup? The error is indicating that the Room processor likely did not run which in turns means the generated implementation of the database was not created and can't be found.

da...@google.com <da...@google.com> Sep 23, 2021 12:20AM

Reassigned to el...@google.com.

pa...@outlook.com <pa...@outlook.com> #3Sep 23, 2021 12:30AM

This is my gradle file. I need to re -explain it runs well in Android, iOS, and Desktop's debug.It only crash when runRelease on desktop.

import org.jetbrains.compose.desktop.application.dsl.TargetFormat
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
import org.jetbrains.kotlin.gradle.tasks.KotlinCompilationTask

plugins {
    alias(libs.plugins.kotlinMultiplatform)
    alias(libs.plugins.androidApplication)
    alias(libs.plugins.composeMultiplatform)
    alias(libs.plugins.composeCompiler)
    alias(libs.plugins.kotlinCocoapods)
    alias(libs.plugins.googleKsp)
    alias(libs.plugins.kotlinSerialization)
    alias(libs.plugins.androidxRoom)
}

kotlin {
    androidTarget {
        compilerOptions {
            jvmTarget.set(JvmTarget.JVM_11)
        }
    }

    iosX64()
    iosArm64()
    iosSimulatorArm64()

    cocoapods {
        summary = "Some description for the Shared Module"
        homepage = "Link to the Shared Module homepage"
        version = "1.0"
        ios.deploymentTarget = "13.0"
        podfile = project.file("../iosApp/Podfile")
        framework {
            baseName = "ComposeApp"
            isStatic = true
        }
    }

    jvm("desktop")

    sourceSets {
        val desktopMain by getting

        androidMain.dependencies {
            implementation(compose.preview)
            implementation(libs.androidx.activity.compose)
        }
        commonMain.dependencies {
            implementation(compose.runtime)
            implementation(compose.foundation)
            implementation(compose.material3)
            implementation(compose.ui)
            implementation(compose.components.resources)
            implementation(compose.components.uiToolingPreview)
            implementation(libs.androidx.lifecycle.viewmodel)
            implementation(libs.androidx.lifecycle.runtime.compose)
            implementation(libs.androidx.navigation)

            // Serialization
            implementation(libs.kotlinx.serialization.json)

            // Room
            implementation(libs.androidx.room.runtime)
            implementation(libs.androidx.sqlite.bundled)
        }
        desktopMain.dependencies {
            implementation(compose.desktop.currentOs)
            implementation(libs.kotlinx.coroutines.swing)
        }
    }
}

android {
    namespace = "xxx"
    compileSdk = libs.versions.android.compileSdk.get().toInt()

    defaultConfig {
        applicationId = "xxx"
        minSdk = libs.versions.android.minSdk.get().toInt()
        targetSdk = libs.versions.android.targetSdk.get().toInt()
        versionCode = 1
        versionName = "1.0"
    }
    packaging {
        resources {
            excludes += "/META-INF/{AL2.0,LGPL2.1}"
        }
    }
    buildTypes {
        getByName("release") {
            isMinifyEnabled = false
        }
    }
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_11
        targetCompatibility = JavaVersion.VERSION_11
    }
}

dependencies {
    debugImplementation(compose.uiTooling)
}

compose.desktop {
    application {
        mainClass = "xxx.MainKt"

        nativeDistributions {
            targetFormats(TargetFormat.Dmg, TargetFormat.Msi, TargetFormat.Deb)
            packageName = "xxx"
            packageVersion = "1.0.0"
        }
    }
}

dependencies {
    kspCommonMainMetadata(libs.koin.ksp.compiler)
    listOf(
        "kspAndroid",
        "kspDesktop",
        "kspIosX64",
        "kspIosArm64",
        "kspIosSimulatorArm64"
    ).forEach {
        add(it, libs.androidx.room.compiler)
    }
}

project.tasks.withType(KotlinCompilationTask::class.java).configureEach {
    if (name != "kspCommonMainKotlinMetadata") {
        dependsOn("kspCommonMainKotlinMetadata")
    }
}

kotlin.sourceSets.commonMain {
    kotlin.srcDir("build/generated/ksp/metadata/commonMain/kotlin")
}

room {
    schemaDirectory("$projectDir/schemas")
}

pa...@outlook.com <pa...@outlook.com> #4Sep 23, 2021 01:27AM

Does release have some type of obfuscation? The generated database file is found via reflection and if the class is renamed due to obfuscation, that could be a cause. For Android room-runtime ships with proguard rules to solve this but we don't include them in the JVM artifacts (we probably should).

Also, one thing in the build file is you seem to have an outdated workaround where Room is applied to the common source set and a manual dependency to the KSP generated in metadata is added, those workarounds should be removed if using the latest version. Specifically the lines:

// in dependencies
kspCommonMainMetadata(libs.koin.ksp.compiler)

project.tasks.withType(KotlinCompilationTask::class.java).configureEach {
    if (name != "kspCommonMainKotlinMetadata") {
        dependsOn("kspCommonMainKotlinMetadata")
    }
}

kotlin.sourceSets.commonMain {
    kotlin.srcDir("build/generated/ksp/metadata/commonMain/kotlin")
}

I'm not sure if it'll solve your issue but wanted to call them out.

pa...@outlook.com <pa...@outlook.com> #5Sep 23, 2021 02:08AM

These codes are because I use koin-annotations. If I delete any of them, it will cause koin-annotations to be unable to generate code normally.

da...@google.com <da...@google.com> #6Sep 23, 2021 06:29PM

Gotcha - I think the issue is obfuscation then.

Can you try disabling it:

compose.desktop {
    application {
        buildTypes.release.proguard.obfuscate = false
        ...
    }
}

ap...@google.com <ap...@google.com> #7Sep 29, 2021 05:22PM

Two more alternatives:

Include a proguard file with the same rule specified by Room's included one: -keep class * extends androidx.room.RoomDatabase { void <init>(); } via the DSL buildTypes.release.proguard.configurationFiles
Include a 'factory' in your database builder that uses the database constructor in a more manual way, avoiding the reflection that is for convinience:

Room.inMemoryDatabaseBuilder<MyDatabase>(
    factory = { MyDatabaseCtor.initialize() }
)

da...@google.com <da...@google.com> #8Sep 29, 2021 05:27PM

Marked as fixed.

Project: platform/frameworks/support
Branch: androidx-main
Author: Daniel Santiago Rivera <danysantiago@google.com>
Link: https://android-review.googlesource.com/3467584

Include Proguard rules in Room's runtime JVM artifacts

Expand for full commit details

Include Proguard rules in Room's runtime JVM artifacts 
 
Bug: 392657750 
Test: Manually on sample app with ./gradlew runRelease 
Change-Id: I43950728d7227e13979945a64a118e55270ed4e0

Files:

M room/room-runtime/build.gradle
M room/room-runtime/src/androidMain/proguard-rules.pro
A room/room-runtime/src/jvmMain/resources/META-INF/com.android.tools/proguard/room.pro
A room/room-runtime/src/jvmMain/resources/META-INF/com.android.tools/r8/room.pro
A room/room-runtime/src/jvmMain/resources/META-INF/proguard/room.pro

Hash: 977f11f1f2adcc7ed85c109eca38b96dfd2c3f8d
Date: Tue Jan 28 12:56:52 2025

da...@loylap.com <da...@loylap.com> #9Sep 14, 2022 07:24PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.room:room-runtime:2.7.0-beta01
androidx.room:room-runtime-android:2.7.0-beta01
androidx.room:room-runtime-iosarm64:2.7.0-beta01
androidx.room:room-runtime-iossimulatorarm64:2.7.0-beta01
androidx.room:room-runtime-iosx64:2.7.0-beta01
androidx.room:room-runtime-jvm:2.7.0-beta01
androidx.room:room-runtime-linuxarm64:2.7.0-beta01
androidx.room:room-runtime-linuxx64:2.7.0-beta01
androidx.room:room-runtime-macosarm64:2.7.0-beta01
androidx.room:room-runtime-macosx64:2.7.0-beta01

da...@loylap.com <da...@loylap.com> #10Sep 14, 2022 07:25PM

After upgrading 2.7.0-beta01, this crash still exists.

Caused by: java.lang.RuntimeException: Cannot find implementation for com.develop.ximi.db.AppDatabase. AppDatabase_Impl does not exist. Is Room annotation processor correctly configured?

Component used: room-runtime, room-compiler, sqlite-bundled Version used: room: 2.7.0-beta01, sqlite: 2.5.0-beta01

el...@google.com <el...@google.com> Sep 26, 2022 07:53PM

Status: Duplicate of

246362513