fix(reactivity): readonly ref able to trigger by `triggerRef` #12804

serkodev · 2025-02-02T17:29:55Z

This PR adds dep to isNonTrackableKeys so that the readonly proxy does not convert dep to a readonly value, allowing it to be triggered by triggerRef.

Summary by CodeRabbit

Tests
- Added a new test to verify manual triggering of effects on readonly shallowRefs using explicit triggers.
Chores
- Introduced an internal property for improved handling within the system; no impact on end-user functionality.

github-actions · 2025-02-02T17:30:52Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+17 B)	38.3 kB (+6 B)	34.6 kB (+15 B)
vue.global.prod.js	159 kB (+17 B)	58.5 kB (+5 B)	52.1 kB (-22 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB (+17 B)	18.2 kB (+6 B)	16.7 kB (+11 B)
createApp	54.6 kB (+17 B)	21.2 kB (+8 B)	19.4 kB
createSSRApp	58.8 kB (+17 B)	23 kB (+5 B)	21 kB (+11 B)
defineCustomElement	59.5 kB (+17 B)	22.8 kB (+5 B)	20.8 kB (+6 B)
overall	68.7 kB (+17 B)	26.4 kB (+5 B)	24.1 kB (-36 B)

pkg-pr-new · 2025-02-02T17:31:06Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 4f28b45

packages/reactivity/src/baseHandlers.ts

This reverts commit fafbea7.

edison1105 · 2025-02-03T13:40:51Z

/ecosystem-ci run

edison1105 · 2025-02-03T13:41:11Z

LGTM

vue-bot · 2025-02-03T13:47:26Z

📝 Ran ecosystem CI: Open

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

skirtles-code

Using __v_skip looks like a good approach to me.

The test is outside the describe section, it should probably be moved inside.

The PR description also needs updating to reflect the latest code.

packages/reactivity/__tests__/readonly.spec.ts

Co-authored-by: skirtle <[email protected]>

coderabbitai · 2025-05-30T06:43:49Z

Walkthrough

A new test case was added to the readonly reactivity test suite to verify that effects can be manually triggered on a readonly shallowRef using triggerRef. Additionally, a new internal readonly property __v_skip was introduced to the Dep class in the reactivity source code.

Changes

File(s)	Change Summary
packages/reactivity/tests/readonly.spec.ts	Added a test case for manually triggering effects on readonly shallowRef using `triggerRef`.
packages/reactivity/src/dep.ts	Added internal readonly property `__v_skip: true` to the `Dep` class with a JSDoc and TODO note.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Case
    participant Ref as shallowRef (original)
    participant Readonly as readonly(shallowRef)
    participant Effect as Effect

    Test->>Ref: Create shallowRef({ n: 1 })
    Test->>Readonly: Wrap with readonly
    Test->>Effect: Setup effect tracking Readonly.value.n
    Test->>Ref: Mutate Ref.value.n++
    Effect-->>Test: No update triggered
    Test->>Readonly: triggerRef(Readonly)
    Effect-->>Test: Effect re-runs and observes updated value

Assessment against linked issues

Objective	Addressed	Explanation
Ensure `triggerRef` can trigger effects on a readonly ref (#12803)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation

Suggested labels

scope: reactivity

Poem

In the warren of code, a test hops anew,
Readonly refs now trigger, as all rabbits knew.
A skip flag was added—so sly and discreet,
Ensuring reactivity is robust and neat.
With a twitch of the nose and a hop in the grass,
This patch helps your signals update and pass! 🐇✨

📜 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 22f359b and 4f28b45.

📒 Files selected for processing (2)

packages/reactivity/__tests__/readonly.spec.ts (2 hunks)
packages/reactivity/src/dep.ts (1 hunks)

🔇 Additional comments (3)

packages/reactivity/src/dep.ts (1)

96-100: LGTM: Skip marker addition aligns with PR objectives.

The addition of the __v_skip property correctly implements the fix to prevent readonly proxy conversion of the dep property, enabling proper triggerRef functionality on readonly refs.

Note that the TODO comment indicates this is a temporary implementation pending isolatedDeclarations support.

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

11-13: LGTM: Required imports correctly added.

The shallowRef and triggerRef imports are necessary for the new test case and are properly placed in the existing import structure.

526-537: Excellent test coverage for the triggerRef fix.

This test comprehensively validates the PR's objective by:

Creating a readonly wrapper around a shallowRef

Verifying that direct mutations don't trigger effects (expected behavior)

Confirming that triggerRef can properly trigger effects on readonly refs

The test correctly uses shallowRef instead of regular ref, which is essential for demonstrating this specific behavior where nested property changes don't automatically trigger effects.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

serkodev added 2 commits February 3, 2025 01:25

fix: add dep to isNonTrackableKeys

fafbea7

test: add triggerRef test for readonly shallowRef

f88bfc0

skirtles-code reviewed Feb 2, 2025

View reviewed changes

packages/reactivity/src/baseHandlers.ts Outdated Show resolved Hide resolved

edison1105 added 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. wait changes labels Feb 3, 2025

serkodev added 2 commits February 3, 2025 21:15

Revert "fix: add dep to isNonTrackableKeys"

43b798b

This reverts commit fafbea7.

feat: add __v_skip to Dep

3be87c1

serkodev requested review from edison1105 and skirtles-code February 3, 2025 13:18

edison1105 added ready to merge The PR is ready to be merged. and removed wait changes labels Feb 3, 2025

edison1105 approved these changes Feb 3, 2025

View reviewed changes

edison1105 changed the title ~~fix: readonly ref able to trigger by triggerRef~~ fix(reactivity): readonly ref able to trigger by triggerRef Feb 3, 2025

skirtles-code reviewed May 30, 2025

View reviewed changes

packages/reactivity/__tests__/readonly.spec.ts Outdated Show resolved Hide resolved

Update packages/reactivity/__tests__/readonly.spec.ts

4f28b45

Co-authored-by: skirtle <[email protected]>

edison1105 approved these changes Jun 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(reactivity): readonly ref able to trigger by `triggerRef` #12804

fix(reactivity): readonly ref able to trigger by `triggerRef` #12804

Uh oh!

serkodev commented Feb 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Feb 2, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Feb 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

edison1105 commented Feb 3, 2025

Uh oh!

edison1105 commented Feb 3, 2025

Uh oh!

vue-bot commented Feb 3, 2025

Uh oh!

skirtles-code left a comment

Uh oh!

Uh oh!

coderabbitai bot commented May 30, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

fix(reactivity): readonly ref able to trigger by triggerRef #12804

Are you sure you want to change the base?

fix(reactivity): readonly ref able to trigger by triggerRef #12804

Uh oh!

Conversation

serkodev commented Feb 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

github-actions bot commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report

Bundles

Usages

Uh oh!

pkg-pr-new bot commented Feb 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

edison1105 commented Feb 3, 2025

Uh oh!

edison1105 commented Feb 3, 2025

Uh oh!

vue-bot commented Feb 3, 2025

Uh oh!

skirtles-code left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Suggested labels

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

fix(reactivity): readonly ref able to trigger by `triggerRef` #12804

fix(reactivity): readonly ref able to trigger by `triggerRef` #12804

serkodev commented Feb 2, 2025 •

edited by coderabbitai bot

Loading

github-actions bot commented Feb 2, 2025 •

edited

Loading

pkg-pr-new bot commented Feb 2, 2025 •

edited

Loading

coderabbitai bot commented May 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)