Updating Wear Compose app to navigation-compose:2.4.0-beta02 causes failure [207328687]

Fixed

Bug

adexe s nau

Status Update

No update yet.

Description

ys...@google.com

created issue #1

Nov 22, 2021 09:08AM

Component used: Wear Activity Version used: 1.0.0-beta01 Devices/Android versions reproduced on: Wear Emulator (API 30)

Works with 1.0.0-alpha03

Error on 1.0.0-beta01

    java.lang.IllegalStateException: You cannot access the NavBackStackEntry's ViewModels until it is added to the NavController's back stack (i.e., the Lifecycle of the NavBackStackEntry reaches the CREATED state).
        at androidx.navigation.NavBackStackEntry.getViewModelStore(NavBackStackEntry.kt:180)
        at androidx.lifecycle.ViewModelProvider.<init>(ViewModelProvider.kt:105)
        at androidx.lifecycle.viewmodel.compose.ViewModelKt.get(ViewModel.kt:82)
        at androidx.lifecycle.viewmodel.compose.ViewModelKt.viewModel(ViewModel.kt:72)
        at androidx.navigation.compose.NavBackStackEntryProviderKt.SaveableStateProvider(NavBackStackEntryProvider.kt:86)
        at androidx.navigation.compose.NavBackStackEntryProviderKt.access$SaveableStateProvider(NavBackStackEntryProvider.kt:1)
        at androidx.navigation.compose.NavBackStackEntryProviderKt$LocalOwnersProvider$1.invoke(NavBackStackEntryProvider.kt:51)
        at androidx.navigation.compose.NavBackStackEntryProviderKt$LocalOwnersProvider$1.invoke(NavBackStackEntryProvider.kt:50)
        at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:107)
        at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:34)
        at androidx.compose.runtime.CompositionLocalKt.CompositionLocalProvider(CompositionLocal.kt:228)
        at androidx.navigation.compose.NavBackStackEntryProviderKt.LocalOwnersProvider(NavBackStackEntryProvider.kt:46)
        at androidx.wear.compose.navigation.SwipeDismissableNavHostKt.BoxedStackEntryContent(SwipeDismissableNavHost.kt:194)
        at androidx.wear.compose.navigation.SwipeDismissableNavHostKt.access$BoxedStackEntryContent(SwipeDismissableNavHost.kt:1)
        at androidx.wear.compose.navigation.SwipeDismissableNavHostKt$SwipeDismissableNavHost$5.invoke(SwipeDismissableNavHost.kt:169)
        at androidx.wear.compose.navigation.SwipeDismissableNavHostKt$SwipeDismissableNavHost$5.invoke(SwipeDismissableNavHost.kt:168)
        at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:135)
        at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:34)
        at androidx.wear.compose.material.SwipeToDismissBoxKt.SwipeToDismissBox-njYn8yo(SwipeToDismissBox.kt:177)
        at androidx.wear.compose.navigation.SwipeDismissableNavHostKt.SwipeDismissableNavHost(SwipeDismissableNavHost.kt:162)
        at androidx.wear.compose.navigation.SwipeDismissableNavHostKt.SwipeDismissableNavHost(SwipeDismissableNavHost.kt:77)
        at ...
        at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:107)
        at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:34)
        at androidx.wear.compose.material.ScaffoldKt.Scaffold(Scaffold.kt:66)

I have a non public repro but haven't created a standalone repro yet.

Comments

ys...@google.com <ys...@google.com> #2Nov 22, 2021 09:26AM

Project: platform/frameworks/support
Branch: androidx-main
Author: Louis Pullen-Freilich <lpf@google.com>
Link: https://android-review.googlesource.com/3328184

Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling

Expand for full commit details

Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling 
 
These APIs allow overscroll to have events dispatched to it by one component, and rendered in a separate component. 
 
Fixes: b/266550551 
Fixes: b/204650733 
Fixes: b/255554340 
Fixes: b/229537244 
Test: OverscrollTest 
Relnote: "Adds OverscrollEffect#withoutDrawing and OverscrollEffect#withoutEventHandling APIs - these APIs create a wrapped instance of the provided overscroll effect that doesn't draw / handle events respectively, which allows for rendering  overscroll in a separate component from the component that is dispatching events. For example, disabling drawing the overscroll inside a lazy list, and then drawing the overscroll separately on top / elsewhere." 
Change-Id: Idbb3d91546b49c1987a041f959bce4b2b09a9f61

Files:

