AndroidView does not set ViewTree*Owners from composition locals [179708470]

Fixed

Bug

Status Update

No update yet.

Description

za...@gmail.com

created issue #1

Feb 9, 2021 08:14PM

Jetpack Compose release version: 1.0.0-alpha11

Android Studio Build:

Android Studio Arctic Fox | 2020.3.1 Canary 4
Build #AI-202.7319.50.2031.7049475, built on December 23, 2020
Runtime version: 11.0.8+10-b944.6842174 x86_64
VM: OpenJDK 64-Bit Server VM by N/A
macOS 10.16
GC: G1 Young Generation, G1 Old Generation
Memory: 16384M
Cores: 16
Registry: analyze.exceptions.on.the.fly=true, external.system.auto.import.disabled=true, debugger.watches.in.variables=false, vcs.log.index.git=off, caches.indexerThreadsCount=16
Non-Bundled Plugins: carbon-now-sh, com.intellij.marketplace, com.squareup.android.library.generator, org.jetbrains.kotlin

This requires a bit of setup to reproduce, and there are a number of issues that require similar setup, so I have created a dedicated repo that demonstrates and has UI tests for them here.

The README in the root of that repo describes the setup, the issues, and the fixes to them that make sense to me.

These issues will probably affect the Compose integration for the Jetpack Navigation library, as well as other navigation libraries that are written in Compose.

Comments

an...@google.com <an...@google.com> Feb 9, 2021 08:20PM

Assigned to an...@google.com.

za...@gmail.com <za...@gmail.com> #2Feb 10, 2021 12:49AM

I gave this a bad title. It should probably be something like "The communication of view tree owners between Compositions and AndroidViews is confusing, error-prone, and currently missing some wiring".

za...@gmail.com <za...@gmail.com> #3Aug 26, 2021 08:59PM

It looks like at least some of these issues are still present in 1.0.1, although I need to update the repro project to verify. I’ve been chatting with Ian about this on the Kotlin Slack. He said it seems like something in Wrapper.android.it might need to be changed, but I’m not sure what.

Ian pointed out that composition locals that are set by a parent composition are generally visible to/inherited by subcompositions, even if there are Android views in between. However, in this particular case, that does not matter because the Wrapper will always explicitly set the values of the lifecycle and state registry locals to the values it got from the view tree, overriding any values coming in from the parent composition.

As far as I can tell from reading the code myself, I think the solution is just that AndroidView needs to set the ViewTreeLifecycleOwner and ViewTreeSavedStateRegistryOwner from the LocalLifecycleOwner and LocalSavedStateRegistry, respectively, on the Android view it creates. Then, any descendant views will see the correct owners if they were overridden in the composition, and any nested compositions will also get those owners and set them as the local values for their compositions.

an...@google.com <an...@google.com> Aug 27, 2021 10:29AM

Reassigned to po...@google.com.

za...@gmail.com <za...@gmail.com> #4Sep 6, 2021 04:55PM

Confirming the issue affects Jetpack Navigation as well.

I just updated the repro project to Compose 1.0.1 and added a demonstration of the issue affecting Jetpack Navigation.

po...@google.com <po...@google.com> Sep 7, 2021 05:34PM

Reassigned to kl...@google.com.

kl...@google.com <kl...@google.com> Sep 13, 2021 08:37PM

Accepted by kl...@google.com.

kl...@google.com <kl...@google.com> #5Sep 17, 2021 06:00PM

Started working on this, but it looks like navigation-compose might need a change as well.

kl...@google.com <kl...@google.com> #6Sep 23, 2021 04:36PM

Filed b/200953430 to track the issue in Jetpack Navigation.

ap...@google.com <ap...@google.com> #7Oct 7, 2021 12:50AM

Marked as fixed.

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

commit 11a26697f42c3a6d4a248eb35f52d2c26bd6d9cf
Author: Zach Klippenstein <klippenstein@google.com>
Date: Thu Sep 16 16:46:51 2021

Propagate local owners as view tree owners in AndroidView.

Propagates the LocalLifecycleOwner and LocalSavedStateRegistryOwner from
an AndroidView to the managed View by setting ViewTreeLifecycleOwner and
ViewTreeSavedStateRegistryOwner, respectively, on the AndroidViewHolder.
This ensures that, if something in the composition (e.g. a navigation
library like Jetpack Navigation Compose) sets those locals to
owners that are different from the ones used to create the composition
itself, any Android Views nested beneath them will see those owners and
not the ones used by the composition.

Test: Added tests to AndroidViewTest
Fixes:

b/179708470

Relnote: "AndroidView now propagates LocalLifecycleOwner and
LocalSavedStateRegistryOwner to its view via ViewTreeLifecycleOwner
and ViewTreeSavedStateRegistryOwner."

Change-Id: I38f966576085db66e35b0106f49275ef5bb31adc

M compose/ui/ui/src/androidAndroidTest/kotlin/androidx/compose/ui/viewinterop/AndroidViewTest.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/platform/AndroidCompositionLocals.android.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/viewinterop/AndroidViewHolder.android.kt
M compose/ui/ui/src/androidMain/kotlin/androidx/compose/ui/viewinterop/AndroidView.android.kt

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