You cannot access the NavBackStackEntry's ViewModels after the NavBackStackEntry is destroyed. [228865698]

Fixed

Bug

Status Update

No update yet.

Description

b9...@gmail.com

created issue #1

Apr 12, 2022 10:17AM

Version used: 2.5.0-alpha06

After upgraded Lifecycle to 2.5.0-alpha06, the nested NavHost navigation will crash.

open app, starting with "ok" tab.
tap "hello" tab, which has NavHost own.
tab "would" tab, app crash.

p.s. I keep the old version dependencies in build.gradle, you could try the working version.

java.lang.IllegalStateException: You cannot access the NavBackStackEntry's ViewModels after the NavBackStackEntry is destroyed.
        at androidx.navigation.NavBackStackEntry.getViewModelStore(NavBackStackEntry.kt:202)
        at androidx.lifecycle.ViewModelProvider.<init>(ViewModelProvider.kt:130)
        at androidx.lifecycle.SavedStateHandleSupport.getSavedStateHandlesVM(SavedStateHandleSupport.kt:109)
        at androidx.lifecycle.SavedStateHandlesProvider$viewModel$2.invoke(SavedStateHandleSupport.kt:134)
        at androidx.lifecycle.SavedStateHandlesProvider$viewModel$2.invoke(SavedStateHandleSupport.kt:133)
        at kotlin.SynchronizedLazyImpl.getValue(LazyJVM.kt:74)
        at androidx.lifecycle.SavedStateHandlesProvider.getViewModel(SavedStateHandleSupport.kt:133)
        at androidx.lifecycle.SavedStateHandlesProvider.saveState(SavedStateHandleSupport.kt:146)
        at androidx.savedstate.SavedStateRegistry.performSave(SavedStateRegistry.java:262)
        at androidx.savedstate.SavedStateRegistryController.performSave(SavedStateRegistryController.kt:81)
        at androidx.navigation.NavBackStackEntry.saveState(NavBackStackEntry.kt:236)
        at androidx.navigation.NavBackStackEntryState.<init>(NavBackStackEntryState.kt:37)
        at androidx.navigation.NavController.saveState(NavController.kt:2032)
        at androidx.navigation.compose.NavHostControllerKt$NavControllerSaver$1.invoke(NavHostController.kt:81)
        at androidx.navigation.compose.NavHostControllerKt$NavControllerSaver$1.invoke(NavHostController.kt:80)
        at androidx.compose.runtime.saveable.SaverKt$Saver$1.save(Saver.kt:66)
        at androidx.compose.runtime.saveable.RememberSaveableKt$rememberSaveable$1$valueProvider$1.invoke(RememberSaveable.kt:100)
        at androidx.compose.runtime.saveable.SaveableStateRegistryImpl.performSave(SaveableStateRegistry.kt:136)
        at androidx.compose.runtime.saveable.SaveableStateHolderImpl$RegistryHolder.saveTo(SaveableStateHolder.kt:125)
        at androidx.compose.runtime.saveable.SaveableStateHolderImpl$SaveableStateProvider$1$1$invoke$$inlined$onDispose$1.dispose(Effects.kt:484)
        at androidx.compose.runtime.DisposableEffectImpl.onForgotten(Effects.kt:85)
        at androidx.compose.runtime.CompositionImpl$RememberEventDispatcher.dispatchRememberObservers(Composition.kt:985)
        at androidx.compose.runtime.CompositionImpl.applyChangesInLocked(Composition.kt:767)
        at androidx.compose.runtime.CompositionImpl.applyChanges(Composition.kt:785)
        at androidx.compose.runtime.Recomposer$runRecomposeAndApplyChanges$2$2.invoke(Recomposer.kt:526)
        at androidx.compose.runtime.Recomposer$runRecomposeAndApplyChanges$2$2.invoke(Recomposer.kt:454)
        at androidx.compose.ui.platform.AndroidUiFrameClock$withFrameNanos$2$callback$1.doFrame(AndroidUiFrameClock.android.kt:34)
        at androidx.compose.ui.platform.AndroidUiDispatcher.performFrameDispatch(AndroidUiDispatcher.android.kt:109)
        at androidx.compose.ui.platform.AndroidUiDispatcher.access$performFrameDispatch(AndroidUiDispatcher.android.kt:41)
        at androidx.compose.ui.platform.AndroidUiDispatcher$dispatchCallback$1.doFrame(AndroidUiDispatcher.android.kt:69)
        at android.view.Choreographer$CallbackRecord.run(Choreographer.java:1035)
        at android.view.Choreographer.doCallbacks(Choreographer.java:845)
        at android.view.Choreographer.doFrame(Choreographer.java:775)
        at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:1022)
        at android.os.Handler.handleCallback(Handler.java:938)
        at android.os.Handler.dispatchMessage(Handler.java:99)
        at android.os.Looper.loopOnce(Looper.java:201)
        at android.os.Looper.loop(Looper.java:288)
        at android.app.ActivityThread.main(ActivityThread.java:7839)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:548)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1003)

