App crashes if typeMap for enum is not provided [358137294]

Fixed

Bug

Status Update

No update yet.

Description

nd...@gmail.com

created issue #1

Aug 8, 2024 11:19AM

Component used: Navigation Version used: Version 2.8.0-beta07 Devices/Android versions reproduced on: Pixel 6Pro Android14 The release notes for Version 2.8.0-beta07 state that there is not need to explicitly provide a typeMap for Enum classes but the App crashes on startup but works as expected if the typeMap is provided or the enum class is nested inside the destination serializable data class.

this one works

@Serializable
data class DetailDestination(val levels: Levels){
enum class Levels{
    LEVEL_1,
    LEVEL_2,
    LEVEL_3,
    LEVEL_4,
    LEVEL_5,
}
}

but this one fails

enum class Levels{
    LEVEL_1,
    LEVEL_2,
    LEVEL_3,
    LEVEL_4,
    LEVEL_5,
}

@Serializable
data class DetailDestination(val levels: Levels)

java.lang.IllegalArgumentException:
Cannot find class with name "com.dev.enumsafeargscompose.Levels". Ensure that the serialName for this argument is the default fully qualified name

If this is a bug in the library, we would appreciate if you could attach:

Sample project to trigger the issue. Github Link

beta07.png

195 KB

View

Download

Comments

il...@google.com <il...@google.com> Aug 8, 2024 12:06PM

Assigned to cl...@google.com.

nd...@gmail.com <nd...@gmail.com> #2Aug 8, 2024 12:23PM

You don't need to do step 1 or 2 - ensuring you've called addNavigator() before setGraph() is enough.

Specifically, see

https://issuetracker.google.com/issues/110763345#comment2

Also mentioned is the fact that you can override createFragmentNavigator(), call navController.navigatorProvider.addNavigator() there, then return super.createFragmentNavigator().

st...@gmail.com <st...@gmail.com> #3Aug 8, 2024 12:33PM

It's may also be of interest that I am making use of a custom navigator to implement conditional routing. My custom destination/nodes simply implement an interface like this:
interface DynamicNode {
@IdRes
fun getDestination(context: Context, @IdRes destinationIn: Int, argsIn: Bundle?) : Int
}

The Navigator then implements a navigate method that simply calls NavController.navigate using the ID returned by the DynamicNode and returns null, essentially performing a redirect. It would be cool to see something like this baked-in with a later version of the Navigation component.

ap...@google.com <ap...@google.com> #4Aug 8, 2024 08:41PM

>> You don't need to do step 1 or 2 - ensuring you've called addNavigator() before setGraph() is enough.

Ah gotcha. Okay that's a nicer then. Thanks!

cl...@google.com <cl...@google.com> #5Aug 9, 2024 09:36AM

Marked as fixed.

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

commit 238c09170a34e1c94af42bc3c6e9fce551883aef
Author: Ian Lake <ilake@google.com>
Date: Mon Apr 22 12:54:51 2019

Rename createFragmentNavigator()

Fix confusion around what method should
be overriden to add custom Navigators to
a NavHostFragment.

Test: tested in testapp
Fixes: 122802849
Change-Id: I969dca429a62e0533cb4ca93c77e68e062278a6f

M navigation/fragment/api/2.1.0-alpha03.txt
M navigation/fragment/api/current.txt
M navigation/fragment/src/main/java/androidx/navigation/fragment/NavHostFragment.java

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

https://goto.google.com/android-sha1/238c09170a34e1c94af42bc3c6e9fce551883aef

st...@gmail.com <st...@gmail.com> #6Aug 9, 2024 03:26PM

We've decided to rename createFragmentNavigator() to onCreateNavController(NavController) to make it more clear that this is something you can override to get a callback for when the NavController is created.

This will be available in Navigation 2.1.0-alpha03

st...@gmail.com <st...@gmail.com> #7Aug 9, 2024 03:38PM

Very good point made by Ian, adding @androidx.annotation.Keep to the enum makes it not crash again, since r8 no longer mangles the name, and serialization and the real name then start matching again.

cl...@google.com <cl...@google.com> #8Aug 9, 2024 03:42PM

Re: comment#6 - I can't reproduce crash.

I git cloned your main branch from https://github.com/StylianosGakis/navigation-predictive-back-breaking-shared-element.

Tried running as is, with SomeEnum nested inside B, no crashes. I then moved your enum class out of B

@Serializable
data class B(val someEnum: SomeEnum) 

enum class SomeEnum {
  A, B;
}

So now its using snapshot, minified = true, top level Enum, no crashes.

