8000 dx(reactivity): warn on nested readonly ref update during unwrapping by jh-leong · Pull Request #12141 · vuejs/core · GitHub
[go: up one dir, main page]
Skip to content

dx(reactivity): warn on nested readonly ref update during unwrapping #12141

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

dx(reactivity): warn on nested readonly ref update during unwrapping #12141

wants to merge 5 commits into from

Conversation

jh-leong
Copy link
Member
@jh-leong jh-leong commented Oct 10, 2024 •
edited by coderabbitai bot
Loading

related to #12138

  1. Warn instead of throwing an error when updating a nested readonly ref, keeping consistency with the readonly API.
  2. Improved error message for better clarity.

Before: TypeError: 'set' on proxy: trap returned falsish for property 'foo'
After: [Vue warn] Set operation on key "foo" failed: target is readonly.

Summary by CodeRabbit

  • Bug Fixes
    • Updated behavior when attempting to assign a new value to a readonly ref within a reactive object. Instead of throwing an error, the system now issues a warning and ensures the value remains unchanged.

@github-actions GitHub Actions
Copy link
github-actions bot commented Oct 10, 2024 •
edited
Loading

Size Report

Bundles

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

Usages

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

@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented Oct 10, 2024 •
edited
Loading

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@12141
< 8000 p dir="auto">

@vue/compiler-ssr

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

@vue/compiler-sfc

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 57d78f2

@jh-leong jh-leong mentioned this pull request Oct 10, 2024
Closed
@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: reactivity 🧹 p1-chore Priority 1: this doesn't change code behavior. labels Oct 10, 2024
skirtles-code
skirtles-code reviewed May 24, 2025
View reviewed changes
packages/reactivity/src/baseHandlers.ts Outdated
if (__DEV__) {
warn(
`Set operation on key "${String(key)}" failed: target is readonly.`,
oldValue,
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it maybe be better to use target[key] here instead of oldValue, so the logged value includes the readonly wrapper?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the catch :) updated

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented May 25, 2025 •
edited
Loading

Walkthrough

The control flow for handling assignments to readonly ref properties within reactive objects was updated. Instead of throwing an error or returning false, the code now emits a warning in development mode and returns true. Corresponding tests were updated to check for the warning rather than expecting an exception.

Changes

Files/Groups Change Summary
packages/reactivity/src/baseHandlers.ts Modified set handler to emit a warning and return true instead of false on readonly ref writes.
packages/reactivity/tests/readonly.spec.ts Updated tests to expect a warning rather than an exception when writing to readonly ref properties.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ReactiveObject
    participant MutableReactiveHandler

    User->>ReactiveObject: Assign new value to readonly ref property
    ReactiveObject->>MutableReactiveHandler: set(property, newValue)
    MutableReactiveHandler-->>ReactiveObject: Check if old value is readonly ref
    alt If readonly ref and not array
        MutableReactiveHandler-->>User: Emit warning (in dev mode)
        MutableReactiveHandler-->>ReactiveObject: Return true
    else
        MutableReactiveHandler-->>ReactiveObject: Proceed with set operation
    end
Loading

Poem

In the garden of code where the reactivity grows,
A readonly ref stands firm, as everyone knows.
Now, if you try to change it, no error will fly—
Just a gentle warning, like a rabbit’s soft sigh.
The value stands steady, the message is clear,
Hopping forward with care, the code has no fear! 🐇✨

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9fa787c and 57d78f2.

📒 Files selected for processing (2)
  • packages/reactivity/__tests__/readonly.spec.ts (1 hunks)
  • packages/reactivity/src/baseHandlers.ts (1 hunks)
🔇 Additional comments (2)
packages/reactivity/src/baseHandlers.ts (1)

156-162: Excellent improvement for developer experience and API consistency.

The change from silently returning false to issuing a warning and returning true significantly improves the developer experience by providing clear feedback about readonly violations. This aligns perfectly with the existing ReadonlyReactiveHandler.set behavior (lines 229-237), creating consistent warning patterns across the reactivity system.

The warning message format is consistent and informative, clearly stating both the operation that failed and the reason for the failure.

packages/reactivity/__tests__/readonly.spec.ts (1)

499-502: Test correctly validates the new warning-based behavior.

The test update appropriately reflects the behavior change from throwing an exception to issuing a warning. The test now:

  1. Performs the assignment operation that triggers the readonly violation
  2. Verifies the correct warning message is emitted
  3. Confirms the readonly property value remains unchanged (line 503)

This comprehensive test coverage ensures the new warning behavior works as expected while maintaining readonly protection.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skirtles-code skirtles-code skirtles-code left review comments

Assignees
No one assigned
Labels
🧹 p1-chore Priority 1: this doesn't change code behavior. ready to merge The PR is ready to be merged. scope: reactivity
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

3 participants
@jh-leong @skirtles-code @edison1105
0