2019-08-23 21:38:32 +08:00
|
|
|
import { reactive, readonly, toRaw } from './reactive'
|
2019-12-04 00:30:24 +08:00
|
|
|
import { TrackOpTypes, TriggerOpTypes } from './operations'
|
|
|
|
import { track, trigger, ITERATE_KEY } from './effect'
|
2018-09-19 23:35:38 +08:00
|
|
|
import { LOCKED } from './lock'
|
2020-01-24 02:42:31 +08:00
|
|
|
import { isObject, hasOwn, isSymbol, hasChanged, isArray } from '@vue/shared'
|
2019-08-16 21:42:46 +08:00
|
|
|
import { isRef } from './ref'
|
2018-09-19 23:35:38 +08:00
|
|
|
|
|
|
|
const builtInSymbols = new Set(
|
|
|
|
Object.getOwnPropertyNames(Symbol)
|
|
|
|
.map(key => (Symbol as any)[key])
|
2019-10-09 23:49:23 +08:00
|
|
|
.filter(isSymbol)
|
2018-09-19 23:35:38 +08:00
|
|
|
)
|
|
|
|
|
2019-12-21 00:16:46 +08:00
|
|
|
const get = /*#__PURE__*/ createGetter()
|
2020-02-04 23:15:27 +08:00
|
|
|
const shallowReactiveGet = /*#__PURE__*/ createGetter(false, true)
|
2019-12-21 00:16:46 +08:00
|
|
|
const readonlyGet = /*#__PURE__*/ createGetter(true)
|
|
|
|
const shallowReadonlyGet = /*#__PURE__*/ createGetter(true, true)
|
2019-12-21 00:14:07 +08:00
|
|
|
|
2020-02-22 00:48:39 +08:00
|
|
|
const arrayInstrumentations: Record<string, Function> = {}
|
2020-01-24 02:42:31 +08:00
|
|
|
;['includes', 'indexOf', 'lastIndexOf'].forEach(key => {
|
2020-02-22 00:48:39 +08:00
|
|
|
arrayInstrumentations[key] = function(...args: any[]): any {
|
|
|
|
const arr = toRaw(this) as any
|
|
|
|
for (let i = 0, l = (this as any).length; i < l; i++) {
|
|
|
|
track(arr, TrackOpTypes.GET, i + '')
|
|
|
|
}
|
2020-03-07 00:10:02 +08:00
|
|
|
// we run the method using the orignal args first (which may be reactive)
|
|
|
|
const res = arr[key](...args)
|
|
|
|
if (res === -1 || res === false) {
|
|
|
|
// if that didn't work, run it again using raw values.
|
|
|
|
return arr[key](...args.map(toRaw))
|
|
|
|
} else {
|
|
|
|
return res
|
|
|
|
}
|
2020-01-24 02:42:31 +08:00
|
|
|
}
|
|
|
|
})
|
|
|
|
|
2019-12-21 00:14:07 +08:00
|
|
|
function createGetter(isReadonly = false, shallow = false) {
|
2019-10-22 23:26:48 +08:00
|
|
|
return function get(target: object, key: string | symbol, receiver: object) {
|
2020-02-22 00:48:39 +08:00
|
|
|
if (isArray(target) && hasOwn(arrayInstrumentations, key)) {
|
|
|
|
return Reflect.get(arrayInstrumentations, key, receiver)
|
2020-01-24 02:42:31 +08:00
|
|
|
}
|
2019-12-06 07:10:06 +08:00
|
|
|
const res = Reflect.get(target, key, receiver)
|
2019-10-09 23:49:23 +08:00
|
|
|
if (isSymbol(key) && builtInSymbols.has(key)) {
|
2018-09-21 21:52:46 +08:00
|
|
|
return res
|
|
|
|
}
|
2019-12-03 03:11:12 +08:00
|
|
|
if (shallow) {
|
2019-12-04 00:30:24 +08:00
|
|
|
track(target, TrackOpTypes.GET, key)
|
2019-12-03 03:11:12 +08:00
|
|
|
// TODO strict mode that returns a shallow-readonly version of the value
|
|
|
|
return res
|
|
|
|
}
|
2020-02-22 00:48:39 +08:00
|
|
|
// ref unwrapping, only for Objects, not for Arrays.
|
|
|
|
if (isRef(res) && !isArray(target)) {
|
2019-12-03 03:11:12 +08:00
|
|
|
return res.value
|
2019-05-29 17:36:53 +08:00
|
|
|
}
|
2019-12-04 00:30:24 +08:00
|
|
|
track(target, TrackOpTypes.GET, key)
|
2018-10-17 03:47:51 +08:00
|
|
|
return isObject(res)
|
2019-08-23 21:38:32 +08:00
|
|
|
? isReadonly
|
|
|
|
? // need to lazy access readonly and reactive here to avoid
|
2018-09-21 21:52:46 +08:00
|
|
|
// circular dependency
|
2019-08-23 21:38:32 +08:00
|
|
|
readonly(res)
|
2019-08-16 21:42:46 +08:00
|
|
|
: reactive(res)
|
2018-09-21 21:52:46 +08:00
|
|
|
: res
|
2018-09-19 23:35:38 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-12-21 00:16:46 +08:00
|
|
|
const set = /*#__PURE__*/ createSetter()
|
2020-02-04 23:15:27 +08:00
|
|
|
const shallowReactiveSet = /*#__PURE__*/ createSetter(false, true)
|
2019-12-21 00:16:46 +08:00
|
|
|
const readonlySet = /*#__PURE__*/ createSetter(true)
|
|
|
|
const shallowReadonlySet = /*#__PURE__*/ createSetter(true, true)
|
2019-12-21 00:14:07 +08:00
|
|
|
|
|
|
|
function createSetter(isReadonly = false, shallow = false) {
|
|
|
|
return function set(
|
|
|
|
target: object,
|
|
|
|
key: string | symbol,
|
|
|
|
value: unknown,
|
|
|
|
receiver: object
|
|
|
|
): boolean {
|
|
|
|
if (isReadonly && LOCKED) {
|
|
|
|
if (__DEV__) {
|
|
|
|
console.warn(
|
|
|
|
`Set operation on key "${String(key)}" failed: target is readonly.`,
|
|
|
|
target
|
|
|
|
)
|
|
|
|
}
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
const oldValue = (target as any)[key]
|
|
|
|
if (!shallow) {
|
|
|
|
value = toRaw(value)
|
2020-02-22 00:48:39 +08:00
|
|
|
if (!isArray(target) && isRef(oldValue) && !isRef(value)) {
|
2019-12-21 00:14:07 +08:00
|
|
|
oldValue.value = value
|
|
|
|
return true
|
2018-09-19 23:35:38 +08:00
|
|
|
}
|
|
|
|
} else {
|
2019-12-21 00:14:07 +08:00
|
|
|
// in shallow mode, objects are set as-is regardless of reactive or not
|
|
|
|
}
|
|
|
|
|
|
|
|
const hadKey = hasOwn(target, key)
|
|
|
|
const result = Reflect.set(target, key, value, receiver)
|
|
|
|
// don't trigger if target is something up in the prototype chain of original
|
|
|
|
if (target === toRaw(receiver)) {
|
2020-02-21 22:05:16 +08:00
|
|
|
if (!hadKey) {
|
|
|
|
trigger(target, TriggerOpTypes.ADD, key, value)
|
|
|
|
} else if (hasChanged(value, oldValue)) {
|
|
|
|
trigger(target, TriggerOpTypes.SET, key, value, oldValue)
|
2018-09-19 23:35:38 +08:00
|
|
|
}
|
|
|
|
}
|
2019-12-21 00:14:07 +08:00
|
|
|
return result
|
2018-09-19 23:35:38 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-10-22 23:26:48 +08:00
|
|
|
function deleteProperty(target: object, key: string | symbol): boolean {
|
2019-09-06 08:48:14 +08:00
|
|
|
const hadKey = hasOwn(target, key)
|
2019-10-22 23:26:48 +08:00
|
|
|
const oldValue = (target as any)[key]
|
2018-09-19 23:35:38 +08:00
|
|
|
const result = Reflect.deleteProperty(target, key)
|
2019-10-09 23:55:57 +08:00
|
|
|
if (result && hadKey) {
|
2020-02-21 22:05:16 +08:00
|
|
|
trigger(target, TriggerOpTypes.DELETE, key, undefined, oldValue)
|
2018-09-19 23:35:38 +08:00
|
|
|
}
|
|
|
|
return result
|
|
|
|
}
|
|
|
|
|
2019-10-22 23:26:48 +08:00
|
|
|
function has(target: object, key: string | symbol): boolean {
|
2018-09-19 23:35:38 +08:00
|
|
|
const result = Reflect.has(target, key)
|
2019-12-04 00:30:24 +08:00
|
|
|
track(target, TrackOpTypes.HAS, key)
|
2018-09-19 23:35:38 +08:00
|
|
|
return result
|
|
|
|
}
|
|
|
|
|
2019-10-22 23:26:48 +08:00
|
|
|
function ownKeys(target: object): (string | number | symbol)[] {
|
2019-12-04 00:30:24 +08:00
|
|
|
track(target, TrackOpTypes.ITERATE, ITERATE_KEY)
|
2018-09-19 23:35:38 +08:00
|
|
|
return Reflect.ownKeys(target)
|
|
|
|
}
|
|
|
|
|
2019-10-22 23:26:48 +08:00
|
|
|
export const mutableHandlers: ProxyHandler<object> = {
|
2019-12-21 00:14:07 +08:00
|
|
|
get,
|
2018-09-19 23:35:38 +08:00
|
|
|
set,
|
|
|
|
deleteProperty,
|
|
|
|
has,
|
|
|
|
ownKeys
|
|
|
|
}
|
|
|
|
|
2019-10-22 23:26:48 +08:00
|
|
|
export const readonlyHandlers: ProxyHandler<object> = {
|
2019-12-21 00:14:07 +08:00
|
|
|
get: readonlyGet,
|
|
|
|
set: readonlySet,
|
|
|
|
has,
|
|
|
|
ownKeys,
|
2019-10-22 23:26:48 +08:00
|
|
|
deleteProperty(target: object, key: string | symbol): boolean {
|
2018-09-19 23:35:38 +08:00
|
|
|
if (LOCKED) {
|
|
|
|
if (__DEV__) {
|
2018-09-21 04:18:22 +08:00
|
|
|
console.warn(
|
2019-10-06 23:26:33 +08:00
|
|
|
`Delete operation on key "${String(
|
|
|
|
key
|
|
|
|
)}" failed: target is readonly.`,
|
2018-09-21 04:18:22 +08:00
|
|
|
target
|
|
|
|
)
|
2018-09-19 23:35:38 +08:00
|
|
|
}
|
|
|
|
return true
|
|
|
|
} else {
|
|
|
|
return deleteProperty(target, key)
|
|
|
|
}
|
2019-12-21 00:14:07 +08:00
|
|
|
}
|
2018-09-19 23:35:38 +08:00
|
|
|
}
|
2019-11-07 01:51:06 +08:00
|
|
|
|
2020-02-04 23:15:27 +08:00
|
|
|
export const shallowReactiveHandlers: ProxyHandler<object> = {
|
|
|
|
...mutableHandlers,
|
|
|
|
get: shallowReactiveGet,
|
|
|
|
set: shallowReactiveSet
|
|
|
|
}
|
|
|
|
|
2020-01-28 04:15:13 +08:00
|
|
|
// Props handlers are special in the sense that it should not unwrap top-level
|
2019-11-07 01:51:06 +08:00
|
|
|
// refs (in order to allow refs to be explicitly passed down), but should
|
|
|
|
// retain the reactivity of the normal readonly object.
|
2019-12-03 03:11:12 +08:00
|
|
|
export const shallowReadonlyHandlers: ProxyHandler<object> = {
|
2019-11-07 01:51:06 +08:00
|
|
|
...readonlyHandlers,
|
2019-12-21 00:14:07 +08:00
|
|
|
get: shallowReadonlyGet,
|
|
|
|
set: shallowReadonlySet
|
2019-11-07 01:51:06 +08:00
|
|
|
}
|