detox 20.12.2 → 20.14.0-smoke.0

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.aar.md5

@@ -1 +0,0 @@
-0ff20c1510b97ba80b15a438ce65bddc

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

@@ -1 +0,0 @@
-449b07e6bb8435baef57e3d0839e68b5f7f85af5

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

@@ -1 +0,0 @@
-c3347ddd7b4e4a94c60c55c079451ea219e050f7c69b8dbc7b59a453d2398e67

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

@@ -1 +0,0 @@
-ebcf7f52b7e34a391174fc8850879e39a3e3f8f8ccfa0a417937680187461d5b41f7811933ca5ca088c554ae7a4e8d8cb2198375fdbb55680888aac561c71f64

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();

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

@@ -1,65 +0,0 @@
-// @ts-nocheck
-const logger = require('../../../../../utils/logger').child({ cat: 'device' });
-const DeviceAllocationHelper = require('../../../../common/drivers/DeviceAllocationHelper');
-
-const { ALLOCATE_DEVICE_LOG_EVT } = DeviceAllocationHelper;
-
-class AllocationResult {
-  constructor(instance, isNew) {
-    this.instance = instance;
-    this.isNew = isNew;
-  }
-}
-
-class GenyInstanceAllocationHelper extends DeviceAllocationHelper {
-  constructor({ deviceRegistry, instanceLookupService, instanceLifecycleService }) {
-    super(deviceRegistry, logger);
-
-    this._instanceLookupService = instanceLookupService;
-    this._instanceLifecycleService = instanceLifecycleService;
-  }
-
-  /**
-   * @param recipe { GenyRecipe }
-   * @return { Promise<AllocationResult> }
-   */
-  async allocateDevice(recipe) {
-    this._logAllocationAttempt(recipe);
-
-    const allocationResult = await this._doSynchronizedAllocation(recipe);
-    this._logAllocationResult(recipe, allocationResult.instance);
-
-    return allocationResult;
-  }
-
-  async deallocateDevice(instanceUUID) {
-    await this._deviceRegistry.disposeDevice(instanceUUID);
-  }
-
-  /**
-   * @param recipe { GenyRecipe }
-   * @return {Promise<{AllocationResult}>}
-   * @private
-   */
-  async _doSynchronizedAllocation(recipe) {
-    let instance = null;
-    let isNew = false;
-
-    await this._deviceRegistry.allocateDevice(async () => {
-      instance = await this._instanceLookupService.findFreeInstance();
-      if (!instance) {
-        instance = await this._instanceLifecycleService.createInstance(recipe.uuid);
-        isNew = true;
-      }
-      return instance.uuid;
-    });
-
-    return new AllocationResult(instance, isNew);
-  }
-
-  _logAllocationResult(deviceQuery, deviceHandle) {
-    logger.info({ event: ALLOCATE_DEVICE_LOG_EVT }, `Allocating Genymotion-Cloud instance ${deviceHandle.name} for testing. To access it via a browser, go to: https://cloud.geny.io/instance/${deviceHandle.uuid}`);
-  }
-}
-
-module.exports = GenyInstanceAllocationHelper;

package/src/devices/common/drivers/DeviceAllocationHelper.js

@@ -1,20 +0,0 @@
-const ALLOCATE_DEVICE_LOG_EVT = 'ALLOCATE_DEVICE';
-
-class DeviceAllocationHelper {
-  constructor(deviceRegistry, logger) {
-    this._deviceRegistry = deviceRegistry;
-    this._logger = logger;
-  }
-
-  _logAllocationAttempt(deviceQuery) {
-    this._logger.debug({ event: ALLOCATE_DEVICE_LOG_EVT }, `Trying to allocate a device based on "${deviceQuery}"`);
-  }
-
-  _logAllocationResult(deviceQuery, deviceHandle) {
-    this._logger.debug({ event: ALLOCATE_DEVICE_LOG_EVT }, `Settled on ${deviceHandle}`);
-  }
-}
-
-DeviceAllocationHelper.ALLOCATE_DEVICE_LOG_EVT = ALLOCATE_DEVICE_LOG_EVT;
-
-module.exports = DeviceAllocationHelper;

package/src/devices/common/drivers/DeviceLauncher.js

@@ -1,19 +0,0 @@
-class DeviceLauncher {
-  constructor(eventEmitter) {
-    this._eventEmitter = eventEmitter;
-  }
-
-  async _notifyPreShutdown(deviceId) {
-    return this._eventEmitter.emit('beforeShutdownDevice', { deviceId });
-  }
-
-  async _notifyShutdownCompleted(deviceId) {
-    return this._eventEmitter.emit('shutdownDevice', { deviceId });
-  }
-
-  async _notifyBootEvent(deviceId, type, coldBoot, headless) {
-    return this._eventEmitter.emit('bootDevice', { deviceId, type, coldBoot, headless });
-  }
-}
-
-module.exports = DeviceLauncher;

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

@@ -1,25 +0,0 @@
-const Instance = require('./dto/GenyInstance');
-
-class GenyInstanceLifecycleService {
-  constructor(genyCloudExec, instanceNaming) {
-    this.genyCloudExec = genyCloudExec;
-    this.instanceNaming = instanceNaming;
-  }
-
-  async createInstance(recipeUUID) {
-    const result = await this.genyCloudExec.startInstance(recipeUUID, this.instanceNaming.generateName());
-    return new Instance(result.instance);
-  }
-
-  async adbConnectInstance(instanceUUID) {
-    const result = (await this.genyCloudExec.adbConnect(instanceUUID));
-    return new Instance(result.instance);
-  }
-
-  async deleteInstance(instanceUUID) {
-    const result = await this.genyCloudExec.stopInstance(instanceUUID);
-    return new Instance(result.instance);
-  }
-}
-
-module.exports = GenyInstanceLifecycleService;

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

@@ -1,38 +0,0 @@
-const Instance = require('./dto/GenyInstance');
-
-class GenyInstanceLookupService {
-  constructor(genyCloudExec, instanceNaming, genyCloudDeviceRegistry) {
-    this.genyCloudExec = genyCloudExec;
-    this.instanceNaming = instanceNaming;
-    this.deviceRegistry = genyCloudDeviceRegistry;
-  }
-
-  async findFreeInstance() {
-    const freeInstances = await this._getRelevantInstances();
-    return (freeInstances[0] || null);
-  }
-
-  async getInstance(instanceUUID) {
-    const { instance } = await this.genyCloudExec.getInstance(instanceUUID);
-    return new Instance(instance);
-  }
-
-  async _getRelevantInstances() {
-    const takenInstances = this.deviceRegistry.getRegisteredDevices();
-    const isRelevant = (instance) =>
-      (instance.isOnline() || instance.isInitializing()) &&
-      this.instanceNaming.isFamilial(instance.name) &&
-      !takenInstances.includes(instance.uuid);
-
-    const instances = await this._getAllInstances();
-    return instances.filter(isRelevant);
-  }
-
-  async _getAllInstances() {
-    return (await this.genyCloudExec.getInstances())
-      .instances
-      .map((rawInstance) => new Instance(rawInstance));
-  }
-}
-
-module.exports = GenyInstanceLookupService;

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

@@ -1,14 +0,0 @@
-const internals = () => require('../../../../../../../internals');
-
-class GenyInstanceNaming {
-  generateName() {
-    const { session, worker } = internals();
-    return `Detox.${session.id}.${worker.id}`;
-  }
-
-  isFamilial(name) {
-    return name === this.generateName();
-  }
-}
-
-module.exports = GenyInstanceNaming;