Migrate ViewModel Compose to Multiplatform [330323282]

Fixed

Feature Request

Status Update

No update yet.

Description

mg...@google.com

created issue #1

Mar 19, 2024 02:46PM

Now that lifecycle-viewmodel has been migrated to Kotlin Multiplatform (see b/214568825), we should follow-up migrating lifecycle-viewmodel-compose too.

Comments

mg...@google.com <mg...@google.com> #2Mar 19, 2024 02:57PM

Note: I know alpha-02 has a fix for a biometric related leak: https://android-review.googlesource.com/c/platform/frameworks/support/+/1382564/

However that change did not fix the leak reported here, as BiometricViewModel is still tied to the activity lifecycle no matter what and will hold the clientCallback reference until the activity is destroyed.

ap...@google.com <ap...@google.com> #3Mar 20, 2024 06:08PM

Any news/possible for this issue?

ap...@google.com <ap...@google.com> #4Mar 20, 2024 06:08PM

Can confirm that it still happens in 1.1.0-beta01

ap...@google.com <ap...@google.com> #5Mar 20, 2024 06:08PM

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

commit fcbbd9368d75b736de4b92d067be84421376b294
Author: Curtis Belmonte <curtislb@google.com>
Date: Wed Jan 20 15:54:34 2021

Reset BiometricViewModel callback in Fragment#onDestroy()

Currently, the client callback reference held by BiometricViewModel is
retained for the lifecycle of the hosting activity. In the (likely) case
that a client is using a fragment within that activity to host
BiometricPrompt and passes an AuthenticationCallback with a reference to
that fragment, this will cause the fragment to leak.

This commit applies a minimal fix for the issue by resetting the
callback reference held by the view model when the host fragment is
destroyed (via a LifecycleObserver). This shouldn't affect the prompt's
behavior across configuration changes such as device rotation, since the
callback should be reinitialized by the client in onCreate() or similar.

Test: Biometric integration test app on API 27-30.
Test: ./gradlew biometric:biometric:test
Test: ./gradlew biometric:biometric:connectedAndroidTest
Test: ./gradlew biometric:integration-tests:testapp:connectedAndroidTest

Bug: 167014923
Change-Id: I7086460fac3921a490f4e2abf0671adec5c146bd

M biometric/biometric/src/main/java/androidx/biometric/BiometricPrompt.java
M biometric/biometric/src/main/java/androidx/biometric/BiometricViewModel.java

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

ap...@google.com <ap...@google.com> #6Mar 20, 2024 06:08PM

I don't use Fragments and use a View-based solutions instead. I create prompt like this:

BiometricPrompt(requireActivity, myAuthCallback)

So it is tied to the activity and it still leaks my view-based screens (1.2.0-alpha02). Ideally there would be a way to reset this callback. Latest commit fixes this leak only for Fragments (sadly).

Is there any workaround maybe? Dirty (but working) ones would do too ;)

ap...@google.com <ap...@google.com> #7Mar 20, 2024 06:08PM

Ditto with the above comment. We're a compose-only app, and use `BiometricPrompt` with the `Activity` context as opposed to passing in a Fragment. This results in leaks, as the callback held by `BiometricViewModel` is never cleared.

An API allowing developers to pass in their own `LifecycleOwner` to set up the `ResetCallbackObserver` observer would be a relatively quick and easy fix for this. I'm more than happy to draft a change for this and submit it via GitHub!

ap...@google.com <ap...@google.com> #8Mar 20, 2024 06:08PM

Any updates on this?

ap...@google.com <ap...@google.com> #9Mar 20, 2024 06:08PM

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

commit 61e7561c841336e65be6c18fa7fd8d8b003fb2a4
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:26:09 2024

Move dependencies to `commonMain` on `viewmodel-compose`

Test: N/A
Bug: 330323282
Change-Id: I9ccddf090462f16a71dabe9a0f687c7e91ffb5f6

M lifecycle/lifecycle-viewmodel-compose/build.gradle

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

ap...@google.com <ap...@google.com> #10Mar 20, 2024 06:08PM

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

commit a1f7b7585088dd00015c61bfa10053e76f77cc85
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:41:44 2024

Use `ViewModelProvider.create` method on `viewmodel-compose`

Test: N/A
Bug: 330323282
Change-Id: I056165d298392ddae01f170bd7912196207c30ea

M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.android.kt

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

