feat: effect is always fired once on recovery

vuejs · Dec 6, 2023 · 406268d · 406268d
1 parent 287c182
commit 406268d
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 51 deletions.
diff --git a/packages/reactivity/__tests__/effect.spec.ts b/packages/reactivity/__tests__/effect.spec.ts
@@ -1089,11 +1089,11 @@ describe('reactivity/effect', () => {
  expect(obj.foo).toBe(2)
 
  runner.effect.resume()
- expect(fnSpy).toHaveBeenCalledTimes(1)
+ expect(fnSpy).toHaveBeenCalledTimes(2)
  expect(obj.foo).toBe(2)
 
  obj.foo++
- expect(fnSpy).toHaveBeenCalledTimes(2)
+ expect(fnSpy).toHaveBeenCalledTimes(3)
  expect(obj.foo).toBe(3)
  })
 
@@ -1110,12 +1110,12 @@ describe('reactivity/effect', () => {
  expect(fnSpy).toHaveBeenCalledTimes(1)
  expect(obj.foo).toBe(2)
 
- runner.effect.resume(true)
- expect(fnSpy).toHaveBeenCalledTimes(2)
- expect(obj.foo).toBe(2)
-
  obj.foo++
- expect(fnSpy).toHaveBeenCalledTimes(3)
+ expect(fnSpy).toHaveBeenCalledTimes(1)
+ expect(obj.foo).toBe(3)
+
+ runner.effect.resume()
+ expect(fnSpy).toHaveBeenCalledTimes(2)
  expect(obj.foo).toBe(3)
  })
 })
diff --git a/packages/reactivity/__tests__/effectScope.spec.ts b/packages/reactivity/__tests__/effectScope.spec.ts
@@ -316,39 +316,11 @@ describe('reactivity/effect/scope', () => {
  await nextTick()
  expect(fnSpy).toHaveBeenCalledTimes(2)
 
- scope.resume()
- await nextTick()
- expect(fnSpy).toHaveBeenCalledTimes(2)
-
- counter.num++
- await nextTick()
- expect(fnSpy).toHaveBeenCalledTimes(3)
- })
-
- it('should execute all saved run methods in effects immediately upon resuming', async () => {
- const counter = reactive({ num: 0 })
- const fnSpy = vi.fn(() => counter.num)
- const scope = new EffectScope()
- scope.run(() => {
- effect(fnSpy)
- })
-
- expect(fnSpy).toHaveBeenCalledTimes(1)
-
  counter.num++
  await nextTick()
  expect(fnSpy).toHaveBeenCalledTimes(2)
 
- scope.pause()
- counter.num++
- await nextTick()
- expect(fnSpy).toHaveBeenCalledTimes(2)
-
- scope.resume(true)
+ scope.resume()
  expect(fnSpy).toHaveBeenCalledTimes(3)
-
- counter.num++
- await nextTick()
- expect(fnSpy).toHaveBeenCalledTimes(4)
  })
 })
diff --git a/packages/reactivity/src/effect.ts b/packages/reactivity/src/effect.ts
@@ -103,18 +103,15 @@ export class ReactiveEffect<T = any> {
 
  /**
  * Resumes the execution of the reactive effect.
- * @param {boolean} immediate - If true, executes the saved run method immediately upon resuming.
  */
- resume(immediate: boolean = false) {
+ resume() {
  if (!this._isStopped) {
  this.active = true
  if (pausedQueueEffects.has(this)) {
  pausedQueueEffects.delete(this)
  queueEffectSchedulers.push(this.scheduler!)
- if (immediate) {
- pauseScheduling()
- resetScheduling()
- }
+ pauseScheduling()
+ resetScheduling()
  }
  }
  }

diff --git a/packages/reactivity/src/effectScope.ts b/packages/reactivity/src/effectScope.ts
@@ -66,20 +66,18 @@ export class EffectScope {
 
  /**
  * Resumes the effect scope, including all child scopes and effects.
- *
- * @param {boolean} immediate - If true, executes all saved run methods in effects immediately upon resuming.
  */
- resume(immediate: boolean = false) {
+ resume() {
  if (this._active) {
  if (this._isPaused) {
  this._isPaused = false
  if (this.scopes) {
  for (let i = 0, l = this.scopes.length; i < l; i++) {
- this.scopes[i].resume(immediate)
+ this.scopes[i].resume()
  }
  }
  for (let i = 0, l = this.effects.length; i < l; i++) {
- this.effects[i].resume(immediate)
+ this.effects[i].resume()
  }
  }
  }

diff --git a/packages/runtime-core/__tests__/apiWatch.spec.ts b/packages/runtime-core/__tests__/apiWatch.spec.ts
@@ -1312,7 +1312,7 @@ describe('api: watch', () => {
  expect(cb).toHaveBeenCalledTimes(3)
  expect(cb).toHaveBeenLastCalledWith(4, 3, expect.any(Function))
 
- resume(true)
+ resume()
  await nextTick()
  expect(cb).toHaveBeenCalledTimes(4)
  expect(cb).toHaveBeenLastCalledWith(5, 4, expect.any(Function))

diff --git a/packages/runtime-core/src/apiWatch.ts b/packages/runtime-core/src/apiWatch.ts
@@ -82,7 +82,7 @@ export type WatchStopHandle = () => void
 
 export interface WatchHandle extends WatchStopHandle {
  pause: () => void
- resume: (immediate?: boolean) => void
+ resume: () => void
  stop: () => void
 }
 
@@ -393,8 +393,8 @@ function doWatch(
  }
 
  const watchHandle: WatchHandle = () => unwatch()
- watchHandle.pause = () => effect.pause()
- watchHandle.resume = immediate => effect.resume(immediate)
+ watchHandle.pause = effect.pause.bind(effect)
+ watchHandle.resume = effect.resume.bind(effect)
  watchHandle.stop = unwatch
 
  if (__DEV__) {