-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add rememberRetainedSaveable (#1305)
Adds a `rememberRetainedSaveable` variant that participates in both `RetainedStateRegistry` and `SaveableStateRegistry` restoration. The logic is the following upon `rememberRetainedSaveable` entering composition: - consume from both `RetainedStateRegistry` and `SaveableStateRegistry`, if available - if the retained value is available, use that - otherwise, if the saveable restored value is available, use that - otherwise, re-initialize the value The `RememberObserver` behavior is duplicated from the `rememberRetained` behavior. --------- Co-authored-by: Zac Sweers <[email protected]>
- Loading branch information
Showing
8 changed files
with
475 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
152 changes: 152 additions & 0 deletions
152
...androidInstrumentedTest/kotlin/com/slack/circuit/retained/android/RetainedSaveableTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| // Copyright (C) 2022 Slack Technologies, LLC | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| package com.slack.circuit.retained.android | ||
|
|
||
| import androidx.activity.ComponentActivity | ||
| import androidx.activity.compose.setContent | ||
| import androidx.compose.material.Text | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.CompositionLocalProvider | ||
| import androidx.compose.runtime.Stable | ||
| import androidx.compose.runtime.getValue | ||
| import androidx.compose.runtime.mutableStateOf | ||
| import androidx.compose.runtime.saveable.Saver | ||
| import androidx.compose.runtime.setValue | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.platform.testTag | ||
| import androidx.compose.ui.test.assertTextEquals | ||
| import androidx.compose.ui.test.junit4.createAndroidComposeRule | ||
| import androidx.compose.ui.test.onNodeWithTag | ||
| import androidx.lifecycle.ViewModel | ||
| import androidx.lifecycle.ViewModelProvider | ||
| import androidx.test.core.app.ActivityScenario | ||
| import com.slack.circuit.retained.Continuity | ||
| import com.slack.circuit.retained.ContinuityViewModel | ||
| import com.slack.circuit.retained.LocalCanRetainChecker | ||
| import com.slack.circuit.retained.LocalRetainedStateRegistry | ||
| import com.slack.circuit.retained.continuityRetainedStateRegistry | ||
| import com.slack.circuit.retained.rememberCanRetainChecker | ||
| import com.slack.circuit.retained.rememberRetained | ||
| import leakcanary.DetectLeaksAfterTestSuccess.Companion.detectLeaksAfterTestSuccessWrapping | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.junit.rules.RuleChain | ||
|
|
||
| class RetainedSaveableTest { | ||
| private val composeTestRule = createAndroidComposeRule<ComponentActivity>() | ||
|
|
||
| @get:Rule | ||
| val rule = | ||
| RuleChain.emptyRuleChain().detectLeaksAfterTestSuccessWrapping(tag = "ActivitiesDestroyed") { | ||
| around(composeTestRule) | ||
| } | ||
|
|
||
| private val scenario: ActivityScenario<ComponentActivity> | ||
| get() = composeTestRule.activityRule.scenario | ||
|
|
||
| private class RecordingContinuityVmFactory : ViewModelProvider.Factory { | ||
| var continuity: ContinuityViewModel? = null | ||
|
|
||
| override fun <T : ViewModel> create(modelClass: Class<T>): T { | ||
| @Suppress("UNCHECKED_CAST") return ContinuityViewModel().also { continuity = it } as T | ||
| } | ||
| } | ||
|
|
||
| private val vmFactory = RecordingContinuityVmFactory() | ||
|
|
||
| private var canRetainOverride: Boolean? = null | ||
|
|
||
| @Test | ||
| fun retainedIsUsedWhenRecreating() { | ||
| var id = 0 | ||
| lateinit var data: CacheableData | ||
|
|
||
| val content = | ||
| @Composable { | ||
| data = rememberRetained(saver = CacheableData.Saver) { CacheableData(id++) } | ||
| Text(modifier = Modifier.testTag("id"), text = "${data.id}") | ||
| Text(modifier = Modifier.testTag("superBigData"), text = "${data.superBigData}") | ||
| } | ||
|
|
||
| setActivityContent(content) | ||
|
|
||
| // Check initial state is correct | ||
| composeTestRule.onNodeWithTag("id").assertTextEquals("0") | ||
| composeTestRule.onNodeWithTag("superBigData").assertTextEquals("null") | ||
|
|
||
| data.superBigData = "Super big data" | ||
| composeTestRule.waitForIdle() | ||
|
|
||
| composeTestRule.onNodeWithTag("id").assertTextEquals("0") | ||
| composeTestRule.onNodeWithTag("superBigData").assertTextEquals("Super big data") | ||
|
|
||
| scenario.recreate() | ||
|
|
||
| setActivityContent(content) | ||
|
|
||
| // Retained state is preserved | ||
| composeTestRule.onNodeWithTag("id").assertTextEquals("0") | ||
| composeTestRule.onNodeWithTag("superBigData").assertTextEquals("Super big data") | ||
| } | ||
|
|
||
| @Test | ||
| fun saveableIsUsedWhenRecreatingWithProcessDeath() { | ||
| var id = 0 | ||
| lateinit var data: CacheableData | ||
|
|
||
| val content = | ||
| @Composable { | ||
| data = rememberRetained(saver = CacheableData.Saver) { CacheableData(id++) } | ||
| Text(modifier = Modifier.testTag("id"), text = "${data.id}") | ||
| Text(modifier = Modifier.testTag("superBigData"), text = "${data.superBigData}") | ||
| } | ||
|
|
||
| setActivityContent(content) | ||
|
|
||
| // Check initial state is correct | ||
| composeTestRule.onNodeWithTag("id").assertTextEquals("0") | ||
| composeTestRule.onNodeWithTag("superBigData").assertTextEquals("null") | ||
|
|
||
| data.superBigData = "Super big data" | ||
| composeTestRule.waitForIdle() | ||
|
|
||
| composeTestRule.onNodeWithTag("id").assertTextEquals("0") | ||
| composeTestRule.onNodeWithTag("superBigData").assertTextEquals("Super big data") | ||
|
|
||
| // Override can retain to drop retaining values, to simulate process death | ||
| canRetainOverride = false | ||
| scenario.recreate() | ||
| canRetainOverride = null | ||
|
|
||
| setActivityContent(content) | ||
|
|
||
| // Retained state is not preserved, but id is | ||
| composeTestRule.onNodeWithTag("id").assertTextEquals("0") | ||
| composeTestRule.onNodeWithTag("superBigData").assertTextEquals("null") | ||
| } | ||
|
|
||
| private fun setActivityContent(content: @Composable () -> Unit) { | ||
| scenario.onActivity { activity -> | ||
| activity.setContent { | ||
| val defaultCanRetainChecker = LocalCanRetainChecker.current ?: rememberCanRetainChecker() | ||
| CompositionLocalProvider( | ||
| LocalRetainedStateRegistry provides | ||
| continuityRetainedStateRegistry(Continuity.KEY, vmFactory) { | ||
| canRetainOverride ?: defaultCanRetainChecker.canRetain(it) | ||
| } | ||
| ) { | ||
| content() | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Stable | ||
| private class CacheableData(val id: Int) { | ||
| var superBigData: String? by mutableStateOf(null) | ||
|
|
||
| companion object { | ||
| val Saver: Saver<CacheableData, *> = Saver({ it.id }, { CacheableData(it) }) | ||
| } | ||
| } |
11 changes: 11 additions & 0 deletions
11
...t-retained/src/commonMain/kotlin/com/slack/circuit/retained/DelicateCircuitRetainedApi.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| // Copyright (C) 2024 Slack Technologies, LLC | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| package com.slack.circuit.retained | ||
|
|
||
| import kotlin.annotation.AnnotationTarget.FUNCTION | ||
|
|
||
| /** Indicates that the annotated API is delicate and should be used carefully. */ | ||
| @RequiresOptIn | ||
| @Retention(AnnotationRetention.BINARY) | ||
| @Target(FUNCTION) | ||
| public annotation class DelicateCircuitRetainedApi |
Oops, something went wrong.