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.

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

Cancel predictive back gesture when stack changed (experimental animation API) #806

Merged

Conversation

arkivanov
Copy link
Owner

@arkivanov arkivanov commented Nov 7, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced animation handling during stack transitions with new conditions for seekable transition states.
    • Added a new private function to check if a transition state is seekable.
  • Bug Fixes

    • Introduced a test case for predictive back gesture behavior to ensure correct cancellation when the stack is popped.
  • Documentation

    • Updated method signatures to improve clarity and functionality in animation handling.

Copy link

coderabbitai bot commented Nov 7, 2024

Walkthrough

The changes in this pull request involve updates to the DefaultStackAnimation.kt file to enhance the handling of animation items during stack transitions. A new condition is added to check if the last animation item's transition state is seekable, affecting how animation states are managed. Additionally, a new private extension function isSeekable() is introduced to the TransitionState class. In the test file PredictiveBackGestureTest.kt, a new test case is added to verify the behavior of predictive back gestures during stack changes, and the DefaultStackAnimation function signature is modified to include an optional animator parameter.

Changes

File Change Summary
extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt - Added a check for seekable transition state in the invoke method.
- Introduced a new private method isSeekable().
- Updated method signature for isIdle() (no change in signature).
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt - Added new test method GIVEN_gesture_started_WHEN_stack_popped_THEN_gesture_cancelled.
- Modified DefaultStackAnimation to include an optional animator parameter.

Possibly related PRs

🐰 In the land of code where rabbits play,
Animation hops in a brand new way.
With seekable states and tests that gleam,
Our stack transitions dance like a dream!
So let’s celebrate with a joyful cheer,
For smoother gestures and fun this year! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt (1)

404-406: LGTM: Clean utility function, but remove extra blank line

The isSeekable extension function is well-implemented and improves code readability. However, there's an extra blank line before the function that should be removed to maintain consistent spacing with other utility functions in this file.

 private fun TransitionState<*>.isIdle(): Boolean =
     when (this) {
         is MutableTransitionState -> isIdle
         is SeekableTransitionState -> false
         else -> false
     }
-

 private fun TransitionState<*>.isSeekable(): Boolean =
     this is SeekableTransitionState
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt (1)

216-237: Enhance test coverage with additional assertions.

While the test verifies the basic cancellation behavior, consider adding these assertions for more comprehensive coverage:

  • Verify the final stack state after cancellation
  • Assert the existence of the first item
  • Verify the animation progress is reset
 @Test
 fun GIVEN_gesture_started_WHEN_stack_popped_THEN_gesture_cancelled() {
     var stack by mutableStateOf(stack("1", "2"))
     val animation = DefaultStackAnimation(animator = fade(), onBack = { stack = stack.dropLast() },)

     composeRule.setContent {
         animation(stack, Modifier) {
             Text(text = it.configuration)
         }
     }

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

     stack = stack.dropLast()
     composeRule.mainClock.autoAdvance = false
     composeRule.mainClock.advanceTimeByFrame()

+    assertEquals(stack("1"), stack)
+    composeRule.onNodeWithText("1").assertExists()
+    composeRule.onNodeWithText("1").assertTestTagToRootDoesNotExist { it.startsWith(TEST_TAG_PREFIX) }
     composeRule.onNodeWithText("2").assertTestTagToRootDoesNotExist { it.startsWith(TEST_TAG_PREFIX) }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 00bf7ee and e4c0d00.

📒 Files selected for processing (2)
  • extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt (2 hunks)
  • extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt (3 hunks)
🔇 Additional comments (2)
extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt (1)

72-72: LGTM: Enhanced animation state handling for predictive back gestures

The additional condition items.values.last().transitionState.isSeekable() ensures smooth animation transitions during predictive back gestures by allowing immediate item updates when the last transition state is seekable. This prevents potential animation glitches during stack changes.

extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt (1)

497-497: LGTM!

The addition of the optional animator parameter is clean and maintains backward compatibility. The parameter is correctly utilized in the selector lambda.

Also applies to: 509-509

@arkivanov arkivanov merged commit b843d5a into master Nov 7, 2024
3 checks passed
@arkivanov arkivanov deleted the cancel-predictive-back-animation-when-stack-changed branch November 7, 2024 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant