Skip to content

fix(suspense): handle edge case in patching list nodes within Suspense #13306

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 3 commits into from
May 16, 2025

Conversation

edison1105
Copy link
Member

@edison1105 edison1105 commented May 11, 2025

close #13305

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced handling of suspense nodes for accurate rendering and updates in complex component structures.
  • Tests
    • Added tests validating Suspense behavior in dynamic lists with fallback display, resolution, and reordering in optimized mode.

Copy link

coderabbitai bot commented May 11, 2025

"""

Walkthrough

The update modifies the logic in the patchBlockChildren function within the renderer to include suspense nodes when determining the appropriate container for patching block children. This ensures that suspense nodes are handled consistently with components, teleports, and fragments during the patching process. Additionally, a new test case was added to verify correct rendering and reordering of Suspense-wrapped components nested in lists under optimized rendering mode.

Changes

File(s) Change Summary
packages/runtime-core/src/renderer.ts Updated the condition in patchBlockChildren to treat suspense nodes like components and teleports when selecting the container for patching children.
packages/runtime-core/tests/rendererOptimizedMode.spec.ts Added a test verifying Suspense components nested in keyed lists render correctly and reorder properly in optimized mode.

Assessment against linked issues

Objective Addressed Explanation
Properly handle rendering and scrambling of lists containing <Suspense>-wrapped components (#13305)

Poem

Oh, what suspense! The code did fret,
For lists with wrappers, errors were met.
But now the patching knows just how,
To treat suspense nodes—see it now!
No more scrambling in dismay,
Bugs hop away, hooray, hooray! 🐇✨
"""


📜 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 1a75217 and df9e05a.

📒 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 (1)
  • GitHub Check: test / unit-test-windows
✨ 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 11, 2025

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB (+1 B) 38.3 kB (+1 B) 34.5 kB (+9 B)
vue.global.prod.js 159 kB (+1 B) 58.4 kB (+1 B) 52 kB (-2 B)

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.6 kB (+1 B) 18.2 kB (+1 B) 16.7 kB
createApp 54.5 kB (+1 B) 21.2 kB (+1 B) 19.4 kB (-6 B)
createSSRApp 58.8 kB (+1 B) 23 kB (+2 B) 20.9 kB (+2 B)
defineCustomElement 59.5 kB (+1 B) 22.8 kB (+2 B) 20.8 kB (+10 B)
overall 68.6 kB (+1 B) 26.4 kB (+1 B) 24.1 kB (+16 B)

Copy link

pkg-pr-new bot commented May 11, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/runtime-core

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

@vue/reactivity

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: df9e05a

@edison1105 edison1105 changed the title fix(suspense): handle suspense patching fast path edge case with container determination fix(suspense): handle edge case in patching list nodes within Suspense May 11, 2025
@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: suspense 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. labels May 11, 2025
@edison1105
Copy link
Member Author

/ecosystem-ci run

@vue-bot
Copy link
Contributor

vue-bot commented May 16, 2025

📝 Ran ecosystem CI: Open

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

@edison1105 edison1105 merged commit 772b008 into main May 16, 2025
16 checks passed
@edison1105 edison1105 deleted the edison/fix/13305 branch May 16, 2025 00:32
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: suspense
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rendering a list of <Suspense>-wrapped components fails
2 participants