@react-native-harness/jest 1.3.0 → 1.4.0

package/src/diagnostics/report.ts

@@ -0,0 +1,124 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import type { DiagnosticEntry } from '@react-native-harness/tools';
+import { getHarnessRootPath } from '@react-native-harness/tools';
+
+type TraceEvent = {
+  name: string;
+  ph: 'X' | 'i';
+  ts: number;
+  dur?: number;
+  s?: 'g';
+  pid: number;
+  tid: number;
+  args?: Record<string, unknown>;
+};
+
+const TRACE_PID = 1;
+const TRACE_TID = 1;
+
+const toTraceEvent = (entry: DiagnosticEntry): TraceEvent => {
+  if (entry.kind === 'mark') {
+    return {
+      name: entry.label,
+      ph: 'i',
+      s: 'g',
+      ts: entry.startTime * 1000,
+      pid: TRACE_PID,
+      tid: TRACE_TID,
+      args: entry.attrs,
+    };
+  }
+
+  return {
+    name: entry.label,
+    ph: 'X',
+    ts: entry.startTime * 1000,
+    dur: entry.duration * 1000,
+    pid: TRACE_PID,
+    tid: TRACE_TID,
+    args: entry.attrs,
+  };
+};
+
+export const writeTraceFile = async (
+  entries: DiagnosticEntry[],
+  options: { projectRoot: string; runId: string }
+): Promise<string> => {
+  const dir = path.join(getHarnessRootPath(options.projectRoot), 'diagnostics');
+  await fs.mkdir(dir, { recursive: true });
+
+  const filePath = path.join(dir, `${options.runId}.json`);
+  const trace = { traceEvents: entries.map(toTraceEvent) };
+
+  await fs.writeFile(filePath, JSON.stringify(trace), 'utf-8');
+
+  return filePath;
+};
+
+const formatDuration = (ms: number): string => {
+  if (ms >= 1000) {
+    return `${(ms / 1000).toFixed(1)}s`;
+  }
+  return `${Math.round(ms)}ms`;
+};
+
+const getNamespace = (label: string): string => label.split('.')[0] ?? label;
+
+type LabelStats = {
+  label: string;
+  count: number;
+  totalMs: number;
+  maxMs: number;
+};
+
+export const printSummary = (
+  entries: DiagnosticEntry[],
+  log: (line: string) => void
+): void => {
+  if (entries.length === 0) {
+    return;
+  }
+
+  const statsByLabel = new Map<string, LabelStats>();
+  for (const entry of entries) {
+    const existing = statsByLabel.get(entry.label);
+    if (existing) {
+      existing.count += 1;
+      existing.totalMs += entry.duration;
+      existing.maxMs = Math.max(existing.maxMs, entry.duration);
+    } else {
+      statsByLabel.set(entry.label, {
+        label: entry.label,
+        count: 1,
+        totalMs: entry.duration,
+        maxMs: entry.duration,
+      });
+    }
+  }
+
+  const byNamespace = new Map<string, LabelStats[]>();
+  for (const stats of statsByLabel.values()) {
+    const namespace = getNamespace(stats.label);
+    const group = byNamespace.get(namespace);
+    if (group) {
+      group.push(stats);
+    } else {
+      byNamespace.set(namespace, [stats]);
+    }
+  }
+
+  log('Diagnostics summary:');
+  const sortedNamespaces = [...byNamespace.entries()].sort(([a], [b]) =>
+    a.localeCompare(b)
+  );
+  for (const [namespace, group] of sortedNamespaces) {
+    log(`  ${namespace}`);
+    group.sort((a, b) => b.totalMs - a.totalMs);
+    for (const stats of group) {
+      log(
+        `    ${stats.label}: count=${stats.count} total=${formatDuration(stats.totalMs)} max=${formatDuration(stats.maxMs)}`
+      );
+    }
+  }
+};

package/src/environment-reset.ts

