detox 19.9.1 → 20.0.2-breaking.new-global-lifecycle.0

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,
-};

package/runners/jest-circus/environment.js

@@ -1,206 +0,0 @@
-// @ts-nocheck
-const maybeNodeEnvironment = require('jest-environment-node'); // eslint-disable-line node/no-extraneous-require
-const NodeEnvironment = maybeNodeEnvironment.default || maybeNodeEnvironment;
-
-const DetoxError = require('../../src/errors/DetoxError');
-const Timer = require('../../src/utils/Timer');
-
-const DetoxCoreListener = require('./listeners/DetoxCoreListener');
-const DetoxInitErrorListener = require('./listeners/DetoxInitErrorListener');
-const assertExistingContext = require('./utils/assertExistingContext');
-const assertJestCircus26 = require('./utils/assertJestCircus26');
-const wrapErrorWithNoopLifecycle = require('./utils/wrapErrorWithNoopLifecycle');
-
-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(assertJestCircus26(config), assertExistingContext(context));
-
-    /** @private */
-    this._timer = null;
-    /** @private */
-    this._listenerFactories = {
-      DetoxInitErrorListener,
-      DetoxCoreListener,
-    };
-    /** @private */
-    this._calledDetoxInit = false;
-    /** @private */
-    this._calledDetoxCleanup = false;
-    /** @protected */
-    this.testPath = context.testPath;
-    /** @protected */
-    this.testEventListeners = [];
-    /** @protected */
-    this.initTimeout = 300000;
-  }
-
-  async setup() {
-    await super.setup();
-
-    this.global.detox = require('../../src')
-      ._setGlobal(this.global)
-      ._suppressLoggingInitErrors();
-  }
-
-  async teardown() {
-    try {
-      if (this._calledDetoxInit && !this._calledDetoxCleanup) {
-        await this._runEmergencyTeardown();
-      }
-    } finally {
-      await super.teardown();
-    }
-  }
-
-  get detox() {
-    return this.global.detox;
-  }
-
-  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: name === 'setup' ? this.initTimeout : state.testTimeout,
-    });
-
-    try {
-      if (name === 'setup') {
-        await this._onSetup(state);
-      }
-
-      for (const listener of this.testEventListeners) {
-        if (typeof listener[name] === 'function') {
-          try {
-            await this._timer.run(() => listener[name](event, state));
-          } catch (listenerError) {
-            this._logError(listenerError);
-          }
-        }
-      }
-
-      if (name === 'teardown') {
-        await this._onTeardown(state);
-      }
-    } finally {
-      this._timer.dispose();
-      this._timer = null;
-    }
-  }
-
-  _handleTestEventSync(event, state) {
-    const { name } = event;
-
-    for (const listener of this.testEventListeners) {
-      if (typeof listener[name] === 'function') {
-        listener[name](event, state);
-      }
-    }
-  }
-
-  async _onSetup(state) {
-    let detox;
-
-    try {
-      detox = await this._timer.run(async () => {
-        try {
-          this._calledDetoxInit = true;
-          return await this.initDetox();
-        } catch (actualError) {
-          state.unhandledErrors.push(actualError);
-          this._logError(actualError);
-          throw actualError;
-        }
-      });
-    } catch (maybeActualError) {
-      if (!state.unhandledErrors.includes(maybeActualError)) {
-        const timeoutError = maybeActualError;
-        state.unhandledErrors.push(timeoutError);
-        this._logError(timeoutError);
-      }
-
-      detox = wrapErrorWithNoopLifecycle(maybeActualError);
-    } finally {
-      this._timer.reset(state.testTimeout);
-    }
-
-    this._instantiateListeners(detox);
-  }
-
-  _instantiateListeners(detoxInstance) {
-    for (const Listener of Object.values(this._listenerFactories)) {
-      this.testEventListeners.push(new Listener({
-        detox: detoxInstance,
-        env: this,
-      }));
-    }
-  }
-
-  async _onTeardown(state) {
-    try {
-      this._calledDetoxCleanup = true;
-      await this._timer.run(() => this.cleanupDetox());
-    } catch (cleanupError) {
-      state.unhandledErrors.push(cleanupError);
-      this._logError(cleanupError);
-    }
-  }
-
-  async _runEmergencyTeardown() {
-    this._timer = new Timer({
-      description: `handling environment teardown`,
-      timeout: this.initTimeout,
-    });
-
-    try {
-      await this._timer.run(() => this.cleanupDetox());
-    } catch (cleanupError) {
-      this._logError(cleanupError);
-    } finally {
-      this._timer.dispose();
-      this._timer = null;
-    }
-  }
-
-  /** @private */
-  get _logger() {
-    return require('../../src/utils/logger');
-  }
-
-  /** @private */
-  _logError(e) {
-    this._logger.error(DetoxError.format(e));
-  }
-
-  /** @protected */
-  async initDetox() {
-    return this.detox.init();
-  }
-
-  /** @protected */
-  async cleanupDetox() {
-    return this.detox.cleanup();
-  }
-
-  /** @protected */
-  registerListeners(map) {
-    Object.assign(this._listenerFactories, map);
-  }
-}
-
-module.exports = DetoxCircusEnvironment;

