detox 20.0.2-breaking.new-global-lifecycle.0 → 20.0.5-breaking.new-global-lifecycle.0

package/src/configuration/composeLoggerConfig.js

@@ -7,25 +7,34 @@ const { castLevel, defaultOptions } = require('../logger/DetoxLogger');
  * @param {Detox.DetoxConfig} opts.globalConfig
  * @param {Detox.DetoxConfiguration} opts.localConfig
  * @param {*} opts.cliConfig
- * @returns {Detox.DetoxLoggerConfig}
  */
 function composeLoggerConfig(opts) {
   const { globalConfig, localConfig, cliConfig } = opts;
 
-  return _.merge(
+  const items = [
     {
       level: 'info',
       overrideConsole: 'sandbox',
-      options: {
-        ...defaultOptions,
-        prefixers: {
-          ...defaultOptions.prefixers,
-        },
-      },
+      options: defaultOptions,
     },
     globalConfig.logger,
     localConfig.logger,
     adaptCLI(cliConfig),
+  ];
+
+  return items.reduce(
+    /**
+     * @param {Partial<Detox.DetoxLoggerConfig>} acc
+     * @param config
+     */
+    (acc, config) => {
+      if (!config) return acc;
+      const { options } = config;
+      return _.merge(acc, {
+        options: typeof options === 'function' ? options(acc) : options
+      });
+    },
+    items.reduce((a, b) => _.merge(a, _.omit(b, 'options')))
   );
 }
 

package/src/configuration/composeRunnerConfig.js

@@ -2,17 +2,19 @@ const os = require('os');
 
 const _ = require('lodash');
 
+const log = require('../utils/logger');
+
 /**
  * @param {object} opts
  * @param {Detox.DetoxConfig} opts.globalConfig
  * @param {Detox.DetoxConfiguration} opts.localConfig
- * @param {DetoxInternals.DetoxCLIConfig} opts.cliConfig
+ * @param {DetoxInternals.CLIConfig} opts.cliConfig
  * @param {Record<string, any>} opts.testRunnerArgv
  * @param {import('../errors/DetoxConfigErrorComposer')} opts.errorComposer
  * @returns {Detox.DetoxTestRunnerConfig} opts.testRunnerArgv
  */
 function composeRunnerConfig(opts) {
-  const globalConfig = opts.globalConfig.testRunner;
+  const globalConfig = adaptLegacyRunnerConfig(opts.globalConfig);
   if (globalConfig != null && typeof globalConfig !== 'object') {
     throw opts.errorComposer.invalidTestRunnerProperty(true);
   }
@@ -61,6 +63,51 @@ function composeRunnerConfig(opts) {
   return merged;
 }
 
+function adaptLegacyRunnerConfig(globalConfig) {
+  let isLegacy = false;
+
+  const runnerConfigKey = 'runnerConfig' in globalConfig ? 'runnerConfig' : 'runner-config';
+  if (_.isString(globalConfig[runnerConfigKey])) {
+    isLegacy = true;
+    log.warn(`Detected a deprecated "${runnerConfigKey}" property (string).`);
+  }
+
+  const testRunnerKey = 'testRunner' in globalConfig ? 'testRunner' : 'test-runner';
+  if (_.isString(globalConfig[testRunnerKey])) {
+    isLegacy = true;
+    log.warn(`Detected a deprecated "${testRunnerKey}" property (string).`);
+  }
+
+  if (globalConfig.specs != null) {
+    isLegacy = true;
+    log.warn(`Detected a deprecated "specs" property.`);
+  }
+
+  if (!isLegacy) {
+    return globalConfig.testRunner;
+  }
+
+  log.warn(`Please migrate your Detox config according to the guide: [TODO: insert the migration guilde link]`);
+  const testRunner = globalConfig[testRunnerKey];
+  const runnerConfig = globalConfig[runnerConfigKey];
+  const specs = globalConfig.specs != null ? String(globalConfig.specs) : undefined;
+
+  const args = {};
+  if (_.isString(testRunner)) {
+    args.$0 = testRunner;
+  }
+
+  if (_.isString(runnerConfig)) {
+    args.config = runnerConfig;
+  }
+
+  if (specs) {
+    args._ = [specs];
+  }
+
+  return { args };
+}
+
 function hasEmptyPositionalArgs(value, key) {
   return key === '_' ? _.isEmpty(value) : false;
 }

package/src/configuration/index.js

@@ -105,18 +105,23 @@ async function composeDetoxConfig({
   });
 
   const result = {
-    appsConfig,
-    artifactsConfig,
-    behaviorConfig,
-    cliConfig,
     configurationName,
-    deviceConfig,
-    errorComposer,
-    loggerConfig,
-    runnerConfig,
-    sessionConfig,
+
+    apps: appsConfig,
+    artifacts: artifactsConfig,
+    behavior: behaviorConfig,
+    cli: cliConfig,
+    device: deviceConfig,
+    logger: loggerConfig,
+    testRunner: runnerConfig,
+    session: sessionConfig,
   };
 
+  Object.defineProperty(result, 'errorComposer', {
+    enumerable: false,
+    value: errorComposer,
+  });
+
   return result;
 }
 

package/src/configuration/loadExternalConfig.js

@@ -6,7 +6,7 @@ const fs = require('fs-extra');
 const _ = require('lodash');
 const resolveFrom = require('resolve-from');
 
-const log = require('../utils/logger').child({ __filename });
+const log = require('../utils/logger').child({ cat: 'config' });
 
 async function locateExternalConfig(cwd) {
   return findUp([

package/src/devices/allocation/DeviceAllocator.js

@@ -1,5 +1,6 @@
 // @ts-nocheck
-const { traceMethods } = require('../../utils/trace');
+const log = require('../../utils/logger').child({ cat: 'device' });
+const traceMethods = require('../../utils/traceMethods');
 
 class DeviceAllocator {
   /**
@@ -7,7 +8,7 @@ class DeviceAllocator {
    */
   constructor(allocationDriver) {
     this._driver = allocationDriver;
-    traceMethods(this, 'device', ['allocate', 'free']);
+    traceMethods(log, this, ['allocate', 'free']);
   }
 
   /**

package/src/devices/allocation/drivers/android/emulator/AVDValidator.js

@@ -2,7 +2,7 @@ const _ = require('lodash');
 
 const DetoxRuntimeError = require('../../../../../errors/DetoxRuntimeError');
 const environment = require('../../../../../utils/environment');
-const logger = require('../../../../../utils/logger').child({ __filename });
+const logger = require('../../../../../utils/logger').child({ cat: 'device' });
 
 const REQUIRED_EMULATOR_MAJOR = 29;
 

package/src/devices/allocation/drivers/android/emulator/EmulatorAllocDriver.js

@@ -1,7 +1,8 @@
 // @ts-nocheck
 const _ = require('lodash');
 
-const { traceMethods } = require('../../../../../utils/trace');
+const log = require('../../../../../utils/logger').child({ cat: 'device' });
+const traceMethods = require('../../../../../utils/traceMethods');
 const AndroidEmulatorCookie = require('../../../../cookies/AndroidEmulatorCookie');
 const AllocationDriverBase = require('../../AllocationDriverBase');
 
@@ -23,7 +24,7 @@ class EmulatorAllocDriver extends AllocationDriverBase {
     this._emulatorLauncher = emulatorLauncher;
     this._allocationHelper = allocationHelper;
 
-    traceMethods(this, 'device', ['_launchEmulator']);
+    traceMethods(log, this, ['_launchEmulator']);
   }
 
   /**

package/src/devices/allocation/drivers/android/emulator/EmulatorAllocationHelper.js

@@ -1,4 +1,4 @@
-const logger = require('../../../../../utils/logger').child({ __filename });
+const logger = require('../../../../../utils/logger').child({ cat: 'device' });
 const DeviceAllocationHelper  = require('../../../../common/drivers/DeviceAllocationHelper');
 
 const DetoxEmulatorsPortRange = {

package/src/devices/allocation/drivers/android/emulator/EmulatorLauncher.js

@@ -1,7 +1,8 @@
 // @ts-nocheck
 const { DetoxRuntimeError } = require('../../../../../errors');
+const log = require('../../../../../utils/logger').child({ cat: 'device' });
 const retry = require('../../../../../utils/retry');
-const { traceMethods } = require('../../../../../utils/trace');
+const traceMethods = require('../../../../../utils/traceMethods');
 const DeviceLauncher = require('../../../../common/drivers/DeviceLauncher');
 const { LaunchCommand } = require('../../../../common/drivers/android/emulator/exec/EmulatorExec');
 
@@ -14,7 +15,7 @@ class EmulatorLauncher extends DeviceLauncher {
     super(eventEmitter);
     this._adb = adb;
     this._emulatorExec = emulatorExec;
-    traceMethods(this, 'device', ['_awaitEmulatorBoot']);
+    traceMethods(log, this, ['_awaitEmulatorBoot']);
   }
 
   /**

package/src/devices/allocation/drivers/android/emulator/EmulatorVersionResolver.js

@@ -1,8 +1,6 @@
-const log = require('../../../../../utils/logger').child({ __filename });
+const log = require('../../../../../utils/logger').child({ cat: 'device' });
 const { QueryVersionCommand } = require('../../../../common/drivers/android/emulator/exec/EmulatorExec');
 
-const EMU_BIN_VERSION_DETECT_EV = 'EMU_BIN_VERSION_DETECT';
-
 class EmulatorVersionResolver {
   constructor(emulatorExec) {
     this._emulatorExec = emulatorExec;
@@ -21,18 +19,18 @@ class EmulatorVersionResolver {
     try {
       rawOutput = await this._emulatorExec.exec(new QueryVersionCommand({ headless })) || '';
     } catch (error) {
-      log.error({ event: EMU_BIN_VERSION_DETECT_EV, success: false, error }, 'Could not detect emulator binary version', error);
+      log.error({ success: false, error }, 'Could not detect emulator binary version', error);
       return null;
     }
 
     const matches = rawOutput.match(/Android emulator version ([0-9]+\.[0-9]+\.[0-9]+\.[0-9]*)/);
     if (!matches) {
-      log.warn({ event: EMU_BIN_VERSION_DETECT_EV, success: false }, 'Could not detect emulator binary version, got:', rawOutput);
+      log.warn({ success: false }, 'Could not detect emulator binary version, got:', rawOutput);
       return null;
     }
 
     const version = this._parseVersionString(matches[1]);
-    log.debug({ event: EMU_BIN_VERSION_DETECT_EV, success: true }, 'Detected emulator binary version', version);
+    log.debug({ success: true }, 'Detected emulator binary version', version);
     return version;
   }
 

package/src/devices/allocation/drivers/android/emulator/launchEmulatorProcess.js

@@ -3,7 +3,7 @@ const fs = require('fs');
 const _ = require('lodash');
 const { Tail } = require('tail');
 
-const unitLogger = require('../../../../../utils/logger').child({ __filename });
+const unitLogger = require('../../../../../utils/logger').child({ cat: 'device' });
 
 function launchEmulatorProcess(emulatorName, emulatorExec, emulatorLaunchCommand) {
   let childProcessOutput;

package/src/devices/allocation/drivers/android/genycloud/GenyInstanceAllocationHelper.js

@@ -1,5 +1,5 @@
 // @ts-nocheck
-const logger = require('../../../../../utils/logger').child({ __filename });
+const logger = require('../../../../../utils/logger').child({ cat: 'device' });
 const DeviceAllocationHelper = require('../../../../common/drivers/DeviceAllocationHelper');
 
 const { ALLOCATE_DEVICE_LOG_EVT } = DeviceAllocationHelper;

package/src/devices/common/drivers/android/genycloud/services/GenyInstanceNaming.js

@@ -1,9 +1,9 @@
-const session = () => require('../../../../../../../internals').session;
+const internals = () => require('../../../../../../../internals');
 
 class GenyInstanceNaming {
   generateName() {
-    const { id, workerId } = session();
-    return `Detox.${id}.${workerId}`;
+    const { session, worker } = internals();
+    return `Detox.${session.id}.${worker.id}`;
   }
 
   isFamilial(name) {

package/src/devices/common/drivers/android/genycloud/services/GenyRecipesService.js

@@ -1,4 +1,4 @@
-const logger = require('../../../../../../utils/logger').child({ __filename });
+const logger = require('../../../../../../utils/logger').child({ cat: 'device' });
 
   const Recipe = require('./dto/GenyRecipe');
 

package/src/devices/common/drivers/android/tools/EmulatorTelnet.js

@@ -5,7 +5,7 @@ const path = require('path');
 const fs = require('fs-extra');
 const Telnet = require('telnet-client');
 
-const log = require('../../../../../utils/logger').child({ __filename });
+const log = require('../../../../../utils/logger').child({ cat: 'device' });
 
 class EmulatorTelnet {
   constructor() {

package/src/devices/common/drivers/android/tools/FreeDeviceFinder.js

@@ -1,4 +1,4 @@
-const log = require('../../../../../utils/logger').child({ __filename });
+const log = require('../../../../../utils/logger').child({ cat: 'device' });
 
 const DEVICE_LOOKUP_LOG_EVT = 'DEVICE_LOOKUP';
 

package/src/devices/common/drivers/ios/tools/AppleSimUtils.js

@@ -7,7 +7,7 @@ const DetoxRuntimeError = require('../../../../../errors/DetoxRuntimeError');
 const { joinArgs } = require('../../../../../utils/argparse');
 const childProcess = require('../../../../../utils/childProcess');
 const environment = require('../../../../../utils/environment');
-const log = require('../../../../../utils/logger').child({ __filename });
+const log = require('../../../../../utils/logger').child({ cat: 'device' });
 const { quote } = require('../../../../../utils/shellQuote');
 
 class AppleSimUtils {

package/src/devices/lifecycle/GenyGlobalLifecycleHandler.js

@@ -1,6 +1,4 @@
-const onSignalExit = require('signal-exit');
-
-const logger = require('../../utils/logger').child({ __filename });
+const logger = require('../../utils/logger').child({ cat: 'device' });
 
 const cleanupLogData = {
   event: 'GENYCLOUD_TEARDOWN',
@@ -12,16 +10,14 @@ class GenyGlobalLifecycleHandler {
     this._instanceLifecycleService = instanceLifecycleService;
   }
 
-  async globalInit() {
-    onSignalExit((code, signal) => {
-      if (signal) {
-        const { rawDevices } = this._deviceCleanupRegistry.readRegisteredDevicesUNSAFE();
-        const instanceHandles = rawDevicesToInstanceHandles(rawDevices);
-        if (instanceHandles.length) {
-          reportGlobalCleanupSummary(instanceHandles);
-        }
-      }
-    });
+  async globalInit() {}
+
+  emergencyCleanup() {
+    const { rawDevices } = this._deviceCleanupRegistry.readRegisteredDevicesUNSAFE();
+    const instanceHandles = rawDevicesToInstanceHandles(rawDevices);
+    if (instanceHandles.length) {
+      reportGlobalCleanupSummary(instanceHandles);
+    }
   }
 
   async globalCleanup() {

package/src/devices/runtime/RuntimeDevice.js

@@ -1,6 +1,8 @@
 const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
 const debug = require('../../utils/debug'); // debug utils, leave here even if unused
-const { traceCall, traceMethods } = require('../../utils/trace');
+const log = require('../../utils/logger').child({ cat: 'device' });
+const { traceCall } = require('../../utils/trace');
+const traceMethods = require('../../utils/traceMethods');
 const wrapWithStackTraceCutter = require('../../utils/wrapWithStackTraceCutter');
 
 const LaunchArgsEditor = require('./utils/LaunchArgsEditor');
@@ -48,7 +50,7 @@ class RuntimeDevice {
       'unreverseTcpPort',
     ];
 
-    traceMethods(this, 'device', methodNames);
+    traceMethods(log, this, methodNames);
     wrapWithStackTraceCutter(this, methodNames);
 
     this._appsConfig = appsConfig;
@@ -234,16 +236,13 @@ class RuntimeDevice {
   }
 
   async installApp(binaryPath, testBinaryPath) {
-    await traceCall('appInstall', () => {
-      const currentApp = binaryPath ? { binaryPath, testBinaryPath } : this._getCurrentApp();
-      return this.deviceDriver.installApp(currentApp.binaryPath, currentApp.testBinaryPath);
-    });
+    const currentApp = binaryPath ? { binaryPath, testBinaryPath } : this._getCurrentApp();
+    await this.deviceDriver.installApp(currentApp.binaryPath, currentApp.testBinaryPath);
   }
 
   async uninstallApp(bundleId) {
     const _bundleId = bundleId || this._bundleId;
-    await traceCall('appUninstall', () =>
-      this.deviceDriver.uninstallApp(_bundleId));
+    await this.deviceDriver.uninstallApp(_bundleId);
   }
 
   async installUtilBinaries() {

package/src/devices/runtime/drivers/DeviceDriverBase.js

@@ -4,7 +4,7 @@ const path = require('path');
 
 const fs = require('fs-extra');
 
-const log = require('../../../utils/logger').child({ __filename });
+const log = require('../../../utils/logger').child({ cat: 'device' });
 
 /**
  * @typedef DeviceDriverDeps

package/src/devices/runtime/drivers/android/AndroidDriver.js

@@ -18,7 +18,7 @@ const sleep = require('../../../../utils/sleep');
 const apkUtils = require('../../../common/drivers/android/tools/apk');
 const DeviceDriverBase = require('../DeviceDriverBase');
 
-const log = logger.child({ __filename });
+const log = logger.child({ cat: 'device' });
 
 /**
  * @typedef AndroidDriverProps

package/src/devices/runtime/drivers/ios/SimulatorDriver.js

@@ -7,7 +7,7 @@ const _ = require('lodash');
 const temporaryPath = require('../../../../artifacts/utils/temporaryPath');
 const DetoxRuntimeError = require('../../../../errors/DetoxRuntimeError');
 const getAbsoluteBinaryPath = require('../../../../utils/getAbsoluteBinaryPath');
-const log = require('../../../../utils/logger').child({ __filename });
+const log = require('../../../../utils/logger').child({ cat: 'device' });
 const pressAnyKey = require('../../../../utils/pressAnyKey');
 
 const IosDriver = require('./IosDriver');

package/src/errors/DetoxConfigErrorComposer.js

@@ -656,12 +656,14 @@ Examine your Detox config${this._atPath()}`,
   }
 
   invalidTestRunnerProperty(isGlobal) {
+    const testRunner = _.get(this.contents, ['testRunner']);
+
     return new DetoxConfigError({
-      message: `testRunner should be an object, not a string`,
+      message: `testRunner should be an object, not a ${typeof testRunner}`,
       hint: `Check that in your Detox config${this._atPath()}`,
       inspectOptions: { depth: isGlobal ? 0 : 3 },
       debugInfo: isGlobal ? {
-        testRunner: _.get(this.contents, ['testRunner']),
+        testRunner,
         ...this.contents,
       } : {
         ...this._focusOnConfiguration(c => _.pick(c, ['testRunner'])),

package/src/ipc/IPCClient.js

@@ -6,8 +6,8 @@ class IPCClient {
   constructor({ id, logger, state }) {
     this._id = id;
     /** @type {import('../logger/DetoxLogger')} logger */
-    this._logger = logger.child({ __filename, cat: 'ipc' });
-    /** @type {import('./state').SecondarySessionState} */
+    this._logger = logger.child({ cat: 'ipc' });
+    /** @type {import('./SessionState')} */
     this._state = state;
 
     this._client = null;
@@ -47,7 +47,6 @@ class IPCClient {
   }
 
   async registerWorker(workerId) {
-    this._state.workerId = workerId;
     await this._emit('registerWorker', { workerId });
   }
 
@@ -75,11 +74,7 @@ class IPCClient {
   }
 
   async _registerContext() {
-    const sessionState = await this._emit('registerContext', {
-      id: this._id,
-      logFile: this._logger.file,
-    });
-
+    const sessionState = await this._emit('registerContext', { id: this._id });
     this._state.patch(sessionState);
   }
 

package/src/ipc/IPCServer.js

@@ -3,13 +3,14 @@ const { IPC } = require('node-ipc');
 class IPCServer {
   /**
    * @param {object} options
-   * @param {import('./state').PrimarySessionState} options.sessionState
+   * @param {import('./SessionState')} options.sessionState
    * @param {Detox.Logger} options.logger
    */
   constructor({ sessionState, logger }) {
     this._sessionState = sessionState;
-    this._logger = logger.child({ __filename, cat: 'ipc' });
+    this._logger = logger.child({ cat: 'ipc,ipc-server' });
     this._ipc = null;
+    this._workers = new Set();
   }
 
   get id() {
@@ -48,13 +49,9 @@ class IPCServer {
     });
   }
 
-  onRegisterContext({ id, logFile }, socket) {
+  onRegisterContext({ id }, socket) {
     this._sessionState.contexts.push(id);
 
-    if (logFile && !this._sessionState.logFiles.includes(logFile)) {
-      this._sessionState.logFiles.push(logFile);
-    }
-
     this._ipc.server.emit(socket, 'registerContextDone', {
       failedTestFiles: this._sessionState.failedTestFiles,
       testFilesToRetry: this._sessionState.testFilesToRetry,
@@ -62,13 +59,16 @@ class IPCServer {
     });
   }
 
-  onRegisterWorker({ workerId }, socket) {
+  onRegisterWorker({ workerId }, socket = null) {
+    const workersCount = this._workers.add(workerId).size;
+    const shouldBroadcast = workersCount > this._sessionState.workersCount;
+    this._sessionState.workersCount = workersCount;
+
     if (socket) {
-      this._ipc.server.emit(socket, 'registerWorkerDone', {});
+      this._ipc.server.emit(socket, 'registerWorkerDone', { workersCount });
     }
 
-    if (workerId > this._sessionState.workersCount) {
-      const workersCount = this._sessionState.workersCount = workerId;
+    if (shouldBroadcast) {
       this._ipc.server.broadcast('sessionStateUpdate', { workersCount });
     }
   }

package/src/ipc/{state.js → SessionState.js}

@@ -3,6 +3,28 @@ const cycle = require('json-cycle');
 const uuid = require('../utils/uuid');
 
 class SessionState {
+  constructor({
+    id = uuid.UUID(),
+    contexts = [],
+    detoxConfigSnapshotPath = '',
+    detoxConfig = null,
+    detoxIPCServer = '',
+    failedTestFiles = [],
+    testFilesToRetry = [],
+    testSessionIndex = 0,
+    workersCount = 0
+  }) {
+    this.id = id;
+    this.contexts = contexts;
+    this.detoxConfigSnapshotPath = detoxConfigSnapshotPath;
+    this.detoxConfig = detoxConfig;
+    this.detoxIPCServer = detoxIPCServer;
+    this.failedTestFiles = failedTestFiles;
+    this.testFilesToRetry = testFilesToRetry;
+    this.testSessionIndex = testSessionIndex;
+    this.workersCount = workersCount;
+  }
+
   patch(state) {
     Object.assign(this, state);
   }
@@ -37,53 +59,4 @@ class SessionState {
   }
 }
 
-class SecondarySessionState extends SessionState {
-  constructor({
-    id = uuid.UUID(),
-    detoxConfigSnapshotPath = '',
-    detoxConfig = null,
-    detoxIPCServer = '',
-    failedTestFiles = [],
-    testFilesToRetry = [],
-    testSessionIndex = 0,
-    workerId = undefined,
-    workersCount = 0
-  }) {
-    super();
-
-    this.id = id;
-    this.detoxConfigSnapshotPath = detoxConfigSnapshotPath;
-    this.detoxConfig = detoxConfig;
-    this.detoxIPCServer = detoxIPCServer;
-    this.failedTestFiles = failedTestFiles;
-    this.testFilesToRetry = testFilesToRetry;
-    this.testSessionIndex = testSessionIndex;
-    this.workerId = workerId;
-    this.workersCount = workersCount;
-  }
-}
-
-class PrimarySessionState extends SecondarySessionState {
-  constructor({
-    contexts = [],
-    logFiles = [],
-    failedTestFiles = [],
-    testFilesToRetry = [],
-    testSessionIndex = 0,
-    ...baseOpts
-  }) {
-    super(baseOpts);
-
-    this.contexts = contexts;
-    this.failedTestFiles = failedTestFiles;
-    this.logFiles = logFiles;
-    this.testSessionIndex = testSessionIndex;
-    this.testFilesToRetry = testFilesToRetry;
-  }
-}
-
-module.exports = {
-  SessionState,
-  PrimarySessionState,
-  SecondarySessionState,
-};
+module.exports = SessionState;