detox 19.7.0 → 20.0.0-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.7.0/detox-19.7.0-javadoc.jar.md5

@@ -1 +0,0 @@
-79fdb56017f0147da0e0e4dd6f350b99

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

@@ -1 +0,0 @@
-362d43b822bd19f2846daf501b926fe3a5c4a711

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

@@ -1 +0,0 @@
-851b8010ef6d2e2c8aebdeb3f55a6b66e445b4fd3efd9aa6391ca582383d8f7d

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

@@ -1 +0,0 @@
-978250d24965a75710bf16dc7c4ea5e72972bf4a09181c0a7c59e3cadc299394a71c67e3b25bb55fb1b404c5cef5b521af4c2e16870be47fe1d26ed4e40a1b1e

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

@@ -1 +0,0 @@
-81459bd345745decad426d64952cbde8

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

@@ -1 +0,0 @@
-08999bd9c01d6d6a99c562370854597eceba54cd

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

@@ -1 +0,0 @@
-1cf580c784df4c70609a6995ccaf89e1af3a4d69576c358d522c248d21fd8b89

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

@@ -1 +0,0 @@
-2986b74ea1d6abfba94a40bd38728b9053e9c45ef111d503db76086e23743a49fbd207f5432938d62f54c5b925926baacd6266f013be0e6eb50538a196bac9b3

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

@@ -1 +0,0 @@
-7945a7445d0b1cb59209d62b4a92c8f8

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

@@ -1 +0,0 @@
-f3372a6e1f7d640c0e587d6fd033416ffed65e04

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

@@ -1 +0,0 @@
-9b991a716a5adf5c5bb5700528e03dd4c9933053153bf91ac203c0e7de25c152

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

@@ -1 +0,0 @@
-a67051ecc46747c7dc6b10b1a08ec3c795ebbd001276d77e798f210cff69c49704bcf35d926e55abe4f148085a2955b2cb8987d33f939b5898eef4f06de15b26

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

@@ -1 +0,0 @@
-617b4e31171dd5f37b0a7da053246316

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

@@ -1 +0,0 @@
-1ddb43e2443fbabd7d1849f51790550c13763106

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

@@ -1 +0,0 @@
-37288619efa08c7202001b3c5e50038cdf5053041cfcb5044ddd235eba3d8f42

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

@@ -1 +0,0 @@
-9f81ad0ed181932a2f4242c28ec3cfaa3fa0fd5b3d94a4d1d355f4efb0c13ef51185a3defc6ed06fb995b8d99ef19d140911fc8f90a4952a211c6077193ece9e

package/android/detox/src/full/java/com/wix/detox/espresso/action/AdjustSliderToPositionAction.kt

@@ -1,22 +0,0 @@
-package com.wix.detox.espresso.action
-
-import android.view.View
-import androidx.appcompat.widget.AppCompatSeekBar
-import androidx.test.espresso.UiController
-import androidx.test.espresso.ViewAction
-import androidx.test.espresso.matcher.ViewMatchers.isAssignableFrom
-import androidx.test.espresso.matcher.ViewMatchers.isDisplayed
-import com.wix.detox.espresso.common.SliderHelper
-import org.hamcrest.Matcher
-import org.hamcrest.Matchers
-
-class AdjustSliderToPositionAction(private val targetPositionPct: Double) : ViewAction {
-    override fun getDescription() = "adjustSliderToPosition"
-    override fun getConstraints(): Matcher<View?>? =
-        Matchers.allOf( isDisplayed(), isAssignableFrom(AppCompatSeekBar::class.java) )
-
-    override fun perform(uiController: UiController?, view: View) {
-        val sliderHelper = SliderHelper.create(view)
-        sliderHelper.setProgressPct(targetPositionPct)
-    }
-}

package/android/detox/src/full/java/com/wix/detox/espresso/common/SliderHelper.kt

