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

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