detox 19.7.1 → 20.0.0-breaking.new-global-lifecycle.0

package/local-cli/templates/mocha.js

@@ -1,32 +0,0 @@
-const firstTestContent = require('./firstTestContent');
-
-const mochaRcContent = JSON.stringify({
-  recursive: true,
-  timeout: 120000,
-  bail: true,
-  file: 'e2e/init.js',
-}, null, 4);
-
-const initjsContent = `const detox = require('detox');
-const adapter = require('detox/runners/mocha/adapter');
-
-before(async () => {
-  await detox.init();
-});
-
-beforeEach(async function () {
-  await adapter.beforeEach(this);
-});
-
-afterEach(async function () {
-  await adapter.afterEach(this);
-});
-
-after(async () => {
-  await detox.cleanup();
-});
-`;
-
-exports.initjs = initjsContent;
-exports.firstTest = firstTestContent;
-exports.runnerConfig = mochaRcContent;

package/local-cli/utils/splitArgv.js

@@ -1,107 +0,0 @@
-const _ = require('lodash');
-
-const { resolveJestCliArgs } = require('./jestInternals');
-const testCommandArgs = require('./testCommandArgs');
-
-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()
-  );
-}
-
-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 {
-    specs: passthrough.concat(argv._),
-    passthrough: {
-      _: argv['--'] || [],
-      ...result,
-    },
-  };
-}
-
-function getJestBooleanArgs() {
-  return _(resolveJestCliArgs())
-    .thru(args => args.options)
-    .pickBy(({ type }) => type === 'boolean')
-    .thru(extractKnownKeys)
-    .value();
-}
-
-function getMochaBooleanArgs() {
-  const metadata = require('mocha/lib/cli/run-option-metadata');
-
-  return _(metadata.types.boolean)
-    .flatMap(key => [key, ...(metadata.aliases[key] || [])])
-    .thru(keys => new Set(keys))
-    .value();
-}
-
-function splitDetoxArgv(argv) {
-  const aliases = extractKnownKeys(testCommandArgs);
-  const isDetoxArg = (_value, key) => aliases.has(key);
-
-  const detoxArgs = _.pickBy(argv, isDetoxArg);
-  const runnerArgs = _.omitBy(argv, isDetoxArg);
-  runnerArgs._ = runnerArgs._.slice(1); // omit 'test' string, as in 'detox test'
-  if (typeof detoxArgs['debug-synchronization'] === 'string') {
-    const erroneousPassthrough = detoxArgs['debug-synchronization'];
-    detoxArgs['debug-synchronization'] = 3000;
-    runnerArgs._.unshift(erroneousPassthrough);
-  }
-
-  return { detoxArgs, runnerArgs };
-}
-
-function splitMochaArgv(argv) {
-  return disengageBooleanArgs(argv, getMochaBooleanArgs());
-}
-
-function splitJestArgv(argv) {
-  return realiasJestArgv(disengageBooleanArgs(argv, getJestBooleanArgs()));
-}
-
-function realiasJestArgv({ specs, passthrough }) {
-  if (passthrough.hasOwnProperty('t')) {
-    passthrough.testNamePattern = passthrough.t;
-    delete passthrough.t;
-  }
-
-  return { specs, passthrough };
-}
-
-module.exports = {
-  detox: splitDetoxArgv,
-  jest: splitJestArgv,
-  mocha: splitMochaArgv,
-};

package/runners/integration.js

@@ -1,16 +0,0 @@
-module.exports = {
-  lifecycle: {
-    onRunStart: Symbol('run_start'),
-    onRunDescribeStart: Symbol('run_describe_start'),
-    onTestStart: Symbol('test_start'),
-    onHookStart: Symbol('hook_start'),
-    onHookFailure: Symbol('hook_failure'),
-    onHookSuccess: Symbol('hook_success'),
-    onTestFnStart: Symbol('test_fn_start'),
-    onTestFnFailure: Symbol('test_fn_failure'),
-    onTestFnSuccess: Symbol('test_fn_success'),
-    onTestDone: Symbol('test_done'),
-    onRunDescribeFinish: Symbol('run_describe_finish'),
-    onRunFinish: Symbol('run_finish'),
-  },
-};

