Refactor FileWatcher into a Class

packages/app/src/cli/services/dev/app-events/app-event-watcher.test.ts

@@ -1,5 +1,5 @@
 import {AppEvent, AppEventWatcher, EventType, ExtensionEvent} from './app-event-watcher.js'
-import {OutputContextOptions, WatcherEvent, startFileWatcher} from './file-watcher.js'
+import {OutputContextOptions, WatcherEvent, FileWatcher} from './file-watcher.js'
 import {ESBuildContextManager} from './app-watcher-esbuild.js'
 import {
   testApp,
@@ -12,14 +12,14 @@ import {
 } from '../../../models/app/app.test-data.js'
 import {ExtensionInstance} from '../../../models/extensions/extension-instance.js'
 import {loadApp} from '../../../models/app/loader.js'
+import {AppInterface} from '../../../models/app/app.js'
 import {describe, expect, test, vi} from 'vitest'
 import {AbortSignal} from '@shopify/cli-kit/node/abort'
 import {flushPromises} from '@shopify/cli-kit/node/promises'
 import {inTemporaryDirectory} from '@shopify/cli-kit/node/fs'
 import {joinPath} from '@shopify/cli-kit/node/path'
 import {Writable} from 'stream'
 
-vi.mock('./file-watcher.js')
 vi.mock('../../../models/app/loader.js')
 vi.mock('./app-watcher-esbuild.js')
 
@@ -234,7 +234,6 @@ describe('app-event-watcher when receiving a file event', () => {
       // Given
       await inTemporaryDirectory(async (tmpDir) => {
         vi.mocked(loadApp).mockResolvedValue(testApp({allExtensions: finalExtensions}))
-        vi.mocked(startFileWatcher).mockImplementation(async (app, options, onChange) => onChange([fileWatchEvent]))
 
         const buildOutputPath = joinPath(tmpDir, '.shopify', 'bundle')
 
@@ -244,7 +243,9 @@ describe('app-event-watcher when receiving a file event', () => {
           configuration: {scopes: '', extension_directories: [], path: 'shopify.app.custom.toml'},
         })
 
-        const watcher = new AppEventWatcher(app, 'url', buildOutputPath, new MockESBuildContextManager())
+        const mockManager = new MockESBuildContextManager()
+        const mockFileWatcher = new MockFileWatcher(app, outputOptions, [fileWatchEvent])
+        const watcher = new AppEventWatcher(app, 'url', buildOutputPath, mockManager, mockFileWatcher)
         const emitSpy = vi.spyOn(watcher, 'emit')
         await watcher.start()
 
@@ -310,7 +311,6 @@ describe('app-event-watcher build extension errors', () => {
         extensionPath: '/extensions/ui_extension_1',
         startTime: [0, 0],
       }
-      vi.mocked(startFileWatcher).mockImplementation(async (app, options, onChange) => onChange([fileWatchEvent]))
 
       // Given
       const esbuildError = {
@@ -330,9 +330,10 @@ describe('app-event-watcher build extension errors', () => {
         allExtensions: [extension1],
         configuration: {scopes: '', extension_directories: [], path: 'shopify.app.custom.toml'},
       })
+      const mockFileWatcher = new MockFileWatcher(app, outputOptions, [fileWatchEvent])
 
       // When
-      const watcher = new AppEventWatcher(app, 'url', buildOutputPath, mockManager)
+      const watcher = new AppEventWatcher(app, 'url', buildOutputPath, mockManager, mockFileWatcher)
       const stderr = {write: vi.fn()} as unknown as Writable
       const stdout = {write: vi.fn()} as unknown as Writable
 
@@ -363,7 +364,7 @@ describe('app-event-watcher build extension errors', () => {
         extensionPath: '/extensions/flow_action',
         startTime: [0, 0],
       }
-      vi.mocked(startFileWatcher).mockImplementation(async (app, options, onChange) => onChange([fileWatchEvent]))
+      // vi.mocked(startFileWatcher).mockImplementation(async (app, options, onChange) => onChange([fileWatchEvent]))
 
       // Given
       const esbuildError = {message: 'Build failed'}
@@ -376,7 +377,9 @@ describe('app-event-watcher build extension errors', () => {
       })
 
       // When
-      const watcher = new AppEventWatcher(app, 'url', buildOutputPath, new MockESBuildContextManager())
+      const mockManager = new MockESBuildContextManager()
+      const mockFileWatcher = new MockFileWatcher(app, outputOptions, [fileWatchEvent])
+      const watcher = new AppEventWatcher(app, 'url', buildOutputPath, mockManager, mockFileWatcher)
       const stderr = {write: vi.fn()} as unknown as Writable
       const stdout = {write: vi.fn()} as unknown as Writable
 
@@ -408,3 +411,20 @@ class MockESBuildContextManager extends ESBuildContextManager {
   async updateContexts(appEvent: AppEvent) {}
   async deleteContexts(extensions: ExtensionInstance[]) {}
 }
+
+// Mock class for FileWatcher
+// Used to trigger mocked file system events immediately after the watcher is started.
+class MockFileWatcher extends FileWatcher {
+  private readonly events: WatcherEvent[]
+
+  constructor(app: AppInterface, options: OutputContextOptions, events: WatcherEvent[]) {
+    super(app, options)
+    this.events = events
+  }
+
+  async start(): Promise<void> {}
+
+  onChange(listener: (events: WatcherEvent[]) => void) {
+    listener(this.events)
+  }
+}

packages/app/src/cli/services/dev/app-events/app-event-watcher.ts

@@ -1,5 +1,5 @@
 /* eslint-disable tsdoc/syntax */
-import {OutputContextOptions, startFileWatcher} from './file-watcher.js'
+import {FileWatcher, OutputContextOptions} from './file-watcher.js'
 import {ESBuildContextManager} from './app-watcher-esbuild.js'
 import {handleWatcherEvents} from './app-event-watcher-handler.js'
 import {AppLinkedInterface} from '../../../models/app/app.js'
@@ -96,12 +96,14 @@ export class AppEventWatcher extends EventEmitter {
   private started = false
   private ready = false
   private initialEvents: ExtensionEvent[] = []
+  private fileWatcher?: FileWatcher
 
   constructor(
     app: AppLinkedInterface,
     appURL?: string,
     buildOutputPath?: string,
     esbuildManager?: ESBuildContextManager,
+    fileWatcher?: FileWatcher,
   ) {
     super()
     this.app = app
@@ -117,6 +119,7 @@ export class AppEventWatcher extends EventEmitter {
         url: this.appURL ?? '',
         ...this.options,
       })
+    this.fileWatcher = fileWatcher
   }
 
   async start(options?: OutputContextOptions, buildExtensionsFirst = true) {
@@ -139,8 +142,8 @@ export class AppEventWatcher extends EventEmitter {
       await this.buildExtensions(this.initialEvents)
     }
 
-    // Start the file system watcher
-    await startFileWatcher(this.app, this.options, (events) => {
+    this.fileWatcher = this.fileWatcher ?? new FileWatcher(this.app, this.options)
+    this.fileWatcher?.onChange((events) => {
       handleWatcherEvents(events, this.app, this.options)
         .then(async (appEvent) => {
           if (appEvent?.extensionEvents.length === 0) outputDebug('Change detected, but no extensions were affected')
@@ -163,6 +166,7 @@ export class AppEventWatcher extends EventEmitter {
           this.options.stderr.write(`Error handling event: ${error.message}`)
         })
     })
+    await this.fileWatcher?.start()
 
     this.ready = true
     this.emit('ready', {app: this.app, extensionEvents: this.initialEvents})

packages/app/src/cli/services/dev/app-events/file-watcher.test.ts

@@ -1,4 +1,4 @@
-import {OutputContextOptions, WatcherEvent, startFileWatcher} from './file-watcher.js'
+import {FileWatcher, OutputContextOptions, WatcherEvent} from './file-watcher.js'
 import {
   testApp,
   testAppAccessConfigExtension,
@@ -198,7 +198,10 @@ describe('file-watcher events', () => {
       })
 
       // When
-      await startFileWatcher(app, outputOptions, vi.fn())
+      const fileWatcher = new FileWatcher(app, outputOptions)
+      fileWatcher.onChange(vi.fn())
+
+      await fileWatcher.start()
 
       // Then
       expect(watchSpy).toHaveBeenCalledWith([joinPath(dir, '/shopify.app.toml'), joinPath(dir, '/extensions')], {
@@ -232,7 +235,10 @@ describe('file-watcher events', () => {
 
       // When
       const onChange = vi.fn()
-      await startFileWatcher(defaultApp, outputOptions, onChange)
+      const fileWatcher = new FileWatcher(defaultApp, outputOptions)
+      fileWatcher.onChange(onChange)
+
+      await fileWatcher.start()
 
       // Then
       await flushPromises()
@@ -260,7 +266,10 @@ describe('file-watcher events', () => {
 
       // When
       const onChange = vi.fn()
-      await startFileWatcher(defaultApp, outputOptions, onChange)
+      const fileWatcher = new FileWatcher(defaultApp, outputOptions)
+      fileWatcher.onChange(onChange)
+
+      await fileWatcher.start()
 
       // Then
       await flushPromises()