Support Nullable Primitives or Lint Warning in Typesafe Navigation [351994237]

Fixed

Feature Request

Status Update

No update yet.

Description

ag...@wayfair.com

created issue #1

Jul 9, 2024 01:51PM

Component used: Navigation Version used: 2.8.0-beta03 Devices/Android versions reproduced on:

Simply make a class with a nullable primitive like an Int?

@Serializable data class ExampleRoute(val accountMethod: Int?)

and runtime crash:

java.lang.IllegalArgumentException: integer does not allow nullable values
at androidx.navigation.NavArgument.<init>(NavArgument.kt:210)
at androidx.navigation.NavArgument$Builder.build(NavArgument.kt:199)
at androidx.navigation.NavArgumentBuilder.build(NavDestinationBuilder.kt:394)
at androidx.navigation.NamedNavArgumentKt.navArgument(NamedNavArgument.kt:21)
at androidx.navigation.serialization.RouteSerializerKt.generateNavArguments(RouteSerializer.kt:109)
at androidx.navigation.NavDestinationBuilder.<init>(NavDestinationBuilder.kt:94)
at androidx.navigation.compose.ComposeNavigatorDestinationBuilder.<init>(ComposeNavigatorDestinationBuilder.kt:95)

In the IDE, there is no indication this is wrong, and is perfectly valid in Kotlinx serialization. I understand complex types requiring a barrier, but a nullable primitive seems logical in kotlin. A lint warning or error would be also highly helpful to prevent this from potentially crashing at runtime.

Comments

jb...@google.com <jb...@google.com> Jul 9, 2024 01:51PM

Assigned to cl...@google.com.

ap...@google.com <ap...@google.com> #2Jul 23, 2024 11:28PM

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

commit 12572dfa41547c1f6d451d5d12c6ad04e46c7344
Author: Clara Fok <clarafok@google.com>
Date: Tue Jul 23 13:23:20 2024

Add support for nullable Int in safe args

Test: ./gradlew navigation:navigation-runtime:cC
Bug: 351994237
Relnote: "Navigation in safe args has added built-in support for argumnets of type `Int?`."
Change-Id: I978b0c52b9847518f77d5f238ef8461da9dc485b

M navigation/navigation-common/src/androidTest/java/androidx/navigation/serialization/RouteFilledTest.kt
M navigation/navigation-common/src/main/java/androidx/navigation/serialization/NavTypeConverter.kt
M navigation/navigation-common/src/test/java/androidx/navigation/serialization/NavArgumentGeneratorTest.kt
M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerRouteTest.kt

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

cl...@google.com <cl...@google.com> Jul 24, 2024 01:06AM

Accepted by cl...@google.com.

ap...@google.com <ap...@google.com> #3Jul 24, 2024 06:47PM

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

commit 3672e5d8699e643cc156bcc841b3515821d51c34
Author: Clara Fok <clarafok@google.com>
Date: Wed Jul 24 10:40:00 2024

Add support for nullable Boolean in safe args

Test: ./gradlew navigation:navigation-runtime:cC
Bug: 351994237
Relnote: "Navigation in safe args has added built-in support for argumnets of type `Boolean?`."
Change-Id: Ifba6679f9214b477802567403d8ae97203a30303

M navigation/navigation-common/src/androidTest/java/androidx/navigation/serialization/RouteFilledTest.kt
M navigation/navigation-common/src/main/java/androidx/navigation/serialization/NavTypeConverter.kt
M navigation/navigation-common/src/test/java/androidx/navigation/serialization/NavArgumentGeneratorTest.kt
M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerRouteTest.kt

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

ap...@google.com <ap...@google.com> #4Jul 24, 2024 06:50PM

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

commit 055c9b9f41871ed7edf4a3d2508eb0ed2f553a47
Author: Clara Fok <clarafok@google.com>
Date: Wed Jul 24 10:56:03 2024

Add support for nullable Float in safe args

Test: ./gradlew navigation:navigation-runtime:cC
Bug: 351994237
Relnote: "Navigation in safe args has added built-in support for argumnets of type `Float?`."
Change-Id: I1c580e271cab940b11378f85bd0a5175c503e2f5

M navigation/navigation-common/src/main/java/androidx/navigation/serialization/NavTypeConverter.kt
M navigation/navigation-common/src/test/java/androidx/navigation/serialization/NavArgumentGeneratorTest.kt
M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerRouteTest.kt

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

ap...@google.com <ap...@google.com> #5Jul 24, 2024 06:52PM

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

commit b4551b59c205fda966eb62ecdf769717585287e5
Author: Clara Fok <clarafok@google.com>
Date: Wed Jul 24 11:10:36 2024

Add support for nullable Long in safe args

Test: ./gradlew navigation:navigation-runtime:cC
Bug: 351994237
Relnote: "Navigation in safe args has added built-in support for argumnets of type `Long?`."
Change-Id: I32d131926d08b01151c22d35f7a2d3389d5a1f56

M navigation/navigation-common/src/main/java/androidx/navigation/serialization/NavTypeConverter.kt
M navigation/navigation-common/src/test/java/androidx/navigation/serialization/NavArgumentGeneratorTest.kt
M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerRouteTest.kt

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

cl...@google.com <cl...@google.com> #6Jul 24, 2024 07:06PM

Marked as fixed.

Added built-in support of the following nullable primitives

Int?, Boolean?, Float?, Long?

These primitives will no longer require custom NavTypes.

Note that this support only applies to safe args in Kotlin DSL. XML-based navigation will continue to only support non-nullable primitives.

Will be available in the navigation release on Aug 7th.

ap...@google.com <ap...@google.com> #7Jul 25, 2024 11:56PM

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

commit 3cba58164e32afa04d092ba3b4ab8dc326451290
Author: Clara Fok <clarafok@google.com>
Date: Wed Jul 24 17:10:19 2024

Add support for nullable Enums in safe args

Refactored helper function `parseSerializableOrParcelableType` to take a `clazz: Class<*>` instead of `className: String` so that it can be better reused by NavTypeConverter.

Test: ./gradlew navigation:navigation-common:test
Test: ./gradlew navigation:navigation-common:cC
Test: ./gradlew navigation:navigation-runtime:cC
Bug: 351994237
Relnote: "Navigation in safe args has added built-in support for argumnets of type `Enum<*>?`."
Change-Id: Ide076fd4f77daf8373d71e093f833920aba9b911

M navigation/navigation-common/src/androidTest/java/androidx/navigation/serialization/RouteFilledTest.kt
M navigation/navigation-common/src/main/java/androidx/navigation/NavType.kt
M navigation/navigation-common/src/main/java/androidx/navigation/serialization/NavTypeConverter.kt
M navigation/navigation-common/src/test/java/androidx/navigation/serialization/NavArgumentGeneratorTest.kt
M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerRouteTest.kt

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

pr...@google.com <pr...@google.com> #8Aug 13, 2024 06:59PM

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

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