detox 20.1.0-next-is-hittable-check.0 → 20.1.0

package/runners/jest/testEnvironment/listeners/SpecReporter.js

@@ -1,4 +1,5 @@
 const chalk = require('chalk').default;
+const noop = require('lodash/noop');
 
 const { config, log, session } = require('../../../../internals');
 const { traceln } = require('../utils/stdout');
@@ -15,16 +16,21 @@ class SpecReporter {
     this._suitesDesc = '';
   }
 
-  get enabled() {
+  setup() {
     const jestSection = config.testRunner.jest;
     const reportSpecs = jestSection && jestSection.reportSpecs;
-
-    return reportSpecs !== undefined ? reportSpecs : session.workersCount === 1;
+    const enabled = reportSpecs !== undefined ? reportSpecs : session.workersCount === 1;
+
+    if (!enabled) {
+      this.run_describe_start = noop;
+      this.run_describe_finish = noop;
+      this.test_start = noop;
+      this.test_done = noop;
+      this.test_skip = noop;
+    }
   }
 
   run_describe_start(event) {
-    if (!this.enabled) return;
-
     if (event.describeBlock.parent !== undefined) {
       this._onSuiteStart({
         description: event.describeBlock.name,
@@ -33,16 +39,12 @@ class SpecReporter {
   }
 
   run_describe_finish(event) {
-    if (!this.enabled) return;
-
     if (event.describeBlock.parent !== undefined) {
       this._onSuiteEnd();
     }
   }
 
   test_start(event) {
-    if (!this.enabled) return;
-
     const { test } = event;
     this._onTestStart({
       description: test.name,
@@ -51,8 +53,6 @@ class SpecReporter {
   }
 
   test_done(event) {
-    if (!this.enabled) return;
-
     const { test } = event;
     const testInfo = {
       description: test.name,
@@ -62,8 +62,6 @@ class SpecReporter {
   }
 
   test_skip(event) {
-    if (!this.enabled) return;
-
     const testInfo = {
       description: event.test.name,
     };
@@ -110,7 +108,7 @@ class SpecReporter {
         .concat(suite.description)
         .concat((index === total - 1) ? ': ' : '');
     });
-    this._suitesDesc = chalk.bold.white(this._suitesDesc);
+    this._suitesDesc = chalk.bold(this._suitesDesc);
   }
 
   _traceTest({ description, invocations }, _status = undefined) {

package/runners/jest/testEnvironment/listeners/WorkerAssignReporter.js

@@ -13,7 +13,7 @@ class WorkerAssignReporter {
 
   run_start() {
     if (config.testRunner.jest.reportWorkerAssign) {
-      log.info({ cat: 'lifecycle' }, `${this._formatTestName()} is assigned to ${this._formatDeviceName()}`);
+      log.info({ cat: 'lifecycle' }, `${chalk.bold(this._testName)} is assigned to ${this._formatDeviceName()}`);
     }
   }
 
@@ -25,10 +25,6 @@ class WorkerAssignReporter {
 
     return formattedDeviceName;
   }
-
-  _formatTestName() {
-    return chalk.whiteBright(this._testName);
-  }
 }
 
 module.exports = WorkerAssignReporter;

package/runners/jest/testEnvironment/utils/assertJestCircus27.js

@@ -1,8 +1,10 @@
 const fs = require('fs');
 const path = require('path');
 
+const resolveFrom = require('resolve-from');
 const semver = require('semver');
 
+const { log } = require('../../../../internals');
 const detoxPackageJson = require('../../../../package.json');
 const { DetoxRuntimeError } = require('../../../../src/errors');
 
@@ -25,6 +27,10 @@ function assertJestCircus27(maybeProjectConfig) {
     });
   }
 
+  const jestManifestPath = resolveFrom(process.cwd(), 'jest/package.json');
+  const jestManifest = require(jestManifestPath);
+  assertSupportedVersion(jestManifest.version);
+
   const circusVersion = require(circusPackageJson).version;
   if (!circusVersion) {
     throw new DetoxRuntimeError({
@@ -33,7 +39,14 @@ function assertJestCircus27(maybeProjectConfig) {
     });
   }
 
-  assertSupportedVersion(circusVersion);
+  if (jestManifest.version !== circusVersion) {
+    log.warn([
+      `jest-circus@${circusVersion} does not match jest@${jestManifest.version}.\n`,
+      `- jest@${jestManifest.version} resolved path:\n\t${jestManifestPath}`,
+      `- jest-circus@${circusVersion} resolved path:\n\t${circusPackageJson}`,
+      `\nPlease make sure that your versions match to avoid unexpected behavior!`,
+    ].join('\n'));
+  }
 
   return maybeProjectConfig;
 }
@@ -41,11 +54,12 @@ function assertJestCircus27(maybeProjectConfig) {
 function assertSupportedVersion(actualVersion) {
   const supportedRange = detoxPackageJson.peerDependencies.jest;
   const minSupportedVersion = semver.minVersion(supportedRange);
+  const action = semver.lt(actualVersion, minSupportedVersion) ? 'upgrade' : 'downgrade';
 
-  if (semver.lt(actualVersion, minSupportedVersion)) {
+  if (!semver.satisfies(actualVersion, supportedRange, { includePrerelease: true })) {
     throw new DetoxRuntimeError({
       message: `Detected an unsupported jest@${actualVersion} version.`,
-      hint: `Please upgrade your Jest test runner to the supported range: ${supportedRange}.`
+      hint: `Please ${action} your Jest test runner to the supported range: ${supportedRange}.`
     });
   }
 }

package/src/DetoxWorker.js

@@ -1,3 +1,4 @@
+const CAF = require('caf');
 const _ = require('lodash');
 
 const Client = require('./client/Client');
@@ -11,7 +12,7 @@ const uuid = require('./utils/uuid');
 class DetoxWorker {
   constructor(context) {
     this._context = context;
-    this._isCleaningUp = false;
+    this._injectedGlobalProperties = [];
     this._config = context[symbols.config];
     this._runtimeErrorComposer = new DetoxRuntimeErrorComposer(this._config);
     this._client = null;
@@ -32,6 +33,18 @@ class DetoxWorker {
       onError: this._onEmitError.bind(this),
     });
 
+
+    /** @type {DetoxInternals.RuntimeConfig['apps']} */
+    this._appsConfig = null;
+    /** @type {DetoxInternals.RuntimeConfig['artifacts']} */
+    this._artifactsConfig = null;
+    /** @type {DetoxInternals.RuntimeConfig['behavior']} */
+    this._behaviorConfig = null;
+    /** @type {DetoxInternals.RuntimeConfig['device']} */
+    this._deviceConfig = null;
+    /** @type {DetoxInternals.RuntimeConfig['session']} */
+    this._sessionConfig = null;
+
     /** @type {string} */
     this.id = 'worker';
     /** @type {Detox.Device} */
@@ -53,11 +66,23 @@ class DetoxWorker {
     this.trace = this._context.trace;
     /** @deprecated */
     this.traceCall = this._context.traceCall;
-  }
 
-  async init() {
-    if (this._isCleaningUp) return;
+    this._reinstallAppsOnDevice = CAF(this._reinstallAppsOnDevice.bind(this));
+    this._initToken = new CAF.cancelToken();
+
+    this._cafWrap([
+      'init',
+      'onRunDescribeStart',
+      'onTestStart',
+      'onHookFailure',
+      'onTestFnFailure',
+      'onTestDone',
+      'onRunDescribeFinish',
+    ]);
+  }
 
+  /** @this {DetoxWorker} */
+  init = function* (signal) {
     const {
       apps: appsConfig,
       artifacts: artifactsConfig,
@@ -71,6 +96,7 @@ class DetoxWorker {
     this._behaviorConfig = behaviorConfig;
     this._deviceConfig = deviceConfig;
     this._sessionConfig = sessionConfig;
+    // @ts-ignore
     this._sessionConfig.sessionId = sessionConfig.sessionId || uuid.UUID();
     this._runtimeErrorComposer.appsConfig = this._appsConfig;
 
@@ -82,8 +108,7 @@ class DetoxWorker {
       }
     };
 
-    await this._client.connect();
-    if (this._isCleaningUp) return;
+    yield this._client.connect();
 
     const invocationManager = new InvocationManager(this._client);
 
@@ -100,8 +125,7 @@ class DetoxWorker {
     } = environmentFactory.createFactories(this._deviceConfig);
 
     const envValidator = envValidatorFactory.createValidator();
-    await envValidator.validate();
-    if (this._isCleaningUp) return;
+    yield envValidator.validate();
 
     const commonDeps = {
       invocationManager,
@@ -112,8 +136,7 @@ class DetoxWorker {
 
     this._artifactsManager = artifactsManagerFactory.createArtifactsManager(this._artifactsConfig, commonDeps);
     this._deviceAllocator = deviceAllocatorFactory.createDeviceAllocator(commonDeps);
-    this._deviceCookie = await this._deviceAllocator.allocate(this._deviceConfig);
-    if (this._isCleaningUp) return;
+    this._deviceCookie = yield this._deviceAllocator.allocate(this._deviceConfig);
 
     this.device = runtimeDeviceFactory.createRuntimeDevice(
       this._deviceCookie,
@@ -124,7 +147,6 @@ class DetoxWorker {
         deviceConfig: this._deviceConfig,
         sessionConfig,
       });
-    if (this._isCleaningUp) return;
 
     const matchers = matchersFactory.createMatchers({
       invocationManager,
@@ -134,34 +156,37 @@ class DetoxWorker {
     Object.assign(this, matchers);
 
     if (behaviorConfig.init.exposeGlobals) {
-      Object.assign(DetoxWorker.global, {
+      const injectedGlobals = {
         ...matchers,
         device: this.device,
         detox: this,
-      });
+      };
+
+      this._injectedGlobalProperties = Object.keys(injectedGlobals);
+      Object.assign(DetoxWorker.global, injectedGlobals);
     }
 
     // @ts-ignore
-    await this.device.installUtilBinaries();
-    if (this._isCleaningUp) return;
+    yield this.device.installUtilBinaries();
 
     if (behaviorConfig.init.reinstallApp) {
-      await this._reinstallAppsOnDevice();
-      if (this._isCleaningUp) return;
+      yield this._reinstallAppsOnDevice(signal);
     }
 
     const appAliases = Object.keys(this._appsConfig);
     if (appAliases.length === 1) {
-      await this.device.selectApp(appAliases[0]);
+      yield this.device.selectApp(appAliases[0]);
     } else {
-      await this.device.selectApp(null);
+      yield this.device.selectApp(null);
     }
-
-    return this;
-  }
+  };
 
   async cleanup() {
-    this._isCleaningUp = true;
+    this._initToken.abort('CLEANUP');
+
+    for (const key of this._injectedGlobalProperties) {
+      delete DetoxWorker.global[key];
+    }
 
     if (this._artifactsManager) {
       await this._artifactsManager.onBeforeCleanup();
@@ -190,38 +215,45 @@ class DetoxWorker {
     return this._context.log;
   }
 
-  onRunDescribeStart = async (...args) => this._artifactsManager.onRunDescribeStart(...args);
-  onTestStart = async (testSummary) => {
-    if (this._isCleaningUp) return;
+  onRunDescribeStart = function* (_signal, ...args) {
+    yield this._artifactsManager.onRunDescribeStart(...args);
+  };
+
+  onTestStart = function* (_signal, testSummary) {
     this._validateTestSummary('beforeEach', testSummary);
 
-    if (this._isCleaningUp) return;
-    await this._dumpUnhandledErrorsIfAny({
+    yield this._dumpUnhandledErrorsIfAny({
       pendingRequests: false,
       testName: testSummary.fullName,
     });
 
-    if (this._isCleaningUp) return;
-    await this._artifactsManager.onTestStart(testSummary);
+    yield this._artifactsManager.onTestStart(testSummary);
+  };
+
+  onHookFailure = function* (_signal, ...args) {
+    yield this._artifactsManager.onHookFailure(...args);
   };
-  onHookFailure = async (...args) => this._artifactsManager.onHookFailure(...args);
-  onTestFnFailure = async (...args) => this._artifactsManager.onTestFnFailure(...args);
-  onTestDone = async (testSummary) => {
-    if (this._isCleaningUp) return;
+
+  onTestFnFailure = function* (_signal, ...args) {
+    yield this._artifactsManager.onTestFnFailure(...args);
+  };
+
+  onTestDone = function* (_signal, testSummary) {
     this._validateTestSummary('afterEach', testSummary);
 
-    if (this._isCleaningUp) return;
-    await this._artifactsManager.onTestDone(testSummary);
+    yield this._artifactsManager.onTestDone(testSummary);
 
-    if (this._isCleaningUp) return;
-    await this._dumpUnhandledErrorsIfAny({
+    yield this._dumpUnhandledErrorsIfAny({
       pendingRequests: testSummary.timedOut,
       testName: testSummary.fullName,
     });
   };
-  onRunDescribeFinish = async (...args) => this._artifactsManager.onRunDescribeFinish(...args);
 
-  async _reinstallAppsOnDevice() {
+  onRunDescribeFinish = function* (_signal, ...args) {
+    yield this._artifactsManager.onRunDescribeFinish(...args);
+  };
+
+  *_reinstallAppsOnDevice(_signal) {
     const appNames = _(this._appsConfig)
       .map((config, key) => [key, `${config.binaryPath}:${config.testBinaryPath}`])
       .uniqBy(1)
@@ -229,17 +261,13 @@ class DetoxWorker {
       .value();
 
     for (const appName of appNames) {
-      await this.device.selectApp(appName);
-      if (this._isCleaningUp) return;
-      await this.device.uninstallApp();
-      if (this._isCleaningUp) return;
+      yield this.device.selectApp(appName);
+      yield this.device.uninstallApp();
     }
 
     for (const appName of appNames) {
-      await this.device.selectApp(appName);
-      if (this._isCleaningUp) return;
-      await this.device.installApp();
-      if (this._isCleaningUp) return;
+      yield this.device.selectApp(appName);
+      yield this.device.installApp();
     }
   }
 
@@ -271,10 +299,28 @@ class DetoxWorker {
       error
     );
   }
+
+  _cafWrap(methodNames) {
+    for (const methodName of methodNames) {
+      const cafMethod = CAF(this[methodName].bind(this));
+      this[methodName] = async (...args) => {
+        try {
+          await cafMethod(this._initToken.signal, ...args);
+        } catch (e) {
+          if (e !== 'CLEANUP') {
+            throw e;
+          }
+        }
+
+        return this;
+      };
+    }
+  }
+
 }
 
 /**
- * @type {NodeJS.Global}
+ * @type {NodeJS.Global | {}}
  */
 DetoxWorker.global = global;
 

package/src/android/interactions/native.js

@@ -1,6 +1,7 @@
 const DetoxRuntimeError = require('../../errors/DetoxRuntimeError');
 const { expectDescription, actionDescription } = require('../../utils/invocationTraceDescriptions');
-const { trace } = require('../../utils/trace');
+const log = require('../../utils/logger').child({ cat: 'ws-client, ws' });
+const traceInvocationCall = require('../../utils/traceInvocationCall').bind(null, log);
 const { ScrollAmountStopAtEdgeAction } = require('../actions/native');
 const { NativeMatcher } = require('../core/NativeMatcher');
 const DetoxAssertionApi = require('../espressoapi/DetoxAssertion');
@@ -18,7 +19,7 @@ class Interaction {
   }
 
   async execute() {
-    return trace.invocationCall(this._traceDescription, this._call,
+    return traceInvocationCall(this._traceDescription, this._call,
       this._invocationManager.execute(this._call).then((resultObj) => resultObj ? resultObj.result : undefined));
   }
 }

package/src/artifacts/ArtifactsManager.js

@@ -46,13 +46,13 @@ class ArtifactsManager extends EventEmitter {
   _resolveArtifactsPathBuilder(pathBuilder, rootDir) {
     if (typeof pathBuilder === 'string') {
       pathBuilder = resolveModuleFromPath(pathBuilder);
+    }
 
-      if (typeof pathBuilder === 'function') {
-        try {
-          pathBuilder = pathBuilder({ rootDir });
-        } catch (e) {
-          pathBuilder = new pathBuilder({ rootDir });
-        }
+    if (typeof pathBuilder === 'function') {
+      try {
+        pathBuilder = pathBuilder({ rootDir });
+      } catch (e) {
+        pathBuilder = new pathBuilder({ rootDir });
       }
     }
 

package/src/artifacts/utils/temporaryPath.js

@@ -1,14 +1,42 @@
 const path = require('path');
+const { promisify } = require('util');
 
+const glob = require('glob');
 const tempfile = require('tempfile');
 
+const { useForwardSlashes } = require('../../utils/shellUtils');
+
+const globSync = glob.sync;
+const globAsync = promisify(glob);
+
+function getRoot() {
+  return path.dirname(tempfile());
+}
+
+function createGlobber(ext) {
+  const fullExt = `.detox.${ext}`;
+
+  return {
+    sync: (pattern) => {
+      const cwd = getRoot();
+      const files = globSync(useForwardSlashes(pattern + fullExt), { cwd });
+      return files.map(f => path.join(cwd, f));
+    },
+    async: async (pattern) => {
+      const cwd = getRoot();
+      const files = await globAsync(useForwardSlashes(pattern + fullExt), { cwd });
+      return files.map(f => path.join(cwd, f));
+    },
+  };
+}
+
 function createTempFileBuilderFn(fileExtension) {
   /**
    * @param {string} [basename]
    */
   return (basename) => {
     return basename
-      ? path.join(path.dirname(tempfile()), `${basename}.detox.${fileExtension}`)
+      ? path.join(getRoot(), `${basename}.detox.${fileExtension}`)
       : tempfile(`.detox.${fileExtension}`);
   };
 }
@@ -23,5 +51,7 @@ module.exports = {
     dtxrec: createTempFileBuilderFn('dtxrec'),
     viewhierarchy: createTempFileBuilderFn('viewhierarchy'),
   },
-  mask: () => path.join(tempfile(), '..') + path.sep + '*.detox.*',
+  find: {
+    jsonl: createGlobber('jsonl'),
+  },
 };

package/src/client/actions/SyncStatusSchema.json

@@ -232,6 +232,27 @@
                 ],
                 "additionalProperties":false
               },
+              {
+                "properties":{
+                  "name":{
+                    "const":"bg"
+                  },
+                  "description":{
+                    "type":"object",
+                    "properties":{
+                      "reason":{
+                        "type":"string"
+                      }
+                    },
+                    "additionalProperties":false
+                  }
+                },
+                "required":[
+                  "name",
+                  "description"
+                ],
+                "additionalProperties":false
+              },
               {
                 "properties":{
                   "name":{

package/src/client/actions/formatters/SyncStatusFormatter.js

@@ -4,6 +4,7 @@ const Ajv = require('ajv');
 const DetoxInternalError = require('../../../errors/DetoxInternalError');
 const statusSchema = require('../SyncStatusSchema.json');
 
+const bgThreadFormatter = require('./sync-resources/BgThreadFormatter');
 const delayedPerformSelectorFormatter = require('./sync-resources/DelayedPerformSelectorFormatter');
 const dispatchQueueFormatter = require('./sync-resources/DispatchQueueFormatter');
 const jsTimersFormatter = require('./sync-resources/JavaScriptTimersFormatter');
@@ -51,6 +52,7 @@ function resourcesDescriptionsFromJSON(jsonDescriptions) {
 }
 
 const resourceFormatters = {
+  bg: bgThreadFormatter,
   delayed_perform_selector: delayedPerformSelectorFormatter,
   dispatch_queue: dispatchQueueFormatter,
   run_loop: runLoopFormatter,

package/src/client/actions/formatters/sync-resources/BgThreadFormatter.js

@@ -0,0 +1,5 @@
+const { makeResourceTitle } = require('./utils');
+
+module.exports = function(properties) {
+  return `${makeResourceTitle(`Background work taking place in ${properties.reason}.`)}`;
+};

package/src/configuration/collectCliConfig.js

@@ -1,9 +1,6 @@
 const _ = require('lodash');
 
 const argparse = require('../utils/argparse');
-const log = require('../utils/logger').child({ cat: 'config' });
-
-const { DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION } = require('./utils/warnings');
 
 const asBoolean = (value) => {
   if (typeof value === 'boolean') {
@@ -25,14 +22,6 @@ const asNumber = (value) => {
     : undefined;
 };
 
-const deprecateDeviceLaunchArgs = (value) => {
-  if (value) {
-    log.warn(DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION);
-  }
-
-  return value;
-};
-
 function collectCliConfig({ argv }) {
   const env = (key) => argparse.getArgValue(key);
   const get = (key, fallback) => {
@@ -51,7 +40,7 @@ function collectCliConfig({ argv }) {
     configPath: get('config-path'),
     configuration: get('configuration'),
     debugSynchronization: asNumber(get('debug-synchronization')),
-    deviceBootArgs: get('device-boot-args', deprecateDeviceLaunchArgs(argparse.getEnvValue('device-launch-args'))),
+    deviceBootArgs: get('device-boot-args'),
     appLaunchArgs: get('app-launch-args'),
     deviceName: get('device-name'),
     forceAdbInstall: asBoolean(get('force-adb-install')),

package/src/configuration/composeRunnerConfig.js

@@ -91,7 +91,7 @@ function adaptLegacyRunnerConfig(globalConfig) {
     return globalConfig.testRunner;
   }
 
-  log.warn(`Please migrate your Detox config according to the guide:\nhttps://wix.github.io/Detox/docs/next/guide/migration\n`);
+  log.warn(`Please migrate your Detox config according to the guide:\nhttps://wix.github.io/Detox/docs/guide/migration\n`);
   const testRunner = globalConfig[testRunnerKey];
   const runnerConfig = globalConfig[runnerConfigKey];
   const specs = globalConfig.specs != null ? String(globalConfig.specs) : undefined;
@@ -120,9 +120,10 @@ function hasEmptyPositionalArgs(value, key) {
  * @param {Detox.DetoxTestRunnerConfig} config
  */
 function inspectBrkHookDefault(config) {
-  config.args.$0 = /* istanbul ignore if */ os.platform() === 'win32'
-    ? `node --inspect-brk ./node_modules/jest/bin/jest.js`
-    : `node --inspect-brk ./node_modules/.bin/jest`;
+  /* istanbul ignore next */
+  config.args.$0 = os.platform() !== 'win32'
+    ? `node --inspect-brk ./node_modules/.bin/jest`
+    : `node --inspect-brk ./node_modules/jest/bin/jest.js`;
   config.args.runInBand = true;
   delete config.args.w;
   delete config.args.workers;

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

@@ -36,7 +36,7 @@ class EmulatorLauncher extends DeviceLauncher {
         retries: 2,
         interval: 100,
         conditionFn: isUnknownEmulatorError,
-      }, () => this._launchEmulator(avdName, launchCommand));
+      }, () => this._launchEmulator(avdName, launchCommand, adbName));
     }
     await this._awaitEmulatorBoot(adbName);
     await this._notifyBootEvent(adbName, avdName, !isRunning);
@@ -60,8 +60,8 @@ class EmulatorLauncher extends DeviceLauncher {
     await this._notifyShutdownCompleted(adbName);
   }
 
-  _launchEmulator(emulatorName, launchCommand) {
-    return launchEmulatorProcess(emulatorName, this._emulatorExec, launchCommand);
+  _launchEmulator(emulatorName, launchCommand, adbName) {
+    return launchEmulatorProcess(emulatorName, this._emulatorExec, launchCommand, this._adb, adbName);
   }
 
   async _awaitEmulatorBoot(adbName) {