fix(runtime-core): add skip onmount optimization prop on BaseTransiti…

[TalexDreamSoul]

This pr relates to P13316

Summary by CodeRabbit

• New Features
  • Added a new option to transitions that allows disabling the default unmount optimization, ensuring leave animations can complete even during component unmounting.

[coderabbitai]

Walkthrough

An optional boolean prop, skipUnmountingOptimization, was added to the BaseTransitionProps interface and its validator. The resolveTransitionHooks function now uses this prop to control whether the leave transition is optimized away during unmounting, allowing developers to opt out of the default behavior and always run the leave animation.

Changes

File(s)	Change Summary
packages/runtime-core/src/components/BaseTransition.ts	Added skipUnmountingOptimization prop and validator to BaseTransitionProps. Updated resolveTransitionHooks to use this prop and conditionally skip early removal in the leave hook.

Sequence Diagram(s)

sequenceDiagram
    participant ParentComponent
    participant BaseTransition
    participant ChildComponent

    ParentComponent->>BaseTransition: Initiate unmount (with skipUnmountingOptimization)
    BaseTransition->>BaseTransition: Check isUnmounting and skipUnmountingOptimization
    alt skipUnmountingOptimization is false
        BaseTransition->>ChildComponent: Immediately remove (no leave animation)
    else skipUnmountingOptimization is true
        BaseTransition->>ChildComponent: Run full leave animation before removal
    end

Loading

Poem

A toggle for transitions, so neat and precise,
Now skipping unmounting is just a device.
With a hop and a flag, the animation can stay,
Or vanish at once, as you wish it to play.
🐇✨ Code hops along, transitions anew!

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3cb4db2 and 9fcf336.

📒 Files selected for processing (1)

• packages/runtime-core/src/components/BaseTransition.ts (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules
• GitHub Check: Header rules
• GitHub Check: Pages changed

🔇 Additional comments (4)

packages/runtime-core/src/components/BaseTransition.ts (4)

58-60: Well-documented property addition

The new skipUnmountingOptimization property is clearly documented with a descriptive comment that explains its purpose: to ignore unmount optimization and execute the full animation when set to true.

---

142-142: LGTM: Validator added for new prop

The validator for the new property has been correctly added to the BaseTransitionPropsValidators object with the appropriate type.

---

351-351: LGTM: Default value ensures backward compatibility

The new property is correctly destructured with a default value of false, which ensures backward compatibility with existing code that doesn't specify this property.

---

447-447:

✅ Verification successful

Core implementation looks good

The key functional change correctly modifies the condition in the leave hook to also check if skipUnmountingOptimization is false before bypassing the leave animation when unmounting. This allows developers to opt out of the default optimization and always run the leave animation, even during unmounting.

Let's verify that this is the only place in the codebase where the unmounting optimization is applied:

---

🏁 Script executed:

#!/bin/bash
# Search for other potential places where unmounting optimization might be applied
rg "isUnmounting" -A 5 -B 5

Length of output: 3321

---

Verified: Only one unmounting optimization spot in BaseTransition

I’ve confirmed that state.isUnmounting is only used in two places—its definition/init in useTransitionState and the single conditional in the leave hook:

• state.isUnmounting is set in onBeforeUnmount within useTransitionState.
• The only optimization check in the leave hook is at line 447:

  if (state.isUnmounting && !skipUnmountingOptimization) {
    return remove()
  }

No other occurrences of isUnmounting gate additional behavior. The change correctly scopes the unmounting optimization and allows opting out via skipUnmountingOptimization.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.