detox 20.15.0-prerelease.0 → 20.15.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "detox",
   "description": "E2E tests and automation for mobile",
-  "version": "20.15.0-prerelease.0",
+  "version": "20.15.0",
   "bin": {
     "detox": "local-cli/cli.js"
   },
@@ -36,27 +36,26 @@
   "devDependencies": {
     "@types/bunyan": "^1.8.8",
     "@types/child-process-promise": "^2.2.1",
-    "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^28.1.8",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^29.0.0",
     "@types/node": "^14.18.33",
     "@types/node-ipc": "^9.2.0",
     "@types/ws": "^7.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.59.8",
+    "@typescript-eslint/eslint-plugin": "^6.16.0",
+    "@typescript-eslint/parser": "^6.16.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.41.0",
-    "eslint-plugin-ecmascript-compat": "^3.0.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint": "^8.56.0",
+    "eslint-plugin-ecmascript-compat": "^3.1.0",
+    "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-no-only-tests": "^3.1.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-unicorn": "^47.0.0",
-    "jest": "^28.1.3",
-    "jest-allure2-reporter": "2.0.0-alpha.11",
-    "mockdate": "^2.0.1",
-    "prettier": "^2.4.1",
+    "eslint-plugin-unicorn": "^50.0.1",
+    "jest": "^29.0.0",
+    "jest-allure2-reporter": "^2.0.0-beta.4",
+    "prettier": "^3.1.1",
     "react-native": "0.71.10",
     "react-native-codegen": "^0.0.8",
-    "typescript": "^4.5.2",
+    "typescript": "^5.3.3",
     "wtfnode": "^0.9.1"
   },
   "dependencies": {
@@ -72,6 +71,7 @@
     "funpermaproxy": "^1.1.0",
     "glob": "^8.0.3",
     "ini": "^1.3.4",
+    "jest-environment-emit": "^1.0.5",
     "json-cycle": "^1.3.0",
     "lodash": "^4.17.11",
     "multi-sort-stream": "^1.0.3",
@@ -104,10 +104,10 @@
     }
   },
   "engines": {
-    "node": ">=14.5.0"
+    "node": ">=14.14.0"
   },
   "browserslist": [
     "node 14"
   ],
-  "gitHead": "d8d24e996503ce2618991d4ec6b9ae546335ad49"
+  "gitHead": "bed7b965b2180bd3c628e242b9f78a80660c371f"
 }

package/runners/jest/testEnvironment/index.js

@@ -1,5 +1,6 @@
 const path = require('path');
 
+const WithEmitter = require('jest-environment-emit').default;
 const resolveFrom = require('resolve-from');
 const maybeNodeEnvironment = require(resolveFrom(process.cwd(), 'jest-environment-node'));
 /** @type {typeof import('@jest/environment').JestEnvironment} */
@@ -31,7 +32,7 @@ const log = detox.log.child({ cat: 'lifecycle,jest-environment' });
 /**
  * @see https://www.npmjs.com/package/jest-circus#overview
  */
