feat(reactivity): untrack #13286

teleskop150750 · 2025-05-06T10:36:33Z

RFC vuejs/rfcs#747

Implementation

Allows access without dependency tracking

Summary by CodeRabbit

New Features
- Introduced a peek() method for refs and computed refs, allowing users to access current values without triggering reactivity.
- Added an untrack utility function to enable reading reactive values without establishing dependencies.
Tests
- Added comprehensive tests to verify the behavior of the new peek() method and the untrack utility, ensuring non-reactive access and correct caching behavior.

coderabbitai · 2025-05-06T10:36:39Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This change introduces a new peek() method to refs and computed refs, enabling non-reactive access to their current values. The untrack utility is also added to allow execution of code without dependency tracking. Comprehensive tests are included for both features, verifying their behavior and non-tracking semantics.

Changes

Files/Paths	Change Summary
packages/reactivity/src/computed.ts, packages/reactivity/src/ref.ts	Added `peek()` method to computed refs and refs, including interface and class updates for type safety and implementation.
packages/reactivity/src/effect.ts	Introduced `untrack` function to execute callbacks without tracking reactive dependencies.
packages/reactivity/src/index.ts	Exported `untrack` from the effect module to the public API.
packages/reactivity/tests/computed.spec.ts, packages/reactivity/tests/ref.spec.ts	Added test suites for `peek()` on computed refs and refs, verifying non-reactive value access and correct value updates.
packages/reactivity/tests/effect.spec.ts	Added test for `untrack` utility, confirming it prevents dependency tracking within effects.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Ref
    participant ComputedRef
    participant Effect

    User->>Ref: a = ref(1)
    User->>ComputedRef: c = computed(() => a.value + 1)
    User->>Ref: a.peek()
    Note right of Ref: Returns value without tracking
    User->>ComputedRef: c.peek()
    Note right of ComputedRef: Returns computed value without tracking
    User->>Effect: effect(() => { untrack(() => a.value) })
    Note right of Effect: Access inside untrack is not tracked

Suggested labels

ready to merge, scope: reactivity

Suggested reviewers

jh-leong

Poem

In the warren of code where the signals do sneak,
A rabbit now peeks with a new-fangled peek!
No more surprise hops when dependencies change—
With untrack in tow, your effects stay in range.
So nibble your carrots, your values are clear—
Non-reactive glances, with nothing to fear! 🥕✨

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

edison1105 · 2025-05-06T12:50:08Z

@teleskop150750
Thank you for your PR, this is a new feature that needs to be merged into the minor branch. You may need to merge the minor branch into your branch.

KazariEX · 2025-07-23T14:06:19Z

packages/reactivity/src/effect.ts

@@ -284,6 +284,15 @@ export function cleanup(
  }
 }

+export function untrack<T>(fn: () => T): T {


Could we consider using MaybeRefOrGetter<T> instead of () => T here?

Of course you can. But the utility won't be too overloaded from this. ?

I think we can just call toValue(source). In other words this will make it an untrack wrapper around toValue.

I understand you perfectly. In my mindset, passing Ref directly should be almost completely avoided. Therefore, the use of toValue is minimized. If necessary, the user can call it himself inside untrack, rather than doing it automatically each time. If you insist, I will add your edit.

It is just my opinion. I think I would prefer to hear what others think.

teleskop150750 added 2 commits May 6, 2025 13:30

feat: ref peek

cc326a7

feat: untrack

d089f23

feat: add untrack export

acf02a1

edison1105 added ✨ feature request New feature or request scope: reactivity need discussion labels May 6, 2025

edison1105 changed the base branch from main to minor May 6, 2025 12:46

edison1105 added the version: minor label May 6, 2025

teleskop150750 added 2 commits July 23, 2025 16:12

chore: remove peek

dc89e00

feat(runtime-core): add untrack

87e0d1d

teleskop150750 changed the title ~~feat(reactivity): untrack and peek for ref~~ feat(reactivity): untrack Jul 23, 2025

teleskop150750 added 3 commits July 23, 2025 16:56

chore: merge minor into branch

328607b

chore: revert auto format

ec0a97e

test(runtime-core): add untrack for computed

82914dc

KazariEX reviewed Jul 23, 2025

View reviewed changes

teleskop150750 added 2 commits July 23, 2025 17:06

chore: revert auto format

3973e6b

refactor(runtime-core): [untrack] use setActiveSub

bece02d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(reactivity): untrack #13286

feat(reactivity): untrack #13286

teleskop150750 commented May 6, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 6, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

edison1105 commented May 6, 2025

Uh oh!

KazariEX Jul 23, 2025

Uh oh!

teleskop150750 Jul 23, 2025 •

edited

Loading

Uh oh!

KazariEX Jul 23, 2025

Uh oh!

teleskop150750 Jul 23, 2025

Uh oh!

KazariEX Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

feat(reactivity): untrack #13286

Are you sure you want to change the base?

feat(reactivity): untrack #13286

Conversation

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

Uh oh!

Implementation

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Suggested labels

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

edison1105 commented May 6, 2025

Uh oh!

KazariEX Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

teleskop150750 Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KazariEX Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

teleskop150750 Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

KazariEX Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

teleskop150750 commented May 6, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

teleskop150750 Jul 23, 2025 •

edited

Loading