feat: improve timeout (#24)

This pull request improves timeout handling. The timeout is now propagated not only to the initial bootstrapping process but also to all commands sent to the device.

Author: V3RON

.github/workflows/e2e-tests.yml

@@ -232,18 +232,18 @@ jobs:
 
       - name: Run E2E tests
         run: |
-          pnpm nx run @react-native-harness/${{ matrix.app }}:start --args="--harnessRunner ios"
+          HARNESS_DEBUG=true pnpm nx run @react-native-harness/${{ matrix.app }}:start --args="--harnessRunner ios"
 
-      - name: Capture simulator screenshot on failure
+      - name: Take screenshot after E2E tests
         if: failure()
         run: |
           mkdir -p screenshots
-          xcrun simctl io booted screenshot screenshots/ios-failure-${{ matrix.app }}.png
+          xcrun simctl io booted screenshot screenshots/ios-${{ matrix.app }}-after.png
 
-      - name: Upload screenshot artifact
+      - name: Upload iOS screenshots
         if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: ios-failure-screenshot-${{ matrix.app }}
-          path: screenshots/ios-failure-${{ matrix.app }}.png
+          name: ios-screenshots-${{ matrix.app }}
+          path: screenshots/ios-${{ matrix.app }}-*.png
           retention-days: 7

packages/bridge/src/errors.ts

@@ -0,0 +1,11 @@
+import { HarnessError } from '@react-native-harness/tools';
+
+export class DeviceNotRespondingError extends HarnessError {
+  constructor(
+    public readonly functionName: string,
+    public readonly args: unknown[]
+  ) {
+    super('The device did not respond within the timeout period.');
+    this.name = 'DeviceNotRespondingError';
+  }
+}

packages/bridge/src/server.ts

@@ -9,9 +9,11 @@ import type {
   BridgeEvents,
 } from './shared.js';
 import { deserialize, serialize } from './serializer.js';
+import { DeviceNotRespondingError } from './errors.js';
 
 export type BridgeServerOptions = {
   port: number;
+  timeout?: number;
 };
 
 export type BridgeServerEvents = {
@@ -39,6 +41,7 @@ export type BridgeServer = {
 
 export const getBridgeServer = async ({
   port,
+  timeout,
 }: BridgeServerOptions): Promise<BridgeServer> => {
   const wss = await new Promise<WebSocketServer>((resolve) => {
     const server = new WebSocketServer({ port, host: '0.0.0.0' }, () => {
@@ -57,7 +60,13 @@ export const getBridgeServer = async ({
         emitter.emit('event', data);
       },
     } satisfies BridgeServerFunctions,
-    []
+    [],
+    {
+      timeout,
+      onTimeoutError(functionName, args) {
+        throw new DeviceNotRespondingError(functionName, args);
+      },
+    }
   );
 
   wss.on('connection', (ws: WebSocket) => {

packages/bridge/src/shared.ts

@@ -36,6 +36,7 @@ export type {
   SetupFileBundlingFailedEvent,
   BundlerEvents,
 } from './shared/bundler.js';
+export { DeviceNotRespondingError } from './errors.js';
 
 export type DeviceDescriptor = {
   platform: 'ios' | 'android' | 'vega';

packages/jest/package.json

@@ -35,15 +35,16 @@
   "dependencies": {
     "@jest/test-result": "^30.2.0",
     "@react-native-harness/bridge": "workspace:*",
+    "@react-native-harness/bundler-metro": "workspace:*",
     "@react-native-harness/config": "workspace:*",
     "@react-native-harness/platforms": "workspace:*",
     "@react-native-harness/tools": "workspace:*",
-    "@react-native-harness/bundler-metro": "workspace:*",
     "chalk": "^4.1.2",
     "jest-message-util": "^30.2.0",
     "jest-runner": "^30.2.0",
     "jest-util": "^30.2.0",
     "p-limit": "^7.1.1",
+    "p-retry": "^7.1.0",
     "tslib": "^2.3.0",
     "yargs": "^17.7.2"
   },

packages/jest/src/harness.ts

@@ -3,6 +3,10 @@ import { BridgeClientFunctions } from '@react-native-harness/bridge';
 import { HarnessPlatform } from '@react-native-harness/platforms';
 import { getMetroInstance } from '@react-native-harness/bundler-metro';
 import { InitializationTimeoutError } from './errors.js';
+import { Config as HarnessConfig } from '@react-native-harness/config';
+import pRetry from 'p-retry';
+
+const BRIDGE_READY_TIMEOUT = 10000;
 
 export type Harness = {
   runTests: BridgeClientFunctions['runTests'];
@@ -11,6 +15,7 @@ export type Harness = {
 };
 
 const getHarnessInternal = async (
+  config: HarnessConfig,
   platform: HarnessPlatform,
   signal: AbortSignal
 ): Promise<Harness> => {
@@ -19,14 +24,45 @@ const getHarnessInternal = async (
     platform.getInstance(),
     getBridgeServer({
       port: 3001,
+      timeout: config.bridgeTimeout,
     }),
   ]);
 
+  const dispose = async () => {
+    await Promise.all([
+      serverBridge.dispose(),
+      platformInstance.dispose(),
+      metroInstance.dispose(),
+    ]);
+  };
+
   if (signal.aborted) {
-    metroInstance.dispose();
-    platformInstance.dispose();
-    serverBridge.dispose();
-    signal.throwIfAborted();
+    await dispose();
+
+    throw new DOMException('The operation was aborted', 'AbortError');
+  }
+
+  try {
+    await pRetry(
+      () =>
+        new Promise<void>((resolve, reject) => {
+          signal.addEventListener('abort', () => {
+            reject(new DOMException('The operation was aborted', 'AbortError'));
+          });
+
+          serverBridge.once('ready', () => resolve());
+          platformInstance.restartApp().catch(reject);
+        }),
+      {
+        minTimeout: BRIDGE_READY_TIMEOUT,
+        maxTimeout: BRIDGE_READY_TIMEOUT,
+        retries: Infinity,
+        signal,
+      }
+    );
+  } catch (error) {
+    await dispose();
+    throw error;
   }
 
   const restart = () =>
@@ -35,9 +71,6 @@ const getHarnessInternal = async (
       platformInstance.restartApp().catch(reject);
     });
 
-  // Wait for the bridge to be ready
-  await restart();
-
   return {
     runTests: async (path, options) => {
       const client = serverBridge.rpc.clients.at(-1);
@@ -49,25 +82,18 @@ const getHarnessInternal = async (
       return await client.runTests(path, options);
     },
     restart,
-    dispose: async () => {
-      await Promise.all([
-        serverBridge.dispose(),
-        platformInstance.dispose(),
-        metroInstance.dispose(),
-      ]);
-    },
+    dispose,
   };
 };
 
 export const getHarness = async (
-  platform: HarnessPlatform,
-  timeout: number
+  config: HarnessConfig,
+  platform: HarnessPlatform
 ): Promise<Harness> => {
-  const abortController = new AbortController();
-  const timeoutId = setTimeout(() => abortController.abort(), timeout);
+  const abortSignal = AbortSignal.timeout(config.bridgeTimeout);
+
   try {
-    const harness = await getHarnessInternal(platform, abortController.signal);
-    clearTimeout(timeoutId);
+    const harness = await getHarnessInternal(config, platform, abortSignal);
     return harness;
   } catch (error) {
     if (error instanceof DOMException && error.name === 'AbortError') {

packages/jest/src/index.ts

@@ -15,6 +15,8 @@ import { type Harness } from './harness.js';
 import { setup } from './setup.js';
 import { teardown } from './teardown.js';
 import { HarnessError } from '@react-native-harness/tools';
+import { getErrorMessage } from './logs.js';
+import { DeviceNotRespondingError } from '@react-native-harness/bridge';
 
 class CancelRun extends Error {
   constructor(message?: string) {
@@ -63,7 +65,7 @@ export default class JestHarness implements CallbackTestRunnerInterface {
     } catch (error) {
       if (error instanceof HarnessError) {
         // Jest will print strings as they are, without processing them further.
-        throw error.message;
+        throw getErrorMessage(error);
       }
 
       throw error;
@@ -112,7 +114,18 @@ export default class JestHarness implements CallbackTestRunnerInterface {
               );
             })
             .then((result) => onResult(test, result))
-            .catch((err) => onFailure(test, err))
+            .catch((err) => {
+              if (err instanceof DeviceNotRespondingError) {
+                onFailure(test, {
+                  message: err.message,
+                  stack: '',
+                });
+
+                return;
+              }
+
+              onFailure(test, err);
+            })
         ),
       Promise.resolve()
     );

packages/jest/src/logs.ts

@@ -1,21 +1,30 @@
-type TestRunnerConfig = any;
+import { HarnessPlatform } from '@react-native-harness/platforms';
+import { HarnessError } from '@react-native-harness/tools';
 import chalk from 'chalk';
 
 const TAG = chalk.supportsColor
   ? chalk.reset.inverse.bold.magenta(` HARNESS `)
   : 'HARNESS';
 
+const ERROR_TAG = chalk.supportsColor
+  ? chalk.reset.inverse.bold.red(` HARNESS `)
+  : 'HARNESS';
+
 // @see https://github.com/jestjs/jest/blob/main/packages/jest-reporters/src/BaseReporter.ts#L25
 export const log = (message: string): void => {
   process.stderr.write(`${message}\n`);
 };
 
-export const logTestRunHeader = (runner: TestRunnerConfig): void => {
+export const logTestRunHeader = (runner: HarnessPlatform): void => {
   log(
     `${TAG} Preparing to run tests using ${chalk.bold(runner.name)} runner\n`
   );
 };
 
-export const logTestEnvironmentReady = (runner: TestRunnerConfig): void => {
+export const logTestEnvironmentReady = (runner: HarnessPlatform): void => {
   log(`${TAG} Runner ${chalk.bold(runner.name)} ready\n`);
 };
+
+export const getErrorMessage = (error: HarnessError): string => {
+  return `${ERROR_TAG} ${error.message}\n`;
+};

packages/jest/src/setup.ts

@@ -3,7 +3,7 @@ import {
   type Config as HarnessConfig,
 } from '@react-native-harness/config';
 import type { Config as JestConfig } from 'jest-runner';
-import { getHarness as getHarnessExternal, type Harness } from './harness.js';
+import { getHarness } from './harness.js';
 import { preRunMessage } from 'jest-util';
 import { getAdditionalCliArgs, HarnessCliArgs } from './cli-args.js';
 import { logTestEnvironmentReady, logTestRunHeader } from './logs.js';
@@ -39,13 +39,6 @@ const getHarnessRunner = (
   return runner;
 };
 
-const getHarness = async (
-  runner: HarnessPlatform,
-  timeout: number
-): Promise<Harness> => {
-  return await getHarnessExternal(runner, timeout);
-};
-
 export const setup = async (globalConfig: JestConfig.GlobalConfig) => {
   preRunMessage.remove(process.stderr);
   const harnessConfig =
@@ -78,7 +71,7 @@ export const setup = async (globalConfig: JestConfig.GlobalConfig) => {
   }
 
   logTestRunHeader(selectedRunner);
-  const harness = await getHarness(selectedRunner, harnessConfig.bridgeTimeout);
+  const harness = await getHarness(harnessConfig, selectedRunner);
   logTestEnvironmentReady(selectedRunner);
 
   global.HARNESS_CONFIG = harnessConfig;

packages/metro/src/withRnHarness.ts

@@ -5,6 +5,9 @@ import { getHarnessResolver } from './resolver';
 import { getHarnessManifest } from './manifest';
 import { getHarnessBabelTransformerPath } from './babel-transformer';
 
+const INTERNAL_CALLSITES_REGEX =
+  /(^|[\\/])(node_modules[/\\]@react-native-harness)([\\/]|$)/;
+
 export const withRnHarness = (
   config: MetroConfig | Promise<MetroConfig>
 ): (() => Promise<MetroConfig>) => {
@@ -35,6 +38,18 @@ export const withRnHarness = (
           ...(metroConfig.serializer?.getPolyfills?.(...args) ?? []),
           harnessManifest,
         ],
+        isThirdPartyModule({ path: modulePath }) {
+          const isThirdPartyByDefault =
+            metroConfig.serializer?.isThirdPartyModule?.({
+              path: modulePath,
+            }) ?? false;
+
+          if (isThirdPartyByDefault) {
+            return true;
+          }
+
+          return INTERNAL_CALLSITES_REGEX.test(modulePath);
+        },
       },
       resolver: {
         ...metroConfig.resolver,
@@ -46,6 +61,26 @@ export const withRnHarness = (
         ...metroConfig.transformer,
         babelTransformerPath: harnessBabelTransformerPath,
       },
+      symbolicator: {
+        ...metroConfig.symbolicator,
+        customizeFrame: async (frame) => {
+          const defaultCustomizeFrame =
+            await metroConfig.symbolicator?.customizeFrame?.(frame);
+          const shouldCollapseByDefault =
+            defaultCustomizeFrame?.collapse ?? false;
+
+          if (shouldCollapseByDefault) {
+            return {
+              collapse: true,
+            };
+          }
+
+          return {
+            collapse:
+              frame.file != null && INTERNAL_CALLSITES_REGEX.test(frame.file),
+          };
+        },
+      },
     };
 
     if (harnessConfig.unstable__skipAlreadyIncludedModules) {