detox 19.13.0 → 20.0.0

package/src/configuration/composeRunnerConfig.js

@@ -1,19 +1,132 @@
-// @ts-nocheck
+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.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 = adaptLegacyRunnerConfig(opts.globalConfig);
+  if (globalConfig != null && typeof globalConfig !== 'object') {
+    throw opts.errorComposer.invalidTestRunnerProperty(true);
+  }
+
+  const localConfig = opts.localConfig.testRunner;
+  if (localConfig != null && typeof localConfig !== 'object') {
+    throw opts.errorComposer.invalidTestRunnerProperty(false);
+  }
+
+  const cliConfig = opts.cliConfig;
+
+  /** @type {Detox.DetoxTestRunnerConfig} */
+  const merged = _.merge(
+    {
+      retries: 0,
+      inspectBrk: inspectBrkHookDefault,
+      forwardEnv: false,
+      bail: false,
+      jest: {
+        setupTimeout: 300000,
+        teardownTimeout: 30000,
+        retryAfterCircusRetries: false,
+        reportSpecs: undefined,
+        reportWorkerAssign: true,
+      },
+      args: {
+        $0: 'jest',
+        _: [],
+      },
+    },
+    globalConfig,
+    localConfig,
+    cliConfig.retries != null ? { retries: cliConfig.retries } : null,
+    cliConfig.jestReportSpecs != null ? { jest: { reportSpecs: cliConfig.jestReportSpecs } } : null,
+    {
+      args: _.omitBy(opts.testRunnerArgv, hasEmptyPositionalArgs)
+    }
+  );
+
+  if (typeof merged.inspectBrk === 'function') {
+    if (cliConfig.inspectBrk) {
+      merged.retries = 0;
+      merged.forwardEnv = true;
+      merged.inspectBrk(merged);
+    }
+
+    delete merged.inspectBrk;
+  }
+
+  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:\nhttps://wix.github.io/Detox/docs/guide/migration\n`);
+  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;
+}
+
 /**
- * @param {Detox.DetoxConfig} globalConfig
- * @param {Detox.DetoxConfigurationOverrides} localConfig
+ * @param {Detox.DetoxTestRunnerConfig} config
  */