-class DetoxCircusEnvironment extends NodeEnvironment {
+class DetoxCircusEnvironment extends WithEmitter(NodeEnvironment) {
   constructor(config, context) {
     super(assertJestCircus27(config), assertExistingContext(context));
 
@@ -62,6 +63,8 @@ class DetoxCircusEnvironment extends NodeEnvironment {
       SpecReporter,
       WorkerAssignReporter,
     });
+
+    this.testEvents.on('*', this._onTestEvent.bind(this));
   }
 
   /** @override */
@@ -72,19 +75,14 @@ class DetoxCircusEnvironment extends NodeEnvironment {
 
   // @ts-expect-error TS2425
   async handleTestEvent(event, state) {
+    // @ts-expect-error TS2855
+    await super.handleTestEvent(event, state);
+
     if (detox.session.unsafe_earlyTeardown) {
       if (event.name === 'test_fn_start' || event.name === 'hook_start') {
         throw new Error('Detox halted test execution due to an early teardown request');
       }
     }
-
-    this._timer.schedule(state.testTimeout != null ? state.testTimeout : this.setupTimeout);
-
-    if (SYNC_CIRCUS_EVENTS.has(event.name)) {
-      this._handleTestEventSync(event, state);
-    } else {
-      await this._handleTestEventAsync(event, state);
-    }
   }
 
   /** @override */
@@ -147,6 +145,23 @@ class DetoxCircusEnvironment extends NodeEnvironment {
     }
   }
 
+  /** @private */
+  _onTestEvent({ type, event, state }) {
+    const timeout = state && state.testTimeout != null ? state.testTimeout : this.setupTimeout;
+
+    this._timer.schedule(timeout);
+
+    if (event) {
+      if (SYNC_CIRCUS_EVENTS.has(event.name)) {
+        this._handleTestEventSync(event, state);
+      } else {
+        return this._handleTestEventAsync(event, state);
+      }
+    } else {
+      return this._handleTestEventAsync({ name: type }, null);
+    }
+  }
+
   /** @private */
   async _handleTestEventAsync(event, state = null) {
     const description = `handling ${state ? 'jest-circus' : 'jest-environment'} "${event.name}" event`;

package/src/DetoxWorker.js

@@ -132,7 +132,7 @@ class DetoxWorker {
     };
 
     this._artifactsManager = artifactsManagerFactory.createArtifactsManager(this._artifactsConfig, commonDeps);
-    this._deviceCookie = yield this._context[symbols.allocateDevice]();
+    this._deviceCookie = yield this._context[symbols.allocateDevice](this._deviceConfig);
 
     this.device = runtimeDeviceFactory.createRuntimeDevice(
       this._deviceCookie,

package/src/android/actions/native.js

@@ -81,10 +81,10 @@ class ScrollAmountStopAtEdgeAction extends Action {
 }
 
 class ScrollEdgeAction extends Action {
-  constructor(edge) {
+  constructor(edge, startPositionX = -1, startPositionY = -1) {
     super();
 
-    this._call = invoke.callDirectly(DetoxActionApi.scrollToEdge(edge));
+    this._call = invoke.callDirectly(DetoxActionApi.scrollToEdge(edge, startPositionX, startPositionY));
   }
 }
 

package/src/android/core/NativeElement.js

@@ -93,12 +93,12 @@ class NativeElement {
     return await new ActionInteraction(this._invocationManager, this._matcher, action, traceDescription).execute();
   }
 
-  async scrollTo(edge) {
+  async scrollTo(edge, startPositionX, startPositionY) {
     // override the user's element selection with an extended matcher that looks for UIScrollView children
     this._matcher = this._matcher._extendToDescendantScrollViews();
 
-    const action = new actions.ScrollEdgeAction(edge);
-    const traceDescription = actionDescription.scrollTo(edge);
+    const action = new actions.ScrollEdgeAction(edge, startPositionX, startPositionY);
+    const traceDescription = actionDescription.scrollTo(edge, startPositionX, startPositionY);
     return await new ActionInteraction(this._invocationManager, this._matcher, action, traceDescription).execute();
   }
 
@@ -140,7 +140,6 @@ class NativeElement {
   }
 
   async takeScreenshot(screenshotName) {
-    // TODO this should be moved to a lower-layer handler of this use-case
     const action = new actions.TakeElementScreenshot();
     const traceDescription = actionDescription.takeScreenshot(screenshotName);
     const resultBase64 = await new ActionInteraction(this._invocationManager, this._matcher, action, traceDescription).execute();

package/src/android/espressoapi/DetoxAction.js

@@ -68,8 +68,10 @@ class DetoxAction {
     };
   }
 
-  static scrollToEdge(edge) {
+  static scrollToEdge(edge, startOffsetPercentX, startOffsetPercentY) {
     if (typeof edge !== "string") throw new Error("edge should be a string, but got " + (edge + (" (" + (typeof edge + ")"))));
+    if (typeof startOffsetPercentX !== "number") throw new Error("startOffsetPercentX should be a number, but got " + (startOffsetPercentX + (" (" + (typeof startOffsetPercentX + ")"))));
+    if (typeof startOffsetPercentY !== "number") throw new Error("startOffsetPercentY should be a number, but got " + (startOffsetPercentY + (" (" + (typeof startOffsetPercentY + ")"))));
     return {
       target: {
         type: "Class",
@@ -79,6 +81,12 @@ class DetoxAction {
       args: [{
         type: "Integer",
         value: sanitize_android_edge(edge)
+      }, {
+        type: "Double",
+        value: startOffsetPercentX
+      }, {
+        type: "Double",
+        value: startOffsetPercentY
       }]
     };
   }

package/src/android/interactions/native.js

@@ -28,7 +28,7 @@ class ActionInteraction extends Interaction {
   constructor(invocationManager, matcher, action, traceDescription) {
     super(invocationManager, traceDescription);
     this._call = EspressoDetoxApi.perform(matcher, action._call);
-    // TODO: move this.execute() here from the caller
+    // TODO [2024-12-01]: move this.execute() here from the caller
   }
 }
 
@@ -39,7 +39,7 @@ class MatcherAssertionInteraction extends Interaction {
 
     matcher = notCondition ? matcher.not : matcher;
     this._call = DetoxAssertionApi.assertMatcher(call(element._call), matcher._call.value);
-    // TODO: move this.execute() here from the caller
+    // TODO [2024-12-01]: move this.execute() here from the caller
   }
 }
 

package/src/android/matchers/native.js

@@ -76,7 +76,7 @@ class ToggleMatcher extends NativeMatcher {
   }
 }
 
-// TODO: Please be aware, that this is just a dummy matcher
+// NOTE: Please be aware, that this is just a dummy matcher
 class TraitsMatcher extends NativeMatcher {
   constructor(value) {
     super();

package/src/artifacts/providers/index.js

@@ -1,5 +1,5 @@
 class ArtifactPluginsProvider {
-  declareArtifactPlugins({ client }) {} // eslint-disable-line no-unused-vars
+  declareArtifactPlugins({ client }) {} // eslint-disable-line no-unused-vars,@typescript-eslint/no-unused-vars
 }
 
 class AndroidArtifactPluginsProvider extends ArtifactPluginsProvider {

package/src/artifacts/screenshot/SimulatorScreenshotPlugin.js

@@ -1,7 +1,6 @@
 const path = require('path');
 
 const fs = require('../../utils/fsext');
-const log = require('../../utils/logger').child({ cat: 'artifacts-plugin,artifacts' });
 const FileArtifact = require('../templates/artifact/FileArtifact');
 const temporaryPath = require('../utils/temporaryPath');
 

package/src/artifacts/templates/artifact/Artifact.js

@@ -107,7 +107,7 @@ class Artifact {
 
   async doStop() {}
 
-  async doSave(artifactPath) {} // eslint-disable-line no-unused-vars
+  async doSave(_artifactPath) {}
 
   async doDiscard() {}
 }

package/src/client/AsyncWebSocket.js

@@ -134,7 +134,7 @@ class AsyncWebSocket {
     }
   }
 
-  // TODO: handle this leaked abstraction some day
+  // TODO [2024-12-01]: handle this leaked abstraction some day
   hasPendingActions() {
     return _.some(this.inFlightPromises, p => p.message.type !== 'currentStatus');
   }
@@ -168,7 +168,7 @@ class AsyncWebSocket {
       case WebSocket.CONNECTING: return 'opening';
       case WebSocket.OPEN: return 'open';
       /* istanbul ignore next */
-      default: // TODO: [2021-12-01] throw new DetoxInternalError('...'); instead
+      default:
         return undefined;
     }
   }

package/src/client/Client.js

@@ -187,14 +187,14 @@ class Client {
       this._whenAppIsReady = new Deferred();
 
       await this._whenAppIsConnected.promise;
-      // TODO: optimize traffic (!) - we can just listen for 'ready' event
+      // TODO [2024-12-01]: optimize traffic (!) - we can just listen for 'ready' event
       // if app always sends it upon load completion. On iOS it works,
       // but not on Android. Afterwards, this will suffice:
       //
       // await this._whenAppIsReady.promise;
     }
 
-    // TODO: move to else branch after the optimization
+    // TODO [2024-12-01]: move to else branch after the optimization ↑↑
     if (!this._whenAppIsReady.isResolved()) {
       this._whenAppIsReady = new Deferred();
       await this.sendAction(new actions.Ready());

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

@@ -41,7 +41,6 @@ class AttachedAndroidAllocDriver {
   async postAllocate(deviceCookie) {
     const { adbName } = deviceCookie;
 
-    // TODO Also disable native animations?
     await this._adb.apiLevel(adbName);
     await this._adb.unlockScreen(adbName);
   }

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

@@ -5,7 +5,6 @@
 
 const _ = require('lodash');
 
-const Deferred = require('../../../../../utils/Deferred');
 const log = require('../../../../../utils/logger').child({ cat: 'device,device-allocation' });
 
 const { patchAvdSkinConfig } = require('./patchAvdSkinConfig');

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

@@ -7,7 +7,7 @@ class EmulatorVersionResolver {
     this.version = undefined;
   }
 
-  async resolve(isHeadless = false) { // TODO Make isHeadless a config arg (i.e. through c'tor)?
+  async resolve(isHeadless = false) {
     if (!this.version) {
       this.version = await this._resolve(isHeadless);
     }

package/src/devices/allocation/drivers/ios/SimulatorAllocDriver.js

@@ -39,7 +39,6 @@ class SimulatorAllocDriver {
   async allocate(deviceConfig) {
     const deviceQuery = new SimulatorQuery(deviceConfig.device);
 
-    // TODO Delegate this onto a well tested allocator class
     const udid = await this._deviceRegistry.registerDevice(async () => {
       return await this._findOrCreateDevice(deviceQuery);
     });

package/src/devices/allocation/factories/android.js

@@ -42,7 +42,7 @@ class AndroidEmulator extends DeviceAllocatorFactory {
 }
 
 class AndroidAttached extends DeviceAllocatorFactory {
-  _createDriver({ detoxSession, detoxConfig }) {
+  _createDriver({ detoxSession }) {
     const serviceLocator = require('../../servicelocator/android');
     const adb = serviceLocator.adb;
     const DeviceRegistry = require('../../allocation/DeviceRegistry');

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

@@ -2,7 +2,7 @@
 const DeviceAllocatorFactory = require('./base');
 
 class IosSimulator extends DeviceAllocatorFactory {
-  _createDriver({ detoxConfig, detoxSession, eventEmitter }) {
+  _createDriver({ detoxConfig, detoxSession }) {
     const AppleSimUtils = require('../../../devices/common/drivers/ios/tools/AppleSimUtils');
     const applesimutils = new AppleSimUtils();
 

package/src/devices/common/drivers/android/exec/ADB.js

@@ -8,7 +8,7 @@ const { escape } = require('../../../../../utils/pipeCommands');
 const DeviceHandle = require('../tools/DeviceHandle');
 const EmulatorHandle = require('../tools/EmulatorHandle');
 
-const INSTALL_TIMEOUT = 45000; // TODO Double check 45s makes sense
+const INSTALL_TIMEOUT = 45000;
 
 class ADB {
   constructor() {
@@ -345,7 +345,6 @@ class ADB {
     return this.adbCmd(deviceId, `emu kill`);
   }
 
-  // TODO refactor the whole thing so as to make usage of BinaryExec -- similar to EmulatorExec
   async adbCmd(deviceId, params, options = {}) {
     const serial = `${deviceId ? `-s ${deviceId}` : ''}`;
     const cmd = `"${this.adbBin}" ${serial} ${params}`;

package/src/devices/common/drivers/android/tools/ApkValidator.js

@@ -1,6 +1,6 @@
 const DetoxRuntimeError = require('../../../../../errors/DetoxRuntimeError');
 
-const setupGuideHint = 'For further assistance, visit the Android setup guide: https://github.com/wix/Detox/blob/master/docs/Introduction.Android.md';
+const setupGuideHint = 'For further assistance, visit the project setup guide (select the Android tabs): https://wix.github.io/Detox/docs/introduction/project-setup';
 
 class ApkValidator {
   constructor(aapt) {

package/src/devices/common/drivers/android/tools/AppInstallHelper.js

@@ -1,5 +1,3 @@
-// TODO Tweak such that if apk's already exist on the device (need to store uniquely), they will not be resent (would optimize cloud, for example)
-
 class AppInstallHelper {
   constructor(adb, fileTransfer) {
     this._adb = adb;

package/src/devices/common/drivers/ios/tools/AppleSimUtils.js

@@ -33,6 +33,7 @@ class AppleSimUtils {
       args: `--list ${joinArgs(query)}`,
       retries: 1,
       statusLogs: listOptions.trying ? { trying: listOptions.trying } : undefined,
+      maxBuffer: 4 * 1024 * 1024,
     };
     const response = await this._execAppleSimUtils(options);
     const parsed = this._parseResponseFromAppleSimUtils(response);

package/src/devices/runtime/drivers/android/AndroidDriver.js

@@ -280,7 +280,7 @@ class AndroidDriver extends DeviceDriverBase {
       throw new DetoxRuntimeError({
         message: `The test APK could not be found at path: '${testApkPath}'`,
         hint: 'Try running the detox build command, and make sure it was configured to execute a build command (e.g. \'./gradlew assembleAndroidTest\')' +
-          '\nFor further assistance, visit the Android setup guide: https://github.com/wix/Detox/blob/master/docs/Introduction.Android.md',
+          '\nFor further assistance, visit the project setup guide (select the Android tabs): https://wix.github.io/Detox/docs/introduction/project-setup',
       });
     }
     return testApkPath;

package/src/devices/runtime/drivers/android/emulator/EmulatorDriver.js

@@ -11,7 +11,6 @@ const AndroidDriver = require('../AndroidDriver');
  * @property forceAdbInstall { Boolean }
  */
 
-// TODO Unit test coverage
 class EmulatorDriver extends AndroidDriver {
   /**
    * @param deps { EmulatorDriverDeps }

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

@@ -2,8 +2,6 @@ const RuntimeDeviceFactory = require('./base');
 
 class RuntimeDriverFactoryIos extends RuntimeDeviceFactory {
   _createDriverDependencies(commonDeps) {
-    const { eventEmitter } = commonDeps;
-
     const AppleSimUtils = require('../../../devices/common/drivers/ios/tools/AppleSimUtils');
     const applesimutils = new AppleSimUtils();
 

package/src/ios/expectTwo.js

@@ -247,10 +247,13 @@ class Element {
     return this.withAction('scroll', traceDescription, pixels, direction, startPositionX, startPositionY);
   }
 
-  scrollTo(edge) {
+  scrollTo(edge, startPositionX = NaN, startPositionY = NaN) {
     if (!['left', 'right', 'top', 'bottom'].some(option => option === edge)) throw new Error('edge should be one of [left, right, top, bottom], but got ' + edge);
-    const traceDescription = actionDescription.scrollTo(edge);
-    return this.withAction('scrollTo', traceDescription, edge);
+    if (typeof startPositionX !== 'number') throw new Error('startPositionX should be a number, but got ' + (startPositionX + (' (' + (typeof startPositionX + ')'))));
+    if (typeof startPositionY !== 'number') throw new Error('startPositionY should be a number, but got ' + (startPositionY + (' (' + (typeof startPositionY + ')'))));
+
+    const traceDescription = actionDescription.scrollTo(edge, startPositionX, startPositionY);
+    return this.withAction('scrollTo', traceDescription, edge, startPositionX, startPositionY);
   }
 
   swipe(direction, speed = 'fast', normalizedSwipeOffset = NaN, normalizedStartingPointX = NaN, normalizedStartingPointY = NaN) {

package/src/ipc/IPCClient.js

@@ -60,8 +60,8 @@ class IPCClient {
     this._sessionState.patch(sessionState);
   }
 
-  async allocateDevice() {
-    const { deviceCookie, error } = deserializeObjectWithError(await this._emit('allocateDevice', {}));
+  async allocateDevice(deviceConfig) {
+    const { deviceCookie, error } = deserializeObjectWithError(await this._emit('allocateDevice', { deviceConfig }));
     if (error) {
       throw error;
     }

package/src/ipc/IPCServer.js

@@ -9,7 +9,7 @@ class IPCServer {
    * @param {import('./SessionState')} options.sessionState
    * @param {Detox.Logger} options.logger
    * @param {object} options.callbacks
-   * @param {() => Promise<any>} options.callbacks.onAllocateDevice
+   * @param {(deviceConfig: DetoxInternals.RuntimeConfig['device']) => Promise<any>} options.callbacks.onAllocateDevice
    * @param {(cookie: any) => Promise<void>} options.callbacks.onDeallocateDevice
    */
   constructor({ sessionState, logger, callbacks }) {
@@ -40,7 +40,7 @@ class IPCServer {
     this._ipc.config.logger = (msg) => this._logger.trace(msg);
 
     await new Promise((resolve) => {
-      // TODO: handle reject
+      // It is worth to handle rejection here some day
       this._ipc.serve(() => resolve());
       this._ipc.server.on('conductEarlyTeardown', this.onConductEarlyTeardown.bind(this));
       this._ipc.server.on('registerContext', this.onRegisterContext.bind(this));
@@ -104,11 +104,11 @@ class IPCServer {
     this._ipc.server.broadcast('sessionStateUpdate', newState);
   }
 
-  async onAllocateDevice(_payload, socket) {
+  async onAllocateDevice({ deviceConfig }, socket) {
     let deviceCookie;
 
     try {
-      deviceCookie = await this._callbacks.onAllocateDevice();
+      deviceCookie = await this._callbacks.onAllocateDevice(deviceConfig);
       this._ipc.server.emit(socket, 'allocateDeviceDone', { deviceCookie });
     } catch (error) {
       this._ipc.server.emit(socket, 'allocateDeviceDone', serializeObjectWithError({ error }));

package/src/realms/DetoxContext.js

@@ -47,7 +47,7 @@ class DetoxContext {
     this[$sessionState] = this[$restoreSessionState]();
 
     /**
-     * @type {DetoxLogger & Detox.Logger}
+     * @type {import('../logger/').DetoxLogger & Detox.Logger}
      */
     this[symbols.logger] = new DetoxLogger({
       file: temporary.for.jsonl(`${this[$sessionState].id}.${process.pid}`),
@@ -152,10 +152,10 @@ class DetoxContext {
   }
 
   /** @abstract */
-  async [symbols.allocateDevice]() {}
+  async [symbols.allocateDevice](_deviceConfig) {}
 
   /** @abstract */
-  async [symbols.deallocateDevice]() {}
+  async [symbols.deallocateDevice](_deviceCookie) {}
 
   async [symbols.uninstallWorker]() {
     try {