ap...@google.com <ap...@google.com> #11Mar 20, 2024 06:08PM

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

commit c7d8ed902005764c8df4fef833aba0bb525084ea
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:36:08 2024

Add `factory` param to KDocs on `viewmodel-compose`

* Required for moving from `docs` to `kmpDocs`.
* Fixes `UnknownLine` Missing `@param` tag for parameter `factory` in DFunction `viewModel`

Test: N/A
Bug: 330323282
Change-Id: I216b5bbe5ada1909b24e86aa72236a4471fd334a

M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.android.kt

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

ap...@google.com <ap...@google.com> #12Mar 27, 2024 04:12PM

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

commit 1305e970c8a7187208cc2bbb0932104276bd2aea
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:41:44 2024

Use `ViewModelProvider.create` method in `viewmodel-compose`

Test: N/A
Bug: 330323282
Change-Id: Ia866dfe300c361ceb3ffeb2a88d6b63f38b09aec

M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.android.kt

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

ap...@google.com <ap...@google.com> #13Mar 27, 2024 04:12PM

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

commit ac869c99d561c43b5235bf58a35b859bb36e326f
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:33:41 2024

Move `LocalViewModelStoreOwner` to common in `viewmodel-compose`

Test: N/A
Bug: 330323282
Change-Id: I3561ea2d7e70ee2741bdbefdd6c1625413994aeb

M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/LocalViewModelStoreOwner.android.kt
A lifecycle/lifecycle-viewmodel-compose/src/commonMain/kotlin/androidx/lifecycle/viewmodel/compose/LocalViewModelStoreOwner.kt
A lifecycle/lifecycle-viewmodel-compose/src/desktopMain/kotlin/androidx/lifecycle/viewmodel/compose/LocalViewModelStoreOwner.desktop.kt

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

ap...@google.com <ap...@google.com> #14Mar 27, 2024 04:12PM

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

commit 358101c3e4ee1dd87464c1aec84de41309f706ac
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:22:15 2024

Rename source from `viewmodel-compose` to follow KMP convention

Test: N/A
Bug: 330323282
Change-Id: I688e85f81215bcc9bd05829e1ea2f78fb09c4c50

M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/SavedStateHandleSaverTest.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/TestViewModelClasses.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelInAppCompatActivityTest.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelInComponentActivityTest.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelInFragmentTest.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelTest.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/LocalViewModelStoreOwner.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/SavedStateHandleSaveableApi.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/SavedStateHandleSaver.android.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.android.kt

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

ap...@google.com <ap...@google.com> #15Mar 27, 2024 04:12PM

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

commit b7acab4368186972bb3138c45628cabc971b6fe2
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:24:42 2024

Update Compose UI and Runtime to 1.6.0 in `viewmodel-compose`

* Required to use the `Composable` annotation from the common source set.

Test: N/A
Bug: 330323282
Change-Id: I664449a501ef1d274b91cb3ad196cf5802d5f74b

M lifecycle/lifecycle-viewmodel-compose/build.gradle

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

ap...@google.com <ap...@google.com> #16Mar 27, 2024 04:12PM

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

commit 87fc3ece00231d3310d3f08746b6890c908722e0
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 27 14:53:26 2024

Fix corrupt serialized resolution result in `viewmodel-compose`

