Skip to content

fix(compat): should not warn COMPILER_V_BIND_OBJECT_ORDER when using v-bind together with v-for #12993

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 4 commits into from
May 22, 2025

Conversation

yangxiuxiu1115
Copy link
Contributor

@yangxiuxiu1115 yangxiuxiu1115 commented Mar 4, 2025

fix #12992

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of v-bind with objects inside v-for loops to ensure compatibility warnings are not incorrectly triggered.
  • Tests

    • Added a test case to confirm that deprecation warnings are not emitted when using v-bind with an object inside a v-for loop.

Copy link

github-actions bot commented Mar 4, 2025

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB 38.3 kB 34.5 kB
vue.global.prod.js 159 kB 58.5 kB 52.1 kB

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 Mar 4, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-ssr

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

@vue/compiler-sfc

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

@vue/compat

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

vue

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

commit: b2d878e

@yangxiuxiu1115
Copy link
Contributor Author

Perhaps it would be more appropriate to skip the v-for when check it

@edison1105 edison1105 added ready to merge The PR is ready to be merged. 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope: v2 compat labels Mar 4, 2025
Copy link

coderabbitai bot commented May 22, 2025

Walkthrough

The changes update the compiler's handling of v-bind within v-for loops to ensure compatibility logic is processed before pushing related markers and merge arguments. Additionally, a new test verifies that no deprecation warning is emitted when using v-bind with an object inside a v-for loop, addressing a previously reported issue.

Changes

Files/Paths Change Summary
packages/compiler-core/src/transforms/transformElement.ts Reordered calls to compatibility logic, pushRefVForMarker(), and pushMergeArg() in buildProps for correct handling of v-bind within v-for.
packages/vue-compat/tests/compiler.spec.ts Added a test to ensure no deprecation warning is triggered for v-bind with an object in a v-for loop.

Sequence Diagram(s)

sequenceDiagram
    participant TemplateParser
    participant buildProps
    participant CompatibilityChecker

    TemplateParser->>buildProps: Process v-bind in v-for
    buildProps->>CompatibilityChecker: Run compatibility check
    CompatibilityChecker-->>buildProps: Compatibility logic (may modify mergeArgs)
    buildProps->>buildProps: pushRefVForMarker()
    buildProps->>buildProps: pushMergeArg()
Loading

Assessment against linked issues

Objective Addressed Explanation
No deprecation warning for v-bind with object inside v-for (#12992)

Poem

In the fields of v-for, where bindings grow,
A marker hops in, but warnings stay low.
With logic reordered and tests in the sun,
The compiler now knows when warnings are none.
🐇✨ No more false alarms—just code on the run!

✨ 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

@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/vue-compat/__tests__/compiler.spec.ts (1)

96-104: Good test for verifying the fix

This test correctly verifies that no deprecation warning is emitted when using v-bind with an object inside a v-for loop, addressing the issue described in the PR.

Consider a minor grammatical improvement to the test name:

-test('should not warn COMPILER_V_BIND_OBJECT_ORDER work with vFor', () => {
+test('should not warn COMPILER_V_BIND_OBJECT_ORDER when used with vFor', () => {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b708cf and 51fb524.

📒 Files selected for processing (2)
  • packages/compiler-core/src/transforms/transformElement.ts (2 hunks)
  • packages/vue-compat/__tests__/compiler.spec.ts (1 hunks)
🔇 Additional comments (2)
packages/compiler-core/src/transforms/transformElement.ts (2)

598-599: LGTM - Merging early for compat build check

Adding the early merge step here ensures proper handling of compatibility checks before performing other operations, which prevents the incorrect COMPILER_V_BIND_OBJECT_ORDER warning when v-bind appears before v-for.


642-644:

✅ Verification successful

Correct sequencing of pushRefVForMarker and pushMergeArg

This reordering ensures that the ref marker for v-for and merge arguments are processed before pushing the expression, which correctly handles the case when v-bind is used with v-for. The added comment also helpfully documents the reasoning.

Could you verify whether the earlier call to pushMergeArg() on line 644 might now be redundant in non-compat builds? It seems like it could potentially be moved inside the if (__COMPAT__) { check, since for non-compat builds we would only need a single call.


🏁 Script executed:

#!/bin/bash
# Check for other usages of pushMergeArg to understand its behavior
rg -A 5 -B 5 "pushMergeArg" packages/compiler-core/src/transforms/transformElement.ts

Length of output: 2193


Keep pushMergeArg() outside __COMPAT__
The call inside if (__COMPAT__) { … } only runs in compatibility builds; the subsequent pushMergeArg() immediately after pushRefVForMarker() is required in non-compat builds to flush pending props before pushing the v-bind expression. Removing or moving it into the compat block would break non-compat behavior.

@edison1105 edison1105 changed the title fix(compat): handle v-bind before v-for still throws COMPILER_V_BIND_OBJECT_ORDER warn fix(compat): should not warn COMPILER_V_BIND_OBJECT_ORDER when using v-bind together with v-for May 22, 2025
@edison1105 edison1105 merged commit 93949e6 into vuejs:main May 22, 2025
14 checks passed
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: v2 compat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error tip during vue2 upgrade to vue3
3 participants