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

package/dist/__tests__/crash-monitor.test.js

@@ -0,0 +1,212 @@
+import { describe, expect, it, vi } from 'vitest';
+import { createCrashMonitor, CrashWatchCancelledError, } from '../crash-monitor.js';
+import { NativeCrashError } from '../errors.js';
+const noop = () => undefined;
+const resolveUndefined = async () => undefined;
+// ---------------------------------------------------------------------------
+// Test doubles
+// ---------------------------------------------------------------------------
+const createAppMonitorMock = () => {
+    let registeredListener = null;
+    const monitor = {
+        start: vi.fn(resolveUndefined),
+        stop: vi.fn(resolveUndefined),
+        dispose: vi.fn(resolveUndefined),
+        addListener: vi.fn((l) => {
+            registeredListener = l;
+        }),
+        removeListener: vi.fn((l) => {
+            if (registeredListener === l)
+                registeredListener = null;
+        }),
+    };
+    return {
+        monitor,
+        emit: (event) => registeredListener?.(event),
+    };
+};
+const createPlatformRunnerMock = (isRunning = false, crashDetails = null) => ({
+    isAppRunning: vi.fn(async () => isRunning),
+    getCrashDetails: vi.fn(async () => crashDetails),
+    startApp: vi.fn(resolveUndefined),
+    restartApp: vi.fn(resolveUndefined),
+    stopApp: vi.fn(resolveUndefined),
+    dispose: vi.fn(resolveUndefined),
+    createAppMonitor: vi.fn(),
+});
+// ---------------------------------------------------------------------------
+// Tests
+// ---------------------------------------------------------------------------
+describe('createCrashMonitor', () => {
+    describe('liveness', () => {
+        it('starts not alive', () => {
+            const { monitor } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            expect(cm.isAlive()).toBe(false);
+        });
+        it('becomes alive when the app starts', () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            emit({ type: 'app_started' });
+            expect(cm.isAlive()).toBe(true);
+        });
+        it('becomes not alive after a confirmed crash', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            emit({ type: 'app_started' });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            emit({ type: 'app_exited', isConfirmed: true });
+            await watch.promise.catch(noop);
+            expect(cm.isAlive()).toBe(false);
+        });
+    });
+    describe('watch', () => {
+        it('promise rejects with NativeCrashError on confirmed app_exited', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            const watch = cm.watch('/test/example.ts', 'execution');
+            watch.promise.catch(noop);
+            emit({ type: 'app_exited', isConfirmed: true });
+            await expect(watch.promise).rejects.toBeInstanceOf(NativeCrashError);
+        });
+        it('attributes the crash to the file and phase passed to watch()', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            const watch = cm.watch('/test/example.ts', 'startup');
+            watch.promise.catch(noop);
+            emit({ type: 'app_exited', isConfirmed: true });
+            const error = await watch.promise.catch((e) => e);
+            expect(error.testFilePath).toBe('/test/example.ts');
+            expect(error.details.phase).toBe('startup');
+        });
+        it('settles the promise with CrashWatchCancelledError on cancel()', async () => {
+            const { monitor } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.cancel();
+            await expect(watch.promise).rejects.toBeInstanceOf(CrashWatchCancelledError);
+        });
+        it('subsequent cancel() after crash is a no-op', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            emit({ type: 'app_exited', isConfirmed: true });
+            await watch.promise.catch(noop);
+            // Second cancel should not throw or cause issues.
+            expect(() => watch.cancel()).not.toThrow();
+        });
+    });
+    describe('unconfirmed events', () => {
+        it('fires the crash if isAppRunning returns false', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const runner = createPlatformRunnerMock(false /* not running */);
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: runner });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            emit({ type: 'app_exited', isConfirmed: false });
+            await expect(watch.promise).rejects.toBeInstanceOf(NativeCrashError);
+        });
+        it('does not fire if isAppRunning returns true', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const runner = createPlatformRunnerMock(true /* still running */);
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: runner });
+            const watch = cm.watch('test.ts', 'execution');
+            const settled = vi.fn();
+            watch.promise.then(settled, settled);
+            emit({ type: 'app_exited', isConfirmed: false });
+            await new Promise((r) => setTimeout(r, 20));
+            expect(settled).not.toHaveBeenCalled();
+            watch.cancel();
+        });
+        it('fires on possible_crash when confirmed', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            emit({ type: 'possible_crash', isConfirmed: true });
+            await expect(watch.promise).rejects.toBeInstanceOf(NativeCrashError);
+        });
+    });
+    describe('crash detail enrichment', () => {
+        it('merges initial and enriched crash details', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const runner = createPlatformRunnerMock(false, {
+                processName: 'MyApp',
+                signal: 'SIGSEGV',
+                summary: 'Segmentation fault',
+            });
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: runner });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            emit({ type: 'app_exited', isConfirmed: true, crashDetails: { pid: 1234 } });
+            const error = await watch.promise.catch((e) => e);
+            expect(error.details.processName).toBe('MyApp');
+            expect(error.details.signal).toBe('SIGSEGV');
+            expect(error.details.pid).toBe(1234);
+        });
+    });
+    describe('stop / start', () => {
+        it('ignores events while stopped', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            await cm.stop();
+            const watch = cm.watch('test.ts', 'execution');
+            const settled = vi.fn();
+            watch.promise.then(settled, settled);
+            emit({ type: 'app_exited', isConfirmed: true });
+            await new Promise((r) => setTimeout(r, 10));
+            expect(settled).not.toHaveBeenCalled();
+            watch.cancel();
+        });
+        it('resumes monitoring after start()', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            await cm.stop();
+            await cm.start();
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            emit({ type: 'app_exited', isConfirmed: true });
+            await expect(watch.promise).rejects.toBeInstanceOf(NativeCrashError);
+        });
+    });
+    describe('reset', () => {
+        it('clears alive state and pending watchers', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            emit({ type: 'app_started' });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            cm.reset();
+            expect(cm.isAlive()).toBe(false);
+            // The watcher was cleared; a crash fired now should not reach the old watch.
+            emit({ type: 'app_exited', isConfirmed: true });
+            await new Promise((r) => setTimeout(r, 10));
+            // Old promise is still pending (we can verify by cancel resolving it).
+            watch.cancel();
+            await expect(watch.promise).rejects.toBeInstanceOf(CrashWatchCancelledError);
+        });
+    });
+    describe('dispose', () => {
+        it('ignores events after dispose', async () => {
+            const { monitor, emit } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            const watch = cm.watch('test.ts', 'execution');
+            watch.promise.catch(noop);
+            await cm.dispose();
+            emit({ type: 'app_exited', isConfirmed: true });
+            await new Promise((r) => setTimeout(r, 10));
+            // After dispose watchers are cleared, so crash didn't propagate.
+            // The promise is still pending - cancel to settle it.
+            watch.cancel();
+            await expect(watch.promise).rejects.toBeInstanceOf(CrashWatchCancelledError);
+        });
+        it('calls appMonitor.dispose()', async () => {
+            const { monitor } = createAppMonitorMock();
+            const cm = createCrashMonitor({ appMonitor: monitor, platformRunner: createPlatformRunnerMock() });
+            await cm.dispose();
+            expect(monitor.dispose).toHaveBeenCalledOnce();
+        });
+    });
+});

