| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115 |
- import {
- type DebuggerEvent,
- type ReactiveEffectRunner,
- TrackOpTypes,
- TriggerOpTypes,
- effect,
- markRaw,
- reactive,
- readonly,
- shallowReactive,
- stop,
- toRaw,
- } from '../src/index'
- import { pauseScheduling, resetScheduling } from '../src/effect'
- import { ITERATE_KEY, getDepFromReactive } from '../src/reactiveEffect'
- import {
- computed,
- h,
- nextTick,
- nodeOps,
- ref,
- render,
- serializeInner,
- } from '@vue/runtime-test'
- describe('reactivity/effect', () => {
- it('should run the passed function once (wrapped by a effect)', () => {
- const fnSpy = vi.fn(() => {})
- effect(fnSpy)
- expect(fnSpy).toHaveBeenCalledTimes(1)
- })
- it('should observe basic properties', () => {
- let dummy
- const counter = reactive({ num: 0 })
- effect(() => (dummy = counter.num))
- expect(dummy).toBe(0)
- counter.num = 7
- expect(dummy).toBe(7)
- })
- it('should observe multiple properties', () => {
- let dummy
- const counter = reactive({ num1: 0, num2: 0 })
- effect(() => (dummy = counter.num1 + counter.num1 + counter.num2))
- expect(dummy).toBe(0)
- counter.num1 = counter.num2 = 7
- expect(dummy).toBe(21)
- })
- it('should handle multiple effects', () => {
- let dummy1, dummy2
- const counter = reactive({ num: 0 })
- effect(() => (dummy1 = counter.num))
- effect(() => (dummy2 = counter.num))
- expect(dummy1).toBe(0)
- expect(dummy2).toBe(0)
- counter.num++
- expect(dummy1).toBe(1)
- expect(dummy2).toBe(1)
- })
- it('should observe nested properties', () => {
- let dummy
- const counter = reactive({ nested: { num: 0 } })
- effect(() => (dummy = counter.nested.num))
- expect(dummy).toBe(0)
- counter.nested.num = 8
- expect(dummy).toBe(8)
- })
- it('should observe delete operations', () => {
- let dummy
- const obj = reactive<{
- prop?: string
- }>({ prop: 'value' })
- effect(() => (dummy = obj.prop))
- expect(dummy).toBe('value')
- delete obj.prop
- expect(dummy).toBe(undefined)
- })
- it('should observe has operations', () => {
- let dummy
- const obj = reactive<{ prop?: string | number }>({ prop: 'value' })
- effect(() => (dummy = 'prop' in obj))
- expect(dummy).toBe(true)
- delete obj.prop
- expect(dummy).toBe(false)
- obj.prop = 12
- expect(dummy).toBe(true)
- })
- it('should observe properties on the prototype chain', () => {
- let dummy
- const counter = reactive<{ num?: number }>({ num: 0 })
- const parentCounter = reactive({ num: 2 })
- Object.setPrototypeOf(counter, parentCounter)
- effect(() => (dummy = counter.num))
- expect(dummy).toBe(0)
- delete counter.num
- expect(dummy).toBe(2)
- parentCounter.num = 4
- expect(dummy).toBe(4)
- counter.num = 3
- expect(dummy).toBe(3)
- })
- it('should observe has operations on the prototype chain', () => {
- let dummy
- const counter = reactive<{ num?: number }>({ num: 0 })
- const parentCounter = reactive<{ num?: number }>({ num: 2 })
- Object.setPrototypeOf(counter, parentCounter)
- effect(() => (dummy = 'num' in counter))
- expect(dummy).toBe(true)
- delete counter.num
- expect(dummy).toBe(true)
- delete parentCounter.num
- expect(dummy).toBe(false)
- counter.num = 3
- expect(dummy).toBe(true)
- })
- it('should observe inherited property accessors', () => {
- let dummy, parentDummy, hiddenValue: any
- const obj = reactive<{ prop?: number }>({})
- const parent = reactive({
- set prop(value) {
- hiddenValue = value
- },
- get prop() {
- return hiddenValue
- },
- })
- Object.setPrototypeOf(obj, parent)
- effect(() => (dummy = obj.prop))
- effect(() => (parentDummy = parent.prop))
- expect(dummy).toBe(undefined)
- expect(parentDummy).toBe(undefined)
- obj.prop = 4
- expect(dummy).toBe(4)
- // this doesn't work, should it?
- // expect(parentDummy).toBe(4)
- parent.prop = 2
- expect(dummy).toBe(2)
- expect(parentDummy).toBe(2)
- })
- it('should observe function call chains', () => {
- let dummy
- const counter = reactive({ num: 0 })
- effect(() => (dummy = getNum()))
- function getNum() {
- return counter.num
- }
- expect(dummy).toBe(0)
- counter.num = 2
- expect(dummy).toBe(2)
- })
- it('should observe iteration', () => {
- let dummy
- const list = reactive(['Hello'])
- effect(() => (dummy = list.join(' ')))
- expect(dummy).toBe('Hello')
- list.push('World!')
- expect(dummy).toBe('Hello World!')
- list.shift()
- expect(dummy).toBe('World!')
- })
- it('should observe implicit array length changes', () => {
- let dummy
- const list = reactive(['Hello'])
- effect(() => (dummy = list.join(' ')))
- expect(dummy).toBe('Hello')
- list[1] = 'World!'
- expect(dummy).toBe('Hello World!')
- list[3] = 'Hello!'
- expect(dummy).toBe('Hello World! Hello!')
- })
- it('should observe sparse array mutations', () => {
- let dummy
- const list = reactive<string[]>([])
- list[1] = 'World!'
- effect(() => (dummy = list.join(' ')))
- expect(dummy).toBe(' World!')
- list[0] = 'Hello'
- expect(dummy).toBe('Hello World!')
- list.pop()
- expect(dummy).toBe('Hello')
- })
- it('should observe enumeration', () => {
- let dummy = 0
- const numbers = reactive<Record<string, number>>({ num1: 3 })
- effect(() => {
- dummy = 0
- for (let key in numbers) {
- dummy += numbers[key]
- }
- })
- expect(dummy).toBe(3)
- numbers.num2 = 4
- expect(dummy).toBe(7)
- delete numbers.num1
- expect(dummy).toBe(4)
- })
- it('should observe symbol keyed properties', () => {
- const key = Symbol('symbol keyed prop')
- let dummy, hasDummy
- const obj = reactive<{ [key]?: string }>({ [key]: 'value' })
- effect(() => (dummy = obj[key]))
- effect(() => (hasDummy = key in obj))
- expect(dummy).toBe('value')
- expect(hasDummy).toBe(true)
- obj[key] = 'newValue'
- expect(dummy).toBe('newValue')
- delete obj[key]
- expect(dummy).toBe(undefined)
- expect(hasDummy).toBe(false)
- })
- it('should not observe well-known symbol keyed properties', () => {
- const key = Symbol.isConcatSpreadable
- let dummy
- const array: any = reactive([])
- effect(() => (dummy = array[key]))
- expect(array[key]).toBe(undefined)
- expect(dummy).toBe(undefined)
- array[key] = true
- expect(array[key]).toBe(true)
- expect(dummy).toBe(undefined)
- })
- it('should support manipulating an array while observing symbol keyed properties', () => {
- const key = Symbol()
- let dummy
- const array: any = reactive([1, 2, 3])
- effect(() => (dummy = array[key]))
- expect(dummy).toBe(undefined)
- array.pop()
- array.shift()
- array.splice(0, 1)
- expect(dummy).toBe(undefined)
- array[key] = 'value'
- array.length = 0
- expect(dummy).toBe('value')
- })
- it('should observe function valued properties', () => {
- const oldFunc = () => {}
- const newFunc = () => {}
- let dummy
- const obj = reactive({ func: oldFunc })
- effect(() => (dummy = obj.func))
- expect(dummy).toBe(oldFunc)
- obj.func = newFunc
- expect(dummy).toBe(newFunc)
- })
- it('should observe chained getters relying on this', () => {
- const obj = reactive({
- a: 1,
- get b() {
- return this.a
- },
- })
- let dummy
- effect(() => (dummy = obj.b))
- expect(dummy).toBe(1)
- obj.a++
- expect(dummy).toBe(2)
- })
- it('should observe methods relying on this', () => {
- const obj = reactive({
- a: 1,
- b() {
- return this.a
- },
- })
- let dummy
- effect(() => (dummy = obj.b()))
- expect(dummy).toBe(1)
- obj.a++
- expect(dummy).toBe(2)
- })
- it('should not observe set operations without a value change', () => {
- let hasDummy, getDummy
- const obj = reactive({ prop: 'value' })
- const getSpy = vi.fn(() => (getDummy = obj.prop))
- const hasSpy = vi.fn(() => (hasDummy = 'prop' in obj))
- effect(getSpy)
- effect(hasSpy)
- expect(getDummy).toBe('value')
- expect(hasDummy).toBe(true)
- obj.prop = 'value'
- expect(getSpy).toHaveBeenCalledTimes(1)
- expect(hasSpy).toHaveBeenCalledTimes(1)
- expect(getDummy).toBe('value')
- expect(hasDummy).toBe(true)
- })
- it('should not observe raw mutations', () => {
- let dummy
- const obj = reactive<{ prop?: string }>({})
- effect(() => (dummy = toRaw(obj).prop))
- expect(dummy).toBe(undefined)
- obj.prop = 'value'
- expect(dummy).toBe(undefined)
- })
- it('should not be triggered by raw mutations', () => {
- let dummy
- const obj = reactive<{ prop?: string }>({})
- effect(() => (dummy = obj.prop))
- expect(dummy).toBe(undefined)
- toRaw(obj).prop = 'value'
- expect(dummy).toBe(undefined)
- })
- it('should not be triggered by inherited raw setters', () => {
- let dummy, parentDummy, hiddenValue: any
- const obj = reactive<{ prop?: number }>({})
- const parent = reactive({
- set prop(value) {
- hiddenValue = value
- },
- get prop() {
- return hiddenValue
- },
- })
- Object.setPrototypeOf(obj, parent)
- effect(() => (dummy = obj.prop))
- effect(() => (parentDummy = parent.prop))
- expect(dummy).toBe(undefined)
- expect(parentDummy).toBe(undefined)
- toRaw(obj).prop = 4
- expect(dummy).toBe(undefined)
- expect(parentDummy).toBe(undefined)
- })
- it('should avoid implicit infinite recursive loops with itself', () => {
- const counter = reactive({ num: 0 })
- const counterSpy = vi.fn(() => counter.num++)
- effect(counterSpy)
- expect(counter.num).toBe(1)
- expect(counterSpy).toHaveBeenCalledTimes(1)
- counter.num = 4
- expect(counter.num).toBe(5)
- expect(counterSpy).toHaveBeenCalledTimes(2)
- })
- it('should avoid infinite recursive loops when use Array.prototype.push/unshift/pop/shift', () => {
- ;(['push', 'unshift'] as const).forEach(key => {
- const arr = reactive<number[]>([])
- const counterSpy1 = vi.fn(() => (arr[key] as any)(1))
- const counterSpy2 = vi.fn(() => (arr[key] as any)(2))
- effect(counterSpy1)
- effect(counterSpy2)
- expect(arr.length).toBe(2)
- expect(counterSpy1).toHaveBeenCalledTimes(1)
- expect(counterSpy2).toHaveBeenCalledTimes(1)
- })
- ;(['pop', 'shift'] as const).forEach(key => {
- const arr = reactive<number[]>([1, 2, 3, 4])
- const counterSpy1 = vi.fn(() => (arr[key] as any)())
- const counterSpy2 = vi.fn(() => (arr[key] as any)())
- effect(counterSpy1)
- effect(counterSpy2)
- expect(arr.length).toBe(2)
- expect(counterSpy1).toHaveBeenCalledTimes(1)
- expect(counterSpy2).toHaveBeenCalledTimes(1)
- })
- })
- it('should allow explicitly recursive raw function loops', () => {
- const counter = reactive({ num: 0 })
- const numSpy = vi.fn(() => {
- counter.num++
- if (counter.num < 10) {
- numSpy()
- }
- })
- effect(numSpy)
- expect(counter.num).toEqual(10)
- expect(numSpy).toHaveBeenCalledTimes(10)
- })
- it('should avoid infinite loops with other effects', () => {
- const nums = reactive({ num1: 0, num2: 1 })
- const spy1 = vi.fn(() => (nums.num1 = nums.num2))
- const spy2 = vi.fn(() => (nums.num2 = nums.num1))
- effect(spy1)
- effect(spy2)
- expect(nums.num1).toBe(1)
- expect(nums.num2).toBe(1)
- expect(spy1).toHaveBeenCalledTimes(1)
- expect(spy2).toHaveBeenCalledTimes(1)
- nums.num2 = 4
- expect(nums.num1).toBe(4)
- expect(nums.num2).toBe(4)
- expect(spy1).toHaveBeenCalledTimes(2)
- expect(spy2).toHaveBeenCalledTimes(2)
- nums.num1 = 10
- expect(nums.num1).toBe(10)
- expect(nums.num2).toBe(10)
- expect(spy1).toHaveBeenCalledTimes(3)
- expect(spy2).toHaveBeenCalledTimes(3)
- })
- it('should return a new reactive version of the function', () => {
- function greet() {
- return 'Hello World'
- }
- const effect1 = effect(greet)
- const effect2 = effect(greet)
- expect(typeof effect1).toBe('function')
- expect(typeof effect2).toBe('function')
- expect(effect1).not.toBe(greet)
- expect(effect1).not.toBe(effect2)
- })
- it('should discover new branches while running automatically', () => {
- let dummy
- const obj = reactive({ prop: 'value', run: false })
- const conditionalSpy = vi.fn(() => {
- dummy = obj.run ? obj.prop : 'other'
- })
- effect(conditionalSpy)
- expect(dummy).toBe('other')
- expect(conditionalSpy).toHaveBeenCalledTimes(1)
- obj.prop = 'Hi'
- expect(dummy).toBe('other')
- expect(conditionalSpy).toHaveBeenCalledTimes(1)
- obj.run = true
- expect(dummy).toBe('Hi')
- expect(conditionalSpy).toHaveBeenCalledTimes(2)
- obj.prop = 'World'
- expect(dummy).toBe('World')
- expect(conditionalSpy).toHaveBeenCalledTimes(3)
- })
- it('should discover new branches when running manually', () => {
- let dummy
- let run = false
- const obj = reactive({ prop: 'value' })
- const runner = effect(() => {
- dummy = run ? obj.prop : 'other'
- })
- expect(dummy).toBe('other')
- runner()
- expect(dummy).toBe('other')
- run = true
- runner()
- expect(dummy).toBe('value')
- obj.prop = 'World'
- expect(dummy).toBe('World')
- })
- it('should not be triggered by mutating a property, which is used in an inactive branch', () => {
- let dummy
- const obj = reactive({ prop: 'value', run: true })
- const conditionalSpy = vi.fn(() => {
- dummy = obj.run ? obj.prop : 'other'
- })
- effect(conditionalSpy)
- expect(dummy).toBe('value')
- expect(conditionalSpy).toHaveBeenCalledTimes(1)
- obj.run = false
- expect(dummy).toBe('other')
- expect(conditionalSpy).toHaveBeenCalledTimes(2)
- obj.prop = 'value2'
- expect(dummy).toBe('other')
- expect(conditionalSpy).toHaveBeenCalledTimes(2)
- })
- it('should handle deep effect recursion using cleanup fallback', () => {
- const results = reactive([0])
- const effects: { fx: ReactiveEffectRunner; index: number }[] = []
- for (let i = 1; i < 40; i++) {
- ;(index => {
- const fx = effect(() => {
- results[index] = results[index - 1] * 2
- })
- effects.push({ fx, index })
- })(i)
- }
- expect(results[39]).toBe(0)
- results[0] = 1
- expect(results[39]).toBe(Math.pow(2, 39))
- })
- it('should register deps independently during effect recursion', () => {
- const input = reactive({ a: 1, b: 2, c: 0 })
- const output = reactive({ fx1: 0, fx2: 0 })
- const fx1Spy = vi.fn(() => {
- let result = 0
- if (input.c < 2) result += input.a
- if (input.c > 1) result += input.b
- output.fx1 = result
- })
- const fx1 = effect(fx1Spy)
- const fx2Spy = vi.fn(() => {
- let result = 0
- if (input.c > 1) result += input.a
- if (input.c < 3) result += input.b
- output.fx2 = result + output.fx1
- })
- const fx2 = effect(fx2Spy)
- expect(fx1).not.toBeNull()
- expect(fx2).not.toBeNull()
- expect(output.fx1).toBe(1)
- expect(output.fx2).toBe(2 + 1)
- expect(fx1Spy).toHaveBeenCalledTimes(1)
- expect(fx2Spy).toHaveBeenCalledTimes(1)
- fx1Spy.mockClear()
- fx2Spy.mockClear()
- input.b = 3
- expect(output.fx1).toBe(1)
- expect(output.fx2).toBe(3 + 1)
- expect(fx1Spy).toHaveBeenCalledTimes(0)
- expect(fx2Spy).toHaveBeenCalledTimes(1)
- fx1Spy.mockClear()
- fx2Spy.mockClear()
- input.c = 1
- expect(output.fx1).toBe(1)
- expect(output.fx2).toBe(3 + 1)
- expect(fx1Spy).toHaveBeenCalledTimes(1)
- expect(fx2Spy).toHaveBeenCalledTimes(1)
- fx1Spy.mockClear()
- fx2Spy.mockClear()
- input.c = 2
- expect(output.fx1).toBe(3)
- expect(output.fx2).toBe(1 + 3 + 3)
- expect(fx1Spy).toHaveBeenCalledTimes(1)
- // Invoked due to change of fx1.
- expect(fx2Spy).toHaveBeenCalledTimes(1)
- fx1Spy.mockClear()
- fx2Spy.mockClear()
- input.c = 3
- expect(output.fx1).toBe(3)
- expect(output.fx2).toBe(1 + 3)
- expect(fx1Spy).toHaveBeenCalledTimes(1)
- expect(fx2Spy).toHaveBeenCalledTimes(1)
- fx1Spy.mockClear()
- fx2Spy.mockClear()
- input.a = 10
- expect(output.fx1).toBe(3)
- expect(output.fx2).toBe(10 + 3)
- expect(fx1Spy).toHaveBeenCalledTimes(0)
- expect(fx2Spy).toHaveBeenCalledTimes(1)
- })
- it('should not double wrap if the passed function is a effect', () => {
- const runner = effect(() => {})
- const otherRunner = effect(runner)
- expect(runner).not.toBe(otherRunner)
- expect(runner.effect.fn).toBe(otherRunner.effect.fn)
- })
- it('should wrap if the passed function is a fake effect', () => {
- const fakeRunner = () => {}
- fakeRunner.effect = {}
- const runner = effect(fakeRunner)
- expect(fakeRunner).not.toBe(runner)
- expect(runner.effect.fn).toBe(fakeRunner)
- })
- it('should not run multiple times for a single mutation', () => {
- let dummy
- const obj = reactive<Record<string, number>>({})
- const fnSpy = vi.fn(() => {
- for (const key in obj) {
- dummy = obj[key]
- }
- dummy = obj.prop
- })
- effect(fnSpy)
- expect(fnSpy).toHaveBeenCalledTimes(1)
- obj.prop = 16
- expect(dummy).toBe(16)
- expect(fnSpy).toHaveBeenCalledTimes(2)
- })
- it('should allow nested effects', () => {
- const nums = reactive({ num1: 0, num2: 1, num3: 2 })
- const dummy: any = {}
- const childSpy = vi.fn(() => (dummy.num1 = nums.num1))
- const childeffect = effect(childSpy)
- const parentSpy = vi.fn(() => {
- dummy.num2 = nums.num2
- childeffect()
- dummy.num3 = nums.num3
- })
- effect(parentSpy)
- expect(dummy).toEqual({ num1: 0, num2: 1, num3: 2 })
- expect(parentSpy).toHaveBeenCalledTimes(1)
- expect(childSpy).toHaveBeenCalledTimes(2)
- // this should only call the childeffect
- nums.num1 = 4
- expect(dummy).toEqual({ num1: 4, num2: 1, num3: 2 })
- expect(parentSpy).toHaveBeenCalledTimes(1)
- expect(childSpy).toHaveBeenCalledTimes(3)
- // this calls the parenteffect, which calls the childeffect once
- nums.num2 = 10
- expect(dummy).toEqual({ num1: 4, num2: 10, num3: 2 })
- expect(parentSpy).toHaveBeenCalledTimes(2)
- expect(childSpy).toHaveBeenCalledTimes(4)
- // this calls the parenteffect, which calls the childeffect once
- nums.num3 = 7
- expect(dummy).toEqual({ num1: 4, num2: 10, num3: 7 })
- expect(parentSpy).toHaveBeenCalledTimes(3)
- expect(childSpy).toHaveBeenCalledTimes(5)
- })
- it('should observe json methods', () => {
- let dummy = <Record<string, number>>{}
- const obj = reactive<Record<string, number>>({})
- effect(() => {
- dummy = JSON.parse(JSON.stringify(obj))
- })
- obj.a = 1
- expect(dummy.a).toBe(1)
- })
- it('should observe class method invocations', () => {
- class Model {
- count: number
- constructor() {
- this.count = 0
- }
- inc() {
- this.count++
- }
- }
- const model = reactive(new Model())
- let dummy
- effect(() => {
- dummy = model.count
- })
- expect(dummy).toBe(0)
- model.inc()
- expect(dummy).toBe(1)
- })
- it('lazy', () => {
- const obj = reactive({ foo: 1 })
- let dummy
- const runner = effect(() => (dummy = obj.foo), { lazy: true })
- expect(dummy).toBe(undefined)
- expect(runner()).toBe(1)
- expect(dummy).toBe(1)
- obj.foo = 2
- expect(dummy).toBe(2)
- })
- it('scheduler', () => {
- let dummy
- let run: any
- const scheduler = vi.fn(() => {
- run = runner
- })
- const obj = reactive({ foo: 1 })
- const runner = effect(
- () => {
- dummy = obj.foo
- },
- { scheduler },
- )
- expect(scheduler).not.toHaveBeenCalled()
- expect(dummy).toBe(1)
- // should be called on first trigger
- obj.foo++
- expect(scheduler).toHaveBeenCalledTimes(1)
- // should not run yet
- expect(dummy).toBe(1)
- // manually run
- run()
- // should have run
- expect(dummy).toBe(2)
- })
- it('events: onTrack', () => {
- let events: DebuggerEvent[] = []
- let dummy
- const onTrack = vi.fn((e: DebuggerEvent) => {
- events.push(e)
- })
- const obj = reactive({ foo: 1, bar: 2 })
- const runner = effect(
- () => {
- dummy = obj.foo
- dummy = 'bar' in obj
- dummy = Object.keys(obj)
- },
- { onTrack },
- )
- expect(dummy).toEqual(['foo', 'bar'])
- expect(onTrack).toHaveBeenCalledTimes(3)
- expect(events).toEqual([
- {
- effect: runner.effect,
- target: toRaw(obj),
- type: TrackOpTypes.GET,
- key: 'foo',
- },
- {
- effect: runner.effect,
- target: toRaw(obj),
- type: TrackOpTypes.HAS,
- key: 'bar',
- },
- {
- effect: runner.effect,
- target: toRaw(obj),
- type: TrackOpTypes.ITERATE,
- key: ITERATE_KEY,
- },
- ])
- })
- it('events: onTrigger', () => {
- let events: DebuggerEvent[] = []
- let dummy
- const onTrigger = vi.fn((e: DebuggerEvent) => {
- events.push(e)
- })
- const obj = reactive<{ foo?: number }>({ foo: 1 })
- const runner = effect(
- () => {
- dummy = obj.foo
- },
- { onTrigger },
- )
- obj.foo!++
- expect(dummy).toBe(2)
- expect(onTrigger).toHaveBeenCalledTimes(1)
- expect(events[0]).toEqual({
- effect: runner.effect,
- target: toRaw(obj),
- type: TriggerOpTypes.SET,
- key: 'foo',
- oldValue: 1,
- newValue: 2,
- })
- delete obj.foo
- expect(dummy).toBeUndefined()
- expect(onTrigger).toHaveBeenCalledTimes(2)
- expect(events[1]).toEqual({
- effect: runner.effect,
- target: toRaw(obj),
- type: TriggerOpTypes.DELETE,
- key: 'foo',
- oldValue: 2,
- })
- })
- it('stop', () => {
- let dummy
- const obj = reactive({ prop: 1 })
- const runner = effect(() => {
- dummy = obj.prop
- })
- obj.prop = 2
- expect(dummy).toBe(2)
- stop(runner)
- obj.prop = 3
- expect(dummy).toBe(2)
- // stopped effect should still be manually callable
- runner()
- expect(dummy).toBe(3)
- })
- it('events: onStop', () => {
- const onStop = vi.fn()
- const runner = effect(() => {}, {
- onStop,
- })
- stop(runner)
- expect(onStop).toHaveBeenCalled()
- })
- it('stop: a stopped effect is nested in a normal effect', () => {
- let dummy
- const obj = reactive({ prop: 1 })
- const runner = effect(() => {
- dummy = obj.prop
- })
- stop(runner)
- obj.prop = 2
- expect(dummy).toBe(1)
- // observed value in inner stopped effect
- // will track outer effect as an dependency
- effect(() => {
- runner()
- })
- expect(dummy).toBe(2)
- // notify outer effect to run
- obj.prop = 3
- expect(dummy).toBe(3)
- })
- it('markRaw', () => {
- const obj = reactive({
- foo: markRaw({
- prop: 0,
- }),
- })
- let dummy
- effect(() => {
- dummy = obj.foo.prop
- })
- expect(dummy).toBe(0)
- obj.foo.prop++
- expect(dummy).toBe(0)
- obj.foo = { prop: 1 }
- expect(dummy).toBe(1)
- })
- it('should not be triggered when the value and the old value both are NaN', () => {
- const obj = reactive({
- foo: NaN,
- })
- const fnSpy = vi.fn(() => obj.foo)
- effect(fnSpy)
- obj.foo = NaN
- expect(fnSpy).toHaveBeenCalledTimes(1)
- })
- it('should trigger all effects when array length is set to 0', () => {
- const observed: any = reactive([1])
- let dummy, record
- effect(() => {
- dummy = observed.length
- })
- effect(() => {
- record = observed[0]
- })
- expect(dummy).toBe(1)
- expect(record).toBe(1)
- observed[1] = 2
- expect(observed[1]).toBe(2)
- observed.unshift(3)
- expect(dummy).toBe(3)
- expect(record).toBe(3)
- observed.length = 0
- expect(dummy).toBe(0)
- expect(record).toBeUndefined()
- })
- it('should not be triggered when set with the same proxy', () => {
- const obj = reactive({ foo: 1 })
- const observed: any = reactive({ obj })
- const fnSpy = vi.fn(() => observed.obj)
- effect(fnSpy)
- expect(fnSpy).toHaveBeenCalledTimes(1)
- observed.obj = obj
- expect(fnSpy).toHaveBeenCalledTimes(1)
- const obj2 = reactive({ foo: 1 })
- const observed2: any = shallowReactive({ obj2 })
- const fnSpy2 = vi.fn(() => observed2.obj2)
- effect(fnSpy2)
- expect(fnSpy2).toHaveBeenCalledTimes(1)
- observed2.obj2 = obj2
- expect(fnSpy2).toHaveBeenCalledTimes(1)
- })
- it('should be triggered when set length with string', () => {
- let ret1 = 'idle'
- let ret2 = 'idle'
- const arr1 = reactive(new Array(11).fill(0))
- const arr2 = reactive(new Array(11).fill(0))
- effect(() => {
- ret1 = arr1[10] === undefined ? 'arr[10] is set to empty' : 'idle'
- })
- effect(() => {
- ret2 = arr2[10] === undefined ? 'arr[10] is set to empty' : 'idle'
- })
- arr1.length = 2
- arr2.length = '2' as any
- expect(ret1).toBe(ret2)
- })
- describe('readonly + reactive for Map', () => {
- test('should work with readonly(reactive(Map))', () => {
- const m = reactive(new Map())
- const roM = readonly(m)
- const fnSpy = vi.fn(() => roM.get(1))
- effect(fnSpy)
- expect(fnSpy).toHaveBeenCalledTimes(1)
- m.set(1, 1)
- expect(fnSpy).toHaveBeenCalledTimes(2)
- })
- test('should work with observed value as key', () => {
- const key = reactive({})
- const m = reactive(new Map())
- m.set(key, 1)
- const roM = readonly(m)
- const fnSpy = vi.fn(() => roM.get(key))
- effect(fnSpy)
- expect(fnSpy).toHaveBeenCalledTimes(1)
- m.set(key, 1)
- expect(fnSpy).toHaveBeenCalledTimes(1)
- m.set(key, 2)
- expect(fnSpy).toHaveBeenCalledTimes(2)
- })
- test('should track hasOwnProperty', () => {
- const obj: any = reactive({})
- let has = false
- const fnSpy = vi.fn()
- effect(() => {
- fnSpy()
- has = obj.hasOwnProperty('foo')
- })
- expect(fnSpy).toHaveBeenCalledTimes(1)
- expect(has).toBe(false)
- obj.foo = 1
- expect(fnSpy).toHaveBeenCalledTimes(2)
- expect(has).toBe(true)
- delete obj.foo
- expect(fnSpy).toHaveBeenCalledTimes(3)
- expect(has).toBe(false)
- // should not trigger on unrelated key
- obj.bar = 2
- expect(fnSpy).toHaveBeenCalledTimes(3)
- expect(has).toBe(false)
- })
- })
- it('should be triggered once with pauseScheduling', () => {
- const counter = reactive({ num: 0 })
- const counterSpy = vi.fn(() => counter.num)
- effect(counterSpy)
- counterSpy.mockClear()
- pauseScheduling()
- counter.num++
- counter.num++
- resetScheduling()
- expect(counterSpy).toHaveBeenCalledTimes(1)
- })
- // #10082
- it('should set dirtyLevel when effect is allowRecurse and is running', async () => {
- const s = ref(0)
- const n = computed(() => s.value + 1)
- const Child = {
- setup() {
- s.value++
- return () => n.value
- },
- }
- const renderSpy = vi.fn()
- const Parent = {
- setup() {
- return () => {
- renderSpy()
- return [n.value, h(Child)]
- }
- },
- }
- const root = nodeOps.createElement('div')
- render(h(Parent), root)
- await nextTick()
- expect(serializeInner(root)).toBe('22')
- expect(renderSpy).toHaveBeenCalledTimes(2)
- })
- describe('empty dep cleanup', () => {
- it('should remove the dep when the effect is stopped', () => {
- const obj = reactive({ prop: 1 })
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBeUndefined()
- const runner = effect(() => obj.prop)
- const dep = getDepFromReactive(toRaw(obj), 'prop')
- expect(dep).toHaveLength(1)
- obj.prop = 2
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBe(dep)
- expect(dep).toHaveLength(1)
- stop(runner)
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBeUndefined()
- obj.prop = 3
- runner()
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBeUndefined()
- })
- it('should only remove the dep when the last effect is stopped', () => {
- const obj = reactive({ prop: 1 })
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBeUndefined()
- const runner1 = effect(() => obj.prop)
- const dep = getDepFromReactive(toRaw(obj), 'prop')
- expect(dep).toHaveLength(1)
- const runner2 = effect(() => obj.prop)
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBe(dep)
- expect(dep).toHaveLength(2)
- obj.prop = 2
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBe(dep)
- expect(dep).toHaveLength(2)
- stop(runner1)
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBe(dep)
- expect(dep).toHaveLength(1)
- obj.prop = 3
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBe(dep)
- expect(dep).toHaveLength(1)
- stop(runner2)
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBeUndefined()
- obj.prop = 4
- runner1()
- runner2()
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBeUndefined()
- })
- it('should remove the dep when it is no longer used by the effect', () => {
- const obj = reactive<{ a: number; b: number; c: 'a' | 'b' }>({
- a: 1,
- b: 2,
- c: 'a',
- })
- expect(getDepFromReactive(toRaw(obj), 'prop')).toBeUndefined()
- effect(() => obj[obj.c])
- const depC = getDepFromReactive(toRaw(obj), 'c')
- expect(getDepFromReactive(toRaw(obj), 'a')).toHaveLength(1)
- expect(getDepFromReactive(toRaw(obj), 'b')).toBeUndefined()
- expect(depC).toHaveLength(1)
- obj.c = 'b'
- obj.a = 4
- expect(getDepFromReactive(toRaw(obj), 'a')).toBeUndefined()
- expect(getDepFromReactive(toRaw(obj), 'b')).toHaveLength(1)
- expect(getDepFromReactive(toRaw(obj), 'c')).toBe(depC)
- expect(depC).toHaveLength(1)
- })
- })
- })
|