Improve error messaging for NavController.getBackStackEntry when no destination is found [168311416]

Fixed

Bug

Status Update

No update yet.

Description

sk...@gmail.com

created issue #1

Sep 11, 2020 10:43PM

Component used: Navigation
Version used: 2.3.0

While using `by navGraphViewModels`, my crash reporting reports an error when invoked

NavGraphViewModelLazy.kt line 56
Fatal Exception: java.lang.IllegalArgumentException: No destination with ID 2131296839 is on the NavController's back stack
at androidx.navigation.NavController.getBackStackEntry(NavController.java:1293)
at com.example.ExampleFragment$$special$$inlined$navGraphViewModels$1.invoke(NavGraphViewModelLazy.kt:56)
[...]

This is difficult to debug since the navGraphId that I pass in should theoretically always be in the NavController's back stack when navGraphViewModels is invoked. The error message could be improved by letting me know what IS available on the back stack or if the back stack is completely empty.

Comments

il...@google.com <il...@google.com> Sep 14, 2020 11:11PM

Assigned to il...@google.com.

ap...@google.com <ap...@google.com> #2Sep 15, 2020 12:14AM

Oh I forgot to mention that I thought it might be connected to this issue: https://issuetracker.google.com/issues/243778589. But after trying 2.5.2 I can say that the issue persists.

il...@google.com <il...@google.com> #3Sep 15, 2020 12:20AM

Marked as fixed.

Please provide a minimal sample project along with the minimal steps to recreate the issue in the project.

ap...@google.com <ap...@google.com> #4Sep 24, 2020 08:46AM

Sorry for the delay. I got a working example here: https://github.com/Del-S/issues. The project is set up to crash when navigating to ThirdFragment (nested nav graph) with poping the graph.

I poked into it a little bit and it seems to be connected to SafeArgs gradle plugin. When safe args is used to navigate to ThirdFragment (with nested graph poped) it will try to recreate te parent but there were no arguments passed so it crashes.

Steps to reproduce:

Navigate from Second Fragment to Child nav graph (with non-nullable parameters).
Navigate to Third fragment using SafeArgs and the app crashes.

Crash log:

Process: cz.dels.issues, PID: 1743
java.lang.NullPointerException: null cannot be cast to non-null type kotlin.Long
at androidx.navigation.NavType$Companion$LongType$1.get(NavType.kt:352)
at androidx.navigation.NavType$Companion$LongType$1.get(NavType.kt:342)
at androidx.navigation.NavArgument.verify(NavArgument.kt:76)
at androidx.navigation.NavDestination.addInDefaultArgs(NavDestination.kt:502)
at androidx.navigation.NavController.addEntryToBackStack(NavController.kt:1865)
at androidx.navigation.NavController.addEntryToBackStack$default(NavController.kt:1813)
at androidx.navigation.NavController$navigate$4.invoke(NavController.kt:1721)
at androidx.navigation.NavController$navigate$4.invoke(NavController.kt:1719)
at androidx.navigation.NavController$NavControllerNavigatorState.push(NavController.kt:287)
at androidx.navigation.fragment.FragmentNavigator.navigate(FragmentNavigator.kt:246)
at androidx.navigation.fragment.FragmentNavigator.navigate(FragmentNavigator.kt:162)
at androidx.navigation.NavController.navigateInternal(NavController.kt:260)
at androidx.navigation.NavController.navigate(NavController.kt:1719)
at androidx.navigation.NavController.navigate(NavController.kt:1545)
at androidx.navigation.NavController.navigate(NavController.kt:1472)
at androidx.navigation.NavController.navigate(NavController.kt:1930)
at cz.dels.issues.SecondFragment.onViewCreated$lambda-0(SecondFragment.kt:38)
at cz.dels.issues.SecondFragment.$r8$lambda$XDYnOS_cYrafiNQ5rcCu1WCn0IE(Unknown Source:0)
at cz.dels.issues.SecondFragment$$ExternalSyntheticLambda0.onClick(Unknown Source:2)

