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

Yigit, do you have time to fix it?

reemission of the same liveData is racy

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

yea i'll take it.

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

Thanks for the detailed analysis. This may not be an issue anymore since we've started using Main.immediate there but I' not sure; I'll try to create a test case.

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

just emitting same live data reproduces the issue.

@Test
fun raceTest() {
val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData)
emitSource(subLiveData) //crashes
}
subject.addObserver().apply {
testScope.advanceUntilIdle()
}
}

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

With 2.2.0-alpha04 (that use Main.immediate), the issue seems to be still there (I tested it by calling emitSource() twice, like your test case)

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

Assigned to jb...@google.com.

yea sorry immediate does not fix it.
I actually have a WIP fix for it:

https://android-review.googlesource.com/c/platform/frameworks/support/+/1112186

if your case is the one i found (emitting same LiveData multiple times, as shown in #5) you can work around it by adding a dummy transformation.

val subLiveData = MutableLiveData(1)
val subject = liveData(testScope.coroutineContext) {
emitSource(subLiveData.map {it })
emitSource(subLiveData.map {it} )
}

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

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

commit af12e75e6b4110f48e44ca121466943909de8f06
Author: Yigit Boyar <yboyar@google.com>
Date: Tue Sep 03 12:58:11 2019

Fix coroutine livedata race condition

This CL fixes a bug in liveData builder where emitting same
LiveData source twice would make it crash because the second
emission registry could possibly happen before first one is
removed as source.

We fix it by using a suspending dispose function. It does feel
a bit hacky but we cannot make DisposableHandle.dispose async
and we do not want to block there. This does not mean that there
is a problem if developer disposes it manually since our emit
functions take care of making sure it disposes (and there is
no other way to add source to the underlying MediatorLiveData)

Bug: 140249349
Test: BuildLiveDataTest#raceTest_*

Change-Id: I0b464c242a583da4669af195cf2504e2adc4de40

M lifecycle/lifecycle-livedata-ktx/api/2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/current.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/public_plus_experimental_current.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_2.2.0-alpha05.txt
M lifecycle/lifecycle-livedata-ktx/api/restricted_current.txt
M lifecycle/lifecycle-livedata-ktx/src/main/java/androidx/lifecycle/CoroutineLiveData.kt
M lifecycle/lifecycle-livedata-ktx/src/test/java/androidx/lifecycle/BuildLiveDataTest.kt

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

https://goto.google.com/android-sha1/af12e75e6b4110f48e44ca121466943909de8f06

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