Safe Args fromBundle() doesn't handle a null Bundle when there are no required arguments [128531879]

Fixed

Bug

Status Update

No update yet.

Description

il...@google.com

created issue #1

Mar 13, 2019 08:07PM

Component used: Navigation
Version used: 1.0.0-rc02

When using a Fragment such as:

<fragment>
...
<argument
android:name="myArg"
app:argType="string"
app:nullable="true"
android:defaultValue="@null"/>
</fragment>

The defaultValue="@null" causes that attribute to be dropped by the NavInflater (due to now XmlPullParser works), meaning the resulting arguments Bundle can be null as there is no way to distinguish between no default value being set and a null default value being set.

Unfortunately, even in the case where no arguments are required, Safe Args' fromBundle() and, by extension, the by navArgs(), require a non-null Bundle.

fromBundle() should only throw on a null Bundle if there are required values.

Comments

il...@google.com <il...@google.com> #2Mar 15, 2019 07:25PM

As a workaround, your Fragment can set the arguments to an empty Bundle if it is null:

if (arguments == null) {
arguments = Bundle()
}
// Assuming myArgs is set via by navArgs()
val myArg = myArgs.myArg

il...@google.com <il...@google.com> Mar 15, 2019 08:44PM

Accepted by il...@google.com.

ap...@google.com <ap...@google.com> #3Mar 15, 2019 11:26PM

Marked as fixed.

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

commit d8c9982a9cac54247134252eea8d8a4cbf757e74
Author: Ian Lake <ilake@google.com>
Date: Fri Mar 15 13:21:12 2019

Avoid sending a null Bundle when NavArguments are present

When using arguments with android:defaultValue="@null",
these attributes are dropped by XmlPullParser, so the
NavArgument does not have a default value set. Change
addInDefaultArgs() to always return a non-null Bundle
if there are NavArguments set at all to ensure that
Safe Args can correctly parse the empty Bundle and
fill in the correct default values.

This also simplifies the process if you're not using
Safe Args since you can requireArguments() and the
proper gets with your default values.

Test: new AddInDefaultArgsTest parameterized test
Fixes: 128531879
Change-Id: I6ec9673100790df03b5aa1d86f74dbec70173095

A navigation/common/src/androidTest/java/androidx/navigation/AddInDefaultArgsTest.kt
M navigation/common/src/main/java/androidx/navigation/NavDestination.java

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

https://goto.google.com/android-sha1/d8c9982a9cac54247134252eea8d8a4cbf757e74

il...@google.com <il...@google.com> #4Mar 16, 2019 12:46AM

We've fixed this for Navigation 2.1.0-alpha01 at the library level, rather than only in Safe Args. Destinations with any argument will have a non-null Bundle.

zv...@gmail.com <zv...@gmail.com> #5Apr 30, 2019 10:13AM

I'm still getting the error with "androidx.navigation:navigation-safe-args-gradle-plugin:2.1.0-alpha02"

