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

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

commit b90079595f33f58fece04026a97faa0d243acdb1
Author: Yuichi Araki <yaraki@google.com>
Date: Wed Sep 18 16:55:49 2019

Change the way to detect mismatch between POJO and query

This fixes cursor mismatch warnings with expandProjection.

Bug: 140759491
Test: QueryMethodProcessorTest
Change-Id: I7659002e5e0d1ef60fc1af2a625c0c36da0664d8

M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/QueryMethodProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/testing/TestProcessor.kt

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

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

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

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6093116828680192/#/cherrypickHistory/all)
Created: 2019-10-14 17:23:42.610596+00:00
Changes: aosp/1123258

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

Marked as fixed.

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

commit bdde5a1a970ddc9007b28de4aa29d60ffa588f08
Author: Yigit Boyar <yboyar@google.com>
Date: Thu Apr 16 16:47:05 2020

Re-factor how errors are dismissed when query is re-written

This CL changes how we handle errors/warnings if query is
re-written.
There was a bug in expandProjection where we would report warnings
for things that Room already fixes automatically (

b/140759491

).
The solution to that problem (I7659002e5e0d1ef60fc1af2a625c0c36da0664d8)
solved it by deferring validating of columns until after re-write
decision is made. Unfortunately, this required changing PojoRowAdapter
to have a dummy mapping until it is validating, make it hard to use
as it does have a non-null mapping which is not useful.

This CL partially reverts that change and instead rely on the log
deferring logic we have in Context. This way, we don't need to break
the stability of PojoRowAdapter while still having the ability to
drop warnings that room fixes. This will also play nicer when we
have different query re-writing options that can use more information
about the query results.

Bug: 153387066
Bug: 140759491
Test: existing tests pass
Change-Id: I2ec967c763d33d7a3ff02c1a13c6953b460d1e5f

M room/compiler/src/main/kotlin/androidx/room/log/RLog.kt
M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt

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

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

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

androidx.navigation:navigation-compose:2.7.5

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