@react-native-harness/tools 1.0.0 → 1.1.0-rc.2

package/src/logger.ts

@@ -1,49 +1,59 @@
 import util from 'node:util';
-import { log as clackLog } from '@clack/prompts';
-import isUnicodeSupported from 'is-unicode-supported';
-import { color } from './color.js';
 
-const unicode = isUnicodeSupported();
+let verbose = !!process.env.HARNESS_DEBUG;
 
-const unicodeWithFallback = (c: string, fallback: string) =>
-  unicode ? c : fallback;
+type LoggerLevel = 'debug' | 'info' | 'warn' | 'error' | 'log' | 'success';
+type LoggerMethod = (...messages: Array<unknown>) => void;
 
-const SYMBOL_DEBUG = unicodeWithFallback('●', '•');
+export type HarnessLogger = {
+  debug: LoggerMethod;
+  info: LoggerMethod;
+  warn: LoggerMethod;
+  error: LoggerMethod;
+  log: LoggerMethod;
+  success: LoggerMethod;
+  child: (scope: string) => HarnessLogger;
+  setVerbose: (level: boolean) => void;
+  isVerbose: () => boolean;
+};
 
-let verbose = !!process.env.HARNESS_DEBUG;
+const BASE_TAG = '[harness]';
 
-const success = (...messages: Array<unknown>) => {
-  const output = util.format(...messages);
-  clackLog.success(output);
-};
+const getTimestamp = (): string => new Date().toISOString();
 
-const info = (...messages: Array<unknown>) => {
-  const output = util.format(...messages);
-  clackLog.info(output);
-};
+const normalizeScope = (scope: string): string =>
+  scope
+    .trim()
+    .replace(/^\[+|\]+$/g, '')
+    .replace(/\]\[/g, '][');
 
