detox 19.9.0 → 21.0.0-breaking.new-global-lifecycle.0

package/runners/jest/JestCircusEnvironment.js

@@ -1,38 +1,3 @@
-const maybeNodeEnvironment = require('jest-environment-node'); // eslint-disable-line node/no-extraneous-require
-// @ts-ignore
-const NodeEnvironment = maybeNodeEnvironment.default || maybeNodeEnvironment;
-
-/**
- * @see https://www.npmjs.com/package/jest-circus#overview
- */
-class JestCircusEnvironment extends NodeEnvironment {
-  constructor(config) {
-    super(config);
-    this.testEventListeners = [];
-
-    // Enable access to this instance (single in each worker's scope) by exposing a get-function.
-    // Note: whatever's set into this.global will be exported in that way. The reason behind it is that
-    // each suite is run inside a sandboxed JS context which scope is in fact this specific instance. See
-    // NodeEnvironment's constructor for more info, or https://jestjs.io/docs/en/configuration#testenvironment-string
-    // for additional ref.
-    this.global.detoxCircus = {
-      getEnv: () => this,
-    };
-  }
-
-  addEventsListener(listener) {
-    this.testEventListeners.push(listener);
-  }
-
-  async handleTestEvent(event, state) {
-    const name = event.name;
-
-    for (const listener of this.testEventListeners) {
-      if (typeof listener[name] === 'function') {
-        await listener[name](event, state);
-      }
-    }
-  }
-}
-
-module.exports = JestCircusEnvironment;
+/** @deprecated */
+/** @type {never} */
+module.exports = require('../deprecation');

package/runners/jest/adapter.d.ts

@@ -1,12 +1,6 @@
-interface DetoxJestAdapter extends Detox.CircusTestEventListenerBase {
-    detox: Detox.DetoxExportWrapper;
-    beforeEach: () => Promise<void>;
-    afterAll: () => Promise<void>;
-    // These are not publicly used, but are defined in order to overlap with the jasmine.CustomReporter interface (which is a weak interface)
-    specDone: () => void;
-    specStarted: () => void;
-}
-
-declare const adapter: DetoxJestAdapter;
+/***
+ * @deprecated Detox does not support old Jest integrations since v20.0.0
+ */
+declare const adapter: never;
 
 export = adapter;

package/runners/jest/adapter.js

@@ -1,6 +1,3 @@
-const detox = require('../../src/index');
-
-const runnerInfo = require('./runnerInfo');
-const DetoxAdapter = runnerInfo.isJestCircus ? require('./DetoxAdapterCircus') : require('./DetoxAdapterJasmine');
-
-module.exports = new DetoxAdapter(detox);
+/** @deprecated */
+/** @type {never} */
+module.exports = require('../deprecation');

package/runners/jest/assignReporter.d.ts

@@ -1,3 +1,6 @@
-declare const assignReporter: Detox.CircusTestEventListenerBase;
+/***
+ * @deprecated Detox does not support old Jest integrations since v20.0.0
+ */
+declare const assignReporter: never;
 
 export = assignReporter;

package/runners/jest/assignReporter.js

@@ -1,6 +1,3 @@
-const detox = require('../../src/index');
-
-const runnerInfo = require('./runnerInfo');
-
-const Reporter = runnerInfo.isJestCircus ? require('./WorkerAssignReporterCircus') : require('./WorkerAssignReporterJasmine');
-module.exports = new Reporter({ detox });
+/** @deprecated */
+/** @type {never} */
+module.exports = require('../deprecation');

package/runners/jest/deprecation.js

@@ -0,0 +1,25 @@
+const chalk = require('chalk');
+
+// @ts-ignore
+console.error(chalk.yellow(`
+=========================  THE NEW JOURNEY BEGINS  =============================
+
+                  https://wix.github.io/Detox/docs/guide/jest
+
+         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.
+
+                  https://wix.github.io/Detox/docs/guide/jest
+
+=========================  THE NEW JOURNEY BEGINS  =============================
+
+`));
+
+throw Object.assign(new Error(
+  '\n\nPlease follow the new Jest setup guide:\nhttps://wix.github.io/Detox/docs/guide/jest\n\n'
+), { stack: '' });

package/runners/jest/globalSetup.js

@@ -0,0 +1 @@
+module.exports = async () => require('../../internals').globalSetup();

package/runners/jest/globalTeardown.js

@@ -0,0 +1 @@
+module.exports = async () => require('../../internals').globalTeardown();

