fix(types): unwrap custom symbols in Reactive #13740

DrJume · 2025-08-07T19:37:32Z

When using reactive() with an object that has symbol keys whose values are Refs, the runtime correctly unwraps those Refs (except for built-in well-known symbols), but the TypeScript type for Reactive<> does not reflect this behavior.

As a result, TypeScript still infers the property type as Ref<...> even though at runtime you receive the raw value.

Reproduction

import { reactive, ref } from '@vue/reactivity'

const S = Symbol('custom')

const state = reactive({
  [S]: ref(123),
})

state[S] // runtime: 123 (number), type: Ref<number> ❌

This PR fixes this issue by changing the symbol checking logic in Reactive<> to only match builtin/well-known symbols. A test is added as well.

Summary by CodeRabbit

Tests
- Added tests to verify that reactive objects correctly unwrap both string-keyed and custom symbol-keyed properties.
Refactor
- Improved type handling for symbol-keyed properties, ensuring only built-in symbols are excluded from unwrapping while custom symbols are now unwrapped as expected.

coderabbitai · 2025-08-07T19:37:40Z

Walkthrough

A new test suite was added to verify that reactive unwrapping works for custom symbol keys as well as string keys. The internal type logic for unwrapping was updated to only exclude built-in symbol keys (not all symbols) from recursive unwrapping. A new exported type alias, BuiltinSymbols, was introduced to represent built-in symbol values.

Changes

Cohort / File(s)	Change Summary
Test for symbol-keyed unwrapping `packages-private/dts-test/reactivity.test-d.ts`	Added a test suite to check that custom symbol and string keys in a reactive object are correctly unwrapped to their underlying value types.
BuiltinSymbols type introduction `packages/reactivity/src/baseHandlers.ts`	Introduced and exported the `BuiltinSymbols` type, extracting built-in symbol values from the global `Symbol` object.
UnwrapRef type logic update `packages/reactivity/src/ref.ts`	Modified the `UnwrapRefSimple<T>` type to only exclude built-in symbol keys (via `BuiltinSymbols`) from recursive unwrapping, allowing custom symbol keys to be unwrapped as well.

Sequence Diagram(s)

sequenceDiagram
    participant Tester
    participant ReactiveSystem
    participant TypeSystem

    Tester->>ReactiveSystem: Create reactive object with custom symbol and string keys (ref values)
    ReactiveSystem->>TypeSystem: Apply UnwrapRefSimple logic
    TypeSystem->>TypeSystem: Exclude built-in symbol keys from unwrapping
    TypeSystem->>TypeSystem: Recursively unwrap custom symbol and string keys
    TypeSystem-->>ReactiveSystem: Return object with unwrapped values
    ReactiveSystem-->>Tester: Access properties, verify types are unwrapped

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A symbol hops in fields anew,
Not just built-in, but custom too!
With types unwrapped, the tests all cheer,
For clarity in code is here.
🐇✨
Now every key—be it string or sign—
Unwraps its value, crisp and fine!

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

📜 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 1d247f4 and 0a83288.

📒 Files selected for processing (1)

packages-private/dts-test/reactivity.test-d.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages-private/dts-test/reactivity.test-d.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

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

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate unit tests to generate unit tests for 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.

github-actions · 2025-08-07T19:38:33Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB	38.4 kB	34.6 kB
vue.global.prod.js	159 kB	58.6 kB	52.2 kB

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB	18.2 kB	16.7 kB
createApp	54.6 kB	21.2 kB	19.4 kB
createSSRApp	58.8 kB	23 kB	20.9 kB
defineCustomElement	59.6 kB	22.8 kB	20.8 kB
overall	68.7 kB	26.4 kB	24.1 kB

pkg-pr-new · 2025-08-07T19:38:45Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 0a83288

edison1105 · 2025-08-08T00:46:46Z

/ecosystem-ci run

vue-bot · 2025-08-08T00:53:53Z

📝 Ran ecosystem CI: Open

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

fix(types): unwrap custom symbols in Reactive

1d247f4

test: verify builtin symbol is not unwrapped

0a83288

edison1105 added scope: reactivity scope: types labels Aug 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(types): unwrap custom symbols in Reactive #13740

fix(types): unwrap custom symbols in Reactive #13740

DrJume commented Aug 7, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 7, 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!

github-actions bot commented Aug 7, 2025

Uh oh!

pkg-pr-new bot commented Aug 7, 2025 •

edited

Loading

Uh oh!

edison1105 commented Aug 8, 2025

Uh oh!

vue-bot commented Aug 8, 2025

Uh oh!

Uh oh!

Uh oh!

fix(types): unwrap custom symbols in Reactive #13740

Are you sure you want to change the base?

fix(types): unwrap custom symbols in Reactive #13740

Conversation

DrJume commented Aug 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reproduction

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Aug 7, 2025

Size Report

Bundles

Usages

Uh oh!

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

Uh oh!

Uh oh!

edison1105 commented Aug 8, 2025

Uh oh!

vue-bot commented Aug 8, 2025

Uh oh!

Uh oh!

DrJume commented Aug 7, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Aug 7, 2025 •

edited

Loading