-const warn = (...messages: Array<unknown>) => {
-  const output = util.format(...messages);
-  clackLog.warn(mapLines(output, color.yellow));
+const formatPrefix = (scopes: readonly string[]): string => {
+  const suffix = scopes.map((scope) => `[${normalizeScope(scope)}]`).join('');
+  return `${BASE_TAG}${suffix}`;
 };
 
-const error = (...messages: Array<unknown>) => {
-  const output = util.format(...messages);
-  clackLog.error(mapLines(output, color.red));
-};
+const mapLines = (text: string, prefix: string) =>
+  text
+    .split('\n')
+    .map((line) => `${prefix} ${line}`)
+    .join('\n');
 
-const log = (...messages: Array<unknown>) => {
+const writeLog = (
+  level: LoggerLevel,
+  scopes: readonly string[],
+  messages: Array<unknown>
+) => {
+  const method =
+    level === 'warn'
+      ? console.warn
+      : level === 'error'
+        ? console.error
+        : level === 'debug'
+          ? console.debug
+          : console.info;
   const output = util.format(...messages);
-  clackLog.step(output);
-};
-
-const debug = (...messages: Array<unknown>) => {
-  if (verbose) {
-    const output = util.format(...messages);
-    clackLog.message(mapLines(output, color.dim), {
-      symbol: color.dim(SYMBOL_DEBUG),
-    });
-  }
+  const prefix = `${getTimestamp()} ${formatPrefix(scopes)}`;
+  method(mapLines(output, prefix));
 };
 
 const setVerbose = (level: boolean) => {
@@ -54,17 +64,35 @@ const isVerbose = () => {
   return verbose;
 };
 
-export const logger = {
-  success,
-  info,
-  warn,
-  error,
-  debug,
-  log,
+const createScopedLogger = (scopes: readonly string[] = []): HarnessLogger => ({
+  debug: (...messages) => {
+    if (!verbose) {
+      return;
+    }
+
+    writeLog('debug', scopes, messages);
+  },
+  info: (...messages) => {
+    writeLog('info', scopes, messages);
+  },
+  warn: (...messages) => {
+    writeLog('warn', scopes, messages);
+  },
+  error: (...messages) => {
+    writeLog('error', scopes, messages);
+  },
+  log: (...messages) => {
+    writeLog('log', scopes, messages);
+  },
+  success: (...messages) => {
+    writeLog('success', scopes, messages);
+  },
+  child: (scope) => createScopedLogger([...scopes, scope]),
   setVerbose,
   isVerbose,
-};
+});
+
+export const createLogger = (scope: string): HarnessLogger =>
+  createScopedLogger([scope]);
 
-function mapLines(text: string, colorFn: (line: string) => string) {
-  return text.split('\n').map(colorFn).join('\n');
-}
+export const logger = createScopedLogger();

package/src/regex.ts

@@ -0,0 +1,2 @@
+export const escapeRegExp = (value: string) =>
+  value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');

package/src/spawn.ts

@@ -3,6 +3,7 @@ import nanoSpawn, { SubprocessError } from 'nano-spawn';
 import { logger } from './logger.js';
 
 export type SpawnOptions = Options;
+const spawnLogger = logger.child('spawn');
 
 export const spawn = (
   file: string,
@@ -16,7 +17,8 @@ export const spawn = (
     // Always 'pipe' stderr to handle errors properly down the line
     stderr: 'pipe',
   };
-  logger.debug(`Running: ${file}`, ...(args ?? []));
+  const command = [file, ...(args ?? [])].join(' ');
+  spawnLogger.debug('running command: %s', command);
   const childProcess = nanoSpawn(file, args, { ...defaultOptions, ...options });
 
   setupChildProcessCleanup(childProcess);
@@ -33,6 +35,43 @@ export const spawnAndForget = async (file: string, args?: readonly string[], opt
 
 export { Subprocess, SubprocessError };
 
+const activeChildProcesses = new Set<Subprocess>();
+let isProcessCleanupInstalled = false;
+
+const terminateActiveChildren = async () => {
+  const children = [...activeChildProcesses];
+
+  await Promise.allSettled(
+    children.map(async (childProcess) => {
+      try {
+        (await childProcess.nodeChildProcess).kill();
+      } catch {
+        // Ignore cleanup failures while shutting down.
+      }
+    })
+  );
+};
+
+const installProcessCleanup = () => {
+  if (isProcessCleanupInstalled) {
+    return;
+  }
+
+  isProcessCleanupInstalled = true;
+
+  const terminate = async () => {
+    await terminateActiveChildren();
+    process.exit(1);
+  };
+
+  process.on('SIGINT', () => {
+    void terminate();
+  });
+  process.on('SIGTERM', () => {
+    void terminate();
+  });
+};
+
 const setupChildProcessCleanup = (childProcess: Subprocess) => {
   // https://stackoverflow.com/questions/53049939/node-daemon-wont-start-with-process-stdin-setrawmodetrue/53050098#53050098
   if (process.stdin.isTTY) {
@@ -41,24 +80,11 @@ const setupChildProcessCleanup = (childProcess: Subprocess) => {
     process.stdin.setRawMode(false);
   }
 
-  const terminate = async () => {
-    try {
-      (await childProcess.nodeChildProcess).kill();
-      process.exit(1);
-    } catch {
-      // ignore
-    }
-  };
-
-  const sigintHandler = () => terminate();
-  const sigtermHandler = () => terminate();
-
-  process.on('SIGINT', sigintHandler);
-  process.on('SIGTERM', sigtermHandler);
+  installProcessCleanup();
+  activeChildProcesses.add(childProcess);
 
   const cleanup = () => {
-    process.off('SIGINT', sigintHandler);
-    process.off('SIGTERM', sigtermHandler);
+    activeChildProcesses.delete(childProcess);
   };
 
   childProcess.nodeChildProcess.finally(cleanup);

package/tsconfig.lib.json

@@ -7,7 +7,8 @@
     "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
     "emitDeclarationOnly": false,
     "forceConsistentCasingInFileNames": true,
-    "types": ["node"]
+    "types": ["node"],
+    "lib": ["DOM", "ES2022"]
   },
   "include": ["src/**/*.ts"],
   "references": []

package/dist/runtime.d.ts

@@ -1,10 +0,0 @@
-declare global {
-    var Bun: boolean | undefined;
-    var Deno: boolean | undefined;
-}
-export declare const isBun: boolean;
-export declare const isDeno: boolean;
-export declare const isNode: boolean;
-export type Runtime = 'bun' | 'deno' | 'node';
-export declare const getRuntime: () => Runtime;
-//# sourceMappingURL=runtime.d.ts.map

package/dist/runtime.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,GAAG,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,IAAI,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AAED,eAAO,MAAM,KAAK,EAAE,OAAsB,CAAC;AAC3C,eAAO,MAAM,MAAM,EAAE,OAAuB,CAAC;AAC7C,eAAO,MAAM,MAAM,EAAE,OAAoD,CAAC;AAE1E,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9C,eAAO,MAAM,UAAU,QAAO,OAI7B,CAAC"}

package/dist/runtime.js

@@ -1,10 +0,0 @@
-export const isBun = !!global.Bun;
-export const isDeno = !!global.Deno;
-export const isNode = !!global.process?.versions?.node && !isBun;
-export const getRuntime = () => {
-    if (isBun)
-        return 'bun';
-    if (isDeno)
-        return 'deno';
-    return 'node';
-};

package/dist/timeout.d.ts

@@ -1,2 +0,0 @@
-export declare const withTimeout: <T>(promise: Promise<T>, timeout: number, onTimeout: () => Error) => Promise<T>;
-//# sourceMappingURL=timeout.d.ts.map

package/dist/timeout.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"timeout.d.ts","sourceRoot":"","sources":["../src/timeout.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,CAAC,EAC3B,SAAS,OAAO,CAAC,CAAC,CAAC,EACnB,SAAS,MAAM,EACf,WAAW,MAAM,KAAK,KACrB,OAAO,CAAC,CAAC,CAkBX,CAAC"}

package/dist/timeout.js

@@ -1,16 +0,0 @@
-export const withTimeout = (promise, timeout, onTimeout) => {
-    return new Promise((resolve, reject) => {
-        const timeoutId = setTimeout(() => {
-            reject(onTimeout());
-        }, timeout);
-        const onResolve = (result) => {
-            clearTimeout(timeoutId);
-            resolve(result);
-        };
-        const onReject = (error) => {
-            clearTimeout(timeoutId);
-            reject(error);
-        };
-        promise.then(onResolve).catch(onReject);
-    });
-};