detox 20.15.1-prerelease.0 → 20.16.0

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 {

package/src/realms/DetoxPrimaryContext.js

@@ -23,7 +23,9 @@ const _emergencyTeardown = Symbol('emergencyTeardown');
 const _lifecycleLogger = Symbol('lifecycleLogger');
 const _sessionFile = Symbol('sessionFile');
 const _logFinalError = Symbol('logFinalError');
-const _deviceAllocator = Symbol('deviceAllocator');
+const _cookieAllocators = Symbol('cookieAllocators');
+const _deviceAllocators = Symbol('deviceAllocators');
+const _createDeviceAllocator = Symbol('createDeviceAllocator');
 //#endregion
 
 class DetoxPrimaryContext extends DetoxContext {
@@ -32,7 +34,8 @@ class DetoxPrimaryContext extends DetoxContext {
 
     this[_dirty] = false;
     this[_wss] = null;
-    this[_deviceAllocator] = null;
+    this[_cookieAllocators] = {};
+    this[_deviceAllocators] = {};
 
     /** Path to file where the initial session object is serialized */
     this[_sessionFile] = '';
@@ -85,7 +88,6 @@ class DetoxPrimaryContext extends DetoxContext {
     const detoxConfig = await this[symbols.resolveConfig](opts);
 
     const {
-      device: deviceConfig,
       logger: loggerConfig,
       session: sessionConfig
     } = detoxConfig;
@@ -96,7 +98,6 @@ class DetoxPrimaryContext extends DetoxContext {
       data: this[$sessionState],
     }, getCurrentCommand());
 
-    // TODO: IPC Server creation ought to be delegated to a generator/factory.
     const IPCServer = require('../ipc/IPCServer');
     this[_ipcServer] = new IPCServer({
       sessionState: this[$sessionState],
@@ -109,17 +110,6 @@ class DetoxPrimaryContext extends DetoxContext {
 
     await this[_ipcServer].init();
 
-    const environmentFactory = require('../environmentFactory');
-
-    const { deviceAllocatorFactory } = environmentFactory.createFactories(deviceConfig);
-    this[_deviceAllocator] = deviceAllocatorFactory.createDeviceAllocator({
-      detoxConfig,
-      detoxSession: this[$sessionState],
-    });
-
-    await this[_deviceAllocator].init();
-
-    // TODO: Detox-server creation ought to be delegated to a generator/factory.
     const DetoxServer = require('../server/DetoxServer');
     if (sessionConfig.autoStart) {
       this[_wss] = new DetoxServer({
@@ -132,7 +122,6 @@ class DetoxPrimaryContext extends DetoxContext {
       await this[_wss].open();
     }
 
-    // TODO: double check that this config is indeed propogated onto the client create at the detox-worker side
     if (!sessionConfig.server && this[_wss]) {
       // @ts-ignore
       sessionConfig.server = `ws://localhost:${this[_wss].port}`;
@@ -162,17 +151,20 @@ class DetoxPrimaryContext extends DetoxContext {
   }
 
   /** @override */
-  async [symbols.allocateDevice]() {
-    const { device } = this[$sessionState].detoxConfig;
-    const deviceCookie = await this[_deviceAllocator].allocate(device);
+  async [symbols.allocateDevice](deviceConfig) {
+    const deviceAllocator = await this[_createDeviceAllocator](deviceConfig);
+    const deviceCookie = await deviceAllocator.allocate(deviceConfig);
+    this[_cookieAllocators][deviceCookie.id] = deviceAllocator;
 
     try {
-      return await this[_deviceAllocator].postAllocate(deviceCookie);
+      return await deviceAllocator.postAllocate(deviceCookie);
     } catch (e) {
       try {
-        await this[_deviceAllocator].free(deviceCookie, { shutdown: true });
+        await deviceAllocator.free(deviceCookie, { shutdown: true });
       } catch (e2) {
-        this[symbols.logger].error({ cat: 'device', err: e2 }, `Failed to free ${deviceCookie.name || deviceCookie.id} after a failed allocation`);
+        this[symbols.logger].error({ cat: 'device', err: e2 }, `Failed to free ${deviceCookie.name || deviceCookie.id} after a failed allocation attempt`);
+      } finally {
+        delete this[_cookieAllocators][deviceCookie.id];
       }
 
       throw e;
@@ -181,7 +173,17 @@ class DetoxPrimaryContext extends DetoxContext {
 
   /** @override */
   async [symbols.deallocateDevice](cookie) {
-    await this[_deviceAllocator].free(cookie);
+    const deviceAllocator = this[_cookieAllocators][cookie.id];
+    if (!deviceAllocator) {
+      throw new DetoxRuntimeError({
+        message: `Cannot deallocate device ${cookie.id} because it was not allocated by this context.`,
+        hint: `See the actually known allocated devices below:`,
+        debugInfo: Object.keys(this[_cookieAllocators]).map(id => `- ${id}`).join('\n'),
+      });
+    }
+
+    await deviceAllocator.free(cookie);
+    delete this[_cookieAllocators][cookie.id];
   }
 
   /** @override */
@@ -191,11 +193,18 @@ class DetoxPrimaryContext extends DetoxContext {
         await this[symbols.uninstallWorker]();
       }
     } finally {
-      if (this[_deviceAllocator]) {
-        await this[_deviceAllocator].cleanup();
-        this[_deviceAllocator] = null;
+      for (const key of Object.keys(this[_deviceAllocators])) {
+        const deviceAllocator = this[_deviceAllocators][key];
+        delete this[_deviceAllocators][key];
+        try {
+          await deviceAllocator.cleanup();
+        } catch (err) {
+          this[symbols.logger].error({ cat: 'device', err }, `Failed to cleanup the device allocation driver for ${key}`);
+        }
       }
 
+      this[_cookieAllocators] = {};
+
       if (this[_wss]) {
         await this[_wss].close();
         this[_wss] = null;
@@ -227,11 +236,18 @@ class DetoxPrimaryContext extends DetoxContext {
       return;
     }
 
-    if (this[_deviceAllocator]) {
-      this[_deviceAllocator].emergencyCleanup();
-      this[_deviceAllocator] = null;
+    for (const key of Object.keys(this[_deviceAllocators])) {
+      const deviceAllocator = this[_deviceAllocators][key];
+      delete this[_deviceAllocators][key];
+      try {
+        deviceAllocator.emergencyCleanup();
+      } catch (err) {
+        this[symbols.logger].error({ cat: 'device', err }, `Failed to clean up the device allocation driver for ${key} in emergency mode`);
+      }
     }
 
+    this[_cookieAllocators] = {};
+
     if (this[_wss]) {
       this[_wss].close();
     }
@@ -253,6 +269,35 @@ class DetoxPrimaryContext extends DetoxContext {
     }
   };
 
+  /** @param {Detox.DetoxDeviceConfig} deviceConfig */
+  [_createDeviceAllocator] = async (deviceConfig) => {
+    const deviceType = deviceConfig.type;
+    if (!this[_deviceAllocators][deviceType]) {
+      const environmentFactory = require('../environmentFactory');
+      const { deviceAllocatorFactory } = environmentFactory.createFactories(deviceConfig);
+      const { detoxConfig } = this[$sessionState];
+      const deviceAllocator = deviceAllocatorFactory.createDeviceAllocator({
+        detoxConfig,
+        detoxSession: this[$sessionState],
+      });
+
+      try {
+        await deviceAllocator.init();
+        this[_deviceAllocators][deviceType] = deviceAllocator;
+      } catch (e) {
+        try {
+          await deviceAllocator.cleanup();
+        } catch (e2) {
+          this[symbols.logger].error({ cat: 'device', err: e2 }, `Failed to cleanup the device allocation driver for ${deviceType} after a failed initialization`);
+        }
+
+        throw e;
+      }
+    }
+
+    return this[_deviceAllocators][deviceType];
+  };
+
   [_logFinalError] = (err) => {
     this[_lifecycleLogger].error(err, 'Encountered an error while merging the process logs:');
   };

package/src/realms/DetoxSecondaryContext.js

@@ -63,9 +63,9 @@ class DetoxSecondaryContext extends DetoxContext {
   }
 
   /** @override */
-  async [symbols.allocateDevice]() {
+  async [symbols.allocateDevice](deviceConfig) {
     if (this[_ipcClient]) {
-      const deviceCookie = await this[_ipcClient].allocateDevice();
+      const deviceCookie = await this[_ipcClient].allocateDevice(deviceConfig);
       return deviceCookie;
     } else {
       throw new DetoxInternalError('Detected an attempt to allocate a device using a non-initialized context.');

package/src/utils/childProcess/exec.js

@@ -14,9 +14,10 @@ async function execWithRetriesAndLogs(bin, options = {}) {
     interval = 1000,
     prefix = null,
     args = null,
-    timeout = 0,
+    timeout,
     statusLogs = {},
     verbosity = 'normal',
+    maxBuffer,
   } = options;
 
   const trackingId = execsCounter.inc();
@@ -35,7 +36,7 @@ async function execWithRetriesAndLogs(bin, options = {}) {
       } else if (statusLogs.retrying) {
         _logExecRetrying(logger, cmd, tryNumber, lastError);
       }
-      result = await exec(cmd, { timeout });
+      result = await exec(cmd, _.omitBy({ timeout, maxBuffer }, _.isUndefined));
     });
   } catch (err) {
     const failReason = err.code == null && timeout > 0

package/src/utils/invocationTraceDescriptions.js

@@ -12,8 +12,9 @@ module.exports = {
     pinchWithAngle: (direction, speed, angle) => `pinch with direction ${direction}, speed ${speed}, and angle ${angle}`,
     replaceText: (value) => `replace input text: "${value}"`,
     scroll: (amount, direction, startPositionX, startPositionY) =>
-      `scroll ${amount} pixels ${direction}${startPositionX !== undefined && startPositionY !== undefined ? ` from normalized position (${startPositionX}, ${startPositionY})` : ''}`,
-    scrollTo: (edge) => `scroll to ${edge}`,
+      `scroll ${amount} pixels ${direction}${startPositionX !== undefined || startPositionY !== undefined ? ` from normalized position (${startPositionX}, ${startPositionY})` : ''}`,
+    scrollTo: (edge, startPositionX, startPositionY) =>
+      `scroll to ${edge} ${startPositionX !== undefined || startPositionY !== undefined ? ` from normalized position (${startPositionX}, ${startPositionY})` : ''}`,
     scrollToIndex: (index) => `scroll to index #${index}`,
     setColumnToValue: (column, value) => `set column ${column} to value ${value}`,
     setDatePickerDate: (dateString, dateFormat) => `set date picker date to ${dateString} using format ${dateFormat}`,

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "node16",
     "lib": ["es2022"],
     "target": "ES2022",
     "allowJs": true,

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-javadoc.jar.md5

@@ -1 +0,0 @@
-d186084aecacd72fb090ddb8b6e95039

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-javadoc.jar.sha1

@@ -1 +0,0 @@
-862c5158e6d2f299fb84d31bb91701cd2a957a84

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-javadoc.jar.sha256

@@ -1 +0,0 @@
-aac472f3c6a5695b08ce2a6f7f83927cbf4adb494316a64282e44c8dc6b91bf7

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-javadoc.jar.sha512

@@ -1 +0,0 @@
-7d23fb7769a5f64a1232d9d6466fc08cdafb5f7e7b33027c6296c2ceb9d050daa4dd0c52e0da56da6d3bb87509a27d5789082bab919b0428fa94dc4e6d1601de

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-sources.jar.md5

@@ -1 +0,0 @@
-3f11c334abdbac1f62db3258cd97ccbd

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-sources.jar.sha1

@@ -1 +0,0 @@
-a66bc0bc574842d176d1da4a0c148aea8ef3507f

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-sources.jar.sha256

@@ -1 +0,0 @@
-5b57ac262feb204c4284d6c7e3c07ba3e49a4d3fb7eca4e902f0532dc8c47704

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0-sources.jar.sha512

@@ -1 +0,0 @@
-c9f2fb00f54efb71ef213625fff971b4c87c1df802c7b6006f6224f286c00e40cb31c672a99fbbb7e08c77cf9ab0793e8a0fc81bc56488c056492c8452a382d8

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.aar.md5

@@ -1 +0,0 @@
-c27920150917efb5b25878186e904fe0

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.aar.sha1

@@ -1 +0,0 @@
-ad9e12738ca3c82606a58bacea6d50b51687aee9

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.aar.sha256

@@ -1 +0,0 @@
-ab07c0011f9cee612e5b56ea42618978b75a5cfff9841766fc3f796e730c3571

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.aar.sha512

@@ -1 +0,0 @@
-a26f964a1ef775262740a23fbbeca9e5754a5da7896bcab22a476f684d40168b67ad4a97087a1f6fe484343e70eb32063adfeac3a2879f887e8d7fc616e6eacc

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.pom.md5

@@ -1 +0,0 @@
-5252ce03ecdbc8c6e367a4a6c9f308ca

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.pom.sha1

@@ -1 +0,0 @@
-7d885823adf8e1d2217ab89909d53fbc9acb23de

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.pom.sha256

@@ -1 +0,0 @@
-a0c47342c3898b2cfe040146683d58d022bca2606d676003dfac59be11cbca05

package/Detox-android/com/wix/detox/20.15.0-prerelease.0/detox-20.15.0-prerelease.0.pom.sha512

@@ -1 +0,0 @@
-6ab3dd11adfba07baeb98509a3c0e86718a00eeee5b2470429dc10e79e22b74b579a3d5ff06fcc1375f999e5e7a676a3cf49e8a570dd04b6666c63675a1196e1