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

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

package/src/utils/MissingDetox.js

@@ -1,78 +0,0 @@
-const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
-
-class MissingDetox {
-  constructor() {
-    this.throwError = this.throwError.bind(this);
-    this.initContext(this);
-
-    this._defineRequiredProperty(this, 'beforeEach', async () => this.throwError(), true);
-    this._defineRequiredProperty(this, 'afterEach', async () => this.throwError(), true);
-  }
-
-  initContext(context) {
-    const readonly = context === this;
-
-    this._defineRequiredProperty(context, 'by', undefined, readonly);
-    this._defineRequiredProperty(context, 'device', undefined, readonly);
-    this._defineRequiredProperty(context, 'element', this.throwError, readonly);
-    this._defineRequiredProperty(context, 'expect', this.throwError, readonly);
-    this._defineRequiredProperty(context, 'waitFor', this.throwError, readonly);
-    this._defineRequiredProperty(context, 'web', undefined, readonly);
-  }
-
-  cleanupContext(context) {
-    this._cleanupProperty(context, 'by');
-    this._cleanupProperty(context, 'device');
-    this._cleanupProperty(context, 'element');
-    this._cleanupProperty(context, 'expect');
-    this._cleanupProperty(context, 'waitFor');
-  }
-
-  _cleanupProperty(context, name) {
-    if (context.hasOwnProperty(name)) {
-      context[name] = undefined;
-    }
-  }
-
-  _defineRequiredProperty(context, name, initialValue, readonly) {
-    if (context.hasOwnProperty(name)) {
-      return;
-    }
-
-    let _value = initialValue;
-
-    const descriptor = {
-      get: () => {
-        if (_value === undefined) {
-          this.throwError();
-        }
-
-        return _value;
-      },
-    };
-
-    if (!readonly) {
-      descriptor.set = (value) => {
-        _value = value;
-      };
-    }
-
-    Object.defineProperty(context, name, descriptor);
-  }
-
-  setError(err) {
-    this._lastError = err;
-  }
-
-  throwError() {
-    throw new DetoxRuntimeError({
-      message: 'Detox instance has not been initialized',
-      hint: this._lastError
-        ? 'There was an error on attempt to call detox.init()'
-        : 'Make sure to call detox.init() before your test begins',
-      debugInfo: this._lastError && this._lastError.stack || '',
-    });
-  }
-}
-
-module.exports = MissingDetox;

package/src/utils/fakeTimestampsProvider.js

@@ -1,9 +0,0 @@
-let _timestamp = 1000;
-
-function nextTimestamp() {
-  const timestamp = _timestamp;
-  _timestamp += 100;
-  return timestamp;
-}
-
-module.exports = nextTimestamp;

package/src/utils/getWorkerId.js

@@ -1,5 +0,0 @@
-function getWorkerId() {
-  return process.env.JEST_WORKER_ID;
-}
-
-module.exports = getWorkerId;

package/src/utils/lastFailedTests.js

@@ -1,38 +0,0 @@
-const fs = require('fs-extra');
-
-const environment = require('./environment');
-
-async function resetLastFailedTests() {
-  const lastFailedTxt = environment.getLastFailedTestsPath();
-  await fs.remove(lastFailedTxt);
-}
-
-async function loadLastFailedTests() {
-  const lastFailedTxt = environment.getLastFailedTestsPath();
-  const lastFailedTests = await fs.exists(lastFailedTxt)
-    ? (await fs.readFile(lastFailedTxt, 'utf8')).trim()
-    : '';
-
-  if (lastFailedTests) {
-    return lastFailedTests.split('\n');
-  } else {
-    return [];
-  }
-}
-
-/**
- * @async
- * @param {string[]} failedFiles - paths to the test suites
- */
-async function saveLastFailedTests(failedFiles) {
-  const failedTestsPath = environment.getLastFailedTestsPath();
-
-  await fs.ensureFile(failedTestsPath);
-  await fs.writeFile(failedTestsPath, failedFiles.join('\n'));
-}
-
-module.exports = {
-  resetLastFailedTests,
-  loadLastFailedTests,
-  saveLastFailedTests,
-};

package/src/utils/sh.js

@@ -1,18 +0,0 @@
-// @ts-nocheck
-const cpp = require('child-process-promise');
-
-const sh = new Proxy({}, {
-  get: function(target, prop) {
-    if (target[prop] === undefined) {
-      return target[prop] = (...params) => {
-        return cpp.exec(`${prop} ${params.join(' ')}`);
-      };
-    } else {
-      return target[prop];
-    }
-  }
-});
-
-process.env['PATH'] = `${process.env.PATH}:${sh.npm(`bin`)}`;
-
-module.exports = sh;