ViewModel onCleared not called in Compose Navigation when Screen is rotated while navigation Back [298164648]

Fixed

Bug

Status Update

No update yet.

Description

to...@chefkoch.de

created issue #1

Aug 30, 2023 12:53PM

Component used: Navigation

Version used:

navigation-compose:2.7.1
hilt-navigation-compose:1.0.0
compose 1.5.0

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

Sample project to trigger the issue -> https://github.com/TobyEb/NavigationOrientationChange

Issue:

Hi, I just encountered a weird behaviour which can be reproduced every time. My setup looks like this, Single Activity with Compose Navigation, some screens are locked to portrait orientation, some can be used in every orientation, e.g. to display images or videos.

Orientation is set like this while navigating:

class DestinationChangedListenerForOrientation : NavController.OnDestinationChangedListener {
        @SuppressLint("SourceLockedOrientationActivity")
        override fun onDestinationChanged(controller: NavController, destination: NavDestination, arguments: Bundle?) {
            requestedOrientation = if (destination.route == Screens.screenB) {
                ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED
            } else {
                ActivityInfo.SCREEN_ORIENTATION_PORTRAIT
            }
        }
    }

ScreenA is locked to portrait, ScreenB can be used in every orientation. If ScreenB is used in landscape mode, while navigating back an orientation change is requested which leads to activity recreation. I think because of the activity recreation ScreenBViewModel.onCleared is not called...

How to reproduce?

Start App
Navigate to ScreenB
Rotate your device to Landscape
Navigate back
Screen orientation changes and ScreenA is visible, ScreenBViewModel.onCleared is not called

You can just search the logs for "ScreenBViewModel", an info gets logged for init and onCleared of ScreenBViewModel. If ScreenB doesn't change its orientation onCleared is called as expected.

Expected behaviour:

For step 5 ScreenBViewModel.onCleared is called

Do you have any recommendations for a temporary workaround or any suggestions how orientation changes can be forced without losing the onCleared call?

Let me know if you need more info.

Best regards ✌️

Comments

il...@google.com <il...@google.com> Aug 30, 2023 04:58PM

Assigned to cl...@google.com.

cl...@google.com <cl...@google.com> #2Oct 6, 2023 02:09AM

A couple of questions:

1. Have you saw crash in real device or only in simulators?
2. Do you use dynamic feature for language ID?

ap...@google.com <ap...@google.com> #3Oct 10, 2023 11:04PM

Tested on Android 12 Emulator with custom executor, but cannot repro this issue.

cl...@google.com <cl...@google.com> #4Oct 10, 2023 11:05PM

Marked as fixed.

Second crash in the description is from a real device. Experienced it myself on two different Xiaomi phones, plus lots of crashes from users in the Google Play console.
Dynamic features are not used in the application.

As a wild guess, I have downgraded build tools from 31.0.0 to 30.0.3, compileSdk from 31 to 30, and moved all work with Language ID to the service in a separate process (just to be sure that crash can kill secondary process instead of main). This combination is in beta for 2 days by now and I don't see any SIGSEGV crashes.

na...@google.com <na...@google.com> #5Nov 1, 2023 05:20PM

Hmm, I feel the crash might be something related to separate/secondary process.

I also changed compileSdk and targetSDK to 31 but still cannot repro this issue.

na...@google.com <na...@google.com> #6Jan 24, 2024 07:53PM

On the contrary, there was no separate process before, when crashes started.

In the new build (with the aforementioned changes) I can see SIGSEGV crash, but only one instead of dozens and it has a bit different backtrace:

signal 11 (SIGSEGV), code 1 (SEGV_MAPERR)
liblanguage_id_jni.so (offset 0x11e000)

backtrace:
  #00  pc 000000000003c7c0  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/split_config.arm64_v8a.apk!lib/arm64-v8a/liblanguage_id_jni.so (offset 0x11e000)
  #00  pc 000000000003b960  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/split_config.arm64_v8a.apk!lib/arm64-v8a/liblanguage_id_jni.so (offset 0x11e000)
  #00  pc 000000000003bb48  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/split_config.arm64_v8a.apk!lib/arm64-v8a/liblanguage_id_jni.so (offset 0x11e000)
  #00  pc 000000000003bafc  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/split_config.arm64_v8a.apk!lib/arm64-v8a/liblanguage_id_jni.so (offset 0x11e000)
  #00  pc 0000000000036c98  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/split_config.arm64_v8a.apk!lib/arm64-v8a/liblanguage_id_jni.so (offset 0x11e000)
  #00  pc 0000000000032714  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/split_config.arm64_v8a.apk!lib/arm64-v8a/liblanguage_id_jni.so (offset 0x11e000)
  #00  pc 0000000000031cac  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/split_config.arm64_v8a.apk!lib/arm64-v8a/liblanguage_id_jni.so (offset 0x11e000)
  #00  pc 0000000000057438  /data/app/azagroup.reedy-mF7zTu2bv_ELlbFArwNgqA==/oat/arm64/base.odex (offset 0x57000)