// reactivity/src/effect.ts
export interface DebuggerOptions {
  onTrack?: (event: DebuggerEvent) => void
  onTrigger?: (event: DebuggerEvent) => void
}
?
// runtime-core/apiWatch.ts
export interface WatchOptionsBase extends DebuggerOptions {
  flush?: 'pre' | 'post' | 'sync'
}
?
export interface WatchOptions<Immediate = boolean> extends WatchOptionsBase {
  immediate?: Immediate
  deep?: boolean
}

// 副作用
export type WatchEffect = (onCleanup: OnCleanup) => void
?
export type WatchCallback<V = any, OV = any> = (
  value: V,
  oldValue: OV,
  onCleanup: OnCleanup
) => any
?
type OnCleanup = (cleanupFn: () => void) => void

// 單數(shù)據(jù)源類型：可以是 Ref 或 ComputedRef 或 函數(shù)
export type WatchSource<T = any> = Ref<T> | ComputedRef<T> | (() => T)
?
// 多數(shù)據(jù)源類型
type MultiWatchSources = (WatchSource<unknown> | object)[]
?

// watch的重載與實(shí)現(xiàn)
export function watch<
  T extends MultiWatchSources,
  Immediate extends Readonly<boolean> = false
>(
  sources: [...T],
  cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>,
  options?: WatchOptions<Immediate>
): WatchStopHandle
?
// overload: multiple sources w/ `as const`
// watch([foo, bar] as const, () => {})
// somehow [...T] breaks when the type is readonly
export function watch<
  T extends Readonly<MultiWatchSources>,
  Immediate extends Readonly<boolean> = false
>(
  source: T,
  cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>,
  options?: WatchOptions<Immediate>
): WatchStopHandle
?
// overload: single source + cb
export function watch<T, Immediate extends Readonly<boolean> = false>(
  source: WatchSource<T>,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: WatchOptions<Immediate>
): WatchStopHandle
?
// overload: watching reactive object w/ cb
export function watch<
  T extends object,
  Immediate extends Readonly<boolean> = false