Note: If in step 2 SaveArgs is not used then navigation works correctly. More information is here: https://github.com/Del-S/issues/blob/master/app/src/main/java/cz/dels/issues/SecondFragment.kt#L37.

ap...@google.com <ap...@google.com> #5Sep 24, 2020 08:52AM

Ups a typo: Navigate from ~~Second~~ First Fragment to Child nav graph (with non-nullable parameters).

Note: sorry for the spam but I am not able to edit my own comment.

ap...@google.com <ap...@google.com> #6Sep 24, 2020 08:57AM

This has been fixed and will be available in navigation 2.6.0-alpha08

ap...@google.com <ap...@google.com> #7Sep 24, 2020 09:18AM

Project: platform/frameworks/support
Branch: androidx-main

commit 6b358154b794a0456b089ac8e548bfb830dd6c22
Author: Clara Fok <clarafok@google.com>
Date: Tue Mar 14 17:56:12 2023

Fix missing non-nullable arg when rebuilding hierarchy

When navigating with NavDirections, args is populated with an empty bundle. This causes issue when we rebuild parent hierarchy while adding a new entry to NavBackStack. If the Entry being rebuilt contains a non-nullalbe arg, i.e. Long, this empty bundle will cause an exception.

Test: ./gradlew navigation:navigation-runtime:cC
Bug: 249988437
Change-Id: I5c8ce739ad9a3428c8a8de13eae391bfff0db5df

M navigation/navigation-runtime/src/androidTest/java/androidx/navigation/NavControllerTest.kt
M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.kt

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

ap...@google.com <ap...@google.com> #8Sep 24, 2020 09:34AM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.navigation:navigation-runtime:2.6.0-alpha08

ap...@google.com <ap...@google.com> #9Sep 24, 2020 09:36AM

Project: platform/frameworks/support
Branch: snap-temp-L04700000699849955

commit 12b13608ec1155b5780fe44f5ab07cdc93c5ba90
Author: Ian Lake <ilake@google.com>
Date: Mon Sep 14 16:10:06 2020

Mention the current destination in getBackStackEntry errors

Improve the debugging experience for "No destination
with ID..." errors in getBackStackEntry() by mentioning
exactly destination the NavController is on. This would
allow developers to know if they have called popBackStack()
to a destination they don't expect to be at or if
they have not called setGraph() at all (where the
current destination would be null).

Test: existing tests pass
BUG: 168311416
Change-Id: Ia96b6732d7caadbddf31b7f35a1a419407ff6e25
(cherry picked from commit d0a10be065a3a629e3835f28d35804c91d8d2e4d)

M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java

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

ap...@google.com <ap...@google.com> #10Sep 24, 2020 10:08AM

Project: platform/frameworks/support
Branch: snap-temp-L69500000699869549

commit 7204d04ad74baf9816389e27778266391fbd79a5
Author: Ian Lake <ilake@google.com>
Date: Mon Sep 14 16:10:06 2020

Mention the current destination in getBackStackEntry errors

Improve the debugging experience for "No destination
with ID..." errors in getBackStackEntry() by mentioning
exactly destination the NavController is on. This would
allow developers to know if they have called popBackStack()
to a destination they don't expect to be at or if
they have not called setGraph() at all (where the
current destination would be null).

Test: existing tests pass
BUG: 168311416
Change-Id: Ia96b6732d7caadbddf31b7f35a1a419407ff6e25
(cherry picked from commit d0a10be065a3a629e3835f28d35804c91d8d2e4d)

M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java

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

ap...@google.com <ap...@google.com> #11Sep 24, 2020 10:10AM

Project: platform/frameworks/support
Branch: snap-temp-L31300000699869852

commit 398a1fe7bb7792589189574aec5f6e77bb749229
Author: Ian Lake <ilake@google.com>
Date: Mon Sep 14 16:10:06 2020

Mention the current destination in getBackStackEntry errors

