8000 fix(hydration): handle transition appear hydration edge case by edison1105 · Pull Request #13339 · vuejs/core · GitHub
[go: up one dir, main page]
Skip to content

fix(hydration): handle transition appear hydration edge case #13339

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

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

fix(hydration): handle transition appear hydration edge case #13339

wants to merge 2 commits into from

Conversation

edison1105
Copy link
Member
@edison1105 edison1105 commented May 16, 2025 •
edited by coderabbitai bot
Loading

close #13335

Summary by CodeRabbit

  • New Features
    • Improved class attribute handling during hydration, resulting in more accurate detection of class mismatches on elements.
  • Bug Fixes
    • Enhanced reliability when checking for class mismatches, reducing potential hydration inconsistencies.
  • Tests
    • Added a test to ensure class attributes are correctly preserved and combined during transition hydration with pre-existing classes.

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented May 16, 2025 •
edited
Loading

"""

Walkthrough

The changes implement a caching mechanism for the class attribute during hydration, specifically storing the initial class value on the first child of a hydrated <template>. The propHasMismatch function is updated to utilize this cached value for more accurate class mismatch detection, with the element type signature adjusted accordingly.

Changes

File(s) Change Summary
packages/runtime-core/src/hydration.ts Added caching of initial class attribute as $cls on first child of hydrated <template> elements; updated propHasMismatch to use this cache and revised its type signature.
packages/runtime-core/tests/hydration.spec.ts Added test case verifying that <Transition appear> preserves pre-existing classes during hydration without mismatch warnings.

Sequence Diagram(s)

sequenceDiagram
    participant Hydrator as Hydration Process
    participant Template as <template> Element
    participant Child as First Child Element
    participant MismatchCheck as propHasMismatch

    Hydrator->>Template: Hydrate content
    Template->>Child: Assign $cls with initial class attribute
    Hydrator->>MismatchCheck: Check for class mismatch
    MismatchCheck->>Child: Retrieve $cls (if present)
    MismatchCheck->>Child: Fallback to class attribute if $cls not present
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent hydration mismatch for class attribute in <Transition appear> with SSR (#13335) ✅

Poem

A class was once lost in the SSR mist,
Hydration would grumble, "Something's been missed!"
Now with a cache, mismatches are few—
The DOM and the client both stick like glue.
🐇✨
Hooray for the fix, from this coding rabbit to you!
"""

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 26a579b and f5998fb.

📒 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)

1657-1678: Well-structured test for the transition appear hydration edge case.

This test effectively validates that elements with pre-existing classes maintain those classes when hydrated inside a Transition component with the appear prop. The test correctly ensures that both the original "foo" class and the transition-specific classes ("v-enter-from" and "v-enter-active") are preserved during hydration without any mismatch warnings.

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

@github-actions GitHub Actions
Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+33 B) 38.3 kB (+17 B) 34.5 kB (+16 B)
vue.global.prod.js 159 kB (+33 B) 58.5 kB (+15 B) 52.1 kB (+109 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 (+33 B) 23 kB (+14 B) 20.9 kB (+14 B)
defineCustomElement 59.5 kB 22.8 kB 20.8 kB
overall 68.6 kB 26.4 kB 24.1 kB

@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented May 16, 2025 •
edited
Loading

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: f5998fb

@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 labels May 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope:hydration scope: transition
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

<Transition appear> leads to hydration mismatch with SSR
1 participant
@edison1105
0