Exception for missing NavTypes with the new type-safe APIs points to lines of code which are not matching the real source code [346264232]

Fixed

Bug

Status Update

No update yet.

Description

st...@gmail.com

created issue #1

Jun 10, 2024 03:52PM

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

After migrating to use the new APIs, the last step for me was to go ahead and implement all the right typeMap: Map<KType, @JvmSuppressWildcards NavType<*>> to pass into my destinations. The stacktrace for those looked something like this:

java.lang.IllegalArgumentException: Cannot cast sections of type kotlin.collections.ArrayList to a NavType. Make sure to provide custom NavType for this argument.
at androidx.navigation.serialization.RouteSerializerKt.computeNavType(RouteSerializer.kt:166)
at androidx.navigation.serialization.RouteSerializerKt.generateRoutePattern(RouteSerializer.kt:61)
at androidx.navigation.serialization.RouteSerializerKt.generateRoutePattern$default(RouteSerializer.kt:46)
at androidx.navigation.NavDestinationBuilder.<init>(NavDestinationBuilder.kt:102)
at androidx.navigation.compose.ComposeNavigatorDestinationBuilder.<init>(ComposeNavigatorDestinationBuilder.kt:87)
at com.hedvig.android.feature.home.home.navigation.HomeGraphKt.homeGraph$lambda$3(HomeGraph.kt:158)
at com.hedvig.android.feature.home.home.navigation.HomeGraphKt.$r8$lambda$IIglyxrCdF1JgsxPvTgg8qUr6eM(Unknown Source:0)
at com.hedvig.android.feature.home.home.navigation.HomeGraphKt$$ExternalSyntheticLambda0.invoke(D8$$SyntheticClass:0)
at androidx.navigation.compose.NavGraphBuilderKt.navigation(NavGraphBuilder.kt:417)
at com.hedvig.android.feature.home.home.navigation.HomeGraphKt.homeGraph(HomeGraph.kt:84)
at com.hedvig.android.app.navigation.HedvigNavHostKt.HedvigNavHost$lambda$56$lambda$55(HedvigNavHost.kt:99)
at com.hedvig.android.app.navigation.HedvigNavHostKt.$r8$lambda$4yVibVguIbCzl1wpOzQtD0x6edM(Unknown Source:0)
at com.hedvig.android.app.navigation.HedvigNavHostKt$$ExternalSyntheticLambda44.invoke(D8$$SyntheticClass:0)
at androidx.navigation.compose.NavHostKt.NavHost(NavHost.kt:706)
at com.hedvig.android.app.navigation.HedvigNavHostKt.HedvigNavHost(HedvigNavHost.kt:81)
at com.hedvig.android.app.ui.HedvigAppUiKt$HedvigAppUi$1$2.invoke(HedvigAppUi.kt:63)
at com.hedvig.android.app.ui.HedvigAppUiKt$HedvigAppUi$1$2.invoke(HedvigAppUi.kt:62)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:118)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:35)
at com.hedvig.android.app.ui.NavigationSuiteKt.NavigationSuite-W8DTaGw(NavigationSuite.kt:56)
at com.hedvig.android.app.ui.HedvigAppUiKt$HedvigAppUi$1.invoke(HedvigAppUi.kt:56)
at com.hedvig.android.app.ui.HedvigAppUiKt$HedvigAppUi$1.invoke(HedvigAppUi.kt:55)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:109)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:35)
at androidx.compose.material3.SurfaceKt$Surface$1.invoke(Surface.kt:134)
at androidx.compose.material3.SurfaceKt$Surface$1.invoke(Surface.kt:115)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:109)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:35)
at androidx.compose.runtime.CompositionLocalKt.CompositionLocalProvider(CompositionLocal.kt:380)
at androidx.compose.material3.SurfaceKt.Surface-T9BRK9s(Surface.kt:112)
at com.hedvig.android.app.ui.HedvigAppUiKt.HedvigAppUi(HedvigAppUi.kt:51)
at com.hedvig.android.app.ui.HedvigAppKt$HedvigApp$1$2.invoke(HedvigApp.kt:103)
at com.hedvig.android.app.ui.HedvigAppKt$HedvigApp$1$2.invoke(HedvigApp.kt:102)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:109)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:35)
at androidx.compose.runtime.CompositionLocalKt.CompositionLocalProvider(CompositionLocal.kt:401)
at com.hedvig.android.app.ui.HedvigAppKt$HedvigApp$1.invoke(HedvigApp.kt:102)
at com.hedvig.android.app.ui.HedvigAppKt$HedvigApp$1.invoke(HedvigApp.kt:84)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:109)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:35)
at com.hedvig.android.app.ui.HedvigAppKt$HedvigTheme$1$1.invoke(HedvigApp.kt:128)