Message last modified on Aug 9, 2024 03:45PM

cl...@google.com <cl...@google.com> #9Aug 9, 2024 03:59PM

Ah yes I see the crash in release build. As Ian recommended, use @androidx.annotation.Keep or else the class gets removed.

st...@gmail.com <st...@gmail.com> #10Aug 10, 2024 07:34PM

Created a new issue https://issuetracker.google.com/issues/358687142 to track specifically what I mention right above, as this issue is now considered fixed but I still think it's worth looking at the problem when minification is in the mix.

ap...@google.com <ap...@google.com> #11Aug 20, 2024 11:06PM

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

commit 6187e05a8c1892c1679aa4571e5a5d6ffb9663e8
Author: Clara Fok <clarafok@google.com>
Date: Fri Aug 09 09:26:44 2024

Improve error message for Enum type

Navigation added built-in support for Enums in type safety. Due to limited metadata without kotlin reflect, the implementation relies on the Enum's serialName to match the Enum class's fqn.

However, if r8 minifed build is employed in release builds, it is possible that the fqn is modified. Kotlinx serialization is not aware of this, however, and the serialName would remain the same. This means navigation won't be able to match the serialName to the new fqn.

The current solution is to add @androidx.annotation.Keep on enum classes to ensure it doesn't get erased. We should update the exception message to suggest this as a possible solution.

Test: ./gradlew navigation:navigation-common:cC
Bug: 358137294
Relnote: "Update Enum class not found exception to suggest using @Keep annotation in case the Enum class gets erased in minified builds."
Change-Id: I90e79cc476c21ab0ad3b172af65c436817665ef7

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

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

na...@google.com <na...@google.com> #12Aug 21, 2024 07:55PM

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

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

sa...@outlook.com <sa...@outlook.com> #13Aug 24, 2024 04:55AM

This bug is not happening for me anymore with the debug build, but is still happening with the release/R8 minified build.

Looks like the above suggestion to update the exception to add the Keep annotation would be a good idea.

ch...@gmail.com <ch...@gmail.com> #14Oct 2, 2024 06:36PM

I'm building my app in debug with minify disabled but I still have the issue:

@Serializable
data class NewReservationDetails(val usage: Usage) {
companion object {
val typeMap = mapOf(typeOf<Usage>() to NavType.EnumType<Usage>(Usage::class.java))

fun from(savedStateHandle: SavedStateHandle) =
savedStateHandle.toRoute<Usage>(typeMap)
}
}

composable<NewReservationDetails>(
enterTransition = { expandHorizontally() },
exitTransition = { shrinkHorizontally() },
typeMap = NewReservationDetails.typeMap
) { backStackEntry ->
val parentEntry = remember(backStackEntry) {
navController.getBackStackEntry(NewReservation)
}
val parentViewModel: OrderRideHostViewModel = hiltViewModel(parentEntry)
val viewModel: OrderRideAddressDateViewModel = hiltViewModel()
NewReservationDetailsScreen(
orderRideAddressDateViewModel = viewModel,
orderRideHostViewModel = parentViewModel
)
}
)

class OrderRideAddressDateViewModel @Inject constructor(
val savedStateHandle: SavedStateHandle,
) : ViewModel() {

private val usage = NewReservationDetails.from(savedStateHandle)
}

I'm still having the crash, i've tried a lot of thing :(

java.lang.IllegalArgumentException: Cannot cast PERSO of type com.wimova.domain.model.Usage.PERSO to a NavType. Make sure to provide custom NavType for this argument.

Message last modified on Oct 2, 2024 06:37PM

il...@google.com <il...@google.com> #15Oct 2, 2024 08:54PM

Re comment#14 - please file a separate bug with a sample project that reproduces your issue.

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

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

androidx.navigation:navigation-common:2.9.0-alpha01

ca...@digitalchargingsolutions.com <ca...@digitalchargingsolutions.com> #17Mar 28, 2025 12:55PM

As a rule of thumb I try to avoid using @Keep, because sooner or later someone will forget to add it. Instead, in my opinion it's better to add a proguard rule to "keep" the information for all future usages as well.

~~I am using this now and it solved the crash. Would it maybe make sense to ship the library with this or to reference it, as an alternative to using @Keep?~~

Edit: Actually Serializable is not needed for the enum, but imo this is an okay solution.

Variant 1: -keep @kotlinx.serialization.Serializable enum * { *; }

Variant 2:

# Keep child enums of classes tagged with @Serializable.
-if @kotlinx.serialization.Serializable class ** { *; }
-keep enum * { *; }

Message last modified on Mar 28, 2025 01:17PM