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

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

commit c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

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

I tried to recreate the issue here -- The warnings for the deprecated usage can be seen, but running lintRelease continues successfully, even though I've configured lint to check generated sources as well by setting checkGeneratedSources to true in lintOptions, and setting warningsAsErrors to true as well.

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

The latest version of the platform deprecated and replaced those functions. But since we are a support library, we can't use the new replacements. We should add deprecation suppressions to SafeArgs instead.

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

I'd also like to add the following details:

The project where this issue is happening is a multi-module project. We don't use Plugins DSL so we still have usages of apply plugin, etc. I can also share logs with Google if someone wants to have a look.

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

I would like to ask if this would be addressed in a future fix? I am planning to do a workaround that involves removing all nav args that use Serializable/Parcelable. It will be a big rework of our codebase, so I'd like to understand if there is any merit to this issue and if there is any appetite to fix this. I'd like to report the status of this issue to my higher-ups as soon as possible. Thanks

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

Assigned to jb...@google.com.

We'll be addressing this in a Navigation 2.5.1 bug fix release.

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

Thank you very much!

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