MigrationTestHelper rejects a migration that AppDatabase_Impl's onValidateSchema accepts (creation of FTS table) [145858914]

Fixed

Bug

androidx-bug-bounty

Status Update

No update yet.

Description

ah...@gmail.com

created issue #1

Dec 8, 2019 08:13PM

Component used:
Version used: 2.2.2
Devices/Android versions reproduced on: Android emulator running API 28

I've included a sample project with a MigrationTest class that fails like so when invoking MigrationTestHelper:

java.lang.IllegalStateException: Migration didn't properly handle: user_fts
Expected: FtsTableInfo{name='user_fts', columns=[name, rowid], options=[]}
Found: FtsTableInfo{name='user_fts', columns=[name], options=[]}

Yet the AppDatabase_Impl sees the schema as being correct.

The root cause seems to be that they treat the implicit `rowid` column differently: the generated schema json file includes the `rowid` field causing MigrationTestHelper to expect its presence, but AppDatabase_Impl's onValidateSchema method doesn't check for rowid.

I believe AppDatabase_Impl has the correct behaviour in this case: MigrationTestHelper uses FtsTableInfo which uses `PRAGMA table_info()` to discover the columns of the fts table, which *doesn't* return `rowid` as being one of the columns, but MigrationTestHelper is comparing that FtsTableInfo with the json data which *does* include `rowid`, so it thinks the schema doesn't match.

RoomFtsMigrationFailRepro.zip

1.4 MB

Download

Comments

yb...@google.com <yb...@google.com> #2Jul 30, 2020 08:33PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit b90079595f33f58fece04026a97faa0d243acdb1
Author: Yuichi Araki <yaraki@google.com>
Date: Wed Sep 18 16:55:49 2019

Change the way to detect mismatch between POJO and query

This fixes cursor mismatch warnings with expandProjection.

Bug: 140759491
Test: QueryMethodProcessorTest
Change-Id: I7659002e5e0d1ef60fc1af2a625c0c36da0664d8

M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/QueryMethodProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/testing/TestProcessor.kt

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

https://goto.google.com/android-sha1/b90079595f33f58fece04026a97faa0d243acdb1

da...@google.com <da...@google.com> #3Jul 30, 2020 08:40PM

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6093116828680192/#/cherrypickHistory/all)
Created: 2019-10-14 17:23:42.610596+00:00
Changes: aosp/1123258

ap...@google.com <ap...@google.com> #4Aug 4, 2020 04:11PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit bdde5a1a970ddc9007b28de4aa29d60ffa588f08
Author: Yigit Boyar <yboyar@google.com>
Date: Thu Apr 16 16:47:05 2020

Re-factor how errors are dismissed when query is re-written

This CL changes how we handle errors/warnings if query is
re-written.
There was a bug in expandProjection where we would report warnings
for things that Room already fixes automatically (

b/140759491

).
The solution to that problem (I7659002e5e0d1ef60fc1af2a625c0c36da0664d8)
solved it by deferring validating of columns until after re-write
decision is made. Unfortunately, this required changing PojoRowAdapter
to have a dummy mapping until it is validating, make it hard to use
as it does have a non-null mapping which is not useful.

This CL partially reverts that change and instead rely on the log
deferring logic we have in Context. This way, we don't need to break
the stability of PojoRowAdapter while still having the ability to
drop warnings that room fixes. This will also play nicer when we
have different query re-writing options that can use more information
about the query results.

Bug: 153387066
Bug: 140759491
Test: existing tests pass
Change-Id: I2ec967c763d33d7a3ff02c1a13c6953b460d1e5f

M room/compiler/src/main/kotlin/androidx/room/log/RLog.kt
M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt

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

da...@google.com <da...@google.com> Aug 4, 2020 04:13PM

Marked as fixed.

to...@gmail.com <to...@gmail.com> #5Nov 13, 2020 09:17AM

Version used: 2.3.0-alpha03
Devices/Android versions reproduced on: oneplus 5t and Huawei honer8

E/TestRunner: java.lang.IllegalStateException: Migration failed. expected:TableInfo{name='messages_fts4', columns={message_id=Column{name='message_id', type='TEXT', affinity='2', notNull=true, primaryKeyPosition=0, defaultValue='null'}, content=Column{name='content', type='TEXT', affinity='2', notNull=false, primaryKeyPosition=0, defaultValue='null'}}, foreignKeys=[], indices=[]} , found:TableInfo{name='messages_fts4', columns={message_id=Column{name='message_id', type='', affinity='1', notNull=false, primaryKeyPosition=0, defaultValue='null'}, content=Column{name='content', type='', affinity='1', notNull=false, primaryKeyPosition=0, defaultValue='null'}}, foreignKeys=[], indices=[]}

Database_Impl.java

_db.execSQL("CREATE VIRTUAL TABLE IF NOT EXISTS `messages_fts4` USING FTS4(`message_id` TEXT NOT NULL, `content` TEXT, tokenize=unicode61, notindexed=`message_id`)");

10.json

{
"ftsVersion": "FTS4",
"ftsOptions": {
"tokenizer": "unicode61",
"tokenizerArgs": [],
"contentTable": "",
"languageIdColumnName": "",
"matchInfo": "FTS4",
"notIndexedColumns": [
"message_id"
],
"prefixSizes": [],
"preferredOrder": "ASC"
},
"contentSyncTriggers": [],
"tableName": "messages_fts4",
"createSql": "CREATE VIRTUAL TABLE IF NOT EXISTS `${TABLE_NAME}` USING FTS4(`message_id` TEXT NOT NULL, `content` TEXT, tokenize=unicode61, notindexed=`message_id`)",
"fields": [
{
"fieldPath": "messageId",
"columnName": "message_id",
"affinity": "TEXT",
"notNull": true
},
{
"fieldPath": "content",
"columnName": "content",
"affinity": "TEXT",
"notNull": false
}
],
"primaryKey": {
"columnNames": [],
"autoGenerate": false
},
"indices": [],
"foreignKeys": []
}

Maybe it's a same issue, I don't know the [found:TableInfo] come from.

Issue 145858914