@react-native-harness/jest 1.0.0-alpha.22 → 1.0.0-alpha.24

package/dist/__tests__/client-log-handler.test.d.ts

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

package/dist/__tests__/client-log-handler.test.d.ts.map

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

package/dist/__tests__/client-log-handler.test.js

@@ -0,0 +1,262 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { formatClientLogMessage, formatClientLogLine, handleClientLogEvent, createClientLogListener, } from '../client-log-handler.js';
+// Mock the log function
+vi.mock('../logs.js', () => ({
+    log: vi.fn(),
+}));
+import { log } from '../logs.js';
+describe('client-log-handler', () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+    describe('formatClientLogMessage', () => {
+        it('should format a single string', () => {
+            const result = formatClientLogMessage(['Hello, world!']);
+            expect(result).toBe('Hello, world!');
+        });
+        it('should join multiple strings with spaces', () => {
+            const result = formatClientLogMessage(['Hello', 'world', '!']);
+            expect(result).toBe('Hello world !');
+        });
+        it('should format objects', () => {
+            const result = formatClientLogMessage([{ key: 'value' }]);
+            // util.format uses inspect-style output for objects
+            expect(result).toContain('key');
+            expect(result).toContain('value');
+        });
+        it('should format arrays', () => {
+            const result = formatClientLogMessage([[1, 2, 3]]);
+            expect(result).toContain('1');
+            expect(result).toContain('2');
+            expect(result).toContain('3');
+        });
+        it('should handle mixed types', () => {
+            const result = formatClientLogMessage([
+                'Message:',
+                { count: 42 },
+                'items',
+            ]);
+            expect(result).toContain('Message:');
+            expect(result).toContain('count');
+            expect(result).toContain('42');
+            expect(result).toContain('items');
+        });
+        it('should format numbers', () => {
+            const result = formatClientLogMessage([123, 456]);
+            expect(result).toBe('123 456');
+        });
+        it('should format booleans', () => {
+            const result = formatClientLogMessage([true, false]);
+            expect(result).toBe('true false');
+        });
+        it('should format null and undefined', () => {
+            const result = formatClientLogMessage([null, undefined]);
+            expect(result).toBe('null undefined');
+        });
+        it('should handle empty array', () => {
+            const result = formatClientLogMessage([]);
+            expect(result).toBe('');
+        });
+        describe('printf-style format specifiers', () => {
+            it('should handle %s string substitution', () => {
+                const result = formatClientLogMessage(['%s world', 'hello']);
+                expect(result).toBe('hello world');
+            });
+            it('should handle %d integer substitution', () => {
+                const result = formatClientLogMessage(['Count: %d', 42]);
+                expect(result).toBe('Count: 42');
+            });
+            it('should handle %i integer substitution', () => {
+                const result = formatClientLogMessage(['Value: %i', 123]);
+                expect(result).toBe('Value: 123');
+            });
+            it('should handle %f float substitution', () => {
+                const result = formatClientLogMessage(['Pi: %f', 3.14159]);
+                expect(result).toContain('3.14159');
+            });
+            it('should handle multiple substitutions', () => {
+                const result = formatClientLogMessage(['Hello %s, you have %d messages', 'Alice', 5]);
+                expect(result).toBe('Hello Alice, you have 5 messages');
+            });
+            it('should handle %j JSON substitution', () => {
+                const result = formatClientLogMessage(['Data: %j', { key: 'value' }]);
+                expect(result).toBe('Data: {"key":"value"}');
+            });
+            it('should handle %o object substitution', () => {
+                const result = formatClientLogMessage(['Object: %o', { a: 1 }]);
+                // %o produces inspect-style output, just check it contains the key
+                expect(result).toContain('a');
+            });
+            it('should handle %% as literal percent when substituting', () => {
+                // %% is only converted to % when there are substitutions
+                const result = formatClientLogMessage(['%s is 100%% complete', 'Task']);
+                expect(result).toBe('Task is 100% complete');
+            });
+            it('should append extra arguments after substitution', () => {
+                const result = formatClientLogMessage(['Hello %s', 'world', 'extra', 'args']);
+                expect(result).toBe('Hello world extra args');
+            });
+        });
+    });
+    describe('formatClientLogLine', () => {
+        it('should format log level event', () => {
+            const event = {
+                type: 'client_log',
+                level: 'log',
+                data: ['Test message'],
+            };
+            const result = formatClientLogLine(event);
+            // The result will contain ANSI codes for styling, so we check it contains the message
+            expect(result).toContain('Test message');
+        });
+        it('should format error level event', () => {
+            const event = {
+                type: 'client_log',
+                level: 'error',
+                data: ['Error occurred'],
+            };
+            const result = formatClientLogLine(event);
+            expect(result).toContain('Error occurred');
+        });
+        it('should format warn level event', () => {
+            const event = {
+                type: 'client_log',
+                level: 'warn',
+                data: ['Warning message'],
+            };
+            const result = formatClientLogLine(event);
+            expect(result).toContain('Warning message');
+        });
+        it('should format info level event', () => {
+            const event = {
+                type: 'client_log',
+                level: 'info',
+                data: ['Info message'],
+            };
+            const result = formatClientLogLine(event);
+            expect(result).toContain('Info message');
+        });
+        it('should format debug level event', () => {
+            const event = {
+                type: 'client_log',
+                level: 'debug',
+                data: ['Debug message'],
+            };
+            const result = formatClientLogLine(event);
+            expect(result).toContain('Debug message');
+        });
+        it('should format trace level event', () => {
+            const event = {
+                type: 'client_log',
+                level: 'trace',
+                data: ['Trace message'],
+            };
+            const result = formatClientLogLine(event);
+            expect(result).toContain('Trace message');
+        });
+        it('should handle multiple data items', () => {
+            const event = {
+                type: 'client_log',
+                level: 'log',
+                data: ['User:', { id: 1, name: 'Test' }],
+            };
+            const result = formatClientLogLine(event);
+            expect(result).toContain('User:');
+            expect(result).toContain('id');
+            expect(result).toContain('Test');
+        });
+    });
+    describe('handleClientLogEvent', () => {
+        it('should handle client_log events and call log', () => {
+            const event = {
+                type: 'client_log',
+                level: 'log',
+                data: ['Test message'],
+            };
+            const result = handleClientLogEvent(event);
+            expect(result).toBe(true);
+            expect(log).toHaveBeenCalledTimes(1);
+            expect(log).toHaveBeenCalledWith(expect.stringContaining('Test message'));
+        });
+        it('should return false for non-client_log events', () => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const event = { type: 'bundle_build_started' };
+            const result = handleClientLogEvent(event);
+            expect(result).toBe(false);
+            expect(log).not.toHaveBeenCalled();
+        });
+        it('should handle error level logs', () => {
+            const event = {
+                type: 'client_log',
+                level: 'error',
+                data: ['Something went wrong'],
+            };
+            handleClientLogEvent(event);
+            expect(log).toHaveBeenCalledWith(expect.stringContaining('Something went wrong'));
+        });
+        it('should handle warn level logs', () => {
+            const event = {
+                type: 'client_log',
+                level: 'warn',
+                data: ['Deprecation warning'],
+            };
+            handleClientLogEvent(event);
+            expect(log).toHaveBeenCalledWith(expect.stringContaining('Deprecation warning'));
+        });
+    });
+    describe('createClientLogListener', () => {
+        it('should create a listener function', () => {
+            const listener = createClientLogListener();
+            expect(typeof listener).toBe('function');
+        });
+        it('should handle client_log events when called', () => {
+            const listener = createClientLogListener();
+            const event = {
+                type: 'client_log',
+                level: 'info',
+                data: ['Listener test'],
+            };
+            listener(event);
+            expect(log).toHaveBeenCalledWith(expect.stringContaining('Listener test'));
+        });
+        it('should ignore non-client_log events', () => {
+            const listener = createClientLogListener();
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const event = { type: 'initialize_done' };
+            listener(event);
+            expect(log).not.toHaveBeenCalled();
+        });
+    });
+    describe('group events', () => {
+        it('should handle group events without logging', () => {
+            const event = {
+                type: 'client_log',
+                level: 'group',
+                data: ['Group label'],
+            };
+            const result = handleClientLogEvent(event);
+            expect(result).toBe(true);
+            expect(log).not.toHaveBeenCalled();
+        });
+        it('should handle groupCollapsed events without logging', () => {
+            const event = {
+                type: 'client_log',
+                level: 'groupCollapsed',
+                data: ['Collapsed'],
+            };
+            const result = handleClientLogEvent(event);
+            expect(result).toBe(true);
+            expect(log).not.toHaveBeenCalled();
+        });
+        it('should handle groupEnd events without logging', () => {
+            const event = {
+                type: 'client_log',
+                level: 'groupEnd',
+                data: [],
+            };
+            const result = handleClientLogEvent(event);
+            expect(result).toBe(true);
+            expect(log).not.toHaveBeenCalled();
+        });
+    });
+});

