@react-native-harness/jest 1.1.0-rc.4 → 1.2.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-harness/jest",
-  "version": "1.1.0-rc.4",
+  "version": "1.2.0-rc.1",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -40,12 +40,12 @@
     "p-limit": "^7.1.1",
     "tslib": "^2.3.0",
     "yargs": "^17.7.2",
-    "@react-native-harness/bridge": "1.1.0-rc.4",
-    "@react-native-harness/plugins": "1.1.0-rc.4",
-    "@react-native-harness/platforms": "1.1.0-rc.4",
-    "@react-native-harness/tools": "1.1.0-rc.4",
-    "@react-native-harness/config": "1.1.0-rc.4",
-    "@react-native-harness/bundler-metro": "1.1.0-rc.4"
+    "@react-native-harness/bundler-metro": "1.2.0-rc.1",
+    "@react-native-harness/config": "1.2.0-rc.1",
+    "@react-native-harness/platforms": "1.2.0-rc.1",
+    "@react-native-harness/tools": "1.2.0-rc.1",
+    "@react-native-harness/bridge": "1.2.0-rc.1",
+    "@react-native-harness/plugins": "1.2.0-rc.1"
   },
   "devDependencies": {
     "@types/yargs": "^17.0.32",

package/src/__tests__/harness.test.ts

@@ -125,7 +125,7 @@ const createReporter = (): Reporter => {
 };
 
 const createMetroInstance = (
-  overrides: Partial<MetroInstance> = {}
+  overrides: Partial<MetroInstance> = {},
 ): MetroInstance => ({
   events: createReporter(),
   httpServer: {} as never,
@@ -163,7 +163,7 @@ const createAppMonitor = (): {
 };
 
 const createPlatformRunner = (
-  overrides: Partial<HarnessPlatformRunner> = {}
+  overrides: Partial<HarnessPlatformRunner> = {},
 ): HarnessPlatformRunner => ({
   startApp: vi.fn(async () => undefined),
   restartApp: vi.fn(async () => undefined),
@@ -175,7 +175,7 @@ const createPlatformRunner = (
 });
 
 const createHarnessConfig = (
-  overrides: Partial<HarnessConfig> = {}
+  overrides: Partial<HarnessConfig> = {},
 ): HarnessConfig =>
   ({
     appRegistryComponentName: 'App',
@@ -196,7 +196,7 @@ const createHarnessConfig = (
     unstable__skipAlreadyIncludedModules: false,
     webSocketPort: 3001,
     ...overrides,
-  } as HarnessConfig);
+  }) as HarnessConfig;
 
 beforeEach(() => {
   vi.clearAllMocks();
@@ -230,7 +230,7 @@ describe('waitForAppReady', () => {
         emitReady();
         await readyPromise;
         options.onAttemptReset?.();
-      }
+      },
     );
 
     await waitForAppReady({
@@ -255,7 +255,7 @@ describe('waitForAppReady', () => {
         startAttempt: expect.any(Function),
         waitForReady: expect.any(Function),
         waitForCrash: expect.any(Function),
-      })
+      }),
     );
     expect(crashSupervisor.isReady()).toBe(true);
 
@@ -276,7 +276,7 @@ describe('waitForAppReady', () => {
     mocks.waitForMetroBackedAppReady.mockImplementationOnce(
       async (options: WaitForMetroBackedAppReadyOptions) => {
         await options.startAttempt();
-      }
+      },
     );
 
     await waitForAppReady({
@@ -324,7 +324,7 @@ describe('getHarness', () => {
           setTimeout(() => {
             reject(new DOMException('The operation was aborted', 'AbortError'));
           }, 20);
-        })
+        }),
     );
 
     const platform: HarnessPlatform = {
@@ -333,7 +333,7 @@ describe('getHarness', () => {
       name: 'ios',
       platformId: 'ios',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
     };
 
@@ -343,8 +343,8 @@ describe('getHarness', () => {
           platformReadyTimeout: 10,
         }),
         platform,
-        '/tmp/project'
-      )
+        '/tmp/project',
+      ),
     ).rejects.toBeInstanceOf(PlatformReadyTimeoutError);
   });
 
