detox 19.13.0 → 20.0.0

package/src/artifacts/timeline/TimelineArtifactPlugin.js

@@ -1,92 +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 TIMELINE_CONTEXT_TYPES = require('./TimelineContextTypes');
-
-const traceNoop = {
-  startSection: _noop,
-  endSection: _noop,
-};
-
-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: TIMELINE_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: TIMELINE_CONTEXT_TYPES.DESCRIBE });
-    await super.onRunDescribeFinish(suite);
-  }
-
-  async onTestStart(testSummary) {
-    this._trace.startSection(testSummary.title, { context: TIMELINE_CONTEXT_TYPES.TEST, ...testSummary });
-    await super.onTestStart(testSummary);
-  }
-
-  async onTestDone(testSummary) {
-    this._trace.endSection(testSummary.title, { context: TIMELINE_CONTEXT_TYPES.TEST, ...testSummary });
-    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/configuration/utils/warnings.js

@@ -1,12 +0,0 @@
-const DEVICE_LAUNCH_ARGS_DEPRECATION = `\
---device-launch-args is a deprecated name of this option.
-Please change your scripts to use --device-boot-args instead.`;
-
-const DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION = `\
---device-launch-args / $DETOX_DEVICE_LAUNCH_ARGS is a deprecated name of this option.
-Please change your scripts to use --device-boot-args / $DETOX_DEVICE_BOOT_ARGS instead.`;
-
-module.exports = {
-  DEVICE_LAUNCH_ARGS_DEPRECATION,
-  DEVICE_LAUNCH_ARGS_GENERIC_DEPRECATION,
-};

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/ChromeTracingExporter.js

@@ -1,54 +0,0 @@
-const _ = require('lodash');
-
-const DetoxRuntimeError = require('../errors/DetoxRuntimeError');
-
-class ChromeTracingExporter {
-  constructor({
-    process,
-    thread,
-  }) {
-    this._process = {
-      id: process.id,
-      name: process.name,
-    };
-    this._thread = {
-      id: thread.id,
-      name: thread.name,
-    };
-  }
-
-  export(traceEvents, append) {
-    const _events = _.flatMap(traceEvents, this._parseEvent.bind(this));
-    const json = JSON.stringify(_events);
-    const prefix = (append ? ',' : '[');
-    return `${prefix}${json.slice(1, -1)}`;
-  }
-
-  _parseEvent(event) {
-    const { name, ts, args, type } = event;
-    const tsInMicroseconds = ts * 1000;
-    switch (type) {
-      case 'start': return this._event(name, 'B', tsInMicroseconds, args);
-      case 'end': return this._event(name, 'E', tsInMicroseconds, args);
-      case 'init': return [
-          this._event('process_name', 'M', tsInMicroseconds, { name: this._process.name }),
-          this._event('thread_name', 'M', tsInMicroseconds, { name: this._thread.name }),
-        ];
-      default:
-        throw new DetoxRuntimeError({ message: `Invalid type '${type}' in event: ${event}` });
-    }
-  }
-
-  _event(name, phase, ts, args) {
-    return {
-      name,
-      pid: this._process.id,
-      tid: this._thread.id,
-      ts,
-      ph: phase,
-      args: { ...args },
-    };
-  }
-}
-
-module.exports = ChromeTracingExporter;

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;

package/src/utils/trace.js

@@ -1,96 +0,0 @@
-const assert = require('assert');
-
-const TIMELINE_CONTEXT_TYPES = require('../artifacts/timeline/TimelineContextTypes');
-
-class Trace {
-  constructor() {
-    this.events = [];
-  }
-
-  init(timestampProviderFn = Date.now) {
-    this._timestampProviderFn = timestampProviderFn;
-    this.events = [
-      this._event('init'),
-    ];
-  }
-
-  startSection(name, args) {
-    this.events.push(this._event('start', name, args));
-  }
-
-  endSection(name, args) {
-    this.events.push(this._event('end', name, args));
-  }
-
-  reset() {
-    this.events = [
-      this._event('init'),
-    ];
-  }
-
-  _event(type, name, args) {
-    return {
-      type,
-      ts: this._timestampProviderFn(),
-      name,
-      args,
-    };
-  }
-}
-
-let trace = new Trace();
-
-/**
- * Trace a single call, with a given name and arguments.
- * @param sectionName The name of the section to trace.
- * @param promiseOrFunction {Promise|Function} Promise or a function that provides a promise.
- * @param args {Object} Optional arguments to pass to the trace.
- * @returns {any} The returned value of the traced call.
- *
- * @see https://wix.github.io/Detox/docs/next/api/detox-object-api/#detoxtracecall.
- */
-function traceCall(sectionName, promiseOrFunction, args = {}) {
-  assert(sectionName,
-    `must provide section name when calling \`traceCall\` with args: \n ${JSON.stringify(args)}`);
-
-  const promise = typeof promiseOrFunction === 'function' ? promiseOrFunction() : promiseOrFunction;
-
-  trace.startSection(sectionName, args);
-  return promise
-    .then((result) => {
-      trace.endSection(sectionName, { ...args, success: true });
-      return result;
-    })
-    .catch((error) => {
-      trace.endSection(sectionName, { ...args, success: false, error: error.toString() });
-      throw error;
-    });
-}
-
-function traceInvocationCall(sectionName, invocation, promise) {
-  return traceCall(
-    sectionName, promise, {
-      context: TIMELINE_CONTEXT_TYPES.INVOCATION,
-      stackTrace: _getCallStackTrace(),
-      invocation: JSON.stringify(invocation),
-    });
-}
-
-function _getCallStackTrace() {
-  return new Error().stack
-    .split('\n')
-    .slice(1) // Ignore Error message
-    .map(line => line
-      .replace(/^\s*at\s+/, '')
-      .replace(process.cwd(), '')
-    )
-    .filter(line => !line.includes('/detox/src')) // Ignore detox internal calls
-    .join('\n');
-}
-
-module.exports = {
-  Trace,
-  trace,
-  traceCall,
-  traceInvocationCall
-};