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.

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

commit 11a3cb30e7c9067a27eb10bf96e89afdc283ba2e
Author: pingxuanli <pingxuanli@google.com>
Date: Mon Aug 22 13:03:03 2022

Adding error message check in EntityUpsertionAdapter.

Bug: 243039555
Test: Tests are in EntityUpsertionAdapterTest file. By using toy, can check for foreign key constraint. (FK violation is commented out to prevent crash but the errors were thrown correctly)
Relnote: restrict the minimum version that supports Upsert to at least 16
Change-Id: I5f67f2ab5d41a313c48dac42f485f8345f74c1b1

M room/room-common/api/current.txt
M room/room-runtime/api/restricted_current.txt
M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/DaoConflictStrategyTest.java
M room/room-common/src/main/java/androidx/room/Upsert.kt
M room/room-common/api/public_plus_experimental_current.txt
M room/room-runtime/api/current.txt
M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/LiveDataQueryTest.java
M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/EntityUpsertionAdapterTest.java
M room/room-runtime/api/public_plus_experimental_current.txt
M room/room-runtime/src/main/java/androidx/room/EntityUpsertionAdapter.kt
M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/vo/Toy.java
M room/room-common/api/restricted_current.txt

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

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

This bug was linked in a change in the following release(s):

androidx.room:room-common:2.5.0-beta01
androidx.room:room-runtime:2.5.0-beta01

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

This fix is also preventing the update when there is a uniqueness conflict on an index (code 2067 SQLITE_CONTRAINT_UNIQUE). In this case `checkUniquenessException(ex)` rethrows the exception. Is it expected ?

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

Thanks for the comment, indeed checkUniquenessException should not throw for SQLITE_CONSTRAINT_UNIQUE as per the SQLite docs:

The special UPSERT processing happens only for uniqueness constraint on the table that is receiving the INSERT. A "uniqueness constraint" is an explicit UNIQUE or PRIMARY KEY constraint within the CREATE TABLE statement, or a unique index. UPSERT does not intervene for failed NOT NULL or foreign key constraints or for constraints that are implemented using triggers.

In https://www.sqlite.org/lang_UPSERT.html

We'll make a fix to includes SQLITE_CONSTRAINT_UNIQUE as part of the 'uniqueness constraint' that will lead to an UPDATE.

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

Thanks for the update, really appreciate it !

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

Hello,

I've just hit this issue and I would like to know what's the status on handling 2067 SQLITE_CONSTRAINT_UNIQUE the same way and proceed to an update. I was very surprised upsert wasn't working.

Thanks

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

Thanks for the bump, we'll resolve this issue asap.

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

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

commit 01002bedc549e0264a5f920dc554ed7dd7785cfe
Author: elifbilgin <elifbilgin@google.com>
Date: Tue Aug 01 05:53:50 2023

Handle special case SQLite exception during upsert.

When 2067 SQLITE_CONSTRAINT_UNIQUE is thrown during an upsert, upsert should perform an update.

Bug: 243039555
Test: EntityUpsertionAdapterTest.java
Change-Id: If28499c59443f590ac456924eff03b18f1a87e4f

M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/EntityUpsertionAdapterTest.java
M room/room-runtime/src/main/java/androidx/room/EntityUpsertionAdapter.kt

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

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.