package/dist/client-log-handler.d.ts

@@ -0,0 +1,23 @@
+import type { ReportableEvent } from '@react-native-harness/bundler-metro';
+export type ClientLogEvent = Extract<ReportableEvent, {
+    type: 'client_log';
+}>;
+/**
+ * Formats a client log event data array into a string message.
+ * Uses util.format for printf-style format specifier support (%s, %d, %j, etc.)
+ */
+export declare const formatClientLogMessage: (data: unknown[]) => string;
+/**
+ * Formats a client log event into a log line with styled level prefix.
+ */
+export declare const formatClientLogLine: (event: ClientLogEvent) => string;
+/**
+ * Handles a client_log event by formatting and logging it.
+ * Returns true if the event was handled, false otherwise.
+ */
+export declare const handleClientLogEvent: (event: ReportableEvent) => boolean;
+/**
+ * Creates a client log event listener that can be added to the Metro reporter.
+ */
+export declare const createClientLogListener: () => ((event: ReportableEvent) => void);
+//# sourceMappingURL=client-log-handler.d.ts.map

package/dist/client-log-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-log-handler.d.ts","sourceRoot":"","sources":["../src/client-log-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAK3E,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,eAAe,EAAE;IAAE,IAAI,EAAE,YAAY,CAAA;CAAE,CAAC,CAAC;AA6C9E;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GAAI,MAAM,OAAO,EAAE,KAAG,MAKxD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,cAAc,KAAG,MAI3D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,eAAe,KAAG,OAiB7D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,QAAO,CAAC,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAI3E,CAAC"}

