feat(reactivity): untrack and peek for ref

[teleskop150750]

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]

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

Loading

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! 🥕✨

---

📜 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 d089f23 and acf02a1.

📒 Files selected for processing (1)

• packages/reactivity/src/index.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• packages/reactivity/src/index.ts

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules
• GitHub Check: Header rules
• GitHub Check: Pages changed

✨ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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]

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