package/runners/jest/index.js

@@ -0,0 +1,21 @@
+module.exports = {
+  //#region *** Runner Realm ***
+
+  get DetoxCircusEnvironment() {
+    return require('./testEnvironment');
+  },
+
+  //#endregion
+
+  //#region *** Worker Realm ***
+
+  get globalSetup() {
+    return require('./globalSetup');
+  },
+
+  get globalTeardown() {
+    return require('./globalTeardown');
+  },
+
+  //#endregion
+};

package/runners/jest/reporter.js

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

package/runners/jest/reporters/DetoxReporter.js

@@ -0,0 +1,5 @@
+const { VerboseReporter: JestVerboseReporter } = require('@jest/reporters'); // eslint-disable-line node/no-extraneous-require
+
+class DetoxReporter extends JestVerboseReporter {}
+
+module.exports = DetoxReporter;

package/runners/jest/specReporter.d.ts

@@ -1,11 +1,6 @@
-interface SpecReporter extends Detox.CircusTestEventListenerBase {
-    // These are not publicly used, but are defined in order to overlap with the jasmine.CustomReporter interface (which is a weak interface)
-    suiteStarted: () => void;
-    suiteDone: () => void;
-    specDone: () => void;
-    specStarted: () => void;
-}
-
-declare const specReporter: SpecReporter;
+/***
+ * @deprecated Detox does not support old Jest integrations since v20.0.0
+ */
+declare const specReporter: never;
 
 export = specReporter;

package/runners/jest/specReporter.js

@@ -1,10 +1,3 @@
-const argparse = require('../../src/utils/argparse');
-
-const runnerInfo = require('./runnerInfo');
-
-if (argparse.getArgValue('reportSpecs') === 'true') {
-  const Reporter = runnerInfo.isJestCircus ? require('./SpecReporterCircus') : require('./SpecReporterJasmine');
-  module.exports = new Reporter();
-} else {
-  module.exports = {};
-}
+/** @deprecated */
+/** @type {never} */
+module.exports = require('../deprecation');

package/runners/jest/streamlineReporter.js

@@ -1,22 +1,3 @@
-// @ts-nocheck
-/*
- * This is here to make it easier for users to apply this reporter in config.json (naming-wise)
- * TODO: rename this file to reporter.js in the next major version (Detox 18)
- */
-
-const DetoxStreamlineJestReporter = require('./DetoxStreamlineJestReporter');
-const FailingTestsReporter = require('./FailingTestsReporter');
-
-class DetoxReporter extends DetoxStreamlineJestReporter {
-  constructor(globalConfig) {
-    super(globalConfig);
-    this._failingTestsReporter = new FailingTestsReporter();
-  }
-
-  async onRunComplete(contexts, results) {
-    await super.onRunComplete(contexts, results);
-    await this._failingTestsReporter.onRunComplete(contexts, results);
-  }
-}
-
-module.exports = DetoxReporter;
+/** @deprecated */
+/** @type {never} */
+module.exports = require('../deprecation');

package/runners/jest/testEnvironment/index.js