package/runners/jest/DetoxAdapterCircus.js

@@ -1,60 +0,0 @@
-const DetoxAdapter = require('./DetoxAdapterImpl');
-const { getFullTestName, hasTimedOut } = require('./utils');
-
-class DetoxAdapterCircus {
-  constructor(detox) {
-    this._adapter = new DetoxAdapter(detox, DetoxAdapterCircus._describeInitError);
-  }
-
-  static _describeInitError() {
-    return {
-      message: 'Detox adapter to Jest is malfunctioning.',
-      hint: `Make sure you register it as a test-event listener inside init.js:\n` +
-        `-------------------------------------------------------------\n` +
-        'detoxCircus.getEnv().addEventsListener(adapter);',
-      };
-  }
-
-  async beforeEach() {
-    await this._adapter.beforeEach();
-  }
-
-  async afterAll() {
-    await this._adapter.afterAll();
-  }
-
-  async run_describe_start({ describeBlock: { name, children } }, state) { // eslint-disable-line no-unused-vars
-    if (children.length) await this._adapter.suiteStart({ name });
-  }
-
-  async run_describe_finish({ describeBlock: { name, children } }, state) { // eslint-disable-line no-unused-vars
-    if (children.length) await this._adapter.suiteEnd({ name });
-  }
-
-  test_start(event) {
-    const { test } = event;
-    if (test.mode === 'skip' || test.mode === 'todo' || test.errors.length > 0) {
-      return;
-    }
-
-    this._adapter.testStart({
-      title: test.name,
-      fullName: getFullTestName(test),
-      status: 'running',
-    });
-  }
-
-  test_done(event) {
-    const { test } = event;
-    this._adapter.testComplete({
-      status: test.errors.length ? 'failed' : 'passed',
-      timedOut: hasTimedOut(test)
-    });
-  }
-
-  test_skip(event) { // eslint-disable-line no-unused-vars
-    // Ignored (for clarity)
-  }
-}
-
-module.exports = DetoxAdapterCircus;

package/runners/jest/DetoxAdapterImpl.js

@@ -1,81 +0,0 @@
-const DetoxRuntimeError = require('../../src/errors/DetoxRuntimeError');
-const log = require('../../src/utils/logger').child({ __filename });
-
-class DetoxAdapterImpl {
-  constructor(detox, describeInitErrorFn) {
-    if (process.env.DETOX_RERUN_INDEX) {
-      log.warn(
-        'While Detox CLI supports "-R <N>, --retries <N>" mechanism, ' +
-        'this outdated Jest integration does not — expect artifacts issues. ' +
-        'Please migrate to the new Jest Circus integration.\n\n' +
-        'See: https://wix.github.io/Detox/docs/api/guide/jest\n');
-    }
-
-    this.detox = detox;
-    this._describeInitError = describeInitErrorFn;
-    this._currentTest = null;
-    this._todos = [];
-  }
-
-  async beforeEach() {
-    if (!this._currentTest) {
-      throw new DetoxRuntimeError(this._describeInitError());
-    }
-
-    const currentTest = this._currentTest;
-
-    await this._flush();
-    await this.detox.beforeEach(currentTest);
-  }
-
-  async afterAll() {
-    await this._flush();
-  }
-
-  async suiteStart({ name }) {
-    this._enqueue(() => this.detox.suiteStart({ name }));
-  }
-
-  async suiteEnd({ name }) {
-    this._enqueue(() => this.detox.suiteEnd({ name }));
-  }
-
-  testStart({ title, fullName, status }) {
-    this._currentTest = {
-      title,
-      fullName,
-      status,
-    };
-  }
-
-  testComplete({ status, timedOut }) {
-    if (this._currentTest) {
-      const _test = {
-        ...this._currentTest,
-        status,
-        timedOut,
-      };
-
-      this._currentTest = null;
-      this._enqueue(() => this._afterEach(_test));
-    }
-  }
-
-  async _afterEach(previousTest) {
-    await this.detox.afterEach(previousTest);
-  }
-
-  _enqueue(fn) {
-    this._todos.push(fn);
-  }
-
-  async _flush() {
-    const t = this._todos;
-
-    while (t.length > 0) {
-      await Promise.resolve().then(t.shift()).catch(()=>{});
-    }
-  }
-}
-
-module.exports = DetoxAdapterImpl;

