8000 fix(runtime-core): fix the issue of passing incorrect parentComponent to patch when KeepAlive is activated by yinhangfeng · Pull Request #13218 · vuejs/core · GitHub
[go: up one dir, main page]
Skip to content

fix(runtime-core): fix the issue of passing incorrect parentComponent to patch when KeepAlive is activated #13218

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(runtime-core): fix the issue of passing incorrect parentComponent to patch when KeepAlive is activated #13218

wants to merge 2 commits into from

Conversation

yinhangfeng
Copy link
@yinhangfeng yinhangfeng commented Apr 17, 2025 •
edited by coderabbitai bot
Loading

@edison1105
Copy link
Member
edison1105 commented Apr 18, 2025 •
edited
Loading

Thanks for the PR, but the reproduction doesn't make sense.

<KeepAlive>
    <Test1 v-if=\"flag\" :key=\"key\" />
    <Test2 v-else :key=\"key\" />
  </KeepAlive>

If the keys of if/else are different, there will be no issue.

@edison1105 edison1105 added the need more info Further information is requested label Apr 18, 2025
@yinhangfeng
Copy link
Author
yinhangfeng commented Apr 18, 2025 •
edited
Loading

Thanks for the PR, but the reproduction doesn't make sense.

<KeepAlive>
    <Test1 v-if=\"flag\" :key=\"key\" />
    <Test2 v-else :key=\"key\" />
  </KeepAlive>

If the keys of if/else are different, there will be no issue.

是的，这个例子是为了复现这个问题特意写的，实际情况下目前除了这样也几乎无法复现这个问题，但传给 patch 的 parentComponent 参数确实错了，主要是目前 patch 基本只在 mount 和 unmount 时使用到了 parentComponent，如果后续代码迭代中 patch 对传入的 parentComponent 有其它的使用方式就有可能会出现问题

@github-actions GitHub Actions
Copy link
github-actions bot commented Apr 18, 2025 •
edited
Loading

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+7 B) 38.3 kB (+3 B) 34.5 kB (+27 B)
vue.global.prod.js 159 kB (+7 B) 58.5 kB (+2 B) 52 kB (+8 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 23 kB 20.9 kB
defineCustomElement 59.5 kB 22.8 kB 20.8 kB
overall 68.7 kB (+7 B) 26.4 kB (+1 B) 24 kB (-67 B)

@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented Apr 18, 2025 •
edited
Loading

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 5466112

@edison1105
Copy link
Member

/ecosystem-ci run

@vue-bot
Copy link
Contributor
vue-bot commented Apr 18, 2025

📝 Ran ecosystem CI: Open

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

@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: keep-alive 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. and removed need more info Further information is requested labels Apr 18, 2025
@skirtles-code
Copy link
Contributor

I tried running the reproduction against the Netlify deployment of this PR, but I get Maximum call stack size exceeded:

I had a go at converting it to use render functions, as we might be able to adapt that for a unit test:

I'm also wondering whether there might be some overlap with #12915. They aren't exactly the same, but the fixes might end up being similar.

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

Walkthrough

The update changes the parent component context used in the patch function within the activate method of the KeepAlive component. Instead of passing the current component instance as the parent, it now passes the parent of the instance. No other logic or exported entity declarations are modified.

Changes

File(s) Change Summary
packages/runtime-core/src/components/KeepAlive.ts Modified the argument in the patch call within activate, passing instance.parent instead of instance. No other logic or exported entity changes.

Poem

A patch within KeepAlive’s nest,
Now calls on parent, not itself, for best.
With context shifted up a tree,
The roots grow strong, as code should be.
🐇✨

Hop along, dear patch, and see—
How tidy hierarchies can be!

📜 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 93949e6 and 5466112.

📒 Files selected for processing (1)
  • packages/runtime-core/src/components/KeepAlive.ts (1 hunks)
🔇 Additional comments (1)
packages/runtime-core/src/components/KeepAlive.ts (1)

141-151: Correct fix for parent component reference in KeepAlive's activate method.

This change properly fixes the incorrect parent component reference being passed to the patch function. Using instance.parent instead of instance ensures the correct component hierarchy is maintained during the patch operation.

This is important because:

  1. A component should not be passed as its own parent
  2. The correct parent reference ensures proper lifecycle hook invocation
  3. It prevents potential issues if future code changes rely more heavily on this parameter
✨ 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.

@yinhangfeng
Copy link
Author

I tried running the reproduction against the Netlify deployment of this PR, but I get Maximum 871E call stack size exceeded:

I had a go at converting it to use render functions, as we might be able to adapt that for a unit test:

I'm also wondering whether there might be some overlap with #12915. They aren't exactly the same, but the fixes might end up being similar.

This should be an issue with the reproduction example I provided. The KeepAlive activate passed to the patch's parentComponent only takes effect here. So I constructed such a reproduction example.

However, under normal circumstances, this branch will not be entered. So the issue fixed by this MR does not currently exist. It is only possible for the issue to occur if parentComponent is used elsewhere in the patch function in the future.

Regarding the issue of Maximum call stack size exceeded in the reproduction example I provided, this should be achievable by modifying the generation method of the cacheKey here to key+type. But for now, it doesn't seem necessary because it is caused by an abnormal usage after all.

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. ready to merge The PR is ready to be merged. scope: keep-alive
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@yinhangfeng @edison1105 @vue-bot @skirtles-code
0