using Android Jetpack Navigation "by navGraphViewModels" API causes crash when you enable the option of "dont keep activity" [213504272]

Fixed

Bug

Status Update

No update yet.

Description

ch...@gmail.com

created issue #1

Jan 7, 2022 07:27AM

I have two Activities, MainActivity and SecondActivity. Using Navigation architecture in MainActivity, which has two fragments, such as HomeFragment and DetailFragment, the Navigation diagram is declared as follows:

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/navigation_home_flow"
    app:startDestination="@id/home_root_fragment">

    <fragment
        android:id="@id/home_root_fragment"
        android:name=".home.HomeFragment"
        android:label="HomeFragment">

    </fragment>

    <fragment
        android:id="@id/detail_fragment"
        android:name=".home.DetailFragment"
        android:label="DetailFragment">
    </fragment>
    
</navigation>

Generate ViewModels in the DetailFragment onCreate with "by navGraphViewModels".

class BaseImmerseFragment : BaseFragment() {

    companion object {
        const val TAG = "DetailFragment"
    }

    val vm by navGraphViewModels<ViewModel>(R.id.navigation_home_flow)


    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        //init vm
        LogUtils.d(TAG, "init $vm")
    }
}

There is a button in DetailFragment, clicking it will jump to SecondActivity, when "Do not keep background Activity" is enabled, pressing the back button in SecondActivity will trigger the program crash：

Process: xxxxx, PID: 24236
java.lang.RuntimeException: Unable to start activity ComponentInfo{xxxxxx/xxxx.MainActivity}: java.lang.IllegalStateException: You cannot access the NavBackStackEntry's ViewModels until it is added to the NavController's back stack (i.e., the Lifecycle of the NavBackStackEntry reaches the CREATED state).
    at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3739)
    at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3892)
    at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:83)
    at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
    at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
    at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2267)
    at com.didichuxing.doraemonkit.kit.timecounter.instrumentation.ProxyHandlerCallback.handleMessage(ProxyHandlerCallback.java:44)
    at android.os.Handler.dispatchMessage(Handler.java:103)
    at android.os.Looper.loop(Looper.java:217)
    at android.app.ActivityThread.main(ActivityThread.java:7993)
    at java.lang.reflect.Method.invoke(Native Method)
    at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:502)
    at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:955)
 Caused by: java.lang.IllegalStateException: You cannot access the NavBackStackEntry's ViewModels until it is added to the NavController's back stack (i.e., the Lifecycle of the NavBackStackEntry reaches the CREATED state).
    at androidx.navigation.NavBackStackEntry.getViewModelStore(NavBackStackEntry.kt:174)
    at xxxxx.DetailFragment$special$$inlined$navGraphViewModels$default$2.invoke(NavGraphViewModelLazy.kt:59)
    at xxxxx.DetailFragment$special$$inlined$navGraphViewModels$default$2.invoke(NavGraphViewModelLazy.kt:58)
    at androidx.lifecycle.ViewModelLazy.getValue(ViewModelProvider.kt:53)
    at androidx.lifecycle.ViewModelLazy.getValue(ViewModelProvider.kt:41)
    at xxxxx.DetailFragment.getVm(DetailFragment.kt:50)
    at xxxxx.DetailFragment.onCreate(DetailFragment.kt:102)
    at androidx.fragment.app.Fragment.performCreate(Fragment.java:2947)
    at androidx.fragment.app.FragmentStateManager.create(FragmentStateManager.java:455)
    at androidx.fragment.app.FragmentStateManager.moveToExpectedState(FragmentStateManager.java:255)
    at androidx.fragment.app.FragmentStore.moveToExpectedState(FragmentStore.java:113)
    at androidx.fragment.app.FragmentManager.moveToState(FragmentManager.java:1331)
    at androidx.fragment.app.FragmentManager.dispatchStateChange(FragmentManager.java:2772)

If I put the vm creation declaration in the onViewCreated lifecycle or later, there will be no crashes.