package/dist/__tests__/execute-run.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=execute-run.test.d.ts.map

package/dist/__tests__/execute-run.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute-run.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/execute-run.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/execute-run.test.js

@@ -0,0 +1,229 @@
+import { describe, expect, it, vi, beforeEach } from 'vitest';
+import { NativeCrashError, StartupStallError } from '../errors.js';
+import { DeviceNotRespondingError } from '@react-native-harness/bridge/server';
+import { executeRun } from '../execute-run.js';
+const resolveUndefined = async () => undefined;
+// Mock the file-runner so we control what jestResult/harnessResult each test returns
+// without needing a real Jest config or Metro bundler.
+const mockRunHarnessTestFile = vi.hoisted(() => vi.fn());
+vi.mock('../run.js', () => ({
+    runHarnessTestFile: mockRunHarnessTestFile,
+}));
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+const makeJestResult = (overrides = {}) => ({
+    testFilePath: '/test/example.ts',
+    testResults: [],
+    failureMessage: null,
+    numFailingTests: 0,
+    numPassingTests: 1,
+    numPendingTests: 0,
+    numTodoTests: 0,
+    leaks: false,
+    openHandles: [],
+    skipped: false,
+    snapshot: {
+        added: 0, fileDeleted: false, matched: 0, unchecked: 0,
+        uncheckedKeys: [], unmatched: 0, updated: 0,
+    },
+    perfStats: { start: 0, end: 1, runtime: 1, slow: false,
+        loadTestEnvironmentStart: 0, loadTestEnvironmentEnd: 0,
+        setupAfterEnvStart: 0, setupAfterEnvEnd: 0,
+        setupFilesStart: 0, setupFilesEnd: 0 },
+    coverage: undefined,
+    ...overrides,
+});
+const makeHarnessResult = (status = 'passed') => ({
+    name: 'suite',
+    tests: [],
+    suites: [],
+    status,
+    duration: 50,
+});
+const makeFileRunResult = (overrides = {}) => ({
+    jestResult: makeJestResult(),
+    harnessResult: makeHarnessResult(),
+    relativeTestPath: 'example.ts',
+    duration: 50,
+    ...overrides,
+});
+const makeTest = (filePath = '/test/example.ts') => ({
+    path: filePath,
+    context: { config: {} },
+});
+const makeWatcher = (interrupted = false) => ({ isInterrupted: () => interrupted });
+const makeGlobalConfig = (overrides = {}) => ({
+    rootDir: '/project',
+    watch: false,
+    watchAll: false,
+    collectCoverage: false,
+    ...overrides,
+});
+const makeSession = (overrides = {}) => ({
+    config: {
+        metroPort: 8081,
+        host: undefined,
+        resetEnvironmentBetweenTestFiles: false,
+        detectNativeCrashes: true,
+    },
+    context: {},
+    ensureAppReady: vi.fn(resolveUndefined),
+    runTestFile: vi.fn(async () => makeHarnessResult()),
+    restartApp: vi.fn(resolveUndefined),
+    resetCrashState: vi.fn(),
+    flushClientLogs: vi.fn(() => []),
+    callHook: vi.fn(resolveUndefined),
+    setRunState: vi.fn(),
+    dispose: vi.fn(resolveUndefined),
+    ...overrides,
+});
+// ---------------------------------------------------------------------------
+// Tests
+// ---------------------------------------------------------------------------
+beforeEach(() => {
+    vi.clearAllMocks();
+    mockRunHarnessTestFile.mockResolvedValue(makeFileRunResult());
+});
+describe('executeRun', () => {
+    describe('lifecycle hooks', () => {
+        it('emits run:started then run:finished in order', async () => {
+            const hookNames = [];
+            const session = makeSession({
+                callHook: vi.fn(async (name) => { hookNames.push(name); }),
+            });
+            await executeRun(session, [makeTest()], makeWatcher(), vi.fn(), vi.fn(), vi.fn(), makeGlobalConfig());
+            expect(hookNames[0]).toBe('run:started');
+            expect(hookNames[hookNames.length - 1]).toBe('run:finished');
+        });
+        it('emits test-file:started and test-file:finished around each test', async () => {
+            const hookNames = [];
+            const session = makeSession({
+                callHook: vi.fn(async (name) => { hookNames.push(name); }),
+            });
+            await executeRun(session, [makeTest('/a.ts'), makeTest('/b.ts')], makeWatcher(), vi.fn(), vi.fn(), vi.fn(), makeGlobalConfig());
+            const fileHooks = hookNames.filter((n) => n === 'test-file:started' || n === 'test-file:finished');
+            expect(fileHooks).toEqual([
+                'test-file:started', 'test-file:finished',
+                'test-file:started', 'test-file:finished',
+            ]);
+        });
+        it('always emits run:finished even when a test throws', async () => {
+            const hookNames = [];
+            const session = makeSession({
+                callHook: vi.fn(async (name) => { hookNames.push(name); }),
+                ensureAppReady: vi.fn(async () => { throw new Error('unexpected'); }),
+            });
+            await executeRun(session, [makeTest()], makeWatcher(), vi.fn(), vi.fn(), vi.fn(), makeGlobalConfig());
+            expect(hookNames).toContain('run:finished');
+        });
+    });
+    describe('happy path', () => {
+        it('calls onStart, ensureAppReady, runTestFile, onResult in order', async () => {
+            const order = [];
+            const session = makeSession({
+                ensureAppReady: vi.fn(async () => { order.push('ensureAppReady'); }),
+            });
+            const onStart = vi.fn(async () => { order.push('onStart'); });
+            const onResult = vi.fn(async () => { order.push('onResult'); });
+            mockRunHarnessTestFile.mockImplementation(async () => {
+                order.push('runTestFile');
+                return makeFileRunResult();
+            });
+            await executeRun(session, [makeTest()], makeWatcher(), onStart, onResult, vi.fn(), makeGlobalConfig());
+            expect(order).toEqual(['onStart', 'ensureAppReady', 'runTestFile', 'onResult']);
+        });
+        it('accumulates passing test counts in run:finished summary', async () => {
+            let finishedPayload;
+            const session = makeSession({
+                callHook: vi.fn(async (name, payload) => {
+                    if (name === 'run:finished')
+                        finishedPayload = payload;
+                }),
+            });
+            mockRunHarnessTestFile.mockResolvedValue(makeFileRunResult({ jestResult: makeJestResult({ numPassingTests: 3 }) }));
+            await executeRun(session, [makeTest(), makeTest('/b.ts')], makeWatcher(), vi.fn(), vi.fn(), vi.fn(), makeGlobalConfig());
+            const payload = finishedPayload;
+            expect(payload.summary.passed).toBe(6);
+            expect(payload.status).toBe('passed');
+        });
+        it('attaches buffered client logs to the Jest result', async () => {
+            const clientLogs = [{ message: 'Loaded screen', origin: '', type: 'warn' }];
+            const session = makeSession({
+                flushClientLogs: vi.fn()
+                    .mockReturnValueOnce([])
+                    .mockReturnValueOnce(clientLogs),
+            });
+            const onResult = vi.fn();
+            await executeRun(session, [makeTest()], makeWatcher(), vi.fn(), onResult, vi.fn(), makeGlobalConfig());
+            expect(session.flushClientLogs).toHaveBeenCalledTimes(2);
+            expect(onResult).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({ console: clientLogs }));
+        });
+    });
+    describe('runtime failures', () => {
+        it('passes StartupStallError to onFailure with an empty stack', async () => {
+            const onFailure = vi.fn();
+            const session = makeSession({
+                ensureAppReady: vi.fn().mockRejectedValue(new StartupStallError(1500, 3)),
+            });
+            await executeRun(session, [makeTest()], makeWatcher(), vi.fn(), vi.fn(), onFailure, makeGlobalConfig());
+            expect(onFailure).toHaveBeenCalledWith(expect.objectContaining({ path: '/test/example.ts' }), expect.objectContaining({ message: expect.stringContaining('1500'), stack: '' }));
+        });
+        it('passes DeviceNotRespondingError to onFailure with an empty stack', async () => {
+            const onFailure = vi.fn();
+            const session = makeSession({
+                ensureAppReady: vi.fn().mockRejectedValue(new DeviceNotRespondingError('runTests', [])),
+            });
+            await executeRun(session, [makeTest()], makeWatcher(), vi.fn(), vi.fn(), onFailure, makeGlobalConfig());
+            expect(onFailure).toHaveBeenCalledWith(expect.anything(), expect.objectContaining({ stack: '' }));
+        });
+        it('calls resetCrashState after a NativeCrashError', async () => {
+            const session = makeSession({
+                ensureAppReady: vi.fn().mockRejectedValue(new NativeCrashError('example.ts', { phase: 'execution', source: 'polling' })),
+            });
+            await executeRun(session, [makeTest()], makeWatcher(), vi.fn(), vi.fn(), vi.fn(), makeGlobalConfig());
+            expect(session.resetCrashState).toHaveBeenCalled();
+        });
+        it('counts runtime failures in the summary', async () => {
+            let finishedPayload;
+            const session = makeSession({
+                callHook: vi.fn(async (name, payload) => {
+                    if (name === 'run:finished')
+                        finishedPayload = payload;
+                }),
+                ensureAppReady: vi.fn().mockRejectedValue(new StartupStallError(1000, 2)),
+            });
+            await executeRun(session, [makeTest()], makeWatcher(), vi.fn(), vi.fn(), vi.fn(), makeGlobalConfig());
+            const payload = finishedPayload;
+            expect(payload.summary.failed).toBe(1);
+            expect(payload.status).toBe('failed');
+        });
+    });
+    describe('watcher interrupt', () => {
+        it('stops processing tests and still emits run:finished', async () => {
+            const hookNames = [];
+            const session = makeSession({
+                callHook: vi.fn(async (name) => { hookNames.push(name); }),
+            });
+            const onStart = vi.fn();
+            await executeRun(session, [makeTest('/a.ts'), makeTest('/b.ts')], makeWatcher(true /* interrupted */), onStart, vi.fn(), vi.fn(), makeGlobalConfig());
+            // No test was started; watcher was already interrupted.
+            expect(onStart).not.toHaveBeenCalled();
+            expect(hookNames).toContain('run:finished');
+        });
+    });
+    describe('resetEnvironmentBetweenTestFiles', () => {
+        it('calls restartApp before the second test but not the first', async () => {
+            const session = makeSession({
+                config: {
+                    metroPort: 8081,
+                    resetEnvironmentBetweenTestFiles: true,
+                    detectNativeCrashes: false,
+                },
+            });
+            await executeRun(session, [makeTest('/a.ts'), makeTest('/b.ts'), makeTest('/c.ts')], makeWatcher(), vi.fn(), vi.fn(), vi.fn(), makeGlobalConfig());
+            // restartApp should be called for tests 2 and 3, not test 1.
+            expect(session.restartApp).toHaveBeenCalledTimes(2);
+        });
+    });
+});

