test: better collection coverage + tests for immutable

This commit is contained in:
Evan You 2018-09-20 16:18:22 -04:00
parent 9459ca2152
commit 8a714a6c39
9 changed files with 953 additions and 497 deletions

View File

@ -206,5 +206,34 @@ describe('observer/collections', () => {
map.delete('key')
expect(dummy).toBe(undefined)
})
it('should not pollute original Map with Proxies', () => {
const map = new Map()
const observed = observable(map)
const value = observable({})
observed.set('key', value)
expect(map.get('key')).not.toBe(value)
expect(map.get('key')).toBe(unwrap(value))
})
it('should return observable versions of contained values', () => {
const observed = observable(new Map())
const value = {}
observed.set('key', value)
const wrapped = observed.get('key')
expect(isObservable(wrapped)).toBe(true)
expect(unwrap(wrapped)).toBe(value)
})
it('should observed nested data', () => {
const observed = observable(new Map())
observed.set('key', { a: 1 })
let dummy
autorun(() => {
dummy = observed.get('key').a
})
observed.get('key').a = 2
expect(dummy).toBe(2)
})
})
})

View File

@ -1,6 +1,7 @@
import { observable, autorun, isObservable, unwrap } from '../../src'
describe('Set', () => {
describe('observer/collections', () => {
describe('Set', () => {
it('instanceof', () => {
const original = new Set()
const observed = observable(original)
@ -276,4 +277,14 @@ describe('Set', () => {
expect(dummy).toBe(true)
expect(setSpy).toHaveBeenCalledTimes(2)
})
it('should not pollute original Set with Proxies', () => {
const set = new Set()
const observed = observable(set)
const value = observable({})
observed.add(value)
expect(observed.has(value)).toBe(true)
expect(set.has(value)).toBe(false)
})
})
})

View File

@ -1,6 +1,7 @@
import { observable, autorun, unwrap, isObservable } from '../../src'
describe('observer/collections/WeakMap', () => {
describe('observer/collections', () => {
describe('WeakMap', () => {
test('instanceof', () => {
const original = new WeakMap()
const observed = observable(original)
@ -28,7 +29,7 @@ describe('observer/collections/WeakMap', () => {
it('should not observe custom property mutations', () => {
let dummy
const map: any = observable(new Map())
const map: any = observable(new WeakMap())
autorun(() => (dummy = map.customProp))
expect(dummy).toBe(undefined)
@ -39,7 +40,7 @@ describe('observer/collections/WeakMap', () => {
it('should not observe non value changing mutations', () => {
let dummy
const key = {}
const map = observable(new Map())
const map = observable(new WeakMap())
const mapSpy = jest.fn(() => (dummy = map.get(key)))
autorun(mapSpy)
@ -57,16 +58,13 @@ describe('observer/collections/WeakMap', () => {
map.delete(key)
expect(dummy).toBe(undefined)
expect(mapSpy).toHaveBeenCalledTimes(3)
map.clear()
expect(dummy).toBe(undefined)
expect(mapSpy).toHaveBeenCalledTimes(3)
})
it('should not observe raw data', () => {
let dummy
const key = {}
const map = observable(new Map())
autorun(() => (dummy = unwrap(map).get('key')))
const map = observable(new WeakMap())
autorun(() => (dummy = unwrap(map).get(key)))
expect(dummy).toBe(undefined)
map.set(key, 'Hello')
@ -74,4 +72,37 @@ describe('observer/collections/WeakMap', () => {
map.delete(key)
expect(dummy).toBe(undefined)
})
it('should not pollute original Map with Proxies', () => {
const map = new WeakMap()
const observed = observable(map)
const key = {}
const value = observable({})
observed.set(key, value)
expect(map.get(key)).not.toBe(value)
expect(map.get(key)).toBe(unwrap(value))
})
it('should return observable versions of contained values', () => {
const observed = observable(new WeakMap())
const key = {}
const value = {}
observed.set(key, value)
const wrapped = observed.get(key)
expect(isObservable(wrapped)).toBe(true)
expect(unwrap(wrapped)).toBe(value)
})
it('should observed nested data', () => {
const observed = observable(new Map())
const key = {}
observed.set(key, { a: 1 })
let dummy
autorun(() => {
dummy = observed.get(key).a
})
observed.get(key).a = 2
expect(dummy).toBe(2)
})
})
})

View File

@ -1,6 +1,7 @@
import { observable, isObservable, autorun, unwrap } from '../../src'
describe('WeakSet', () => {
describe('observer/collections', () => {
describe('WeakSet', () => {
it('instanceof', () => {
const original = new Set()
const observed = observable(original)
@ -76,4 +77,14 @@ describe('WeakSet', () => {
unwrap(set).add(value)
expect(dummy).toBe(false)
})
it('should not pollute original Set with Proxies', () => {
const set = new WeakSet()
const observed = observable(set)
const value = observable({})
observed.add(value)
expect(observed.has(value)).toBe(true)
expect(set.has(value)).toBe(false)
})
})
})

View File

@ -1 +1,339 @@
describe('observer/immutable', () => {})
import {
observable,
immutable,
unwrap,
isObservable,
isImmutable,
markNonReactive,
markImmutable,
lock,
unlock,
autorun
} from '../src'
describe('observer/immutable', () => {
let warn: any
beforeEach(() => {
warn = jest.spyOn(console, 'warn')
warn.mockImplementation(() => {})
})
afterEach(() => {
warn.mockRestore()
})
describe('Object', () => {
it('should make nested values immutable', () => {
const original = { foo: 1, bar: { baz: 2 } }
const observed = immutable(original)
expect(observed).not.toBe(original)
expect(isObservable(observed)).toBe(true)
expect(isImmutable(observed)).toBe(true)
expect(isObservable(original)).toBe(false)
expect(isImmutable(original)).toBe(false)
expect(isObservable(observed.bar)).toBe(true)
expect(isImmutable(observed.bar)).toBe(true)
expect(isObservable(original.bar)).toBe(false)
expect(isImmutable(original.bar)).toBe(false)
// get
expect(observed.foo).toBe(1)
// has
expect('foo' in observed).toBe(true)
// ownKeys
expect(Object.keys(observed)).toEqual(['foo', 'bar'])
})
it('should not allow mutation', () => {
const observed = immutable({ foo: 1, bar: { baz: 2 } })
observed.foo = 2
expect(observed.foo).toBe(1)
expect(warn).toHaveBeenCalledTimes(1)
observed.bar.baz = 3
expect(observed.bar.baz).toBe(2)
expect(warn).toHaveBeenCalledTimes(2)
})
it('should allow mutation when unlocked', () => {
const observed = immutable({ foo: 1, bar: { baz: 2 } })
unlock()
observed.foo = 2
observed.bar.baz = 3
lock()
expect(observed.foo).toBe(2)
expect(observed.bar.baz).toBe(3)
expect(warn).not.toHaveBeenCalled()
})
it('should not trigger autoruns when locked', () => {
const observed = immutable({ a: 1 })
let dummy
autorun(() => {
dummy = observed.a
})
expect(dummy).toBe(1)
observed.a = 2
expect(observed.a).toBe(1)
expect(dummy).toBe(1)
})
it('should trigger autoruns when unlocked', () => {
const observed = immutable({ a: 1 })
let dummy
autorun(() => {
dummy = observed.a
})
expect(dummy).toBe(1)
unlock()
observed.a = 2
lock()
expect(observed.a).toBe(2)
expect(dummy).toBe(2)
})
})
describe('Array', () => {
it('should make nested values immutable', () => {
const original: any[] = [{ foo: 1 }]
const observed = immutable(original)
expect(observed).not.toBe(original)
expect(isObservable(observed)).toBe(true)
expect(isImmutable(observed)).toBe(true)
expect(isObservable(original)).toBe(false)
expect(isImmutable(original)).toBe(false)
expect(isObservable(observed[0])).toBe(true)
expect(isImmutable(observed[0])).toBe(true)
expect(isObservable(original[0])).toBe(false)
expect(isImmutable(original[0])).toBe(false)
// get
expect(observed[0].foo).toBe(1)
// has
expect(0 in observed).toBe(true)
// ownKeys
expect(Object.keys(observed)).toEqual(['0'])
})
it('should not allow mutation', () => {
const observed: any = immutable([{ foo: 1 }])
observed[0] = 1
expect(observed[0]).not.toBe(1)
expect(warn).toHaveBeenCalledTimes(1)
observed[0].foo = 2
expect(observed[0].foo).toBe(1)
expect(warn).toHaveBeenCalledTimes(2)
// should block length mutation
observed.length = 0
expect(observed.length).toBe(1)
expect(observed[0].foo).toBe(1)
expect(warn).toHaveBeenCalledTimes(3)
// mutation methods invoke set/length internally and thus are blocked as well
observed.push(2)
expect(observed.length).toBe(1)
// push triggers two warnings on [1] and .length
expect(warn).toHaveBeenCalledTimes(5)
})
it('should allow mutation when unlocked', () => {
const observed: any[] = immutable([{ foo: 1, bar: { baz: 2 } }])
unlock()
observed[1] = 2
observed.push(3)
observed[0].foo = 2
observed[0].bar.baz = 3
lock()
expect(observed.length).toBe(3)
expect(observed[1]).toBe(2)
expect(observed[2]).toBe(3)
expect(observed[0].foo).toBe(2)
expect(observed[0].bar.baz).toBe(3)
expect(warn).not.toHaveBeenCalled()
})
it('should not trigger autoruns when locked', () => {
const observed = immutable([{ a: 1 }])
let dummy
autorun(() => {
dummy = observed[0].a
})
expect(dummy).toBe(1)
observed[0].a = 2
expect(observed[0].a).toBe(1)
expect(dummy).toBe(1)
observed[0] = { a: 2 }
expect(observed[0].a).toBe(1)
expect(dummy).toBe(1)
})
it('should trigger autoruns when unlocked', () => {
const observed = immutable([{ a: 1 }])
let dummy
autorun(() => {
dummy = observed[0].a
})
expect(dummy).toBe(1)
unlock()
observed[0].a = 2
expect(observed[0].a).toBe(2)
expect(dummy).toBe(2)
observed[0] = { a: 3 }
expect(observed[0].a).toBe(3)
expect(dummy).toBe(3)
observed.unshift({ a: 4 })
expect(observed[0].a).toBe(4)
expect(dummy).toBe(4)
lock()
})
})
;[Map, WeakMap].forEach((Collection: any) => {
describe(Collection.name, () => {
test('should make nested values immutable', () => {
const key1 = {}
const key2 = {}
const original = new Collection([[key1, {}], [key2, {}]])
const observed = immutable(original)
expect(observed).not.toBe(original)
expect(isObservable(observed)).toBe(true)
expect(isImmutable(observed)).toBe(true)
expect(isObservable(original)).toBe(false)
expect(isImmutable(original)).toBe(false)
expect(isObservable(observed.get(key1))).toBe(true)
expect(isImmutable(observed.get(key1))).toBe(true)
expect(isObservable(original.get(key1))).toBe(false)
expect(isImmutable(original.get(key1))).toBe(false)
})
test('should not allow mutation & not trigger autorun', () => {
const map = immutable(new Collection())
const key = {}
let dummy
autorun(() => {
dummy = map.get(key)
})
expect(dummy).toBeUndefined()
map.set(key, 1)
expect(dummy).toBeUndefined()
expect(map.has(key)).toBe(false)
expect(warn).toHaveBeenCalledTimes(1)
})
test('should allow mutation & trigger autorun when unlocked', () => {
const map = immutable(new Collection())
const key = {}
let dummy
autorun(() => {
dummy = map.get(key)
})
expect(dummy).toBeUndefined()
unlock()
map.set(key, 1)
lock()
expect(dummy).toBe(1)
expect(map.get(key)).toBe(1)
expect(warn).not.toHaveBeenCalled()
})
})
})
;[Set, WeakSet].forEach((Collection: any) => {
describe(Collection.name, () => {
test('should make nested values immutable', () => {
const key1 = {}
const key2 = {}
const original = new Collection([key1, key2])
const observed = immutable(original)
expect(observed).not.toBe(original)
expect(isObservable(observed)).toBe(true)
expect(isImmutable(observed)).toBe(true)
expect(isObservable(original)).toBe(false)
expect(isImmutable(original)).toBe(false)
expect(observed.has(observable(key1))).toBe(true)
expect(original.has(observable(key1))).toBe(false)
})
test('should not allow mutation & not trigger autorun', () => {
const set = immutable(new Collection())
const key = {}
let dummy
autorun(() => {
dummy = set.has(key)
})
expect(dummy).toBe(false)
set.add(key)
expect(dummy).toBe(false)
expect(set.has(key)).toBe(false)
expect(warn).toHaveBeenCalledTimes(1)
})
test('should allow mutation & trigger autorun when unlocked', () => {
const set = immutable(new Collection())
const key = {}
let dummy
autorun(() => {
dummy = set.has(key)
})
expect(dummy).toBe(false)
unlock()
set.add(key)
lock()
expect(dummy).toBe(true)
expect(set.has(key)).toBe(true)
expect(warn).not.toHaveBeenCalled()
})
})
})
test('calling observable on an immutable should return immutable', () => {
const a = immutable()
const b = observable(a)
expect(isImmutable(b)).toBe(true)
// should point to same original
expect(unwrap(a)).toBe(unwrap(b))
})
test('calling immutable on an observable should return immutable', () => {
const a = observable()
const b = immutable(a)
expect(isImmutable(b)).toBe(true)
// should point to same original
expect(unwrap(a)).toBe(unwrap(b))
})
test('observing already observed value should return same Proxy', () => {
const original = { foo: 1 }
const observed = immutable(original)
const observed2 = immutable(observed)
expect(observed2).toBe(observed)
})
test('observing the same value multiple times should return same Proxy', () => {
const original = { foo: 1 }
const observed = immutable(original)
const observed2 = immutable(original)
expect(observed2).toBe(observed)
})
test('markNonReactive', () => {
const obj = immutable({
foo: { a: 1 },
bar: markNonReactive({ b: 2 })
})
expect(isObservable(obj.foo)).toBe(true)
expect(isObservable(obj.bar)).toBe(false)
})
test('markImmutable', () => {
const obj = observable({
foo: { a: 1 },
bar: markImmutable({ b: 2 })
})
expect(isObservable(obj.foo)).toBe(true)
expect(isObservable(obj.bar)).toBe(true)
expect(isImmutable(obj.foo)).toBe(false)
expect(isImmutable(obj.bar)).toBe(true)
})
})

View File

@ -116,7 +116,9 @@ export function trigger(
})
} else {
// schedule runs for SET | ADD | DELETE
if (key !== void 0) {
addRunners(runners, depsMap.get(key as string | symbol))
}
// also run for iteration key on ADD | DELETE
if (type === OperationTypes.ADD || type === OperationTypes.DELETE) {
const iterationKey = Array.isArray(target) ? 'length' : ITERATE_KEY

View File

@ -15,14 +15,14 @@ function get(
target: any,
key: string | symbol,
receiver: any,
toObsevable: (t: any) => any
toObservable: (t: any) => any
) {
const res = Reflect.get(target, key, receiver)
if (typeof key === 'symbol' && builtInSymbols.has(key)) {
return res
}
track(target, OperationTypes.GET, key)
return res !== null && typeof res === 'object' ? toObsevable(res) : res
return res !== null && typeof res === 'object' ? toObservable(res) : res
}
function set(
@ -96,7 +96,10 @@ export const immutableHandlers: ProxyHandler<any> = {
set(target: any, key: string | symbol, value: any, receiver: any): boolean {
if (LOCKED) {
if (__DEV__) {
console.warn(`Set operation failed: target is immutable.`, target)
console.warn(
`Set operation on key "${key as any}" failed: target is immutable.`,
target
)
}
return true
} else {
@ -107,7 +110,10 @@ export const immutableHandlers: ProxyHandler<any> = {
deleteProperty(target: any, key: string | symbol): boolean {
if (LOCKED) {
if (__DEV__) {
console.warn(`Delete operation failed: target is immutable.`, target)
console.warn(
`Delete operation on key "${key as any}" failed: target is immutable.`,
target
)
}
return true
} else {

View File

@ -1,18 +1,24 @@
import { unwrap } from './index'
import { unwrap, observable, immutable } from './index'
import { track, trigger } from './autorun'
import { OperationTypes } from './operations'
import { LOCKED } from './lock'
function makeInstrumentedMethod(method: string | symbol, type: OperationTypes) {
return function(...args: any[]) {
const target = unwrap(this)
function get(target: any, key: any, toObservable: (t: any) => any): any {
target = unwrap(target)
key = unwrap(key)
const proto: any = Reflect.getPrototypeOf(target)
track(target, type, args[0])
return proto[method].apply(target, args)
}
track(target, OperationTypes.GET, key)
const res = proto.get.call(target, key)
return res !== null && typeof res === 'object' ? toObservable(res) : res
}
const get = makeInstrumentedMethod('get', OperationTypes.GET)
const has = makeInstrumentedMethod('has', OperationTypes.HAS)
function has(key: any): boolean {
const target = unwrap(this)
key = unwrap(key)
const proto: any = Reflect.getPrototypeOf(target)
track(target, OperationTypes.HAS, key)
return proto.has.call(target, key)
}
function size(target: any) {
target = unwrap(target)
@ -21,46 +27,29 @@ function size(target: any) {
return Reflect.get(proto, 'size', target)
}
function makeWarning(type: OperationTypes) {
return function() {
if (__DEV__) {
console.warn(
`${type} operation failed: target is immutable.`,
unwrap(this)
)
}
}
}
const mutableInstrumentations: any = {
get,
has,
get size() {
return size(this)
},
add(key: any) {
function add(value: any) {
value = unwrap(value)
const target = unwrap(this)
const proto: any = Reflect.getPrototypeOf(this)
const hadKey = proto.has.call(target, key)
const result = proto.add.apply(target, arguments)
const hadKey = proto.has.call(target, value)
const result = proto.add.call(target, value)
if (!hadKey) {
if (__DEV__) {
trigger(target, OperationTypes.ADD, key, { value: key })
trigger(target, OperationTypes.ADD, value, { value })
} else {
trigger(target, OperationTypes.ADD, key)
trigger(target, OperationTypes.ADD, value)
}
}
return result
},
}
set(key: any, value: any) {
function set(key: any, value: any) {
value = unwrap(value)
const target = unwrap(this)
const proto: any = Reflect.getPrototypeOf(this)
const hadKey = proto.has.call(target, key)
const oldValue = proto.get.call(target, key)
const result = proto.set.apply(target, arguments)
const result = proto.set.call(target, key, value)
if (value !== oldValue) {
if (__DEV__) {
const extraInfo = { oldValue, newValue: value }
@ -78,15 +67,15 @@ const mutableInstrumentations: any = {
}
}
return result
},
}
delete(key: any) {
function deleteEntry(key: any) {
const target = unwrap(this)
const proto: any = Reflect.getPrototypeOf(this)
const hadKey = proto.has.call(target, key)
const oldValue = proto.get ? proto.get.call(target, key) : undefined
// forward the operation before queueing reactions
const result = proto.delete.apply(target, arguments)
const result = proto.delete.call(target, key)
if (hadKey) {
if (__DEV__) {
trigger(target, OperationTypes.DELETE, key, { oldValue })
@ -95,15 +84,15 @@ const mutableInstrumentations: any = {
}
}
return result
},
}
clear() {
function clear() {
const target = unwrap(this)
const proto: any = Reflect.getPrototypeOf(this)
const hadItems = target.size !== 0
const oldTarget = target instanceof Map ? new Map(target) : new Set(target)
// forward the operation before queueing reactions
const result = proto.clear.apply(target, arguments)
const result = proto.clear.call(target)
if (hadItems) {
if (__DEV__) {
trigger(target, OperationTypes.CLEAR, void 0, { oldTarget })
@ -112,24 +101,61 @@ const mutableInstrumentations: any = {
}
}
return result
}
function makeImmutableMethod(method: Function, type: OperationTypes): Function {
return function(...args: any[]) {
if (LOCKED) {
if (__DEV__) {
const key = args[0] ? `on key "${args[0]}"` : ``
console.warn(
`${type} operation ${key}failed: target is immutable.`,
unwrap(this)
)
}
return type === OperationTypes.DELETE ? false : this
} else {
return method.apply(this, args)
}
}
}
const immutableInstrumentations: any = {
get,
has,
const mutableInstrumentations: any = {
get(key: any) {
return get(this, key, observable)
},
get size() {
return size(this)
},
add: makeWarning(OperationTypes.ADD),
set: makeWarning(OperationTypes.SET),
delete: makeWarning(OperationTypes.DELETE),
clear: makeWarning(OperationTypes.CLEAR)
has,
add,
set,
delete: deleteEntry,
clear
}
;['forEach', 'keys', 'values', 'entries', Symbol.iterator].forEach(key => {
mutableInstrumentations[key] = immutableInstrumentations[
key
] = makeInstrumentedMethod(key, OperationTypes.ITERATE)
const immutableInstrumentations: any = {
get(key: any) {
return get(this, key, immutable)
},
get size() {
return size(this)
},
has,
add: makeImmutableMethod(add, OperationTypes.ADD),
set: makeImmutableMethod(set, OperationTypes.SET),
delete: makeImmutableMethod(deleteEntry, OperationTypes.DELETE),
clear: makeImmutableMethod(clear, OperationTypes.CLEAR)
}
;['forEach', 'keys', 'values', 'entries', Symbol.iterator].forEach(method => {
mutableInstrumentations[method] = immutableInstrumentations[
method
] = function(...args: any[]) {
const target = unwrap(this)
const proto: any = Reflect.getPrototypeOf(target)
track(target, OperationTypes.ITERATE)
return proto[method].apply(target, args)
}
})
function getInstrumented(

View File

@ -105,7 +105,9 @@ function createObservable(
observed = new Proxy(target, handlers)
toProxy.set(target, observed)
toRaw.set(observed, target)
if (!targetMap.has(target)) {
targetMap.set(target, new Map())
}
return observed
}