detox 21.0.0-breaking.new-global-lifecycle.0 → 21.0.1-rc.0

package/scripts/build_universal_framework_modern.sh

@@ -1,28 +0,0 @@
-#!/bin/bash -e
-
-PROJECT=$1
-OUTPUT_DIR=$2
-CONFIGURATION=Release
-PROJECT_NAME=Detox
-
-# Make sure the output directory exists
-
-mkdir -p "${OUTPUT_DIR}"
-rm -fr "${OUTPUT_DIR}/${PROJECT_NAME}.framework"
-
-# Step 0. Xcode version
-
-USE_NEW_BUILD_SYSTEM="YES"
-echo "Using -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM}"
-
-# Step 1. Build Device and Simulator versions
-
-BUILD_SIM=`xcodebuild -project "${PROJECT}" -scheme "Detox" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -configuration "${CONFIGURATION}" -sdk iphonesimulator -destination "generic/platform=iOS Simulator" build -showBuildSettings  | awk -F= '/TARGET_BUILD_DIR/{x=$NF; gsub(/^[ \t]+|[ \t]+$/,"",x); print x}'`
-
-echo ${BUILD_SIM}
-
-xcodebuild -project "${PROJECT}" -scheme "Detox" -UseNewBuildSystem=${USE_NEW_BUILD_SYSTEM} -configuration "${CONFIGURATION}" -sdk iphonesimulator -destination "generic/platform=iOS Simulator" build -quiet
-
-# Step 2. Copy the framework to output folder
-
-cp -fR "${BUILD_SIM}/${PROJECT_NAME}.framework" "${OUTPUT_DIR}"/

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/common/drivers/android/tools/TempFileXfer.js

@@ -1,16 +0,0 @@
-// @ts-nocheck
-const FileXfer = require('./FileXfer');
-
-const EMU_TEMP_PATH = '/data/local/tmp';
-const EMU_TEMP_INSTALL_PATH = `${EMU_TEMP_PATH}/detox`;
-
-class TempFileXfer extends FileXfer {
-  /**
-   * @param adb { ADB }
-   */
-  constructor(adb) {
-    super(adb, EMU_TEMP_INSTALL_PATH);
-  }
-}
-
-module.exports = TempFileXfer;

package/src/ipc/state.js

@@ -1,76 +0,0 @@
-const cycle = require('json-cycle');
-
-const uuid = require('../utils/uuid');
-
-class SessionState {
-  patch(state) {
-    Object.assign(this, state);
-  }
-
-  stringify() {
-    return cycle.stringify(this, SessionState.stringifier);
-  }
-
-  /**
-   * @return {*}
-   */
-  static parse(stringified) {
-    const Class = this; // eslint-disable-line unicorn/no-this-assignment
-    // @ts-ignore
-    return new Class(cycle.parse(stringified, SessionState.reviver));
-  }
-
-  static reviver(key, val) {
-    if (typeof val === 'object' && typeof val.$fn == 'string') {
-      return eval(val.$fn);
-    } else {
-      return val;
-    }
-  }
-
-  static stringifier(key, val) {
-    if (typeof val === 'function') {
-      return { $fn: `(${val})` };
-    } else {
-      return val;
-    }
-  }
-}
-
-class SecondarySessionState extends SessionState {
-  constructor({
-    id = uuid.UUID(),
-    detoxConfigSnapshotPath = '',
-    detoxConfig = null,
-    detoxIPCServer = '',
-    failedTestFiles = [],
-    workerId = undefined,
-    workersCount = 0
-  }) {
-    super();
-
-    this.id = id;
-    this.detoxConfigSnapshotPath = detoxConfigSnapshotPath;
-    this.detoxConfig = detoxConfig;
-    this.detoxIPCServer = detoxIPCServer;
-    this.failedTestFiles = failedTestFiles;
-    this.workerId = workerId;
-    this.workersCount = workersCount;
-  }
-}
-
-class PrimarySessionState extends SecondarySessionState {
-  constructor({ contexts = [], failedTestFiles = [], logFiles = [], ...baseOpts }) {
-    super(baseOpts);
-
-    this.contexts = contexts;
-    this.failedTestFiles = failedTestFiles;
-    this.logFiles = logFiles;
-  }
-}
-
-module.exports = {
-  SessionState,
-  PrimarySessionState,
-  SecondarySessionState,
-};

package/src/logger/DetoxTraceEventBuilder.js

