Skip to content

fix(teleport): handle deferred teleport updates before and after mount #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

Merged
merged 2 commits into from
May 20, 2025

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 accurate mounted state tracking during updates.
  • Tests
    • Added a new test verifying multiple updates before and after a deferred Teleport mounts, ensuring correct content rendering and model binding.

Copy link

coderabbitai bot commented May 17, 2025

"""

Walkthrough

This change refines the handling of the __isMounted flag on Teleport vnode root elements during deferred mounting and updates. The flag is explicitly set to false before queuing post-render effects and deleted instead of set to true after mounting. The update condition now checks for __isMounted === false. A new test verifies deferred Teleport updates before and after mount. No API signatures changed.

Changes

File(s) Change Summary
packages/runtime-core/src/components/Teleport.ts Modified __isMounted flag handling for deferred Teleport vnode root elements; updated mount and update logic.
packages/runtime-core/tests/components/Teleport.spec.ts Added test case for deferred Teleport updates occurring before and after mount with reactive bindings.

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

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ 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

github-actions bot commented May 17, 2025

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+6 B) 38.3 kB (+5 B) 34.5 kB (-15 B)
vue.global.prod.js 159 kB (+6 B) 58.5 kB (+5 B) 52 kB (+1 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: 034d1fc

@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
@edison1105 edison1105 changed the title fix(teleport): handle deferred teleport multiple updates before mounted fix(teleport): handle deferred teleport updates before and after mount May 18, 2025
@edison1105
Copy link
Member Author

/ecosystem-ci run

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/runtime-core/src/components/Teleport.ts (1)

170-170: Consider using assignment to undefined instead of delete.

The delete operator can have performance implications, as flagged by the static analysis tool. Consider using n2.el!.__isMounted = undefined instead, which achieves similar semantics but with better performance characteristics.

-          delete n2.el!.__isMounted
+          n2.el!.__isMounted = undefined
🧰 Tools
🪛 Biome (1.9.4)

[error] 170-170: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

📜 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 8c0d9e9 and 034d1fc.

📒 Files selected for processing (2)
  • packages/runtime-core/__tests__/components/Teleport.spec.ts (2 hunks)
  • packages/runtime-core/src/components/Teleport.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/runtime-core/tests/components/Teleport.spec.ts
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/runtime-core/src/components/Teleport.ts (1)
packages/runtime-core/src/renderer.ts (1)
  • queuePostRenderEffect (286-295)
🪛 Biome (1.9.4)
packages/runtime-core/src/components/Teleport.ts

[error] 170-170: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

⏰ 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/src/components/Teleport.ts (2)

167-167: Good addition of explicit initialization flag.

This explicitly sets the __isMounted flag to false before queueing the post-render effect, making the mounting state tracking clearer. This helps ensure the deferred teleport knows its initial state before any updates occur.


176-176: Improved condition for deferred teleport processing.

The updated condition now explicitly checks both that the teleport is deferred AND that it hasn't been mounted yet (__isMounted === false). This correctly handles the case where updates might occur before the teleport has fully mounted.

I recommend adding a comment explaining this logic for future maintainers:

+      // Only process deferred teleports that haven't been mounted yet
       if (isTeleportDeferred(n2.props) && n1.el!.__isMounted === false) {

@vue-bot
Copy link
Contributor

vue-bot commented May 20, 2025

📝 Ran ecosystem CI: Open

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

@edison1105 edison1105 merged commit d15dce3 into main May 20, 2025
16 checks passed
@edison1105 edison1105 deleted the edison/fix/13349 branch May 20, 2025 00:27
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
2 participants