Auto migration error when object is embedded [193798291]

Fixed

Bug

Status Update

No update yet.

Description

ba...@lamelcolor.ch

created issue #1

Jul 16, 2021 08:45AM

Component used: Room auto migration Version used: 2.4.0-alpha02 Devices/Android versions reproduced on: Samsung xcover 4s / android 10

This problem occur when I have add a new column in a entity. Auto migration add this columns for the entity, but it is not pass to the entity where the object entity is embedded.

For make this error try to make auto migration when you add a new columns to a embedded entity.

This error not occur because I have no change my db version.

E/AndroidRuntime: FATAL EXCEPTION: pool-5-thread-1
    Process: ch.lamelcolor.lafipla, PID: 29544
    java.lang.IllegalStateException: Migration didn't properly handle: StaffScheduleAssignment(ch.lamelcolor.lafipla.model.StaffScheduleAssignment).
     Expected:
    TableInfo{name='StaffScheduleAssignment', columns={followupActionRemark=Column{name='followupActionRemark', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkScheduleNo=Column{name='fkScheduleNo', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=0, defaultValue='null'}, endDate=Column{name='endDate', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkStateTypeNo=Column{name='fkStateTypeNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, workExplanation=Column{name='workExplanation', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, master=Column{name='master', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=0, defaultValue='null'}, validationText=Column{name='validationText', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, pkFollowupActionNo=Column{name='pkFollowupActionNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, pkAssignmentNo=Column{name='pkAssignmentNo', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=1, defaultValue='null'}, followupAction=Column{name='followupAction', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkReportNo=Column{name='fkReportNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, comment=Column{name='comment', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkStaffNo=Column{name='fkStaffNo', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, pkScheduleNo=Column{name='pkScheduleNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, startDate=Column{name='startDate', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkFollowupActionNo=Column{name='fkFollowupActionNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}}, foreignKeys=[ForeignKey{referenceTable='StaffSchedule', onDelete='CASCADE', onUpdate='NO ACTION', columnNames=[fkScheduleNo], referenceColumnNames=[pkScheduleNo]}], indices=[Index{name='index_StaffScheduleAssignment_fkScheduleNo', unique=false, columns=[fkScheduleNo]}, Index{name='index_StaffScheduleAssignment_fkStaffNo', unique=false, columns=[fkStaffNo]}]}
     Found:
E/AndroidRuntime: TableInfo{name='StaffScheduleAssignment', columns={followupActionRemark=Column{name='followupActionRemark', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkScheduleNo=Column{name='fkScheduleNo', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=0, defaultValue='null'}, endDate=Column{name='endDate', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkStateTypeNo=Column{name='fkStateTypeNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, master=Column{name='master', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=0, defaultValue='null'}, validationText=Column{name='validationText', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, pkFollowupActionNo=Column{name='pkFollowupActionNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, pkAssignmentNo=Column{name='pkAssignmentNo', type='INTEGER', affinity='3', notNull=true, primaryKeyPosition=1, defaultValue='null'}, followupAction=Column{name='followupAction', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkReportNo=Column{name='fkReportNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, comment=Column{name='comment', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkStaffNo=Column{name='fkStaffNo', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}, pkScheduleNo=Column{name='pkScheduleNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, startDate=Column{name='startDate', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}, fkFollowupActionNo=Column{name='fkFollowupActionNo', type='INTEGER', affinity='3', notNull=false, primaryKeyPosition=0, defaultValue='null'}}, foreignKeys=[ForeignKey{referenceTable='StaffSchedule', onDelete='CASCADE', onUpdate='NO ACTION', columnNames=[fkScheduleNo], referenceColumnNames=[pkScheduleNo]}], indices=[Index{name='index_StaffScheduleAssignment_fkScheduleNo', unique=false, columns=[fkScheduleNo]}, Index{name='index_StaffScheduleAssignment_fkStaffNo', unique=false, columns=[fkStaffNo]}]}
        at androidx.room.RoomOpenHelper.onUpgrade(RoomOpenHelper.java:103)
        at androidx.sqlite.db.framework.FrameworkSQLiteOpenHelper$OpenHelper.onUpgrade(FrameworkSQLiteOpenHelper.java:177)
        at android.database.sqlite.SQLiteOpenHelper.getDatabaseLocked(SQLiteOpenHelper.java:493)
        at android.database.sqlite.SQLiteOpenHelper.getWritableDatabase(SQLiteOpenHelper.java:391)
        at androidx.sqlite.db.framework.FrameworkSQLiteOpenHelper$OpenHelper.getWritableSupportDatabase(FrameworkSQLiteOpenHelper.java:145)
        at androidx.sqlite.db.framework.FrameworkSQLiteOpenHelper.getWritableDatabase(FrameworkSQLiteOpenHelper.java:106)
        at androidx.room.RoomDatabase.internalBeginTransaction(RoomDatabase.java:591)
        at androidx.room.RoomDatabase.beginTransaction(RoomDatabase.java:580)
        at ch.lamelcolor.lafipla.dao.GoogleUserDao_Impl.upsert(GoogleUserDao_Impl.java:211)
        at ch.lamelcolor.lafipla.dao.GoogleUserDao_Impl.upsert(GoogleUserDao_Impl.java:23)
        at ch.lamelcolor.lafipla.repository.GoogleUserRepository.upsert(GoogleUserRepository.java:45)
        at ch.lamelcolor.lafipla.ui.viewModel.MainViewModel.lambda$insertGoogleUser$0$MainViewModel(MainViewModel.java:31)
        at ch.lamelcolor.lafipla.ui.viewModel.-$$Lambda$MainViewModel$MbrAHqk2wa171_QnASiLWfi40jI.run(Unknown Source:4)
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1167)
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:641)
        at java.lang.Thread.run(Thread.java:919)

Comments

yb...@google.com <yb...@google.com> #2Jul 16, 2021 03:58PM

Reassigned to el...@google.com.

From the other issue:

note that it is never the right approach to attach a <deeplink> to an <activity> destination as that will never give you the right behavior when using an implicit deep link on another app's task (where the system back should immediately take the user back to the app that triggered your deep link). Instead, you should attach your deep link directly to your second activity (either by manually writing the appropriate <intent-filter> or by adding the <deeplink> to the start destination of a nav host in that second activity).

A lint error saying as such when a <deepLink> element is added in Navigation XML would go a really long way to avoiding this case. Our guide to writing Lint checks in AndroidX is a good place to start to start a navigation-runtime-lint artifact that would contain this check.

ba...@lamelcolor.ch <ba...@lamelcolor.ch> #3Jul 19, 2021 05:17AM

We have some public docs on writing library lint rules. Specifically the xml lint rule part should be pretty helpful.

el...@google.com <el...@google.com> #4Jul 19, 2021 09:46PM

CL is WIP: https://android-review.googlesource.com/c/platform/frameworks/support/+/2064176

ba...@lamelcolor.ch <ba...@lamelcolor.ch> #5Jul 20, 2021 05:01AM

Project: platform/frameworks/support
Branch: androidx-main

commit cd77b4bbe312dd8892dfbb3c662344d13a96c82d
Author: Julia McClellan <juliamcclellan@google.com>
Date: Thu Apr 14 15:31:46 2022

Deep link in activity destination in navigation lint

Test: Included tests of API version and the lint rule
Bug: 178403185

Change-Id: Ic15a5ec165620b7ef5b3f03538cc83b5576add8d

A navigation/navigation-runtime-lint/src/main/java/androidx/navigation/runtime/lint/DeepLinkInActivityDestinationDetector.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/ApiLintVersionsTest.kt
M settings.gradle
A navigation/navigation-runtime-lint/build.gradle
M navigation/navigation-runtime/build.gradle
A navigation/navigation-runtime-lint/src/main/java/androidx/navigation/runtime/lint/NavigationRuntimeIssueRegistry.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/DeepLinkInActivityDestinationDetectorTest.kt
A navigation/navigation-runtime-lint/src/main/resources/META-INF/services/com.android.tools.lint.client.api.IssueRegistry

https://android-review.googlesource.com/2064176

ev...@gmail.com <ev...@gmail.com> #6Jul 20, 2021 07:19PM

What was embedded in my email?

ba...@lamelcolor.ch <ba...@lamelcolor.ch> #7Jul 21, 2021 05:09AM

Sorry I don't understand your request ! What do you means about that ?

el...@google.com <el...@google.com> #8Jul 21, 2021 02:15PM

Hi - I believe

comment #6

was a spam post, you can ignore it!

el...@google.com <el...@google.com> #9Jul 21, 2021 03:47PM

Sorry - one more follow up question - could you clarify what you mean by "This error not occur because I have no change my db version."? I'm working on reproducing the error and want to have the full backstory.

ba...@lamelcolor.ch <ba...@lamelcolor.ch> #10Jul 22, 2021 05:14AM

It is to say it's not a error by oversight.

el...@google.com <el...@google.com> #11Nov 4, 2021 10:54PM

Could you share the AutoMigration implementation that is getting generated? It should be located somewhere in the /build/generated/ap_generated_sources/ directory.

ap...@google.com <ap...@google.com> #12Nov 10, 2021 02:01AM

Project: platform/frameworks/support
Branch: androidx-main

commit 87c1e43b72f3eaa6342fe7afe9136e4994b8d055
Author: Elif Bilgin <elifbilgin@google.com>
Date: Mon Jul 19 10:05:33 2021

Resolving Auto-Migration error when a new column is added to an embedded Entity between versions.

This fix is particularly for the issue when the nullability of a column that is in an embedded entity is misinterpreted, generating an auto migration with missing default values.

Bug: 193798291
Test: AutoMigrationTest.java
Change-Id: I5fcb1bcf6bf0af9763ed90aea6ec4f25581ca63d

A room/integration-tests/testapp/schemas/androidx.room.integration.testapp.migration.EmbeddedAutoMigrationDb/2.json
A room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/migration/EmbeddedAutoMigrationDb.java
M room/room-compiler/src/main/kotlin/androidx/room/writer/AutoMigrationWriter.kt
A room/integration-tests/testapp/schemas/androidx.room.integration.testapp.migration.EmbeddedAutoMigrationDb/1.json
M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/migration/AutoMigrationTest.java

https://android-review.googlesource.com/1771292

el...@google.com <el...@google.com> Mar 8, 2022 06:06PM

Marked as fixed.