"fromSavedStateHandle" can't restore custom parcelable arrays properly [207315994]

Fixed

Bug

adexe s nau

Status Update

No update yet.

Description

hi...@gmail.com

created issue #1

Nov 22, 2021 03:43PM

Component used: Navigation Version used: 2.4.0-beta02 Devices/Android versions reproduced on: multiple versions

When using fromSavedStateHandle to create the NavArgs class, it succeeds on first passes, but it fails when it tries to restore the data from the saved state (after process-death) if it has any Parcelable[] objects, as it doesn't cast them properly.

To reproduce this, please use the attached project, and enable "don't keep activities" from the developer options, if you open the app, then navigate to another app, and comes back, the app will crash with the following stacktrace:

    Process: com.hicham.navigationcrash, PID: 22769
    java.lang.RuntimeException: An exception happened in constructor of class com.hicham.navigationcrash.DestinationViewModel
        at androidx.lifecycle.SavedStateViewModelFactory.create(SavedStateViewModelFactory.java:132)
        at androidx.lifecycle.ViewModelProvider.get(ViewModelProvider.java:185)
        at androidx.lifecycle.ViewModelProvider.get(ViewModelProvider.java:150)
        ...
     Caused by: java.lang.ClassCastException: android.os.Parcelable[] cannot be cast to com.hicham.navigationcrash.CustomParcelable[]
        at com.hicham.navigationcrash.DestinationFragmentArgs$Companion.fromSavedStateHandle(DestinationFragmentArgs.kt:48)
        at com.hicham.navigationcrash.DestinationViewModel.<init>(DestinationViewModel.kt:8)
        ...

The generated fromSavedStateHandle from the attached project has this:

if (savedStateHandle.contains("custom")) {
        __custom = savedStateHandle["custom"]
        if (__custom == null) {
          throw IllegalArgumentException("Argument \"custom\" is marked as non-null but was passed a null value")
        }
      }

while fromBundle handles the casting properly:

if (bundle.containsKey("custom")) {
        __custom = bundle.getParcelableArray("custom")?.map { it as CustomParcelable
            }?.toTypedArray()
        if (__custom == null) {
          throw IllegalArgumentException("Argument \"custom\" is marked as non-null but was passed a null value.")
        }
      }

NavigationCrash.zip

427 KB

Download

Comments

il...@google.com <il...@google.com> Nov 29, 2021 05:14PM

Assigned to jb...@google.com.

ap...@google.com <ap...@google.com> #2Dec 3, 2021 11:38PM

We also need documentation with a few examples for it.

jb...@google.com <jb...@google.com> #3Dec 4, 2021 12:17AM

Marked as fixed.

Any progress with the documentation?

[Deleted User] <[Deleted User]> #4Dec 5, 2022 01:15PM

Changelists related to this issue will be linked once they are submitted.

il...@google.com <il...@google.com> #5Dec 5, 2022 03:37PM

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

commit dc23f5c30d0394593e16a594c1502059f7e11140
Author: Ben Weiss <benweiss@google.com>
Date: Mon Mar 09 13:08:13 2020

Kotlin DSL for navigation-dynamic-features-*

Test: check & connectedCheck of affected modules

Bug: 148969800

Change-Id: Icd0cb16fbe7035aca6638c5fb984f27b6eb1ee0c

M navigation/navigation-dynamic-features-fragment/api/2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-fragment/api/current.txt
M navigation/navigation-dynamic-features-fragment/api/public_plus_experimental_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-fragment/api/public_plus_experimental_current.txt
M navigation/navigation-dynamic-features-fragment/api/restricted_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-fragment/api/restricted_current.txt
M navigation/navigation-dynamic-features-fragment/src/androidTest/AndroidManifest.xml
A navigation/navigation-dynamic-features-fragment/src/androidTest/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigatorDestinationBuilderTest.kt
A navigation/navigation-dynamic-features-fragment/src/main/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigatorDestinationBuilder.kt
M navigation/navigation-dynamic-features-runtime/api/2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-runtime/api/current.txt
M navigation/navigation-dynamic-features-runtime/api/public_plus_experimental_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-runtime/api/public_plus_experimental_current.txt
M navigation/navigation-dynamic-features-runtime/api/restricted_2.3.0-alpha04.txt
M navigation/navigation-dynamic-features-runtime/api/restricted_current.txt
A navigation/navigation-dynamic-features-runtime/src/androidTest/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigatorDestinationBuilderTest.kt
M navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigator.kt
A navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigatorDestinationBuilder.kt

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

Issue 207315994