detox 19.13.0 → 20.0.0

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,16 @@ 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);
-        }
-      }
-    });
+  // TODO: remove this ignore as soon as DetoxPrimaryContext is covered with tests
+  /* istanbul ignore next */
+  async globalInit() {}
+
+  emergencyCleanup() {
+    const { rawDevices } = this._deviceCleanupRegistry.readRegisteredDevicesUNSAFE();
+    const instanceHandles = rawDevicesToInstanceHandles(rawDevices);
+    if (instanceHandles.length) {
+      reportGlobalCleanupSummary(instanceHandles);
+    }
   }
 
   async globalCleanup() {
@@ -34,7 +32,7 @@ class GenyGlobalLifecycleHandler {
 }
 
 async function doSafeCleanup(instanceLifecycleService, instanceHandles) {
-  logger.info(cleanupLogData, 'Initiating Genymotion cloud instances teardown...');
+  logger.info(cleanupLogData, 'Initiating Genymotion SaaS instances teardown...');
 
   const deletionLeaks = [];
   const killPromises = instanceHandles.map((instanceHandle) =>
@@ -47,7 +45,7 @@ async function doSafeCleanup(instanceLifecycleService, instanceHandles) {
 
 function reportGlobalCleanupSummary(deletionLeaks) {
   if (deletionLeaks.length) {
-    logger.warn(cleanupLogData, 'WARNING! Detected a Genymotion cloud instance leakage, for the following instances:');
+    logger.warn(cleanupLogData, 'WARNING! Detected a Genymotion SaaS instance leakage, for the following instances:');
 
     deletionLeaks.forEach(({ uuid, name, error }) => {
       logger.warn(cleanupLogData, [

package/src/devices/runtime/RuntimeDevice.js

@@ -1,6 +1,7 @@
 const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
 const debug = require('../../utils/debug'); // debug utils, leave here even if unused
-const { traceCall } = require('../../utils/trace');
+const log = require('../../utils/logger').child({ cat: 'device' });
+const traceMethods = require('../../utils/traceMethods');
 const wrapWithStackTraceCutter = require('../../utils/wrapWithStackTraceCutter');
 
 const LaunchArgsEditor = require('./utils/LaunchArgsEditor');
@@ -14,12 +15,13 @@ class RuntimeDevice {
     sessionConfig,
     runtimeErrorComposer,
   }, deviceDriver) {
-    wrapWithStackTraceCutter(this, [
+    const methodNames = [
       'captureViewHierarchy',
       'clearKeychain',
       'disableSynchronization',
       'enableSynchronization',
       'installApp',
+      'installUtilBinaries',
       'launchApp',
       'matchFace',
       'matchFinger',
@@ -46,7 +48,10 @@ class RuntimeDevice {
       'unmatchFace',
       'unmatchFinger',
       'unreverseTcpPort',
-    ]);
+    ];
+
+    traceMethods(log, this, methodNames);
+    wrapWithStackTraceCutter(this, methodNames);
 
     this._appsConfig = appsConfig;
     this._behaviorConfig = behaviorConfig;
@@ -80,13 +85,6 @@ class RuntimeDevice {
     return this._currentAppLaunchArgs;
   }
 
-  async _prepare() {
-    const appAliases = Object.keys(this._appsConfig);
-    if (appAliases.length === 1) {
-      await this.selectApp(appAliases[0]);
-    }
-  }
-
   async selectApp(name) {
     if (name === undefined) {
       throw this._errorComposer.cantSelectEmptyApp();
@@ -113,12 +111,71 @@ class RuntimeDevice {
   }
 
   async launchApp(params = {}, bundleId = this._bundleId) {
-    return traceCall('launch app', this._doLaunchApp(params, bundleId));
+    const payloadParams = ['url', 'userNotification', 'userActivity'];
+    const hasPayload = this._assertHasSingleParam(payloadParams, params);
+    const newInstance = params.newInstance !== undefined
+      ? params.newInstance
+      : this._processes[bundleId] == null;
+
+    if (params.delete) {
+      await this.terminateApp(bundleId);
+      await this.uninstallApp();
+      await this.installApp();
+    } else if (newInstance) {
+      await this.terminateApp(bundleId);
+    }
+
+    const baseLaunchArgs = {
+      ...this._currentAppLaunchArgs.get(),
+      ...params.launchArgs,
+    };
+
+    if (params.url) {
+      baseLaunchArgs['detoxURLOverride'] = params.url;
+      if (params.sourceApp) {
+        baseLaunchArgs['detoxSourceAppOverride'] = params.sourceApp;
+      }
+    } else if (params.userNotification) {
+      this._createPayloadFileAndUpdatesParamsObject('userNotification', 'detoxUserNotificationDataURL', params, baseLaunchArgs);
+    } else if (params.userActivity) {
+      this._createPayloadFileAndUpdatesParamsObject('userActivity', 'detoxUserActivityDataURL', params, baseLaunchArgs);
+    }
+
+    if (params.permissions) {
+      await this.deviceDriver.setPermissions(bundleId, params.permissions);
+    }
+
+    if (params.disableTouchIndicators) {
+      baseLaunchArgs['detoxDisableTouchIndicators'] = true;
+    }
+
+    if (this._isAppRunning(bundleId) && hasPayload) {
+      await this.deviceDriver.deliverPayload({ ...(params), delayPayload: true });
+    }
+
+    if (this._behaviorConfig.launchApp === 'manual') {
+      this._processes[bundleId] = await this.deviceDriver.waitForAppLaunch(bundleId, this._prepareLaunchArgs(baseLaunchArgs), params.languageAndLocale);
+    } else {
+      this._processes[bundleId] = await this.deviceDriver.launchApp(bundleId, this._prepareLaunchArgs(baseLaunchArgs), params.languageAndLocale);
+      await this.deviceDriver.waitUntilReady();
+      await this.deviceDriver.waitForActive();
+    }
+
+    await this._emitter.emit('appReady', {
+      deviceId: this.deviceDriver.getExternalId(),
+      bundleId,
+      pid: this._processes[bundleId],
+    });
+
+    if (params.detoxUserNotificationDataURL) {
+      await this.deviceDriver.cleanupRandomDirectory(params.detoxUserNotificationDataURL);
+    }
+
+    if (params.detoxUserActivityDataURL) {
+      await this.deviceDriver.cleanupRandomDirectory(params.detoxUserActivityDataURL);
+    }
   }
 
-  /**
-   * @deprecated
-   */
   async relaunchApp(params = {}, bundleId) {
     if (params.newInstance === undefined) {
       params['newInstance'] = true;
@@ -180,24 +237,33 @@ class RuntimeDevice {
 
   async installApp(binaryPath, testBinaryPath) {
     const currentApp = binaryPath ? { binaryPath, testBinaryPath } : this._getCurrentApp();
-    await traceCall('appInstall',
-      this.deviceDriver.installApp(currentApp.binaryPath, currentApp.testBinaryPath));
+    await this.deviceDriver.installApp(currentApp.binaryPath, currentApp.testBinaryPath);
+
+    // This abstraction leaks because our drivers themselves leak,
+    // so don't blame me - DeviceBaseDriver itself has `reverseTcpPort`,
+    // setting a vicious downward spiral. I can't refactor everything
+    // in a single pull request, so let's bear with it for now.
+    if (Array.isArray(currentApp.reversePorts)) {
+      for (const port of currentApp.reversePorts) {
+        await this.reverseTcpPort(port);
+      }
+    }
   }
 
   async uninstallApp(bundleId) {
     const _bundleId = bundleId || this._bundleId;
-    await traceCall('appUninstall', this.deviceDriver.uninstallApp(_bundleId));
+    await this.deviceDriver.uninstallApp(_bundleId);
   }
 
   async installUtilBinaries() {
     const paths = this._deviceConfig.utilBinaryPaths;
     if (paths) {
-      await traceCall('installUtilBinaries', this.deviceDriver.installUtilBinaries(paths));
+      await this.deviceDriver.installUtilBinaries(paths);
     }
   }
 
   async reloadReactNative() {
-    await traceCall('reload React Native', this.deviceDriver.reloadReactNative());
+    await this.deviceDriver.reloadReactNative();
   }
 
   async openURL(params) {
@@ -296,73 +362,6 @@ class RuntimeDevice {
     }
     return this._currentApp;
   }
-
-  async _doLaunchApp(params, bundleId) {
-    const payloadParams = ['url', 'userNotification', 'userActivity'];
-    const hasPayload = this._assertHasSingleParam(payloadParams, params);
-    const newInstance = params.newInstance !== undefined
-      ? params.newInstance
-      : this._processes[bundleId] == null;
-
-    if (params.delete) {
-      await this.terminateApp(bundleId);
-      await this.uninstallApp();
-      await this.installApp();
-    } else if (newInstance) {
-      await this.terminateApp(bundleId);
-    }
-
-    const baseLaunchArgs = {
-      ...this._currentAppLaunchArgs.get(),
-      ...params.launchArgs,
-    };
-
-    if (params.url) {
-      baseLaunchArgs['detoxURLOverride'] = params.url;
-      if (params.sourceApp) {
-        baseLaunchArgs['detoxSourceAppOverride'] = params.sourceApp;
-      }
-    } else if (params.userNotification) {
-      this._createPayloadFileAndUpdatesParamsObject('userNotification', 'detoxUserNotificationDataURL', params, baseLaunchArgs);
-    } else if (params.userActivity) {
-      this._createPayloadFileAndUpdatesParamsObject('userActivity', 'detoxUserActivityDataURL', params, baseLaunchArgs);
-    }
-
-    if (params.permissions) {
-      await this.deviceDriver.setPermissions(bundleId, params.permissions);
-    }
-
-    if (params.disableTouchIndicators) {
-      baseLaunchArgs['detoxDisableTouchIndicators'] = true;
-    }
-
-    if (this._isAppRunning(bundleId) && hasPayload) {
-      await this.deviceDriver.deliverPayload({ ...params, delayPayload: true });
-    }
-
-    if (this._behaviorConfig.launchApp === 'manual') {
-      this._processes[bundleId] = await this.deviceDriver.waitForAppLaunch(bundleId, this._prepareLaunchArgs(baseLaunchArgs), params.languageAndLocale);
-    } else {
-      this._processes[bundleId] = await this.deviceDriver.launchApp(bundleId, this._prepareLaunchArgs(baseLaunchArgs), params.languageAndLocale);
-      await this.deviceDriver.waitUntilReady();
-      await this.deviceDriver.waitForActive();
-    }
-
-    await this._emitter.emit('appReady', {
-      deviceId: this.deviceDriver.getExternalId(),
-      bundleId,
-      pid: this._processes[bundleId],
-    });
-
-    if(params.detoxUserNotificationDataURL) {
-      await this.deviceDriver.cleanupRandomDirectory(params.detoxUserNotificationDataURL);
-    }
-
-    if(params.detoxUserActivityDataURL) {
-      await this.deviceDriver.cleanupRandomDirectory(params.detoxUserActivityDataURL);
-    }
-  }
-
   async _sendPayload(key, params) {
     const payloadFilePath = this.deviceDriver.createPayloadFile(params);
     const payload = {

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
@@ -153,9 +153,9 @@ class AndroidDriver extends DeviceDriverBase {
           this.instrumentation.waitForCrash()
         ]);
       } catch (e) {
-        console.warn('An error occurred while waiting for the app to become ready. Waiting for disconnection... Error:\n', e);
+        log.warn({ error: e }, 'An error occurred while waiting for the app to become ready. Waiting for disconnection...');
         await this.client.waitUntilDisconnected();
-        console.warn('...app disconnected.');
+        log.warn('The app disconnected.');
         throw e;
       } finally {
         this.instrumentation.abortWaitForCrash();

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

@@ -2,6 +2,5 @@ module.exports = {
   AndroidEmulatorRuntimeDriver: require('./android/emulator/EmulatorDriver'),
   AttachedAndroidRuntimeDriver: require('./android/attached/AttachedAndroidDriver'),
   GenycloudRuntimeDriver: require('./android/genycloud/GenyCloudDriver'),
-  IosRuntimeDriver: require('./ios/IosDriver'),
   IosSimulatorRuntimeDriver: require('./ios/SimulatorDriver'),
 };

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');
@@ -30,12 +30,13 @@ class SimulatorDriver extends IosDriver {
    * @param deps { SimulatorDriverDeps }
    * @param props { SimulatorDriverProps }
    */
-  constructor(deps, { udid, type, bootArgs }) {
+  constructor(deps, { udid, type, bootArgs, headless }) {
     super(deps);
 
     this.udid = udid;
     this._type = type;
     this._bootArgs = bootArgs;
+    this._headless = headless;
     this._deviceName = `${udid} (${this._type})`;
     this._simulatorLauncher = deps.simulatorLauncher;
     this._applesimutils = deps.applesimutils;
@@ -151,7 +152,7 @@ class SimulatorDriver extends IosDriver {
   async resetContentAndSettings() {
     await this._simulatorLauncher.shutdown(this.udid);
     await this._applesimutils.resetContentAndSettings(this.udid);
-    await this._simulatorLauncher.launch(this.udid, this._type, this._bootArgs);
+    await this._simulatorLauncher.launch(this.udid, this._type, this._bootArgs, this._headless);
   }
 
   getLogsPaths() {

package/src/devices/runtime/factories/ios.js

@@ -15,19 +15,13 @@ class RuntimeDriverFactoryIos extends RuntimeDeviceFactory {
   }
 }
 
-class Ios extends RuntimeDriverFactoryIos {
-  _createDriver(deviceCookie, deps, configs) { // eslint-disable-line no-unused-vars
-    const { IosRuntimeDriver } = require('../drivers');
-    return new IosRuntimeDriver(deps);
-  }
-}
-
 class IosSimulator extends RuntimeDriverFactoryIos {
   _createDriver(deviceCookie, deps, { deviceConfig }) {
     const props = {
       udid: deviceCookie.udid,
       type: deviceConfig.device.type,
       bootArgs: deviceConfig.bootArgs,
+      headless: deviceConfig.headless
     };
 
     const { IosSimulatorRuntimeDriver } = require('../drivers');
@@ -36,6 +30,5 @@ class IosSimulator extends RuntimeDriverFactoryIos {
 }
 
 module.exports = {
-  Ios,
   IosSimulator,
 };

package/src/devices/runtime/utils/LaunchArgsEditor.js

@@ -1,14 +1,7 @@
 const _ = require('lodash');
 
-const log = require('../../../utils/logger');
-
 const ScopedLaunchArgsEditor = require('./ScopedLaunchArgsEditor');
 
-/**
- * @typedef {Object} LaunchArgsEditorOptions
- * @property {boolean} [permanent=false] - Indicates whether the operation should affect the permanent app launch args.
- */
-
 class LaunchArgsEditor {
   constructor() {
     this._local = new ScopedLaunchArgsEditor();
@@ -19,67 +12,19 @@ class LaunchArgsEditor {
     return this._shared;
   }
 
-  /**
-   * @param {LaunchArgsEditorOptions} [options] - deprecated
-   */
-  modify(launchArgs, options) {
-    this._assertNoDeprecatedOptions('modify', options);
-
-    if (!_.isEmpty(launchArgs)) {
-      if (options && options.permanent) {
-        this._shared.modify(launchArgs);
-      } else {
-        this._local.modify(launchArgs);
-      }
-    }
-
+  modify(launchArgs) {
+    this._local.modify(launchArgs);
     return this;
   }
 
-  /**
-   * @param {LaunchArgsEditorOptions} [options] - deprecated
-   */
-  reset(options) {
-    this._assertNoDeprecatedOptions('reset', options);
+  reset() {
     this._local.reset();
-
-    if (options && options.permanent) {
-      this._shared.reset();
-    }
-
     return this;
   }
 
-  /**
-   * @param {LaunchArgsEditorOptions} [options] - deprecated
-   */
-  get(options) {
-    this._assertNoDeprecatedOptions('get', options);
-    const permanent = options && options.permanent;
-
-    if (permanent === true) {
-      return this._shared.get();
-    }
-
-    if (permanent === false) {
-      return this._local.get();
-    }
-
+  get() {
     return _.merge(this._shared.get(), this._local.get());
   }
-
-  _assertNoDeprecatedOptions(methodName, options) {
-    if (!options) {
-      return;
-    }
-
-    const target = options.permanent ? 'appLaunchArgs.shared' : 'appLaunchArgs';
-    log.warn({ event: 'DEPRECATION' }, [
-      `Detected an attempt to use device.launchArgs.${methodName}(...) with a deprecated 'options' parameter.`,
-      `Please use device.${target}.${methodName}(...) instead.`,
-      `For more details, see the reference at: https://wix.github.io/Detox/docs/api/device-object-api#deviceapplaunchargs\n`,
-    ].join('\n'));
-  }
 }
 
 module.exports = LaunchArgsEditor;

package/src/devices/runtime/utils/Storage.js

@@ -14,6 +14,10 @@ class Storage {
   }
 
   assign(map) {
+    if (_.isEmpty(map)) {
+      return;
+    }
+
     for (const key of Object.keys(map)) {
       this.set(key, map[key]);
     }

package/src/environmentFactory.js

@@ -85,14 +85,6 @@ function _getFactoryClasses(deviceConfig) {
       runtimeDeviceFactoryClass = runtimeDeviceFactories.IosSimulator;
       break;
 
-    case 'ios.none':
-      envValidatorFactoryClass = envValidationFactories.Noop;
-      deviceAllocatorFactoryClass = deviceAllocationFactories.None;
-      artifactsManagerFactoryClass = artifactsManagerFactories.Ios;
-      matchersFactoryClass = matchersFactories.Ios;
-      runtimeDeviceFactoryClass = runtimeDeviceFactories.Ios;
-      break;
-
     default: {
       return null;
     }