@@ -1,75 +0,0 @@
-package com.wix.detox.espresso.common
-
-import android.view.View
-import androidx.appcompat.widget.AppCompatSeekBar
-import com.facebook.react.bridge.JavaOnlyMap
-import com.facebook.react.uimanager.ReactStylesDiffMap
-import com.facebook.react.views.slider.ReactSlider
-import com.wix.detox.common.DetoxErrors.DetoxIllegalStateException
-import com.wix.detox.espresso.action.common.ReflectUtils
-import org.joor.Reflect
-
-private const val CLASS_REACT_SLIDER_LEGACY = "com.facebook.react.views.slider.ReactSlider"
-private const val CLASS_REACT_SLIDER_COMMUNITY = "com.reactnativecommunity.slider.ReactSlider"
-
-abstract class SliderHelper(protected val slider: AppCompatSeekBar) {
-    fun getCurrentProgressPct(): Double {
-        val nativeProgress = slider.progress.toDouble()
-        val nativeMax = slider.max
-        return nativeProgress / nativeMax
-    }
-
-    // TODO Make this more testable (e.g. by delegating the set action away)
-    fun setProgressPct(valuePct: Double) {
-        val maxJSProgress = calcMaxJSProgress()
-        val valueJS = valuePct * maxJSProgress
-        setProgressJS(valueJS)
-    }
-
-    protected abstract fun setProgressJS(valueJS: Double)
-
-    private fun calcMaxJSProgress(): Double {
-        val nativeProgress = slider.progress.toDouble()
-        val nativeMax = slider.max
-        val toMaxFactor = nativeMax / nativeProgress
-
-        val jsProgress = getJSProgress()
-        return jsProgress * toMaxFactor
-    }
-
-    private fun getJSProgress(): Double =
-        Reflect.on(slider).call("toRealProgress", slider.progress).get() as Double
-
-    companion object {
-        fun create(view: View) =
-            maybeCreate(view)
-                ?: throw DetoxIllegalStateException("Cannot handle this type of a seek-bar view (Class ${view.javaClass.canonicalName}). " +
-                        "Only React Native sliders are currently supported.")
-
-        fun maybeCreate(view: View): SliderHelper? =
-            when {
-                ReflectUtils.isAssignableFrom(view, CLASS_REACT_SLIDER_LEGACY)
-                   -> LegacySliderHelper(view as ReactSlider)
-                ReflectUtils.isAssignableFrom(view, CLASS_REACT_SLIDER_COMMUNITY)
-                    -> CommunitySliderHelper(view as AppCompatSeekBar)
-                else
-                   -> null
-            }
-    }
-}
-
-private class LegacySliderHelper(slider: AppCompatSeekBar): SliderHelper(slider) {
-    override fun setProgressJS(valueJS: Double) {
-        val reactSliderManager = com.facebook.react.views.slider.ReactSliderManager()
-        reactSliderManager.updateProperties(slider as ReactSlider, buildStyles("value", valueJS))
-    }
-
-    private fun buildStyles(vararg keysAndValues: Any) = ReactStylesDiffMap(JavaOnlyMap.of(*keysAndValues))
-}
-
-private class CommunitySliderHelper(slider: AppCompatSeekBar): SliderHelper(slider) {
-    override fun setProgressJS(valueJS: Double) {
-        val reactSliderManager = Class.forName("com.reactnativecommunity.slider.ReactSliderManager").newInstance()
-        Reflect.on(reactSliderManager).call("setValue", slider, valueJS)
-    }
-}

package/android/detox/src/main/java/com/wix/detox/espresso/action/common/ReflectUtils.kt

@@ -1,10 +0,0 @@
-package com.wix.detox.espresso.action.common
-
-object ReflectUtils {
-    fun isAssignableFrom(source: Any, className: String) =
-        try {
-            Class.forName(className).isAssignableFrom(source.javaClass)
-        } catch (ex: ClassNotFoundException) {
-            false
-        }
-}

package/android/detox/src/testFull/java/com/wix/detox/espresso/common/SliderHelperTest.kt

@@ -1,39 +0,0 @@
-package com.wix.detox.espresso.common
-
-import com.facebook.react.views.slider.ReactSlider
-import org.assertj.core.api.Assertions.assertThat
-import org.junit.Before
-import org.junit.Test
-import org.junit.runner.RunWith
-import org.mockito.kotlin.doReturn
-import org.mockito.kotlin.mock
-import org.mockito.kotlin.whenever
-import org.robolectric.RobolectricTestRunner
-
-/**
- * Note: This only tests against the react *legacy* (non-community) slider in order
- * to avoid having to install the community slider under node_modules just for this.
- */
-@RunWith(RobolectricTestRunner::class)
-class SliderHelperTest {
-    lateinit var slider: ReactSlider
-    lateinit var uut: SliderHelper
-
-    @Before
-    fun setup() {
-        slider = mock()
-        uut = SliderHelper.create(slider)
-    }
-
-    private fun givenNativeProgressTraits(current: Int, max: Int) {
-        whenever(slider.progress).doReturn(current)
-        whenever(slider.max).doReturn(max)
-    }
-
-    @Test
-    fun `should properly calculate current progress, in percentage`() {
-        givenNativeProgressTraits(current = 20, max = 100)
-
-        assertThat(uut.getCurrentProgressPct()).isEqualTo(0.2)
-    }
-}

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'),
-  },
-};