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

Don't animate the previous child after predictive back gesture finished and stack popped #774

Merged

Conversation

arkivanov
Copy link
Owner

@arkivanov arkivanov commented Sep 6, 2024

Fixes #772.

Summary by CodeRabbit

  • New Features

    • Improved handling of stack animations for scenarios with a single item, enhancing animation state accuracy.
  • Tests

    • Added a new test case to verify that the previous child does not animate after a predictive back gesture is completed, increasing testing coverage for stack animation behavior.

Copy link

coderabbitai bot commented Sep 6, 2024

Walkthrough

The changes enhance the DefaultStackAnimation class by adding a conditional check for single-item stacks, refining the animation state update logic. Additionally, a new test case is introduced in PredictiveBackGestureTest to validate the behavior of stack animations during predictive back gestures, ensuring that previous children do not animate unexpectedly after a pop operation.

Changes

Files Change Summary
extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt Enhanced logic in DefaultStackAnimation to include a condition for single-item stacks, improving animation state updates.
extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt Added a new test case in PredictiveBackGestureTest to ensure the previous child does not animate after a pop operation when a predictive back gesture is completed.

Assessment against linked issues

Objective Addressed Explanation
Duplicated predictive back animation with new Experimental Animation API (#772)

🐰 In the stack where children play,
A single hop, they sway away.
With gestures clear, no dance in vain,
Animation flows, no need to feign.
Hops are smooth, the path is bright,
In joyful leaps, we find delight! 🌟


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ba105fd and c7ba62f.

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

288-324: Well-structured test for predictive back gesture behavior.

The test method GIVEN_three_children_in_stack_WHEN_predictive_back_finished_THEN_previous_child_not_animated_after_pop is well-structured and effectively verifies that the previous child is not animated after a pop operation. The use of mutable state and an ArrayList to capture animation values is appropriate, and the assertion that no values are less than 1F effectively checks the desired behavior.

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

62-63: Critical enhancement for handling single-item stacks in animations.

The addition of a new conditional check for single-item stacks within the updateItems logic is a critical enhancement. This change ensures that the animation state is accurately updated, preventing unnecessary animations and improving performance. The implementation correctly checks if the single key in items is different from the active.key of the stack, which is essential for handling edge cases effectively.

@arkivanov arkivanov force-pushed the fix-prev-child-animating-after-predictive-back-pop branch from c7ba62f to d8f7d2d Compare September 7, 2024 11:55
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c7ba62f and d8f7d2d.

Files selected for processing (2)
  • extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt (1 hunks)
  • extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt (3 hunks)
Files skipped from review as they are similar to previous changes (2)
  • extensions-compose-experimental/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/DefaultStackAnimation.kt
  • extensions-compose-experimental/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/experimental/stack/animation/PredictiveBackGestureTest.kt

@arkivanov arkivanov merged commit 43ef0e1 into master Sep 7, 2024
3 checks passed
@arkivanov arkivanov deleted the fix-prev-child-animating-after-predictive-back-pop branch September 7, 2024 12:34
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.

Duplicated predictive back animation with new Experimental Animation API
1 participant