Component used: Navigation Version used: 2.8.5 Devices/Android versions reproduced on: API 34 Emulator

If this is a bug in the library, we would appreciate if you could attach:

Sample project to trigger the issue.
A screenrecord or screenshots showing the issue (if UI related).

Upgrading to Navigation 2.8.5 has caused a number of our tests to fail. We have a custom OnDestinationChangedListener. Our test navigates to some dialog and then we pop it. onDestinationChanged is called, and in 2.8.4 the prior screen's controller.currentBackStackEntry.lifecycle.currentState is RESUMED as expected.

However, on 2.8.5 the prior screen's controller.currentBackStackEntry.lifecycle.currentState is STARTED instead after performing a pop. This change results in our custom OnDestinationChangedListener not behaving as expected. You can replicate in a Robolectric test like below:

@OptIn(ExperimentalCoroutinesApi::class)
@RunWith(AndroidJUnit4::class)
class ExampleUnitTest {

    @get:Rule
    val composeRule = createComposeRule()
    private lateinit var controller: NavController

    @Before
    fun setup() {
        composeRule.setContent {
            val navController = rememberNavController().also { controller = it }
            NavHost(navController = navController, startDestination = "screen1") {
                composable("screen1") {}
                composable("screen2") {}
                dialog("dialog") {}
            }
        }
    }



    @Test
    fun `nothing tracked when lifecycle state is resumed`() = runTest {
        controller.addOnDestinationChangedListener { controller, destination, _ ->
            println("Route ${destination.route} - ${controller.currentBackStackEntry?.lifecycle?.currentState}")
        }

        controller.navigate("screen2")
        controller.navigate("dialog")
        composeRule.waitForIdle()

        controller.popBackStack()
        runCurrent()
    }

}

On 2.8.4 the output is:

Route screen1 - RESUMED
Route screen2 - STARTED
Route dialog - RESUMED
Route screen2 - RESUMED

But on 2.8.5 the output is:

Route screen1 - RESUMED
Route screen2 - STARTED
Route dialog - RESUMED
Route screen2 - STARTED

Looking at 2.8.5's change list https://developer.android.com/jetpack/androidx/releases/navigation#2.8.5 I see some fixes to uncaught exceptions related to the lifecycle so I'm not sure if this is an intentional change. I've only been able to replicate this in tests and not in a dummy app; the lifecycle state is RESUMED as in 2.8.4

Issue 387831867

Links (1)

Issue metadata