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

There are a few more changes to DataStoreImpl's logic which makes a reevaluation necessary.

Now with Yigit's changes, datastore's cold flow always tries to do a dirty read by readState which calls readAndInitOrPropagateAndThrowFailure that invokes readDataOrHandleCorruption only in InitDataStore's first run. Any following read is triggered by IPC's listener which calls readDataAndUpdateCache which updates the cache to ReadException returned from attemptRead.

A ReadException is not automatically handled and stays in cache until a updateData call which revisits readAndInitOrPropagateAndThrowFailure, but it doesn't handle the corruption exception because it's already not the first run. In such case, the handleUpdate call proceeds to transformAndWrite which does not catch the exceptions thrown from readDataFromFileOrDefault.

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

can we create a test failure for this? I'm not fully sure what is going wrong here, it is a bit hard to track w/o a repro case.

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

Marked as fixed.

can we create a test failure for this?

Sure I'm working on the code changes.

In the meantime I think this bug might makes the errors e.g. in b/309382591 harder to recover because it doesn't try to handle the corruption until the app restarts so the DS can readAndInit again (with corruption handler logic).

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

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

commit 383a67d0e5a9b35e394b212db35bdee892b167fb
Author: Zhiyuan Wang <zhiyuanwang@google.com>
Date: Wed Feb 21 17:04:40 2024

Add tests to verify that CorruptionException is not properly handled after DataStore's first disk read. If the internal state is [ReadException], it will not recover for the rest of the lifecycle.

Fix in the follow up change.

Bug: 289582516
Test: ./gradlew :datastore:datastore-core:jvmTest
Change-Id: Ie77900b5c2cb8fb8e55d4c40364491dea9250784

M datastore/datastore-core/src/commonTest/kotlin/androidx/datastore/core/SingleProcessDataStoreTest.kt

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

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

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

commit 70085fee2af278bb8c3e45e1acfcf3f4cbb05c5a
Author: Zhiyuan Wang <zhiyuanwang@google.com>
Date: Thu Feb 22 15:08:34 2024

DataStore handles CorruptionException for all reads and writes.

Before this change, DataStore didn't handle the CorruptionException for both the reads and writes after initialization.

Fixes: 289582516
Test: ./gradlew :datastore:datastore-core:jvmTest
Change-Id: Icb07b140017b62a905d3626f82aeb993f636c053

M datastore/datastore-core/src/commonMain/kotlin/androidx/datastore/core/DataStoreImpl.kt
M datastore/datastore-core/src/commonTest/kotlin/androidx/datastore/core/SingleProcessDataStoreTest.kt

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

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

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.datastore:datastore-core:1.1.0-beta02
androidx.datastore:datastore-core-android:1.1.0-beta02
androidx.datastore:datastore-core-iosarm64:1.1.0-beta02
androidx.datastore:datastore-core-iossimulatorarm64:1.1.0-beta02
androidx.datastore:datastore-core-iosx64:1.1.0-beta02
androidx.datastore:datastore-core-jvm:1.1.0-beta02
androidx.datastore:datastore-core-linuxx64:1.1.0-beta02
androidx.datastore:datastore-core-macosarm64:1.1.0-beta02
androidx.datastore:datastore-core-macosx64:1.1.0-beta02

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

Hi, I recently came across this crash in my current project and I discovered that it happens when a Textfield was tapped and in focus, then the app was backgrounded. This would occur with all of the Textfields in the app.

We are using Compose version: 1.2.0-rc03
and jetpack lifecycle version: 2.4.1

Fatal Exception: java.lang.IllegalStateException: You cannot access the NavBackStackEntry's ViewModels after the NavBackStackEntry is destroyed.
at androidx.navigation.NavBackStackEntry.getViewModelStore(NavBackStackEntry.kt:192)
at androidx.navigation.compose.NavHostKt.NavHost(NavHost.kt:106)
at androidx.navigation.compose.NavHostKt.NavHost(NavHost.kt:69)

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.

[Deleted User] <[Deleted User]> #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?