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

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> #3Jul 26, 2024 12:13AM

Marked as fixed.

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

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

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

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

Re comment#4 - please file a new bug with a sample project that reproduces your issue and we can take a look!

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