@@ -1,21 +0,0 @@
-const { AbstractEventBuilder } = require('trace-event-lib');
-
-class DetoxTraceEventBuilder extends AbstractEventBuilder {
-  constructor(forward) {
-    super();
-
-    this._forward = forward;
-  }
-
-  send(event) {
-    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-    const { pid, ts, name, args = {}, ...trace } = event;
-    if (trace.ph === 'E') {
-      this._forward({ ...args, trace }, `end`);
-    } else {
-      this._forward({ ...args, trace }, name);
-    }
-  }
-}
-
-module.exports = DetoxTraceEventBuilder;

package/src/logger/DetoxTracer.js

@@ -1,133 +0,0 @@
-const _ = require('lodash');
-
-const isPromise = require('../utils/isPromise');
-
-const DetoxTraceEventBuilder = require('./DetoxTraceEventBuilder');
-const TraceThreadDispatcher = require('./TraceThreadDispatcher');
-
-class DetoxTracer {
-  /**
-   * @param {object} options
-   * @param {Detox.Logger} options.logger
-   */
-  constructor({ logger }) {
-    this.logger = logger;
-    this.builder = new DetoxTraceEventBuilder(this.logger.trace);
-    this.categories = {};
-    this.defaultEventDispatcher = new TraceThreadDispatcher({
-      logger,
-      name: 'Default',
-      min: 10000,
-    });
-    this.eventDispatchers = { '': this.defaultEventDispatcher };
-  }
-
-  /**
-   * @param {Detox.TraceEvent | string} eventOrName
-   * @param {Detox.TraceEvent['args']} [args]
-   * @returns {import('trace-event-lib').EndHandle<Detox.TraceEvent>}
-   */
-  begin(eventOrName, args) {
-    const event = typeof eventOrName === 'string' ? { name: eventOrName, args } : eventOrName;
-    const mainCategory = event.cat ? event.cat.split(',', 1)[0] : '';
-    const dispatcher = this.eventDispatchers[mainCategory] || this.defaultEventDispatcher;
-    const tid = dispatcher.begin(event.id);
-
-    return this.builder.begin({
-      args: event.args,
-      cat: event.cat || '',
-      cname: event.cname,
-      name: event.name,
-      tid,
-    });
-  }
-
-  end(eventOrName, args) {
-    const event = typeof eventOrName === 'string' ? { name: eventOrName, args } : eventOrName || {};
-    const mainCategory = event.cat ? event.cat.split(',', 1)[0] : '';
-    const dispatcher = this.eventDispatchers[mainCategory] || this.defaultEventDispatcher;
-    const tid = dispatcher.end(event.id);
-
-    this.builder.end({
-      args: event.args,
-      cname: event.cname,
-      tid,
-    });
-  }
-
-  section(sectionName, func) {
-    let result;
-
-    this.begin(sectionName);
-    try {
-      result = func();
-      if (!isPromise(result)) {
-        this.end(sectionName, { success: true });
-      } else {
-        result.then(
-          () => this.end(sectionName, { success: true }),
-          (err) => this.end(sectionName, { success: false, err }),
-        );
-      }
-    } catch (err) {
-      this.end(sectionName, { success: false, err });
-      throw err;
-    }
-
-    return result;
-  }
-
-  registerThreads(event, [min, max]) {
-    this.eventDispatchers[event] = new TraceThreadDispatcher({
-      logger: this.logger,
-      name: event,
-      min,
-      max,
-    });
-
-    return this;
-  }
-
-  static default(options) {
-    const tracer = new DetoxTracer(options);
-    for (const [key, range] of Object.entries(this.CATEGORIES)) {
-      tracer.registerThreads(key, range);
-    }
-
-    return Object.assign(
-      tracer.section.bind(tracer),
-      {
-        begin: tracer.begin.bind(tracer),
-        startSection: tracer.begin.bind(tracer),
-        end: tracer.end.bind(tracer),
-        endSection: tracer.end.bind(tracer),
-      });
-  }
-
-  static categorize(tid) {
-    return _.findKey(this.CATEGORIES, ([min, max]) => min <= tid && tid <= max) || 'user';
-  }
-
-  static threadize(cat) {
-    const [mainCategory] = cat ? cat.split(',', 1) : 'user';
-    const threads = _.find(this.CATEGORIES, (_, key) => key === mainCategory);
-    return threads ? threads[0] : 10000;
-  }
-
-  /**
-   * @type {Record<string, [number, number]>}
-   */
-  static CATEGORIES = {
-    'lifecycle': [0, 0],
-    'ipc': [29, 29],
-    'ws-server': [50, 99],
-    'ws-client': [100, 149],
-    'device': [150, 159],
-    'artifacts-manager': [300, 300],
-    'artifact-plugin': [310, 349],
-    'artifact': [350, 399],
-    'child-process': [400, 499],
-  };
-}
-
-module.exports = DetoxTracer;

