Support fromSavedStateHandle in SafeArgs [136967621]

Fixed

Feature Request

androidx-bug-bounty

Status Update

No update yet.

Description

jo...@gmail.com

created issue #1

Jul 8, 2019 06:35PM

Components used:
androidx.navigation:navigation-safe-args-gradle-plugin:2.0.0
androidx.lifecycle:lifecycle-viewmodel-savedstate:1.0.0-alpha02

Allow SafeArgs to be created `fromSavedStateHandle` as one would from a bundle.

Comments

il...@google.com <il...@google.com> #2Jul 8, 2019 10:01PM

Navigation is built with Support Library Fragments so has no access to the FragmentFactory itself. I think we can make some minor changes to FragmentNavigator to make it easy for developers who are using Navigation 1.0 and Fragments 1.1.0 together to call through to their FragmentFactory.

Once Navigation switches to AndroidX (post 1.0), we'll use FragmentFactory directly.

jo...@gmail.com <jo...@gmail.com> #3Jul 9, 2019 04:32PM

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

commit 1b215f0d93828286782776b9a12d2387097947f9
Author: Ian Lake <ilake@google.com>
Date: Sun Nov 25 21:45:56 2018

Move Fragment creation to FragmentNavigator

Provide an instantiateFragment() method on
FragmentNavigator which serves as the
centralized place to instantiate new
Fragment instances for FragmentNavigator.

Besides moving this business logic out of
the dumb POJO FragmentNavigator.Destination,
this also provides a future extension point
for integrating in FragmentFactory.

Test: existing tests passes, testapp still works
BUG: 119054429
Change-Id: If60471a704ef77bc35b30838e152a31cde8bc235

M navigation/fragment/ktx/src/androidTest/java/androidx/navigation/fragment/FragmentNavigatorDestinationBuilderTest.kt
M navigation/fragment/ktx/src/main/java/androidx/navigation/fragment/FragmentNavigatorDestinationBuilder.kt
M navigation/fragment/src/androidTest/java/androidx/navigation/fragment/FragmentNavigatorTest.kt
M navigation/fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.java

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

https://goto.google.com/android-sha1/1b215f0d93828286782776b9a12d2387097947f9

ka...@gmail.com <ka...@gmail.com> #4Jul 7, 2020 07:00AM

Navigation still depends on Support Library and not AndroidX, so we can't directly use FragmentFactory in FragmentNavigator.

However, in alpha08, you'll be able to subclass FragmentNavigator and override instantiateFragment(), calling into FragmentFactory if you're using AndroidX Fragment 1.1.0+. You'd also need to subclass NavHostFragment and override createFragmentNavigator() to return your custom FragmentNavigator subclass (or, if you're not using app:navGraph, you can set it via navHostFragment.navController.navigatorProvider += YourFragmentNavigator(context, navHostFragment.childFragmentManager)).

We'll keep this open until Navigation has moved to AndroidX and can directly use FragmentFactory as its default implementation of instantiateFragment().

[Deleted User] <[Deleted User]> #5Jul 22, 2020 07:06PM

Thanks for the workaround in alpha08!

g....@gmail.com <g....@gmail.com> #6Sep 27, 2020 08:21AM

Can't wait to use this library after the move to AndroidX.
For us is a major blocking feature and we don't want to proceed overriding all the necessary classes.

Thank you Ian and the rest of the navigation team.

ka...@gmail.com <ka...@gmail.com> #7Oct 11, 2020 09:49AM

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

commit 74c3760e428648d00249dc1d38865b7802f48a9a
Author: Ian Lake <ilake@google.com>
Date: Wed Mar 13 13:11:57 2019

Use FragmentFactory in FragmentNavigator

Rely on the FragmentManager's FragmentFactory
to instantiate Fragments created for
FragmentNavigator.

Test: new FragmentNavigatorTest
Fixes: 119054429
Change-Id: Icbeb2771e29cafdc52e4c4ea770ce89f739921d1

M navigation/fragment/src/androidTest/java/androidx/navigation/fragment/FragmentNavigatorTest.kt
M navigation/fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.java

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

