Skip to content

fix(compat): ensure false value on input value retains attribute #13216

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 Apr 17, 2025

close #13205

Summary by CodeRabbit

  • Bug Fixes

    • Prevented removal of the value attribute from <input> elements when bound to false, ensuring it remains as "false" and no warning is shown.
  • Tests

    • Added a test to confirm that binding false to the value attribute on <input> elements behaves correctly and does not trigger a warning.

@edison1105 edison1105 changed the title fix(compat): ensure false value on input retains value attribute fix(compat): ensure false value on input value retains attribute Apr 17, 2025
Copy link

github-actions bot commented Apr 17, 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 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 Apr 17, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 6196ff6

@edison1105 edison1105 marked this pull request as ready for review April 17, 2025 07:59
@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 Apr 17, 2025
Copy link

coderabbitai bot commented May 20, 2025

Walkthrough

The update adjusts the compatibility logic for handling attribute coercion in the runtime. Specifically, it prevents the removal of the value attribute from <input> elements when bound to false, ensuring correct behavior. A targeted test case is added to verify this exception and confirm no deprecation warning is triggered in this scenario.

Changes

File(s) Change Summary
packages/runtime-dom/src/modules/attrs.ts Modified compatCoerceAttr to exclude <input value="false"> from attribute removal and warning logic.
packages/vue-compat/tests/misc.spec.ts Added a test to verify <input :value="false"> retains the attribute and does not trigger a warning.

Assessment against linked issues

Objective Addressed Explanation
Prevent ATTR_FALSE_VALUE compat logic from removing value attribute on inputs (#13205)
Ensure no deprecation warning is triggered for <input :value="false"> with compat flag (#13205)

Poem

A bunny hopped with code so neat,
Fixing input values—what a treat!
No more false alarms or warnings loud,
The value stays, the bunny’s proud.
With tests in place, the bugs retreat,
🐇✨—this patch is truly sweet!

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

@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__/misc.spec.ts (1)

219-219: Consider using a more specific type than 'Function'

The static analysis tool flagged the use of Function as a type, which is generally discouraged in TypeScript. Consider explicitly defining the function shape for better type safety.

- (deprecationData[DeprecationTypes.ATTR_FALSE_VALUE].message as Function)(
+ (deprecationData[DeprecationTypes.ATTR_FALSE_VALUE].message as (arg: string) => string)(
🧰 Tools
🪛 Biome (1.9.4)

[error] 219-219: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

📜 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 35aeae7 and 6196ff6.

📒 Files selected for processing (2)
  • packages/runtime-dom/src/modules/attrs.ts (1 hunks)
  • packages/vue-compat/__tests__/misc.spec.ts (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
packages/vue-compat/__tests__/misc.spec.ts

[error] 219-219: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

🔇 Additional comments (2)
packages/runtime-dom/src/modules/attrs.ts (1)

82-82: Good fix for handling false value on input elements

This change correctly implements an exception for input elements with value="false", ensuring the attribute is retained rather than being removed. This fix addresses the issue where setting a false value on an input would incorrectly remove the attribute entirely.

packages/vue-compat/__tests__/misc.spec.ts (1)

211-223: Appropriate test case to validate the fix

This test properly verifies that:

  1. The value attribute is retained when set to false on an input element
  2. The attribute value is correctly set to the string "false"
  3. No deprecation warning is emitted in this specific case

The test is well-structured and provides good coverage for the implemented fix.

🧰 Tools
🪛 Biome (1.9.4)

[error] 219-219: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

@edison1105
Copy link
Member Author

/ecosystem-ci run

@vue-bot
Copy link
Contributor

vue-bot commented May 20, 2025

📝 Ran ecosystem CI: Open

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

@edison1105 edison1105 merged commit 1a66474 into main May 20, 2025
16 checks passed
@edison1105 edison1105 deleted the edison/fix/13205 branch May 20, 2025 00:43
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.

compat: ATTR_FALSE_VALUE incorrectly removes value attribute on inputs
3 participants