AndroidX Navigation 2.6.0 broke dynamic app bar title for non String arguments [316676794]

Fixed

Bug

Status Update

No update yet.

Description

si...@gmail.com

created issue #1

Dec 16, 2023 04:56PM

Component used: Navigation
Version used: androidx.navigation:navigation-*:2.6.0 and above
Devices/Android versions reproduced on: Not applicable

This commit b1ac7d6 introduced a regression in how the title is dynamically rendered, and more precisely how the Bundle containing parameters is accessed.

Previously, it used the default Bundle.get(key) method:

if (argType == NavType.ReferenceType) {
    val value = context.resources.getString(arguments[argName] as Int)
    title.append(value)
} else {
    title.append(arguments[argName].toString())
}

But after this commit, it now uses Bundle.getString(key):

if (argType == NavType.ReferenceType) {
    val value = context.getString(bundle.getInt(argName))
    builder.append(value)
} else {
    builder.append(bundle.getString(argName))
}

Unfortunately, this breaks basic usage, with other types than String, since Bundle.getString(key) will return null.

Here is a very simple example:

<navigation>
    <fragment android:label="Album #{albumId}">
        <argument android:name="albumId" app:argType="long" />
    </fragment>
</navigation>

Previously it would have correctly set the title to "Album #42" (for example).
But since this update, it will render "Album #null"!

Comments

si...@gmail.com <si...@gmail.com> #2Dec 16, 2023 05:20PM

This has been fixed internally in

https://android-review.googlesource.com/870975 and will be available in Navigation 1.0.0-alpha10.

Now, instead of crashing, we ignore invalid deep links, printing a log message saying as much.

il...@google.com <il...@google.com> Dec 19, 2023 09:37PM

Assigned to il...@google.com.

ap...@google.com <ap...@google.com> #3Dec 19, 2023 10:21PM

Marked as fixed.

Hi team.
The problem still occurs on version 2.2.0-rc04

il...@google.com <il...@google.com> #4Dec 19, 2023 10:26PM

Hi, still getting crash for 2.1.0

si...@gmail.com <si...@gmail.com> #5Dec 19, 2023 10:44PM

still getting crash on version 2.2.0

na...@google.com <na...@google.com> #6Jan 24, 2024 07:53PM

getting crash with 2.2.1

si...@gmail.com <si...@gmail.com> #7Jan 27, 2024 11:57AM

still getting crash with 2.2.1

il...@google.com <il...@google.com> #8Jan 31, 2024 12:08AM

findInvalidDestinationDisplayNameInDeepLink always return null if deepLink length == 1 (deep link destination is start destination of any navGraph of BottomNavigationView)

NavDestination node = i == 0 ? mGraph : graph.findNode(destinationId);
if deepLink.length == 1 node never will be null and this will cause IllegalStateException

Bug demo:

get NavigationAdvancedSample from github

on R.id.about_btn click

NavDeepLinkBuilder(it.context)
.setGraph(R.navigation.list)
.setDestination(R.id.leaderboard)
.createTaskStackBuilder()
.startActivities()

will crash because R.id.leaderboard is start destination (findInvalidDestinationDisplayNameInDeepLink will have deepLink length == 1)

NavDeepLinkBuilder(it.context)
.setGraph(R.navigation.list)
.setDestination(R.id.userProfile)
.createTaskStackBuilder()
.startActivities()

will work because findInvalidDestinationDisplayNameInDeepLink will return NOT null

si...@gmail.com <si...@gmail.com> #9Feb 3, 2024 09:01AM

It still crash with the latest version 2.2.1. I think the problem lies somewhere around this code

NavDestination node = i == 0 ? mGraph : graph.findNode(destinationId);

When i is 0, just return mGraph itself. When the deep link destination is a root of bottom_nav tab, the deeplink.length becomes 1. Which means this function still says there's no invalid Destination in deep link even if deepLink[0] is totally irrelevant tomGraph.

So this step passes and when findDestination() is actually triggered down the road, it won't find any destination and thus lead to unknown destination crash.

All NavControllers of bottom nav automatically call handleDeepLink() as part of onGraphCreated(). The problem arises the moment NavController whose graph is irrelevant to the root deep link destination calls handleDeepLink().

il...@google.com <il...@google.com> #10Feb 5, 2024 10:58PM

It still crashes with 2.3.0-alpha03 version but only if you try to deeplink to startDestination fragment inside navigation graph. Repro steps (described in #8, but lets repeat it in hope issue will be reopened):

download NavigationAdvancedSample
send pending intent to any startDestination screen, e.g.

val pendingIntent = NavDeepLinkBuilder(applicationContext)
                .setGraph(R.navigation.list)
                .setDestination(R.id.leaderboard)
                .setArguments(bundle) // no matter if it is empty in this use case
                .createPendingIntent()
pendingIntent.send()

Exception:

     Caused by: java.lang.IllegalStateException: unknown destination during deep link: com.example.android.navigationadvancedsample:id/list
        at androidx.navigation.NavController.handleDeepLink(NavController.java:689)
        at androidx.navigation.NavController.onGraphCreated(NavController.java:602)
        at androidx.navigation.NavController.setGraph(NavController.java:563)
        at androidx.navigation.NavController.setGraph(NavController.java:528)
        at androidx.navigation.fragment.NavHostFragment.onCreate(NavHostFragment.java:246)
        at androidx.fragment.app.Fragment.performCreate(Fragment.java:2684)
        at androidx.fragment.app.FragmentStateManager.create(FragmentStateManager.java:280)
        at androidx.fragment.app.FragmentManager.moveToState(FragmentManager.java:1175)
        at androidx.fragment.app.FragmentTransition.addToFirstInLastOut(FragmentTransition.java:1255)
        at androidx.fragment.app.FragmentTransition.calculateFragments(FragmentTransition.java:1138)
        at androidx.fragment.app.FragmentTransition.startTransitions(FragmentTransition.java:136)
        at androidx.fragment.app.FragmentManager.executeOpsTogether(FragmentManager.java:1989)
        at androidx.fragment.app.FragmentManager.removeRedundantOperationsAndExecute(FragmentManager.java:1947)
        at androidx.fragment.app.FragmentManager.execSingleAction(FragmentManager.java:1818)
        at androidx.fragment.app.BackStackRecord.commitNow(BackStackRecord.java:297)
        at com.example.android.navigationadvancedsample.NavigationExtensionsKt.obtainNavHostFragment(NavigationExtensions.kt:269)
        at com.example.android.navigationadvancedsample.NavigationExtensionsKt.setupWithNavController(NavigationExtensions.kt:61)
        at com.example.android.navigationadvancedsample.MainActivity.setupBottomNavigationBar(MainActivity.kt:121)
        at com.example.android.navigationadvancedsample.MainActivity.onCreate(MainActivity.kt:54)

Reopening would be a good sign that issue is recognized.

ju...@gmail.com <ju...@gmail.com> #11Dec 2, 2024 05:47PM

Just in a case Reopen feature is not implemented in IssueTracker :), new ticket is created: https://issuetracker.google.com/issues/151164638