detox 19.13.0 → 20.0.0

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

@@ -0,0 +1,27 @@
+const _ = require('lodash');
+
+const { device } = require('../../../..');
+
+const PLATFORM_REGEXP = /^:([^:]+):/;
+
+class DetoxPlatformFilterListener {
+  setup() {
+    this._platform = device.getPlatform();
+  }
+
+  start_describe_definition(event, state) {
+    const match = event.blockName.match(PLATFORM_REGEXP);
+    if (match && match[1] !== this._platform) {
+      state.currentDescribeBlock.mode = 'skip';
+    }
+  }
+
+  add_test(event, state) {
+    const match = event.testName.match(PLATFORM_REGEXP);
+    if (match && match[1] !== this._platform) {
+      _.last(state.currentDescribeBlock.children).mode = 'skip';
+    }
+  }
+}
+
+module.exports = DetoxPlatformFilterListener;

package/runners/jest/{SpecReporterImpl.js → testEnvironment/listeners/SpecReporter.js}

@@ -1,8 +1,8 @@
 const chalk = require('chalk').default;
+const noop = require('lodash/noop');
 
-const log = require('../../src/utils/logger').child();
-
-const { traceln } = require('./utils/stdout');
+const { config, log, session } = require('../../../../internals');
+const { traceln } = require('../utils/stdout');
 
 const RESULT_SKIPPED = chalk.yellow('SKIPPED');
 const RESULT_FAILED = chalk.red('FAIL');
@@ -16,12 +16,64 @@ class SpecReporter {
     this._suitesDesc = '';
   }
 