Does "by navGraphViewModels" necessarily require the user to use it this way?

In my opinion, as long as the NavBackStackEntry viewModelStore corresponding to "R.id.navigation_home_flow" is in the CREATED state, it's OK, not the DetailFragment.

The Navigation version I use is 2.4.0-alpha06.

Thanks in advance if you can address my issue.

Comments

il...@google.com <il...@google.com> #2Jan 7, 2022 07:18PM

Actually sorry, it may be possible to create a sample project which could replicate this issue. If needed then please let me know.

ch...@gmail.com <ch...@gmail.com> #3Jan 10, 2022 04:02AM

Thank you for reporting this issue. For us to further investigate this issue, please provide the following additional information:

Sample application to reproduce the issue.

Android build
Which Android build are you using? (e.g. KVT49L)

Steps to reproduce
What steps do others need to take in order to reproduce the issue themselves?

Frequency
How frequently does this issue occur? (e.g 100% of the time, 10% of the time)

Android bug report
After reproducing the issue, press the volume up, volume down, and power button simultaneously. This will capture a bug report on your device in the “bug reports” directory. Attach the bug report file to this issue.

Alternate method:
After reproducing the issue, navigate to developer settings, ensure ‘USB debugging’ is enabled, then enable ‘Bug report shortcut’. To take bug report, hold the power button and select the ‘Take bug report’ option.

Please upload the files to Google Drive and share the folder to android-bugreport@google.com, then share the link here.

il...@google.com <il...@google.com> #4Jan 11, 2022 12:42AM

Assigned to il...@google.com.

After further debugging, the issue is called by calling notifyItemChanged() with a negative argument. Shouldn't there perhaps be a range check in that method?

ch...@gmail.com <ch...@gmail.com> #5Jan 14, 2022 02:57AM

For us to further check this case and find the possible root cause, we would need details as requested in

comment #3

ap...@google.com <ap...@google.com> #6Jan 20, 2022 12:50AM

Unfortunately we do not have enough actionable information to proceed further on this issue. Kindly share the requested details and raise a new bug in case issue is seen in future.

il...@google.com <il...@google.com> #7Jan 20, 2022 12:51AM

Marked as fixed.

Would it be possible to reopen this issue? I believe I've found the same thing although in my case the index is off the end of the array. I've created a sample application which reproduces the issue:

https://drive.google.com/file/d/1AB-Gl_hfkO9SBTYIiLJ1tMjQcMeB7ttl/view?usp=sharing

NOTE: The device resolution is important because the number of elements visible and the number of elements added to the RecyclerView is specific. Please run this on an emulator of 1080x1920 (confirmed on Pixel API 27 and Nexus 5 API 25).

Repro steps:
1. Create an emulator with 1080x1920.
2. Launch the StaggeredBug sample on the emulator.
3. Click the button at the bottom of the view.