package/dist/client-log-handler.js

@@ -0,0 +1,84 @@
+import chalk from 'chalk';
+import util from 'node:util';
+import { log } from './logs.js';
+/**
+ * Gets the display level for a log level.
+ * Note: Metro treats 'trace' as 'log' because Hermes doesn't include stack traces.
+ */
+const getDisplayLevel = (level) => {
+    // Metro converts trace to log for display (Hermes doesn't provide stack traces)
+    if (level === 'trace') {
+        return 'LOG';
+    }
+    return level.toUpperCase();
+};
+/**
+ * Creates a styled tag for a log level with colored box appearance.
+ */
+const createLevelTag = (level) => {
+    const displayLevel = getDisplayLevel(level);
+    const label = ` ${displayLevel} `;
+    if (!chalk.supportsColor) {
+        return `[${displayLevel}]`;
+    }
+    switch (level) {
+        case 'error':
+            return chalk.reset.inverse.bold.red(label);
+        case 'warn':
+            return chalk.reset.inverse.bold.yellow(label);
+        case 'info':
+            return chalk.reset.inverse.bold.cyan(label);
+        case 'debug':
+            return chalk.reset.inverse.bold.blue(label);
+        case 'trace':
+            // Trace displays as LOG but with a distinct color
+            return chalk.reset.inverse.bold.magenta(label);
+        case 'log':
+        default:
+            return chalk.reset.inverse.bold.white(label);
+    }
+};
+/**
+ * Formats a client log event data array into a string message.
+ * Uses util.format for printf-style format specifier support (%s, %d, %j, etc.)
+ */
+export const formatClientLogMessage = (data) => {
+    if (data.length === 0) {
+        return '';
+    }
+    return util.format(...data);
+};
+/**
+ * Formats a client log event into a log line with styled level prefix.
+ */
+export const formatClientLogLine = (event) => {
+    const tag = createLevelTag(event.level);
+    const message = formatClientLogMessage(event.data);
+    return `${tag} ${message}`;
+};
+/**
+ * Handles a client_log event by formatting and logging it.
+ * Returns true if the event was handled, false otherwise.
+ */
+export const handleClientLogEvent = (event) => {
+    if (event.type !== 'client_log') {
+        return false;
+    }
+    // Skip group events - they don't produce output
+    if (event.level === 'group' ||
+        event.level === 'groupCollapsed' ||
+        event.level === 'groupEnd') {
+        return true;
+    }
+    const logLine = formatClientLogLine(event);
+    log(logLine);
+    return true;
+};
+/**
+ * Creates a client log event listener that can be added to the Metro reporter.
+ */
+export const createClientLogListener = () => {
+    return (event) => {
+        handleClientLogEvent(event);
+    };
+};

