@react-native-harness/jest 1.3.0 → 1.4.0

package/src/execute-run.ts

@@ -1,20 +1,44 @@
 import type {
-  OnTestFailure,
-  OnTestStart,
-  OnTestSuccess,
   Test,
   TestWatcher,
   Config,
+  TestEvents,
 } from 'jest-runner';
 import { randomUUID } from 'node:crypto';
 import path from 'node:path';
 import { type HarnessSession, type HarnessRunState } from './harness-session.js';
 import { runHarnessTestFile } from './run.js';
+import { resolveResetStrategyKind } from './environment-reset.js';
 import {
   NativeCrashError,
+  RuntimeDisconnectError,
   StartupStallError,
 } from './errors.js';
-import { DeviceNotRespondingError } from '@react-native-harness/bridge/server';
+import {
+  AppBridgeDisconnectedError,
+  DeviceNotRespondingError,
+} from '@react-native-harness/bridge/server';
+import type { TestCaseResult } from '@jest/test-result';
+import type {
+  TestRunnerEvents,
+  TestRunnerTestFinishedEvent,
+  TestRunnerTestStartedEvent,
+  TestSuiteResult,
+} from '@react-native-harness/bridge';
+import {
+  createPlatformSkippedTestResult,
+  shouldRunHarnessTestFile,
+} from './test-file-platform-filter.js';
+import { formatHarnessErrorMessage } from './format-harness-error.js';
+import { logger } from '@react-native-harness/tools';
+import { printSummary, writeTraceFile } from './diagnostics/index.js';
+
+const diagnosticsLogger = logger.child('diagnostics');
+
+type EmitTestEvent = <Name extends keyof TestEvents>(
+  eventName: Name,
+  ...eventData: TestEvents[Name]
+) => Promise<void>;
 
 const createRunSummary = () => ({ passed: 0, failed: 0, skipped: 0, todo: 0 });
 
