navigation-compose 2.4.0-alpha05 does not keep a subgraph's BackStackEntry until the transition animation completes [194313238]

Fixed

Bug

adexe s nau

Status Update

No update yet.

Description

ma...@gmail.com

created issue #1

Jul 22, 2021 02:28PM

Component used: navigation-compose Version used: 2.4.0-alpha05

Steps to reproduce:

Create a new compose project using Android Studio Arctic Fox rc01 wizard.
Replace the code below in MainActivity
Run the app, click the button "Go to B" then click the button "Go back".

Ref to Slack convo: https://kotlinlang.slack.com/archives/CJLTWPH7S/p1626963158280100?thread_ts=1626960240.270300&cid=CJLTWPH7S

Sample code to reproduce the issue:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            val navController = rememberNavController()
            NavHost(
                navController = navController,
                startDestination = "a",
                modifier = Modifier.fillMaxSize(),
                route = "mainGraph",
            ) {
                composable(route = "a") {
                    ScreenA(navToB = { navController.navigate("b") })
                }
                navigation(
                    startDestination = "b",
                    route = "subGraph",
                ) {
                    composable(route = "b") {
                        val vm = viewModel<SomeViewModel>(
                            viewModelStoreOwner = navController.getBackStackEntry("subGraph")
                        )
                        ScreenB(navBack = { navController.navigateUp() })
                    }
                }
            }
        }
    }
}

@Composable
fun ScreenA(
    navToB: () -> Unit
) {
    Column {
        Text("I am screen A")
        Button(onClick = navToB) {
            Text("Go to B")
        }
    }
}

@Composable
fun ScreenB(
    navBack: () -> Unit
) {
    Column {
        Text("I am screen B")
        Button(onClick = navBack) {
            Text("Go back")
        }
    }
}

Comments

il...@google.com <il...@google.com> Jul 22, 2021 06:18PM

Assigned to jb...@google.com.

ma...@gmail.com <ma...@gmail.com> #2Aug 5, 2021 06:54AM

We also need documentation with a few examples for it.

ma...@gmail.com <ma...@gmail.com> #3Aug 5, 2021 06:56AM

Any progress with the documentation?

ap...@google.com <ap...@google.com> #4Aug 24, 2021 11:10PM

Changelists related to this issue will be linked once they are submitted.

jb...@google.com <jb...@google.com> #5Aug 26, 2021 11:31PM

Marked as fixed.

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

commit dc23f5c30d0394593e16a594c1502059f7e11140
Author: Ben Weiss <benweiss@google.com>
Date: Mon Mar 09 13:08:13 2020

Kotlin DSL for navigation-dynamic-features-*

Test: check & connectedCheck of affected modules

Bug: 148969800

Change-Id: Icd0cb16fbe7035aca6638c5fb984f27b6eb1ee0c

M navigation/navigation-dynamic-features-fragment/api/2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-fragment/api/current.txt
M navigation/navigation-dynamic-features-fragment/api/public_plus_experimental_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-fragment/api/public_plus_experimental_current.txt
M navigation/navigation-dynamic-features-fragment/api/restricted_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-fragment/api/restricted_current.txt
M navigation/navigation-dynamic-features-fragment/src/androidTest/AndroidManifest.xml
A navigation/navigation-dynamic-features-fragment/src/androidTest/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigatorDestinationBuilderTest.kt
A navigation/navigation-dynamic-features-fragment/src/main/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigatorDestinationBuilder.kt
M navigation/navigation-dynamic-features-runtime/api/2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-runtime/api/current.txt
M navigation/navigation-dynamic-features-runtime/api/public_plus_experimental_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-runtime/api/public_plus_experimental_current.txt
M navigation/navigation-dynamic-features-runtime/api/restricted_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-runtime/api/restricted_current.txt
A navigation/navigation-dynamic-features-runtime/src/androidTest/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigatorDestinationBuilderTest.kt
M navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigator.kt
A navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigatorDestinationBuilder.kt

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

ri...@gmail.com <ri...@gmail.com> #6Sep 27, 2021 11:01PM

Integration into the Kotlin DSL for dynamic feature <activity> and <fragment> destinations is complete internally and will be available in Navigation 2.3.0-alpha04.

Still to do:

Support for DynamicNavGraph (i.e., <navigation> elements) with a moduleName in the DSL
Support for something like <dynamic-include> (<include> isn't necessary in the Kotlin DSL since you'd just call navInflater.inflate() yourself, but for dynamic navigation you would need some equivalent to call navInflater.inflate() after the module is downloaded)

We're tracking the Kotlin DSL documentation separately from this in an internal bug; it is not tied to any specific Navigation release.

Issue 194313238