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-master-dev

commit b90079595f33f58fece04026a97faa0d243acdb1
Author: Yuichi Araki <yaraki@google.com>
Date: Wed Sep 18 16:55:49 2019

Change the way to detect mismatch between POJO and query

This fixes cursor mismatch warnings with expandProjection.

Bug: 140759491
Test: QueryMethodProcessorTest
Change-Id: I7659002e5e0d1ef60fc1af2a625c0c36da0664d8

M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/QueryMethodProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/testing/TestProcessor.kt

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

https://goto.google.com/android-sha1/b90079595f33f58fece04026a97faa0d243acdb1

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

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6093116828680192/#/cherrypickHistory/all)
Created: 2019-10-14 17:23:42.610596+00:00
Changes: aosp/1123258

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

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

commit bdde5a1a970ddc9007b28de4aa29d60ffa588f08
Author: Yigit Boyar <yboyar@google.com>
Date: Thu Apr 16 16:47:05 2020

Re-factor how errors are dismissed when query is re-written

This CL changes how we handle errors/warnings if query is
re-written.
There was a bug in expandProjection where we would report warnings
for things that Room already fixes automatically (

b/140759491

).
The solution to that problem (I7659002e5e0d1ef60fc1af2a625c0c36da0664d8)
solved it by deferring validating of columns until after re-write
decision is made. Unfortunately, this required changing PojoRowAdapter
to have a dummy mapping until it is validating, make it hard to use
as it does have a non-null mapping which is not useful.

This CL partially reverts that change and instead rely on the log
deferring logic we have in Context. This way, we don't need to break
the stability of PojoRowAdapter while still having the ability to
drop warnings that room fixes. This will also play nicer when we
have different query re-writing options that can use more information
about the query results.

Bug: 153387066
Bug: 140759491
Test: existing tests pass
Change-Id: I2ec967c763d33d7a3ff02c1a13c6953b460d1e5f

M room/compiler/src/main/kotlin/androidx/room/log/RLog.kt
M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt

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

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