>(
  source: T,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: WatchOptions<Immediate>
): WatchStopHandle
?
// implementation
export function watch<T = any, Immediate extends Readonly<boolean> = false>(
  source: T | WatchSource<T>,
  cb: any,
  options?: WatchOptions<Immediate>
): WatchStopHandle {
  if (__DEV__ && !isFunction(cb)) {
    warn(
      ``watch(fn, options?)` signature has been moved to a separate API. ` +
        `Use `watchEffect(fn, options?)` instead. `watch` now only ` +
        `supports `watch(source, cb, options?) signature.`
    )
  }
  return doWatch(source as any, cb, options)
}

function doWatch(
  source: WatchSource | WatchSource[] | WatchEffect | object,
  cb: WatchCallback | null,
  { immediate, deep, flush, onTrack, onTrigger }: WatchOptions = EMPTY_OBJ
): WatchStopHandle {
    // ...
  }

if (__DEV__ && !cb) {
    if (immediate !== undefined) {
      warn(
        `watch() "immediate" option is only respected when using the ` +
          `watch(source, callback, options?) signature.`
      )
    }
    if (deep !== undefined) {
      warn(
        `watch() "deep" option is only respected when using the ` +
          `watch(source, callback, options?) signature.`
      )
    }
  }
?
// 聲明一個source參數(shù)不合法的警告函數(shù)
const warnInvalidSource = (s: unknown) => {
    warn(
      `Invalid watch source: `,
      s,
      `A watch source can only be a getter/effect function, a ref, ` +
        `a reactive object, or an array of these types.`
    )
  }
// ...

// 拿到當(dāng)前實(shí)例，聲明了空的getter，初始化關(guān)閉強(qiáng)制觸發(fā)，且默認(rèn)為單數(shù)據(jù)源的偵聽
const instance = currentInstance
let getter: () => any
let forceTrigger = false
let isMultiSource = false
?
// 根據(jù)偵聽數(shù)據(jù)源的類型做相應(yīng)的處理
if (isRef(source)) {
    getter = () => source.value
    forceTrigger = isShallow(source)
  } else if (isReactive(source)) {
    getter = () => source
    deep = true
  } else if (isArray(source)) {
    isMultiSource = true
    forceTrigger = source.some(s => isReactive(s) || isShallow(s))
    getter = () =>
      // 可見，數(shù)組成員只能是Ref、Reactive或者函數(shù)，其它類型無法通過校驗(yàn)，將引發(fā)告警
      source.map(s => {
        if (isRef(s)) {
          return s.value
        } else if (isReactive(s)) {
          return traverse(s)
        } else if (isFunction(s)) {
          return callWithErrorHandling(s, instance, ErrorCodes.WATCH_GETTER)
        } else {
          __DEV__ && warnInvalidSource(s)
        }
      })
  } else if (isFunction(source)) {
    if (cb) {
      // getter with cb
      getter = () =>
        callWithErrorHandling(source, instance, ErrorCodes.WATCH_GETTER)
    } else {
      // no cb -> simple effect
      getter = () => {
        if (instance && instance.isUnmounted) {
          return
        }
        if (cleanup) {
          cleanup()
        }
        return callWithAsyncErrorHandling(
          source,
          instance,
          ErrorCodes.WATCH_CALLBACK,
          [onCleanup]
        )
      }
    }
  } else {
    getter = NOOP
    __DEV__ && warnInvalidSource(source)
  }

// 2.x array mutation watch compat
  if (__COMPAT__ && cb && !deep) {
    const baseGetter = getter
    getter = () => {
      const val = baseGetter()
      if (
        isArray(val) &&
        checkCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance)
      ) {
        traverse(val)
      }
      return val
    }
  }

export function traverse(value: unknown, seen?: Set<unknown>) {
  if (!isObject(value) || (value as any)[ReactiveFlags.SKIP]) {
    return value
  }
  seen = seen || new Set()
  if (seen.has(value)) {
    return value
  }
  seen.add(value)
  // Ref
  if (isRef(value)) {
    traverse(value.value, seen)
  } else if (isArray(value)) {
    // 數(shù)組
    for (let i = 0; i < value.length; i++) {
      traverse(value[i], seen)
    }
  } else if (isSet(value) || isMap(value)) {
    // 集合與映射
    value.forEach((v: any) => {
      traverse(v, seen)
    })
  } else if (isPlainObject(value)) {
    // 普通對象
    for (const key in value) {
      traverse((value as any)[key], seen)
    }
  }
  return value
}

let cleanup: () => void
  let onCleanup: OnCleanup = (fn: () => void) => {
    cleanup = effect.onStop = () => {
      callWithErrorHandling(fn, instance, ErrorCodes.WATCH_CLEANUP)
    }
  }
// in SSR there is no need to setup an actual effect, and it should be noop
// unless it's eager
if (__SSR__ && isInSSRComponentSetup) {
  // we will also not call the invalidate callback (+ runner is not set up)
  onCleanup = NOOP
  if (!cb) {
    getter()
  } else if (immediate) {
    callWithAsyncErrorHandling(cb, instance, ErrorCodes.WATCH_CALLBACK, [
      getter(),
      isMultiSource ? [] : undefined,
      onCleanup
    ])
  }
  return NOOP
}

let oldValue = isMultiSource ? [] : INITIAL_WATCHER_VALUE
// job為當(dāng)前watch要做的工作，后續(xù)通過調(diào)度器來處理
const job: SchedulerJob = () => {
  // 當(dāng)前effect不在active狀態(tài)，說明沒有觸發(fā)該effect的響應(yīng)式變化，直接返回 
  if (!effect.active) {
    return
  }
  // cb存在，說明是watch，而不是watchEffect
  if (cb) {
    // watch(source, cb)
    // 調(diào)用 effect.run 得到新的值 newValue
    const newValue = effect.run()
    if (
      deep ||
      forceTrigger ||
      // 取到的新值和舊值是否相同，如果有變化則進(jìn)入分支
      (isMultiSource
        ? (newValue as any[]).some((v, i) =>
            hasChanged(v, (oldValue as any[])[i])
          )
        : hasChanged(newValue, oldValue)) ||
      // 兼容2.x
      (__COMPAT__ &&
        isArray(newValue) &&
        isCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance))
    ) {
      // cleanup before running cb again
      if (cleanup) {
        cleanup()
      }
      // 用異步異常處理程序包裹了一層來調(diào)用cb
      callWithAsyncErrorHandling(cb, instance, ErrorCodes.WATCH_CALLBACK, [
        newValue,
        // pass undefined as the old value when it's changed for the first time
        oldValue === INITIAL_WATCHER_VALUE ? undefined : oldValue,
        onCleanup
      ])
      // cb執(zhí)行完成，當(dāng)前的新值就變成了舊值
      oldValue = newValue
    }
  } else {
    // cb不存在，則是watchEffect
    // watchEffect
    effect.run()
  }
}
// 設(shè)置allowRecurse，讓調(diào)度器知道它可以自己觸發(fā)
job.allowRecurse = !!cb

let scheduler: EffectScheduler
// 根據(jù)flush的值來創(chuàng)建不同的調(diào)度器
if (flush === 'sync') {
  scheduler = job as any // the scheduler function gets called directly
} else if (flush === 'post') {
  scheduler = () => queuePostRenderEffect(job, instance && instance.suspense)
} else {
  // default: 'pre'
  scheduler = () => queuePreFlushCb(job)
}
// 為 watch 創(chuàng)建 effect ，watchEffect就不必了，因?yàn)樽詭У挠?
const effect = new ReactiveEffect(getter, scheduler)
// 主要是調(diào)試用的onTrack和onTrigger，當(dāng)收集依賴和觸發(fā)更新時(shí)做一些操作
if (__DEV__) {
  effect.onTrack = onTrack
  effect.onTrigger = onTrigger
}

// initial run
// 有cb，是 watch
if (cb) {
  if (immediate) {
    job()
  } else {
    // 獲取一下當(dāng)前的值作為舊值
    oldValue = effect.run()
  }
} else if (flush === 'post') {
  // 沒有cb，是watchEffect，副作用的時(shí)機(jī)在組件更新之后，用queuePostRenderEffect包裹一層來調(diào)整時(shí)機(jī)
  queuePostRenderEffect(
    effect.run.bind(effect),
    instance && instance.suspense
  )
} else {
  // watchEffect，副作用的時(shí)機(jī)在組件更新之前，直接執(zhí)行一次effect.run
  effect.run()
}
// 返回一個WatchStopHandle，內(nèi)部執(zhí)行 effect.stop來達(dá)到停止偵聽的作用
return () => {
  effect.stop()
  // 移除當(dāng)前實(shí)例作用域下的當(dāng)前effect
  if (instance && instance.scope) {
    remove(instance.scope.effects!, effect)
  }
}