Improve the debugging experience for "No destination
with ID..." errors in getBackStackEntry() by mentioning
exactly destination the NavController is on. This would
allow developers to know if they have called popBackStack()
to a destination they don't expect to be at or if
they have not called setGraph() at all (where the
current destination would be null).

Test: existing tests pass
BUG: 168311416
Change-Id: Ia96b6732d7caadbddf31b7f35a1a419407ff6e25
(cherry picked from commit d0a10be065a3a629e3835f28d35804c91d8d2e4d)

M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java

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

ap...@google.com <ap...@google.com> #12Sep 24, 2020 11:30AM

Project: platform/frameworks/support
Branch: snap-temp-L53700000699921463

commit 31027c16ff20b10e78093f8de205c81fc49dfc92
Author: Ian Lake <ilake@google.com>
Date: Mon Sep 14 16:10:06 2020

Mention the current destination in getBackStackEntry errors

Improve the debugging experience for "No destination
with ID..." errors in getBackStackEntry() by mentioning
exactly destination the NavController is on. This would
allow developers to know if they have called popBackStack()
to a destination they don't expect to be at or if
they have not called setGraph() at all (where the
current destination would be null).

Test: existing tests pass
BUG: 168311416
Change-Id: Ia96b6732d7caadbddf31b7f35a1a419407ff6e25
(cherry picked from commit d0a10be065a3a629e3835f28d35804c91d8d2e4d)

M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java

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

ap...@google.com <ap...@google.com> #13Sep 24, 2020 11:32AM

Project: platform/frameworks/support
Branch: snap-temp-L25200000699921867

commit 63e58ff4f522eb70dec6c0749679fb6b963698d8
Author: Ian Lake <ilake@google.com>
Date: Mon Sep 14 16:10:06 2020

Mention the current destination in getBackStackEntry errors

Improve the debugging experience for "No destination
with ID..." errors in getBackStackEntry() by mentioning
exactly destination the NavController is on. This would
allow developers to know if they have called popBackStack()
to a destination they don't expect to be at or if
they have not called setGraph() at all (where the
current destination would be null).

Test: existing tests pass
BUG: 168311416
Change-Id: Ia96b6732d7caadbddf31b7f35a1a419407ff6e25
(cherry picked from commit d0a10be065a3a629e3835f28d35804c91d8d2e4d)

M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java

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

ap...@google.com <ap...@google.com> #14Sep 24, 2020 11:52AM

Project: platform/frameworks/support
Branch: snap-temp-L07700000699933785

commit 56fe0d47de20fb430c4280332a20eb96076dd44b
Author: Ian Lake <ilake@google.com>
Date: Mon Sep 14 16:10:06 2020

Mention the current destination in getBackStackEntry errors

Improve the debugging experience for "No destination
with ID..." errors in getBackStackEntry() by mentioning
exactly destination the NavController is on. This would
allow developers to know if they have called popBackStack()
to a destination they don't expect to be at or if
they have not called setGraph() at all (where the
current destination would be null).

Test: existing tests pass
BUG: 168311416
Change-Id: Ia96b6732d7caadbddf31b7f35a1a419407ff6e25
(cherry picked from commit d0a10be065a3a629e3835f28d35804c91d8d2e4d)

M navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java

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

vi...@gws.hotstar.com <vi...@gws.hotstar.com> #15Jun 22, 2022 09:53AM

getting this error even after ensuring we are setting graph before using it..
Caused by java.lang.IllegalArgumentException
No destination with ID 2131427956 is on the NavController's back stack in HiltNavGraphViewModelLazy.kt:49) , we are using androidx.hilt:hilt-navigation-fragment:1.0.0

androidx.navigation.NavController.getBackStackEntry (NavController.kt:2204)
androidx.hilt.navigation.fragment.HiltNavGraphViewModelLazyKt$hiltNavGraphViewModels$backStackEntry$2.invoke (HiltNavGraphViewModelLazyKt.java:49)
$special$$inlined$hiltNavGraphViewModels$4.invoke (HiltNavGraphViewModelLazy.kt:49)