But the problem is that until the last point where it does lead me to the right place (at com.hedvig.android.app.navigation.HedvigNavHostKt.HedvigNavHost$lambda$56$lambda$55(HedvigNavHost.kt:99)) from that point and up, all the references to my own code are to lines that do not match my real project. For example HomeGraph.kt:82 points to line "82" but the entire file is 71 lines.

I am not sure where this mismatch is happening, but it's making fixing the type maps a very slow job as I need to now go and manually check every single destination and manually deduce if it needs a type-map or not.

Comments

st...@gmail.com <st...@gmail.com> #2Jun 10, 2024 04:05PM

For reference, my class looked like data class SomeDestination(val sections: List<CustomTypeWhichIsSerializableButNotProvidedInTypeMap>) So it just told me about the fact that it did not know how to work with it, but not where to find where the problem was besides somewhere inside my NavGraphBuilder.homeGraph lambda, which in some cases may contain tens of destinations that one would have to go through to check.

il...@google.com <il...@google.com> #3Jun 10, 2024 04:14PM

The exception did say

Cannot cast sections of type kotlin.collections.ArrayList

E.g., it told you exactly what field of what type was causing the exception. Was there more information you were looking for? E.g., SomeDestination?

st...@gmail.com <st...@gmail.com> #4Jun 11, 2024 02:45PM

The issue was mostly that the stacktrace was pointing at the entire function like here https://github.com/HedvigInsurance/android/blob/9bc3f65b2dac13f3d900c704a21be137f06370ce/app/feature/feature-help-center/src/main/kotlin/com/hedvig/android/feature/help/center/HelpCenterGraph.kt#L26-L119 and then it was saying that a field named sections was missing its types.

So what is actionable for me in this context since it does not actually tell me which destination that is, is to go through all of my destinations one by one, jump inside their type and find the one which has a field named sections and has some sort of List<*> in there.
Then after I've found it, if I potentially have more than one destination with a field named sections which has a list of something, then I don't actually know which one it was, so I need to edit something, run again, and notice if the crash stacktrace has changed or not.

I understand that one can end up finding what the issue is and where it is provided enough effort and that their graph is not huge, but optimally this should be much simpler than that.

Out of curiosity, what is it that makes the stacktrace point at the wrong lines of code?

jb...@google.com <jb...@google.com> Sep 16, 2024 08:25PM

Assigned to cl...@google.com.

ap...@google.com <ap...@google.com> #5Sep 19, 2024 02:30AM

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

commit c2f42d17627d19ad4de6121a098a0e8f463aeff4
Author: Clara Fok <clarafok@google.com>
Date: Tue Sep 17 20:38:29 2024

Improve unknown NavType exception message

RouteSerializer.computeNavType throws an IllegalArgumentExcpetion when it fails to map a route argument to a NavType.

To provide an exception with more specific details, the two direct callers of `RouteSerializer.computeNavType` will now catch the exception and throw a different IllegalArgumentExcpetion with a message that contains:

1. argument name
2. arugment fqn
3. route fqn

Test: ./gradlew navigation:navigation-common:cc
Test: ./gradlew navigation:navigation-compose:cC
Bug: 346264232
Relnote: "When Navigation fails to map a route's argument to a NavType, the new error message will contain the argument name, argument fully qualified name, and the route's fully qualified name."
Change-Id: Id84161f47630fe76d85af01bb06c7f3a13d372bb

M navigation/navigation-common/src/androidTest/java/androidx/navigation/NavDestinationBuilderTest.kt
M navigation/navigation-common/src/main/java/androidx/navigation/serialization/RouteSerializer.kt
M navigation/navigation-common/src/test/java/androidx/navigation/serialization/NavArgumentGeneratorTest.kt
M navigation/navigation-compose/src/androidTest/java/androidx/navigation/compose/NavGraphBuilderTest.kt

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

cl...@google.com <cl...@google.com> #6Sep 19, 2024 06:44AM

Marked as fixed.

Fixed internally, available in navigation 2.8.2.

pr...@google.com <pr...@google.com> #7Oct 2, 2024 05:37PM

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

androidx.annotation:annotation-wasm-js:1.9.0-rc01
androidx.annotation:annotation-watchosdevicearm64:1.9.0-rc01
androidx.navigation:navigation-common:2.8.2
androidx.navigation:navigation-compose:2.8.2

na...@google.com <na...@google.com> #8Oct 16, 2024 05:48PM