SavedStateHandle keys() method is inconsistent when using setSavedStateProvider() [174713653]

Fixed

Bug

Status Update

No update yet.

Description

er...@google.com

created issue #1

Dec 3, 2020 02:27AM

The keys() method in SavedStateHandle will always include keys for values set via the set() method, but it doesn't include the keys associated with a SavedStateProvider set via setSavedStateProvider() until after state is saved. If you wanted to remove all of the SavedStateProviders by iterating through the keys, whether it would work or not would depend on if state was already saved, which is kind of inconsistent and seems like a bug.

Comments

se...@google.com <se...@google.com> #2Dec 3, 2020 11:11AM

yeah, looks like a bug.

se...@google.com <se...@google.com> #3Dec 3, 2020 02:45PM

I look closer and now I'm not sure what is the best behavior. Currently keys() does what javadoc says "all keys contained in this SavedStateHandle". Technically, before first onSaveInstanceState keys corresponding to SavedStateProviders aren't in the SavedStateHandle. However I can see, that SavedStateProvide is kinda promise that value will be in the SavedStateHandle in future.

I think we can do smth like:

fun keys() = mRegular.keySet() + mSavedStateProviders.keySet()

Ian, what do you think?

il...@google.com <il...@google.com> #4Dec 3, 2020 05:21PM

Yes, I think having keys() return the combined set as recommended in comment#3 makes a lot of sense and ensures that the set of keys is the same both before and after the state is actually saved.

ap...@google.com <ap...@google.com> #5Dec 7, 2020 06:35PM

Marked as fixed.

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

commit da54c9d83ca533316fa95591a59b33eb2903a1e6
Author: Sergey Vasilinets <sergeyv@google.com>
Date: Fri Dec 04 16:39:50 2020

SavedStateHandle#keys() now returns keys of Providers and LiveData-s

Fixes: 174713653
Test: improved SavedStateHandleTest#testKeySet
Change-Id: Ib586038aabe6601cd95e0d74af67f031439cf6ee

M lifecycle/lifecycle-viewmodel-savedstate/src/androidTest/java/androidx/lifecycle/viewmodel/savedstate/SavedStateHandleTest.kt
M lifecycle/lifecycle-viewmodel-savedstate/src/main/java/androidx/lifecycle/SavedStateHandle.java

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

Issue 174713653

Description

Issue summary

Comments

se...@google.com <se...@google.com> #2Dec 3, 2020 11:11AM

se...@google.com <se...@google.com> #3Dec 3, 2020 02:45PM

il...@google.com <il...@google.com> #4Dec 3, 2020 05:21PM

ap...@google.com <ap...@google.com> #5Dec 7, 2020 06:35PM

Add comment

Issue metadata