@@ -0,0 +1,138 @@
+import { getTimeoutSignal } from '@react-native-harness/tools';
+import type { Config as HarnessConfig } from '@react-native-harness/config';
+
+const ignorePromiseRejection = () => undefined;
+
+export type ResetStrategyKind = 'process' | 'runtime';
+
+export type EnvironmentResetStrategy = {
+  readonly kind: ResetStrategyKind;
+  // Post-condition: bridge connected, runtime ready, crash-monitor state consistent.
+  reset(ctx: { testFilePath: string }): Promise<void>;
+};
+
+/**
+ * Normalizes the `resetEnvironmentBetweenTestFiles` config value into a
+ * strategy kind, or `null` when no reset should happen between test files
+ * (i.e. the value is `false`).
+ */
+export const resolveResetStrategyKind = (
+  value: HarnessConfig['resetEnvironmentBetweenTestFiles']
+): ResetStrategyKind | null => {
+  if (value === false) {
+    return null;
+  }
+  if (value === true) {
+    return 'process';
+  }
+  return value;
+};
+
+export type ProcessResetStrategyDeps = {
+  // Shared with restartApp; killing and relaunching the app process.
+  restart: (testFilePath: string) => Promise<void>;
+};
+
+/**
+ * The 'process' strategy: kill and cold-restart the app process. This is
+ * the same implementation `restartApp` uses for crash/timeout recovery.
+ */
+export const createProcessResetStrategy = (
+  deps: ProcessResetStrategyDeps
+): EnvironmentResetStrategy => ({
+  kind: 'process',
+  reset: ({ testFilePath }) => deps.restart(testFilePath),
+});
+
+export type RuntimeResetConnection = {
+  resetEnvironment: () => Promise<void>;
+};
+
+export type RuntimeResetStrategyDeps = {
+  // Returns the active app connection, or null if there isn't one.
+  getConnection: () => RuntimeResetConnection | null;
+  // Opens a window that suppresses crash-monitor disconnect handling;
+  // returns a closer to end the window.
+  expectDisconnect: () => () => void;
+  // Resolves the next time the bridge reports a 'connected' event, or
+  // rejects when `signal` aborts.
+  waitForReconnect: (signal: AbortSignal) => Promise<void>;
+  // Identifies RPC rejections caused by the bridge disconnecting. Inside the
+  // expected-disconnect window these mean the reload tore the runtime down
+  // before the RPC ack flushed — the reload is in flight, not failed.
+  isDisconnectError: (error: unknown) => boolean;
+  // Reconnect timeout in ms (the configured bundleStartTimeout).
+  timeoutMs: number;
+};
+
+/**
+ * The 'runtime' strategy: reload the JS runtime in place (DevSettings.reload()
+ * on native, window.location.reload() on web) via the resetEnvironment RPC,
+ * and wait for the bridge to reconnect. The app process stays alive
+ * throughout, so the crash monitor's expected-disconnect window is used to
+ * avoid misclassifying the intentional disconnect as a runtime failure.
+ */
+export const createRuntimeResetStrategy = (
+  deps: RuntimeResetStrategyDeps
+): EnvironmentResetStrategy => ({
+  kind: 'runtime',
+  reset: async () => {
+    const connection = deps.getConnection();
+    if (!connection) {
+      throw new Error('No active app connection to reset the runtime on');
+    }
+
+    const closeWindow = deps.expectDisconnect();
+    try {
+      // Start listening for the reconnect before firing the RPC, so a fast
+      // reload can't reconnect before we're watching for it.
+      const reconnected = deps.waitForReconnect(getTimeoutSignal(deps.timeoutMs));
+      // Observe the rejection even when the RPC throws first, so the timeout
+      // abort firing later can't become an unhandled rejection. (.catch()
+      // returns a new promise; the original is what gets awaited below.)
+      reconnected.catch(ignorePromiseRejection);
+
+      try {
+        await connection.resetEnvironment();
+      } catch (error) {
+        // The reload can tear the runtime down before the RPC ack flushes.
+        // A disconnect-flavored rejection means the reload is in flight, so
+        // keep waiting for the reconnect; anything else is a real failure.
+        if (!deps.isDisconnectError(error)) {
+          throw error;
+        }
+      }
+
+      await reconnected;
+    } finally {
+      closeWindow();
+    }
+  },
+});
+
+export type EscalationOptions = {
+  // Invoked when the primary strategy fails and the fallback is about to run.
+  onEscalate?: (error: unknown) => void;
+};
+
+/**
+ * Wraps a primary strategy so that any failure (no active connection, RPC
+ * error, reconnect timeout, ...) falls back to running `fallback` instead of
+ * propagating the error. The composite reports the primary's `kind`, since
+ * that's the strategy that was requested.
+ */
+export const withEscalation = (
+  primary: EnvironmentResetStrategy,
+  fallback: EnvironmentResetStrategy,
+  options: EscalationOptions = {}
+): EnvironmentResetStrategy => ({
+  kind: primary.kind,
+  reset: async (ctx) => {
+    try {
+      await primary.reset(ctx);
+    } catch (error) {
+      options.onEscalate?.(error);
+      await fallback.reset(ctx);
+    }
+  },
+});