https://goto.google.com/android-sha1/74c3760e428648d00249dc1d38865b7802f48a9a

g....@gmail.com <g....@gmail.com> #8Oct 11, 2020 11:38AM

This is fixed internally - FragmentNavigator will use the FragmentFactory to create Fragments in the upcoming 2.1.0-alpha01 release.

al...@linguistica360.com <al...@linguistica360.com> #9Nov 12, 2020 11:39PM

Thank you Ian :)

si...@gmail.com <si...@gmail.com> #10Mar 2, 2021 07:28PM

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

commit 3dd6d1fcdb3ffa7d4bd265a023f0ac7c94e14d19
Author: Ian Lake <ilake@google.com>
Date: Mon Mar 18 09:36:37 2019

Deprecate FragmentNavigator.instantiateFragment

Instead of providing a custom subclass of
FragmentNavigator, instantiation of Fragments
should be controlled by setting a custom
FragmentFactory, which is the default behavior
of instantiateFragment() now.

By deprecating the class, we ensure that
developers who were overriding this method
are informed of the changes and can change
their code to use FragmentFactory.

Test: ./gradlew checkApi
BUG: 119054429
Change-Id: Iff46919face98baa6dc62835ca3fc105d987d141

M navigation/fragment/api/2.1.0-alpha01.txt
M navigation/fragment/api/current.txt
M navigation/fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.java

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

https://goto.google.com/android-sha1/3dd6d1fcdb3ffa7d4bd265a023f0ac7c94e14d19

il...@google.com <il...@google.com> Mar 2, 2021 08:08PM

Marked as fixed, reassigned to jb...@google.com.

al...@linguistica360.com <al...@linguistica360.com> #11Mar 3, 2021 10:24PM

Do you know when this will be released?

il...@google.com <il...@google.com> #12Mar 3, 2021 10:27PM

Re #11 - The public hotlist listed at the top of this bug says "androidx-navigation-2.4.0-alpha01" - that's the expected release.

ho...@gmail.com <ho...@gmail.com> #13May 31, 2021 10:31AM

It seems this has been included in the 2.4.0-alpha01 release.

But is there any additional setup required besides updating the navigation dependencies? With the following dependencies on my project

object Navigation {
    private const val version = "2.4.0-alpha01"
    const val compose = "androidx.navigation:navigation-compose:$version"
    const val fragment = "androidx.navigation:navigation-fragment-ktx:$version"
    const val safeArgsPlugin = "androidx.navigation:navigation-safe-args-gradle-plugin:$version"
    const val ui = "androidx.navigation:navigation-ui-ktx:$version"
}

my safeargs don't generate fromSavedStateHandle().

fromBundle() is still the only auto-complete suggestion.

FooFragmentArgs.fromSavedStateHandle(savedStateHandle) is an unresolved reference in my ViewModel.

ok...@gmail.com <ok...@gmail.com> #14Jun 1, 2021 11:38AM

I agree with the previous comment. FooFragmentArgs.fromSavedStateHandle(savedStateHandle) is unresolved reference in my ViewModel too. When I checked on generated FooFragmentArgs class, fromSavedStateHandle function is there but Android Studio can't find that reference. Code compiles successfully.

Android Studio : 4.2.1
com.android.tools.build:gradle:4.2.1
androidx.navigation:navigation-safe-args-gradle-plugin:2.4.0-alpha01

Is there any thing we can do about this?

il...@google.com <il...@google.com> #15Jun 1, 2021 05:02PM

Re #13, #14 - please upgrade to the latest version of Android Studio and file a bug against Android Studio if you are still not seeing this method in the Studio generated light classes.

ho...@gmail.com <ho...@gmail.com> #16Jun 3, 2021 09:07AM

I'm using Arctic Fox | 2020.3.1 Canary 9. I've just updated Navigation to 2.4.0-alpha02 and still seeing the bug, so I've filed a bug against AS. https://issuetracker.google.com/issues/189966590

ho...@gmail.com <ho...@gmail.com> #17Jun 4, 2021 07:15AM

As mentioned in the linked issue, manually downloading the latest version of Android Studio Preview fixes the issue