IssueTracker

Currently the combination of Hilt, SavedStateHandle and Safe args is not possible. The closest I've seen is to drop using safe args and just use magic strings. This also not ideal re dependency inversion as now you have to construct a mock SavedStateHandle for unit tests etc.

class ArticleViewModel @ViewModelInject constructor(
        private val repository: ArticleRepository,
        @Assisted savedStateHandle: SavedStateHandle
) {
    // FIXME: oops, magic "articleId" string
    private val articleId: Long = savedStateHandle["articleId"]
            ?: throw IllegalArgumentException("Article ID required")
}

I thought I needed this, but then I realized that I can just create an empty Bundle, store the Fragment's arguments in it as a Bundle (so a Bundle inside a Bundle) and use that to initialize the SavedStateHandle. Then I can just retrieve the arguments from the SavedStateHandle and use the already existing fromBundle method.

What I like about this is that I get to have immutable init arguments, as long as I store the Fragment's arguments with a key that I would never use for other entries.

With a helper function and a base ViewModel class you can hide this entire process and have ViewModels that expose the arguments object as property/member of the ViewModel itself.

Could you provide an example of how you achieve that?

What I wrote requires the ability to provide a Bundle to initialize the SavedStateHandle and currently that's not possible with Hilt. You need to wait for this to be fixed: https://github.com/google/dagger/issues/1938 (https://android-review.googlesource.com/c/platform/frameworks/support/+/1427172).

If you do not use Hilt, then what I wrote becomes straightforward. Rather than passing the Fragment's arguments directly, you provide a Bundle with the Fragment's arguments in it:

Bundle().apply { putBundle(SOME_SPECIAL_BUNDLE_KEY, arguments) }

By doing so you'll be able to do the following in your ViewModel:

val fragmentArgs = savedStateHandle[SOME_SPECIAL_BUNDLE_KEY]
val args = YouFragmentArgs.fromBundle(fragmentArgs)

You still need to use a magic key for the Bundle, but it can be a project-wide constant and you only have to pass a single argument. The initialization is also the same for all the ViewModels, so you can easily write helpers to abstract away the process.

If you are using hilt you can wrap the incoming arguments in fragment like so

open class BaseFragment : Fragment() {

    override fun setArguments(args: Bundle?) {
        if (args != null) {
            super.setArguments(Bundle(args).apply {
                putBundle(BUNDLE_ARGS, args) // Wrap the arguments as BUNDLE_ARGS
            })
        } else {
            super.setArguments(null)
        }
    }
}

and then for the view model, you can inherit from something like that

open class ArgsViewModel(private val savedStateHandle: SavedStateHandle) : ViewModel() {

    val arguments get() = savedStateHandle.get<Bundle>(BUNDLE_ARGS)

    @MainThread
    inline fun <reified Args : NavArgs> navArgs() = NavArgsLazy(Args::class) {
        arguments ?: throw IllegalStateException("ViewModel $this has null arguments")
    }
}

Hope that helps

Should be fixed by https://github.com/androidx/androidx/pull/122

Do you know when this will be released?

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

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.

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.

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

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