Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates AmbientAware to avoid recreating whole tree #2050

Merged
merged 2 commits into from
Feb 20, 2024
Merged

Updates AmbientAware to avoid recreating whole tree #2050

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5ce413
Updates AmbientAware to avoid recreating whole tree
garanj Feb 20, 2024
1bed225
Removes AmbientAwareDisabled
garanj Feb 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 31 additions & 45 deletions compose-layout/src/main/java/com/google/android/horologist/compose/ambient/AmbientAware.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,56 +51,48 @@ fun AmbientAware(
isAlwaysOnScreen: Boolean = true,
block: @Composable (AmbientStateUpdate) -> Unit,
) {
var ambientUpdate by remember(isAlwaysOnScreen) {
mutableStateOf(if (isAlwaysOnScreen) null else AmbientStateUpdate(AmbientState.Interactive))
}

val activity = LocalContext.current.findActivityOrNull()
// Using AmbientAware correctly relies on there being an Activity context. If there isn't, then
// gracefully allow the composition of [block], but no ambient-mode functionality is enabled.
if (activity != null && isAlwaysOnScreen) {
AmbientAwareEnabled(activity, block)
} else {
AmbientAwareDisabled(block)
yschimke marked this conversation as resolved.
Show resolved Hide resolved
}
}
val lifecycle = LocalLifecycleOwner.current.lifecycle
val observer = remember {
val callback = object : AmbientLifecycleObserver.AmbientLifecycleCallback {
override fun onEnterAmbient(ambientDetails: AmbientLifecycleObserver.AmbientDetails) {
ambientUpdate = AmbientStateUpdate(AmbientState.Ambient(ambientDetails))
}

@Composable
private fun AmbientAwareEnabled(
activity: Activity,
block: @Composable (AmbientStateUpdate) -> Unit,
) {
val lifecycle = LocalLifecycleOwner.current.lifecycle
var ambientUpdate by remember { mutableStateOf<AmbientStateUpdate?>(null) }
override fun onExitAmbient() {
ambientUpdate = AmbientStateUpdate(AmbientState.Interactive)
}

val observer = remember {
val callback = object : AmbientLifecycleObserver.AmbientLifecycleCallback {
override fun onEnterAmbient(ambientDetails: AmbientLifecycleObserver.AmbientDetails) {
ambientUpdate = AmbientStateUpdate(AmbientState.Ambient(ambientDetails))
override fun onUpdateAmbient() {
val lastAmbientDetails =
(ambientUpdate?.ambientState as? AmbientState.Ambient)?.ambientDetails
ambientUpdate = AmbientStateUpdate(AmbientState.Ambient(lastAmbientDetails))
}
}

override fun onExitAmbient() {
ambientUpdate = AmbientStateUpdate(AmbientState.Interactive)
AmbientLifecycleObserver(activity, callback).also {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the future, there is a comment that AmbientLifecycleObserver being mocked out.

Something we should consider for testing and previews.

https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:wear/wear/src/main/java/androidx/wear/ambient/AmbientLifecycleObserver.kt;l=109?q=AmbientLifecycleObserver

// Necessary to populate the initial value
val initialAmbientState = if (it.isAmbient) {
AmbientState.Ambient(null)
} else {
AmbientState.Interactive
}
ambientUpdate = AmbientStateUpdate(initialAmbientState)
}

override fun onUpdateAmbient() {
val lastAmbientDetails =
(ambientUpdate?.ambientState as? AmbientState.Ambient)?.ambientDetails
ambientUpdate = AmbientStateUpdate(AmbientState.Ambient(lastAmbientDetails))
}
}
AmbientLifecycleObserver(activity, callback).also {
// Necessary to populate the initial value
val initialAmbientState = if (it.isAmbient) {
AmbientState.Ambient(null)
} else {
AmbientState.Interactive
}
ambientUpdate = AmbientStateUpdate(initialAmbientState)
}
}

DisposableEffect(Unit) {
lifecycle.addObserver(observer)
DisposableEffect(Unit) {
lifecycle.addObserver(observer)

onDispose {
lifecycle.removeObserver(observer)
onDispose {
lifecycle.removeObserver(observer)
}
}
}

Expand All @@ -109,12 +101,6 @@ private fun AmbientAwareEnabled(
}
}

@Composable
private fun AmbientAwareDisabled(block: @Composable (AmbientStateUpdate) -> Unit) {
val staticAmbientState by remember { mutableStateOf(AmbientStateUpdate(AmbientState.Interactive)) }
block(staticAmbientState)
}

private fun Context.findActivityOrNull(): Activity? {
var context = this
while (context is ContextWrapper) {
Expand Down
Loading