@@ -0,0 +1,155 @@
+// @ts-nocheck
+const maybeNodeEnvironment = require('jest-environment-node'); // eslint-disable-line node/no-extraneous-require
+const NodeEnvironment = maybeNodeEnvironment.default || maybeNodeEnvironment;
+
+const detox = require('../../../internals');
+const { DetoxError } = require('../../../src/errors');
+const Timer = require('../../../src/utils/Timer');
+
+const {
+  DetoxCoreListener,
+  DetoxInitErrorListener,
+  DetoxPlatformFilterListener,
+  SpecReporter,
+  WorkerAssignReporter
+} = require('./listeners');
+const assertExistingContext = require('./utils/assertExistingContext');
+const { assertJestCircus27 } = require('./utils/assertJestCircus27');
+
+const SYNC_CIRCUS_EVENTS = new Set([
+  'start_describe_definition',
+  'finish_describe_definition',
+  'add_hook',
+  'add_test',
+  'error',
+]);
+
+/**
+ * @see https://www.npmjs.com/package/jest-circus#overview
+ */
+class DetoxCircusEnvironment extends NodeEnvironment {
+  constructor(config, context) {
+    super(assertJestCircus27(config), assertExistingContext(context));
+
+    /** @private */
+    this._timer = null;
+    /** @private */
+    this._listenerFactories = {
+      DetoxInitErrorListener,
+      DetoxPlatformFilterListener,
+      DetoxCoreListener,
+      SpecReporter,
+      WorkerAssignReporter,
+    };
+    /** @protected */
+    this.testPath = context.testPath;
+    /** @protected */
+    this.testEventListeners = [];
+    /** @protected */
+    this.initTimeout = detox.config.runnerConfig.jest.initTimeout;
+  }
+
+  /** @override */
+  async setup() {
+    await super.setup();
+
+    await Timer.run({
+      description: `setting up Detox environment`,
+      timeout: this.initTimeout,
+      fn: async () => {
+        await this.initDetox();
+        this._instantiateListeners();
+      },
+    });
+  }
+
+  /** @override */
+  async handleTestEvent(event, state) {
+    const { name } = event;
+
+    if (SYNC_CIRCUS_EVENTS.has(name)) {
+      return this._handleTestEventSync(event, state);
+    }
+
+    this._timer = new Timer({
+      description: `handling jest-circus "${name}" event`,
+      timeout: state.testTimeout != null ? state.testTimeout : this.initTimeout,
+    });
+
+    try {
+      for (const listener of this.testEventListeners) {
+        if (typeof listener[name] !== 'function') {
+          continue;
+        }
+
+        try {
+          await this._timer.run(() => listener[name](event, state));
+        } catch (listenerError) {
+          this._logError(listenerError);
+          break;
+        }
+      }
+    } finally {
+      this._timer.dispose();
+      this._timer = null;
+    }
+  }
+
+  /** @override */
+  async teardown() {
+    await Timer.run({
+      description: `tearing down Detox environment`,
+      timeout: this.initTimeout,
+      fn: async () => {
+        await this.cleanupDetox();
+      },
+    });
+  }
+
+  /** @protected */
+  registerListeners(map) {
+    Object.assign(this._listenerFactories, map);
+  }
+
+  /**
+   * @protected
+   */
+  async initDetox() {
+    await detox.setup({
+      global: this.global,
+      workerId: +process.env.JEST_WORKER_ID,
+    });
+  }
+
+  /** @protected */
+  async cleanupDetox() {
+    await detox.teardown();
+  }
+
+  /** @private */
+  _handleTestEventSync(event, state) {
+    const { name } = event;
+
+    for (const listener of this.testEventListeners) {
+      if (typeof listener[name] === 'function') {
+        listener[name](event, state);
+      }
+    }
+  }
+
+  /** @private */
+  _instantiateListeners() {
+    for (const Listener of Object.values(this._listenerFactories)) {
+      this.testEventListeners.push(new Listener({
+        env: this,
+      }));
+    }
+  }
+
+  /** @private */
+  _logError(e) {
+    detox.log.error(DetoxError.format(e));
+  }
+}
+
+module.exports = DetoxCircusEnvironment;

package/runners/{jest-circus → jest/testEnvironment}/listeners/DetoxCoreListener.js

@@ -1,25 +1,18 @@
 // @ts-nocheck
 const _ = require('lodash');
 
