KMP - destructive migration fails - view already exists [381518941]

Fixed

Bug

Status Update

No update yet.

Description

ma...@caringvillage.com

created issue #1

Nov 30, 2024 06:38PM

I'm using:

room 2.7.0-alpha11
sqlite-bundled: 2.5.0-alpha11
kotlin: 2.0.21, 2.0.20
ksp: 2.0.21-1.0.28, 2.0.20-1.0.25

My databases are configured with:

        .setDriver(BundledSQLiteDriver())
        .setQueryCoroutineContext(Dispatchers.IO)
        .fallbackToDestructiveMigrationOnDowngrade(true)
        .fallbackToDestructiveMigration(true)

When a destructive migration occurs we're getting an error on Android (and I believe we're getting a similar error on iOS, but am awaiting confirmation on that).

1:55:25.008  E  FATAL EXCEPTION: main
                 Process: com.app.dev.debug, PID: 13846
                 android.database.SQLException: Error code: 1, message: view `calendar_items_view` already exists
                 	at androidx.sqlite.driver.bundled.BundledSQLiteConnectionKt.nativePrepare(Native Method)
                 	at androidx.sqlite.driver.bundled.BundledSQLiteConnectionKt.access$nativePrepare(BundledSQLiteConnection.jvmAndroid.kt:1)
                 	at androidx.sqlite.driver.bundled.BundledSQLiteConnection.prepare(BundledSQLiteConnection.jvmAndroid.kt:36)
                 	at androidx.sqlite.SQLite.execSQL(SQLite.kt:58)
                 	at com.app.kmp.AppDatabase_Impl$createOpenDelegate$_openDelegate$1.createAllTables(AppDatabase_Impl.kt:249)
                 	at androidx.room.BaseRoomConnectionManager.onMigrate(RoomConnectionManager.kt:213)
                 	at androidx.room.BaseRoomConnectionManager.configureDatabase(RoomConnectionManager.kt:100)
                 	at androidx.room.BaseRoomConnectionManager.access$configureDatabase(RoomConnectionManager.kt:37)
                 	at androidx.room.BaseRoomConnectionManager$DriverWrapper$open$1.invoke(RoomConnectionManager.kt:69)
                 	at androidx.room.BaseRoomConnectionManager$DriverWrapper$open$1.invoke(RoomConnectionManager.kt:59)
                 	at androidx.room.concurrent.ExclusiveLock.withLock(ExclusiveLock.kt:48)
                 	at androidx.room.BaseRoomConnectionManager$DriverWrapper.open(RoomConnectionManager.kt:59)
                 	at androidx.room.coroutines.ConnectionPoolImpl$5.invoke(ConnectionPoolImpl.kt:89)
                 	at androidx.room.coroutines.ConnectionPoolImpl$5.invoke(ConnectionPoolImpl.kt:89)
                 	at androidx.room.coroutines.Pool.tryOpenNewConnection(ConnectionPoolImpl.kt:221)
                 	at androidx.room.coroutines.Pool.acquire(ConnectionPoolImpl.kt:209)
                 	at androidx.room.coroutines.ConnectionPoolImpl$acquireWithTimeout$2.invokeSuspend(ConnectionPoolImpl.kt:166)
                 	at androidx.room.coroutines.ConnectionPoolImpl$acquireWithTimeout$2.invoke(Unknown Source:8)
                 	at androidx.room.coroutines.ConnectionPoolImpl$acquireWithTimeout$2.invoke(Unknown Source:4)
                 	at kotlinx.coroutines.intrinsics.UndispatchedKt.startUndispatchedOrReturnIgnoreTimeout(Undispatched.kt:53)
                 	at kotlinx.coroutines.TimeoutKt.setupTimeout(Timeout.kt:148)
                 	at kotlinx.coroutines.TimeoutKt.withTimeout(Timeout.kt:43)
                 	at kotlinx.coroutines.TimeoutKt.withTimeout-KLykuaI(Timeout.kt:71)
                 	at androidx.room.coroutines.ConnectionPoolImpl.useConnection(ConnectionPoolImpl.kt:536)
                 	at androidx.room.RoomConnectionManager.useConnection(RoomConnectionManager.android.kt:126)
                 	at androidx.room.RoomDatabase.useConnection$room_runtime_release(RoomDatabase.android.kt:583)
                 	at androidx.room.TriggerBasedInvalidationTracker.syncTriggers$room_runtime_release(InvalidationTracker.kt:290)
                 	at androidx.room.TriggerBasedInvalidationTracker$createFlow$1$1.invokeSuspend(InvalidationTracker.kt:223)
                 	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
                 	at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:101)
                 	at kotlinx.coroutines.internal.LimitedDispatcher$Worker.run(LimitedDispatcher.kt:113)
                 	at kotlinx.coroutines.scheduling.TaskImpl.run(Tasks.kt:89)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:589)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:823)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:720)
                 	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:707)
                 	Suppressed: kotlinx.coroutines.internal.DiagnosticCoroutineContextException: [StandaloneCoroutine{Cancelling}@a3e53e, Dispatchers.Main.immediate]