-function composeRunnerConfig({ globalConfig, cliConfig }) {
-  const testRunner = globalConfig.testRunner || globalConfig['test-runner'] || 'mocha';
-  const defaultRunnerConfig = testRunner.includes('mocha') ? 'e2e/mocha.opts' : 'e2e/config.json';
-  const customRunnerConfig = cliConfig.runnerConfig || globalConfig.runnerConfig || globalConfig['runner-config'];
-
-  return {
-    testRunner,
-    runnerConfig: customRunnerConfig || defaultRunnerConfig,
-    specs: globalConfig.specs || 'e2e',
-    skipLegacyWorkersInjection: Boolean(globalConfig.skipLegacyWorkersInjection),
-  };
+function inspectBrkHookDefault(config) {
+  /* istanbul ignore next */
+  config.args.$0 = os.platform() !== 'win32'
+    ? `node --inspect-brk ./node_modules/.bin/jest`
+    : `node --inspect-brk ./node_modules/jest/bin/jest.js`;
+  config.args.runInBand = true;
+  delete config.args.w;
+  delete config.args.workers;
 }
 
 module.exports = composeRunnerConfig;

package/src/configuration/composeSessionConfig.js

@@ -1,11 +1,10 @@
 const isValidWebsocketURL = require('../utils/isValidWebsocketURL');
-const uuid = require('../utils/uuid');
 
 /**
  * @param {{
  *  cliConfig: Record<string, any>;
  *  globalConfig: Detox.DetoxConfig;
- *  localConfig: Detox.DetoxConfigurationOverrides;
+ *  localConfig: Detox.DetoxConfiguration;
  *  errorComposer: import('../errors/DetoxConfigErrorComposer');
  * }} options
  */
@@ -44,7 +43,6 @@ async function composeSessionConfig(options) {
 
   const result = {
     autoStart: !session.server,
-    sessionId: uuid.UUID(),
     debugSynchronization: 10000,
 
     ...session,

package/src/configuration/index.js

@@ -8,22 +8,19 @@ const composeAppsConfig = require('./composeAppsConfig');
 const composeArtifactsConfig = require('./composeArtifactsConfig');
 const composeBehaviorConfig = require('./composeBehaviorConfig');
 const composeDeviceConfig = require('./composeDeviceConfig');
+const composeLoggerConfig = require('./composeLoggerConfig');
 const composeRunnerConfig = require('./composeRunnerConfig');
 const composeSessionConfig = require('./composeSessionConfig');
 const loadExternalConfig = require('./loadExternalConfig');
 const selectConfiguration = require('./selectConfiguration');
 
-const hooks = {
-  UNSAFE_configReady: [],
-};
-
 async function composeDetoxConfig({
   cwd = process.cwd(),
-  argv,
-  override,
-  userParams,
+  argv = undefined,
+  testRunnerArgv = undefined,
+  errorComposer = new DetoxConfigErrorComposer(),
+  override = undefined,
 }) {
-  const errorComposer = new DetoxConfigErrorComposer();
   const cliConfig = collectCliConfig({ argv });
   const findupResult = await loadExternalConfig({
     errorComposer,
@@ -45,11 +42,6 @@ async function composeDetoxConfig({
 
   const { configurations } = globalConfig;
 
-  const runnerConfig = composeRunnerConfig({
-    globalConfig,
-    cliConfig,
-  });
-
   const configurationName = selectConfiguration({
     errorComposer,
     globalConfig,
@@ -58,6 +50,18 @@ async function composeDetoxConfig({
 
   const localConfig = configurations[configurationName];
 
+  if (localConfig['type']) {
+    throw errorComposer.configurationShouldNotUseLegacyFormat();
+  }
+
+  const runnerConfig = composeRunnerConfig({
+    globalConfig,
+    localConfig,
+    cliConfig,
+    testRunnerArgv,
+    errorComposer,
+  });
+
   const deviceConfig = composeDeviceConfig({
     errorComposer,
     globalConfig,
@@ -84,7 +88,12 @@ async function composeDetoxConfig({
   const behaviorConfig = composeBehaviorConfig({
     globalConfig,
     localConfig,
-    userParams,
+    cliConfig,
+  });
+
+  const loggerConfig = composeLoggerConfig({
+    globalConfig,
+    localConfig,
     cliConfig,
   });
 
@@ -96,29 +105,26 @@ async function composeDetoxConfig({
   });
 
   const result = {
-    appsConfig,
-    artifactsConfig,
-    behaviorConfig,
-    cliConfig,
     configurationName,
-    deviceConfig,
-    errorComposer,
-    runnerConfig,
-    sessionConfig,
+
+    apps: appsConfig,
+    artifacts: artifactsConfig,
+    behavior: behaviorConfig,
+    cli: cliConfig,
+    device: deviceConfig,
+    logger: loggerConfig,
+    testRunner: runnerConfig,
+    session: sessionConfig,
   };
 
-  for (const fn of hooks.UNSAFE_configReady) {
-    await fn({ ...result, argv });
-  }
+  Object.defineProperty(result, 'errorComposer', {
+    enumerable: false,
+    value: errorComposer,
+  });
 
   return result;
 }
 
-function hook(event, listener) {
-  hooks[event].push(listener);
-}
-
 module.exports = {
   composeDetoxConfig,
-  hook,
 };

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/configuration/utils/deviceAppTypes.js

@@ -1,6 +1,5 @@
 module.exports = {
   'ios.simulator': ['ios.app'],
-  'ios.none': ['ios.app'],
   'android.attached': ['android.apk'],
   'android.emulator': ['android.apk'],
   'android.genycloud': ['android.apk'],

package/src/devices/allocation/DeviceAllocator.js

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

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 { traceCall } = 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');
 
@@ -22,6 +23,8 @@ class EmulatorAllocDriver extends AllocationDriverBase {
     this._emulatorVersionResolver = emulatorVersionResolver;
     this._emulatorLauncher = emulatorLauncher;
     this._allocationHelper = allocationHelper;
+
+    traceMethods(log, this, ['_launchEmulator']);
   }
 
   /**
@@ -73,8 +76,7 @@ class EmulatorAllocDriver extends AllocationDriverBase {
 
   async _launchEmulator(avdName, adbName, isRunning, options) {
     try {
-      await traceCall('emulatorLaunch',
-        this._emulatorLauncher.launch(avdName, adbName, isRunning, options));
+      await this._emulatorLauncher.launch(avdName, adbName, isRunning, options);
     } catch (e) {
       await this._allocationHelper.deallocateDevice(adbName);
       throw e;

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 { traceCall } = require('../../../../../utils/trace');
+const traceMethods = require('../../../../../utils/traceMethods');
 const DeviceLauncher = require('../../../../common/drivers/DeviceLauncher');
 const { LaunchCommand } = require('../../../../common/drivers/android/emulator/exec/EmulatorExec');
 
@@ -14,6 +15,7 @@ class EmulatorLauncher extends DeviceLauncher {
     super(eventEmitter);
     this._adb = adb;
     this._emulatorExec = emulatorExec;
+    traceMethods(log, this, ['_awaitEmulatorBoot']);
   }
 
   /**
@@ -63,10 +65,6 @@ class EmulatorLauncher extends DeviceLauncher {
   }
 
   async _awaitEmulatorBoot(adbName) {
-    await traceCall('awaitBoot', this._waitForBootToComplete(adbName));
-  }
-
-  async _waitForBootToComplete(adbName) {
     await retry({ retries: 240, interval: 2500, shouldUnref: true }, async () => {
       const isBootComplete = await this._adb.isBootComplete(adbName);
 

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/allocation/drivers/ios/SimulatorAllocDriver.js

@@ -36,7 +36,7 @@ class SimulatorAllocDriver extends AllocationDriverBase {
     }
 
     try {
-      await this._simulatorLauncher.launch(udid, deviceConfig.type, deviceConfig.bootArgs);
+      await this._simulatorLauncher.launch(udid, deviceConfig.type, deviceConfig.bootArgs, deviceConfig.headless);
     } catch (e) {
       await this._deviceRegistry.disposeDevice(udid);
       throw e;

package/src/devices/allocation/drivers/ios/SimulatorLauncher.js

@@ -6,9 +6,9 @@ class SimulatorLauncher extends DeviceLauncher {
     this._applesimutils = applesimutils;
   }
 
-  async launch(udid, type, bootArgs) {
-    const coldBoot = await this._applesimutils.boot(udid, bootArgs);
-    await this._notifyBootEvent(udid, type, coldBoot);
+  async launch(udid, type, bootArgs, headless) {
+    const coldBoot = await this._applesimutils.boot(udid, bootArgs, headless);
+    await this._notifyBootEvent(udid, type, coldBoot, headless);
   }
 
   async shutdown(udid) {

package/src/devices/allocation/factories/index.js

@@ -1,6 +1,5 @@
 module.exports = {
   ...require('./android'),
   ...require('./ios'),
-  ...require('./none'),
   ...require('./external'),
 };

package/src/devices/common/drivers/DeviceLauncher.js

@@ -11,8 +11,8 @@ class DeviceLauncher {
     return this._eventEmitter.emit('shutdownDevice', { deviceId });
   }
 
-  async _notifyBootEvent(deviceId, type, coldBoot) {
-    return this._eventEmitter.emit('bootDevice', { deviceId, type, coldBoot });
+  async _notifyBootEvent(deviceId, type, coldBoot, headless) {
+    return this._eventEmitter.emit('bootDevice', { deviceId, type, coldBoot, headless });
   }
 }
 

package/src/devices/common/drivers/android/emulator/exec/EmulatorExec.js

@@ -48,7 +48,7 @@ class LaunchCommand extends ExecCommand {
       bootArgs,
       gpuMode = this._getDefaultGPUMode(),
       headless,
-      readonly,
+      readonly = true,
       port,
     } = this._options;
 

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

@@ -1,18 +1,13 @@
-const getWorkerId = require('../../../../../../utils/getWorkerId');
+const internals = () => require('../../../../../../../internals');
 
 class GenyInstanceNaming {
-  constructor(nowProvider = () => Date.now()) {
-    this.uniqueSessionId = Number(process.env.DETOX_START_TIMESTAMP);
-    this.nowProvider = nowProvider;
-    this._workerId = getWorkerId() || (this.nowProvider() - this.uniqueSessionId);
-  }
-
   generateName() {
-    return `Detox-${this.uniqueSessionId}.${this._workerId}`;
+    const { session, worker } = internals();
+    return `Detox.${session.id}.${worker.id}`;
   }
 
   isFamilial(name) {
-    return name.startsWith(`Detox-${this.uniqueSessionId}.${this._workerId}`);
+    return name === this.generateName();
   }
 }
 

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 {
@@ -42,20 +42,27 @@ class AppleSimUtils {
   /***
    * Boots the simulator if it is not booted already.
    *
-   * @param {String} udid - device id
-   * @returns {Promise<boolean>} true, if device has been booted up from the shutdown state
+   * @param {String} udid iOS Simulator UDID.
+   * @param {String} deviceBootArgs simctl boot command arguments.
+   * @param {Boolean} headless If false, opens the Simulator app after the Simulator has booted.
+   * @returns {Promise<boolean>} true, if device has been booted up from the shutdown state.
    */
-  async boot(udid, deviceBootArgs = '') {
+  async boot(udid, deviceBootArgs = '', headless = false) {
     const isBooted = await this.isBooted(udid);
 
-    if (!isBooted) {
-      const statusLogs = { trying: `Booting device ${udid}...` };
-      await this._execSimctl({ cmd: `boot ${udid} ${deviceBootArgs}`, statusLogs, retries: 10 });
-      await this._execSimctl({ cmd: `bootstatus ${udid}`, retries: 1 });
-      return true;
+    if (isBooted) {
+      return false;
     }
 
-    return false;
+    const statusLogs = { trying: `Booting device ${udid}...` };
+    await this._execSimctl({ cmd: `boot ${udid} ${deviceBootArgs}`, statusLogs, retries: 10 });
+    await this._execSimctl({ cmd: `bootstatus ${udid}`, retries: 1 });
+
+    if (!headless) {
+      await this._openSimulatorApp(udid);
+    }
+
+    return true;
   }
 
   async isBooted(udid) {
@@ -72,6 +79,24 @@ class AppleSimUtils {
     return device;
   }
 
+  async _openSimulatorApp(udid) {
+    try {
+      await childProcess.execWithRetriesAndLogs(`open -a Simulator --args -CurrentDeviceUDID ${udid}`, { retries: 0 });
+    } catch (error) {
+      this._logUnableToOpenSimulator();
+    }
+  }
+
+  _logUnableToOpenSimulator() {
+    log.warn(
+      `Unable to open the Simulator app. Please make sure you have Xcode and iOS Simulator installed ` +
+      `(https://developer.apple.com/xcode/). In case you already have the latest Xcode version installed, ` +
+      `try run the command: \`sudo xcode-select -s /Applications/Xcode.app\`. If you are running tests from CI, ` +
+      `we recommend running them with "--headless" device configuration (see: ` +
+      `https://wix.github.io/Detox/docs/cli/test/#options).`
+    );
+  }
+
   /***
    * @param deviceInfo - an item in output of `applesimutils --list`
    * @returns {Promise<string>} UDID of a new device