Generated code for NavArgs has deprecated usages of Bundle [237725966]

Fixed

Bug

Status Update

No update yet.

Description

al...@gmail.com

created issue #1

Jul 1, 2022 08:07AM

Component used: Navigation

Version used: 2.4.2

Target SDK and Compile SDK version: 33

I would like to report that when building our app that targets API 33, the generated code for destination arguments in Navigation graphs use deprecated usages of Bundle (ie. Bundle.get(String key), Bundle.getParcelableArray(String key)

Here is an example of how the generated code looks like (I modified arg names):

 if (bundle.containsKey("someArg")) {
        __someArg = bundle.getParcelableArray("someArg")?.map { it as ResolveInfo
            }?.toTypedArray()
        if (__someArg == null) {
          throw IllegalArgumentException("Argument \"someArg\" is marked as non-null but was passed a null value.")
        }
      } else {
        throw IllegalArgumentException("Required argument \"someArg\" is missing and does not have an android:defaultValue")
      }

and another:

      if (bundle.containsKey("someOtherArg")) {
        if (Parcelable::class.java.isAssignableFrom(SomeOtherArg::class.java) ||
            Serializable::class.java.isAssignableFrom(SomeOtherArg::class.java)) {
          __someOtherArg = bundle.get("someOtherArg") as SomeOtherArg?
        } else {
          throw UnsupportedOperationException(SomeOtherArg::class.java.name +
              " must implement Parcelable or Serializable or must be an Enum.")
        }
        if (__someOtherArg == null) {
          throw IllegalArgumentException("Argument \"someOtherArg\" is marked as non-null but was passed a null value.")
        }
      }

Comments

al...@gmail.com <al...@gmail.com> #2Jul 4, 2022 07:34AM

Oh I forgot to mention that I thought it might be connected to this issue: https://issuetracker.google.com/issues/243778589. But after trying 2.5.2 I can say that the issue persists.

al...@gmail.com <al...@gmail.com> #3Jul 6, 2022 08:07AM

Please provide a minimal sample project along with the minimal steps to recreate the issue in the project.

jb...@google.com <jb...@google.com> #4Jul 6, 2022 04:14PM

Sorry for the delay. I got a working example here: https://github.com/Del-S/issues. The project is set up to crash when navigating to ThirdFragment (nested nav graph) with poping the graph.

I poked into it a little bit and it seems to be connected to SafeArgs gradle plugin. When safe args is used to navigate to ThirdFragment (with nested graph poped) it will try to recreate te parent but there were no arguments passed so it crashes.

Steps to reproduce:

Navigate from Second Fragment to Child nav graph (with non-nullable parameters).
Navigate to Third fragment using SafeArgs and the app crashes.

Crash log:

Process: cz.dels.issues, PID: 1743
java.lang.NullPointerException: null cannot be cast to non-null type kotlin.Long
at androidx.navigation.NavType$Companion$LongType$1.get(NavType.kt:352)
at androidx.navigation.NavType$Companion$LongType$1.get(NavType.kt:342)
at androidx.navigation.NavArgument.verify(NavArgument.kt:76)
at androidx.navigation.NavDestination.addInDefaultArgs(NavDestination.kt:502)
at androidx.navigation.NavController.addEntryToBackStack(NavController.kt:1865)
at androidx.navigation.NavController.addEntryToBackStack$default(NavController.kt:1813)
at androidx.navigation.NavController$navigate$4.invoke(NavController.kt:1721)
at androidx.navigation.NavController$navigate$4.invoke(NavController.kt:1719)
at androidx.navigation.NavController$NavControllerNavigatorState.push(NavController.kt:287)
at androidx.navigation.fragment.FragmentNavigator.navigate(FragmentNavigator.kt:246)
at androidx.navigation.fragment.FragmentNavigator.navigate(FragmentNavigator.kt:162)
at androidx.navigation.NavController.navigateInternal(NavController.kt:260)
at androidx.navigation.NavController.navigate(NavController.kt:1719)
at androidx.navigation.NavController.navigate(NavController.kt:1545)
at androidx.navigation.NavController.navigate(NavController.kt:1472)
at androidx.navigation.NavController.navigate(NavController.kt:1930)
at cz.dels.issues.SecondFragment.onViewCreated$lambda-0(SecondFragment.kt:38)
at cz.dels.issues.SecondFragment.$r8$lambda$XDYnOS_cYrafiNQ5rcCu1WCn0IE(Unknown Source:0)
at cz.dels.issues.SecondFragment$$ExternalSyntheticLambda0.onClick(Unknown Source:2)

Note: If in step 2 SaveArgs is not used then navigation works correctly. More information is here: https://github.com/Del-S/issues/blob/master/app/src/main/java/cz/dels/issues/SecondFragment.kt#L37.

al...@gmail.com <al...@gmail.com> #5Jul 6, 2022 11:27PM

Ups a typo: Navigate from ~~Second~~ First Fragment to Child nav graph (with non-nullable parameters).

Note: sorry for the spam but I am not able to edit my own comment.

al...@gmail.com <al...@gmail.com> #6Jul 7, 2022 07:09AM

This has been fixed and will be available in navigation 2.6.0-alpha08

il...@google.com <il...@google.com> #7Jul 8, 2022 08:08PM

Assigned to jb...@google.com.

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

commit 6b358154b794a0456b089ac8e548bfb830dd6c22
Author: Clara Fok <clarafok@google.com>
Date: Tue Mar 14 17:56:12 2023

Fix missing non-nullable arg when rebuilding hierarchy

When navigating with NavDirections, args is populated with an empty bundle. This causes issue when we rebuild parent hierarchy while adding a new entry to NavBackStack. If the Entry being rebuilt contains a non-nullalbe arg, i.e. Long, this empty bundle will cause an exception.

Test: ./gradlew navigation:navigation-runtime:cC
Bug: 249988437
Change-Id: I5c8ce739ad9a3428c8a8de13eae391bfff0db5df

M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerTest.kt
M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.kt

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

al...@gmail.com <al...@gmail.com> #8Jul 9, 2022 01:18AM

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

androidx.navigation:navigation-runtime:2.6.0-alpha08

mi...@gmail.com <mi...@gmail.com> #9Jul 11, 2022 12:53PM

Is this difficult to also backport the change to earlier releases? Upgrading to 2.5.1 might need to also upgrade other dependencies.

il...@google.com <il...@google.com> #10Jul 11, 2022 05:54PM

Re comment#9 - sorry, we can only backport changes to the latest stable release (in this case, cherry picking this change into Navigation 2.5.0).

mi...@gmail.com <mi...@gmail.com> #11Jul 15, 2022 09:28AM

Is there an estimated release date for 2.5.1? Thank you!

ap...@google.com <ap...@google.com> #12Jul 18, 2022 10:56PM

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

commit 0027220b3ef51bf9c69ac0287c3699e0b87f6422
Author: Jeremy Woods <jbwoods@google.com>
Date: Fri Jul 15 14:38:08 2022

Add deprecation suppressions to generated fromBundle

The getParcelableArray() and get() functions on Bundle have been
deprecated in SDK 33. This causes warning in the generated Safe Args
classes that use the fromBundle function with custom types.

We need to continue to use the old functions since we need to support
older platform versions so we should suppress the warnings on these
calls.

RelNote: "Navigation Safe Args will no longer cause deprecation warnings
in generated classes when using custom types."
Test: ./gradlew :navigation:navigation-safe-args-generator:test
--rerun-tasks
Bug: 237725966

Change-Id: Id86edf231b90176b5a0f03239bff628171a0284c

M navigation/navigation-safe-args-generator/src/test/test-data/expected/java_nav_writer_test/MainFragmentArgs.java
M navigation/navigation-safe-args-generator/src/test/test-data/expected/kotlin_nav_writer_test/MainFragmentArgs.kt
M navigation/navigation-safe-args-generator/src/main/kotlin/androidx/navigation/safe/args/generator/java/JavaNavWriter.kt
M navigation/navigation-safe-args-generator/src/main/kotlin/androidx/navigation/safe/args/generator/kotlin/KotlinNavWriter.kt

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

jb...@google.com <jb...@google.com> #13Jul 18, 2022 10:57PM

Marked as fixed.

This has been fixed internally and will be released in the Navigation 2.5.1 and 2.6.0-alpha01 versions.

na...@google.com <na...@google.com> #14Sep 12, 2022 05:52PM

This bug was linked in a change in the following release(s):

androidx.navigation:navigation-safe-args-generator:2.6.0-alpha01