package/src/logger/TraceThreadDispatcher.js

@@ -1,52 +0,0 @@
-const isUndefined = (x) => x === undefined;
-
-class TraceThreadDispatcher {
-  /**
-   * @param {object} options
-   * @param {Detox.Logger} options.logger
-   * @param {string} options.name
-   * @param {number} options.min
-   * @param {number} [options.max]
-   */
-  constructor({ logger, name, min, max = Infinity }) {
-    this.logger = logger;
-    this.name = name;
-    this.min = min;
-    this.max = max;
-    this.stacks = [];
-    this.threads = [];
-  }
-
-  begin(id = 0) {
-    const tid = this._findTID(id);
-    this.threads[tid] = id;
-    this.stacks[tid] = (this.stacks[tid] || 0) + 1;
-    return this._transpose(tid);
-  }
-
-  end(id = 0) {
-    const tid = this._findTID(id);
-    if (this.stacks[tid] && --this.stacks[tid] === 0) {
-      delete this.threads[tid];
-    }
-    return this._transpose(tid);
-  }
-
-  _findTID(id) {
-    let tid = this.threads.indexOf(id);
-    if (tid === -1) {
-      tid = this.threads.findIndex(isUndefined);
-    }
-    return tid === -1 ? this.threads.length : tid;
-  }
-
-  _transpose(id) {
-    const result = this.min + id;
-    if (result > this.max) {
-      this.logger.warn({ event: 'THREAD_DISPATCHER' }, `${this.name} trace thread dispatcher has run out of available thread IDs: ${this.min}..${this.max}`);
-    }
-    return Math.min(result, this.max);
-  }
-}
-
-module.exports = TraceThreadDispatcher;

package/src/realms/index.js

@@ -1,10 +0,0 @@
-function current() {
-  if (process.env.DETOX_CONFIG_SNAPSHOT_PATH) {
-    return require('./secondary');
-  } else {
-    return require('./primary');
-  }
-}
-
-/** @type {DetoxInternals.Facade} */
-module.exports = global['__detox__'] || current();

package/src/utils/ChromeTracingExporter.js

