detox 19.9.0 → 21.0.0-breaking.new-global-lifecycle.0

package/src/configuration/composeLoggerConfig.js

@@ -0,0 +1,50 @@
+const _ = require('lodash');
+
+const { castLevel, defaultOptions } = require('../logger/DetoxLogger');
+
+/**
+ * @param {object} opts
+ * @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(
+    {
+      level: 'info',
+      overrideConsole: 'sandbox',
+      options: {
+        ...defaultOptions,
+        prefixers: {
+          ...defaultOptions.prefixers,
+        },
+      },
+    },
+    globalConfig.logger,
+    localConfig.logger,
+    adaptCLI(cliConfig),
+  );
+}
+
+function adaptCLI(cliConfig) {
+  const result = {};
+
+  if (cliConfig.loglevel !== undefined) {
+    result.level = castLevel(cliConfig.loglevel);
+  }
+
+  if (cliConfig.useCustomLogger !== undefined) {
+    result.overrideConsole = cliConfig.useCustomLogger ? 'all' : 'none';
+  }
+
+  if (cliConfig.noColor) {
+    result.options = { colors: false };
+  }
+
+  return result;
+}
+
+module.exports = composeLoggerConfig;

package/src/configuration/composeRunnerConfig.js

@@ -1,19 +1,79 @@
-// @ts-nocheck
+const os = require('os');
+
+const _ = require('lodash');
+
+/**
+ * @param {object} opts
+ * @param {Detox.DetoxConfig} opts.globalConfig
+ * @param {Detox.DetoxConfiguration} opts.localConfig
+ * @param {DetoxInternals.DetoxCLIConfig} 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;
+  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,
+      jest: {
+        initTimeout: 300000,
+        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.inspectBrk(merged);
+      merged.inspectBrk = true;
+    } else {
+      merged.inspectBrk = false;
+    }
+  }
+
+  return merged;
+}
+
+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) {
+  config.args.$0 = /* istanbul ignore if */ os.platform() === 'win32'
+    ? `node --inspect-brk ./node_modules/jest/bin/jest.js`
+    : `node --inspect-brk ./node_modules/.bin/jest`;
+  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,
   });
 
@@ -103,22 +112,14 @@ async function composeDetoxConfig({
     configurationName,
     deviceConfig,
     errorComposer,
+    loggerConfig,
     runnerConfig,
     sessionConfig,
   };
 
-  for (const fn of hooks.UNSAFE_configReady) {
-    await fn({ ...result, argv });
-  }
-
   return result;
 }
 
-function hook(event, listener) {
-  hooks[event].push(listener);
-}
-
 module.exports = {
   composeDetoxConfig,
-  hook,
 };

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,5 @@
 // @ts-nocheck
-const { traceCall } = require('../../utils/trace');
+const { traceMethods } = require('../../utils/trace');
 
 class DeviceAllocator {
   /**
@@ -7,6 +7,7 @@ class DeviceAllocator {
    */
   constructor(allocationDriver) {
     this._driver = allocationDriver;
+    traceMethods(this, 'device', ['allocate', 'free']);
   }
 
   /**
@@ -14,8 +15,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/EmulatorAllocDriver.js

@@ -1,7 +1,7 @@
 // @ts-nocheck
 const _ = require('lodash');
 
-const { traceCall } = require('../../../../../utils/trace');
+const { traceMethods } = require('../../../../../utils/trace');
 const AndroidEmulatorCookie = require('../../../../cookies/AndroidEmulatorCookie');
 const AllocationDriverBase = require('../../AllocationDriverBase');
 
@@ -22,6 +22,8 @@ class EmulatorAllocDriver extends AllocationDriverBase {
     this._emulatorVersionResolver = emulatorVersionResolver;
     this._emulatorLauncher = emulatorLauncher;
     this._allocationHelper = allocationHelper;
+
+    traceMethods(this, 'device', ['_launchEmulator']);
   }
 
   /**
@@ -73,8 +75,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/EmulatorLauncher.js

@@ -1,7 +1,7 @@
 // @ts-nocheck
 const { DetoxRuntimeError } = require('../../../../../errors');
 const retry = require('../../../../../utils/retry');
-const { traceCall } = require('../../../../../utils/trace');
+const { traceMethods } = require('../../../../../utils/trace');
 const DeviceLauncher = require('../../../../common/drivers/DeviceLauncher');
 const { LaunchCommand } = require('../../../../common/drivers/android/emulator/exec/EmulatorExec');
 
@@ -14,6 +14,7 @@ class EmulatorLauncher extends DeviceLauncher {
     super(eventEmitter);
     this._adb = adb;
     this._emulatorExec = emulatorExec;
+    traceMethods(this, 'device', ['_awaitEmulatorBoot']);
   }
 
   /**
@@ -63,11 +64,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/genycloud/GenyAllocDriver.js

@@ -40,7 +40,6 @@ class GenyAllocDriver extends AllocationDriverBase {
     const { adbName } = instance;
 
     await this._adb.disableAndroidAnimations(adbName);
-    await this._adb.setWiFiToggle(adbName, true);
     await this._adb.apiLevel(adbName);
     return new GenycloudEmulatorCookie(instance);
   }

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/exec/ADB.js

@@ -206,11 +206,6 @@ class ADB {
     await this.shell(deviceId, `settings put global transition_animation_scale 0`);
   }
 
-  async setWiFiToggle(deviceId, state) {
-    const value = (state === true ? 'enable' : 'disable');
-    await this.shell(deviceId, `svc wifi ${value}`);
-  }
-
   async screencap(deviceId, path) {
     await this.shell(deviceId, `screencap ${path}`);
   }

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

@@ -1,18 +1,13 @@
-const getWorkerId = require('../../../../../../utils/getWorkerId');
+const session = () => require('../../../../../../../internals').session;
 
 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 { id, workerId } = session();
+    return `Detox.${id}.${workerId}`;
   }
 
   isFamilial(name) {
-    return name.startsWith(`Detox-${this.uniqueSessionId}.${this._workerId}`);
+    return name === this.generateName();
   }
 }
 

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

@@ -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/next/api/configuration/#device-configurations).`
+    );
+  }
+
   /***
    * @param deviceInfo - an item in output of `applesimutils --list`
    * @returns {Promise<string>} UDID of a new device

package/src/devices/lifecycle/GenyGlobalLifecycleHandler.js

@@ -15,7 +15,7 @@ class GenyGlobalLifecycleHandler {
   async globalInit() {
     onSignalExit((code, signal) => {
       if (signal) {
-        const { rawDevices  } = this._deviceCleanupRegistry.readRegisteredDevicesUNSAFE();
+        const { rawDevices } = this._deviceCleanupRegistry.readRegisteredDevicesUNSAFE();
         const instanceHandles = rawDevicesToInstanceHandles(rawDevices);
         if (instanceHandles.length) {
           reportGlobalCleanupSummary(instanceHandles);