package/runners/jest-circus/utils/assertJestCircus26.js

@@ -1,39 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const DetoxRuntimeError = require('../../../src/errors/DetoxRuntimeError');
-
-function assertJestCircus26(maybeProjectConfig) {
-  const projectConfig = maybeProjectConfig.projectConfig || maybeProjectConfig;
-
-  if (!/jest-circus/.test(projectConfig.testRunner)) {
-    throw new DetoxRuntimeError('Cannot run tests without "jest-circus" npm package, exiting.');
-  }
-
-  const circusPackageJson = path.join(path.dirname(projectConfig.testRunner), 'package.json');
-  if (!fs.existsSync(circusPackageJson)) {
-    throw new DetoxRuntimeError('Check that you have an installed copy of "jest-circus" npm package, exiting.');
-  }
-
-  const circusVersion = require(circusPackageJson).version || '';
-  const [major, minor, patch] = circusVersion.split('.');
-  if (major < 26) {
-    throw new DetoxRuntimeError(
-      `Cannot use older versions of "jest-circus", exiting.\n` +
-      `You have jest-circus@${circusVersion}. Update to ^26.0.0 or newer.`
-    );
-  }
-
-  if (major == 26 && minor == 5 && patch < 2) {
-    throw new DetoxRuntimeError(
-      `You have jest-circus@${circusVersion} currently installed.\n` +
-      `Unfortunately, it is incompatible with Detox due to this critical issue:\n\n` +
-      `https://github.com/wix/Detox/issues/2390\n\n` +
-      `Please update to jest-circus@^26.5.2 (or newer) to proceed.`
-    );
-  }
-
-  return maybeProjectConfig;
-}
-
-module.exports = assertJestCircus26;

package/runners/jest-circus/utils/wrapErrorWithNoopLifecycle.js

@@ -1,14 +0,0 @@
-const _ = require('lodash');
-
-const lifecycleSymbols = require('../../integration').lifecycle;
-
-function wrapErrorWithNoopLifecycle(error) {
-  const wrapper = { error };
-  for (const symbol of Object.values(lifecycleSymbols)) {
-    wrapper[symbol] = _.noop;
-  }
-
-  return wrapper;
-}
-
-module.exports = wrapErrorWithNoopLifecycle;

package/src/DetoxConstants.js

@@ -1,13 +0,0 @@
-module.exports = Object.freeze({
-  'userNotificationTriggers': {
-    'push': 'push',
-    'calendar': 'calendar',
-    'timeInterval': 'timeInterval',
-    'location': 'location'
-  },
-  'userActivityTypes': {
-    'searchableItem': 'com.apple.corespotlightitem',
-    'browsingWeb': 'NSUserActivityTypeBrowsingWeb',
-  },
-  'searchableItemActivityIdentifier': 'kCSSearchableItemActivityIdentifier'
-});