refactor: use watchDebounced from @netlify/dev-utils (#7467)

* Replaced all usages of cli watchDebounced with dev-utils

* removed unused imports in command-helpers.ts

* Removed unused exports that are now in @netlify/dev-utils

* Revising watchDebounced mock test

* Fixed import group in registry.ts

Author: keanu-a

src/lib/edge-functions/registry.ts

@@ -3,6 +3,7 @@ import { join } from 'path'
 import { fileURLToPath } from 'url'
 
 import type { Declaration, EdgeFunction, FunctionConfig, Manifest, ModuleGraph } from '@netlify/edge-bundler'
+import { watchDebounced } from '@netlify/dev-utils'
 
 import BaseCommand from '../../commands/base-command.js'
 import {
@@ -13,7 +14,6 @@ import {
   chalk,
   log,
   warn,
-  watchDebounced,
   isNodeError,
   type NormalizedCachedConfigConfig,
 } from '../../utils/command-helpers.js'

src/lib/functions/registry.ts

@@ -4,7 +4,7 @@ import { basename, extname, isAbsolute, join, resolve } from 'path'
 import { env } from 'process'
 
 import { type ListedFunction, listFunctions, type Manifest } from '@netlify/zip-it-and-ship-it'
-import type { MemoizeCache } from '@netlify/dev-utils'
+import { type MemoizeCache, watchDebounced } from '@netlify/dev-utils'
 import extractZip from 'extract-zip'
 
 import {
@@ -15,7 +15,6 @@ import {
   NETLIFYDEVLOG,
   NETLIFYDEVWARN,
   warn,
-  watchDebounced,
   type NormalizedCachedConfigConfig,
 } from '../../utils/command-helpers.js'
 import { getFrameworksAPIPaths } from '../../utils/frameworks-api.js'

src/utils/command-helpers.ts

@@ -1,4 +1,3 @@
-import { once } from 'events'
 import os from 'os'
 import fs from 'fs'
 import process from 'process'
@@ -7,10 +6,7 @@ import { format, inspect } from 'util'
 import type { NetlifyAPI } from '@netlify/api'
 import { getGlobalConfigStore } from '@netlify/dev-utils'
 import { Chalk } from 'chalk'
-import chokidar from 'chokidar'
-import decache from 'decache'
 import WSL from 'is-wsl'
-import debounce from 'lodash/debounce.js'
 import terminalLink from 'terminal-link'
 
 import { startSpinner } from '../lib/spinner.js'
@@ -235,79 +231,13 @@ export const normalizeConfig = (config: CachedConfig['config']): NormalizedCache
   return publishOrigin === 'default' ? { ...config, build } : config
 }
 
-const DEBOUNCE_WAIT = 100
-
-interface WatchDebouncedOptions {
-  depth?: number
-  ignored?: (string | RegExp)[]
-  onAdd?: (paths: string[]) => void
-  onChange?: (paths: string[]) => void
-  onUnlink?: (paths: string[]) => void
-}
-
-/**
- * Adds a file watcher to a path or set of paths and debounces the events.
- */
-export const watchDebounced = async (
-  target: string | string[],
-  { depth, ignored = [], onAdd = noOp, onChange = noOp, onUnlink = noOp }: WatchDebouncedOptions,
-) => {
-  const baseIgnores = [/\/(node_modules|.git)\//]
-  const watcher = chokidar.watch(target, { depth, ignored: [...baseIgnores, ...ignored], ignoreInitial: true })
-
-  await once(watcher, 'ready')
-
-  let onChangeQueue: string[] = []
-  let onAddQueue: string[] = []
-  let onUnlinkQueue: string[] = []
-
-  const debouncedOnChange = debounce(() => {
-    onChange(onChangeQueue)
-    onChangeQueue = []
-  }, DEBOUNCE_WAIT)
-  const debouncedOnAdd = debounce(() => {
-    onAdd(onAddQueue)
-    onAddQueue = []
-  }, DEBOUNCE_WAIT)
-  const debouncedOnUnlink = debounce(() => {
-    onUnlink(onUnlinkQueue)
-    onUnlinkQueue = []
-  }, DEBOUNCE_WAIT)
-
-  watcher
-    .on('change', (path) => {
-      // @ts-expect-error
-      decache(path)
-      onChangeQueue.push(path)
-      debouncedOnChange()
-    })
-    .on('unlink', (path) => {
-      // @ts-expect-error
-      decache(path)
-      onUnlinkQueue.push(path)
-      debouncedOnUnlink()
-    })
-    .on('add', (path) => {
-      // @ts-expect-error
-      decache(path)
-      onAddQueue.push(path)
-      debouncedOnAdd()
-    })
-
-  return watcher
-}
-
 export const getTerminalLink = (text: string, url: string): string =>
   terminalLink(text, url, { fallback: () => `${text} (${url})` })
 
 export const isNodeError = (err: unknown): err is NodeJS.ErrnoException => err instanceof Error
 
 export const nonNullable = <T>(value: T): value is NonNullable<T> => value !== null && value !== undefined
 
-export const noOp = () => {
-  // no-op
-}
-
 export interface APIError extends Error {
   status: number
   message: string

tests/unit/lib/functions/registry.test.ts

@@ -2,10 +2,10 @@ import { mkdir, mkdtemp, writeFile } from 'fs/promises'
 import { tmpdir } from 'os'
 import { join } from 'path'
 
+import { watchDebounced } from '@netlify/dev-utils'
 import { describe, expect, test, vi } from 'vitest'
 
 import { FunctionsRegistry } from '../../../../src/lib/functions/registry.js'
-import { watchDebounced } from '../../../../src/utils/command-helpers.js'
 import { getFrameworksAPIPaths } from '../../../../src/utils/frameworks-api.js'
 
 const duplicateFunctions = [
@@ -36,8 +36,8 @@ const duplicateFunctions = [
   },
 ]
 
-vi.mock('../../../../src/utils/command-helpers.js', async () => {
-  const helpers = await vi.importActual('../../../../src/utils/command-helpers.js')
+vi.mock('@netlify/dev-utils', async () => {
+  const helpers = await vi.importActual('@netlify/dev-utils')
 
   return {
     ...helpers,