@@ -38,7 +62,9 @@ class CancelRun extends Error {
 const buildTestFailure = (err: unknown): { message: string; stack: string } => {
   if (
     err instanceof NativeCrashError ||
+    err instanceof RuntimeDisconnectError ||
     err instanceof StartupStallError ||
+    err instanceof AppBridgeDisconnectedError ||
     err instanceof DeviceNotRespondingError
   ) {
     return { message: (err as Error).message, stack: '' };
@@ -46,21 +72,92 @@ const buildTestFailure = (err: unknown): { message: string; stack: string } => {
   return err as { message: string; stack: string };
 };
 
+const toJestMode = (
+  declarationMode?: 'only' | 'skip' | 'todo',
+): 'only' | 'skip' | 'todo' | undefined => declarationMode;
+
+const emitHarnessTestStarted = async (
+  emitEvent: EmitTestEvent,
+  event: TestRunnerTestStartedEvent,
+): Promise<void> => {
+  await emitEvent('test-case-start', event.file, {
+    ancestorTitles: event.ancestorTitles,
+    fullName: event.fullName,
+    mode: toJestMode(event.declarationMode),
+    title: event.name,
+    startedAt: event.startedAt,
+  });
+};
+
+const emitHarnessTestFinished = async (
+  emitEvent: EmitTestEvent,
+  event: TestRunnerTestFinishedEvent,
+): Promise<void> => {
+  const codeFrame = event.error?.codeFrame;
+  const failureMessage = formatHarnessErrorMessage(event.error, {
+    testStartedAt: event.startedAt,
+  });
+  const location = codeFrame?.location
+    ? { column: codeFrame.location.column, line: codeFrame.location.row }
+    : null;
+  const testCaseResult: TestCaseResult = {
+    ancestorTitles: event.ancestorTitles,
+    duration: event.duration,
+    failureDetails: [],
+    failureMessages: failureMessage ? [failureMessage] : [],
+    fullName: event.fullName,
+    location,
+    numPassingAsserts: event.status === 'passed' ? 1 : 0,
+    startedAt: event.startedAt,
+    status: event.status,
+    title: event.name,
+  };
+
+  await emitEvent('test-case-result', event.file, testCaseResult);
+};
+
+const isHarnessCaseEvent = (
+  event: TestRunnerEvents,
+): event is TestRunnerTestStartedEvent | TestRunnerTestFinishedEvent =>
+  event.type === 'test-started' || event.type === 'test-finished';
+
+const TIMEOUT_ERROR_NAMES = new Set([
+  'SuiteHookTimeoutError',
+  'TestCaseTimeoutError',
+]);
+
+const hasRuntimeTimeout = (result: TestSuiteResult): boolean =>
+  (result.error ? TIMEOUT_ERROR_NAMES.has(result.error.name) : false) ||
+  result.tests.some((test) =>
+    test.error ? TIMEOUT_ERROR_NAMES.has(test.error.name) : false,
+  ) ||
+  result.suites.some(hasRuntimeTimeout);
+
 export const executeRun = async (
   session: HarnessSession,
   tests: Array<Test>,
   watcher: TestWatcher,
-  onStart: OnTestStart,
-  onResult: OnTestSuccess,
-  onFailure: OnTestFailure,
+  emitEvent: EmitTestEvent,
   globalConfig: Config.GlobalConfig,
 ): Promise<void> => {
   const runId = randomUUID();
+  const diagnostics = session.diagnostics.child({ runId });
+  const runSpan = diagnostics.start('run.total', { runId });
   const startTime = Date.now();
   const watchMode = globalConfig.watch || globalConfig.watchAll;
   const rootDir = globalConfig.rootDir ?? process.cwd();
   const testFiles = tests.map((t) => path.relative(rootDir, t.path));
   const summary = createRunSummary();
+  let caseEventChain = Promise.resolve();
+  const unsubscribe = session.onTestRunnerEvent((event) => {
+    if (isHarnessCaseEvent(event)) {
+      caseEventChain = caseEventChain.then(() =>
+        event.type === 'test-started'
+          ? emitHarnessTestStarted(emitEvent, event)
+          : emitHarnessTestFinished(emitEvent, event),
+      );
+    }
+  });
 
   const updateRunState = (overrides: Partial<HarnessRunState> = {}) => {
     const state: HarnessRunState = {
@@ -69,6 +166,7 @@ export const executeRun = async (
       testFiles,
       watchMode,
       coverageEnabled: globalConfig.collectCoverage,
+      completed: false,
       summary,
       status: summary.failed > 0 ? 'failed' : 'passed',
       ...overrides,
@@ -92,8 +190,15 @@ export const executeRun = async (
     host: session.config.host?.trim() || undefined,
   });
 
-  const shouldResetEnv = session.config.resetEnvironmentBetweenTestFiles;
+  const resetStrategyKind = resolveResetStrategyKind(
+    session.config.resetEnvironmentBetweenTestFiles,
+  );
+  const platformId = session.context.platform.platformId;
+  const knownPlatformIds = new Set(
+    session.config.runners.map((runner) => runner.platformId),
+  );
   let isFirstTest = true;
+  let shouldRestartAfterTimeout = false;
   let runError: unknown;
 
   try {
@@ -120,63 +225,116 @@ export const executeRun = async (
       };
 
       await session.callHook('test-file:started', { runId, file: relativeTestPath });
+      const fileSpan = diagnostics.start('run.file', { file: relativeTestPath });
+      let fileStatus: 'passed' | 'failed' | 'skipped' | 'todo' = 'failed';
 
       try {
-        if (shouldResetEnv && !isFirstTest) {
-          await session.restartApp(test.path);
+        if (
+          !shouldRunHarnessTestFile(test.path, platformId, knownPlatformIds)
+        ) {
+          try {
+            await emitEvent('test-file-start', test);
+            const skippedResult = createPlatformSkippedTestResult(test.path);
+            applyJestResultToSummary(summary, skippedResult);
+            updateRunState();
+            fileStatus = 'skipped';
+            await emitTestFileFinished({
+              status: 'skipped',
+              duration: Date.now() - fileStartedAt,
+              result: null,
+            });
+            await emitEvent('test-file-success', test, skippedResult);
+          } catch (err) {
+            fileStatus = 'failed';
+            if (!emittedTestFileFinished) {
+              await emitTestFileFinished({
+                status: 'failed',
+                duration: Date.now() - fileStartedAt,
+                result: null,
+              });
+            }
+            updateRunState({ error: err });
+            await emitEvent('test-file-failure', test, buildTestFailure(err));
+          }
+          continue;
         }
-        isFirstTest = false;
-
-        session.flushClientLogs();
-        await onStart(test);
-        await session.ensureAppReady(test.path);
-
-        // Crash detection is handled inside session.runTestFile; NativeCrashError
-        // propagates here if a crash wins the race.
-        const result = await runHarnessTestFile({
-          testPath: test.path,
-          session,
-          globalConfig,
-          projectConfig: test.context.config,
-        });
 
-        applyJestResultToSummary(summary, result.jestResult);
-        const clientLogs = session.flushClientLogs();
-        if (clientLogs.length > 0) {
-          result.jestResult.console = clientLogs;
-        }
-        updateRunState();
-        await emitTestFileFinished({
-          status: result.harnessResult.status,
-          duration: result.duration,
-          result: result.harnessResult,
-        });
-        await onResult(test, result.jestResult);
-      } catch (err) {
-        if (!emittedTestFileFinished) {
+        try {
+          if (shouldRestartAfterTimeout) {
+            // Recovery from a runtime timeout always uses the (stronger)
+            // process restart, never the configured reset strategy.
+            await session.restartApp(test.path);
+            shouldRestartAfterTimeout = false;
+          } else if (resetStrategyKind !== null && !isFirstTest) {
+            await session.resetEnvironment(test.path);
+          }
+          isFirstTest = false;
+
+          session.flushClientLogs();
+          await emitEvent('test-file-start', test);
+          await session.ensureAppReady(test.path);
+
+          // Crash detection is handled inside session.runTestFile; NativeCrashError
+          // propagates here if a crash wins the race.
+          const result = await runHarnessTestFile({
+            testPath: test.path,
+            session,
+            globalConfig,
+            projectConfig: test.context.config,
+          });
+
+          applyJestResultToSummary(summary, result.jestResult);
+          const clientLogs = session.flushClientLogs();
+          if (clientLogs.length > 0) {
+            result.jestResult.console = clientLogs;
+          }
+          updateRunState();
+          fileStatus = result.harnessResult.status;
           await emitTestFileFinished({
-            status: 'failed',
-            duration: Date.now() - fileStartedAt,
-            result: null,
+            status: result.harnessResult.status,
+            duration: result.duration,
+            result: result.harnessResult,
           });
-        }
+          const didRuntimeTimeout = hasRuntimeTimeout(result.harnessResult);
+          shouldRestartAfterTimeout = didRuntimeTimeout;
+          await caseEventChain;
+          await emitEvent('test-file-success', test, result.jestResult);
+          if (didRuntimeTimeout) {
+            await session.restartApp(test.path);
+            shouldRestartAfterTimeout = false;
+          }
+        } catch (err) {
+          fileStatus = 'failed';
+          if (!emittedTestFileFinished) {
+            await emitTestFileFinished({
+              status: 'failed',
+              duration: Date.now() - fileStartedAt,
+              result: null,
+            });
+          }
 
-        const isRuntimeFailure =
-          err instanceof NativeCrashError ||
-          err instanceof StartupStallError ||
-          err instanceof DeviceNotRespondingError;
+          const isRuntimeFailure =
+            err instanceof NativeCrashError ||
+            err instanceof RuntimeDisconnectError ||
+            err instanceof StartupStallError ||
+            err instanceof AppBridgeDisconnectedError ||
+            err instanceof DeviceNotRespondingError;
 
-        if (isRuntimeFailure) {
-          summary.failed += 1;
-          updateRunState();
-        }
+          if (isRuntimeFailure) {
+            summary.failed += 1;
+            updateRunState();
+          }
 
-        if (err instanceof NativeCrashError) {
-          session.resetCrashState();
-        }
+          if (err instanceof NativeCrashError || err instanceof RuntimeDisconnectError) {
+            session.resetCrashState();
+          }
 
-        updateRunState({ error: isRuntimeFailure ? undefined : err });
-        onFailure(test, buildTestFailure(err));
+          updateRunState({ error: isRuntimeFailure ? undefined : err });
+          await caseEventChain;
+          await emitEvent('test-file-failure', test, buildTestFailure(err));
+        }
+      } finally {
+        fileSpan.end({ status: fileStatus });
       }
     }
   } catch (err) {
@@ -184,16 +342,31 @@ export const executeRun = async (
     if (!(err instanceof CancelRun)) throw err;
   } finally {
     const runState = updateRunState(
-      runError != null ? { error: runError, status: 'failed' } : {},
+      runError != null ? { completed: true, error: runError, status: 'failed' } : { completed: true },
     );
+    const finalStatus = runState.status ?? (runError != null ? 'failed' : 'passed');
     await session.callHook('run:finished', {
       runId,
       startTime,
       duration: Date.now() - startTime,
       testFiles,
       summary,
-      status: runState.status ?? (runError != null ? 'failed' : 'passed'),
+      status: finalStatus,
       ...(runError != null ? { error: runError } : {}),
     });
+    await caseEventChain;
+    unsubscribe();
+    runSpan.end({ runId, status: finalStatus });
+
+    if (session.diagnostics.enabled) {
+      const entries = session.diagnostics.flush();
+      try {
+        printSummary(entries, (line) => diagnosticsLogger.info(line));
+        const tracePath = await writeTraceFile(entries, { projectRoot: rootDir, runId });
+        diagnosticsLogger.info(`wrote diagnostics trace to ${tracePath}`);
+      } catch (reportError) {
+        diagnosticsLogger.warn('failed to write diagnostics report: %s', reportError);
+      }
+    }
   }
 };

package/src/format-harness-error.ts

@@ -0,0 +1,73 @@
+import type { SerializedError } from '@react-native-harness/bridge';
+
+const formatPendingPromiseStack = (stack: string): string =>
+  stack
+    .split('\n')
+    .map((line) => `  ${line}`)
+    .join('\n');
+
+const formatPendingPromises = (
+  pendingPromises: NonNullable<
+    NonNullable<SerializedError['diagnostics']>['pendingPromises']
+  >,
+  testStartedAt?: number,
+): string | null => {
+  if (pendingPromises.total === 0) {
+    return null;
+  }
+
+  const lines = [`Pending promises at timeout: ${pendingPromises.total}`];
+
+  if (pendingPromises.items.length < pendingPromises.total) {
+    lines.push(
+      `Showing ${pendingPromises.items.length} of ${pendingPromises.total} pending promises.`,
+    );
+  }
+
+  for (const promise of pendingPromises.items) {
+    const age =
+      testStartedAt !== undefined
+        ? `, created ${Math.max(0, promise.createdAt - testStartedAt)}ms after test start`
+        : '';
+
+    lines.push('');
+    lines.push(`Promise #${promise.id}${age}:`);
+
+    if (promise.stack) {
+      lines.push(formatPendingPromiseStack(promise.stack));
+    } else {
+      lines.push('  <stack unavailable>');
+    }
+  }
+
+  return lines.join('\n');
+};
+
+export const formatHarnessErrorMessage = (
+  error: SerializedError | undefined,
+  options: {
+    testStartedAt?: number;
+  } = {},
+): string | undefined => {
+  if (!error) {
+    return undefined;
+  }
+
+  const parts = [error.message];
+  const pendingPromiseDetails = error.diagnostics?.pendingPromises
+    ? formatPendingPromises(
+        error.diagnostics.pendingPromises,
+        options.testStartedAt,
+      )
+    : null;
+
+  if (pendingPromiseDetails) {
+    parts.push(pendingPromiseDetails);
+  }
+
+  if (error.codeFrame) {
+    parts.push(error.codeFrame.content);
+  }
+
+  return parts.join('\n\n');
+};