package/dist/__tests__/fixtures/mock-platform-runner.d.ts

@@ -0,0 +1,7 @@
+import type { HarnessPlatformInitOptions, HarnessPlatformRunner } from '@react-native-harness/platforms';
+import type { Config as HarnessConfig } from '@react-native-harness/config';
+declare global {
+    var __HARNESS_TEST_PLATFORM_RUNNER__: HarnessPlatformRunner | undefined;
+}
+export default function mockPlatformRunner(_platformConfig: Record<string, unknown>, _harnessConfig: HarnessConfig, _init: HarnessPlatformInitOptions): Promise<HarnessPlatformRunner>;
+//# sourceMappingURL=mock-platform-runner.d.ts.map

package/dist/__tests__/fixtures/mock-platform-runner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock-platform-runner.d.ts","sourceRoot":"","sources":["../../../src/__tests__/fixtures/mock-platform-runner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE5E,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,gCAAgC,EAChC,qBAAqB,GACrB,SAAS,CAAC;CACf;AAED,wBAA8B,kBAAkB,CAC9C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,cAAc,EAAE,aAAa,EAC7B,KAAK,EAAE,0BAA0B,GAChC,OAAO,CAAC,qBAAqB,CAAC,CAMhC"}

package/dist/__tests__/fixtures/mock-platform-runner.js

@@ -0,0 +1,6 @@
+export default async function mockPlatformRunner(_platformConfig, _harnessConfig, _init) {
+    if (!globalThis.__HARNESS_TEST_PLATFORM_RUNNER__) {
+        throw new Error('Missing __HARNESS_TEST_PLATFORM_RUNNER__ test fixture');
+    }
+    return globalThis.__HARNESS_TEST_PLATFORM_RUNNER__;
+}

package/dist/__tests__/harness-session.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=harness-session.test.d.ts.map

package/dist/__tests__/harness-session.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"harness-session.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/harness-session.test.ts"],"names":[],"mappings":""}