detox 19.13.0 → 20.0.0

package/local-cli/testCommand/TestRunnerCommand.js

@@ -0,0 +1,163 @@
+const cp = require('child_process');
+
+const _ = require('lodash');
+const parser = require('yargs-parser');
+const unparse = require('yargs-unparser');
+
+const detox = require('../../internals');
+const log = detox.log.child({ cat: ['lifecycle', 'cli'] });
+const { DetoxRuntimeError } = require('../../src/errors');
+const { printEnvironmentVariables, prependNodeModulesBinToPATH } = require('../../src/utils/envUtils');
+const { escapeSpaces } = require('../../src/utils/shellUtils');
+
+class TestRunnerCommand {
+  /*
+    @param {object} opts
+    @param {DetoxInternals.RuntimeConfig} opts.config
+    @param {ProcessEnv} opts.env
+  */
+  constructor(opts) {
+    const cliConfig = opts.config.cli;
+    const deviceConfig = opts.config.device;
+    const runnerConfig = opts.config.testRunner;
+
+    this._argv = runnerConfig.args;
+    this._retries = runnerConfig.retries;
+    this._envHint = this._buildEnvHint(opts.env);
+    this._envFwd = {};
+    if (runnerConfig.forwardEnv) {
+      this._envFwd = this._buildEnvOverride(cliConfig, deviceConfig);
+      Object.assign(this._envHint, this._envFwd);
+    }
+  }
+
+  async execute() {
+    let runsLeft = 1 + this._retries;
+    let launchError = null;
+
+    do {
+      try {
+        await this._spawnTestRunner();
+        launchError = null;
+      } catch (e) {
+        launchError = e;
+
+        const failedTestFiles = detox.session.testResults.filter(r => !r.success);
+
+        const { bail } = detox.config.testRunner;
+        if (bail && failedTestFiles.some(r => r.isPermanentFailure)) {
+          throw e;
+        }
+
+        const testFilesToRetry = failedTestFiles.filter(r => !r.isPermanentFailure).map(r => r.testFilePath);
+        if (_.isEmpty(testFilesToRetry)) {
+          throw e;
+        }
+
+        if (--runsLeft > 0) {
+          // @ts-ignore
+          detox.session.testSessionIndex++; // it is always the primary context, so we can update it
+          this._argv._ = testFilesToRetry;
+          this._logRelaunchError();
+        }
+      }
+    } while (launchError && runsLeft > 0);
+
+    if (launchError) {
+      throw launchError;
+    }
+  }
+
+  _buildEnvHint(env) {
+    return _(env)
+      .mapKeys((_value, key) => key.toUpperCase())
+      .pickBy((_value, key) => key.startsWith('DETOX_'))
+      .omit(['DETOX_CONFIG_SNAPSHOT_PATH'])
+      .value();
+  }
+
+  /**
+   * @param {DetoxInternals.CLIConfig} cliConfig
+   * @param {Detox.DetoxDeviceConfig} deviceConfig
+   */
+  _buildEnvOverride(cliConfig, deviceConfig) {
+    return _.omitBy({
+      DETOX_APP_LAUNCH_ARGS: cliConfig.appLaunchArgs,
+      DETOX_ARTIFACTS_LOCATION: cliConfig.artifactsLocation,
+      DETOX_CAPTURE_VIEW_HIERARCHY: cliConfig.captureViewHierarchy,
+      DETOX_CLEANUP: cliConfig.cleanup,
+      DETOX_CONFIGURATION: cliConfig.configuration,
+      DETOX_CONFIG_PATH: cliConfig.configPath,
+      DETOX_DEBUG_SYNCHRONIZATION: cliConfig.debugSynchronization,
+      DETOX_DEVICE_BOOT_ARGS: cliConfig.deviceBootArgs,
+      DETOX_DEVICE_NAME: cliConfig.deviceName,
+      DETOX_FORCE_ADB_INSTALL: deviceConfig.type.startsWith('android.')
+        ? cliConfig.forceAdbInstall
+        : undefined,
+      DETOX_GPU: cliConfig.gpu,
+      DETOX_HEADLESS: cliConfig.headless,
+      DETOX_KEEP_LOCKFILE: cliConfig.keepLockFile,
+      DETOX_LOGLEVEL: cliConfig.loglevel,
+      DETOX_READ_ONLY_EMU: cliConfig.readonlyEmu,
+      DETOX_RECORD_LOGS: cliConfig.recordLogs,
+      DETOX_RECORD_PERFORMANCE: cliConfig.recordPerformance,
+      DETOX_RECORD_VIDEOS: cliConfig.recordVideos,
+      DETOX_REPORT_SPECS: cliConfig.jestReportSpecs,
+      DETOX_RETRIES: cliConfig.retries,
+      DETOX_REUSE: cliConfig.reuse,
+      DETOX_TAKE_SCREENSHOTS: cliConfig.takeScreenshots,
+      DETOX_USE_CUSTOM_LOGGER: cliConfig.useCustomLogger,
+    }, _.isUndefined);
+  }
+
+  async _spawnTestRunner() {
+    const fullCommand = this._buildSpawnArguments().map(escapeSpaces);
+    const fullCommandWithHint = printEnvironmentVariables(this._envHint) + fullCommand.join(' ');
+
+    log.info({ env: this._envHint }, fullCommandWithHint);
+
+    return new Promise((resolve, reject) => {
+      cp.spawn(fullCommand[0], fullCommand.slice(1), {
+        shell: true,
+        stdio: 'inherit',
+        env: _({})
+          .assign(process.env)
+          .assign(this._envFwd)
+          .omitBy(_.isUndefined)
+          .tap(prependNodeModulesBinToPATH)
+          .value()
+      })
+        .on('error', /* istanbul ignore next */ (err) => reject(err))
+        .on('exit', (code) => code === 0
+          ? resolve()
+          : reject(new DetoxRuntimeError(`Command failed with exit code = ${code}:\n${fullCommandWithHint}`)
+        ));
+    });
+  }
+
+  _buildSpawnArguments() {
+    /* istanbul ignore next */
+    const { _: specs = [], '--': passthrough = [], $0, ...argv } = this._argv;
+    const { _: $0_, ...$0argv } = parser($0);
+
+    return [
+      ...$0_,
+      ...unparse($0argv),
+      ...unparse(argv),
+      ...unparse({ _: [...passthrough, ...specs] }),
+    ].map(String);
+  }
+
+  _logRelaunchError() {
+    const list = this._argv._.map((file, index) => {
+      return `  ${index + 1}. ${file}`;
+    }).join('\n');
+
+    log.error(
+      `There were failing tests in the following files:\n${list}\n\n` +
+      'Detox CLI is going to restart the test runner with those files...\n'
+    );
+  }
+}
+
+module.exports = TestRunnerCommand;