package/dist/harness.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"harness.d.ts","sourceRoot":"","sources":["../src/harness.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACb,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,eAAe,EACf,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,QAAQ,EAET,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAsB,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEtE,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;AAE/E,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,sBAAsB,KAC5B,OAAO,CAAC,eAAe,CAAC,CAAC;IAC9B,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,eAAe,GAAU,SAAS;IAC7C,WAAW,EAAE,QAAQ,CAAC;IACtB,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,EAAE,qBAAqB,CAAC;IACxC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,WAAW,CAAC;CACrB,KAAG,OAAO,CAAC,IAAI,CAgFf,CAAC;AAwFF,eAAO,MAAM,UAAU,GACrB,QAAQ,aAAa,EACrB,UAAU,eAAe,EACzB,aAAa,MAAM,KAClB,OAAO,CAAC,OAAO,CAkBjB,CAAC"}
+{"version":3,"file":"harness.d.ts","sourceRoot":"","sources":["../src/harness.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACb,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,eAAe,EACf,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,QAAQ,EAET,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAsB,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGtE,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;AAE/E,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,sBAAsB,KAC5B,OAAO,CAAC,eAAe,CAAC,CAAC;IAC9B,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,eAAe,GAAU,SAAS;IAC7C,WAAW,EAAE,QAAQ,CAAC;IACtB,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,EAAE,qBAAqB,CAAC;IACxC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,WAAW,CAAC;CACrB,KAAG,OAAO,CAAC,IAAI,CAgFf,CAAC;AAkGF,eAAO,MAAM,UAAU,GACrB,QAAQ,aAAa,EACrB,UAAU,eAAe,EACzB,aAAa,MAAM,KAClB,OAAO,CAAC,OAAO,CAkBjB,CAAC"}

package/dist/harness.js

@@ -2,6 +2,7 @@ import { getBridgeServer, } from '@react-native-harness/bridge/server';
 import { getMetroInstance, } from '@react-native-harness/bundler-metro';
 import { InitializationTimeoutError, MaxAppRestartsError } from './errors.js';
 import { createCrashMonitor } from './crash-monitor.js';
+import { createClientLogListener } from './client-log-handler.js';
 export const waitForAppReady = async (options) => {
     const { metroEvents, serverBridge, platformInstance, bundleStartTimeout, maxRestarts, signal, } = options;
     let restartCount = 0;
@@ -78,7 +79,15 @@ const getHarnessInternal = async (config, platform, projectRoot, signal) => {
             context,
         }),
     ]);
+    // Forward client logs to console if enabled
+    const clientLogListener = createClientLogListener();
+    if (config.forwardClientLogs) {
+        metroInstance.events.addListener(clientLogListener);
+    }
     const dispose = async () => {
+        if (config.forwardClientLogs) {
+            metroInstance.events.removeListener(clientLogListener);
+        }
         await Promise.all([
             serverBridge.dispose(),
             platformInstance.dispose(),

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,aAAa,CAAC;AAqCxD,eAAO,MAAM,KAAK,GAAU,cAAc,UAAU,CAAC,YAAY,kBAyChE,CAAC"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,aAAa,CAAC;AAqCxD,eAAO,MAAM,KAAK,GAAU,cAAc,UAAU,CAAC,YAAY,kBA6ChE,CAAC"}

package/dist/setup.js

@@ -42,6 +42,9 @@ export const setup = async (globalConfig) => {
         // This is going to be used by @react-native-harness/babel-preset
         // to enable instrumentation of test files.
         process.env.RN_HARNESS_COLLECT_COVERAGE = 'true';
+        if (harnessConfig.coverage?.root) {
+            process.env.RN_HARNESS_COVERAGE_ROOT = harnessConfig.coverage.root;
+        }
     }
     logTestRunHeader(selectedRunner);
     const harness = await getHarness(harnessConfig, selectedRunner, globalConfig.rootDir);