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

Fixed incorrect predictive back animation playing on hardware back button click with the new animation API #779

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Fixed incorrect predictive back animation playing on hardware back button click with the new animation API #779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 31 additions & 12 deletions ...ivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,24 @@ internal class DefaultStackAnimation<C : Any, T : Any>(
private val setItems: (Map<Any, AnimationItem<C, T>>) -> Unit,
) : BackCallback() {
private var animationHandler: AnimationHandler? = null
private var initialBackEvent: BackEvent? = null

override fun onBackStarted(backEvent: BackEvent) {
initialBackEvent = backEvent
}

override fun onBackProgressed(backEvent: BackEvent) {
startIfNeeded()

scope.launch {
animationHandler?.progress(backEvent)
}
}

private fun startIfNeeded() {
val backEvent = initialBackEvent ?: return
initialBackEvent = null

val animationHandler = AnimationHandler(animatable = predictiveBackParams.animatable(backEvent))
this.animationHandler = animationHandler
val exitChild = stack.active
Expand Down Expand Up @@ -252,25 +268,28 @@ internal class DefaultStackAnimation<C : Any, T : Any>(
}
}

override fun onBackProgressed(backEvent: BackEvent) {
scope.launch {
animationHandler?.progress(backEvent)
}
}

override fun onBackCancelled() {
initialBackEvent = null

scope.launch {
animationHandler?.cancel()
animationHandler = null
setItems(getAnimationItems(newStack = stack))
animationHandler?.also { handler ->
handler.cancel()
animationHandler = null
setItems(getAnimationItems(newStack = stack))
}
}
}

override fun onBack() {
initialBackEvent = null

scope.launch {
animationHandler?.finish()
animationHandler = null
setItems(getAnimationItems(newStack = stack.dropLast()))
animationHandler?.also { handler ->
handler.finish()
animationHandler = null
setItems(getAnimationItems(newStack = stack.dropLast()))
}

predictiveBackParams.onBack()
}
}
Expand Down
100 changes: 94 additions & 6 deletions ...ov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import org.junit.Rule
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFalse
import kotlin.test.assertTrue

@Suppress("TestFunctionName")
@OptIn(ExperimentalDecomposeApi::class)
Expand Down Expand Up @@ -50,7 +51,7 @@ class PredictiveBackGestureTest {
}

@Test
fun WHEN_startPredictiveBack_THEN_gesture_started() {
fun WHEN_startPredictiveBack_THEN_active_child_shown_without_progress() {
var stack by mutableStateOf(stack("1", "2"))
val animation = DefaultStackAnimation(onBack = { stack = stack.dropLast() })

Expand All @@ -63,8 +64,9 @@ class PredictiveBackGestureTest {
backDispatcher.startPredictiveBack(BackEvent(progress = 0F))
composeRule.waitForIdle()

composeRule.onNodeWithText("1").assertTestTagToRootExists(enterTestTag(progress = 0F))
composeRule.onNodeWithText("2").assertTestTagToRootExists(exitTestTag(progress = 0F))
composeRule.onNodeWithText("1").assertDoesNotExist()
composeRule.onNodeWithText("2").assertExists()
composeRule.onNodeWithText("2").assertTestTagToRootDoesNotExist { it.startsWith(TEST_TAG_PREFIX) }
}

@Test
Expand Down Expand Up @@ -286,7 +288,50 @@ class PredictiveBackGestureTest {
}

@Test
fun GIVEN_three_children_in_stack_WHEN_predictive_back_finished_THEN_previous_child_not_animated_after_pop() {
fun GIVEN_three_children_in_stack_and_gesture_started_WHEN_predictive_back_finished_THEN_predictive_back_animatable_not_created() {
var stack by mutableStateOf(stack("1", "2", "3"))
val values = ArrayList<Float>()
var isAnimatableCreated = false

val animation =
DefaultStackAnimation(
predictiveBackAnimatable = { initialBackEvent ->
isAnimatableCreated = true
TestAnimatable(initialBackEvent)
},
onBack = {
values.clear()
stack = stack.dropLast()
},
)


composeRule.setContent {
animation(stack, Modifier) {
val float by transition.animateFloat { state ->
when (state) {
EnterExitState.PreEnter -> 0F
EnterExitState.Visible -> 1F
EnterExitState.PostExit -> 0F
}
}

if (it.configuration == "2") {
values += float
}
}
}

backDispatcher.startPredictiveBack(BackEvent(progress = 0F))
composeRule.waitForIdle()
backDispatcher.back()
composeRule.waitForIdle()

assertFalse(isAnimatableCreated)
}

@Test
fun GIVEN_three_children_in_stack_and_gesture_started_WHEN_predictive_back_finished_THEN_previous_child_animated_after_pop() {
var stack by mutableStateOf(stack("1", "2", "3"))
val values = ArrayList<Float>()

Expand Down Expand Up @@ -320,17 +365,60 @@ class PredictiveBackGestureTest {
backDispatcher.back()
composeRule.waitForIdle()

assertTrue(values.any { it < 1F })
}

@Test
fun GIVEN_three_children_in_stack_and_gesture_progressed_WHEN_predictive_back_finished_THEN_previous_child_not_animated_after_pop() {
var stack by mutableStateOf(stack("1", "2", "3"))
val values = ArrayList<Float>()

val animation =
DefaultStackAnimation(
onBack = {
values.clear()
stack = stack.dropLast()
}
)


composeRule.setContent {
animation(stack, Modifier) {
val float by transition.animateFloat { state ->
when (state) {
EnterExitState.PreEnter -> 0F
EnterExitState.Visible -> 1F
EnterExitState.PostExit -> 0F
}
}

if (it.configuration == "2") {
values += float
}
}
}

backDispatcher.startPredictiveBack(BackEvent(progress = 0F))
composeRule.waitForIdle()
backDispatcher.progressPredictiveBack(BackEvent(progress = 0.5F))
composeRule.waitForIdle()
backDispatcher.back()
composeRule.waitForIdle()

assertFalse(values.any { it < 1F })
}

private fun DefaultStackAnimation(onBack: () -> Unit): DefaultStackAnimation<String, String> =
private fun DefaultStackAnimation(
predictiveBackAnimatable: (initialBackEvent: BackEvent) -> PredictiveBackAnimatable? = ::TestAnimatable,
onBack: () -> Unit,
): DefaultStackAnimation<String, String> =
DefaultStackAnimation(
disableInputDuringAnimation = false,
predictiveBackParams = {
PredictiveBackParams(
backHandler = backDispatcher,
onBack = onBack,
animatable = ::TestAnimatable,
animatable = predictiveBackAnimatable,
)
},
selector = { _, _, _ -> null },
Expand Down
Loading