package/runners/jest/DetoxAdapterJasmine.js

@@ -1,67 +0,0 @@
-const _ = require('lodash');
-
-const DetoxAdapter = require('./DetoxAdapterImpl');
-
-class DetoxAdapterJasmine /* extends JasmineReporter */ {
-  constructor(detox) {
-    this._adapter = new DetoxAdapter(detox, DetoxAdapterJasmine._describeInitError);
-  }
-
-  static _describeInitError() {
-    return {
-      message: 'Detox adapter to Jest is malfunctioning.',
-      hint: `Make sure you register it as Jasmine reporter inside init.js:\n` +
-        `-------------------------------------------------------------\n` +
-        'jasmine.getEnv().addReporter(adapter);',
-    };
-  }
-
-  async beforeEach() {
-    await this._adapter.beforeEach();
-  }
-
-  async afterAll() {
-    await this._adapter.afterAll();
-  }
-
-  async suiteStarted(result) {
-    await this._adapter.suiteStart({ name: result.description });
-  }
-
-  async suiteDone(result) {
-    await this._adapter.suiteEnd({ name: result.description });
-  }
-
-  specStarted(result) {
-    if (result.pendingReason) {
-      return;
-    }
-
-    this._adapter.testStart({
-      title: result.description,
-      fullName: result.fullName,
-      status: 'running',
-    });
-  }
-
-  specDone(result) {
-    if (result.status === 'disabled' || result.pendingReason) {
-      return;
-    }
-
-    this._adapter.testComplete({
-      status: result.status,
-      timedOut: this._hasTimedOut(result),
-    });
-  }
-
-  _hasTimedOut(result) {
-    return _.chain(result.failedExpectations)
-      .map('error')
-      .compact()
-      .some(e => _.includes(e.message, 'Timeout'))
-      .value();
-  }
-}
-
-module.exports = DetoxAdapterJasmine;

package/runners/jest/DetoxStreamlineJestReporter.js

