fix(runtime-core): handle null props in component FULL_PROPS patch #13329

jh-leong · 2025-05-15T04:40:54Z

Summary by CodeRabbit

Bug Fixes
- Improved component update logic to ensure correct handling when properties are added, removed, or set to null, resulting in more accurate DOM updates.
Tests
- Added a new test to verify that components update correctly when switching between null and non-null properties.

coderabbitai · 2025-05-15T04:41:00Z

Walkthrough

A new test was added to verify component updates when props transition between null and non-null with PatchFlags.FULL_PROPS. The shouldUpdateComponent function was updated to symmetrically handle cases where either previous or next props are null, ensuring correct component update decisions in these scenarios.

Changes

File(s)	Change Summary
packages/runtime-core/tests/rendererOptimizedMode.spec.ts	Added a test for component updates with `PatchFlags.FULL_PROPS` when props toggle between null/non-null.
packages/runtime-core/src/componentRenderUtils.ts	Updated `shouldUpdateComponent` to symmetrically check for null/undefined `prevProps` and `nextProps`.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite as Test Suite
    participant Renderer as Renderer
    participant Comp as Component

    TestSuite->>Renderer: renderWithBlock(Comp, null props, PatchFlags.FULL_PROPS)
    Renderer->>Comp: Render <p>
    Renderer->>TestSuite: <div><p></p></div>

    TestSuite->>Renderer: renderWithBlock(Comp, {foo: 'true'}, PatchFlags.FULL_PROPS)
    Renderer->>Comp: Render <p foo="true">
    Renderer->>TestSuite: <div><p foo="true"></p></div>

    TestSuite->>Renderer: renderWithBlock(Comp, null props, PatchFlags.FULL_PROPS)
    Renderer->>Comp: Render <p>
    Renderer->>TestSuite: <div><p></p></div>

Assessment against linked issues

Objective	Addressed	Explanation
Fix error when v-bind="data" transitions between null and object props (#13328)	✅
Ensure shouldUpdateComponent handles null/undefined prevProps and nextProps correctly (#13328)	✅

Poem

A patch for props, both null and not,
Ensures our updates never forgot.
With tests that check each edge and seam,
The renderer now works like a dream.
So here’s a hop, a skip, a cheer—
No more errors, code is clear!
🐇✨

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.

📜 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 d0253a0 and 952c517.

📒 Files selected for processing (2)

packages/runtime-core/__tests__/rendererOptimizedMode.spec.ts (1 hunks)
packages/runtime-core/src/componentRenderUtils.ts (1 hunks)

⏰ 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 / unit-test-windows

🔇 Additional comments (2)

packages/runtime-core/src/componentRenderUtils.ts (1)

395-397: Excellent fix for handling null props symmetrically

This change adds the necessary symmetrical check for when nextProps is falsy but prevProps exists, which complements the existing check for when prevProps is falsy. This ensures component updates are correctly triggered when props transition from non-null to null, not just from null to non-null.

packages/runtime-core/__tests__/rendererOptimizedMode.spec.ts (1)

224-241: Good test case covering the null props handling

This test correctly verifies that components with PatchFlags.FULL_PROPS can handle transitions between null and non-null props in both directions:

Initial render with null props

Update with non-null props ({ foo: 'true' })

Update back to null props

The assertions verify that DOM updates occur correctly in each case, confirming the fix in shouldUpdateComponent works as intended.

✨ 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-05-15T04:41:52Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+6 B)	38.2 kB (+2 B)	34.5 kB (+68 B)
vue.global.prod.js	159 kB (+6 B)	58.4 kB (+6 B)	52 kB (+11 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB (+6 B)	18.2 kB (+4 B)	16.7 kB (-1 B)
createApp	54.5 kB (+6 B)	21.2 kB (+5 B)	19.4 kB (-7 B)
createSSRApp	58.7 kB (+6 B)	23 kB (+6 B)	20.9 kB (+8 B)
defineCustomElement	59.3 kB (+6 B)	22.8 kB (+4 B)	20.8 kB (+5 B)
overall	68.6 kB (+6 B)	26.4 kB (+4 B)	24.1 kB (+68 B)

pkg-pr-new · 2025-05-15T04:42:00Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-ssr

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

@vue/compiler-sfc

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

@vue/compat

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

vue

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

commit: 952c517

jh-leong · 2025-05-15T04:44:36Z

/ecosystem-ci run

vue-bot · 2025-05-15T04:50:39Z

📝 Ran ecosystem CI: Open

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

fix(runtime-core): handle null props in component FULL_PROPS patch

952c517

jh-leong closed this May 15, 2025

jh-leong deleted the fix/13328 branch May 15, 2025 04:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(runtime-core): handle null props in component FULL_PROPS patch #13329

fix(runtime-core): handle null props in component FULL_PROPS patch #13329

jh-leong commented May 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 15, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented May 15, 2025

pkg-pr-new bot commented May 15, 2025

jh-leong commented May 15, 2025

vue-bot commented May 15, 2025

fix(runtime-core): handle null props in component FULL_PROPS patch #13329

fix(runtime-core): handle null props in component FULL_PROPS patch #13329

Conversation

jh-leong commented May 15, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented May 15, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented May 15, 2025

Size Report

Bundles

Usages

pkg-pr-new bot commented May 15, 2025

jh-leong commented May 15, 2025

vue-bot commented May 15, 2025

jh-leong commented May 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)