* Converting `lifecycle-viewmodel-compose` to Kotlin Multiplatform, and transitively depending on `lifecycle-livedata-core` triggered a bug in Gradle (

https://github.com/gradle/gradle/issues/14220).
* Directly adding `lifecycle-livedata-core` to `androidMain` allowed us to workaround the issue.

Test: `./gradlew :lifecycle:lifecycle-viewmodel-compose:compileCommonMainKotlinMetadata -Pandroidx.constraints=true`
Bug: 330323282
Change-Id: I0eb4c79efeb65e049f51706c6dcefce0d1ab83a4

M lifecycle/lifecycle-viewmodel-compose/build.gradle

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

ap...@google.com <ap...@google.com> #17Mar 27, 2024 04:12PM

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

commit fc493abaa7ecb38655922406691d1454f084b6ec
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 27 14:57:55 2024

Align all `implementation` declarations in `viewmodel-compose`

Test: N/A
Bug: 330323282
Change-Id: Ice8418438e70d633b59ae52cf3071d7b8c70e863

M lifecycle/lifecycle-viewmodel-compose/build.gradle

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

ap...@google.com <ap...@google.com> #18Mar 27, 2024 04:12PM

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

commit 7a8b0a8f054a488f1fa3762269b3c812d5c8fbf1
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:26:09 2024

Move dependencies to `commonMain` in `viewmodel-compose`

Test: N/A
Bug: 330323282
Change-Id: Icdf9d69a73de2ffc780355b2a84f21387ec4550c

M lifecycle/lifecycle-viewmodel-compose/build.gradle

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

ap...@google.com <ap...@google.com> #19Mar 27, 2024 04:12PM

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

commit 923f14b702f2b1cd7c2e1a626a3320737ea88e3a
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:39:47 2024

Add `KClass` method variants in `viewmodel-compose`

RelNote: "Composable `viewModel` functions now accept a `KClass` for Multiplatform compatibility. The `Class` variants are kept for Android compatibility."
Test: N/A
Bug: 330323282
Change-Id: I309315a069205acd87f7752d31c8a91ffc5ffbe7

M lifecycle/lifecycle-viewmodel-compose/api/current.txt
M lifecycle/lifecycle-viewmodel-compose/api/restricted_current.txt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.android.kt

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

ap...@google.com <ap...@google.com> #20Mar 27, 2024 04:12PM

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

commit ee955583f497b4c4ed60b95703282db85319534a
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:18:32 2024

Configure KMP in `viewmodel-compose`

* Setup the build scripts.
* Setup folder hierarchy.

Test: N/A
Bug: 330323282
Change-Id: I7461c27e0e90774c5391b971bfd3e58772cc0c9e

M docs-tip-of-tree/build.gradle
M lifecycle/lifecycle-viewmodel-compose/build.gradle
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/AndroidManifest.xml
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/SavedStateHandleSaverTest.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/TestViewModelClasses.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelInAppCompatActivityTest.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelInComponentActivityTest.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelInFragmentTest.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidInstrumentedTest/kotlin/androidx/lifecycle/viewmodel/compose/ViewModelTest.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/LocalViewModelStoreOwner.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/SavedStateHandleSaveableApi.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/SavedStateHandleSaver.kt
M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.kt

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

ap...@google.com <ap...@google.com> #21Mar 27, 2024 04:12PM

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

commit 7a8b46834cd8070ef519ac1d118115bcb62924ad
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:44:25 2024

Move `ViewModel.kt` to common in `viewmodel-compose`

Test: N/A
Bug: 330323282
Change-Id: I88d7c2a876b7469f301870a139b733c9db15cb8d

M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.android.kt
A lifecycle/lifecycle-viewmodel-compose/src/commonMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.kt

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

ap...@google.com <ap...@google.com> #22Mar 27, 2024 04:12PM

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

commit 22bf2247c81917a7d8e08d5d58e1a1b82c4fd6d9
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 20 11:36:08 2024

Add `factory` param to KDocs in `viewmodel-compose`

* Required for moving from `docs` to `kmpDocs`.
* Fixes `UnknownLine` Missing `@param` tag for parameter `factory` in DFunction `viewModel`

Test: N/A
Bug: 330323282
Change-Id: Iea301a001d6e47e038aa1e03cb5bc8e5c3b28bc2

M lifecycle/lifecycle-viewmodel-compose/src/androidMain/kotlin/androidx/lifecycle/viewmodel/compose/ViewModel.android.kt

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

ap...@google.com <ap...@google.com> #23Mar 27, 2024 05:59PM

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

commit 8c39ccf27d8a9656c2d22a464a9863e9af2e293e
Author: Marcello Galhardo <mgalhardo@google.com>
Date: Wed Mar 27 17:17:46 2024

Set LiveData to `compile` in `viewmodel-compose`

* Replace `implementation(projectOrArtifact(":lifecycle:lifecycle-livedata-core"))` by `compileOnly(projectOrArtifact(":lifecycle:lifecycle-livedata-core"))`

Test: `./gradlew :lifecycle:lifecycle-viewmodel-compose:compileCommonMainKotlinMetadata -Pandroidx.constraints=true`
Bug: 330323282
Change-Id: I1e3c65fb268b91ae489650995caa3cd33a452f57

M lifecycle/lifecycle-viewmodel-compose/build.gradle

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

mg...@google.com <mg...@google.com> Mar 28, 2024 11:00AM

Marked as fixed.