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

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'
-});

package/src/DetoxExportWrapper.js

@@ -1,140 +0,0 @@
-// @ts-nocheck
-const funpermaproxy = require('funpermaproxy');
-
-const Detox = require('./Detox');
-const DetoxConstants = require('./DetoxConstants');
-const configuration = require('./configuration');
-const logger = require('./utils/logger');
-const log = logger.child({ __filename });
-const { trace, traceCall } = require('./utils/trace');
-
-const _detox = Symbol('detox');
-const _shouldLogInitError = Symbol('shouldLogInitError');
-
-class DetoxExportWrapper {
-  constructor() {
-    this[_detox] = Detox.none;
-    this[_shouldLogInitError] = true;
-
-    this.init = this.init.bind(this);
-    this.cleanup = this.cleanup.bind(this);
-
-    this.DetoxConstants = DetoxConstants;
-
-    this._definePassthroughMethod('beforeEach');
-    this._definePassthroughMethod('afterEach');
-    this._definePassthroughMethod('suiteStart');
-    this._definePassthroughMethod('suiteEnd');
-
-    this._definePassthroughMethod('element');
-    this._definePassthroughMethod('expect');
-    this._definePassthroughMethod('waitFor');
-
-    this._defineProxy('by');
-    this._defineProxy('device');
-    this._defineProxy('web');
-
-    this.trace = trace;
-    this.traceCall = traceCall;
-  }
-
-  async init(configOverride, userParams) {
-    let configError, exposeGlobals, resolvedConfig;
-
-    trace.init();
-    logger.reinitialize(Detox.global);
-
-    try {
-      resolvedConfig = await configuration.composeDetoxConfig({
-        override: configOverride,
-        userParams,
-      });
-
-      exposeGlobals = resolvedConfig.behaviorConfig.init.exposeGlobals;
-    } catch (err) {
-      configError = err;
-      exposeGlobals = true;
-    }
-
-    try {
-      if (exposeGlobals) {
-        Detox.none.initContext(Detox.global);
-      }
-
-      if (configError) {
-        throw configError;
-      }
-
-      this[_detox] = new Detox(resolvedConfig);
-      await traceCall('detoxInit', () => this[_detox].init());
-      Detox.none.setError(null);
-
-      return this[_detox];
-    } catch (err) {
-      if (this[_shouldLogInitError]) {
-        log.error({ event: 'DETOX_INIT_ERROR' }, '\n', err);
-      }
-
-      Detox.none.setError(err);
-      throw err;
-    }
-  }
-
-  async cleanup() {
-    Detox.none.cleanupContext(Detox.global);
-
-    if (this[_detox] !== Detox.none) {
-      await this[_detox].cleanup();
-      this[_detox] = Detox.none;
-    }
-  }
-
-  _definePassthroughMethod(name) {
-    this[name] = (...args) => {
-      return this[_detox][name](...args);
-    };
-  }
-
-  _defineProxy(name) {
-    this[name] = funpermaproxy(() => this[_detox][name]);
-  }
-
-  /** Use for test runners with sandboxed global */
-  _setGlobal(global) {
-    Detox.global = global;
-    return this;
-  }
-
-  /** @internal */
-  _suppressLoggingInitErrors() {
-    this[_shouldLogInitError] = false;
-    return this;
-  }
-}
-
-DetoxExportWrapper.prototype.hook = configuration.hook;
-
-DetoxExportWrapper.prototype.globalInit = async function() {
-  try {
-    // TODO This can only work in Jest, where config info etc. is available globally through env vars rather
-    //   than argv (e.g. in Mocha) -- which we don't have available here.
-    //   We will resolve this, ultimately, in https://github.com/wix/Detox/issues/2894 (DAS project), where
-    //   this whole hack would be removed altogether.
-    const configs = await configuration.composeDetoxConfig({});
-    await Detox.globalInit(configs);
-  } catch (error) {
-    log.warn({ event: 'GLOBAL_INIT' }, 'An error occurred!');
-    throw error;
-  }
-};
-
-DetoxExportWrapper.prototype.globalCleanup = async function() {
-  try {
-    const configs = await configuration.composeDetoxConfig({});
-    await Detox.globalCleanup(configs);
-  } catch (error) {
-    log.warn({ event: 'GLOBAL_CLEANUP' }, 'An error occurred!', error);
-  }
-};
-
-module.exports = DetoxExportWrapper;

package/src/artifacts/timeline/TimelineArtifactPlugin.js

