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

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

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.

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

commit 812fe658e564bb57b0bea0ae79946d04e2b85610
Author: Simon Marquis <contact@simon-marquis.fr>
Date: Tue Dec 19 21:46:01 2023

[GH] Fix regression in dynamic labels with non-string typed arguments

Regression introduced in

https://github.com/androidx/androidx/commit/76f9009e6cfc1cba5314cad87a6f1923203c54fa Reported in

https://issuetracker.google.com/issues/316676794

Test: ./gradlew navigation:navigation-ui:cC
Fixes: 316676794

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

https://issuetracker.google.com/issues/316676794)

This is an imported pull request from

https://github.com/androidx/androidx/pull/636.

Resolves #636
Github-Pr-Head-Sha: f455c6d1e641cc72cc1bd371b1f47b7d87ec8eff
GitOrigin-RevId: 3ad8f763f17acb22678f1a87e183ef4e7dac5a9d
Change-Id: I94b4e28bb847632663be32b11e481d13789e8c1b

M navigation/navigation-common/src/main/java/androidx/navigation/NavDestination.kt
M navigation/navigation-ui/src/androidTest/java/androidx/navigation/ui/NavigationUITest.kt

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

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

Thanks for pointing this out and putting up the PR to fix this! We'll look at doing a Navigation 2.7.7 release with this fix.

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

Awesome, thanks for the quick merge 😀

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

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

androidx.navigation:navigation-common:2.8.0-alpha01
androidx.navigation:navigation-ui:2.8.0-alpha01

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

I can confirm the issue reported here is fixed in 2.8.0-alpha01. Not sure why there is no mention of it in the release notes though. I should have added a RelNotes trailer to the git commit message, or can it be added afterwards?

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

You would have had to add a Relnote if you wanted it mentioned in the release notes, yes.

We can manually add it to the release notes though.

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

Understood!

We can manually add it to the release notes though.

It's up to you to decide if it's worth mentioning :)

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

We've added it to the 2.8.0-alpha01 release notes. Thanks again for the contribution!

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

juma