import named export from parcel/watcher (#2341)

* import named export from parcel/watcher

* try injecting subscribe

* revise subscription mock

* not needed

---------

Co-authored-by: Kamil Sobol <[email protected]>

Author: josefaidt

.changeset/chilled-pants-kiss.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/sandbox': patch
+---
+
+move from importing the default export from the commonjs distribution of parcle/watcher to named export

packages/sandbox/src/file_watching_sandbox.test.ts

@@ -1,6 +1,6 @@
 import { afterEach, beforeEach, describe, it, mock } from 'node:test';
 import path from 'path';
-import watcher from '@parcel/watcher';
+import watcher, { subscribe as _subscribe } from '@parcel/watcher';
 import {
   CDK_DEFAULT_BOOTSTRAP_VERSION_PARAMETER_NAME,
   FileWatchingSandbox,
@@ -40,7 +40,11 @@ import { EOL } from 'os';
 
 // Watcher mocks
 const unsubscribeMockFn = mock.fn();
-const subscribeMock = mock.method(watcher, 'subscribe', async () => {
+const subscribeMock = mock.fn<
+  (
+    ...args: Parameters<typeof _subscribe>
+  ) => Promise<{ unsubscribe: typeof unsubscribeMockFn }>
+>(async () => {
   return { unsubscribe: unsubscribeMockFn };
 });
 const packageManagerControllerFactory = new PackageManagerControllerFactory(
@@ -148,7 +152,8 @@ void describe('Sandbox to check if region is bootstrapped', () => {
       ssmClientMock,
       functionsLogStreamerMock as unknown as LambdaFunctionLogStreamer,
       printer as unknown as Printer,
-      openMock as never
+      openMock as never,
+      subscribeMock as never
     );
 
     ssmClientSendMock.mock.resetCalls();
@@ -1172,7 +1177,8 @@ const setupAndStartSandbox = async (
     testData.ssmClient,
     testData.functionsLogStreamer,
     printer as unknown as Printer,
-    testData.open ?? _open
+    testData.open ?? _open,
+    subscribeMock as never
   );
 
   await sandboxInstance.start(sandboxOptions);

packages/sandbox/src/file_watching_sandbox.ts

@@ -1,5 +1,5 @@
 import debounce from 'debounce-promise';
-import parcelWatcher, { subscribe } from '@parcel/watcher';
+import { subscribe as _subscribe } from '@parcel/watcher';
 import { AmplifySandboxExecutor } from './sandbox_executor.js';
 import {
   BackendIdSandboxResolver,
@@ -67,7 +67,7 @@ export const getBootstrapUrl = (region: string) =>
  * Runs a file watcher and deploys
  */
 export class FileWatchingSandbox extends EventEmitter implements Sandbox {
-  private watcherSubscription: Awaited<ReturnType<typeof subscribe>>;
+  private watcherSubscription: Awaited<ReturnType<typeof _subscribe>>;
   private outputFilesExcludedFromWatch = ['.amplify'];
   private filesChangesTracker: FilesChangesTracker;
 
@@ -80,7 +80,8 @@ export class FileWatchingSandbox extends EventEmitter implements Sandbox {
     private readonly ssmClient: SSMClient,
     private readonly functionsLogStreamer: LambdaFunctionLogStreamer,
     private readonly printer: Printer,
-    private readonly open = _open
+    private readonly open = _open,
+    private readonly subscribe = _subscribe
   ) {
     process.once('SIGINT', () => void this.stop());
     process.once('SIGTERM', () => void this.stop());
@@ -202,7 +203,7 @@ export class FileWatchingSandbox extends EventEmitter implements Sandbox {
     });
 
     if (watchForChanges) {
-      this.watcherSubscription = await parcelWatcher.subscribe(
+      this.watcherSubscription = await this.subscribe(
         watchDir,
         async (_, events) => {
           // Log and track file changes.