I pulled the db from device explorer, and it looks like the "destructive" part of the migration never completed? All the tables and views are is still present - but it's all in the .wal file (first time I just pulled the .db file, and it was empty).

Clearing storage, or uninstall+reinstall resolves the issue, but that's less than ideal, and as soon as the db version is bumped again, even if no other changes are made to the code, it happens again.

It's odd that this appears to have just popped up recently, after a couple of minor changes, after appearing to have been working fine for the last ~15 or so destructive migrations.

Comments

ma...@caringvillage.com <ma...@caringvillage.com> #2Nov 30, 2024 07:31PM

So there does seem to be a bug in Navigation that causes this to fail.

When it navigates with popUpTo and removes SecondFragment, that removal in fragment is set for a frame later and before it is actually removed the navigate call in the onViewCreated of SecondFragment enqueues another call to add it back. But we still need to destroy SecondDetailFragment which ends up marking the NavBackStackEntry associated with SecondFragment as complete before navigation has received the call from the fragment that it has been added back. So by the time it hits this check, the SecondFragment is in the correct state, but Navigation has no way of referencing it so it assumes that it is not associated with an entry.

But this is not the way this type of situation should be implemented. Instead of having the destinations as part of the NavGraph, they should:

be managed by the childFragmentManager of SecondFragment. So instead of going back to SecondFragment just to go somewhere else, each of the fragments take the entire content of SecondFragment and are swapped out.
for some sort of a/b testing, set different graphs in the Activity. The graphs would keep the same SecondFragment id, but swap out the names and then you choose the correct graph based on the condition.

da...@google.com <da...@google.com> #3Dec 2, 2024 04:09PM

Please example,what do you mean by that?

da...@google.com <da...@google.com> Dec 4, 2024 03:54PM

Reassigned to da...@google.com.

ap...@google.com <ap...@google.com> #4Dec 4, 2024 09:43PM

Have SecondFragment as part of your graph and then inside of SecondFragment call the childFragmentManager and replace with the fragment you actually want to show, whether that is SecondTypeOne or SecondTypeTwo.
Create different graphs and follow along with the docs on using different graphs dynamically and inflate and set the one needed based on logic in your Activity.

da...@google.com <da...@google.com> Dec 4, 2024 09:45PM

Marked as fixed.

pr...@google.com <pr...@google.com> #5Dec 11, 2024 06:27PM

Thank you very much. Now the issue does not occur. When I added this code below in SecondFragment

shardViewModel.onGetTypeSecond.observe(viewLifecycleOwner) { isType1 ->
if (isType1) {
val graph = findNavController().graph
val carInstallmentNavGraph =
graph.findNode(R.id.nav_second) as NavGraph
carInstallmentNavGraph.setStartDestination(R.id.secondTypeOneFragment)
findNavController().navigate(SecondFragmentDirections.actionSecondFragmentToSecondTypeOneFragment())
} else {
val graph = findNavController().graph
val carInstallmentNavGraph =
graph.findNode(R.id.nav_second) as NavGraph
carInstallmentNavGraph.setStartDestination(R.id.secondTypeTwoFragment)
findNavController().navigate(SecondFragmentDirections.actionSecondFragmentToSecondTypeTwoFragment())
}
}

and removed app:popUpTo="@id/secondFragment" and app:popUpToInclusive="true"

<fragment
android:id="@+id/secondFragment"
android:name="com.example.navigationdeeplink.SecondFragment"
android:label="fragment_second"
tools:layout="@layout/fragment_second" >
<action
android:id="@+id/action_secondFragment_to_secondTypeOneFragment"
app:destination="@id/secondTypeOneFragment" />
<action
android:id="@+id/action_secondFragment_to_secondTypeTwoFragment"
app:destination="@id/secondTypeTwoFragment"
app:popUpTo="@id/secondFragment" />
</fragment>

Issue 381518941