package/local-cli/{utils/testCommandArgs.js → testCommand/builder.js}

@@ -10,27 +10,17 @@ module.exports = {
     describe:
       'Select a device configuration from your defined configurations, if not supplied, and there\'s only one configuration, detox will default to it',
   },
-  o: {
-    alias: 'runner-config',
-    group: 'Configuration:',
-    describe: 'Test runner config file, defaults to e2e/mocha.opts for mocha and e2e/config.json for jest',
-  },
   l: {
     alias: 'loglevel',
     group: 'Debugging:',
-    choices: ['fatal', 'error', 'warn', 'info', 'verbose', 'trace'],
+    choices: ['fatal', 'error', 'warn', 'info', 'verbose', 'debug', 'trace'],
     describe: 'Log level',
   },
-  'no-color': {
-    describe: 'Disable colors in log output',
-    boolean: true,
-  },
   R: {
     alias: 'retries',
     group: 'Execution:',
-    describe: '[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or <N> times at least.',
+    describe: 'Re-spawn the test runner for individual failing suite files until they pass, or <N> times at least.',
     number: true,
-    default: 0,
   },
   r: {
     alias: 'reuse',
@@ -48,10 +38,6 @@ module.exports = {
     alias: 'debug-synchronization',
     group: 'Debugging:',
     coerce(value) {
-      if (value == null) {
-        return undefined;
-      }
-
       if (value === false || value === 'false') {
         return 0;
       }
@@ -96,33 +82,23 @@ module.exports = {
     choices: ['enabled', 'disabled'],
     describe: '[iOS Only] Capture *.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls.',
   },
-  'record-timeline': {
-    group: 'Debugging:',
-    choices: ['all', 'none'],
-    describe: '[Jest Only] Record tests and events timeline, for visual display on the chrome://tracing tool.',
-  },
-  w: {
-    alias: 'workers',
-    group: 'Execution:',
-    describe: 'Specifies the number of workers the test runner should spawn. Requires a test runner with parallel execution support (e.g. Jest)',
-    number: true,
-  },
   'jest-report-specs': {
     group: 'Execution:',
-    describe: '[Jest Only] Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.',
+    describe: 'Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.',
     boolean: true,
   },
   H: {
     alias: 'headless',
     group: 'Execution:',
-    describe: '[Android Only] Launch emulator in headless mode. Useful when running on CI. Only applicable for Google emulators.',
+    describe: 'Launch device in headless mode. Useful when running on CI.',
     boolean: true,
   },
   gpu: {
     group: 'Execution:',
-    describe: '[Android Only] Launch emulator with the specific -gpu [gpu mode] parameter. Only applicable for Google emulators.',
+    choices: ['auto', 'host', 'swiftshader_indirect', 'angle_indirect', 'guest', 'off'],
+    describe: '[Android Only] Launch emulator with the specific -gpu [gpu mode] parameter.',
   },
-  keepLockFile:{
+  keepLockFile: {
     group: 'Configuration:',
     describe:'Keep the device lock file when running Detox tests',
     boolean: true,
@@ -133,7 +109,6 @@ module.exports = {
     describe: 'Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.',
   },
   'device-boot-args': {
-    alias: 'device-launch-args',
     group: 'Execution:',
     describe: 'Custom arguments to pass (through) onto the device (emulator/simulator) binary when booted.',
   },
@@ -143,18 +118,17 @@ module.exports = {
   },
   'use-custom-logger': {
     boolean: true,
-    default: true,
     group: 'Execution:',
-    describe: `Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to node.js / test-runner's implementation (e.g. Jest / Mocha).`,
+    describe: `Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to node.js / test runner's implementation (e.g. Jest).`,
   },
   'force-adb-install': {
     boolean: true,
     group: 'Execution:',
-    describe: `Due to problems with the "adb install" command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of "adb install", instead.`,
+    describe: `[Android Only] Due to problems with the "adb install" command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of "adb install", instead.`,
   },
   'inspect-brk': {
     group: 'Debugging:',
-    describe: 'Allows debugging of the underlying test runner',
+    describe: '[Jest Only] Allows debugging of the underlying test runner',
     boolean: true,
   }
 };

package/local-cli/testCommand/middlewares.js

@@ -0,0 +1,66 @@
+const _ = require('lodash');
+
+const { log } = require('../../internals');
+const { getJestBooleanArgs } = require('../utils/jestInternals');
+const { simpleUnquote, extractKnownKeys, disengageBooleanArgs } = require('../utils/yargsUtils');
+
+const testCommandArgs = require('./builder');
+const { DETOX_ARGV_OVERRIDE_NOTICE } = require('./warnings');
+
+function applyEnvironmentVariableAddendum(argv, yargs) {
+  if (process.env.DETOX_ARGV_OVERRIDE) {
+    log.warn(DETOX_ARGV_OVERRIDE_NOTICE);
+
+    const { _: positional, '--': passthrough, ...named } = yargs.parse(process.env.DETOX_ARGV_OVERRIDE);
+
+    if (!_.isEmpty(positional)) {
+      /* istanbul ignore next */
+      argv._ = argv._ || [];
+      argv._.push(...positional.map(simpleUnquote));
+    }
+
+    if (!_.isEmpty(passthrough)) {
+      argv['--'] = argv['--'] || [];
+      argv['--'].push(...passthrough.map(simpleUnquote));
+    }
+
+    Object.assign(argv, named);
+  }
+
+  return argv;
+}
+
+/**
+ * @param {Record<string, *>} argv
+ * @returns {{
+ *   detoxArgs: Record<string, *>,
+ *   runnerArgs: Record<string, *>
+ * }}
+ */
+function splitArgv(argv) {
+  const aliases = extractKnownKeys(testCommandArgs);
+  const isDetoxArg = (_value, key) => key === '$0' || aliases.has(key);
+
+  const detoxArgs = _.pickBy(argv, isDetoxArg);
+  const runnerArgv = _.omitBy(argv, isDetoxArg);
+  runnerArgv._ = runnerArgv._.slice(1); // omit 'test' string, as in 'detox test'
+  if (typeof detoxArgs['debug-synchronization'] === 'string') {
+    const erroneousPassthrough = detoxArgs['debug-synchronization'];
+    detoxArgs['debug-synchronization'] = 3000;
+    runnerArgv._.unshift(erroneousPassthrough);
+  }
+
+  const runnerArgs = disengageBooleanArgs(runnerArgv, getJestBooleanArgs());
+  return { detoxArgs, runnerArgs };
+}
+
+// noinspection JSUnusedGlobalSymbols
+module.exports = {
+  applyEnvironmentVariableAddendum,
+  splitArgv,
+};
+
+module.exports.default = [
+  applyEnvironmentVariableAddendum,
+  splitArgv,
+];

package/local-cli/{utils → testCommand}/warnings.js

@@ -1,14 +1,3 @@
-const { DEVICE_LAUNCH_ARGS_DEPRECATION } = require('../../src/configuration/utils/warnings');
-const log = require('../../src/utils/logger').child({ __filename });
-
-function coerceDeprecation(option) {
-  return function coerceDeprecationFn(value) {
-    log.warn(`Beware: ${option} will be removed in the next version of Detox.`);
-
-    return value;
-  };
-}
-
 const DETOX_ARGV_OVERRIDE_NOTICE = `
    _____ _____ ___________
   /  ___|_   _|  _  | ___ \\  $DETOX_ARGV_OVERRIDE is detected
@@ -30,7 +19,5 @@ const DETOX_ARGV_OVERRIDE_NOTICE = `
 `;
 
 module.exports = {
-  coerceDeprecation,
   DETOX_ARGV_OVERRIDE_NOTICE,
-  DEVICE_LAUNCH_ARGS_DEPRECATION,
 };

package/local-cli/utils/jestInternals.js

@@ -2,10 +2,13 @@
 const Module = require('module');
 const path = require('path');
 
+const _ = require('lodash');
 const resolveFrom = require('resolve-from');
 const semver = require('semver');
 
-const DetoxRuntimeError = require('../../src/errors/DetoxRuntimeError');
+const { DetoxRuntimeError } = require('../../src/errors');
+
+const { extractKnownKeys } = require('./yargsUtils');
 
 const getNodeModulePaths = (dir) => Module._nodeModulePaths(dir);
 
@@ -68,7 +71,15 @@ async function readJestConfig(argv) {
   return readConfig(argv, process.cwd(), false);
 }
 
+function getJestBooleanArgs() {
+  return _(resolveJestCliArgs())
+    .thru(args => args.options)
+    .pickBy(({ type }) => type === 'boolean')
+    .thru(extractKnownKeys)
+    .value();
+}
+
 module.exports = {
-  resolveJestCliArgs,
+  getJestBooleanArgs,
   readJestConfig,
 };

package/local-cli/utils/yargsUtils.js

@@ -0,0 +1,67 @@
+/**
+ * @param {Record<string, Record<string, *>>} yargsBuilder
+ * @returns {Set<string>}
+ */
+function extractKnownKeys(yargsBuilder) {
+  return Object.entries(yargsBuilder).reduce(
+    (set, [key, option]) => {
+      if (option.alias) {
+        if (Array.isArray(option.alias)) {
+          for (const value of option.alias) {
+            set.add(value);
+          }
+        } else {
+          set.add(option.alias);
+        }
+      }
+
+      return set.add(key);
+    },
+    new Set()
+  );
+}
+
+/**
+ * @param {Record<string, *>} argv
+ * @param {Set<string>} booleanKeys
+ * @returns {Record<string, *>}
+ */
+function disengageBooleanArgs(argv, booleanKeys) {
+  const result = {};
+  const passthrough = [];
+
+  for (const entry of Object.entries(argv)) {
+    const [key, value] = entry;
+    if (key === '_' || key === '--') {
+      continue;
+    }
+
+    const positiveKey = key.startsWith('no-') ? key.slice(3) : key;
+    if (booleanKeys.has(positiveKey) && typeof value !== 'boolean') {
+      result[positiveKey] = key === positiveKey;
+      passthrough.push(value);
+    } else {
+      result[key] = value;
+    }
+  }
+
+  return {
+    ...result,
+    '_': passthrough.concat(argv._),
+    '--': argv['--'] || [],
+  };
+}
+
+function simpleUnquote(arg) {
+  if ((arg[0] === '"' || arg[0] === "'") && arg[0] === arg[arg.length - 1]) {
+    return arg.slice(1, -1);
+  }
+
+  return arg;
+}
+
+module.exports = {
+  disengageBooleanArgs,
+  extractKnownKeys,
+  simpleUnquote,
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "detox",
   "description": "E2E tests and automation for mobile",
-  "version": "19.13.0",
+  "version": "20.0.0",
   "bin": {
     "detox": "local-cli/cli.js"
   },
@@ -14,7 +14,7 @@
     "url": "https://github.com/wix/Detox/issues"
   },
   "homepage": "https://github.com/wix/Detox#readme",
-  "main": "./src/index.js",
+  "main": "./index.js",
   "types": "./index.d.ts",
   "author": "Tal Kol <talkol@gmail.com>",
   "license": "MIT",
@@ -32,9 +32,12 @@
     "postinstall": "node scripts/postinstall.js"
   },
   "devDependencies": {
+    "@types/bunyan": "^1.8.8",
     "@types/child-process-promise": "^2.2.1",
-    "@types/jest": "^27.0.3",
-    "@types/node": "^12.20.37",
+    "@types/fs-extra": "^9.0.13",
+    "@types/jest": "^28.1.8",
+    "@types/node": "^14.18.33",
+    "@types/node-ipc": "^9.2.0",
     "@types/ws": "^7.4.0",
     "@typescript-eslint/eslint-plugin": "^5.4.0",
     "@typescript-eslint/parser": "^5.4.0",
@@ -43,8 +46,7 @@
     "eslint-plugin-no-only-tests": "^2.6.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^39.0.0",
-    "jest": "^28.0.0",
-    "mocha": ">=6.0.0",
+    "jest": "^28.1.3",
     "mockdate": "^2.0.1",
     "prettier": "1.7.0",
     "react-native": "0.69.7",
@@ -55,15 +57,22 @@
   "dependencies": {
     "ajv": "^8.6.3",
     "bunyan": "^1.8.12",
-    "bunyan-debug-stream": "^2.0.1",
+    "bunyan-debug-stream": "^3.1.0",
+    "caf": "^15.0.1",
     "chalk": "^2.4.2",
     "child-process-promise": "^2.2.0",
+    "duplexify": "^4.1.2",
     "find-up": "^4.1.0",
     "fs-extra": "^4.0.2",
     "funpermaproxy": "^1.0.1",
+    "glob": "^8.0.3",
     "ini": "^1.3.4",
+    "json-cycle": "^1.3.0",
     "lodash": "^4.17.5",
     "minimist": "^1.2.0",
+    "multi-sort-stream": "^1.0.3",
+    "multipipe": "^4.0.0",
+    "node-ipc": "^9.2.1",
     "proper-lockfile": "^3.0.2",
     "resolve-from": "^5.0.0",
     "sanitize-filename": "^1.6.1",
@@ -71,29 +80,28 @@
     "serialize-error": "^8.0.1",
     "shell-quote": "^1.7.2",
     "signal-exit": "^3.0.3",
+    "stream-json": "^1.7.4",
+    "strip-ansi": "^6.0.1",
     "tail": "^2.0.0",
     "telnet-client": "1.2.8",
     "tempfile": "^2.0.0",
+    "trace-event-lib": "^1.3.1",
     "which": "^1.3.1",
     "ws": "^7.0.0",
     "yargs": "^16.0.3",
-    "yargs-parser": "^20.2.2",
+    "yargs-parser": "^20.2.9",
     "yargs-unparser": "^2.0.0"
   },
   "peerDependencies": {
-    "jest": "26.0.x - 26.4.x || ^26.5.2 || 27.x.x || 28.x.x || 29.x.x",
-    "mocha": ">=6.0.0"
+    "jest": "29.x.x || 28.x.x || ^27.2.5"
   },
   "peerDependenciesMeta": {
     "jest": {
       "optional": true
-    },
-    "mocha": {
-      "optional": true
     }
   },
   "engines": {
-    "node": ">=8.3.0"
+    "node": ">=14.5.0"
   },
   "jest": {
     "setupFiles": [
@@ -103,8 +111,9 @@
     "testRunner": "jest-circus/runner",
     "roots": [
       "node_modules",
+      "local-cli",
       "src",
-      "local-cli"
+      "runners"
     ],
     "testPathIgnorePatterns": [
       "/node_modules/",
@@ -124,7 +133,6 @@
       "src/artifacts/screenshot",
       "src/artifacts/video",
       "src/devices/allocation/drivers/AllocationDriverBase.js",
-      "src/devices/allocation/drivers/NoneAllocDriver.js",
       "src/devices/allocation/drivers/android/emulator/launchEmulatorProcess.js",
       "src/devices/allocation/drivers/android/emulator/patchAvdSkinConfig.js",
       "src/devices/allocation/drivers/ios",
@@ -145,14 +153,19 @@
       "src/validation/EnvironmentValidatorBase.js",
       "src/validation/factories",
       "src/validation/ios/IosSimulatorEnvValidator",
-      "src/utils/MissingDetox.js",
       "src/utils/appdatapath.js",
       "src/utils/debug.js",
       "src/utils/environment.js",
       "src/utils/logger.js",
       "src/utils/pipeCommands.js",
       "src/utils/pressAnyKey.js",
-      "src/utils/shellUtils.js"
+      "src/utils/shellUtils.js",
+      "runners/jest/reporters",
+      "runners/jest/testEnvironment",
+      "src/DetoxWorker.js",
+      "src/logger/utils/streamUtils.js",
+      "src/ipc",
+      "src/realms"
     ],
     "resetMocks": true,
     "resetModules": true,
@@ -177,5 +190,5 @@
       }
     }
   },
-  "gitHead": "7e4d0112cfb404b9e93ac3a4a50a7e45909c1966"
+  "gitHead": "8c533cd0bbbd514071a31355516292a2cf3c89ce"
 }

package/runners/deprecation.js

@@ -0,0 +1,45 @@
+const chalk = require('chalk');
+
+// @ts-ignore
+const bold = chalk.bold;
+
+function getMaxWidth(text) {
+  const lines = text.split('\n');
+  return lines.reduce((acc, line) => Math.max(acc, line.length), 0);
+}
+
+function centerText(text, maxWidth = getMaxWidth(text)) {
+  return text
+    .split('\n')
+    .map(line => {
+      const padStart = Math.max(0, Math.floor((maxWidth - line.length) / 2));
+      const padEnd = Math.max(0, maxWidth - line.length - padStart);
+      return ' '.repeat(padStart) + line + ' '.repeat(padEnd);
+    })
+    .join('\n');
+}
+
+const header = `\
+=========================  THE NEW JOURNEY BEGINS  =============================`;
+
+console.error(centerText(`\
+
+${bold(header)}
+
+https://wix.github.io/Detox/docs/guide/migration
+
+Sorry to say that Detox 20 comes without old adapters for Jest.
+You have to rearrange your init code before you can continue your journey.
+
+Navigate to the link and follow the migration guide steps.
+
+Sincerely yours,
+Detox team.
+
+${bold(header)}
+
+`, header.length));
+
+const error = new Error('\nPlease follow the migration guide:\nhttps://wix.github.io/Detox/docs/guide/migration\n\n');
+error.stack = '';
+throw error;