@@ -1,95 +0,0 @@
-const fs = require('fs-extra');
-const _noop = require('lodash/noop');
-
-const ChromeTracingExporter = require('../../utils/ChromeTracingExporter');
-const fakeTimestampsProvider = require('../../utils/fakeTimestampsProvider');
-const { trace } = require('../../utils/trace');
-const FileArtifact = require('../templates/artifact/FileArtifact');
-const ArtifactPlugin = require('../templates/plugin/ArtifactPlugin');
-
-const traceNoop = {
-  startSection: _noop,
-  endSection: _noop,
-};
-
-const CONTEXT_TYPES = {
-  TEST: 'test',
-  DESCRIBE: 'describe'
-};
-
-class TimelineArtifactPlugin extends ArtifactPlugin {
-  constructor(config) {
-    super(config);
-    this._useFakeTimestamps = config.useFakeTimestamps;
-
-    const threadId = process.env.JEST_WORKER_ID || process.pid;
-    this._trace = this.enabled ? trace : traceNoop;
-    this._traceExporter = new ChromeTracingExporter({
-      process: { id: 0, name: 'detox' },
-      thread: { id: threadId, name: `Worker #${threadId}` },
-    });
-  }
-
-  async onBootDevice(event) {
-    this._deviceName = event.deviceId;
-    return super.onBootDevice(event);
-  }
-
-  async onRunDescribeStart(suite) {
-    const sectionName = (suite.name === 'ROOT_DESCRIBE_BLOCK' ? this._deviceName : suite.name);
-    this._trace.startSection(sectionName, { context: CONTEXT_TYPES.DESCRIBE });
-    await super.onRunDescribeStart(suite);
-  }
-
-  async onRunDescribeFinish(suite) {
-    const sectionName = (suite.name === 'ROOT_DESCRIBE_BLOCK' ? this._deviceName : suite.name);
-    this._trace.endSection(sectionName, { context: CONTEXT_TYPES.DESCRIBE });
-    await super.onRunDescribeFinish(suite);
-  }
-
-  async onTestStart(testSummary) {
-    this._trace.startSection(testSummary.title, { context: CONTEXT_TYPES.TEST });
-    await super.onTestStart(testSummary);
-  }
-
-  async onTestDone(testSummary) {
-    this._trace.endSection(testSummary.title, { status: testSummary.status, context: CONTEXT_TYPES.TEST });
-    await super.onTestDone(testSummary);
-  }
-
-  async onBeforeCleanup() {
-    this._deviceName = null;
-
-    if (!this.enabled) {
-      return;
-    }
-
-    const traceLogPath = await this.api.preparePathForArtifact(`detox.trace.json`);
-    const append = await this._logFileExists(traceLogPath);
-    const events = this._useFakeTimestamps ? this._transformEventTimestamps(trace.events) : trace.events;
-    const data = this._traceExporter.export(events, append);
-
-    const fileArtifact = new FileArtifact({ temporaryData: data });
-    await fileArtifact.save(traceLogPath, { append });
-  }
-
-  async _logFileExists(traceLogPath) {
-    return fs.access(traceLogPath).then(() => true).catch(() => false);
-  }
-
-  _transformEventTimestamps(events) {
-    return events.map((event) => ({
-      ...event,
-      ts: fakeTimestampsProvider(),
-    }));
-  }
-
-  /** @param {string} config */
-  static parseConfig(config) {
-    return {
-      enabled: config === 'all',
-    };
-  }
-}
-
-module.exports = TimelineArtifactPlugin;

package/src/devices/allocation/drivers/NoneAllocDriver.js

@@ -1,10 +0,0 @@
-const AllocationDriverBase = require('./AllocationDriverBase');
-
-class NoneAllocDriver extends AllocationDriverBase {
-  async allocate(deviceQuery) { // eslint-disable-line no-unused-vars
-    return null;
-  }
-  async free(cookie, options) {} // eslint-disable-line no-unused-vars
-}
-
-module.exports = NoneAllocDriver;

package/src/devices/allocation/factories/none.js

@@ -1,11 +0,0 @@
-// @ts-nocheck
-const DeviceAllocatorFactory = require('./base');
-
-class None extends DeviceAllocatorFactory {
-  _createDriver() {
-    const NoneAllocDriver = require('../drivers/NoneAllocDriver');
-    return new NoneAllocDriver();
-  }
-}
-
-module.exports = { None };

package/src/index.js

@@ -1,6 +0,0 @@
-if (global.detox) {
-  module.exports = global.detox;
-} else {
-  const DetoxExportWrapper = require('./DetoxExportWrapper');
-  module.exports = new DetoxExportWrapper();
-}