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

P.S. Actually we cannot running Instrumented Test when using NavigationUI.
When initialize the AppBarConfiguration, it will call the final method of NavGraph (findNode) and we cannot mock it.

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

I also ran into this today while trying to add a FragmentScenario test. Followed the testing documentation and arrived at the same place. AppBarConfiguration attempts to interact with NavGraph and crashes.

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

Yep, we should have a better testing story that doesn't depend on using mocks.

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

One and only solution is to use Mockito in Espresso tests. Which is actually is almost equal to no solution. We strictly do not use Mockito in our integrations tests running on devices because that is very fragile and causes huge amount of issues when using on different SDK versions. This makes Navigation lib no go for us.

So current situation:
- Navigation library is already released with stable API.
- API is created without test-ability in mind. Huge classes with large amount of public methods, no interfaces. Using such tools as Mockito is not a solution, but workaround for situations when API is not testable.

After 10 years of creating un-testable Android SDKs there was possibility to have clean slate opportunity. And here we go again. API released and needs to be maintained now. Please recognize this problem now and bump priority from lowest (P3) to something higher. Because until we won't have possibility to test our app navigation flows we can't use this library.

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

Marked as fixed.

We'll be releasing a dedicated navigation-testing artifact in Navigation 2.3.0-alpha01 that provides additional testing specific APIs

This work includes:

Among other changes.

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