detox 19.9.1 → 20.0.2-breaking.new-global-lifecycle.0

package/src/utils/streamUtils.js

@@ -0,0 +1,214 @@
+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,54 +1,19 @@
-class Trace {
-  constructor() {
-    this.events = [];
-  }
-
-  init(timestampProviderFn = Date.now) {
-    this._timestampProviderFn = timestampProviderFn;
-    this.events = [
-      this._event('init'),
-    ];
-  }
+/** @type {Detox.Tracer} */
+const trace = require('../..').trace;
+const traceCall = trace.bind(null);
 
-  startSection(name, args) {
-    this.events.push(this._event('start', name, args));
-  }
-
-  endSection(name, args) {
-    this.events.push(this._event('end', name, args));
-  }
+function traceMethods(obj, cat, methodNames) {
+  for (const name of methodNames) {
+    const originalMethod = obj[name];
 
-  reset() {
-    this.events = [
-      this._event('init'),
-    ];
-  }
-
-  _event(type, name, args) {
-    return {
-      type,
-      ts: this._timestampProviderFn(),
-      name,
-      args,
+    obj[name] = function tracedMethod() {
+      return traceCall({ cat, name }, originalMethod.apply.bind(originalMethod, obj, arguments));
     };
   }
 }
 
-let trace = new Trace();
-async function traceCall(sectionName, func) {
-  trace.startSection(sectionName);
-  try {
-    const result = await func();
-    trace.endSection(sectionName, { success: true });
-    return result;
-  } catch (error) {
-    trace.endSection(sectionName, { success: false, error: error.toString() });
-    throw error;
-  }
-}
-
 module.exports = {
-  Trace,
   trace,
   traceCall,
+  traceMethods,
 };

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-javadoc.jar.md5

@@ -1 +0,0 @@
-31031f641f4838a7fd2cc69f228fab37

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-javadoc.jar.sha1

@@ -1 +0,0 @@
-546ba7c24a48941f2bdd2895c0f9eb97ec9f93f4

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-javadoc.jar.sha256

@@ -1 +0,0 @@
-98ed2bec49a0898295dbc63e4b01b3ec14b8ed8bc5f449f1ae13a8df46df8b94

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-javadoc.jar.sha512

@@ -1 +0,0 @@
-ac217f1f8c18c192a449aee7cad69612a371d2e4a82458c8830c1242515cb3e73c3fa43aeaf45bd71025bc84760ae818c82583a74c17f944b6ff5182b5935398

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-sources.jar.md5

@@ -1 +0,0 @@
-1a67a8520ffb42030572c079d6c8dd61

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-sources.jar.sha1

@@ -1 +0,0 @@
-18e724df796f8d00fa0029084092c30a75ad4acd

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-sources.jar.sha256

@@ -1 +0,0 @@
-8394ad55a508ce78e5512f9a10a96e64ee4bdf6c7972ffdb90c9a70fa63e1430

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1-sources.jar.sha512

@@ -1 +0,0 @@
-84deae513735699bec509d7b5e2baf4142aab527881bc2d1e53a88bde7e0553fb28e89fedf14213caaa7ac714917156f2fc4c0d8fb5c194199489f57112547e3

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.aar.md5

@@ -1 +0,0 @@
-f00a26db2932c0f5dd9e4ea695c5f55c

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.aar.sha1

@@ -1 +0,0 @@
-39dba13a0e694adb108fc6bb4d15b58b21a4eed5

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.aar.sha256

@@ -1 +0,0 @@
-c9897fd212cfefb379527e059f6f29a94f29c4681b3659e26f8f08b22e20d1ea

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.aar.sha512

@@ -1 +0,0 @@
-f12faacdbbcf214aba48971b1054310eca06c2a69d403404376b087d86beb76345e383bc6d452f6af8ec25b050895700bd930f8a33c9439153a972a179b3c763

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.pom.md5

@@ -1 +0,0 @@
-3198b870e3e7ed3180a7531904c72b4c

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.pom.sha1

@@ -1 +0,0 @@
-acd1cb11d1c3eb38773e06ccfc27bf92aa7a034c

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.pom.sha256

@@ -1 +0,0 @@
-baf4edbae2dfa7d970360e30273b05e3e555f022f507cc808329226e0f860882

package/Detox-android/com/wix/detox/19.9.1/detox-19.9.1.pom.sha512

@@ -1 +0,0 @@
-ef1d06b5ec6a0a06beb78fb6bba3c96d74b7c0da379a52f0023a07436a027b7fedfd14c8ede193c348ea668ba271e8364c3996c2d12f6d86cb8a399b4c75a57e

package/local-cli/templates/mocha.js

@@ -1,32 +0,0 @@
-const firstTestContent = require('./firstTestContent');
-
-const mochaRcContent = JSON.stringify({
-  recursive: true,
-  timeout: 120000,
-  bail: true,
-  file: 'e2e/init.js',
-}, null, 4);
-
-const initjsContent = `const detox = require('detox');
-const adapter = require('detox/runners/mocha/adapter');
-
-before(async () => {
-  await detox.init();
-});
-
-beforeEach(async function () {
-  await adapter.beforeEach(this);
-});
-
-afterEach(async function () {
-  await adapter.afterEach(this);
-});
-
-after(async () => {
-  await detox.cleanup();
-});
-`;
-
-exports.initjs = initjsContent;
-exports.firstTest = firstTestContent;
-exports.runnerConfig = mochaRcContent;

package/local-cli/utils/splitArgv.js

@@ -1,107 +0,0 @@
-const _ = require('lodash');
-
-const { resolveJestCliArgs } = require('./jestInternals');
-const testCommandArgs = require('./testCommandArgs');
-
-function extractKnownKeys(yargsBuilder) {
-  return Object.entries(yargsBuilder).reduce(
-    (set, [key, option]) => {
-      if (option.alias) {
-        if (Array.isArray(option.alias)) {
-          for (const value of option.alias) {
-            set.add(value);
-          }
-        } else {
-          set.add(option.alias);
-        }
-      }
-
-      return set.add(key);
-    },
-    new Set()
-  );
-}
-
-function disengageBooleanArgs(argv, booleanKeys) {
-  const result = {};
-  const passthrough = [];
-
-  for (const entry of Object.entries(argv)) {
-    const [key, value] = entry;
-    if (key === '_' || key === '--') {
-      continue;
-    }
-
-    const positiveKey = key.startsWith('no-') ? key.slice(3) : key;
-    if (booleanKeys.has(positiveKey) && typeof value !== 'boolean') {
-      result[positiveKey] = key === positiveKey;
-      passthrough.push(value);
-    } else {
-      result[key] = value;
-    }
-  }
-
-  return {
-    specs: passthrough.concat(argv._),
-    passthrough: {
-      _: argv['--'] || [],
-      ...result,
-    },
-  };
-}
-
-function getJestBooleanArgs() {
-  return _(resolveJestCliArgs())
-    .thru(args => args.options)
-    .pickBy(({ type }) => type === 'boolean')
-    .thru(extractKnownKeys)
-    .value();
-}
-
-function getMochaBooleanArgs() {
-  const metadata = require('mocha/lib/cli/run-option-metadata');
-
-  return _(metadata.types.boolean)
-    .flatMap(key => [key, ...(metadata.aliases[key] || [])])
-    .thru(keys => new Set(keys))
-    .value();
-}
-
-function splitDetoxArgv(argv) {
-  const aliases = extractKnownKeys(testCommandArgs);
-  const isDetoxArg = (_value, key) => aliases.has(key);
-
-  const detoxArgs = _.pickBy(argv, isDetoxArg);
-  const runnerArgs = _.omitBy(argv, isDetoxArg);
-  runnerArgs._ = runnerArgs._.slice(1); // omit 'test' string, as in 'detox test'
-  if (typeof detoxArgs['debug-synchronization'] === 'string') {
-    const erroneousPassthrough = detoxArgs['debug-synchronization'];
-    detoxArgs['debug-synchronization'] = 3000;
-    runnerArgs._.unshift(erroneousPassthrough);
-  }
-
-  return { detoxArgs, runnerArgs };
-}
-
-function splitMochaArgv(argv) {
-  return disengageBooleanArgs(argv, getMochaBooleanArgs());
-}
-
-function splitJestArgv(argv) {
-  return realiasJestArgv(disengageBooleanArgs(argv, getJestBooleanArgs()));
-}
-
-function realiasJestArgv({ specs, passthrough }) {
-  if (passthrough.hasOwnProperty('t')) {
-    passthrough.testNamePattern = passthrough.t;
-    delete passthrough.t;
-  }
-
-  return { specs, passthrough };
-}
-
-module.exports = {
-  detox: splitDetoxArgv,
-  jest: splitJestArgv,
-  mocha: splitMochaArgv,
-};

package/runners/integration.js

@@ -1,16 +0,0 @@
-module.exports = {
-  lifecycle: {
-    onRunStart: Symbol('run_start'),
-    onRunDescribeStart: Symbol('run_describe_start'),
-    onTestStart: Symbol('test_start'),
-    onHookStart: Symbol('hook_start'),
-    onHookFailure: Symbol('hook_failure'),
-    onHookSuccess: Symbol('hook_success'),
-    onTestFnStart: Symbol('test_fn_start'),
-    onTestFnFailure: Symbol('test_fn_failure'),
-    onTestFnSuccess: Symbol('test_fn_success'),
-    onTestDone: Symbol('test_done'),
-    onRunDescribeFinish: Symbol('run_describe_finish'),
-    onRunFinish: Symbol('run_finish'),
-  },
-};

package/runners/jest/DetoxAdapterCircus.js

@@ -1,60 +0,0 @@
-const DetoxAdapter = require('./DetoxAdapterImpl');
-const { getFullTestName, hasTimedOut } = require('./utils');
-
-class DetoxAdapterCircus {
-  constructor(detox) {
-    this._adapter = new DetoxAdapter(detox, DetoxAdapterCircus._describeInitError);
-  }
-
-  static _describeInitError() {
-    return {
-      message: 'Detox adapter to Jest is malfunctioning.',
-      hint: `Make sure you register it as a test-event listener inside init.js:\n` +
-        `-------------------------------------------------------------\n` +
-        'detoxCircus.getEnv().addEventsListener(adapter);',
-      };
-  }
-
-  async beforeEach() {
-    await this._adapter.beforeEach();
-  }
-
-  async afterAll() {
-    await this._adapter.afterAll();
-  }
-
-  async run_describe_start({ describeBlock: { name, children } }, state) { // eslint-disable-line no-unused-vars
-    if (children.length) await this._adapter.suiteStart({ name });
-  }
-
-  async run_describe_finish({ describeBlock: { name, children } }, state) { // eslint-disable-line no-unused-vars
-    if (children.length) await this._adapter.suiteEnd({ name });
-  }
-
-  test_start(event) {
-    const { test } = event;
-    if (test.mode === 'skip' || test.mode === 'todo' || test.errors.length > 0) {
-      return;
-    }
-
-    this._adapter.testStart({
-      title: test.name,
-      fullName: getFullTestName(test),
-      status: 'running',
-    });
-  }
-
-  test_done(event) {
-    const { test } = event;
-    this._adapter.testComplete({
-      status: test.errors.length ? 'failed' : 'passed',
-      timedOut: hasTimedOut(test)
-    });
-  }
-
-  test_skip(event) { // eslint-disable-line no-unused-vars
-    // Ignored (for clarity)
-  }
-}
-
-module.exports = DetoxAdapterCircus;

package/runners/jest/DetoxAdapterImpl.js

@@ -1,81 +0,0 @@
-const DetoxRuntimeError = require('../../src/errors/DetoxRuntimeError');
-const log = require('../../src/utils/logger').child({ __filename });
-
-class DetoxAdapterImpl {
-  constructor(detox, describeInitErrorFn) {
-    if (process.env.DETOX_RERUN_INDEX) {
-      log.warn(
-        'While Detox CLI supports "-R <N>, --retries <N>" mechanism, ' +
-        'this outdated Jest integration does not — expect artifacts issues. ' +
-        'Please migrate to the new Jest Circus integration.\n\n' +
-        'See: https://wix.github.io/Detox/docs/api/guide/jest\n');
-    }
-
-    this.detox = detox;
-    this._describeInitError = describeInitErrorFn;
-    this._currentTest = null;
-    this._todos = [];
-  }
-
-  async beforeEach() {
-    if (!this._currentTest) {
-      throw new DetoxRuntimeError(this._describeInitError());
-    }
-
-    const currentTest = this._currentTest;
-
-    await this._flush();
-    await this.detox.beforeEach(currentTest);
-  }
-
-  async afterAll() {
-    await this._flush();
-  }
-
-  async suiteStart({ name }) {
-    this._enqueue(() => this.detox.suiteStart({ name }));
-  }
-
-  async suiteEnd({ name }) {
-    this._enqueue(() => this.detox.suiteEnd({ name }));
-  }
-
-  testStart({ title, fullName, status }) {
-    this._currentTest = {
-      title,
-      fullName,
-      status,
-    };
-  }
-
-  testComplete({ status, timedOut }) {
-    if (this._currentTest) {
-      const _test = {
-        ...this._currentTest,
-        status,
-        timedOut,
-      };
-
-      this._currentTest = null;
-      this._enqueue(() => this._afterEach(_test));
-    }
-  }
-
-  async _afterEach(previousTest) {
-    await this.detox.afterEach(previousTest);
-  }
-
-  _enqueue(fn) {
-    this._todos.push(fn);
-  }
-
-  async _flush() {
-    const t = this._todos;
-
-    while (t.length > 0) {
-      await Promise.resolve().then(t.shift()).catch(()=>{});
-    }
-  }
-}
-
-module.exports = DetoxAdapterImpl;