MyApplication.zip

113 KB

Download

Comments

il...@google.com <il...@google.com> Apr 13, 2022 11:47PM

Assigned to il...@google.com.

ap...@google.com <ap...@google.com> #2Apr 14, 2022 03:56AM

Yigit, do you have time to fix it?

reemission of the same liveData is racy

b9...@gmail.com <b9...@gmail.com> #3Apr 14, 2022 07:11AM

yea i'll take it.

il...@google.com <il...@google.com> #4Apr 14, 2022 04:26PM

Marked as fixed.

Thanks for the detailed analysis. This may not be an issue anymore since we've started using Main.immediate there but I' not sure; I'll try to create a test case.

mc...@gmail.com <mc...@gmail.com> #5May 5, 2022 07:09PM

just emitting same live data reproduces the issue.

@Test
fun raceTest() {
val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData)
emitSource(subLiveData) //crashes
}
subject.addObserver().apply {
testScope.advanceUntilIdle()
}
}

tr...@gmail.com <tr...@gmail.com> #6May 5, 2022 07:34PM

With 2.2.0-alpha04 (that use Main.immediate), the issue seems to be still there (I tested it by calling emitSource() twice, like your test case)

il...@google.com <il...@google.com> #7May 5, 2022 09:55PM

yea sorry immediate does not fix it.
I actually have a WIP fix for it:

https://android-review.googlesource.com/c/platform/frameworks/support/+/1112186

if your case is the one i found (emitting same LiveData multiple times, as shown in #5) you can work around it by adding a dummy transformation.

val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData.map {it })
emitSource(subLiveData.map {it} )
}

za...@groundcrewdev.com <za...@groundcrewdev.com> #8Oct 5, 2022 07:48PM

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

commit af12e75e6b4110f48e44ca121466943909de8f06
Author: Yigit Boyar <yboyar@google.com>
Date: Tue Sep 03 12:58:11 2019

Fix coroutine livedata race condition

This CL fixes a bug in liveData builder where emitting same
LiveData source twice would make it crash because the second
emission registry could possibly happen before first one is
removed as source.

We fix it by using a suspending dispose function. It does feel
a bit hacky but we cannot make DisposableHandle.dispose async
and we do not want to block there. This does not mean that there
is a problem if developer disposes it manually since our emit
functions take care of making sure it disposes (and there is
no other way to add source to the underlying MediatorLiveData)

Bug: 140249349
Test: BuildLiveDataTest#raceTest_*

Change-Id: I0b464c242a583da4669af195cf2504e2adc4de40

M lifecycle/lifecycle-livedata-ktx/api/2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/current.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_current.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_current.txt
M lifecycle/lifecycle-livedata-ktx/src/main/java/androidx/lifecycle/CoroutineLiveData.kt
M lifecycle/lifecycle-livedata-ktx/src/test/java/androidx/lifecycle/BuildLiveDataTest.kt

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

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

jb...@google.com <jb...@google.com> #9Oct 5, 2022 07:56PM

Please file a new bug with a minimal sample project that reproduces your error.

za...@groundcrewdev.com <za...@groundcrewdev.com> #10Oct 5, 2022 08:11PM

Okay, we will get a sample project up soon. One thing I forgot to mention in the initial comment is that this crash occurs when we use backQueue.clear() to clear the back stack. We were able to come up with a solution/workaround by using popUpTo() as a way to clear the back stack, and after implementing that solution we saw no crashes when backgrounding the app while a textfield was in focus.

il...@google.com <il...@google.com> #11Oct 5, 2022 08:16PM

Re comment#10 - backQueue is not part of the public API surface and never has been. Calling anything on that is always, always, always the wrong thing to do.

li...@gmail.com <li...@gmail.com> #12Jul 29, 2023 12:58PM

Any updates? This issue is persistent for almost 6 months and its getting crazier.

g....@tnet.ge <g....@tnet.ge> #13Aug 1, 2023 11:32AM

Solution is provided here >

https://github.com/google/accompanist/issues/1487#issuecomment-1660115297

sa...@bluevine.com <sa...@bluevine.com> #14Aug 2, 2023 02:34PM

This is still happened

ra...@gmail.com <ra...@gmail.com> #15Aug 24, 2023 04:39AM

It's still happening with navigation-compose 2.7.0 and lifecycle 2.6.1

jb...@google.com <jb...@google.com> #16Aug 24, 2023 02:26PM

Try 2.7.1

re...@gmail.com <re...@gmail.com> #17Feb 20, 2024 09:15AM

Still happening on navigation-compose v2.7.7 / lifecycle v2.7.0. Any updates / prospect? Workaround maybe?