8000 fix(hmr): avoid hydration for hmr root reload by edison1105 · Pull Request #12450 · vuejs/core · GitHub
[go: up one dir, main page]
Skip to content

fix(hmr): avoid hydration for hmr root reload #12450

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
Merged
merged 7 commits into from
May 13, 2025
Merged

fix(hmr): avoid hydration for hmr root reload #12450

merged 7 commits into from
May 13, 2025

Conversation

edison1105
Copy link
Member
@edison1105 edison1105 commented Nov 21, 2024 •
edited by coderabbitai bot
Loading

close vitejs/vite-plugin-vue#146
close vitejs/vite-plugin-vue#477

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added a test to verify that Hot Module Replacement (HMR) can reload the root component during SSR hydration, ensuring updates are reflected without a full reload.

  • Bug Fixes

    • Improved HMR behavior by treating root components as fresh nodes during reloads, preventing issues with DOM element reuse.

@github-actions GitHub Actions
Copy link
github-actions bot commented Nov 21, 2024 •
edited
Loading

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB 38.2 kB 34.4 kB
vue.global.prod.js 159 kB 58.4 kB 51.9 kB

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.7 kB 23 kB 20.9 kB
defineCustomElement 59.3 kB 22.8 kB 20.8 kB
overall 68.6 kB 26.4 kB 24 kB

@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented Nov 21, 2024 •
edited
Loading

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-ssr

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

@vue/compiler-sfc

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: a0d7ed9

@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: hmr 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. labels Nov 21, 2024
@edison1105 edison1105 requested a review from Copilot November 21, 2024 07:30
Copilot
Copilot AI reviewed Nov 21, 2024
View reviewed changes
Copy link
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no suggestions.

@yooouuri
Copy link
yooouuri commented Feb 15, 2025 •
edited
Loading

This also fixes vitejs/vite-plugin-vue#525

Screen.Recording.2025-02-15.at.14.40.21.mov

create-vite-extra/template-ssr-vue example, before (see issue) and after see screencast

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

Caution

Review failed

The pull request is closed.

Walkthrough

A new SSR hydration test for Hot Module Replacement (HMR) root reload has been added, verifying that the root component can be reloaded and updated correctly. The HMR reload logic in the app mounting process has been modified to ensure the vnode's DOM element reference is cleared, preventing unwanted hydration during HMR updates.

Changes

File(s) Change Summary
packages/runtime-core/__tests__/hydration.spec.ts Added a test case for HMR root reload during SSR hydration, checking DOM updates after HMR reload.
packages/runtime-core/src/apiCreateApp.ts Modified HMR reload logic to set the cloned vnode's el property to null before rendering on reload.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Case
    participant App as App Instance
    participant HMR as HMR Runtime

    Test->>App: Mount SSR-hydrated component
    App->>Test: DOM contains <div>foo</div>
    Test->>HMR: Call reload with new component
    HMR->>App: Replace root vnode, set el = null, render
    App->>Test: DOM updates to <div>bar</div>
Loading

Assessment against linked issues

Objective Addressed Explanation
Fix HMR not working with useCssModule and SSR (#146, #477) ✅
Prevent hydration mismatches and ensure correct DOM updates on HMR reload with SSR (#477) ✅

Possibly related PRs

Poem

A bunny hops through code so bright,
Ensuring HMR now works right.
Hydration’s smooth, the DOM refreshed,
No mismatched classes, all addressed!
With every tick and little test,
The runtime core now works its best.
🐇✨

📜 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 5562a81 and a0d7ed9.

📒 Files selected for processing (1)
  • packages/runtime-core/__tests__/hydration.spec.ts (1 hunks)
✨ 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.

@edison1105
Copy link
Member Author

/ecosystem-ci run

@vue-bot
Copy link
Contributor
vue-bot commented May 13, 2025

📝 Ran ecosystem CI: Open

suite result latest scheduled
nuxt ✅ success ✅ success
quasar ✅ success ✅ success
pinia ✅ success ✅ success
primevue ✅ success ✅ success
test-utils ✅ success ✅ success
vite-plugin-vue ✅ success ✅ success
vant ✅ success ✅ success
router ✅ success ✅ success
language-tools ✅ success ✅ success
vue-macros ✅ success ✅ success
radix-vue ✅ success ✅ success
vue-simple-compiler ✅ success ✅ success
vuetify ✅ success ✅ success
vitepress ✅ success ✅ success
vue-i18n ✅ success ✅ success
vueuse ✅ success ✅ success

@edison1105 edison1105 merged commit 1f98a9c into main May 13, 2025
11 of 12 checks passed
@edison1105 edison1105 deleted the edison/fix/hmrRootReload branch May 13, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@LittleSound LittleSound LittleSound approved these changes

@baiwusanyu-c baiwusanyu-c baiwusanyu-c approved these changes

@Doctor-wu Doctor-wu Doctor-wu approved these changes

@KazariEX KazariEX KazariEX approved these changes

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. ready to merge The PR is ready to be merged. scope: hmr
Projects
None yet
Milestone
No milestone
7 participants
@edison1105 @yooouuri @vue-bot @LittleSound @baiwusanyu-c @Doctor-wu @KazariEX
0