@@ -1,53 +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;
-    switch (type) {
-      case 'start': return this._event(name, 'B', ts * 1000, args);
-      case 'end': return this._event(name, 'E', ts * 1000, args);
-      case 'init': return [
-          this._event('process_name', 'M', ts, { name: this._process.name }),
-          this._event('thread_name', 'M', ts, { name: this._thread.name }),
-        ];
-      default:
-        throw new DetoxRuntimeError(`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/streamUtils.js

@@ -1,214 +0,0 @@
-const { PassThrough, Transform } = require('stream');
-
-const bunyanDebugStream = require('bunyan-debug-stream');
-const duplexify = require('duplexify');
-const multiSort = require('multi-sort-stream');
-const pipe = require('multipipe');
-const JsonlParser = require('stream-json/jsonl/Parser');
-const stripAnsi = require('strip-ansi');
-const { AbstractEventBuilder } = require('trace-event-lib');
-
-const DetoxTracer = require('../logger/DetoxTracer');
-
-const log = require('./logger').child({ __filename });
-
-function compareTimestamps(a, b) {
-  return +(a.value.time > b.value.time) - +(a.value.time < b.value.time);
-}
-
-function mapTransform(fn) {
-  return new Transform({
-    objectMode: true,
-    transform(chunk, encoding, callback){
-      this.push(fn(chunk));
-      callback();
-    },
-  });
-}
-
-function flatMapTransform(fn) {
-  let index = 0;
-
-  return new Transform({
-    objectMode: true,
-    transform(chunk, encoding, callback){
-      const result = fn(chunk, index++);
-      if (Array.isArray(result)) {
-        // eslint-disable-next-line unicorn/no-array-method-this-argument
-        result.forEach(pushThis, this);
-      } else if (result) {
-        this.push(result);
-      }
-
-      callback();
-    },
-  });
-}
-
-function pushThis(x) {
-  return this.push(x);
-}
-
-function extractValue({ value }) {
-  value.msg = stripAnsi(value.msg);
-
-  if (typeof value.time === 'string') {
-    value.time = new Date(value.time);
-  }
-
-  return value;
-}
-
-function through() {
-  return new PassThrough({ objectMode: true });
-}
-
-function mergeSortedJSONL(jsonlStreams, comparator = compareTimestamps) {
-  const intermediate = mapTransform(extractValue);
-  const reemitError = (err) => intermediate.emit('error', err);
-  const addReemit = (stream) => stream.on('error', reemitError);
-  return pipe(multiSort(jsonlStreams.map(addReemit), comparator), intermediate, through());
-}
-
-function writeJSONL() {
-  return new JsonlStringer({
-    header: '',
-    delimiter: '\n',
-    footer: '',
-  });
-}
-
-function writeJSON() {
-  return new JsonlStringer({
-    header: '[\n\t',
-    delimiter: ',\n\t',
-    footer: '\n]\n',
-  });
-}
-
-function debugStream(options) {
-  const out = new PassThrough({ encoding: 'utf8' });
-  const writable = bunyanDebugStream.default({
-    ...options,
-    colors: false,
-    out,
-  });
-
-  return duplexify(writable, out, {
-    readableObjectMode: false,
-    writableObjectMode: true
-  });
-}
-
-class JsonlStringer extends Transform {
-  constructor({ replacer = undefined, header = '', delimiter = '\n', footer = '' } = {}) {
-    super({ writableObjectMode: true, readableObjectMode: false });
-
-    this._replacer = replacer;
-    this._header = header;
-    this._delimiter = delimiter;
-    this._footer = footer;
-  }
-
-  _transform(chunk, _, callback) {
-    if (this._header) {
-      this.push(this._header);
-    }
-
-    this.push(JSON.stringify(chunk, this._replacer));
-    this._transform = this._nextTransform;
-    callback(null);
-  }
-
-  _nextTransform(chunk, _, callback) {
-    this.push(this._delimiter + JSON.stringify(chunk, this._replacer));
-    callback(null);
-  }
-
-  _flush(callback) {
-    if (this._footer) {
-      this.push(this._footer);
-    }
-
-    callback();
-  }
-}
-
-class SimpleEventBuilder extends AbstractEventBuilder {
-  events = [];
-  send(event) {
-    this.events.push(event);
-  }
-}
-
-function chromeTraceStream() {
-  const knownPids = new Set();
-  const knownTids = new Set();
-
-  return flatMapTransform((data) => {
-    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-    const { pid, trace, msg, time, name: _name, hostname: _hostname, ...args } = data;
-    const tid = trace ? trace.tid : DetoxTracer.threadize(args.cat);
-    const ts = new Date(time).getTime() * 1E3;
-
-    const builder = new SimpleEventBuilder();
-    if (!knownPids.has(pid)) {
-      builder.process_name(pid === process.pid ? 'primary' : 'secondary', pid);
-      knownPids.add(pid);
-    }
-
-    const tidHash = `${pid}:${tid}`;
-    if (!knownTids.has(tidHash)) {
-      builder.thread_name(DetoxTracer.categorize(tid), tid, pid);
-      builder.thread_sort_index(tid, tid, pid);
-      knownTids.add(tidHash);
-    }
-
-    const event = { ph: 'i', ...data.trace, pid, tid, ts, args };
-    if (!trace || trace.ph !== 'E') {
-      event.name = msg || '';
-    }
-
-    builder.events.push(event);
-    return builder.events;
-  });
-}
-
-// TODO: create PR to https://github.com/mafintosh/duplexify
-// should be able to pass { error: false } to end-of-stream
-function preventErrorSubscriptions(emitter) {
-  const originalOn = emitter.on.bind(emitter);
-  emitter.on = (event, ...args) => {
-    if (event === 'error') {
-      return emitter;
-    }
-
-    return originalOn(event, ...args);
-  };
-
-  return emitter;
-}
-
-function readJSONL() {
-  const readable = new PassThrough({ objectMode: true });
-  const writable = JsonlParser.make({ checkErrors: true })
-    .on('error', (err) => {
-      if (err instanceof SyntaxError) {
-        log.debug({ event: 'JSONL_ERROR', err });
-        readable.end();
-      } else {
-        readable.emit('error', err);
-      }
-    });
-
-  return duplexify.obj(preventErrorSubscriptions(writable), writable.pipe(readable));
-}
-
-module.exports = {
-  readJSONL,
-  writeJSON,
-  writeJSONL,
-  mergeSortedJSONL,
-  debugStream,
-  chromeTraceStream,
-};

package/src/utils/trace.js

@@ -1,19 +0,0 @@
-/** @type {Detox.Tracer} */
-const trace = require('../..').trace;
-const traceCall = trace.bind(null);
-
-function traceMethods(obj, cat, methodNames) {
-  for (const name of methodNames) {
-    const originalMethod = obj[name];
-
-    obj[name] = function tracedMethod() {
-      return traceCall({ cat, name }, originalMethod.apply.bind(originalMethod, obj, arguments));
-    };
-  }
-}
-
-module.exports = {
-  trace,
-  traceCall,
-  traceMethods,
-};