@@ -1,98 +0,0 @@
-// @ts-nocheck
-const { VerboseReporter: JestVerboseReporter } = require('@jest/reporters'); // eslint-disable-line node/no-extraneous-require
-
-const DetoxRuntimeError = require('../../src/errors/DetoxRuntimeError');
-
-class DetoxStreamlineJestReporter extends JestVerboseReporter {
-
-  constructor(globalConfig) {
-    super(globalConfig);
-    this._assertConfig();
-  }
-
-  /**
-   * Monkey patch for _wrapStdio method of Jest's DefaultReporter class
-   * https://github.com/facebook/jest/blob/84466b7bb187d33ffd336bd9fc76111bba511fe6/packages/jest-reporters/src/default_reporter.ts#L47
-   *
-   * The official implementation does the following:
-   * - For the <b>stderr</b> stream, it overrides the 'write' method with a simple bulked output mechanism,
-   *   which aggregates output onto a buffer but flushes it immediately.
-   * - For the <b>stdout</b> stream, it overrides the 'write' method with a time-based bulked output mechanism,
-   *   which aggregates output onto a buffer and flushes only in 100ms intervals.
-   *
-   * This gives priority, to a certain extent, to stderr output, over stdout.
-   * See: https://github.com/facebook/jest/blob/84466b7bb187d33ffd336bd9fc76111bba511fe6/packages/jest-reporters/src/default_reporter.ts#L73
-   *
-   * Typically, user logs are sent to stdout, and Jest reporter's (e.g. test-suite summary) - to stderr.
-   *
-   * ---
-   * Our goal is to have these 3 types of output streamlined in real time:
-   *
-   * 1. Jest suite-level lifecycle logging, typically done by the super-class' impl.
-   *    Note: Jest does not notify spec-level events to reporters.
-   * 2. Jasmine real-time, spec-level lifecycle logging.
-   * 3. User in-test logging (e.g. for debugging).
-   *
-   * It's easy to see that this cannot be done while stderr and stdout are not of equal priority.
-   * Therefore, this hack enforces immediate-flushing approach to <b>both</b> stderr and stdout.
-   */
-  _wrapStdio(stream) {
-    const originalWrite = stream.write;
-    let buffer = [];
-
-    const flushBufferedOutput = () => {
-      const string = buffer.join('');
-      buffer = []; // This is to avoid conflicts between random output and status text
-
-      this._clearStatus();
-
-      if (string) {
-        originalWrite.call(stream, string);
-      }
-
-      this._printStatus();
-
-      this._bufferedOutput.delete(flushBufferedOutput);
-    };
-
-    this._bufferedOutput.add(flushBufferedOutput);
-
-    stream.write = chunk => {
-      buffer.push(chunk);
-      flushBufferedOutput();
-      return true;
-    };
-  }
-
-  _assertConfig() {
-    if (!this._isVerboseEnabled()) {
-      // Non-verbose mode makes Jest swizzle 'console' with a buffered output impl, which prevents
-      // user and detox' jasmine-lifecycle logs from showing in real time.
-      throw new DetoxRuntimeError({
-        message: 'Cannot run properly unless Jest is in verbose mode',
-        hint: 'See https://jestjs.io/docs/en/configuration#verbose-boolean for more details',
-      });
-    }
-
-    if (this._hasDefaultReporter()) {
-      // This class overrides Jest's VerboseReporter, which is set by default. Can't have both.
-      throw new DetoxRuntimeError({
-        message: 'Cannot work alongside the default Jest reporter. Please remove it from the reporters list.',
-        hint: 'See https://jestjs.io/docs/en/configuration#reporters-array-modulename-modulename-options for more details',
-      });
-    }
-  }
-
-  _isVerboseEnabled() {
-    return !!this._globalConfig.verbose;
-  }
-
-  _hasDefaultReporter() {
-    return !!this._globalConfig.reporters.find(reporterDef => {
-      const [reporterName] = reporterDef;
-      return reporterName === 'default';
-    });
-  }
-}
-
-module.exports = DetoxStreamlineJestReporter;

package/runners/jest/FailingTestsReporter.js

@@ -1,16 +0,0 @@
-const path = require('path');
-
-const { saveLastFailedTests } = require('../../src/utils/lastFailedTests');
-
-class FailingTestsReporter {
-  async onRunComplete(_contexts, { testResults }) {
-    const cwd = process.cwd();
-    const failedFiles = testResults
-      .filter(result => result.numFailingTests > 0)
-      .map(result => path.relative(cwd, result.testFilePath));
-
-    await saveLastFailedTests(failedFiles);
-  }
-}
-
-module.exports = FailingTestsReporter;

package/runners/jest/SpecReporterCircus.js

@@ -1,51 +0,0 @@
-const argparse = require('../../src/utils/argparse');
-
-const SpecReporter = require('./SpecReporterImpl');
-
-class SpecReporterCircus {
-  constructor() {
-    this._specReporter = new SpecReporter();
-  }
-
-  run_describe_start(event) {
-    if (event.describeBlock.parent !== undefined) {
-      this._specReporter.onSuiteStart({
-        description: event.describeBlock.name,
-      });
-    }
-  }
-
-  run_describe_finish(event) {
-    if (event.describeBlock.parent !== undefined) {
-      this._specReporter.onSuiteEnd();
-    }
-  }
-
-  test_start(event) {
-    const { test } = event;
-    this._specReporter.onTestStart({
-      description: test.name,
-      invocations: test.invocations,
-    });
-  }
-
-  test_done(event) {
-    const { test } = event;
-    const testInfo = {
-      description: test.name,
-      invocations: test.invocations,
-    };
-    this._specReporter.onTestEnd(testInfo, test.errors.length ? 'failed' : 'success');
-  }
-
-  test_skip(event) {
-    const testInfo = {
-      description: event.test.name,
-    };
-    this._specReporter.onTestEnd(testInfo, 'skipped');
-  }
-}
-
-module.exports = argparse.getArgValue('reportSpecs') === 'true'
-  ? SpecReporterCircus
-  : class {};

