detox 20.14.0-smoke.0 → 20.14.0

package/src/configuration/composeRunnerConfig.js

@@ -32,6 +32,7 @@ function composeRunnerConfig(opts) {
       retries: 0,
       inspectBrk: inspectBrkHookDefault,
       forwardEnv: false,
+      detached: false,
       bail: false,
       jest: {
         setupTimeout: 300000,
@@ -56,8 +57,9 @@ function composeRunnerConfig(opts) {
 
   if (typeof merged.inspectBrk === 'function') {
     if (cliConfig.inspectBrk) {
-      merged.retries = 0;
+      merged.detached = false;
       merged.forwardEnv = true;
+      merged.retries = 0;
       merged.inspectBrk(merged);
     }
 

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

@@ -20,12 +20,10 @@ class SimulatorAllocDriver {
    * @param {import('../../DeviceRegistry')} options.deviceRegistry
    * @param {DetoxInternals.RuntimeConfig} options.detoxConfig
    * @param {import('../../../common/drivers/ios/tools/AppleSimUtils')} options.applesimutils
-   * @param {import('./SimulatorLauncher')} options.simulatorLauncher
    */
-  constructor({ detoxConfig, deviceRegistry, applesimutils, simulatorLauncher }) {
+  constructor({ detoxConfig, deviceRegistry, applesimutils }) {
     this._deviceRegistry = deviceRegistry;
     this._applesimutils = applesimutils;
-    this._simulatorLauncher = simulatorLauncher;
     this._launchInfo = {};
     this._shouldShutdown = detoxConfig.behavior.cleanup.shutdownDevice;
   }
@@ -61,7 +59,7 @@ class SimulatorAllocDriver {
   async postAllocate(deviceCookie) {
     const { udid } = deviceCookie;
     const { deviceConfig } = this._launchInfo[udid];
-    await this._simulatorLauncher.launch(udid, deviceConfig.type, deviceConfig.bootArgs, deviceConfig.headless);
+    await this._applesimutils.boot(udid, deviceConfig.bootArgs, deviceConfig.headless);
 
     return {
       id: udid,
@@ -105,7 +103,7 @@ class SimulatorAllocDriver {
    */
   async _doShutdown(udid) {
     try {
-      await this._simulatorLauncher.shutdown(udid);
+      await this._applesimutils.shutdown(udid);
     } catch (err) {
       log.warn({ err }, `Failed to shutdown simulator ${udid}`);
     }

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

@@ -9,11 +9,8 @@ class IosSimulator extends DeviceAllocatorFactory {
     const DeviceRegistry = require('../../../devices/allocation/DeviceRegistry');
     const deviceRegistry = new DeviceRegistry({ sessionId: detoxSession.id });
 
-    const SimulatorLauncher = require('../drivers/ios/SimulatorLauncher');
-    const simulatorLauncher = new SimulatorLauncher({ applesimutils, eventEmitter });
-
     const SimulatorAllocDriver = require('../drivers/ios/SimulatorAllocDriver');
-    return new SimulatorAllocDriver({ detoxConfig, deviceRegistry, applesimutils, simulatorLauncher });
+    return new SimulatorAllocDriver({ detoxConfig, deviceRegistry, applesimutils });
   }
 }
 

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

@@ -1,6 +1,7 @@
 const _ = require('lodash');
 
 const { encodeBase64 } = require('../../../../../utils/encoding');
+const { autoEscape } = require('../../../../../utils/shellUtils');
 
 const reservedInstrumentationArgs = new Set(['class', 'package', 'func', 'unit', 'size', 'perf', 'debug', 'log', 'emma', 'coverageFile']);
 const isReservedInstrumentationArg = (arg) => reservedInstrumentationArgs.has(arg);
@@ -17,7 +18,8 @@ function prepareInstrumentationArgs(args) {
       valueEncoded = encodeBase64(valueAsString);
     }
 
-    result.push('-e', key, valueEncoded);
+    const valueEscaped = hasLegacyIssues(key) ? valueEncoded : autoEscape.shell(valueEncoded);
+    result.push('-e', key, valueEscaped);
     return result;
   }, []);
 
@@ -27,6 +29,10 @@ function prepareInstrumentationArgs(args) {
   };
 }
 
+function hasLegacyIssues(key) {
+  return key === 'detoxURLBlacklistRegex';
+}
+
 module.exports = {
   prepareInstrumentationArgs,
 };

package/src/devices/runtime/drivers/ios/SimulatorDriver.js

@@ -14,7 +14,6 @@ const IosDriver = require('./IosDriver');
 
 /**
  * @typedef SimulatorDriverDeps { DeviceDriverDeps }
- * @property simulatorLauncher { SimulatorLauncher }
  * @property applesimutils { AppleSimUtils }
  */
 
@@ -38,7 +37,6 @@ class SimulatorDriver extends IosDriver {
     this._bootArgs = bootArgs;
     this._headless = headless;
     this._deviceName = `${udid} (${this._type})`;
-    this._simulatorLauncher = deps.simulatorLauncher;
     this._applesimutils = deps.applesimutils;
   }
 
@@ -150,9 +148,12 @@ class SimulatorDriver extends IosDriver {
   }
 
   async resetContentAndSettings() {
-    await this._simulatorLauncher.shutdown(this.udid);
+    await this.emitter.emit('beforeShutdownDevice', { deviceId: this.udid });
+    await this._applesimutils.shutdown(this.udid);
+    await this.emitter.emit('shutdownDevice', { deviceId: this.udid });
     await this._applesimutils.resetContentAndSettings(this.udid);
-    await this._simulatorLauncher.launch(this.udid, this._type, this._bootArgs, this._headless);
+    await this._applesimutils.boot(this.udid, this._bootArgs, this._headless);
+    await this.emitter.emit('bootDevice', { deviceId: this.udid });
   }
 
   getLogsPaths() {

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

@@ -7,11 +7,9 @@ class RuntimeDriverFactoryIos extends RuntimeDeviceFactory {
     const AppleSimUtils = require('../../../devices/common/drivers/ios/tools/AppleSimUtils');
     const applesimutils = new AppleSimUtils();
 
-    const SimulatorLauncher = require('../../allocation/drivers/ios/SimulatorLauncher');
     return {
       ...commonDeps,
       applesimutils,
-      simulatorLauncher: new SimulatorLauncher({ applesimutils, eventEmitter }),
     };
   }
 }

package/src/ipc/IPCClient.js

@@ -86,8 +86,8 @@ class IPCClient {
     this._sessionState.patch(sessionState);
   }
 
-  async conductEarlyTeardown() {
-    const sessionState = await this._emit('conductEarlyTeardown', {});
+  async conductEarlyTeardown({ permanent }) {
+    const sessionState = await this._emit('conductEarlyTeardown', { permanent });
     this._sessionState.patch(sessionState);
   }
 

package/src/ipc/IPCServer.js

@@ -73,6 +73,7 @@ class IPCServer {
     this._ipc.server.emit(socket, 'registerContextDone', {
       testResults: this._sessionState.testResults,
       testSessionIndex: this._sessionState.testSessionIndex,
+      unsafe_earlyTeardown: this._sessionState.unsafe_earlyTeardown,
     });
   }
 
@@ -90,10 +91,11 @@ class IPCServer {
     }
   }
 
-  onConductEarlyTeardown(_data = null, socket = null) {
-    // Note that we don't save `unsafe_earlyTeardown` in the primary session state
-    // because it's transient and needed only to make the workers quit early.
+  onConductEarlyTeardown({ permanent }, socket = null) {
     const newState = { unsafe_earlyTeardown: true };
+    if (permanent) {
+      Object.assign(this._sessionState, newState);
+    }
 
     if (socket) {
       this._ipc.server.emit(socket, 'conductEarlyTeardownDone', newState);

package/src/realms/DetoxContext.js

@@ -102,7 +102,7 @@ class DetoxContext {
   /** @abstract */
   [symbols.reportTestResults](_testResults) {}
   /** @abstract */
-  [symbols.conductEarlyTeardown]() {}
+  [symbols.conductEarlyTeardown](_permanent) {}
   /**
    * @abstract
    * @param {Partial<DetoxInternals.DetoxInitOptions>} _opts

package/src/realms/DetoxPrimaryContext.js

@@ -51,9 +51,9 @@ class DetoxPrimaryContext extends DetoxContext {
     }
   }
 
-  [symbols.conductEarlyTeardown] = async () => {
+  [symbols.conductEarlyTeardown] = async (permanent = false) => {
     if (this[_ipcServer]) {
-      await this[_ipcServer].onConductEarlyTeardown();
+      await this[_ipcServer].onConductEarlyTeardown({ permanent });
     }
   };
 

package/src/realms/DetoxSecondaryContext.js

@@ -33,9 +33,9 @@ class DetoxSecondaryContext extends DetoxContext {
     }
   }
 
-  [symbols.conductEarlyTeardown] = async () => {
+  [symbols.conductEarlyTeardown] = async (permanent = false) => {
     if (this[_ipcClient]) {
-      await this[_ipcClient].conductEarlyTeardown();
+      await this[_ipcClient].conductEarlyTeardown({ permanent });
     } else {
       throw new DetoxInternalError('Detected an attempt to report early teardown using a non-initialized context.');
     }

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/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

@@ -15,6 +15,9 @@
   },
   "rootDir": ".",
   "include": [
+    "detox.d.ts",
+    "globals.d.ts",
+    "index.d.ts",
     "**/*.js",
     "**/*.ts"
   ],

package/Detox-android/com/wix/detox/20.14.0-smoke.0/detox-20.14.0-smoke.0-javadoc.jar.md5

@@ -1 +0,0 @@
-0c2bae26c123edf10cb62b77d5e5acdd

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

@@ -1 +0,0 @@
-96b7351396c83931de86925d213b5bc9d12a827d

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

@@ -1 +0,0 @@
-dbe5afc9df9a7c857a961781ebd58be8cf1d82c39771819b6c801f36b44434d4

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

@@ -1 +0,0 @@
-8e4f2278448ac644826386e11b95b24f44037c1483f0bae0c1347dfc0a01783e058f9b229b5d9e217f8be08984ff0035a8a9a028503f672f2baff523d3dc037c

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

@@ -1 +0,0 @@
-4db28745d12fb52a9b94eefe7aef7c6d

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

@@ -1 +0,0 @@
-5101597e82e164ba10f7ecd0e15ee7a4316fdccc

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

@@ -1 +0,0 @@
-e7bc12d7cbefc0831194c059a2b62166bfda3a63e9e34d212418eed88155462f

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

@@ -1 +0,0 @@
-6cc5ce462ef6068c314ffa8d8a06d6c091b819baa7d3d1b329bd6a907e3c7909db097fac66381b3833bbfcb3bd1226f5c1e511cad080b1e2a3a914ff91af6f61

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

@@ -1 +0,0 @@
-b8569c6d3b296face8b6d34037e27b6e

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

@@ -1 +0,0 @@
-fe831778fa7fbeffb2ccdbb15bf3200ec0e641b2

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

@@ -1 +0,0 @@
-305c99310501d83ad114e4357d1af6efccf8ff774ec5ad25a04f7d9921203225

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

@@ -1 +0,0 @@
-f02ad136e06b87c385b1ec7d8d9ad27259cdd2f9eec6dae79eb79eb9e7e78614b55bbb33773da61990ea5e594b0dff92c8013f5d3687c9c04710916e95d70418

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

@@ -1 +0,0 @@
-84130ea1d35084f1db1652765a011da8

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

@@ -1 +0,0 @@
-0dc75a3ca7a62dadea9abdd8c20d8cade91ff0ad

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

@@ -1 +0,0 @@
-cc11f65f610d8f9cc708b0295e6998ee7e819ae7dc34d9f54586790ee253d4b2

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

@@ -1 +0,0 @@
-592a6a8c132c98bb7e7cb531ec495cb83bd4bc004fd8388f361199359c293d10169e9af1a771efd9d79db0e9e65d2dd75cb3d4aa9b32909c01dc561368165ea0

package/runners/jest/reporters/DetoxReporter.js

@@ -1,154 +0,0 @@
-const resolveFrom = require('resolve-from');
-/** @type {new (globalConfig: any) => import('@jest/reporters').VerboseReporter} */
-const JestVerboseReporter = require(resolveFrom(process.cwd(), '@jest/reporters')).VerboseReporter;
-/** @type {new (globalConfig: any) => import('@jest/reporters').SummaryReporter} */
-const SummaryReporter = require(resolveFrom(process.cwd(), '@jest/reporters')).SummaryReporter;
-
-const { config, reportTestResults, unsafe_conductEarlyTeardown, cleanup } = require('../../../internals');
-const Deferred = require('../../../src/utils/Deferred');
-
-class DetoxReporter extends JestVerboseReporter {
-  constructor(globalConfig) {
-    super(globalConfig);
-
-    /** @type {Deferred | null} */
-    this._lastRunComplete = null;
-    /** @type {Set<string>} */
-    this._pendingTestFiles = new Set();
-    /** @type {Promise<any> | null} */
-    this._runCompletePromise = null;
-    /** @type {import('@jest/reporters').SummaryReporter | null} */
-    this._summaryReporter = this._initSummaryReporter();
-  }
-
-  onRunStart(aggregatedResults, options) {
-    super.onRunStart(aggregatedResults, options);
-
-    if (this._summaryReporter) {
-      this._summaryReporter.onRunStart(aggregatedResults, options);
-    }
-  }
-
-  onTestFileStart(test) {
-    this._pendingTestFiles.add(test.path);
-
-    // @ts-ignore Precaution in case Jest migrates to the new signature
-    if (typeof super.onTestFileStart === 'function') {
-      // @ts-ignore
-      super.onTestFileStart(test);
-    } else {
-      super.onTestStart(test);
-    }
-  }
-
-  onTestFileResult(test, testResult, aggregatedResult) {
-    this._pendingTestFiles.delete(test.path);
-
-    // @ts-ignore Precaution in case Jest migrates to the new signature
-    if (typeof super.onTestFileResult === 'function') {
-      // @ts-ignore
-      super.onTestFileResult(test, testResult, aggregatedResult);
-    } else {
-      super.onTestResult(test, testResult, aggregatedResult);
-    }
-
-    if (this._lastRunComplete && this._pendingTestFiles.size === 0) {
-      this._lastRunComplete.resolve(aggregatedResult);
-    }
-  }
-
-  /**
-   * @param {Set<import('@jest/reporters').TestContext>} testContexts
-   * @param {import('@jest/reporters').AggregatedResult} aggregatedResult
-   * @returns {Promise<any> | null}
-   */
-  // @ts-ignore We need to use the complete signature, not the one from the base class
-  onRunComplete(testContexts, aggregatedResult) {
-    if (!this._runCompletePromise) {
-      // Both `_lastRunComplete` and `_runCompletePromise` are used to prevent
-      // a bug in Jest, where `onRunComplete` is called multiple times when
-      // Jest runs with `--bail` and multiple workers, and `onRunComplete`
-      // is implemented as an asynchronous long-running operation.
-      this._lastRunComplete = this._pendingTestFiles.size === 0
-        ? Deferred.resolved(aggregatedResult)
-        : new Deferred();
-
-      this._runCompletePromise = this._onRunComplete(testContexts, aggregatedResult).catch(err => {
-        console.error(err);
-        throw err;
-      });
-    }
-
-    return this._runCompletePromise;
-  }
-
-  /**
-   * @param {Set<import('@jest/reporters').TestContext>} testContexts
-   * @param {import('@jest/reporters').AggregatedResult} aggregatedResult
-   * @returns {Promise<any> | null}
-   */
-  async _onRunComplete(testContexts, { numFailedTests }) {
-    const bail = this._globalConfig.bail;
-    const earlyTeardown = bail > 0 && numFailedTests >= bail;
-    if (earlyTeardown) {
-      await unsafe_conductEarlyTeardown();
-    }
-
-    const aggregatedResult = await this._lastRunComplete.promise;
-    const lostTests = aggregatedResult.numTotalTestSuites - aggregatedResult.testResults.length;
-
-    // @ts-expect-error TS2554
-    super.onRunComplete(testContexts, aggregatedResult);
-
-    if (earlyTeardown && lostTests > 0 && config.testRunner.retries > 0) {
-      console.warn(
-        'Jest aborted the test execution before all scheduled test files have been reported.\n' +
-        'This brings us to a dilemma: retry the whole test run, or retry only known failed test files.\n' +
-        'Both options are bad in their own way, this is why we have decided to not support this edge case.\n' +
-        'If you want to retry the whole test run, please disable Jest\'s --bail option.'
-      );
-    }
-
-    await reportTestResults(aggregatedResult.testResults.map(r => ({
-      success: !r.failureMessage,
-      testFilePath: r.testFilePath,
-      testExecError: r.testExecError,
-      isPermanentFailure: lostTests > 0 || this._isPermanentFailure(r),
-    })));
-
-    if (this._summaryReporter) {
-      this._summaryReporter.onRunComplete(testContexts, aggregatedResult);
-    }
-
-    if (earlyTeardown) {
-      await cleanup();
-    }
-  }
-
-  /**
-   * @returns {import('@jest/reporters').SummaryReporter | null}
-   * @private
-   */
-  _initSummaryReporter() {
-    /** @type {(config: import('@jest/types').Config.ReporterConfig) => boolean} */
-    const isSummaryReporter = (config) => config[0] === 'summary';
-    if (this._globalConfig.reporters.some(isSummaryReporter)) {
-      return null;
-    }
-
-    return new SummaryReporter(this._globalConfig);
-  }
-
-  /**
-   * @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/allocation/drivers/ios/SimulatorLauncher.js

@@ -1,25 +0,0 @@
-class SimulatorLauncher {
-  constructor({ applesimutils, eventEmitter }) {
-    this._applesimutils = applesimutils;
-    this._eventEmitter = eventEmitter;
-  }
-
-  async launch(udid, type, bootArgs, headless) {
-    const coldBoot = await this._applesimutils.boot(udid, bootArgs, headless);
-    return coldBoot;
-  }
-
-  async shutdown(udid) {
-    if (this._eventEmitter) {
-      await this._eventEmitter.emit('beforeShutdownDevice', { deviceId: udid });
-    }
-
-    await this._applesimutils.shutdown(udid);
-
-    if (this._eventEmitter) {
-      await this._eventEmitter.emit('shutdownDevice', { deviceId: udid });
-    }
-  }
-}
-
-module.exports = SimulatorLauncher;