-  onSuiteStart({ description }) {
+  setup() {
+    const jestSection = config.testRunner.jest;
+    const reportSpecs = jestSection && jestSection.reportSpecs;
+    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 (event.describeBlock.parent !== undefined) {
+      this._onSuiteStart({
+        description: event.describeBlock.name,
+      });
+    }
+  }
+
+  run_describe_finish(event) {
+    if (event.describeBlock.parent !== undefined) {
+      this._onSuiteEnd();
+    }
+  }
+
+  test_start(event) {
+    const { test } = event;
+    this._onTestStart({
+      description: test.name,
+      invocations: test.invocations,
+    });
+  }
+
+  test_done(event) {
+    const { test } = event;
+    const testInfo = {
+      description: test.name,
+      invocations: test.invocations,
+    };
+    this._onTestEnd(testInfo, test.errors.length ? 'failed' : 'success');
+  }
+
+  test_skip(event) {
+    const testInfo = {
+      description: event.test.name,
+    };
+    this._onTestEnd(testInfo, 'skipped');
+  }
+
+  _onSuiteStart({ description }) {
     this._suites.push({ description });
     this._regenerateSuitesDesc();
   }
 
-  onSuiteEnd() {
+  _onSuiteEnd() {
     this._suites.pop();
     this._regenerateSuitesDesc();
 
@@ -30,11 +82,11 @@ class SpecReporter {
     }
   }
 
-  onTestStart({ description, invocations = 1 }) {
+  _onTestStart({ description, invocations = 1 }) {
     this._traceTest({ description, invocations });
   }
 
-  onTestEnd({ description, invocations = 1 }, result) {
+  _onTestEnd({ description, invocations = 1 }, result) {
     let status;
     switch (result) {
       case 'skipped': status = RESULT_SKIPPED; break;
@@ -56,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) {
@@ -64,7 +116,7 @@ class SpecReporter {
     const retriesDescription = (invocations > 1) ? chalk.gray(` [Retry #${invocations - 1}]`) : '';
     const status = chalk.gray(_status ? ` [${_status}]` : '');
     const desc = this._suitesDesc + testDescription + retriesDescription + status;
-    log.info({ event: 'SPEC_STATE_CHANGE' }, desc);
+    log.info({ cat: 'lifecycle' }, desc);
   }
 }
 

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

@@ -0,0 +1,30 @@
+const path = require('path');
+
+const chalk = require('chalk').default;
+const _ = require('lodash');
+
+const { device } = require('../../../..');
+const { config, log } = require('../../../../internals');
+
+class WorkerAssignReporter {
+  constructor({ env }) {
+    this._testName = path.basename(env.testPath);
+  }
+
+  run_start() {
+    if (config.testRunner.jest.reportWorkerAssign) {
+      log.info({ cat: 'lifecycle' }, `${chalk.bold(this._testName)} is assigned to ${this._formatDeviceName()}`);
+    }
+  }
+
+  _formatDeviceName() {
+    const deviceName = _.attempt(() => device.name);
+    const formattedDeviceName = _.isError(deviceName)
+      ? chalk.redBright('undefined')
+      : chalk.blueBright(deviceName);
+
+    return formattedDeviceName;
+  }
+}
+
+module.exports = WorkerAssignReporter;

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

@@ -0,0 +1,13 @@
+const DetoxCoreListener = require('./DetoxCoreListener');
+const DetoxInitErrorListener = require('./DetoxInitErrorListener');
+const DetoxPlatformFilterListener = require('./DetoxPlatformFilterListener');
+const SpecReporter = require('./SpecReporter');
+const WorkerAssignReporter = require('./WorkerAssignReporter');
+
+module.exports = {
+  DetoxCoreListener,
+  DetoxInitErrorListener,
+  DetoxPlatformFilterListener,
+  SpecReporter,
+  WorkerAssignReporter,
+};

package/runners/{jest-circus → jest/testEnvironment}/utils/assertExistingContext.js

@@ -1,6 +1,6 @@
 // @ts-nocheck
-const { DetoxRuntimeError } = require('../../../src/errors/DetoxRuntimeError');
-const { filterErrorStack } = require('../../../src/utils/errorUtils');
+const { DetoxRuntimeError } = require('../../../../src/errors/DetoxRuntimeError');
+const { filterErrorStack } = require('../../../../src/utils/errorUtils');
 
 function findUserConstructor() {
   let wasInBaseClass = false;

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

@@ -0,0 +1,70 @@
+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');
+
+function assertJestCircus27(maybeProjectConfig) {
+  const projectConfig = maybeProjectConfig.projectConfig || maybeProjectConfig;
+
+  if (!/jest-circus/.test(projectConfig.testRunner)) {
+    throw new DetoxRuntimeError({
+      message: 'Cannot continue without Jest Circus test runner underneath, exiting.',
+      hint: 'Make sure that in your Jest config you have no "testRunner" property or it is explicitly set to "jest-circus/runner".',
+      debugInfo: `The test runner powering your configuration is:\n${projectConfig.testRunner}`,
+    });
+  }
+
+  const circusPackageJson = path.join(path.dirname(projectConfig.testRunner), 'package.json');
+  if (!fs.existsSync(circusPackageJson)) {
+    throw new DetoxRuntimeError({
+      message: 'Check that you have an installed copy of "jest-circus" npm package, exiting.',
+      debugInfo: `Its package.json file is missing: ${circusPackageJson}`,
+    });
+  }
+
+  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({
+      message: 'Check that you have an valid copy of "jest-circus" npm package, exiting.',
+      debugInfo: `Its package.json file has no "version" property. See:\n` + circusPackageJson,
+    });
+  }
+
+  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;
+}
+
+function assertSupportedVersion(actualVersion) {
+  const supportedRange = detoxPackageJson.peerDependencies.jest;
+  const minSupportedVersion = semver.minVersion(supportedRange);
+  const action = semver.lt(actualVersion, minSupportedVersion) ? 'upgrade' : 'downgrade';
+
+  if (!semver.satisfies(actualVersion, supportedRange, { includePrerelease: true })) {
+    throw new DetoxRuntimeError({
+      message: `Detected an unsupported jest@${actualVersion} version.`,
+      hint: `Please ${action} your Jest test runner to the supported range: ${supportedRange}.`
+    });
+  }
+}
+
+module.exports = {
+  assertJestCircus27,
+  assertSupportedVersion,
+};

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

@@ -0,0 +1,22 @@
+const { assertSupportedVersion } = require('./assertJestCircus27');
+
+describe('assertSupportedVersion', () => {
+  test.each([
+    ['27.2.5'],
+    ['27.2.6-prerelease.0'],
+    ['27.3.0'],
+    ['28.0.0-alpha.1'],
+    ['28.0.0'],
+    ['28.1.0'],
+    ['29.0.0-next.0'],
+  ])('should pass for %j', (version) => {
+    expect(() => assertSupportedVersion(version)).not.toThrow();
+  });
+
+  test.each([
+    ['26.0.0'],
+    ['27.2.4'],
+  ])('should throw an error for %j', (version) => {
+    expect(() => assertSupportedVersion(version)).toThrowError(/unsupported jest.*version/);
+  });
+});

package/runners/jest-circus/environment/index.js

@@ -0,0 +1,6 @@
+const path = require('path');
+
+module.exports = require('../../migration')(
+  __filename,
+  path.join(__dirname, '../../jest/testEnvironment/index.js')
+);

package/runners/jest-circus/index.js

@@ -1,10 +1 @@
-const SpecReporterCircus = require('../jest/SpecReporterCircus');
-const WorkerAssignReporterCircus = require('../jest/WorkerAssignReporterCircus');
-
-const DetoxCircusEnvironment = require('./environment');
-
-module.exports = {
-  DetoxCircusEnvironment,
-  SpecReporter: SpecReporterCircus,
-  WorkerAssignReporter: WorkerAssignReporterCircus,
-};
+module.exports = require('../migration')(__filename);

package/runners/jest-circus/reporter.js

@@ -0,0 +1 @@
+module.exports = require('../migration')(__filename);

package/runners/migration.js

@@ -0,0 +1,37 @@
+const path = require('path');
+
+const chalk = require('chalk');
+const _ = require('lodash');
+
+const SEARCH_VALUE = ['', 'detox', 'runners', 'jest-circus', ''].join(path.sep);
+const REPLACE_VALUE = ['', 'detox', 'runners', 'jest', ''].join(path.sep);
+
+function jsify(pathToFile) {
+  return 'detox/' + path
+    .relative(
+      path.join(__dirname, '..'),
+      pathToFile
+    )
+    .replace(/\\/g, '/')
+    .replace(/(?:\/index)?\.js$/, '');
+}
+
+const redirectWithWarning = _.memoize((
+  oldPath,
+  newPath = oldPath.replace(SEARCH_VALUE, REPLACE_VALUE)
+) => {
+  redirectWithWarning._log([
+    '[DEPRECATION] Detox detected an attempt to require a module from an outdated location, please change in your project:',
+    `- ${jsify(oldPath)}`,
+    `+ ${jsify(newPath)}`,
+    '',
+  ].join('\n'));
+
+  return require(newPath);
+});
+
+// @ts-ignore
+// istanbul ignore next
+redirectWithWarning._log = msg => process.stderr.write(chalk.yellow(msg) + '\n');
+
+module.exports = redirectWithWarning;

package/runners/mocha/DetoxMochaAdapter.js

@@ -1,35 +1,3 @@
-class DetoxMochaAdapter {
-  constructor(detox) {
-    this.detox = detox;
-  }
-
-  async beforeEach(context) {
-    await this.detox.beforeEach({
-      title: context.currentTest.title,
-      fullName: context.currentTest.fullTitle(),
-      status: this._mapStatus(context, false),
-    });
-  }
-
-  async afterEach(context) {
-    await this.detox.afterEach({
-      title: context.currentTest.title,
-      fullName: context.currentTest.fullTitle(),
-      status: this._mapStatus(context, true),
-      timedOut: context.currentTest.timedOut,
-    });
-  }
-
-  _mapStatus(context, isAfterTest) {
-    switch (context.currentTest.state) {
-      case 'passed':
-        return 'passed';
-      case 'failed':
-        return 'failed';
-      default:
-        return isAfterTest ? 'failed' : 'running';
-    }
-  }
-}
-
-module.exports = DetoxMochaAdapter;
+/** @deprecated */
+/** @type {never} */
+module.exports = require('../deprecation');

package/runners/mocha/adapter.d.ts

@@ -1,9 +1,6 @@
-interface DetoxMochaAdapter {
-    detox: Detox.DetoxExportWrapper;
-    beforeEach: (context: any) => Promise<void>;
-    afterEach: (context: any) => Promise<void>;
-}
-
-declare const adapter: DetoxMochaAdapter;
+/**
+ * @deprecated Mocha integration is no longer supported since Detox v20.0.0
+ */
+declare const adapter: never;
 
 export = adapter;

package/runners/mocha/adapter.js

@@ -1,5 +1,3 @@
-const detox = require('../../src/index');
-
-const DetoxMochaAdapter = require('./DetoxMochaAdapter');
-
-module.exports = new DetoxMochaAdapter(detox);
+/** @deprecated */
+/** @type {never} */
+module.exports = require('../deprecation');