Add built-in support for nullable Enum types in safe args [346475493]

Fixed

Feature Request

Status Update

No update yet.

Description

sk...@gmail.com

created issue #1

Jun 11, 2024 06:23PM

Component used: Navigation: androidx.navigation:navigation-compose
Version used: 2.8.0-beta02

Have destination object with enum
Add the destination without typeMap with that enum.

Per Ian's comment here https://issuetracker.google.com/issues/346505952#comment2 it should not be needed.

	@Serializable
	data class IssueEnum(
		val priority: Priority,
	) {
		enum class Priority { Top, Normal }
	}

Repro here: https://github.com/hrach/navigation-compose/commit/6342c95cc0c57a5e8598f92241d59a658c538071

remove the type map for IssueEnum destination
run demo app

                 java.lang.IllegalArgumentException: Cannot cast priority of type dev.hrach.navigation.demo.Destinations.IssueEnum.Priority 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 dev.hrach.navigation.demo.NavHostKt.NavHost$lambda$0(NavHost.kt:275)
                 	at dev.hrach.navigation.demo.NavHostKt.$r8$lambda$FgKxCDk5rO8iiazuePYjqgmHY-Y(Unknown Source:0)
                 	at dev.hrach.navigation.demo.NavHostKt$$ExternalSyntheticLambda0.invoke(D8$$SyntheticClass:0)
                 	at androidx.navigation.compose.NavHostKt.NavHost(NavHost.kt:715)
                 	at dev.hrach.navigation.demo.NavHostKt.NavHost(NavHost.kt:29)

Comments

jb...@google.com <jb...@google.com> Jun 12, 2024 07:20PM

Assigned to cl...@google.com.

cl...@google.com <cl...@google.com> Jul 25, 2024 12:19AM

Accepted by cl...@google.com.

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

since these are in public API (:/) we need to do this in 1.2

cl...@google.com <cl...@google.com> #3Jul 26, 2024 12:13AM

Marked as fixed.

since it is already marked as deprecated, we can probably do it by now.

je...@gmail.com <je...@gmail.com> #4Aug 7, 2024 10:19PM

Opening diff shortly

il...@google.com <il...@google.com> #5Aug 8, 2024 06:12AM

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

commit d576cbdc911cba16638a44fd8223391a90a07ef7
Author: Mike Nakhimovich <digitalbuddha@users.noreply.github.com>
Date: Tue Aug 11 09:30:34 2020

[GH] Hide deprecated internal API.

## Proposed Changes

* `RoomDatabase.java` has protected `mCallbacks` field which is leaking in the API docs, we should @Hide it.

## Testing

Test: Ran unit tests locally

## Issues Fixed

Fixes: 76109329

This is an imported pull request from

https://github.com/androidx/androidx/pull/61.

Resolves #61
Github-Pr-Head-Sha: 6440daa3a63752c7f9d5ba2a390248cd85bc634f
GitOrigin-RevId: fe92d8466a59b44b218b6ca3cbd57dcda17992f7

Change-Id: Id599cdf5b02b32bdae0166266fb7da967598fe92

A room/runtime/api/current.ignore
M room/runtime/api/current.txt
M room/runtime/api/public_plus_experimental_current.txt
M room/runtime/api/restricted_current.txt
M room/runtime/src/main/java/androidx/room/RoomDatabase.java

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

lu...@gmail.com <lu...@gmail.com> #6Aug 9, 2024 07:58AM

I got the same issue as #4, and it's still here in 2.8.0-beta07.

Even if regular enums are implicitly Serializable, you still need to add it or the issue Ensure that the serialName for this argument is the default fully qualified name will appear.

package org.jdc.template.ux.test

@Serializable
enum class TestEnum {
    ONE,
    TWO
}

@Serializable
data class TestRoute(
    val testEnum: TestEnum
)

You will also need to specified type in the declaration of your route:

composable<Route.TestRoute>(
    typeMap = mapOf(
        typeOf<TestEnum>() to NavType.EnumType(TestEnum::class.java)
    ),
) {
    ...
}

During my investigations, I've found that if you declare it like this:

package org.jdc.template.ux.test

@Serializable
data class TestRoute(
    val testEnum: TestEnum
) {
    enum class TestEnum {
        ONE,
        TWO
    }
}

It will work on non-minified code, but it won't after minifying and you will get same error as before.

Message last modified on Aug 9, 2024 08:08AM

cl...@google.com <cl...@google.com> #7Aug 9, 2024 09:37AM

There is a known issue reported in this bug with top-level Enums. Bug has been fixed and will be available in the release on Aug 21st.

Message last modified on Aug 9, 2024 09:42AM

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