Skip to content

fix(runtime-core): unset old ref during patching when new ref is absent #12900

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 4 commits into from
Jun 5, 2025
Merged

fix(runtime-core): unset old ref during patching when new ref is absent #12900

merged 4 commits into from
Jun 5, 2025

Conversation

inottn
Copy link
Contributor

@inottn inottn commented Feb 17, 2025 •
edited by coderabbitai bot
Loading

fix #12898

Summary by CodeRabbit

  • Bug Fixes

    • Ensured that template refs are properly cleared when they are conditionally removed, preventing stale references.

  • Tests

    • Added a test to verify that refs are unset when no longer assigned.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Feb 17, 2025 •
edited
Loading

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 6e146ce

edison1105
edison1105 reviewed Feb 18, 2025
View reviewed changes
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 18, 2025 •
edited
Loading

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+46 B) 38.4 kB (+17 B) 34.6 kB (-6 B)
vue.global.prod.js 159 kB (+46 B) 58.5 kB (+17 B) 52.1 kB (+68 B)

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.6 kB (+46 B) 18.2 kB (+18 B) 16.7 kB (+13 B)
createApp 54.6 kB (+46 B) 21.3 kB (+18 B) 19.4 kB (+14 B)
createSSRApp 58.9 kB (+46 B) 23 kB (+17 B) 21 kB (+22 B)
defineCustomElement 59.6 kB (+46 B) 22.9 kB (+23 B) 20.8 kB (+17 B)
overall 68.7 kB (+46 B) 26.4 kB (+19 B) 24.1 kB (+80 B)

@edison1105 edison1105 added ready to merge The PR is ready to be merged. 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. labels Feb 18, 2025
@edison1105 edison1105 changed the title fix(runtime-core): handle ref unmounting in conditional updates fix(runtime-core): unset old ref during patching when new ref is absent Jun 4, 2025
edison1105
edison1105 reviewed Jun 4, 2025
View reviewed changes
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 4, 2025 •
edited
Loading

Walkthrough

The changes introduce logic to ensure that template refs are properly unset (set to null) when they are conditionally removed in the rendering process. This is achieved by updating the renderer to explicitly clear refs when they become absent and adding a test case to verify this behavior.

Changes

File(s) Change Summary
packages/runtime-core/src/renderer.ts Enhanced ref management: explicitly unsets old refs when new ref is absent during vnode patching.
packages/runtime-core/tests/rendererTemplateRef.spec.ts Added a test case to verify that refs are unset (set to null) when conditionally removed from the template.

Sequence Diagram(s)

sequenceDiagram
    participant Component
    participant Renderer
    participant Ref

    Component->>Renderer: Render with ref present
    Renderer->>Ref: Set ref to DOM element

    Component->>Renderer: Re-render with ref absent
    Renderer->>Ref: Unset old ref (set to null)
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure template ref is set to null after conditional rendering removes the ref (#12898) ✅
Prevent stale references when ref is removed in updated render (#12898) ✅
Add test coverage verifying ref is unset when conditionally removed (#12898) ✅

Poem

A toggle of refs, now set to null,
No more stale links, the logic is full.
With tests to confirm, the patch is complete,
The renderer's tidy, no ghosts in the suite!
🐇✨

— A happy CodeRabbit

📜 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 7e78cd7 and 6e146ce.

📒 Files selected for processing (1)
  • packages/runtime-core/src/renderer.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/runtime-core/src/renderer.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test / unit-test-windows
  • GitHub Check: test / e2e-test
  • GitHub Check: continuous-release
✨ 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
🪧 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 edison1105 merged commit 47ddf98 into vuejs:main Jun 5, 2025
14 checks passed
@inottn inottn deleted the fix/ref-unmount branch June 5, 2025 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edison1105 edison1105 edison1105 left review comments

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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

The template ref was not set to null correctly after the conditional rendering was updated
2 participants
@inottn @edison1105