detox 20.11.4 → 20.12.0-smoke.0

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

@@ -2,10 +2,11 @@ const RuntimeDeviceFactory = require('./base');
 
 class RuntimeDriverFactoryIos extends RuntimeDeviceFactory {
   _createDriverDependencies(commonDeps) {
-    const serviceLocator = require('../../../servicelocator/ios');
-    const applesimutils = serviceLocator.appleSimUtils;
     const { eventEmitter } = commonDeps;
 
+    const AppleSimUtils = require('../../../devices/common/drivers/ios/tools/AppleSimUtils');
+    const applesimutils = new AppleSimUtils();
+
     const SimulatorLauncher = require('../../allocation/drivers/ios/SimulatorLauncher');
     return {
       ...commonDeps,

package/src/{servicelocator → devices/servicelocator}/android/emulatorServiceLocator.js

@@ -1,4 +1,4 @@
-const { EmulatorExec } = require('../../devices/common/drivers/android/emulator/exec/EmulatorExec');
+const { EmulatorExec } = require('../../common/drivers/android/emulator/exec/EmulatorExec');
 
 class EmulatorServiceLocator {
   constructor() {

package/src/devices/servicelocator/android/genycloudServiceLocator.js

@@ -0,0 +1,17 @@
+class GenycloudServiceLocator {
+  constructor() {
+    this._exec = null;
+  }
+
+  // Note: important to keep lazy because of implicit validations that are sensitive (inside environment, in particular).
+  get exec() {
+    if (!this._exec) {
+      const Exec = require('../../allocation/drivers/android/genycloud/exec/GenyCloudExec');
+      const environment = require('../../../utils/environment');
+      this._exec = new Exec(environment.getGmsaasPath());
+    }
+    return this._exec;
+  }
+}
+
+module.exports = new GenycloudServiceLocator();

package/src/devices/servicelocator/android/index.js

@@ -0,0 +1,23 @@
+const AndroidDevicePathBuilder = require('../../../artifacts/utils/AndroidDevicePathBuilder');
+const AAPT = require('../../common/drivers/android/exec/AAPT');
+const ADB = require('../../common/drivers/android/exec/ADB');
+const ApkValidator = require('../../common/drivers/android/tools/ApkValidator');
+const { TempFileTransfer } = require('../../common/drivers/android/tools/TempFileTransfer');
+
+const AndroidServiceLocator = {
+  get emulator() {
+    return require('./emulatorServiceLocator');
+  },
+
+  get genycloud() {
+    return require('./genycloudServiceLocator');
+  },
+};
+
+AndroidServiceLocator.adb = new ADB();
+AndroidServiceLocator.aapt = new AAPT();
+AndroidServiceLocator.apkValidator = new ApkValidator(AndroidServiceLocator.aapt);
+AndroidServiceLocator.fileTransfer = new TempFileTransfer(AndroidServiceLocator.adb);
+AndroidServiceLocator.devicePathBuilder = new AndroidDevicePathBuilder();
+
+module.exports = AndroidServiceLocator;

package/src/{validation → devices/validation}/android/GenycloudEnvValidator.js

@@ -1,8 +1,8 @@
 // @ts-nocheck
 const semver = require('semver');
 
-const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
-const environment = require('../../utils/environment');
+const { DetoxRuntimeError } = require('../../../errors');
+const environment = require('../../../utils/environment');
 const EnvironmentValidatorBase = require('../EnvironmentValidatorBase');
 
 const MIN_GMSAAS_VERSION = '1.6.0';

package/src/{validation → devices/validation}/factories/index.js

@@ -7,7 +7,7 @@ class Genycloud extends EnvValidatorFactory {
     const serviceLocator = require('../../servicelocator/android');
     const exec = serviceLocator.genycloud.exec;
 
-    const GenyAuthService = require('../../devices/common/drivers/android/genycloud/services/GenyAuthService');
+    const GenyAuthService = require('../../allocation/drivers/android/genycloud/services/GenyAuthService');
     const authService = new GenyAuthService(exec);
 
     const GenycloudEnvValidator = require('../android/GenycloudEnvValidator');

package/src/{validation → devices/validation}/ios/IosSimulatorEnvValidator.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 
-const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
-const environment = require('../../utils/environment');
+const DetoxRuntimeError = require('../../../errors/DetoxRuntimeError');
+const environment = require('../../../utils/environment');
 const EnvironmentValidatorBase = require('../EnvironmentValidatorBase');
 
 class IosSimulatorEnvValidator extends EnvironmentValidatorBase {

package/src/environmentFactory.js

@@ -2,9 +2,9 @@
 const artifactsManagerFactories = require('./artifacts/factories');
 const deviceAllocationFactories = require('./devices/allocation/factories');
 const runtimeDeviceFactories = require('./devices/runtime/factories');
+const envValidationFactories = require('./devices/validation/factories');
 const matchersFactories = require('./matchers/factories');
 const resolveModuleFromPath = require('./utils/resolveModuleFromPath');
-const envValidationFactories = require('./validation/factories');
 
 function validateConfig(deviceConfig) {
   const classes = _getFactoryClasses(deviceConfig);
@@ -36,15 +36,6 @@ function createFactories(deviceConfig) {
   return _getExternalModuleFactories(deviceConfig);
 }
 
-function createGlobalLifecycleHandler(deviceConfig) {
-  if (deviceConfig.type === 'android.genycloud') {
-    const FactoryClass = require('./devices/lifecycle/factories/GenyGlobalLifecycleHandlerFactory');
-    const factory = new FactoryClass();
-    return factory.createHandler();
-  }
-  return null;
-}
-
 function _getFactoryClasses(deviceConfig) {
   let envValidatorFactoryClass;
   let artifactsManagerFactoryClass;
@@ -115,5 +106,4 @@ function _getExternalModuleFactories(deviceConfig) {
 module.exports = {
   validateConfig,
   createFactories,
-  createGlobalLifecycleHandler,
 };

package/src/ipc/IPCClient.js

@@ -1,7 +1,7 @@
 const { IPC } = require('node-ipc');
 
 const { DetoxInternalError } = require('../errors');
-const { serializeObjectWithError } = require('../utils/errorUtils');
+const { serializeObjectWithError, deserializeObjectWithError } = require('../utils/errorUtils');
 
 class IPCClient {
   constructor({ id, logger, sessionState }) {
@@ -60,6 +60,22 @@ class IPCClient {
     this._sessionState.patch(sessionState);
   }
 
+  async allocateDevice() {
+    const { deviceCookie, error } = deserializeObjectWithError(await this._emit('allocateDevice', {}));
+    if (error) {
+      throw error;
+    }
+
+    return deviceCookie;
+  }
+
+  async deallocateDevice(deviceCookie) {
+    const { error } = deserializeObjectWithError(await this._emit('deallocateDevice', { deviceCookie }));
+    if (error) {
+      throw error;
+    }
+  }
+
   /**
    * @param {DetoxInternals.DetoxTestFileReport[]} testResults
    */

package/src/ipc/IPCServer.js

@@ -8,11 +8,15 @@ class IPCServer {
    * @param {object} options
    * @param {import('./SessionState')} options.sessionState
    * @param {Detox.Logger} options.logger
+   * @param {object} options.callbacks
+   * @param {() => Promise<any>} options.callbacks.onAllocateDevice
+   * @param {(cookie: any) => Promise<void>} options.callbacks.onDeallocateDevice
    */
-  constructor({ sessionState, logger }) {
+  constructor({ sessionState, logger, callbacks }) {
     this._sessionState = sessionState;
     this._logger = logger.child({ cat: 'ipc,ipc-server' });
     this._ipc = null;
+    this._callbacks = callbacks;
     this._workers = new Set();
     this._contexts = new Set();
   }
@@ -41,6 +45,8 @@ class IPCServer {
       this._ipc.server.on('registerContext', this.onRegisterContext.bind(this));
       this._ipc.server.on('registerWorker', this.onRegisterWorker.bind(this));
       this._ipc.server.on('reportTestResults', this.onReportTestResults.bind(this));
+      this._ipc.server.on('allocateDevice', this.onAllocateDevice.bind(this));
+      this._ipc.server.on('deallocateDevice', this.onDeallocateDevice.bind(this));
       this._ipc.server.start();
     });
   }
@@ -83,6 +89,24 @@ class IPCServer {
     }
   }
 
+  async onAllocateDevice(_payload, socket) {
+    try {
+      const deviceCookie = await this._callbacks.onAllocateDevice();
+      this._ipc.server.emit(socket, 'allocateDeviceDone', { deviceCookie });
+    } catch (error) {
+      this._ipc.server.emit(socket, 'allocateDeviceDone', serializeObjectWithError({ error }));
+    }
+  }
+
+  async onDeallocateDevice({ deviceCookie }, socket) {
+    try {
+      await this._callbacks.onDeallocateDevice(deviceCookie);
+      this._ipc.server.emit(socket, 'deallocateDeviceDone', {});
+    } catch (error) {
+      this._ipc.server.emit(socket, 'deallocateDeviceDone', serializeObjectWithError({ error }));
+    }
+  }
+
   onReportTestResults({ testResults }, socket = null) {
     const merged = uniqBy([
       ...testResults.map(r => serializeObjectWithError(r, 'testExecError')),

package/src/realms/DetoxContext.js

@@ -149,6 +149,12 @@ class DetoxContext {
     await this[$worker].init();
   }
 
+  /** @abstract */
+  async [symbols.allocateDevice]() {}
+
+  /** @abstract */
+  async [symbols.deallocateDevice]() {}
+
   async [symbols.uninstallWorker]() {
     try {
       if (this[$worker]) {

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] = '';
     /**
@@ -79,7 +79,6 @@ class DetoxPrimaryContext extends DetoxContext {
     const detoxConfig = await this[symbols.resolveConfig](opts);
 
     const {
-      behavior: behaviorConfig,
       device: deviceConfig,
       logger: loggerConfig,
       session: sessionConfig
@@ -96,20 +95,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');
@@ -153,6 +155,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} after a failed allocation`);
+      }
+
+      throw e;
+    }
+  }
+
+  /** @override */
+  async [symbols.deallocateDevice](cookie) {
+    await this[_deviceAllocator].free(cookie);
+  }
+
   /** @override */
   async [symbols.cleanup]() {
     try {
@@ -160,9 +185,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]) {
@@ -196,9 +221,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]) {
@@ -241,31 +266,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

@@ -54,6 +54,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;
@@ -32,6 +34,8 @@ module.exports = {
 
   //#region IPC
   reportTestResults: Symbol('reportTestResults'),
+  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]) {
     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/Detox-android/com/wix/detox/20.11.4/detox-20.11.4-javadoc.jar.md5

@@ -1 +0,0 @@
-3ab1e77a88959796445b964956a4b6cb

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

@@ -1 +0,0 @@
-a7282bbd2481685e2692a4cf51676464a0f7446f

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

@@ -1 +0,0 @@
-deeac0e7aab27bd41f07df5f72448abe52e6cc4d6ac4355c9a0e3d3be38ce052

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

@@ -1 +0,0 @@
-a039381f1dc1580412a3ab5b34065d74d9cd56c26578201fedcfa8d6325993a38556ac14a8d3ad47f231cc53947fa212f603933fe871c453322e895164768911

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

@@ -1 +0,0 @@
-5cf453e649a4658381b05b20ad88bde7

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

@@ -1 +0,0 @@
-6741271763e5c32f00f1d1b6f3a66f8299c7388c

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

@@ -1 +0,0 @@
-dc0c3debc80ef7502250987bfef873bf8ffe3208cb867d9c1f93e5ffe68e3e09

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

@@ -1 +0,0 @@
-f25095114f302dac4e4c1912929d522f333648f6dcc8889c2ccf09b8e5d4b59ceb6cc4d01445bbd789bc3fb36c8f402af1bd4bf1863af82a8c6108021ff58fa0

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

@@ -1 +0,0 @@
-f6329cce61c1d04aff24a0c72fb2710c

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

@@ -1 +0,0 @@
-1fdb6d612186ed63fef79d13ee8204ef550f1934

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

@@ -1 +0,0 @@
-d850605b833689e3d3e53fb09c2210015fac17ba0e15fa4e6be3953aafd3056e

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

@@ -1 +0,0 @@
-83d8ead4b94a64418ed9df32830f2628854f9fb7bde37740a3c24eaca90bd86e8563110eccea6d943089c4b7b6fb7e4e72c6533a668bdadf4f500f40eb6ee70e