detox 21.0.0-rc.5 → 21.0.0-rc.7

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;
@@ -12,6 +14,7 @@
  *   readonly onTestDone: unique symbol;
  *   readonly onTestFnFailure: unique symbol;
  *   readonly onTestStart: unique symbol;
+ *   readonly conductEarlyTeardown: unique symbol;
  *   readonly reportTestResults: unique symbol;
  *   readonly resolveConfig: unique symbol;
  *   readonly session: unique symbol;
@@ -32,6 +35,9 @@ 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/assertIsFunction.js

@@ -0,0 +1,35 @@
+const isArrowFunction = require('./isArrowFunction');
+
+const EXAMPLE = `Here are some examples of valid function strings:
+
+1. function(el) { el.click(); }
+2. el => el.click()
+3. (el) => el.click()
+`;
+
+/**
+ * Dynamically evaluates a string as a function and throws an error if it's not a function
+ * @param {string} str serialized function like 'function() { return 42; }'
+ */
+function assertIsFunction(str) {
+  let isFunction;
+
+  try {
+    isFunction = isFunctionDeclaration(str) && Function(`return typeof (${str})`)() === 'function';
+  } catch (e) {
+    isFunction = false;
+  }
+
+  if (!isFunction) {
+    throw new TypeError(`Expected a valid function string, but got: ${str}\n\n${EXAMPLE}`);
+  }
+
+  return str;
+}
+
+function isFunctionDeclaration(rawStr) {
+  const str = rawStr.trimStart();
+  return str.startsWith('async') || str.startsWith('function') || isArrowFunction(str);
+}
+
+module.exports = assertIsFunction;

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() {
@@ -218,17 +217,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() {
@@ -253,9 +247,8 @@ module.exports = {
   getAndroidSDKPath,
   getAndroidEmulatorPath,
   getDetoxLibraryRootPath,
-  getDeviceLockFilePathIOS,
-  getDeviceLockFilePathAndroid,
-  getGenyCloudGlobalCleanupFilePath,
+  getDetoxLockFilePath,
+  getDeviceRegistryPath,
   getLastFailedTestsPath,
   getHomeDir,
 };

package/src/utils/errorUtils.js

@@ -40,15 +40,15 @@ function asError(error) {
   return isError(error) ? error : new Error(error);
 }
 
-function serializeObjectWithError(obj, errorKey) {
-  if (obj[errorKey]) {
+function serializeObjectWithError(obj, errorKey = 'error') {
+  if (obj[errorKey] instanceof Error) {
     return { ...obj, [errorKey]: serializeError(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/src/utils/isArrowFunction.js

@@ -0,0 +1,24 @@
+function isArrowFunction(code) {
+  if (!code.includes('=>')) {
+    return false;
+  }
+
+  const syncCode = removeAsync(code.trimStart());
+  return syncCode.startsWith('(') || isSimpleArrowFunction(code);
+}
+
+function removeAsync(code) {
+  return code.startsWith('async') ? code.slice(5).trimStart() : code;
+}
+
+function isSimpleArrowFunction(code) {
+  const [signature] = code.split('=>', 1);
+
+  return isAlphanumericId(removeAsync(signature.trim()));
+}
+
+function isAlphanumericId(code) {
+  return /^[a-zA-Z0-9]+$/.test(code);
+}
+
+module.exports = isArrowFunction;

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,
@@ -15,11 +15,16 @@
   },
   "rootDir": ".",
   "include": [
+    "detox.d.ts",
+    "globals.d.ts",
+    "index.d.ts",
     "**/*.js",
     "**/*.ts"
   ],
   "exclude": [
     "android",
+    "allure-report",
+    "allure-results",
     "coverage",
     "ios",
     "test"

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-javadoc.jar.md5

@@ -1 +0,0 @@
-119d98981ef93269e907438bd7c442a5

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-javadoc.jar.sha1

@@ -1 +0,0 @@
-0ac60d96780a3eb6136168b9ce54dd367aba7b6c

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-javadoc.jar.sha256

@@ -1 +0,0 @@
-f0bc5338c6c490f0a9890fbb7d695693ce5cbcd5db9a3e0bc80daa1c8cf9f06b

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-javadoc.jar.sha512

@@ -1 +0,0 @@
-d69c4fb155fb55f5ee5e0ca503748516c8fb521e53ece14cf19289845e18472e9642cd0aa3277e0bea0838f2c0b4fb822fdee3d37cb31e344eb2d47497a0cb52

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-sources.jar.md5

@@ -1 +0,0 @@
-0cb9fda75a870be143dc849d0bc24ecf

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-sources.jar.sha1

@@ -1 +0,0 @@
-638b69fc3c9638d808365e84f32fada3c6034506

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-sources.jar.sha256

@@ -1 +0,0 @@
-aba192ceb0a79bc73883bacd396d784e45caf5dcaa22f08196daf577ea33c7c3

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5-sources.jar.sha512

@@ -1 +0,0 @@
-fcd97091134fc03520a7acea66445d06326ae96aee8c9f832472bb9226f51f606ff092b7163b826ea82aba3d740b0db064d77330adcb947c99f0287ba58eda8a

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.aar.md5

@@ -1 +0,0 @@
-518f621bfc037203c5ddd30c3f62c8ad

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.aar.sha1

@@ -1 +0,0 @@
-65065fce4ddace8e95d235b60cf5a27f93e1162b

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.aar.sha256

@@ -1 +0,0 @@
-cd516e30305ad672e7ed0e8b4f77e992482c9a2979ce92d88a074dc45524cbe9

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.aar.sha512

@@ -1 +0,0 @@
-00ff273c46cb32923f574fd00189459e9dff6d4782ac561f30583c9610427e270450783485aece4e9ebeb52c12bd3eec1560521d5a0535965dd278c7b44f3848

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.pom.md5

@@ -1 +0,0 @@
-60878c8a642afe97e34dadce9f61b745

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.pom.sha1

@@ -1 +0,0 @@
-e1b3a6426ca487166e12493111c470d867a03698

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.pom.sha256

@@ -1 +0,0 @@
-cf438e39df2864be74d681f7a63ad9a3e560a7762cc7c3cc6492c2cae163ebd7

package/Detox-android/com/wix/detox/21.0.0-rc.5/detox-21.0.0-rc.5.pom.sha512

@@ -1 +0,0 @@
-8cb2ecfe802adf5d4aacdb2366e7a357786a26f7e380f5389c28a14bd160bf5a8aa15e0fdb5952ecd6b4d7c9a681970797aa57a8ba92fc4a0dc265e5b02563b2

package/runners/jest/reporters/DetoxReporter.js

@@ -1,36 +0,0 @@
-const resolveFrom = require('resolve-from');
-/** @type {typeof import('@jest/reporters').VerboseReporter} */
-const JestVerboseReporter = require(resolveFrom(process.cwd(), '@jest/reporters')).VerboseReporter;
-
-const { config, reportTestResults } = require('../../../internals');
-
-class DetoxReporter extends JestVerboseReporter {
-  /**
-   * @param {import('@jest/test-result').AggregatedResult} results
-   */
-  // @ts-ignore
-  async onRunComplete(_contexts, results) {
-    // @ts-ignore
-    await super.onRunComplete(_contexts, results);
-
-    await reportTestResults(results.testResults.map(r => ({
-      success: !r.failureMessage,
-      testFilePath: r.testFilePath,
-      testExecError: r.testExecError,
-      isPermanentFailure: this._isPermanentFailure(r),
-    })));
-  }
-
-  /**
-   * @param {import('@jest/test-result').TestResult} testResult
-   */
-  _isPermanentFailure(testResult) {
-    if (config.testRunner.jest.retryAfterCircusRetries) {
-      return false;
-    }
-
-    return testResult.testResults.some(r => r.status === 'failed' && r.invocations > 1);
-  }
-}
-
-module.exports = DetoxReporter;

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;