detox 20.12.2 → 20.13.0

package/src/realms/DetoxPrimaryContext.js

@@ -16,15 +16,14 @@ const symbols = require('./symbols');
 const { $logFinalizer, $restoreSessionState, $sessionState, $worker } = DetoxContext.protected;
 
 //#region Private symbols
-const _globalLifecycleHandler = Symbol('globalLifecycleHandler');
 const _ipcServer = Symbol('ipcServer');
-const _resetLockFile = Symbol('resetLockFile');
 const _wss = Symbol('wss');
 const _dirty = Symbol('dirty');
 const _emergencyTeardown = Symbol('emergencyTeardown');
 const _lifecycleLogger = Symbol('lifecycleLogger');
 const _sessionFile = Symbol('sessionFile');
 const _logFinalError = Symbol('logFinalError');
+const _deviceAllocator = Symbol('deviceAllocator');
 //#endregion
 
 class DetoxPrimaryContext extends DetoxContext {
@@ -33,7 +32,8 @@ class DetoxPrimaryContext extends DetoxContext {
 
     this[_dirty] = false;
     this[_wss] = null;
-    this[_globalLifecycleHandler] = null;
+    this[_deviceAllocator] = null;
+
     /** Path to file where the initial session object is serialized */
     this[_sessionFile] = '';
     /**
@@ -85,7 +85,6 @@ class DetoxPrimaryContext extends DetoxContext {
     const detoxConfig = await this[symbols.resolveConfig](opts);
 
     const {
-      behavior: behaviorConfig,
       device: deviceConfig,
       logger: loggerConfig,
       session: sessionConfig
@@ -102,20 +101,23 @@ class DetoxPrimaryContext extends DetoxContext {
     this[_ipcServer] = new IPCServer({
       sessionState: this[$sessionState],
       logger: this[symbols.logger],
+      callbacks: {
+        onAllocateDevice: this[symbols.allocateDevice].bind(this),
+        onDeallocateDevice: this[symbols.deallocateDevice].bind(this),
+      },
     });
 
     await this[_ipcServer].init();
 
     const environmentFactory = require('../environmentFactory');
-    this[_globalLifecycleHandler] = await environmentFactory.createGlobalLifecycleHandler(deviceConfig);
 
-    if (this[_globalLifecycleHandler]) {
-      await this[_globalLifecycleHandler].globalInit();
-    }
+    const { deviceAllocatorFactory } = environmentFactory.createFactories(deviceConfig);
+    this[_deviceAllocator] = deviceAllocatorFactory.createDeviceAllocator({
+      detoxConfig,
+      detoxSession: this[$sessionState],
+    });
 
-    if (!behaviorConfig.init.keepLockFile) {
-      await this[_resetLockFile]();
-    }
+    await this[_deviceAllocator].init();
 
     // TODO: Detox-server creation ought to be delegated to a generator/factory.
     const DetoxServer = require('../server/DetoxServer');
@@ -159,6 +161,29 @@ class DetoxPrimaryContext extends DetoxContext {
     await super[symbols.installWorker]({ ...opts, workerId });
   }
 
+  /** @override */
+  async [symbols.allocateDevice]() {
+    const { device } = this[$sessionState].detoxConfig;
+    const deviceCookie = await this[_deviceAllocator].allocate(device);
+
+    try {
+      return await this[_deviceAllocator].postAllocate(deviceCookie);
+    } catch (e) {
+      try {
+        await this[_deviceAllocator].free(deviceCookie, { shutdown: true });
+      } catch (e2) {
+        this[symbols.logger].error({ cat: 'device', err: e2 }, `Failed to free ${deviceCookie.name || deviceCookie.id} after a failed allocation`);
+      }
+
+      throw e;
+    }
+  }
+
+  /** @override */
+  async [symbols.deallocateDevice](cookie) {
+    await this[_deviceAllocator].free(cookie);
+  }
+
   /** @override */
   async [symbols.cleanup]() {
     try {
@@ -166,9 +191,9 @@ class DetoxPrimaryContext extends DetoxContext {
         await this[symbols.uninstallWorker]();
       }
     } finally {
-      if (this[_globalLifecycleHandler]) {
-        await this[_globalLifecycleHandler].globalCleanup();
-        this[_globalLifecycleHandler] = null;
+      if (this[_deviceAllocator]) {
+        await this[_deviceAllocator].cleanup();
+        this[_deviceAllocator] = null;
       }
 
       if (this[_wss]) {
@@ -202,9 +227,9 @@ class DetoxPrimaryContext extends DetoxContext {
       return;
     }
 
-    if (this[_globalLifecycleHandler]) {
-      this[_globalLifecycleHandler].emergencyCleanup();
-      this[_globalLifecycleHandler] = null;
+    if (this[_deviceAllocator]) {
+      this[_deviceAllocator].emergencyCleanup();
+      this[_deviceAllocator] = null;
     }
 
     if (this[_wss]) {
@@ -247,31 +272,6 @@ class DetoxPrimaryContext extends DetoxContext {
     });
   }
   //#endregion
-
-  //#region Private members
-  async[_resetLockFile]() {
-    const DeviceRegistry = require('../devices/DeviceRegistry');
-
-    const deviceType = this[symbols.config].device.type;
-
-    switch (deviceType) {
-      case 'ios.none':
-      case 'ios.simulator':
-        await DeviceRegistry.forIOS().reset();
-        break;
-      case 'android.attached':
-      case 'android.emulator':
-      case 'android.genycloud':
-        await DeviceRegistry.forAndroid().reset();
-        break;
-    }
-
-    if (deviceType === 'android.genycloud') {
-      const GenyDeviceRegistryFactory = require('../devices/allocation/drivers/android/genycloud/GenyDeviceRegistryFactory');
-      await GenyDeviceRegistryFactory.forGlobalShutdown().reset();
-    }
-  }
-  //#endregion
 }
 
 module.exports = DetoxPrimaryContext;

package/src/realms/DetoxSecondaryContext.js

@@ -62,6 +62,25 @@ class DetoxSecondaryContext extends DetoxContext {
     }
   }
 
+  /** @override */
+  async [symbols.allocateDevice]() {
+    if (this[_ipcClient]) {
+      const deviceCookie = await this[_ipcClient].allocateDevice();
+      return deviceCookie;
+    } else {
+      throw new DetoxInternalError('Detected an attempt to allocate a device using a non-initialized context.');
+    }
+  }
+
+  /** @override */
+  async [symbols.deallocateDevice](deviceCookie) {
+    if (this[_ipcClient]) {
+      await this[_ipcClient].deallocateDevice(deviceCookie);
+    } else {
+      throw new DetoxInternalError('Detected an attempt to allocate a device using a non-initialized context.');
+    }
+  }
+
   /** @override */
   async [symbols.cleanup]() {
     try {

package/src/realms/symbols.js

@@ -5,6 +5,8 @@
  *   readonly getStatus: unique symbol;
  *   readonly init: unique symbol;
  *   readonly installWorker: unique symbol;
+ *   readonly allocateDevice: unique symbol;
+ *   readonly deallocateDevice: unique symbol;
  *   readonly logger: unique symbol;
  *   readonly onHookFailure: unique symbol;
  *   readonly onRunDescribeFinish: unique symbol;
@@ -34,6 +36,8 @@ module.exports = {
   //#region IPC
   reportTestResults: Symbol('reportTestResults'),
   conductEarlyTeardown: Symbol('conductEarlyTeardown'),
+  allocateDevice: Symbol('allocateDevice'),
+  deallocateDevice: Symbol('deallocateDevice'),
   //#endregion
 
   //#region Main

package/src/utils/PIDService.js

@@ -0,0 +1,27 @@
+const { pid } = require('process');
+
+class PIDService {
+  getPid() {
+    return pid;
+  }
+
+  /**
+   * Checks if the other process id is running in the current operating system
+   * @param {number} otherPID
+   * @returns {boolean}
+   */
+  isAlive(otherPID) {
+    try {
+      process.kill(otherPID, 0);
+      return true;
+    } catch (ex) {
+      if (ex.code === 'ESRCH') {
+        return false;
+      }
+      throw ex;
+    }
+  }
+
+}
+
+module.exports = PIDService;

package/src/utils/environment.js

@@ -19,9 +19,8 @@ function which(executable, path) {
 const DETOX_LIBRARY_ROOT_PATH = path.join(appdatapath.appDataPath(), 'Detox');
 const MISSING_SDK_ERROR = `$ANDROID_SDK_ROOT is not defined, set the path to the SDK installation directory into $ANDROID_SDK_ROOT,
 Go to https://developer.android.com/studio/command-line/variables.html for more details`;
-const DEVICE_LOCK_FILE_PATH_IOS = path.join(DETOX_LIBRARY_ROOT_PATH, 'device.registry.state.lock');
-const DEVICE_LOCK_FILE_PATH_ANDROID = path.join(DETOX_LIBRARY_ROOT_PATH, 'android-device.registry.state.lock');
-const GENYCLOUD_GLOBAL_CLEANUP_FILE_PATH = path.join(DETOX_LIBRARY_ROOT_PATH, 'genycloud-cleanup.lock');
+const DETOX_LOCK_FILE_PATH = path.join(DETOX_LIBRARY_ROOT_PATH, 'global-context.json');
+const DEVICE_REGISTRY_PATH = path.join(DETOX_LIBRARY_ROOT_PATH, 'device.registry.json');
 const LAST_FAILED_TESTS_PATH = path.join(DETOX_LIBRARY_ROOT_PATH, 'last-failed.txt');
 
 function getAndroidSDKPath() {
@@ -195,17 +194,12 @@ function getDetoxLibraryRootPath() {
   return DETOX_LIBRARY_ROOT_PATH;
 }
 
-function getDeviceLockFilePathIOS() {
-  return DEVICE_LOCK_FILE_PATH_IOS;
+function getDetoxLockFilePath() {
+  return DETOX_LOCK_FILE_PATH;
 }
 
-// TODO This can probably be merged with IOS' by now
-function getDeviceLockFilePathAndroid() {
-  return DEVICE_LOCK_FILE_PATH_ANDROID;
-}
-
-function getGenyCloudGlobalCleanupFilePath() {
-  return GENYCLOUD_GLOBAL_CLEANUP_FILE_PATH;
+function getDeviceRegistryPath() {
+  return DEVICE_REGISTRY_PATH;
 }
 
 function getLastFailedTestsPath() {
@@ -229,9 +223,8 @@ module.exports = {
   getAndroidSDKPath,
   getAndroidEmulatorPath,
   getDetoxLibraryRootPath,
-  getDeviceLockFilePathIOS,
-  getDeviceLockFilePathAndroid,
-  getGenyCloudGlobalCleanupFilePath,
+  getDetoxLockFilePath,
+  getDeviceRegistryPath,
   getLastFailedTestsPath,
   getHomeDir,
 };

package/src/utils/errorUtils.js

@@ -40,7 +40,7 @@ function asError(error) {
   return isError(error) ? error : new Error(error);
 }
 
-function serializeObjectWithError(obj, errorKey) {
+function serializeObjectWithError(obj, errorKey = 'error') {
   if (obj[errorKey] instanceof Error) {
     return { ...obj, [errorKey]: serializeError(obj[errorKey]) };
   }
@@ -48,7 +48,7 @@ function serializeObjectWithError(obj, errorKey) {
   return obj;
 }
 
-function deserializeObjectWithError(obj, errorKey) {
+function deserializeObjectWithError(obj, errorKey = 'error') {
   if (typeof obj[errorKey] === 'object' && !(obj[errorKey] instanceof Error)) {
     return { ...obj, [errorKey]: deserializeError(obj[errorKey]) };
   }

package/tsconfig.json

@@ -1,11 +1,11 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "lib": ["es2018"],
-    "target": "ES2018",
+    "lib": ["es2022"],
+    "target": "ES2022",
     "allowJs": true,
     "checkJs": true,
-    "moduleResolution": "node",
+    "moduleResolution": "node16",
     "resolveJsonModule": true,
     "esModuleInterop": true,
     "noEmit": true,
@@ -20,6 +20,8 @@
   ],
   "exclude": [
     "android",
+    "allure-report",
+    "allure-results",
     "coverage",
     "ios",
     "test"

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-javadoc.jar.md5

@@ -1 +0,0 @@
-9f36d2885a93f2a409ee4e590f8678fe

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-javadoc.jar.sha1

@@ -1 +0,0 @@
-7627d2bccbd1f922472cb85f9e8480210d672d39

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-javadoc.jar.sha256

@@ -1 +0,0 @@
-43075c10900e4d81f273d56e642d1230ec01a4748996955a452ee0374aec0200

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-javadoc.jar.sha512

@@ -1 +0,0 @@
-2ba3ccabd9c41ad2ffb785c5c2ca9b5baedfe51fadcdcdc7b2c7c215335b061e693f7985800d562dd2e7449503e7e5d44a4332daf00a85f4e5b05da848a1f37f

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-sources.jar.md5

@@ -1 +0,0 @@
-bc5126d7b11cf8ad581aab27d743b430

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-sources.jar.sha1

@@ -1 +0,0 @@
-ad9dc488b327afa3154138a147f3873dd4f6b644

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-sources.jar.sha256

@@ -1 +0,0 @@
-d80d2d1e03c7f3b8b75ed70946e31725694cb29d4900eacc115276295b773347

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2-sources.jar.sha512

@@ -1 +0,0 @@
-be1d9cc4b36042e3f0416159a7b9509ce9e35de4eaabad53c385690a893bc51a0f453e0fe46173e91436b9f1e3dcbe9ab209434e1173558d5a87e5a94c8b278b

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2.pom.md5

@@ -1 +0,0 @@
-06ea49e97933d82debed143a3e362af8

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2.pom.sha1

@@ -1 +0,0 @@
-866a73f92aa581f2d23afd5df152cce65a882de6

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2.pom.sha256

@@ -1 +0,0 @@
-b7e47d08915a497db5f42985f3435420bf7580178c6975d1f257123c7bc53b4f

package/Detox-android/com/wix/detox/20.12.2/detox-20.12.2.pom.sha512

@@ -1 +0,0 @@
-f7fbbb355ce037d0519ad63caeebab6447f1e38f25ce44d495267510f7e4576978fff4b676f1a86966e7f638b4678b7bc769f50e4ffa1d106c786db72b9f7d6b

package/src/devices/DeviceRegistry.js

@@ -1,176 +0,0 @@
-// @ts-nocheck
-const fs = require('fs-extra');
-const _ = require('lodash');
-
-const ExclusiveLockfile = require('../utils/ExclusiveLockfile');
-const environment = require('../utils/environment');
-const safeAsync = require('../utils/safeAsync');
-
-const readOptions = {
-  encoding: 'utf8',
-};
-
-const FIELD_NAME_ID = 'id';
-const FIELD_NAME_DATA = 'data';
-
-class DevicesList {
-  constructor(devices) {
-    this._devices = Object.freeze(devices);
-  }
-
-  /**
-   * @returns {{id: string, data: *?}[]}
-   */
-  get rawDevices() {
-    return this._devices;
-  }
-
-  /**
-   * @param {string} deviceId
-   * @returns {boolean}
-   */
-  includes(deviceId) {
-    return DevicesList._includes(deviceId, this._devices);
-  }
-
-  static _includes(deviceId, devices) {
-    return _.some(devices, [FIELD_NAME_ID, deviceId]);
-  }
-}
-
-class DeviceRegistry {
-  constructor({ lockfilePath }) {
-    /***
-     * @private
-     * @type {string}
-     */
-    this._lockfilePath = lockfilePath;
-
-    /***
-     * @protected
-     * @type {ExclusiveLockfile}
-     */
-    this._lockfile = new ExclusiveLockfile(lockfilePath, {
-      getInitialState: this._getInitialLockFileState.bind(this),
-      readOptions,
-    });
-  }
-
-  async reset() {
-    await this._lockfile.exclusively(() => {
-      const empty = this._getInitialLockFileState();
-      this._lockfile.write(empty);
-    });
-  }
-
-  /***
-   * @param {string|Function} getDeviceId
-   * @param {*?} data
-   * @returns {Promise<string>}
-   */
-  async allocateDevice(getDeviceId, data) {
-    return this._lockfile.exclusively(async () => {
-      const deviceId = await safeAsync(getDeviceId);
-      this._registerDevice(deviceId, data);
-      return deviceId;
-    });
-  }
-
-  /***
-   * @param {string|Function} getDeviceId
-   * @returns {Promise<void>}
-   */
-  async disposeDevice(getDeviceId) {
-    await this._lockfile.exclusively(async () => {
-      const deviceId = await safeAsync(getDeviceId);
-      if (deviceId) {
-        this._unregisterDevice(deviceId);
-      }
-    });
-  }
-
-  /***
-   * @param {string} deviceId
-   * @returns {boolean}
-   */
-  includes(deviceId) {
-    const devices = this._lockfile.read();
-    return DevicesList._includes(deviceId, devices);
-  }
-
-  /***
-   * @returns {DevicesList}
-   */
-  getRegisteredDevices() {
-    const devices = this._lockfile.read();
-    return new DevicesList(devices);
-  }
-
-  /***
-   * @returns {DevicesList}
-   */
-  async readRegisteredDevices() {
-    let result = null;
-    await this._lockfile.exclusively(() => {
-      result = this.getRegisteredDevices();
-    });
-    return result;
-  }
-
-  /***
-   * @returns {DevicesList}
-   */
-  readRegisteredDevicesUNSAFE() {
-    const contents = fs.readFileSync(this._lockfilePath, readOptions);
-    const devices = JSON.parse(contents);
-    return new DevicesList(devices);
-  }
-
-  /***
-   * @private
-   */
-  _getInitialLockFileState() {
-    return [];
-  }
-
-  /**
-   * @private
-   */
-  _registerDevice(deviceId, data) {
-    const state = this._lockfile.read();
-    let newState = _.reject(state, [FIELD_NAME_ID, deviceId]);
-
-    const device = {};
-    device[FIELD_NAME_ID] = deviceId;
-
-    if (data) {
-      device[FIELD_NAME_DATA] = data;
-    }
-
-    newState = _.concat(newState, device);
-    this._lockfile.write(newState);
-  }
-
-  /**
-   * @private
-   */
-  _unregisterDevice(deviceId) {
-    const state = this._lockfile.read();
-    const newState = _.reject(state, [FIELD_NAME_ID, deviceId]);
-    this._lockfile.write(newState);
-  }
-
-  static forIOS() {
-    return new DeviceRegistry({
-      lockfilePath: environment.getDeviceLockFilePathIOS(),
-    });
-  }
-
-  static forAndroid() {
-    return new DeviceRegistry({
-      lockfilePath: environment.getDeviceLockFilePathAndroid(),
-    });
-  }
-}
-
-module.exports = DeviceRegistry;

package/src/devices/allocation/drivers/AllocationDriverBase.js

@@ -1,30 +0,0 @@
-/* eslint @typescript-eslint/no-unused-vars: ["error", { "args": "none" }] */
-// @ts-nocheck
-
-/**
- * @typedef DeallocOptions
- * @property shutdown { Boolean }
- */
-
-class AllocationDriverBase {
-  /**
-   * @param deviceConfig { Object }
-   * @return {Promise<DeviceCookie>}
-   */
-  async allocate(deviceConfig) {}
-
-  /**
-   * @param {DeviceCookie} deviceCookie
-   * @return {Promise<void>}
-   */
-  async postAllocate(deviceCookie) {}
-
-  /**
-   * @param cookie { DeviceCookie }
-   * @param options { DeallocOptions }
-   * @return {Promise<void>}
-   */
-  async free(cookie, options) {}
-}
-
-module.exports = AllocationDriverBase;

package/src/devices/allocation/drivers/android/attached/AttachedAndroidLauncher.js

@@ -1,13 +0,0 @@
-const DeviceLauncher = require('../../../../common/drivers/DeviceLauncher');
-
-class AttachedAndroidLauncher extends DeviceLauncher {
-  constructor(eventEmitter) {
-    super(eventEmitter);
-  }
-
-  notifyLaunchCompleted(adbName) {
-    return super._notifyBootEvent(adbName, 'device', false);
-  }
-}
-
-module.exports = AttachedAndroidLauncher;

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

@@ -1,72 +0,0 @@
-const logger = require('../../../../../utils/logger').child({ cat: 'device' });
-const DeviceAllocationHelper  = require('../../../../common/drivers/DeviceAllocationHelper');
-
-const DetoxEmulatorsPortRange = {
-  min: 10000,
-  max: 20000
-};
-
-class AllocationResult {
-  constructor(adbName, placeholderPort) {
-    this.adbName = adbName;
-    this.placeholderPort = placeholderPort;
-  }
-
-  get isRunning() {
-    return !this.placeholderPort;
-  }
-}
-
-class EmulatorAllocationHelper extends DeviceAllocationHelper {
-  constructor(deviceRegistry, freeDeviceFinder, rand = Math.random) {
-    super(deviceRegistry, logger);
-    this._freeDeviceFinder = freeDeviceFinder;
-    this._rand = rand;
-  }
-
-  /**
-   * @param avdName
-   * @returns {Promise<AllocationResult>}
-   */
-  async allocateDevice(avdName) {
-    this._logAllocationAttempt(avdName);
-
-    const result = await this._doSynchronizedAllocation(avdName);
-    this._logAllocationResult(avdName, result.adbName);
-
-    return result;
-  }
-
-  async deallocateDevice(adbName) {
-    await this._deviceRegistry.disposeDevice(adbName);
-  }
-
-  /**
-   * @returns {Promise<AllocationResult>}
-   * @private
-   */
-  async _doSynchronizedAllocation(avdName) {
-    let placeholderPort = null;
-    let adbName = null;
-
-    await this._deviceRegistry.allocateDevice(async () => {
-      adbName = await this._freeDeviceFinder.findFreeDevice(avdName);
-      if (!adbName) {
-        placeholderPort = this._allocateEmulatorPlaceholderPort();
-        adbName = `emulator-${placeholderPort}`;
-      }
-      return adbName;
-    });
-
-    return new AllocationResult(adbName, placeholderPort);
-  }
-
-  _allocateEmulatorPlaceholderPort() {
-    const { min, max } = DetoxEmulatorsPortRange;
-    let port = this._rand() * (max - min) + min;
-    port = port & 0xFFFFFFFE; // Should always be even
-    return port;
-  }
-}
-
-module.exports = EmulatorAllocationHelper;

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

@@ -1,16 +0,0 @@
-const environment = require('../../../../../utils/environment');
-const DeviceRegistry = require('../../../../DeviceRegistry');
-
-class GenyDeviceRegistryFactory {
-  forRuntime() {
-    return DeviceRegistry.forAndroid();
-  }
-
-  forGlobalShutdown() {
-    return new DeviceRegistry({
-      lockfilePath: environment.getGenyCloudGlobalCleanupFilePath(),
-    });
-  }
-}
-
-module.exports = new GenyDeviceRegistryFactory();