Skip to content

fix(hydration): handle empty content in Transition appear edge case #13396

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

edison1105
Copy link
Member

@edison1105 edison1105 commented May 28, 2025

close #13394

Summary by CodeRabbit

  • Bug Fixes
    • Improved node replacement logic to prevent errors when no new node is provided, ensuring smoother updates and reducing potential issues during hydration.
  • Tests
    • Added a test to verify correct handling of transitions with empty content during hydration, preventing mismatch warnings.

Copy link

coderabbitai bot commented May 28, 2025

"""

Walkthrough

The replaceNode function in the hydration logic was updated to check if the new node exists before attempting to replace the old node. If the new node is absent, the old node is simply removed, preventing errors from invalid node replacements during server-side rendering hydration. Additionally, a new test verifies that the <Transition appear> component correctly handles empty content during hydration without errors.

Changes

File(s) Change Summary
packages/runtime-core/src/hydration.ts Updated replaceNode to check for a valid new node before replacing, else remove the old node.
packages/runtime-core/tests/hydration.spec.ts Added test for <Transition appear> with empty content to ensure no hydration errors occur.

Sequence Diagram(s)

sequenceDiagram
    participant ParentNode
    participant OldNode
    participant NewNode

    alt NewNode exists
        ParentNode->>ParentNode: replaceChild(NewNode, OldNode)
    else NewNode is null/undefined
        ParentNode->>ParentNode: removeChild(OldNode)
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent SSR hydration error when replacing node with empty/invalid content (#13394)

Suggested labels

ready to merge, :hammer: p3-minor-bug

Poem

A hop, a skip, a gentle patch,
No more errors when nodes don’t match!
If new is missing, old hops away,
Hydration’s smooth, hooray, hooray!
With careful checks and tidy code,
This bunny’s proud of what’s bestowed. 🐇✨
"""


📜 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 a890378 and bd7d569.

📒 Files selected for processing (1)
  • packages/runtime-core/__tests__/hydration.spec.ts (1 hunks)
🔇 Additional comments (1)
packages/runtime-core/__tests__/hydration.spec.ts (1)

1680-1697: LGTM! Well-written test case for the empty content edge case.

This test properly covers the specific edge case mentioned in issue #13394 where a Transition with appear: true has empty content. The test:

  • Correctly sets up the scenario with empty template and null default slot
  • Uses appropriate assertions to verify the DOM state and vnode element reference
  • Importantly checks that no hydration mismatch warnings are emitted
  • Follows the existing test patterns and fits well within the transition test suite

The test complements the related fix in the replaceNode function and ensures that empty content during Transition appear is handled correctly during hydration.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Copy link

pkg-pr-new bot commented May 28, 2025

Open in StackBlitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@13396

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@13396

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@13396

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@13396

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@13396

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@13396

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@13396

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@13396

@vue/shared

npm i https://pkg.pr.new/@vue/shared@13396

vue

npm i https://pkg.pr.new/vue@13396

@vue/compat

npm i https://pkg.pr.new/@vue/compat@13396

commit: bd7d569

Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+9 B) 38.3 kB (+7 B) 34.5 kB (+19 B)
vue.global.prod.js 159 kB (+9 B) 58.5 kB (+8 B) 52.1 kB (+50 B)

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.6 kB 18.2 kB 16.7 kB
createApp 54.5 kB 21.2 kB 19.4 kB
createSSRApp 58.8 kB (+9 B) 23 kB (+6 B) 21 kB (+5 B)
defineCustomElement 59.5 kB 22.8 kB 20.8 kB
overall 68.6 kB 26.4 kB 24 kB

@edison1105 edison1105 added scope: transition 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope:hydration ready to merge The PR is ready to be merged. labels May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. ready to merge The PR is ready to be merged. scope:hydration scope: transition
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SSR hydration fails with <Transition appear> and empty content
1 participant