detox 20.12.0-smoke.0 → 20.12.0

package/src/ipc/IPCServer.js

@@ -8,15 +8,11 @@ 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, callbacks }) {
+  constructor({ sessionState, logger }) {
     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();
   }
@@ -45,8 +41,6 @@ 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();
     });
   }
@@ -89,24 +83,6 @@ 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,12 +149,6 @@ 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,14 +16,15 @@ 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 {
@@ -32,8 +33,7 @@ class DetoxPrimaryContext extends DetoxContext {
 
     this[_dirty] = false;
     this[_wss] = null;
-    this[_deviceAllocator] = null;
-
+    this[_globalLifecycleHandler] = null;
     /** Path to file where the initial session object is serialized */
     this[_sessionFile] = '';
     /**
@@ -79,6 +79,7 @@ class DetoxPrimaryContext extends DetoxContext {
     const detoxConfig = await this[symbols.resolveConfig](opts);
 
     const {
+      behavior: behaviorConfig,
       device: deviceConfig,
       logger: loggerConfig,
       session: sessionConfig
@@ -95,23 +96,20 @@ 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);
 
-    const { deviceAllocatorFactory } = environmentFactory.createFactories(deviceConfig);
-    this[_deviceAllocator] = deviceAllocatorFactory.createDeviceAllocator({
-      detoxConfig,
-      detoxSession: this[$sessionState],
-    });
+    if (this[_globalLifecycleHandler]) {
+      await this[_globalLifecycleHandler].globalInit();
+    }
 
-    await this[_deviceAllocator].init();
+    if (!behaviorConfig.init.keepLockFile) {
+      await this[_resetLockFile]();
+    }
 
     // TODO: Detox-server creation ought to be delegated to a generator/factory.
     const DetoxServer = require('../server/DetoxServer');
@@ -155,29 +153,6 @@ 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 {
@@ -185,9 +160,9 @@ class DetoxPrimaryContext extends DetoxContext {
         await this[symbols.uninstallWorker]();
       }
     } finally {
-      if (this[_deviceAllocator]) {
-        await this[_deviceAllocator].cleanup();
-        this[_deviceAllocator] = null;
+      if (this[_globalLifecycleHandler]) {
+        await this[_globalLifecycleHandler].globalCleanup();
+        this[_globalLifecycleHandler] = null;
       }
 
       if (this[_wss]) {
@@ -221,9 +196,9 @@ class DetoxPrimaryContext extends DetoxContext {
       return;
     }
 
-    if (this[_deviceAllocator]) {
-      this[_deviceAllocator].emergencyCleanup();
-      this[_deviceAllocator] = null;
+    if (this[_globalLifecycleHandler]) {
+      this[_globalLifecycleHandler].emergencyCleanup();
+      this[_globalLifecycleHandler] = null;
     }
 
     if (this[_wss]) {
@@ -266,6 +241,31 @@ 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,25 +54,6 @@ 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,8 +5,6 @@
  *   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,8 +32,6 @@ module.exports = {
 
   //#region IPC
   reportTestResults: Symbol('reportTestResults'),
-  allocateDevice: Symbol('allocateDevice'),
-  deallocateDevice: Symbol('deallocateDevice'),
   //#endregion
 
   //#region Main

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

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

package/src/servicelocator/android/genycloudServiceLocator.js

@@ -0,0 +1,21 @@
+const GenyDeviceRegistryFactory = require('../../devices/allocation/drivers/android/genycloud/GenyDeviceRegistryFactory');
+
+class GenycloudServiceLocator {
+  constructor() {
+    this._exec = null;
+    this.runtimeDeviceRegistry = GenyDeviceRegistryFactory.forRuntime();
+    this.cleanupDeviceRegistry = GenyDeviceRegistryFactory.forGlobalShutdown();
+  }
+
+  // Note: important to keep lazy because of implicit validations that are sensitive (inside environment, in particular).
+  get exec() {
+    if (!this._exec) {
+      const Exec = require('../../devices/common/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/servicelocator/android/index.js

@@ -0,0 +1,25 @@
+const AndroidDevicePathBuilder = require('../../artifacts/utils/AndroidDevicePathBuilder');
+const DeviceRegistry = require('../../devices/DeviceRegistry');
+const AAPT = require('../../devices/common/drivers/android/exec/AAPT');
+const ADB = require('../../devices/common/drivers/android/exec/ADB');
+const ApkValidator = require('../../devices/common/drivers/android/tools/ApkValidator');
+const { TempFileTransfer } = require('../../devices/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.deviceRegistry = DeviceRegistry.forAndroid();
+AndroidServiceLocator.devicePathBuilder = new AndroidDevicePathBuilder();
+
+module.exports = AndroidServiceLocator;

package/src/servicelocator/ios.js

@@ -0,0 +1,7 @@
+const DeviceRegistry = require('../devices/DeviceRegistry');
+const AppleSimUtils = require('../devices/common/drivers/ios/tools/AppleSimUtils');
+
+module.exports = {
+  appleSimUtils: new AppleSimUtils(),
+  deviceRegistry: DeviceRegistry.forIOS(),
+};

package/src/utils/environment.js

@@ -19,8 +19,9 @@ 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 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 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 LAST_FAILED_TESTS_PATH = path.join(DETOX_LIBRARY_ROOT_PATH, 'last-failed.txt');
 
 function getAndroidSDKPath() {
@@ -194,12 +195,17 @@ function getDetoxLibraryRootPath() {
   return DETOX_LIBRARY_ROOT_PATH;
 }
 
-function getDetoxLockFilePath() {
-  return DETOX_LOCK_FILE_PATH;
+function getDeviceLockFilePathIOS() {
+  return DEVICE_LOCK_FILE_PATH_IOS;
 }
 
-function getDeviceRegistryPath() {
-  return DEVICE_REGISTRY_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 getLastFailedTestsPath() {
@@ -223,8 +229,9 @@ module.exports = {
   getAndroidSDKPath,
   getAndroidEmulatorPath,
   getDetoxLibraryRootPath,
-  getDetoxLockFilePath,
-  getDeviceRegistryPath,
+  getDeviceLockFilePathIOS,
+  getDeviceLockFilePathAndroid,
+  getGenyCloudGlobalCleanupFilePath,
   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 = 'error') {
+function serializeObjectWithError(obj, errorKey) {
   if (obj[errorKey]) {
     return { ...obj, [errorKey]: serializeError(obj[errorKey]) };
   }
@@ -48,7 +48,7 @@ function serializeObjectWithError(obj, errorKey = 'error') {
   return obj;
 }
 
-function deserializeObjectWithError(obj, errorKey = 'error') {
+function deserializeObjectWithError(obj, errorKey) {
   if (typeof obj[errorKey] === 'object' && !(obj[errorKey] instanceof Error)) {
     return { ...obj, [errorKey]: deserializeError(obj[errorKey]) };
   }

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

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

package/src/{devices/validation → 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('../../allocation/drivers/android/genycloud/services/GenyAuthService');
+    const GenyAuthService = require('../../devices/common/drivers/android/genycloud/services/GenyAuthService');
     const authService = new GenyAuthService(exec);
 
     const GenycloudEnvValidator = require('../android/GenycloudEnvValidator');

package/src/{devices/validation → 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/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-javadoc.jar.md5

@@ -1 +0,0 @@
-9e1ed6595db1eb79fd10b72e768b9561

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-javadoc.jar.sha1

@@ -1 +0,0 @@
-d94beb57b34924c9ff07315304976d12682bcb64

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-javadoc.jar.sha256

@@ -1 +0,0 @@
-282729592fa58c2559eaeae9eb7524552ef025e306c20b6619b2ab79e0187f08

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-javadoc.jar.sha512

@@ -1 +0,0 @@
-bea0140ed5de7a5b9143c3cfbe6a65e5a11d5d7fa4699c0ed81f1d50a4978a72b3cd60a2908d88be78a908260bdb081258edcfd5ee34a5ec3a72a73d1fae7161

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-sources.jar.md5

@@ -1 +0,0 @@
-2cd5617bb26a597c18bd4a2fcc3e47a5

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-sources.jar.sha1

@@ -1 +0,0 @@
-e3addaba91ad374e5e74a90b848ce1691e089f9c

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-sources.jar.sha256

@@ -1 +0,0 @@
-ea34470f9caff1392d20c486c997cbcee75f7aad8dfa4cf9268d6984ae620d3c

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0-sources.jar.sha512

@@ -1 +0,0 @@
-f66e64dc2055ed7bb0ef4ce4434308e607f7f5cfa27bc5b447b94a355aacb731664e1ab8a86816dc64f5b8a949ab7bd76753413a84aa9ad610a11cc2d0c91534

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.aar.md5

@@ -1 +0,0 @@
-e1d6c5353b93ff848864f887b4763050

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.aar.sha1

@@ -1 +0,0 @@
-809426e1ab6811b1e6a727fdcd22bbbf20f89b02

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.aar.sha256

@@ -1 +0,0 @@
-dadebda11f4a94f751e23277fadbbaef518955f72ba353a5ae5f52ef1ba9acde

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.aar.sha512

@@ -1 +0,0 @@
-ba77a84e27f54bc932e73fac36cf2aa3b2a45fc51975088af59632256b214365fb1decbb77c117e5889013b10e4dc110e074100ac439b201e58ffd7333aa370e

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.pom.md5

@@ -1 +0,0 @@
-b657a85f93b0087e4bd3d2ef359cdcca

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.pom.sha1

@@ -1 +0,0 @@
-abbf983b4b77e1b748513273b9fb853feea6cfc9

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.pom.sha256

@@ -1 +0,0 @@
-8532ca9a4f54fcbdedcea406b715c7d7150d031e9478996ab505e453dca5d9bc

package/Detox-android/com/wix/detox/20.12.0-smoke.0/detox-20.12.0-smoke.0.pom.sha512

@@ -1 +0,0 @@
-20dc62ea32120332c031cc66c5b90e9917c7bd5ebe0bfff2c30014a05b7e613572fdd6a45b08260fb3b5f8feafc916034c6015a8a3627e67db6205b57cd4697f

package/src/devices/allocation/DeviceList.js

@@ -1,44 +0,0 @@
-class DeviceListReadonly {
-  constructor(devices = []) {
-    this._devices = new Map(devices.map(device => [device.id, device]));
-  }
-
-  concat(other) {
-    return new DeviceListReadonly([...this, ...other]);
-  }
-
-  getIds() {
-    return [...this._devices.keys()];
-  }
-
-  [Symbol.iterator]() {
-    return this._devices.values();
-  }
-
-  /**
-   * @param {string} deviceId
-   * @returns {boolean}
-   */
-  includes(deviceId) {
-    return this._devices.has(deviceId);
-  }
-}
-
-class DeviceList extends DeviceListReadonly {
-  filter(predicate) {
-    return new DeviceListReadonly([...this].filter(predicate));
-  }
-
-  add(deviceId, data) {
-    this._devices.set(deviceId, {
-      id: deviceId,
-      ...data,
-    });
-  }
-
-  delete(deviceId) {
-    this._devices.delete(deviceId);
-  }
-}
-
-module.exports = DeviceList;