NavController.navigate() with launchSingleTop crashes with nested navigation containing same nested routes [294408596]

Fixed

Bug

Status Update

No update yet.

Description

ma...@vonforell.de

created issue #1

Aug 4, 2023 05:37PM

Component used: Navigation

Version used: androidx.navigation:navigation-compose:2.7.0-rc01 (same issue occurs with 2.6.0)

Devices/Android versions reproduced on: Pixel 6 / Android 13

Calling NavController.navigate() { launchSingleTop = true } when using two nested navigations graphs that both contain a node with the same nested route crashes with this stack trace:

type: crash
osVersion: google/oriole/oriole:13/TQ3A.230705.001/2023072600:user/release-keys
package: com.example.navigationtest:1
process: com.example.navigationtest
processUptime: 1300 + 73 ms

java.util.NoSuchElementException: ArrayDeque is empty.
	at kotlin.collections.ArrayDeque.removeLast(ArrayDeque.kt:163)
	at androidx.navigation.NavController.launchSingleTopInternal(NavController.kt:1868)
	at androidx.navigation.NavController.navigate(NavController.kt:1829)
	at androidx.navigation.NavController.navigate(NavController.kt:1792)
	at androidx.navigation.NavController.navigate(NavController.kt:2193)
	at androidx.navigation.NavController.navigate$default(NavController.kt:2188)
	at androidx.navigation.NavController.navigate(NavController.kt:2173)
	at com.example.navigationtest.MainActivityKt$MyNavBar$1$1$1.invoke(MainActivity.kt:81)
	at com.example.navigationtest.MainActivityKt$MyNavBar$1$1$1.invoke(MainActivity.kt:76)
	at androidx.compose.foundation.ClickablePointerInputNode$pointerInput$3.invoke-k-4lQ0M(Clickable.kt:895)
	at androidx.compose.foundation.ClickablePointerInputNode$pointerInput$3.invoke(Clickable.kt:889)
	at androidx.compose.foundation.gestures.TapGestureDetectorKt$detectTapAndPress$2$1.invokeSuspend(TapGestureDetector.kt:255)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)

I have attached a sample project, here's the interesting part of it:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            MyNavHost()
        }
    }
}

@Composable
fun MyNavHost(navController: NavHostController = rememberNavController()) {
    Scaffold(
        bottomBar = { MyNavBar(navController) }
    ) { innerPadding ->
        NavHost(
            modifier = Modifier.padding(innerPadding),
            navController = navController,
            startDestination = "left",
        ) {
            navigation(
                route = "left",
                startDestination = "foo",
            ) {
                composable(route = "foo") {
                    Text("Left")
                }
            }

            navigation(
                route = "right",
                startDestination = "foo",
            ) {
                composable(route = "foo") {
                    Text("Right")
                }
            }
        }
    }
}

@Composable
fun MyNavBar(navController: NavController) {
    val screens = listOf("left", "right")
    val navBackStackEntry by navController.currentBackStackEntryAsState()
    val currentDestination = navBackStackEntry?.destination

    NavigationBar {
        screens.forEach { screen ->
            val selected = currentDestination?.hierarchy?.any { it.route == screen } == true
            NavigationBarItem(
                icon = { Icon(Icons.Default.Info, contentDescription = "") },
                selected = selected,
                label = { Text("text") },
                onClick = {
                    navController.navigate(screen) {
                        launchSingleTop = true
                    }
                }
            )
        }
    }
}

navigation_test.zip

103 KB

Download

Comments

il...@google.com <il...@google.com> Aug 24, 2023 05:57PM

Assigned to cl...@google.com.

al...@gmail.com <al...@gmail.com> #2May 13, 2024 01:10AM

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

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

cl...@google.com <cl...@google.com> Jun 20, 2024 11:07PM

Accepted by cl...@google.com.

ap...@google.com <ap...@google.com> #3Jul 3, 2024 10:54PM

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

commit b2047b27300b0d36faa71dbcd05abba9958977d1
Author: Clara Fok <clarafok@google.com>
Date: Thu Jun 20 15:11:27 2024

Fix single top crash on shared startDestination

Navigation identifies a single top by matching a NavGraph startDestination with the latest NavBackStackEntry. However, different graphs can share the same startDestination route and causes false identification of a single top.

Now to determine if it is a single top, we take the expected singleTop stack (target node to its final startDestination), and try to match it with the latest entries in the backStack. This means different parents sharing the same startDestination are no longer considered as single top navigation.

Test: ./gradlew navigation:navigation-runtime:cC
Bug: 294408596
Relnote: "Fix singleTop navigation crash when different NavGraphs shared the same startDestination."
Change-Id: I17b9466ce3411e0113d1f9a56faa8706577abc72

M navigation/navigation-common/src/main/java/androidx/navigation/NavGraph.kt
M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerRouteTest.kt
M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.kt

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

cl...@google.com <cl...@google.com> #4Jul 3, 2024 11:40PM

Marked as fixed.

Fixed internally and available in navigation 2.8.0-beta05.

na...@google.com <na...@google.com> #5Jul 10, 2024 05:10PM

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

androidx.navigation:navigation-common:2.8.0-beta05
androidx.navigation:navigation-runtime:2.8.0-beta05

Issue 294408596