M compose/foundation/foundation/api/current.txt
M compose/foundation/foundation/api/restricted_current.txt
M compose/foundation/foundation/integration-tests/foundation-demos/src/main/java/androidx/compose/foundation/demos/OverscrollDemo.kt
M compose/foundation/foundation/samples/src/main/java/androidx/compose/foundation/samples/OverscrollSample.kt
M compose/foundation/foundation/src/androidInstrumentedTest/kotlin/androidx/compose/foundation/OverscrollTest.kt
M compose/foundation/foundation/src/commonMain/kotlin/androidx/compose/foundation/Overscroll.kt

Hash: f64e25b7a473c757d080521e7dd97b3f6670f60d
Date: Fri Nov 01 18:43:56 2024

ys...@google.com <ys...@google.com> #3Nov 22, 2021 10:21AM

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

androidx.compose.foundation:foundation:1.8.0-alpha06
androidx.compose.foundation:foundation-android:1.8.0-alpha06
androidx.compose.foundation:foundation-jvmstubs:1.8.0-alpha06
androidx.compose.foundation:foundation-linuxx64stubs:1.8.0-alpha06

ys...@google.com <ys...@google.com> #4Nov 22, 2021 10:23AM

Reproducible with navigation-compose:2.4.0-beta02, without hilt.

st...@google.com <st...@google.com> #5Nov 22, 2021 11:23AM

Could be related to this change https://android-review.googlesource.com/c/platform/frameworks/support/+/1843944 which pinned wear-compose to navigation 2.4.0-alpha10 (and it's still set to that version).

api("androidx.navigation:navigation-runtime:2.4.0-alpha10")

da...@google.com <da...@google.com> Nov 22, 2021 02:45PM

Status: New

st...@google.com <st...@google.com> Nov 22, 2021 03:45PM

Assigned to st...@google.com.

st...@google.com <st...@google.com> #6Nov 22, 2021 05:53PM

I built a version of androidx-main without pinning wear-compose to navigation 2.4.0-alpha10 (see comment#5) - still saw the same exception.

st...@google.com <st...@google.com> #7Nov 22, 2021 05:59PM

Reassigned to jb...@google.com.

st...@google.com <st...@google.com> #8Nov 22, 2021 06:34PM

Further info - if we revert the change mentioned in comment#5 (https://android-review.googlesource.com/c/platform/frameworks/support/+/1843944) then the androidx.wear.compose.navigation tests fail with the same exception: java.lang.IllegalStateException: You cannot access the NavBackStackEntry's ViewModels until it is added to the NavController's back stack (i.e., the Lifecycle of the NavBackStackEntry reaches the CREATED state)

il...@google.com <il...@google.com> #9Nov 29, 2021 07:28PM

Calling LocalOwnersProvider on a NavBackStackEntry that has either never been created (unlikely, given that a NavBackStackEntry is moved to CREATED before it is given to any Navigator) or that has already been moved to destroyed (most likely) is indicative of a problem in SwipeDismissableNavHost and how it handles onTransitionComplete() - you should only be marking a transition as complete after that / synchronized with the removal of that destination from your composable hierarchy - thus ensuring that LocalOwnersProvider won't be called on that particular NavBackStackEntry ever again.

NavHost does not run into this issue as it does handle transitions correctly, so this certainly seems to be something specific with SwipeDismissableNavHost.

ap...@google.com <ap...@google.com> #10Dec 2, 2021 06:49PM

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

commit 4a229ca6ef4cef2d5679334737290d71fe027d7b
Author: stevebower <stevebower@google.com>
Date: Wed Dec 01 13:04:01 2021

Do not show navigation content until Lifecycle state CREATED.

aosp/1871175 changed lifecycle state handling so that a
NavBackStackEntry starts in state INITIALIZED. Given that
WearNavigator pushes destinations without transitions,
SwipeDismissableNavHost must no longer show content until the
entry has reached at least state CREATED. Fixing this allows
us to build against latest navigation libraries.

Test: androidx.wear.compose.navigation

Bug: 207328687

Relnote: "Fixed an issue where NavBackStackEntry has lifecycle
state INITIALIZED and should not be shown until it has
lifecycle state CREATED."
Change-Id: I40a2ba51ec8805007dd11f531a5807e60f595a0d

M wear/compose/compose-navigation/build.gradle
M wear/compose/compose-navigation/src/main/java/androidx/wear/compose/navigation/SwipeDismissableNavHost.kt

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

il...@google.com <il...@google.com> Dec 3, 2021 11:13PM

Marked as fixed, reassigned to st...@google.com.

ys...@google.com <ys...@google.com> #11Dec 6, 2021 09:35AM

Which version is this fixed in? It seemed to still happen with 1.0.0-Alpha12, but maybe I missed something else. Can reconfirm if it's meant to be already fixed in released alphas.

st...@google.com <st...@google.com> #12Dec 6, 2021 10:32AM

The fix was submitted after the 1.0.0-Alpha12 release - should be available as a SNAPSHOT build.