Callstack:
java.lang.ArrayIndexOutOfBoundsException: Array index out of range: 13
at java.util.Arrays.rangeCheck(Arrays.java:1598)
at java.util.Arrays.fill(Arrays.java:2928)
at androidx.recyclerview.widget.StaggeredGridLayoutManager$LazySpanLookup.invalidateAfter(StaggeredGridLayoutManager.java:2878)
at androidx.recyclerview.widget.StaggeredGridLayoutManager.handleUpdate(StaggeredGridLayoutManager.java:1550)
at androidx.recyclerview.widget.StaggeredGridLayoutManager.onItemsUpdated(StaggeredGridLayoutManager.java:1526)
at androidx.recyclerview.widget.RecyclerView$6.dispatchUpdate(RecyclerView.java:1016)
at androidx.recyclerview.widget.RecyclerView$6.onDispatchSecondPass(RecyclerView.java:1027)
at androidx.recyclerview.widget.AdapterHelper.consumePostponedUpdates(AdapterHelper.java:121)
at androidx.recyclerview.widget.AdapterHelper.consumeUpdatesInOnePass(AdapterHelper.java:557)
at androidx.recyclerview.widget.RecyclerView.dispatchLayoutStep2(RecyclerView.java:3918)
at androidx.recyclerview.widget.RecyclerView.dispatchLayout(RecyclerView.java:3641)
at androidx.recyclerview.widget.RecyclerView.onLayout(RecyclerView.java:4194)
at android.view.View.layout(View.java:17637)
at android.view.ViewGroup.layout(ViewGroup.java:5575)
at android.widget.LinearLayout.setChildFrame(LinearLayout.java:1741)
at android.widget.LinearLayout.layoutVertical(LinearLayout.java:1585)
at android.widget.LinearLayout.onLayout(LinearLayout.java:1494)
at android.view.View.layout(View.java:17637)
at android.view.ViewGroup.layout(ViewGroup.java:5575)
at android.widget.FrameLayout.layoutChildren(FrameLayout.java:323)
at android.widget.FrameLayout.onLayout(FrameLayout.java:261)
at android.view.View.layout(View.java:17637)
at android.view.ViewGroup.layout(ViewGroup.java:5575)
at androidx.appcompat.widget.ActionBarOverlayLayout.onLayout(ActionBarOverlayLayout.java:444)
at android.view.View.layout(View.java:17637)
at android.view.ViewGroup.layout(ViewGroup.java:5575)
at android.widget.FrameLayout.layoutChildren(FrameLayout.java:323)
at android.widget.FrameLayout.onLayout(FrameLayout.java:261)
at android.view.View.layout(View.java:17637)
at android.view.ViewGroup.layout(ViewGroup.java:5575)
at android.widget.LinearLayout.setChildFrame(LinearLayout.java:1741)
at android.widget.LinearLayout.layoutVertical(LinearLayout.java:1585)
at android.widget.LinearLayout.onLayout(LinearLayout.java:1494)
at android.view.View.layout(View.java:17637)
at android.view.ViewGroup.layout(ViewGroup.java:5575)
at android.widget.FrameLayout.layoutChildren(FrameLayout.java:323)
at android.widget.FrameLayout.onLayout(FrameLayout.java:261)
at com.android.internal.policy.DecorView.onLayout(DecorView.java:726)
at android.view.View.layout(View.java:17637)
at android.view.ViewGroup.layout(ViewGroup.java:5575)
at android.view.ViewRootImpl.performLayout(ViewRootImpl.java:2346)
at android.view.ViewRootImpl.performTraversals(ViewRootImpl.java:2068)
at android.view.ViewRootImpl.doTraversal(ViewRootImpl.java:1254)
at android.view.ViewRootImpl$TraversalRunnable.run(ViewRootImpl.java:6337)
at android.view.Choreographer$CallbackRecord.run(Choreographer.java:874)
at android.view.Choreographer.doCallbacks(Choreographer.java:686)
at android.view.Choreographer.doFrame(Choreographer.java:621)
at android.view.Choreographer$FrameDisplayEventReceiver.run(Choreographer.java:860)
at android.os.Handler.handleCallback(Handler.java:751)
at android.os.Handler.dispatchMessage(Handler.java:95)
at android.os.Looper.loop(Looper.java:154)
at android.app.ActivityThread.main(ActivityThread.java:6119)
at java.lang.reflect.Method.invoke(Native Method)
at com.android.internal.os.ZygoteInit$MethodAndArgsCaller.run(ZygoteInit.java:886)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:776)
Application terminated.

It seems like the call to ensureSize(positionStart + itemCount) in offsetForAddition isn't correct; maybe something like ensureSize(mFullSpanItems.size() + itemCount)?

Thanks,
Tim

https://drive.google.com/file/d/1AB-Gl_hfkO9SBTYIiLJ1tMjQcMeB7ttl/view?usp=drive_web (StaggeredBug.tgz)

Issue 213504272