fix(compiler-core): avoid cached text vnodes retaining detached DOM nodes #13662

edison1105 · 2025-07-19T14:48:07Z

Summary by CodeRabbit

New Features
- Improved caching for certain text nodes, potentially enhancing rendering performance in specific scenarios.
Tests
- Added an end-to-end test to ensure cached text nodes do not cause memory leaks during component toggling.

coderabbitai · 2025-07-19T14:48:14Z

"""

Walkthrough

The update modifies the walk function in cacheStatic.ts to append the PatchFlags.CACHED flag to JS_CALL_EXPRESSION nodes within TEXT_CALL nodes that are eligible for caching. It also adds a new end-to-end test to verify that cached text virtual nodes do not retain detached DOM nodes, addressing a memory leak issue (#13661). The import statement is updated to include PatchFlagNames from @vue/shared.

Changes

File(s)	Change Summary
packages/compiler-core/src/transforms/cacheStatic.ts	Enhanced `walk` to add `PatchFlags.CACHED` to certain `JS_CALL_EXPRESSION` nodes; updated import
packages/vue/tests/e2e/memory-leak.spec.ts	Added new e2e test verifying no memory leak from cached text VNodes detaching DOM nodes

Sequence Diagram(s)

sequenceDiagram
    participant walk as walk (cacheStatic.ts)
    participant node as TEXT_CALL Node
    participant codegen as JS_CALL_EXPRESSION
    participant PatchFlags

    walk->>node: Inspect children
    alt child is JS_CALL_EXPRESSION and eligible for caching
        walk->>codegen: Append PatchFlags.CACHED to arguments
        walk->>toCache: Push child
    end

Suggested labels

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

Suggested reviewers

skirtles-code

Poem

A tweak in the cache, a flag in the call,
Now static text nodes stand tall.
With CACHED attached, they’re easy to track,
No more detached h1s lurking in the back!
🐇✨
Code hops ahead, bug on the run—
Another fix, another job well done!
"""

📜 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 4cb6a4f and 163ee95.

📒 Files selected for processing (1)

packages/vue/__tests__/e2e/memory-leak.spec.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/vue/__tests__/e2e/memory-leak.spec.ts (1)

packages/vue/__tests__/e2e/e2eUtils.ts (2)

setupPuppeteer (55-224)

E2E_TIMEOUT (8-8)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

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

🔇 Additional comments (6)

packages/vue/__tests__/e2e/memory-leak.spec.ts (6)

1-11: LGTM! Proper E2E test setup.

The imports and test setup are well-structured, correctly loading Vue globally and initializing the test environment in the beforeEach hook.

13-17: Clear test structure with good traceability.

The test structure is well-organized with a descriptive name and proper issue reference (#13661) for traceability.

18-55: Well-designed memory leak test setup.

The Vue app configuration effectively tests the memory leak scenario with:

Large reactive array (3000 items) for detectable memory footprint

WeakRef for proper garbage collection detection

Conditional rendering to test component cleanup

The use of window.__REF__ and @ts-expect-error suppressions are acceptable for testing purposes.

57-66: Comprehensive initial state validation.

The assertion correctly validates the complete rendered HTML structure, ensuring the test setup is working properly before testing the memory leak scenario.

68-71: Proper component removal validation.

The toggle operation correctly tests component cleanup, and the assertion properly validates that only the button and Vue's conditional comment remain after the component is removed.

73-84: Robust memory leak detection implementation.

The garbage collection detection mechanism is well-implemented:

Uses WeakRef correctly to detect object cleanup

Manually triggers GC via Chrome DevTools Protocol

Includes proper timeout handling with E2E_TIMEOUT

Validates that the detached DOM nodes are properly garbage collected

This approach effectively verifies the fix for issue #13661.

✨ 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 · 2025-07-19T14:49:04Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB	38.4 kB	34.6 kB
vue.global.prod.js	159 kB (+94 B)	58.5 kB (+21 B)	52.1 kB (+50 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.5 kB	18.2 kB	16.7 kB
createApp	54.5 kB	21.2 kB	19.4 kB
createSSRApp	58.7 kB	22.9 kB	20.9 kB
defineCustomElement	59.5 kB	22.8 kB	20.8 kB
overall	68.5 kB	26.4 kB	24 kB

pkg-pr-new · 2025-07-19T14:49:18Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: ceca3bd

edison1105 · 2025-07-20T02:00:14Z

/ecosystem-ci run

vue-bot · 2025-07-20T02:19:19Z

📝 Ran ecosystem CI: Open

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

edison1105 force-pushed the edison/fix/13661 branch from 002e0c6 to d3be633 Compare July 19, 2025 14:58

fix(compiler-core): add cache flag for createTextVNode

4cb6a4f

edison1105 force-pushed the edison/fix/13661 branch from d3be633 to 4cb6a4f Compare July 19, 2025 15:02

edison1105 changed the title ~~fix(compiler-core): add cache flag for createTextVNode~~ fix(compiler-core): avoid cached text vnodes retaining detached DOM nodes Jul 20, 2025

test(e2e): add memory leak test for cached text vnodes

163ee95

edison1105 added ready to merge The PR is ready to be merged. scope: compiler ❗ p4-important Priority 4: this fixes bugs that violate documented behavior, or significantly improves perf. labels Jul 20, 2025

Merge branch 'main' into edison/fix/13661

ceca3bd

edison1105 merged commit 00695a5 into main Jul 23, 2025
16 checks passed

edison1105 deleted the edison/fix/13661 branch July 23, 2025 00:36

coderabbitai bot mentioned this pull request Jul 24, 2025

fix(compiler-core): prevent cached array children from retaining detached dom nodes #13691

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(compiler-core): avoid cached text vnodes retaining detached DOM nodes #13662

fix(compiler-core): avoid cached text vnodes retaining detached DOM nodes #13662

edison1105 commented Jul 19, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 19, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Jul 19, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Jul 19, 2025 •

edited

Loading

Uh oh!

edison1105 commented Jul 20, 2025

Uh oh!

vue-bot commented Jul 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(compiler-core): avoid cached text vnodes retaining detached DOM nodes #13662

fix(compiler-core): avoid cached text vnodes retaining detached DOM nodes #13662

Conversation

edison1105 commented Jul 19, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Suggested labels

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report

Bundles

Usages

Uh oh!

pkg-pr-new bot commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edison1105 commented Jul 20, 2025

Uh oh!

vue-bot commented Jul 20, 2025

Uh oh!

Uh oh!

Uh oh!

edison1105 commented Jul 19, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Jul 19, 2025 •

edited

Loading

pkg-pr-new bot commented Jul 19, 2025 •

edited

Loading