is there any way to prevent it?

al...@gmail.com <al...@gmail.com> #16Aug 11, 2022 06:53AM

Could we further improve this by indicating the name of the destination instead of just the ID number?

jb...@google.com <jb...@google.com> #17Aug 11, 2022 07:06PM

If you use a resource to provide the name it will already be displayed. Along with any route or label you may have added.

sh...@gmail.com <sh...@gmail.com> #18Dec 27, 2022 01:05PM

We are also getting this error even after ensuring we are setting the graph before using .popBackStack().

Is there any way to safeguard against this? I am not able to reproduce the error myself, but get a lot of errors show up in Crashlytics

wm...@gmail.com <wm...@gmail.com> #19Apr 6, 2023 12:59PM

I have the same problem

ze...@gmail.com <ze...@gmail.com> #20May 31, 2023 03:51PM

Same here. It is not fixed. Can you reopen and look again?

ir...@gmail.com <ir...@gmail.com> #21Nov 3, 2023 08:45PM

Same problem here

ji...@gmail.com <ji...@gmail.com> #22Dec 1, 2023 02:53AM

Same problem here

ru...@gmail.com <ru...@gmail.com> #23Feb 10, 2024 04:33PM

Same problem here

fa...@fob-solutions.com <fa...@fob-solutions.com> #24Feb 22, 2024 04:15PM

Same problem here, currently using version 2.7.7

ev...@gmail.com <ev...@gmail.com> #25Feb 12, 2025 02:54PM

same problem here

Issue 168311416

Description

Issue summary

Comments

il...@google.com <il...@google.com> Sep 14, 2020 11:11PM

ap...@google.com <ap...@google.com> #2Sep 15, 2020 12:14AM

il...@google.com <il...@google.com> #3Sep 15, 2020 12:20AM

ap...@google.com <ap...@google.com> #4Sep 24, 2020 08:46AM

ap...@google.com <ap...@google.com> #5Sep 24, 2020 08:52AM

ap...@google.com <ap...@google.com> #6Sep 24, 2020 08:57AM

ap...@google.com <ap...@google.com> #7Sep 24, 2020 09:18AM

ap...@google.com <ap...@google.com> #8Sep 24, 2020 09:34AM

ap...@google.com <ap...@google.com> #9Sep 24, 2020 09:36AM

ap...@google.com <ap...@google.com> #10Sep 24, 2020 10:08AM

ap...@google.com <ap...@google.com> #11Sep 24, 2020 10:10AM

ap...@google.com <ap...@google.com> #12Sep 24, 2020 11:30AM

ap...@google.com <ap...@google.com> #13Sep 24, 2020 11:32AM

ap...@google.com <ap...@google.com> #14Sep 24, 2020 11:52AM

vi...@gws.hotstar.com <vi...@gws.hotstar.com> #15Jun 22, 2022 09:53AM

al...@gmail.com <al...@gmail.com> #16Aug 11, 2022 06:53AM

jb...@google.com <jb...@google.com> #17Aug 11, 2022 07:06PM

sh...@gmail.com <sh...@gmail.com> #18Dec 27, 2022 01:05PM

wm...@gmail.com <wm...@gmail.com> #19Apr 6, 2023 12:59PM

ze...@gmail.com <ze...@gmail.com> #20May 31, 2023 03:51PM

ir...@gmail.com <ir...@gmail.com> #21Nov 3, 2023 08:45PM

ji...@gmail.com <ji...@gmail.com> #22Dec 1, 2023 02:53AM

ru...@gmail.com <ru...@gmail.com> #23Feb 10, 2024 04:33PM

fa...@fob-solutions.com <fa...@fob-solutions.com> #24Feb 22, 2024 04:15PM

ev...@gmail.com <ev...@gmail.com> #25Feb 12, 2025 02:54PM

Add comment

Issue metadata