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 c60f33e229e31ab328ef6b59dab63b264954831c
Author: Alexandre Elias <aelias@google.com>
Date: Fri Jul 10 16:23:09 2020

Semantics no-op cleanups

Partly in response to lmr's broad code review, I did a pass of
superficial API/implementation cleanup. The main changes are:

- I changed each Boolean SemanticsProperty where false is equivalent to
not being present to take "Unit" instead. This is conceptually
clearer: it avoids questions like "can I cancel out a semantics from a
merged child by setting it to false?" Because "property = Unit" looks
weird, I also changed the style of these to "property()".

- I moved the Semantics id generator closer to where it's used, in
SemanticsModifierCore. I made it internal and an AtomicInt.
(Note that integer ids are heavily used in the Android
AccessibilityNodeInfo APIs so I can't simply remove them entirely.)

- I deleted dead code. Some examples include SemanticsHintOverrides,
a public API not connected to anything, and SemanticsPropertyKey
merge() open method which is never called. (In both cases I have
a different plan in mind for accessibility.)

Fixes: 145951226
Fixes: 145955412
Test: existing tests
Relnote: "Single-value semantics properties now use a calling style.
For example, 'semantics { hidden = true }' is now written as:
'semantics { hidden() }'."

Change-Id: Ic1afd12ea22c926babc9662f1804d80b33aa0cfc

M ui/integration-tests/benchmark/src/androidTest/java/androidx/ui/benchmark/test/LayoutNodeModifierBenchmark.kt
M ui/ui-core/api/0.1.0-dev15.txt
M ui/ui-core/api/current.txt
M ui/ui-core/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-core/api/public_plus_experimental_current.txt
M ui/ui-core/api/restricted_0.1.0-dev15.txt
M ui/ui-core/api/restricted_current.txt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/graphics/vector/VectorTest.kt
M ui/ui-core/src/androidAndroidTest/kotlin/androidx/ui/semantics/SemanticsTests.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidActuals.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeView.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidComposeViewAccessibilityDelegateCompat.kt
M ui/ui-core/src/androidMain/kotlin/androidx/ui/core/AndroidPopup.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/Expect.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsConfiguration.kt
D ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsHintOverrides.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsModifier.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsNode.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsOwner.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/core/semantics/SemanticsWrapper.kt
M ui/ui-core/src/commonMain/kotlin/androidx/ui/semantics/SemanticsProperties.kt
M ui/ui-foundation/api/0.1.0-dev15.txt
M ui/ui-foundation/api/current.txt
M ui/ui-foundation/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-foundation/api/public_plus_experimental_current.txt
M ui/ui-foundation/api/restricted_0.1.0-dev15.txt
M ui/ui-foundation/api/restricted_current.txt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Clickable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Dialog.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/Scroller.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Selectable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/selection/Toggleable.kt
M ui/ui-foundation/src/main/java/androidx/ui/foundation/semantics/FoundationSemanticsProperties.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ButtonTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CardTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/CheckboxScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/RadioButtonScreenshotTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ScaffoldTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SnackbarTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/SurfaceTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/ripple/RippleIndicationTest.kt
M ui/ui-material/src/androidTest/java/androidx/ui/material/textfield/TextFieldScreenshotTest.kt
M ui/ui-material/src/main/java/androidx/ui/material/AppBar.kt
M ui/ui-material/src/main/java/androidx/ui/material/TextFieldImpl.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/AssertsTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/CallSemanticsActionTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ErrorMessagesTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/FindersTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/PrintToStringTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/ScrollToTest.kt
M ui/ui-test/src/androidTest/java/androidx/ui/test/TextActionsTest.kt
M ui/ui-test/src/main/java/androidx/ui/test/Actions.kt
M ui/ui-test/src/main/java/androidx/ui/test/Filters.kt
M ui/ui-text/api/0.1.0-dev15.txt
M ui/ui-text/api/current.txt
M ui/ui-text/api/public_plus_experimental_0.1.0-dev15.txt
M ui/ui-text/api/public_plus_experimental_current.txt
M ui/ui-text/api/restricted_0.1.0-dev15.txt
M ui/ui-text/api/restricted_current.txt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/CoreTextField.kt
M ui/ui-text/src/commonMain/kotlin/androidx/ui/text/TextSemanticsProperties.kt

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

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

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

commit 690f94c30462a839c39ef5298ec263b67a33557e
Author: Clara Fok <clarafok@google.com>
Date: Tue Oct 10 13:38:34 2023

Fix ViewModel not cleared after pop

When an entry is popped followed by a configuration change, the list of transitioning entries is lost and the outgoing entry is not marked complete. As a result, the ViewModel is also not cleared.

Now we ensure to mark outgoing entries as complete when a NavHost goes through config change (when it is disposed).

Test: ./gradlew navigation:navigation-compose:cC
Bug: 298164648
Relnote: "When an entry is popped followed by a configuration change, the entry's ViewModel will now be cleared properly if saveState is false."
Change-Id: Idf242239ceeb731c3375ef507a2cc854d85743c7

M navigation/navigation-compose/src/androidTest/java/androidx/navigation/compose/NavHostTest.kt
M navigation/navigation-compose/src/main/java/androidx/navigation/compose/NavHost.kt

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

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

Marked as fixed.

Fixed internally, available in navigation 2.7.5

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