09b4202a22
BREAKING CHANGE: Reactivity APIs adjustments: - `readonly` is now non-tracking if called on plain objects. `lock` and `unlock` have been removed. A `readonly` proxy can no longer be directly mutated. However, it can still wrap an already reactive object and track changes to the source reactive object. - `isReactive` now only returns true for proxies created by `reactive`, or a `readonly` proxy that wraps a `reactive` proxy. - A new utility `isProxy` is introduced, which returns true for both reactive or readonly proxies. - `markNonReactive` has been renamed to `markRaw`.
380 lines
11 KiB
TypeScript
380 lines
11 KiB
TypeScript
import {
|
|
reactive,
|
|
readonly,
|
|
toRaw,
|
|
isReactive,
|
|
isReadonly,
|
|
markRaw,
|
|
effect,
|
|
ref,
|
|
shallowReadonly,
|
|
isProxy
|
|
} from '../src'
|
|
import { mockWarn } from '@vue/shared'
|
|
|
|
/**
|
|
* @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html
|
|
*/
|
|
type Writable<T> = { -readonly [P in keyof T]: T[P] }
|
|
|
|
describe('reactivity/readonly', () => {
|
|
mockWarn()
|
|
|
|
describe('Object', () => {
|
|
it('should make nested values readonly', () => {
|
|
const original = { foo: 1, bar: { baz: 2 } }
|
|
const wrapped = readonly(original)
|
|
expect(wrapped).not.toBe(original)
|
|
expect(isProxy(wrapped)).toBe(true)
|
|
expect(isReactive(wrapped)).toBe(false)
|
|
expect(isReadonly(wrapped)).toBe(true)
|
|
expect(isReactive(original)).toBe(false)
|
|
expect(isReadonly(original)).toBe(false)
|
|
expect(isReactive(wrapped.bar)).toBe(false)
|
|
expect(isReadonly(wrapped.bar)).toBe(true)
|
|
expect(isReactive(original.bar)).toBe(false)
|
|
expect(isReadonly(original.bar)).toBe(false)
|
|
// get
|
|
expect(wrapped.foo).toBe(1)
|
|
// has
|
|
expect('foo' in wrapped).toBe(true)
|
|
// ownKeys
|
|
expect(Object.keys(wrapped)).toEqual(['foo', 'bar'])
|
|
})
|
|
|
|
it('should not allow mutation', () => {
|
|
const qux = Symbol('qux')
|
|
const original = {
|
|
foo: 1,
|
|
bar: {
|
|
baz: 2
|
|
},
|
|
[qux]: 3
|
|
}
|
|
const wrapped: Writable<typeof original> = readonly(original)
|
|
|
|
wrapped.foo = 2
|
|
expect(wrapped.foo).toBe(1)
|
|
expect(
|
|
`Set operation on key "foo" failed: target is readonly.`
|
|
).toHaveBeenWarnedLast()
|
|
|
|
wrapped.bar.baz = 3
|
|
expect(wrapped.bar.baz).toBe(2)
|
|
expect(
|
|
`Set operation on key "baz" failed: target is readonly.`
|
|
).toHaveBeenWarnedLast()
|
|
|
|
wrapped[qux] = 4
|
|
expect(wrapped[qux]).toBe(3)
|
|
expect(
|
|
`Set operation on key "Symbol(qux)" failed: target is readonly.`
|
|
).toHaveBeenWarnedLast()
|
|
|
|
delete wrapped.foo
|
|
expect(wrapped.foo).toBe(1)
|
|
expect(
|
|
`Delete operation on key "foo" failed: target is readonly.`
|
|
).toHaveBeenWarnedLast()
|
|
|
|
delete wrapped.bar.baz
|
|
expect(wrapped.bar.baz).toBe(2)
|
|
expect(
|
|
`Delete operation on key "baz" failed: target is readonly.`
|
|
).toHaveBeenWarnedLast()
|
|
|
|
delete wrapped[qux]
|
|
expect(wrapped[qux]).toBe(3)
|
|
expect(
|
|
`Delete operation on key "Symbol(qux)" failed: target is readonly.`
|
|
).toHaveBeenWarnedLast()
|
|
})
|
|
|
|
it('should not trigger effects', () => {
|
|
const wrapped: any = readonly({ a: 1 })
|
|
let dummy
|
|
effect(() => {
|
|
dummy = wrapped.a
|
|
})
|
|
expect(dummy).toBe(1)
|
|
wrapped.a = 2
|
|
expect(wrapped.a).toBe(1)
|
|
expect(dummy).toBe(1)
|
|
expect(`target is readonly`).toHaveBeenWarned()
|
|
})
|
|
})
|
|
|
|
describe('Array', () => {
|
|
it('should make nested values readonly', () => {
|
|
const original = [{ foo: 1 }]
|
|
const wrapped = readonly(original)
|
|
expect(wrapped).not.toBe(original)
|
|
expect(isProxy(wrapped)).toBe(true)
|
|
expect(isReactive(wrapped)).toBe(false)
|
|
expect(isReadonly(wrapped)).toBe(true)
|
|
expect(isReactive(original)).toBe(false)
|
|
expect(isReadonly(original)).toBe(false)
|
|
expect(isReactive(wrapped[0])).toBe(false)
|
|
expect(isReadonly(wrapped[0])).toBe(true)
|
|
expect(isReactive(original[0])).toBe(false)
|
|
expect(isReadonly(original[0])).toBe(false)
|
|
// get
|
|
expect(wrapped[0].foo).toBe(1)
|
|
// has
|
|
expect(0 in wrapped).toBe(true)
|
|
// ownKeys
|
|
expect(Object.keys(wrapped)).toEqual(['0'])
|
|
})
|
|
|
|
it('should not allow mutation', () => {
|
|
const wrapped: any = readonly([{ foo: 1 }])
|
|
wrapped[0] = 1
|
|
expect(wrapped[0]).not.toBe(1)
|
|
expect(
|
|
`Set operation on key "0" failed: target is readonly.`
|
|
).toHaveBeenWarned()
|
|
wrapped[0].foo = 2
|
|
expect(wrapped[0].foo).toBe(1)
|
|
expect(
|
|
`Set operation on key "foo" failed: target is readonly.`
|
|
).toHaveBeenWarned()
|
|
|
|
// should block length mutation
|
|
wrapped.length = 0
|
|
expect(wrapped.length).toBe(1)
|
|
expect(wrapped[0].foo).toBe(1)
|
|
expect(
|
|
`Set operation on key "length" failed: target is readonly.`
|
|
).toHaveBeenWarned()
|
|
|
|
// mutation methods invoke set/length internally and thus are blocked as well
|
|
wrapped.push(2)
|
|
expect(wrapped.length).toBe(1)
|
|
// push triggers two warnings on [1] and .length
|
|
expect(`target is readonly.`).toHaveBeenWarnedTimes(5)
|
|
})
|
|
|
|
it('should not trigger effects', () => {
|
|
const wrapped: any = readonly([{ a: 1 }])
|
|
let dummy
|
|
effect(() => {
|
|
dummy = wrapped[0].a
|
|
})
|
|
expect(dummy).toBe(1)
|
|
wrapped[0].a = 2
|
|
expect(wrapped[0].a).toBe(1)
|
|
expect(dummy).toBe(1)
|
|
expect(`target is readonly`).toHaveBeenWarnedTimes(1)
|
|
wrapped[0] = { a: 2 }
|
|
expect(wrapped[0].a).toBe(1)
|
|
expect(dummy).toBe(1)
|
|
expect(`target is readonly`).toHaveBeenWarnedTimes(2)
|
|
})
|
|
})
|
|
|
|
const maps = [Map, WeakMap]
|
|
maps.forEach((Collection: any) => {
|
|
describe(Collection.name, () => {
|
|
test('should make nested values readonly', () => {
|
|
const key1 = {}
|
|
const key2 = {}
|
|
const original = new Collection([[key1, {}], [key2, {}]])
|
|
const wrapped = readonly(original)
|
|
expect(wrapped).not.toBe(original)
|
|
expect(isProxy(wrapped)).toBe(true)
|
|
expect(isReactive(wrapped)).toBe(false)
|
|
expect(isReadonly(wrapped)).toBe(true)
|
|
expect(isReactive(original)).toBe(false)
|
|
expect(isReadonly(original)).toBe(false)
|
|
expect(isReactive(wrapped.get(key1))).toBe(false)
|
|
expect(isReadonly(wrapped.get(key1))).toBe(true)
|
|
expect(isReactive(original.get(key1))).toBe(false)
|
|
expect(isReadonly(original.get(key1))).toBe(false)
|
|
})
|
|
|
|
test('should not allow mutation & not trigger effect', () => {
|
|
const map = readonly(new Collection())
|
|
const key = {}
|
|
let dummy
|
|
effect(() => {
|
|
dummy = map.get(key)
|
|
})
|
|
expect(dummy).toBeUndefined()
|
|
map.set(key, 1)
|
|
expect(dummy).toBeUndefined()
|
|
expect(map.has(key)).toBe(false)
|
|
expect(
|
|
`Set operation on key "${key}" failed: target is readonly.`
|
|
).toHaveBeenWarned()
|
|
})
|
|
|
|
if (Collection === Map) {
|
|
test('should retrieve readonly values on iteration', () => {
|
|
const key1 = {}
|
|
const key2 = {}
|
|
const original = new Collection([[key1, {}], [key2, {}]])
|
|
const wrapped: any = readonly(original)
|
|
for (const [key, value] of wrapped) {
|
|
expect(isReadonly(key)).toBe(true)
|
|
expect(isReadonly(value)).toBe(true)
|
|
}
|
|
wrapped.forEach((value: any) => {
|
|
expect(isReadonly(value)).toBe(true)
|
|
})
|
|
for (const value of wrapped.values()) {
|
|
expect(isReadonly(value)).toBe(true)
|
|
}
|
|
})
|
|
}
|
|
})
|
|
})
|
|
|
|
const sets = [Set, WeakSet]
|
|
sets.forEach((Collection: any) => {
|
|
describe(Collection.name, () => {
|
|
test('should make nested values readonly', () => {
|
|
const key1 = {}
|
|
const key2 = {}
|
|
const original = new Collection([key1, key2])
|
|
const wrapped = readonly(original)
|
|
expect(wrapped).not.toBe(original)
|
|
expect(isProxy(wrapped)).toBe(true)
|
|
expect(isReactive(wrapped)).toBe(false)
|
|
expect(isReadonly(wrapped)).toBe(true)
|
|
expect(isReactive(original)).toBe(false)
|
|
expect(isReadonly(original)).toBe(false)
|
|
expect(wrapped.has(reactive(key1))).toBe(true)
|
|
expect(original.has(reactive(key1))).toBe(false)
|
|
})
|
|
|
|
test('should not allow mutation & not trigger effect', () => {
|
|
const set = readonly(new Collection())
|
|
const key = {}
|
|
let dummy
|
|
effect(() => {
|
|
dummy = set.has(key)
|
|
})
|
|
expect(dummy).toBe(false)
|
|
set.add(key)
|
|
expect(dummy).toBe(false)
|
|
expect(set.has(key)).toBe(false)
|
|
expect(
|
|
`Add operation on key "${key}" failed: target is readonly.`
|
|
).toHaveBeenWarned()
|
|
})
|
|
|
|
if (Collection === Set) {
|
|
test('should retrieve readonly values on iteration', () => {
|
|
const original = new Collection([{}, {}])
|
|
const wrapped: any = readonly(original)
|
|
for (const value of wrapped) {
|
|
expect(isReadonly(value)).toBe(true)
|
|
}
|
|
wrapped.forEach((value: any) => {
|
|
expect(isReadonly(value)).toBe(true)
|
|
})
|
|
for (const value of wrapped.values()) {
|
|
expect(isReadonly(value)).toBe(true)
|
|
}
|
|
for (const [v1, v2] of wrapped.entries()) {
|
|
expect(isReadonly(v1)).toBe(true)
|
|
expect(isReadonly(v2)).toBe(true)
|
|
}
|
|
})
|
|
}
|
|
})
|
|
})
|
|
|
|
test('calling reactive on an readonly should return readonly', () => {
|
|
const a = readonly({})
|
|
const b = reactive(a)
|
|
expect(isReadonly(b)).toBe(true)
|
|
// should point to same original
|
|
expect(toRaw(a)).toBe(toRaw(b))
|
|
})
|
|
|
|
test('calling readonly on a reactive object should return readonly', () => {
|
|
const a = reactive({})
|
|
const b = readonly(a)
|
|
expect(isReadonly(b)).toBe(true)
|
|
// should point to same original
|
|
expect(toRaw(a)).toBe(toRaw(b))
|
|
})
|
|
|
|
test('readonly should track and trigger if wrapping reactive original', () => {
|
|
const a = reactive({ n: 1 })
|
|
const b = readonly(a)
|
|
// should return true since it's wrapping a reactive source
|
|
expect(isReactive(b)).toBe(true)
|
|
|
|
let dummy
|
|
effect(() => {
|
|
dummy = b.n
|
|
})
|
|
expect(dummy).toBe(1)
|
|
a.n++
|
|
expect(b.n).toBe(2)
|
|
expect(dummy).toBe(2)
|
|
})
|
|
|
|
test('wrapping already wrapped value should return same Proxy', () => {
|
|
const original = { foo: 1 }
|
|
const wrapped = readonly(original)
|
|
const wrapped2 = readonly(wrapped)
|
|
expect(wrapped2).toBe(wrapped)
|
|
})
|
|
|
|
test('wrapping the same value multiple times should return same Proxy', () => {
|
|
const original = { foo: 1 }
|
|
const wrapped = readonly(original)
|
|
const wrapped2 = readonly(original)
|
|
expect(wrapped2).toBe(wrapped)
|
|
})
|
|
|
|
test('markRaw', () => {
|
|
const obj = readonly({
|
|
foo: { a: 1 },
|
|
bar: markRaw({ b: 2 })
|
|
})
|
|
expect(isReadonly(obj.foo)).toBe(true)
|
|
expect(isReactive(obj.bar)).toBe(false)
|
|
})
|
|
|
|
test('should make ref readonly', () => {
|
|
const n: any = readonly(ref(1))
|
|
n.value = 2
|
|
expect(n.value).toBe(1)
|
|
expect(
|
|
`Set operation on key "value" failed: target is readonly.`
|
|
).toHaveBeenWarned()
|
|
})
|
|
|
|
describe('shallowReadonly', () => {
|
|
test('should not make non-reactive properties reactive', () => {
|
|
const props = shallowReadonly({ n: { foo: 1 } })
|
|
expect(isReactive(props.n)).toBe(false)
|
|
})
|
|
|
|
test('should make root level properties readonly', () => {
|
|
const props = shallowReadonly({ n: 1 })
|
|
// @ts-ignore
|
|
props.n = 2
|
|
expect(props.n).toBe(1)
|
|
expect(
|
|
`Set operation on key "n" failed: target is readonly.`
|
|
).toHaveBeenWarned()
|
|
})
|
|
|
|
// to retain 2.x behavior.
|
|
test('should NOT make nested properties readonly', () => {
|
|
const props = shallowReadonly({ n: { foo: 1 } })
|
|
// @ts-ignore
|
|
props.n.foo = 2
|
|
expect(props.n.foo).toBe(2)
|
|
expect(
|
|
`Set operation on key "foo" failed: target is readonly.`
|
|
).not.toHaveBeenWarned()
|
|
})
|
|
})
|
|
})
|