-const {
-  onRunDescribeStart,
-  onTestStart,
-  onHookFailure,
-  onTestFnFailure,
-  onTestDone,
-  onRunDescribeFinish,
-} = require('../../integration').lifecycle;
-const { getFullTestName, hasTimedOut } = require('../../jest/utils');
+const detox = require('../../../..');
+const detoxInternals = require('../../../../internals');
+const { getFullTestName, hasTimedOut } = require('../utils');
 
 const RETRY_TIMES = Symbol.for('RETRY_TIMES');
 
 class DetoxCoreListener {
-  constructor({ detox, env }) {
+  constructor({ env }) {
     this._startedTests = new WeakSet();
     this._testsFailedBeforeStart = new WeakSet();
     this._env = env;
     this._testRunTimes = 1;
-    this.detox = detox;
   }
 
   _getTestInvocations(test) {
@@ -32,15 +25,22 @@ class DetoxCoreListener {
     }
   }
 
+  async setup() {
+    // Workaround to override Jest's expect
+    if (detoxInternals.config.behaviorConfig.init.exposeGlobals) {
+      this._env.global.expect = detox.expect;
+    }
+  }
+
   async run_describe_start({ describeBlock: { name, children } }) {
     if (children.length) {
-      await this.detox[onRunDescribeStart]({ name });
+      await detoxInternals.onRunDescribeStart({ name });
     }
   }
 
   async run_describe_finish({ describeBlock: { name, children } }) {
     if (children.length) {
-      await this.detox[onRunDescribeFinish]({ name });
+      await detoxInternals.onRunDescribeFinish({ name });
     }
   }
 
@@ -58,7 +58,7 @@ class DetoxCoreListener {
   }
 
   async hook_failure({ error, hook }) {
-    await this.detox[onHookFailure]({
+    await detoxInternals.onHookFailure({
       error,
       hook: hook.type,
     });
@@ -69,7 +69,7 @@ class DetoxCoreListener {
   }
 
   async test_fn_failure({ error }) {
-    await this.detox[onTestFnFailure]({ error });
+    await detoxInternals.onTestFnFailure({ error });
   }
 
   async _onBeforeActualTestStart(test) {
@@ -79,7 +79,7 @@ class DetoxCoreListener {
 
     this._startedTests.add(test);
 
-    await this.detox[onTestStart]({
+    await detoxInternals.onTestStart({
       title: test.name,
       fullName: getFullTestName(test),
       status: 'running',
@@ -89,7 +89,7 @@ class DetoxCoreListener {
 
   async test_done({ test }) {
     if (this._startedTests.has(test)) {
-      await this.detox[onTestDone]({
+      await detoxInternals.onTestDone({
         title: test.name,
         fullName: getFullTestName(test),
         status: test.errors.length ? 'failed' : 'passed',
@@ -100,6 +100,24 @@ class DetoxCoreListener {
       this._startedTests.delete(test);
     }
   }
+
+  async run_finish(_event, state) {
+    if (this._hasFailedTests(state.rootDescribeBlock)) {
+      await detoxInternals.reportFailedTests([this._env.testPath]);
+    }
+  }
+
+  _hasFailedTests(block) {
+    if (block.children) {
+      for (const child of block.children) {
+        if (this._hasFailedTests(child)) {
+          return true;
+        }
+      }
+    }
+
+    return block.errors ? block.errors.length > 0 : false;
+  }
 }
 
 module.exports = DetoxCoreListener;

package/runners/{jest-circus → jest/testEnvironment}/listeners/DetoxInitErrorListener.js

@@ -15,7 +15,7 @@ class DetoxInitErrorListener {
     if (!_.isEmpty(unhandledErrors)) {
       const currentTest = _.last(currentDescribeBlock.children);
       const dummyError = new Error('Environment setup failed. See the detailed error below.');
-      delete dummyError.stack;
+      dummyError.stack = '';
 
       currentTest.errors.push(dummyError);
     }

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

@@ -0,0 +1,27 @@
+const _ = require('lodash');
+
+const { device } = require('../../../..');
+
+const PLATFORM_REGEXP = /^:([^:]+):/;
+
+class DetoxPlatformFilterListener {
+  constructor() {
+    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,7 @@
 const chalk = require('chalk').default;
 
-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 +15,67 @@ class SpecReporter {
     this._suitesDesc = '';
   }
 
-  onSuiteStart({ description }) {
+  get enabled() {
+    const jestSection = config.runnerConfig.jest;
+    const reportSpecs = jestSection && jestSection.reportSpecs;
+
+    return reportSpecs !== undefined ? reportSpecs : session.workersCount === 1;
+  }
+
+  run_describe_start(event) {
+    if (!this.enabled) return;
+
+    if (event.describeBlock.parent !== undefined) {
+      this._onSuiteStart({
+        description: event.describeBlock.name,
+      });
+    }
+  }
+
+  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,
+      invocations: test.invocations,
+    });
+  }
+
+  test_done(event) {
+    if (!this.enabled) return;
+
+    const { test } = event;
+    const testInfo = {
+      description: test.name,
+      invocations: test.invocations,
+    };
+    this._onTestEnd(testInfo, test.errors.length ? 'failed' : 'success');
+  }
+
+  test_skip(event) {
+    if (!this.enabled) return;
+
+    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 +84,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;

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

@@ -0,0 +1,34 @@
+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.runnerConfig.jest.reportWorkerAssign) {
+      log.info({ event: 'WORKER_ASSIGN' }, `${this._formatTestName()} is assigned to ${this._formatDeviceName()}`);
+    }
+  }
+
+  _formatDeviceName() {
+    const deviceName = _.attempt(() => device.name);
+    const formattedDeviceName = _.isError(deviceName)
+      ? chalk.redBright('undefined')
+      : chalk.blueBright(deviceName);
+
+    return formattedDeviceName;
+  }
+
+  _formatTestName() {
+    return chalk.whiteBright(this._testName);
+  }
+}
+
+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;