Lifecycle aware call wrappers for navigation [317230685]

Fixed

Feature Request

Status Update

No update yet.

Description

bj...@google.com

created issue #1

Dec 20, 2023 05:54PM

When using Compose navigation, calls to navigate should be guarded by lifecycle state to prevent invoking navigation methods while composable is transitioning as an effect of navigation. Given navigation destination:

composable(...) { backStackEntry ->
  Screen1(
    ...,
    navigateToScreen2 = { navController.navigate("screen2") },
    ...,
    navigateBack = { navController.popBackStack() },
  )
}

navigation calls should be guarded by backStackEntry lifecycle state to prevent invoking navigation from composable that's under transition:

composable(...) { backStackEntry ->
  Screen1(
    ...,
    navigateToScreen2 = {
      if (backStackEntry.lifecycle.currentState == Lifecycle.State.RESUMED) {
        navController.navigate("screen2")
      }
  },

It would be really useful to have a set of lifecycle aware function wrappers for guarding execution of calls, for example:

fun NavBackStackEntry.whenResumed(onClick: () -> Unit): () -> Unit

or standalone composable version which will use LocalLifecycleOwner to access lifecycle state:

@Composable
fun whenResumed(onClick: () -> Unit): () -> Unit

Comments

il...@google.com <il...@google.com> Jan 23, 2024 09:23PM

Assigned to mg...@google.com.

mg...@google.com <mg...@google.com> Jan 31, 2024 05:17PM

Accepted by mg...@google.com.

ap...@google.com <ap...@google.com> #2Feb 8, 2024 11:39AM

When you include androidx.lifecycle:lifecycle-runtime-ktx:2.2.0-alpha05, you are upgrading all of its transitive dependencies, which includes lifecycle-runtime. However, you are *not* upgrading lifecycle-process, which is still using the version of lifecycle from your lifecycle-extensions dependency (2.1.0).

You do any one of the following:
- Add an explicit dependency on lifecycle-process:2.2.0-alpha05 to pull in the new version that is compatible with lifecycle-runtime:2.2.0-alpha05
- Upgrade your lifecycle:extensions dependency to 2.2.0-alpha05 so that lifecycle-process is upgraded
- Remove the lifecycle:extensions dependency entirely and use only the lifecycle libraries you need (for example, use lifecycle-viewmodel-ktx if you want ViewModels) so that you don't pull in lifecycle-process at all

Mixing and matching Lifecycle versions is not a supported configuration, so I'd recommend keeping to using just a single version.

il...@google.com <il...@google.com> Feb 13, 2024 06:10PM

Marked as fixed.

pr...@google.com <pr...@google.com> #3Feb 21, 2024 07:32PM

Sorry and thank you for your time

he...@reaktor.com <he...@reaktor.com> #4Apr 30, 2024 12:28PM

After thinking about this some more, I think we can do something here to maintain compatibility since I suspect that there will be other cases where lifecycle-runtime is updated through some other dependency and that shouldn't force you to upgrade lifecycle-extensions / lifecycle-process.

il...@google.com <il...@google.com> #5Apr 30, 2024 09:44PM

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

commit b73a278881735861cd4a7c4b2f663aecbfce10d8
Author: Ian Lake <ilake@google.com>
Date: Fri Sep 27 15:40:11 2019

Fix lifecycle-runtime:2.2.0 + lifecycle-process:2.1.0

The lifecycle-runtime 2.2.0 switched away from
using ReportFragment on API 29+ devices. However,
lifecycle-process:2.1.0 and earlier still depend on
ReportFragment being there.

Given that lifecycle-process and lifecycle-runtime
do not have any strict Gradle version dependencies
set, it should be possible to mix and match these
dependencies as this is a relatively common operation
(say, if you upgrade to the latest fragments but don't
upgrade your lifecycle-extensions version).

This fixes the issue by continuing to add the
ReportFragment even on API 29+ devices, but ignore
the dispatch() of Lifecycle events from it, using it
solely for backward compatibility with the
ProcessLifecycleOwner of lifecycle-process 2.1.0
and earlier.

Test: tested in sample app
BUG: 141536990
Change-Id: I7f50c33dabe25c24647eec6169b1818d0a23895b

M lifecycle/lifecycle-runtime/src/main/java/androidx/lifecycle/ReportFragment.java

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

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

ha...@gmail.com <ha...@gmail.com> #6Sep 5, 2024 12:12PM

This has been fixed internally. It missed the cutoff for the next version of Lifecycle (2.2.0-beta01), but we'll make sure it is in the next release. The guidance in

comment#2

still applies - it is best to not mix and match lifecycle versions.

Message last modified on Sep 5, 2024 12:13PM