refactor: simplify unwatch implementation

LittleSound · Dec 31, 2023 · 2213634 · 2213634
1 parent f44ef0b
commit 2213634
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 26 deletions.
diff --git a/packages/reactivity/__tests__/baseWatch.spec.ts b/packages/reactivity/__tests__/baseWatch.spec.ts
@@ -64,7 +64,7 @@ describe('baseWatch', () => {
     )
 
     const source = ref(0)
-    const stop = baseWatch(
+    const effect = baseWatch(
       source,
       () => {
         onEffectCleanup(() => {
@@ -88,7 +88,7 @@ describe('baseWatch', () => {
       BaseWatchErrorCodes.WATCH_CALLBACK,
     ])
 
-    stop()
+    effect!.stop()
     source.value++
     expect(onError.mock.calls.length).toBe(3)
     expect(onError.mock.calls[2]).toMatchObject([

diff --git a/packages/reactivity/src/baseWatch.ts b/packages/reactivity/src/baseWatch.ts
@@ -77,12 +77,6 @@ export interface BaseWatchOptions<Immediate = boolean> extends DebuggerOptions {
   onWarn?: HandleWarn
 }
 
-type WatchStopHandle = () => void
-
-export interface WatchInstance extends WatchStopHandle {
-  effect?: ReactiveEffect
-}
-
 // initial value for watchers to trigger on undefined initial values
 const INITIAL_WATCHER_VALUE = {}
 
@@ -146,7 +140,7 @@ export function baseWatch(
     onTrack,
     onTrigger,
   }: BaseWatchOptions = EMPTY_OBJ,
-): WatchInstance {
+): ReactiveEffect | undefined {
   const warnInvalidSource = (s: unknown) => {
     onWarn(
       `Invalid watch source: `,
@@ -232,7 +226,7 @@ export function baseWatch(
       // onEffectCleanup need use effect as a key
       getCurrentScope()?.effects.push((effect = {} as any))
       getter()
-      return NOOP
+      return
     }
     if (immediate) {
       // onEffectCleanup need use effect as a key
@@ -243,12 +237,12 @@ export function baseWatch(
         BaseWatchErrorCodes.WATCH_CALLBACK,
         [getter(), isMultiSource ? [] : undefined, onEffectCleanup],
       )
-      return NOOP
+      return
     }
     const _cb = cb
     cb = (...args) => {
       _cb(...args)
-      unwatch()
+      effect?.stop()
     }
   }
 
@@ -329,11 +323,6 @@ export function baseWatch(
     }
   }
 
-  const unwatch: WatchInstance = () => {
-    effect.stop()
-  }
-  unwatch.effect = effect
-
   if (__DEV__) {
     effect.onTrack = onTrack
     effect.onTrigger = onTrigger
@@ -354,7 +343,7 @@ export function baseWatch(
     })
   }
 
-  return unwatch
+  return effect
 }
 
 export function traverse(value: unknown, seen?: Set<unknown>) {

diff --git a/packages/reactivity/src/index.ts b/packages/reactivity/src/index.ts
@@ -76,5 +76,4 @@ export {
   traverse,
   type BaseWatchOptions,
   type Scheduler,
-  type WatchInstance,
 } from './baseWatch'
diff --git a/packages/runtime-core/src/apiWatch.ts b/packages/runtime-core/src/apiWatch.ts
@@ -223,14 +223,16 @@ function doWatch(
   const scheduler = getSchedulerByFlushMode(flush)({ instance })
   extendOptions.scheduler = scheduler
 
-  let baseUnwatch = baseWatch(source, cb, extend({}, options, extendOptions))
+  let effect = baseWatch(source, cb, extend({}, options, extendOptions))
 
-  const unwatch = () => {
-    baseUnwatch()
-    if (instance && instance.scope) {
-      remove(instance.scope.effects!, baseUnwatch.effect)
-    }
-  }
+  const unwatch = !effect
+    ? NOOP
+    : () => {
+        effect!.stop()
+        if (instance && instance.scope) {
+          remove(instance.scope.effects!, effect)
+        }
+      }
 
   if (__SSR__ && ssrCleanup) ssrCleanup.push(unwatch)
   return unwatch