package/runners/jest/SpecReporterJasmine.js

@@ -1,39 +0,0 @@
-const SpecReporter = require('./SpecReporterImpl');
-
-/***
- * @see {@link https://jasmine.github.io/api/2.9/Reporter.html}
- */
-class SpecReporterJasmine {
-  constructor() {
-    this._specReporter = new SpecReporter();
-  }
-
-  suiteStarted(suiteInfo) {
-    this._specReporter.onSuiteStart(suiteInfo);
-  }
-
-  suiteDone() {
-    this._specReporter.onSuiteEnd();
-  }
-
-  specStarted(specInfo) {
-    this._specReporter.onTestStart(specInfo);
-  }
-
-  specDone(specResult) {
-    let result;
-    if (specResult.status === 'disabled') {
-      result = 'skipped';
-    } else if (specResult.status === 'failed') {
-      result = 'failed';
-    } else if (specResult.pendingReason) {
-      result = 'pending';
-    } else {
-      result = 'success';
-    }
-
-    this._specReporter.onTestEnd(specResult, result);
-  }
-}
-
-module.exports = SpecReporterJasmine;

package/runners/jest/WorkerAssignReporterCircus.js

@@ -1,17 +0,0 @@
-const WorkerAssignReporter = require('./WorkerAssignReporterImpl');
-
-class WorkerAssignReporterCircus {
-  constructor({ detox }) {
-    this._reporter = new WorkerAssignReporter(detox);
-  }
-
-  run_describe_start(event) {
-    const { describeBlock } = event;
-
-    if (describeBlock.parent && describeBlock.parent.parent === undefined) {
-      this._reporter.report(describeBlock.name);
-    }
-  }
-}
-
-module.exports = WorkerAssignReporterCircus;

package/runners/jest/WorkerAssignReporterImpl.js

@@ -1,21 +0,0 @@
-const chalk = require('chalk').default;
-const _ = require('lodash');
-
-const log = require('../../src/utils/logger').child();
-
-class WorkerAssignReporterImpl {
-  constructor(detox) {
-    this.device = detox && detox.device;
-  }
-
-  report(workerName) {
-    const deviceName = _.attempt(() => this.device.name);
-    const formattedDeviceName = _.isError(deviceName)
-      ? chalk.redBright('undefined')
-      : chalk.blueBright(deviceName);
-
-    log.info({ event: 'WORKER_ASSIGN' }, `${chalk.whiteBright(workerName)} is assigned to ${formattedDeviceName}`);
-  }
-}
-
-module.exports = WorkerAssignReporterImpl;

package/runners/jest/WorkerAssignReporterJasmine.js

@@ -1,15 +0,0 @@
-const path = require('path');
-
-const WorkerAssignReporter = require('./WorkerAssignReporterImpl');
-
-class WorkerAssignReporterJasmine {
-  constructor({ detox }) {
-    this._reporter = new WorkerAssignReporter(detox);
-  }
-
-  suiteStarted(suiteInfo) {
-    const workerName = path.basename(suiteInfo.testPath);
-    this._reporter.report(workerName);
-  }
-}
-module.exports = WorkerAssignReporterJasmine;

package/runners/jest/runnerInfo.js

@@ -1,9 +0,0 @@
-// @ts-nocheck
-const isJasmine = !!global.jasmine;
-const isJestCircus = !!global.detoxCircus;
-
-module.exports = {
-  type: isJestCircus ? 'jest-circus' : 'jasmine',
-  isJasmine,
-  isJestCircus,
-};