<argument
android:name="filter"
android:defaultValue="@null"
app:nullable="true"
app:argType="***.ConsultationsFilter"
/>
---------
class TestFragment : androidx.fragment.app.Fragment() {
private val args by navArgs<TestFragment>()
...
override fun onCreateView(
inflater: LayoutInflater, container: ViewGroup?,
savedInstanceState: Bundle?
): View? {
....
val filter = args.filter // <-- throws null argument exception
}

zv...@gmail.com <zv...@gmail.com> #6Apr 30, 2019 10:15AM

upd line: private val args by navArgs<TestFragmentArg>()

il...@google.com <il...@google.com> #7May 4, 2019 12:00AM

Re #5/6 - please file a new bug with a sample project that reproduces your issue.

[Deleted User] <[Deleted User]> #8Apr 5, 2022 09:23AM

i am facing null bundle exception while using nav graph arguments even i have set the default arguments in
nav graph and also check null in code
here is my sample code of Kotlin
private val args : BottomSheetCartFragmentArgs? by navArgs()
arg?.let {
product = it.product
isFromCart = it.isFromCart
screenName = it.screenName

}

Nav graph arguments

<argument
android:name="product"
app:argType="com.dawaai.dawaaidukaan.model.Product"
/>

<argument
android:name="isFromCart"
android:defaultValue="false"
app:argType="boolean"
/>
<argument
android:name="screenName"
app:argType="string"
android:defaultValue="recreate_order"/>

jb...@google.com <jb...@google.com> #9Apr 5, 2022 03:14PM

Re #8 - please file a new bug with a sample project that reproduces your issue.

cr...@gmail.com <cr...@gmail.com> #10Dec 3, 2022 04:31PM

Hi I'm facing a similar issue.
My OrdersFragment has one nullable argument called Option:

<argument
android:name="option"
app:argType="string"
app:nullable="true" />

private val args : OrdersFragmentArgs? by navArgs()

And inside the onViewCreated of this fragment I have:

args?.let {

if(it.option.equals("Completada")){
getCompletedOrders()
}else if (it.option.equals("Cancelada")){
getCanceledOrders()
}
}

Then when I compile the app and I went to the ordesFragment the app got crash:

E/AndroidRuntime: FATAL EXCEPTION: main
Process: com.example.elrestaurante, PID: 3388
java.lang.RuntimeException: java.lang.reflect.InvocationTargetException
at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:581)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1135)
Caused by: java.lang.reflect.InvocationTargetException
at java.lang.reflect.Method.invoke(Native Method)
at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:571)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1135)
Caused by: java.lang.reflect.InvocationTargetException
at java.lang.reflect.Method.invoke(Native Method)
at androidx.navigation.NavArgsLazy.getValue(NavArgsLazy.kt:54)
at androidx.navigation.NavArgsLazy.getValue(NavArgsLazy.kt:35)
at com.example.elrestaurante.ui.orders.OrdersFragment.getArgs(OrdersFragment.kt:62)
at com.example.elrestaurante.ui.orders.OrdersFragment.onViewCreated(OrdersFragment.kt:83)
at androidx.fragment.app.Fragment.performViewCreated(Fragment.java:3128)
at androidx.fragment.app.FragmentStateManager.createView(FragmentStateManager.java:552)
at androidx.fragment.app.FragmentStateManager.moveToExpectedState(FragmentStateManager.java:261)
at androidx.fragment.app.FragmentManager.executeOpsTogether(FragmentManager.java:1890)
at androidx.fragment.app.FragmentManager.removeRedundantOperationsAndExecute(FragmentManager.java:1814)
at androidx.fragment.app.FragmentManager.execPendingActions(FragmentManager.java:1751)
at androidx.fragment.app.FragmentManager$5.run(FragmentManager.java:538)
at android.os.Handler.handleCallback(Handler.java:938)
at android.os.Handler.dispatchMessage(Handler.java:99)
at android.os.Looper.loopOnce(Looper.java:226)
at android.os.Looper.loop(Looper.java:313)
at android.app.ActivityThread.main(ActivityThread.java:8669)
at java.lang.reflect.Method.invoke(Native Method)
at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:571)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1135)
Caused by: java.lang.IllegalArgumentException: Required argument "option" is missing and does not have an android:defaultValue
at com.example.elrestaurante.ui.orders.OrdersFragmentArgs.fromBundle(OrdersFragmentArgs.java:36)
at java.lang.reflect.Method.invoke(Native Method)
at androidx.navigation.NavArgsLazy.getValue(NavArgsLazy.kt:54)
at androidx.navigation.NavArgsLazy.getValue(NavArgsLazy.kt:35)
at com.example.elrestaurante.ui.orders.OrdersFragment.getArgs(OrdersFragment.kt:62)
at com.example.elrestaurante.ui.orders.OrdersFragment.onViewCreated(OrdersFragment.kt:83)
at androidx.fragment.app.Fragment.performViewCreated(Fragment.java:3128)
at androidx.fragment.app.FragmentStateManager.createView(FragmentStateManager.java:552)
at androidx.fragment.app.FragmentStateManager.moveToExpectedState(FragmentStateManager.java:261)
at androidx.fragment.app.FragmentManager.executeOpsTogether(FragmentManager.java:1890)
at androidx.fragment.app.FragmentManager.removeRedundantOperationsAndExecute(FragmentManager.java:1814)
at androidx.fragment.app.FragmentManager.execPendingActions(FragmentManager.java:1751)
at androidx.fragment.app.FragmentManager$5.run(FragmentManager.java:538)
at android.os.Handler.handleCallback(Handler.java:938)
at android.os.Handler.dispatchMessage(Handler.java:99)
at android.os.Looper.loopOnce(Looper.java:226)
at android.os.Looper.loop(Looper.java:313)
at android.app.ActivityThread.main(ActivityThread.java:8669)
at java.lang.reflect.Method.invoke(Native Method)
at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:571)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:1135)
I/Process: Sending signal. PID: 3388 SIG: 9