Skip to content

fix(teleport): handle deferred teleport multiple updates before mounted #13350

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.

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

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

Conversation

edison1105
Copy link
Member

@edison1105 edison1105 commented May 17, 2025

close #13349

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of deferred Teleport components to ensure content mounts correctly and only once when required.
  • Tests
    • Added a new test verifying multiple updates before a deferred Teleport mounts, ensuring correct content rendering and model binding.

Copy link

coderabbitai bot commented May 17, 2025

"""

Walkthrough

This change adds explicit tracking of the mounted state for Teleport vnode root elements using a new __isMounted boolean property. The mounting logic for deferred Teleports is updated to use this property, clarifying when post-render effects should be queued. A new test case was added to verify multiple updates before a deferred Teleport is mounted. No exported or public API signatures are modified.

Changes

File(s) Change Summary
packages/runtime-core/src/components/Teleport.ts Added __isMounted property to track Teleport root element mount state and clarified update logic.
packages/runtime-core/tests/components/Teleport.spec.ts Added a new test case for multiple updates before mount in deferred Teleport mode.

Assessment against linked issues

Objective Addressed Explanation
Prevent infinite recursion in Teleport with defer prop (#13349)

Poem

A Teleport hops from here to there,
But now it knows just when to care—
Mounted or not, it keeps its state,
So infinite loops no longer await!
With a bunny’s hop and a coder’s mind,
Bugs like these are left behind.
🐇✨
"""


📜 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 109d1d8 and d4d1990.

📒 Files selected for processing (1)
  • packages/runtime-core/__tests__/components/Teleport.spec.ts (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/runtime-core/__tests__/components/Teleport.spec.ts (3)
packages/runtime-core/src/index.ts (1)
  • h (109-109)
packages/runtime-core/src/vnode.ts (3)
  • Fragment (63-68)
  • createTextVNode (752-754)
  • createCommentVNode (773-782)
packages/runtime-core/src/components/Teleport.ts (1)
  • Teleport (479-487)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
  • GitHub Check: test / e2e-test
🔇 Additional comments (2)
packages/runtime-core/__tests__/components/Teleport.spec.ts (2)

19-19: Good addition to imports.

Adding the useModel import is necessary for the new test case.


149-203: Well-structured test case for fixing the infinite recursion issue.

This test case effectively reproduces and verifies the fix for issue #13349 by creating a scenario with multiple reactive updates before a deferred Teleport is mounted. The test:

  1. Sets up staggered updates (show teleport after 5ms, then update content after 10ms)
  2. Uses useModel for two-way binding to test reactivity behavior
  3. Verifies both initial and final DOM states

The test confirms that multiple updates before mounting a deferred teleport don't cause infinite recursion and correctly reflect the latest state once mounted, which aligns with the PR's objective.

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

Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+26 B) 38.3 kB (+8 B) 34.5 kB (-15 B)
vue.global.prod.js 159 kB (+26 B) 58.5 kB (+6 B) 52 kB (-4 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.6 kB 26.4 kB 24.1 kB

Copy link

pkg-pr-new bot commented May 17, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-ssr

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

@vue/compiler-sfc

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: d4d1990

@edison1105 edison1105 changed the title fix(teleport): avoid infinite recursion in process when teleport is deferred fix(teleport): handle deferred teleport multiple updates before mounted May 18, 2025
@edison1105 edison1105 added scope: teleport 🔨 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. labels May 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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: teleport
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Teleport defer causes infinite recursion
1 participant