refactor(runtime-core): revert setup() result reactive conversion
BREAKING CHANGE: revert setup() result reactive conversion Revert6b10f0c
&a840e7d
. The motivation of the original change was avoiding unnecessary deep conversions, but that can be achieved by explicitly marking values non-reactive via `markNonReactive`. Removing the reactive conversion behavior leads to an usability issue in that plain objects containing refs (which is what most composition functions will return), when exposed as a nested property from `setup()`, will not unwrap the refs in templates. This goes against the "no .value in template" intuition and the only workaround requires users to manually wrap it again with `reactive()`. So in this commit we are reverting to the previous behavior where objects returned from `setup()` are implicitly wrapped with `reactive()` for deep ref unwrapping.
This commit is contained in:
parent
11d2fb2594
commit
e67f655b26
@ -1,5 +1,6 @@
|
||||
import { VNode, VNodeChild, isVNode } from './vnode'
|
||||
import {
|
||||
reactive,
|
||||
ReactiveEffect,
|
||||
shallowReadonly,
|
||||
pauseTracking,
|
||||
@ -398,7 +399,7 @@ export function handleSetupResult(
|
||||
}
|
||||
// setup returned bindings.
|
||||
// assuming a render function compiled from template is present.
|
||||
instance.renderContext = setupResult
|
||||
instance.renderContext = reactive(setupResult)
|
||||
} else if (__DEV__ && setupResult !== undefined) {
|
||||
warn(
|
||||
`setup() should return an object. Received: ${
|
||||
@ -474,10 +475,6 @@ function finishComponentSetup(
|
||||
currentInstance = null
|
||||
currentSuspense = null
|
||||
}
|
||||
|
||||
if (instance.renderContext === EMPTY_OBJ) {
|
||||
instance.renderContext = {}
|
||||
}
|
||||
}
|
||||
|
||||
// used to identify a setup context proxy
|
||||
|
@ -8,14 +8,7 @@ import {
|
||||
ComputedOptions,
|
||||
MethodOptions
|
||||
} from './apiOptions'
|
||||
import {
|
||||
ReactiveEffect,
|
||||
isRef,
|
||||
isReactive,
|
||||
Ref,
|
||||
ComputedRef,
|
||||
unref
|
||||
} from '@vue/reactivity'
|
||||
import { ReactiveEffect, UnwrapRef } from '@vue/reactivity'
|
||||
import { warn } from './warning'
|
||||
import { Slots } from './componentSlots'
|
||||
import {
|
||||
@ -48,17 +41,11 @@ export type ComponentPublicInstance<
|
||||
$nextTick: typeof nextTick
|
||||
$watch: typeof instanceWatch
|
||||
} & P &
|
||||
UnwrapSetupBindings<B> &
|
||||
UnwrapRef<B> &
|
||||
D &
|
||||
ExtractComputedReturns<C> &
|
||||
M
|
||||
|
||||
type UnwrapSetupBindings<B> = { [K in keyof B]: UnwrapBinding<B[K]> }
|
||||
|
||||
type UnwrapBinding<B> = B extends ComputedRef<any>
|
||||
? B extends ComputedRef<infer V> ? V : B
|
||||
: B extends Ref<infer V> ? V : B
|
||||
|
||||
const publicPropertiesMap: Record<
|
||||
string,
|
||||
(i: ComponentInternalInstance) => any
|
||||
@ -115,7 +102,7 @@ export const PublicInstanceProxyHandlers: ProxyHandler<any> = {
|
||||
case AccessTypes.DATA:
|
||||
return data[key]
|
||||
case AccessTypes.CONTEXT:
|
||||
return unref(renderContext[key])
|
||||
return renderContext[key]
|
||||
case AccessTypes.PROPS:
|
||||
return propsProxy![key]
|
||||
// default: just fallthrough
|
||||
@ -123,9 +110,9 @@ export const PublicInstanceProxyHandlers: ProxyHandler<any> = {
|
||||
} else if (data !== EMPTY_OBJ && hasOwn(data, key)) {
|
||||
accessCache![key] = AccessTypes.DATA
|
||||
return data[key]
|
||||
} else if (hasOwn(renderContext, key)) {
|
||||
} else if (renderContext !== EMPTY_OBJ && hasOwn(renderContext, key)) {
|
||||
accessCache![key] = AccessTypes.CONTEXT
|
||||
return unref(renderContext[key])
|
||||
return renderContext[key]
|
||||
} else if (type.props != null) {
|
||||
// only cache other properties when instance has declared (this stable)
|
||||
// props
|
||||
@ -180,19 +167,7 @@ export const PublicInstanceProxyHandlers: ProxyHandler<any> = {
|
||||
if (data !== EMPTY_OBJ && hasOwn(data, key)) {
|
||||
data[key] = value
|
||||
} else if (hasOwn(renderContext, key)) {
|
||||
// context is already reactive (user returned reactive object from setup())
|
||||
// just set directly
|
||||
if (isReactive(renderContext)) {
|
||||
renderContext[key] = value
|
||||
} else {
|
||||
// handle potential ref set
|
||||
const oldValue = renderContext[key]
|
||||
if (isRef(oldValue) && !isRef(value)) {
|
||||
oldValue.value = value
|
||||
} else {
|
||||
renderContext[key] = value
|
||||
}
|
||||
}
|
||||
renderContext[key] = value
|
||||
} else if (key[0] === '$' && key.slice(1) in target) {
|
||||
__DEV__ &&
|
||||
warn(
|
||||
|
@ -4,7 +4,6 @@ import {
|
||||
defineComponent,
|
||||
PropType,
|
||||
ref,
|
||||
Ref,
|
||||
reactive,
|
||||
createApp
|
||||
} from './index'
|
||||
@ -65,15 +64,12 @@ describe('with object props', () => {
|
||||
// setup context
|
||||
return {
|
||||
c: ref(1),
|
||||
d: reactive({
|
||||
d: {
|
||||
e: ref('hi')
|
||||
}),
|
||||
},
|
||||
f: reactive({
|
||||
g: ref('hello' as GT)
|
||||
}),
|
||||
h: {
|
||||
i: ref('hi')
|
||||
}
|
||||
})
|
||||
}
|
||||
},
|
||||
render() {
|
||||
@ -106,9 +102,6 @@ describe('with object props', () => {
|
||||
expectType<string>(this.d.e)
|
||||
expectType<GT>(this.f.g)
|
||||
|
||||
// should not unwrap refs nested under non-reactive objects
|
||||
expectType<Ref<string>>(this.h.i)
|
||||
|
||||
// setup context properties should be mutable
|
||||
this.c = 2
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user