package/src/errors.ts

@@ -1,4 +1,4 @@
-import { HarnessError } from '@react-native-harness/tools';
+import { formatPath, HarnessError } from '@react-native-harness/tools';
 import type { AppCrashDetails } from '@react-native-harness/platforms';
 export {
   StartupStallError,
@@ -55,6 +55,10 @@ export type NativeCrashDetails = AppCrashDetails & {
   phase: NativeCrashPhase;
 };
 
+export type RuntimeDisconnectDetails = AppCrashDetails & {
+  phase: NativeCrashPhase;
+};
+
 const buildNativeCrashMessage = ({
   phase,
   summary,
@@ -64,12 +68,28 @@ const buildNativeCrashMessage = ({
   pid,
   stackTrace,
   artifactType,
+  artifactPath,
+  enrichmentArtifacts,
 }: NativeCrashDetails) => {
   const lines = [
     phase === 'startup'
       ? 'The native app crashed while preparing to run this test file.'
       : 'The native app crashed during test execution.',
   ];
+
+  lines.push(
+    artifactPath
+      ? `Harness extracted the crash log: ${formatPath(artifactPath)}`
+      : "Harness couldn't extract the crash log."
+  );
+
+  if (enrichmentArtifacts && enrichmentArtifacts.length > 0) {
+    lines.push('Additional crash artifacts:');
+    for (const artifact of enrichmentArtifacts) {
+      lines.push(`  - ${formatPath(artifact.artifactPath)}`);
+    }
+  }
+
   const hasCrashBlock = summary?.includes('\n') ?? false;
   const shouldRenderSummary =
     Boolean(summary) &&
@@ -119,3 +139,44 @@ export class NativeCrashError extends HarnessError {
     return this.details.phase;
   }
 }
+
+const buildRuntimeDisconnectMessage = ({
+  phase,
+  summary,
+  rawLines,
+}: RuntimeDisconnectDetails) => {
+  const lines = [
+    phase === 'startup'
+      ? 'The native runtime disconnected while preparing to run this test file.'
+      : 'The native runtime disconnected during test execution.',
+  ];
+
+  if (summary) {
+    lines.push('');
+    lines.push(summary);
+  }
+
+  if (rawLines && rawLines.length > 0 && summary !== rawLines.join('\n')) {
+    lines.push('');
+    lines.push(...rawLines);
+  }
+
+  return lines.join('\n');
+};
+
+export class RuntimeDisconnectError extends HarnessError {
+  constructor(
+    public readonly testFilePath: string,
+    public readonly details: RuntimeDisconnectDetails
+  ) {
+    super(buildRuntimeDisconnectMessage(details));
+    this.name = 'RuntimeDisconnectError';
+    this.stack = `${this.name}: ${this.message.split('\n')[0]}`;
+  }
+
+  get phase() {
+    return this.details.phase;
+  }
+}
+
+export type HarnessRuntimeFailure = NativeCrashError | RuntimeDisconnectError;