@@ -372,14 +372,14 @@ describe('getHarness', () => {
       name: 'ios',
       platformId: 'ios',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
     };
 
     const harness = await getHarness(
       createHarnessConfig(),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     expect(runner).toHaveBeenCalledWith(
@@ -389,7 +389,7 @@ describe('getHarness', () => {
       }),
       expect.objectContaining({
         signal: expect.any(AbortSignal),
-      })
+      }),
     );
 
     await harness.dispose();
@@ -422,14 +422,14 @@ describe('getHarness', () => {
       name: 'android',
       platformId: 'android',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
     };
 
     const harness = await getHarness(
       createHarnessConfig(),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     expect(harness.config.metroPort).toBe(8082);
@@ -439,7 +439,7 @@ describe('getHarness', () => {
           metroPort: 8082,
         }),
       }),
-      expect.any(AbortSignal)
+      expect.any(AbortSignal),
     );
     expect(runner).toHaveBeenCalledWith(
       platform.config,
@@ -448,7 +448,7 @@ describe('getHarness', () => {
       }),
       expect.objectContaining({
         signal: expect.any(AbortSignal),
-      })
+      }),
     );
     expect(mocks.logMetroPortFallback).toHaveBeenCalledWith(8081, 8082);
 
@@ -467,7 +467,7 @@ describe('getHarness', () => {
     };
 
     await expect(
-      getHarness(createHarnessConfig(), platform, '/tmp/project')
+      getHarness(createHarnessConfig(), platform, '/tmp/project'),
     ).rejects.toBeInstanceOf(MetroPortRangeExhaustedError);
 
     expect(mocks.getBridgeServer).not.toHaveBeenCalled();
@@ -496,14 +496,14 @@ describe('getHarness', () => {
       name: 'legacy-ios',
       platformId: 'ios',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
     };
 
     const harness = await getHarness(
       createHarnessConfig(),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     await harness.dispose();
@@ -527,7 +527,7 @@ describe('getHarness', () => {
         const readyPromise = options.waitForReady(new AbortController().signal);
         emitReady();
         await readyPromise;
-      }
+      },
     );
 
     (
@@ -547,7 +547,7 @@ describe('getHarness', () => {
       name: 'ios',
       platformId: 'ios',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
       getResourceLockKey: () => 'ios:simulator:iPhone 17 Pro:26.2',
     };
@@ -557,7 +557,7 @@ describe('getHarness', () => {
         bridgeTimeout: 1,
       }),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     await harness.ensureAppReady('/tmp/example.harness.ts');
@@ -593,7 +593,7 @@ describe('getHarness', () => {
         const readyPromise = options.waitForReady(new AbortController().signal);
         emitReady();
         await readyPromise;
-      }
+      },
     );
 
     (
@@ -613,7 +613,7 @@ describe('getHarness', () => {
       name: 'ios',
       platformId: 'ios',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
       getResourceLockKey: () => 'ios:simulator:iPhone 17 Pro:26.2',
     };
@@ -621,13 +621,13 @@ describe('getHarness', () => {
     const harness = await getHarness(
       createHarnessConfig(),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     expect(mocks.getBridgeServer).toHaveBeenCalledWith(
       expect.objectContaining({
         noServer: true,
-      })
+      }),
     );
     expect(mocks.getMetroInstance).toHaveBeenCalledWith(
       expect.objectContaining({
@@ -635,7 +635,7 @@ describe('getHarness', () => {
           [HARNESS_BRIDGE_PATH]: serverBridge.ws,
         },
       }),
-      expect.any(AbortSignal)
+      expect.any(AbortSignal),
     );
     await harness.restart('/tmp/restart.harness.ts');
 
@@ -691,7 +691,7 @@ describe('plugins', () => {
                 ctx.appLaunchOptions == null
                   ? 'no-launch-options'
                   : 'launch-options'
-              }`
+              }`,
             );
           },
           beforeRun: (ctx) => {
@@ -700,24 +700,24 @@ describe('plugins', () => {
                 ctx.appLaunchOptions == null
                   ? 'no-launch-options'
                   : 'launch-options'
-              }`
+              }`,
             );
           },
           afterRun: (ctx) => {
             observedHooks.push(
-              `afterRun:${ctx.state.creationCount}:${ctx.reason}`
+              `afterRun:${ctx.state.creationCount}:${ctx.reason}`,
             );
           },
           beforeDispose: (ctx) => {
             observedHooks.push(
-              `beforeDispose:${ctx.state.creationCount}:${ctx.reason}`
+              `beforeDispose:${ctx.state.creationCount}:${ctx.reason}`,
             );
           },
         },
         runtime: {
           ready: (ctx) => {
             observedHooks.push(
-              `runtime.ready:${ctx.runId}:${ctx.device.platform}`
+              `runtime.ready:${ctx.runId}:${ctx.device.platform}`,
             );
           },
           disconnected: (ctx) => {
@@ -743,7 +743,7 @@ describe('plugins', () => {
       name: 'ios',
       platformId: 'ios',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
       getResourceLockKey: () => 'ios:simulator:iPhone 17 Pro:26.2',
     };
@@ -753,7 +753,7 @@ describe('plugins', () => {
         plugins: [plugin],
       }),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     harness.setRunState({
@@ -791,6 +791,59 @@ describe('plugins', () => {
     ]);
   });
 
+  it('disposes lifecycle hooks and platform resources only once', async () => {
+    const { serverBridge } = createBridgeServer();
+    const platformInstance = createPlatformRunner();
+    const observedHooks: string[] = [];
+
+    mocks.getBridgeServer.mockResolvedValue(serverBridge);
+    mocks.getMetroInstance.mockResolvedValue(createMetroInstance());
+
+    (
+      globalThis as typeof globalThis & {
+        __HARNESS_PLATFORM_RUNNER__?: (...args: unknown[]) => Promise<unknown>;
+      }
+    ).__HARNESS_PLATFORM_RUNNER__ = vi.fn(async () => platformInstance);
+
+    const plugin = definePlugin({
+      name: 'dispose-plugin',
+      hooks: {
+        harness: {
+          afterRun: () => {
+            observedHooks.push('afterRun');
+          },
+          beforeDispose: () => {
+            observedHooks.push('beforeDispose');
+          },
+        },
+      },
+    });
+
+    const platform: HarnessPlatform = {
+      config: {},
+      name: 'ios',
+      platformId: 'ios',
+      runner: `data:text/javascript,${encodeURIComponent(
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
+      )}`,
+      getResourceLockKey: () => 'ios:simulator:iPhone 17 Pro:26.2',
+    };
+
+    const harness = await getHarness(
+      createHarnessConfig({
+        plugins: [plugin],
+      }),
+      platform,
+      '/tmp/project',
+    );
+
+    await harness.dispose();
+    await harness.dispose();
+
+    expect(observedHooks).toEqual(['afterRun', 'beforeDispose']);
+    expect(platformInstance.dispose).toHaveBeenCalledTimes(1);
+  });
+
   it('waits in queue before starting Metro and releases the lock on dispose', async () => {
     const resourceKey = 'ios:simulator:iPhone 17 Pro:26.2';
     const firstPlatformRunner = createPlatformRunner();
@@ -828,7 +881,7 @@ describe('plugins', () => {
       name: 'ios',
       platformId: 'ios',
       runner: `data:text/javascript,${encodeURIComponent(
-        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);'
+        'export default (...args) => globalThis.__HARNESS_PLATFORM_RUNNER__(...args);',
       )}`,
       getResourceLockKey: () => resourceKey,
     };
@@ -836,13 +889,13 @@ describe('plugins', () => {
     const firstHarness = await getHarness(
       createHarnessConfig(),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     const secondHarnessPromise = getHarness(
       createHarnessConfig(),
       platform,
-      '/tmp/project'
+      '/tmp/project',
     );
 
     await new Promise((resolve) => setTimeout(resolve, 1100));
@@ -864,7 +917,7 @@ describe('plugins', () => {
 describe('StartupStallError', () => {
   it('includes the configured timeout and attempt count', () => {
     expect(new StartupStallError(1_500, 4).message).toBe(
-      'The app did not request its Metro bundle after 4 launch attempts within 1500ms. Last Metro status: unknown.'
+      'The app did not request its Metro bundle after 4 launch attempts within 1500ms. Last Metro status: unknown.',
     );
   });
 });

package/src/harness.ts

@@ -78,7 +78,7 @@ export type Harness = {
   config: HarnessConfig;
   runTests: (
     path: string,
-    options: HarnessRunTestsOptions
+    options: HarnessRunTestsOptions,
   ) => Promise<TestSuiteResult>;
   ensureAppReady: (testFilePath: string) => Promise<void>;
   restart: (testFilePath?: string) => Promise<void>;
@@ -92,7 +92,7 @@ export type Harness = {
 export const maybeLogMetroCacheReuse = (
   config: HarnessConfig,
   platform: HarnessPlatform,
-  projectRoot: string
+  projectRoot: string,
 ): void => {
   if (config.unstable__enableMetroCache && isMetroCacheReusable(projectRoot)) {
     logMetroCacheReused(platform);
@@ -116,7 +116,7 @@ const waitForAbort = (signal: AbortSignal): Promise<never> => {
       () => {
         reject(signal.reason ?? createAbortError());
       },
-      { once: true }
+      { once: true },
     );
   });
 };
@@ -239,7 +239,7 @@ const getHarnessInternal = async (
   config: HarnessConfig,
   platform: HarnessPlatform,
   projectRoot: string,
-  signal: AbortSignal
+  signal: AbortSignal,
 ): Promise<Harness> => {
   const context: HarnessContext = {
     platform,
@@ -247,7 +247,7 @@ const getHarnessInternal = async (
   harnessLogger.debug(
     'creating Harness internals for runner=%s platform=%s',
     platform.name,
-    platform.platformId
+    platform.platformId,
   );
   const resourceLockKey = await (platform.getResourceLockKey?.() ??
     getDefaultResourceLockKey(platform));
@@ -261,7 +261,7 @@ const getHarnessInternal = async (
       harnessLogger.debug(
         'waiting in queue for runner=%s key=%s',
         platform.name,
-        resourceLockKey
+        resourceLockKey,
       );
     },
     onStillWaiting: (elapsedMs) => {
@@ -275,7 +275,7 @@ const getHarnessInternal = async (
         'still waiting in queue for runner=%s key=%s elapsedMs=%d',
         platform.name,
         resourceLockKey,
-        elapsedMs
+        elapsedMs,
       );
     },
   });
@@ -285,7 +285,7 @@ const getHarnessInternal = async (
   harnessLogger.debug(
     'resource lock acquired for runner=%s key=%s',
     platform.name,
-    resourceLockKey
+    resourceLockKey,
   );
   try {
     const {
@@ -322,7 +322,6 @@ const getHarnessInternal = async (
     let activeTestFilePath: string | undefined;
     const pendingHookPromises = new Set<Promise<void>>();
     let pendingHookError: unknown;
-
     const getCurrentRunId = () => currentRun?.runId;
     const toRelativeTestFilePath = (testFilePath?: string) =>
       testFilePath == null
@@ -358,7 +357,7 @@ const getHarnessInternal = async (
         object,
         HarnessConfig,
         HarnessPlatform
-      >
+      >,
     >(
       name: TName,
       payload: Omit<
@@ -373,7 +372,7 @@ const getHarnessInternal = async (
         | 'timestamp'
         | 'abortSignal'
         | 'meta'
-      >
+      >,
     ) => {
       trackHook(pluginManager.callHook(name, payload));
     };
@@ -384,11 +383,11 @@ const getHarnessInternal = async (
       context,
     });
     harnessLogger.debug(
-      'starting Metro, platform runner, and bridge initialization'
+      'starting Metro, platform runner, and bridge initialization',
     );
     harnessLogger.debug(
       'bridge server initialized on Metro websocket path %s',
-      HARNESS_BRIDGE_PATH
+      HARNESS_BRIDGE_PATH,
     );
     const [metroInstance, platformInstance] = await (async () => {
       try {
@@ -402,7 +401,7 @@ const getHarnessInternal = async (
                   serverBridge.ws as unknown as MetroWebSocketEndpoint,
               },
             },
-            signal
+            signal,
           ).then((instance) => {
             harnessLogger.debug('Metro initialized');
             return instance;
@@ -415,7 +414,7 @@ const getHarnessInternal = async (
                 .then((module) =>
                   module.default(platform.config, runtimeConfig, {
                     signal,
-                  } satisfies HarnessPlatformInitOptions)
+                  } satisfies HarnessPlatformInitOptions),
                 )
                 .then((instance) => {
                   harnessLogger.debug('platform runner initialized');
@@ -650,7 +649,10 @@ const getHarnessInternal = async (
       harnessLogger.debug('client log forwarding enabled');
     }
 
-    const dispose = async (reason: 'normal' | 'abort' | 'error' = 'normal') => {
+    let disposePromise: Promise<void> | null = null;
+    const disposeOnce = async (
+      reason: 'normal' | 'abort' | 'error' = 'normal'
+    ) => {
       harnessLogger.debug('disposing Harness (reason=%s)', reason);
       let hookError: unknown;
 
@@ -709,6 +711,10 @@ const getHarnessInternal = async (
         throw cleanupError;
       }
     };
+    const dispose = (reason: 'normal' | 'abort' | 'error' = 'normal') => {
+      disposePromise ??= disposeOnce(reason);
+      return disposePromise;
+    };
 
     if (signal.aborted) {
       await dispose('abort');
@@ -737,7 +743,7 @@ const getHarnessInternal = async (
       await dispose(
         error instanceof DOMException && error.name === 'AbortError'
           ? 'abort'
-          : 'error'
+          : 'error',
       );
       throw error;
     }
@@ -758,7 +764,7 @@ const getHarnessInternal = async (
 
       crashSupervisor.reset();
       harnessLogger.debug(
-        'app not ready, waiting for launch and runtime readiness'
+        'app not ready, waiting for launch and runtime readiness',
       );
       await waitForAppReady({
         metroInstance,
@@ -783,7 +789,7 @@ const getHarnessInternal = async (
       harnessLogger.debug(
         'restarting app (testFile=%s mode=%s)',
         testFilePath ?? 'n/a',
-        testFilePath ? 'stop-and-ensure-ready' : 'direct-restart'
+        testFilePath ? 'stop-and-ensure-ready' : 'direct-restart',
       );
 
       if (testFilePath) {
@@ -848,17 +854,17 @@ const getHarnessInternal = async (
 export const getHarness = async (
   config: HarnessConfig,
   platform: HarnessPlatform,
-  projectRoot: string
+  projectRoot: string,
 ): Promise<Harness> => {
   harnessLogger.debug(
     'creating Harness with platform ready timeout %dms',
-    config.platformReadyTimeout
+    config.platformReadyTimeout,
   );
 
   return await getHarnessInternal(
     config,
     platform,
     projectRoot,
-    new AbortController().signal
+    new AbortController().signal,
   );
 };