detox 19.7.1 → 20.0.0-breaking.new-global-lifecycle.0

package/src/utils/logger.js

@@ -1,164 +1,4 @@
-// @ts-nocheck
-
-const path = require('path');
-
-const bunyan = require('bunyan');
-const bunyanDebugStream = require('bunyan-debug-stream');
-const fs = require('fs-extra');
-const onExit = require('signal-exit');
-
-const temporaryPath = require('../artifacts/utils/temporaryPath');
-
-const argparse = require('./argparse');
-const customConsoleLogger = require('./customConsoleLogger');
-const { shortFormat: shortDateFormat } = require('./dateUtils');
-
-function adaptLogLevelName(level) {
-  switch (level) {
-    case 'fatal':
-    case 'error':
-    case 'warn':
-    case 'info':
-    case 'debug':
-    case 'trace':
-      return level;
-
-    case 'verbose':
-      return 'debug';
-
-    default:
-      return 'info';
-  }
-}
-
-function tryOverrideConsole(logger, global) {
-  if (argparse.getArgValue('use-custom-logger') === 'true') {
-    const userLogger = logger.child({ component: 'USER_LOG' });
-    customConsoleLogger.overrideConsoleMethods(global.console, userLogger);
-  }
-}
-
-function createPlainBunyanStream({ logPath, level, showDate = true }) {
-  const options = {
-    showDate: showDate,
-    showLoggerName: true,
-    showPid: true,
-    showMetadata: false,
-    basepath: __dirname,
-    out: process.stderr,
-    prefixers: {
-      '__filename': (filename, { entry }) => {
-        if (entry.event === 'USER_LOG') {
-          return '';
-        }
-
-        if (entry.event === 'ERROR') {
-          return `${filename}/${entry.event}`;
-        }
-
-        return entry.event ? entry.event : filename;
-      },
-      'trackingId': id => ` #${id}`,
-      'cpid': pid => ` cpid=${pid}`,
-    },
-  };
-
-  if (logPath) {
-    options.colors = false;
-    options.out = fs.createWriteStream(logPath, {
-      flags: 'a',
-    });
-  }
-
-  if (argparse.getFlag('--no-color')) {
-    options.colors = false;
-  }
-
-  return {
-    level,
-    type: 'raw',
-    stream: bunyanDebugStream(options),
-    serializers: bunyanDebugStream.serializers,
-  };
-}
-
 /**
- * @returns {Logger}
+ * @type {Detox.Logger}
  */
-function init() {
-  const levelFromArg = argparse.getArgValue('loglevel', 'l');
-  const level = adaptLogLevelName(levelFromArg);
-  const debugStream = createPlainBunyanStream({ level, showDate: shortDateFormat });
-  const bunyanStreams = [debugStream];
-
-  let jsonFileStreamPath, plainFileStreamPath;
-  if (!global.DETOX_CLI && !global.IS_RUNNING_DETOX_UNIT_TESTS) {
-    {
-      jsonFileStreamPath = temporaryPath.for.log();
-      fs.ensureFileSync(jsonFileStreamPath);
-      bunyanStreams.push({
-        level: 'trace',
-        path: jsonFileStreamPath,
-      });
-    }
-    {
-      plainFileStreamPath = temporaryPath.for.log();
-      fs.ensureFileSync(plainFileStreamPath);
-      bunyanStreams.push(createPlainBunyanStream({
-        level: 'trace',
-        logPath: plainFileStreamPath,
-      }));
-    }
-
-    onExit(() => {
-      try { fs.unlinkSync(jsonFileStreamPath); } catch (e) {}
-      try { fs.unlinkSync(plainFileStreamPath); } catch (e) {}
-    });
-  }
-
-  const logger = bunyan.createLogger({
-    name: 'detox',
-    streams: bunyanStreams,
-  });
-
-  if (jsonFileStreamPath) {
-    logger.jsonFileStreamPath = jsonFileStreamPath;
-  }
-
-  if (plainFileStreamPath) {
-    logger.plainFileStreamPath = plainFileStreamPath;
-  }
-
-  tryOverrideConsole(logger, global);
-
-  logger.getDetoxLevel = () => level;
-
-  logger.reinitialize = (global) => {
-    if (jsonFileStreamPath) {
-      fs.ensureFileSync(jsonFileStreamPath);
-    }
-
-    if (plainFileStreamPath) {
-      fs.ensureFileSync(plainFileStreamPath);
-    }
-
-    tryOverrideConsole(logger, global);
-  };
-
-  const originalChild = logger.child.bind(logger);
-
-  logger.child = (options) => {
-    if (options && options.__filename) {
-      return originalChild({
-        ...options,
-        __filename: path.basename(options.__filename)
-      });
-    }
-
-    return originalChild(options);
-  };
-
-  return logger;
-}
-
-module.exports = init();
+module.exports = require('../..').log;

package/src/utils/shellUtils.js

@@ -1,7 +1,17 @@
+const SPACE = ' ';
 const BACK_SLASH = '\\';
 const SINGLE_QUOTE = "'";
 const DOUBLE_QUOTE = '"';
 
+function escapeSpacesCMD(str) {
+  return str.includes(' ') ? `"${str}"` : str;
+}
+
+const BACK_SLASH_SPACE = BACK_SLASH + SPACE;
+function escapeSpacesShell(str) {
+  return str.replace(/ /g, BACK_SLASH_SPACE);
+}
+
 const ESCAPED_DOUBLE_QUOTE = BACK_SLASH + DOUBLE_QUOTE;
 function escapeInDoubleQuotedString(fragment) {
   return fragment.replace(/"/g, ESCAPED_DOUBLE_QUOTE);
@@ -62,12 +72,20 @@ const autoEscape = isRunningInCMDEXE()
   /* istanbul ignore next */ ? autoEscapeCmd
   /* istanbul ignore next */ : autoEscapeShell;
 
+const escapeSpaces = isRunningInCMDEXE()
+  /* istanbul ignore next */ ? escapeSpacesCMD
+  /* istanbul ignore next */ : escapeSpacesShell;
+
 module.exports = {
   escapeInDoubleQuotedString,
   escapeInDoubleQuotedRegexp,
   escapeWithSingleQuotedString,
   escapeWithDoubleQuotedString,
   isRunningInCMDEXE,
+  escapeSpaces: Object.assign(escapeSpaces, {
+    cmd: escapeSpacesCMD,
+    shell: escapeSpacesShell,
+  }),
   hasUnsafeChars: Object.assign(hasUnsafeChars, {
     cmd: hasUnsafeCMDChars,
     shell: hasUnsafeShellChars,

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.1/detox-19.7.1-javadoc.jar.md5

@@ -1 +0,0 @@
-e62a337bab2325f5394a0c49017020d9

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

@@ -1 +0,0 @@
-43b1170ce1496f1d5f65e0a89c66016891129cd6

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

@@ -1 +0,0 @@
-9b45638c7ecfb2a4f6dc730b87233b44ce1a6ed526bc8d594808c363bf4bdee5

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

@@ -1 +0,0 @@
-70ff560a76cf2c9d6efd975c9416eaf04f15fca3997e6a060e58a77243b3462c4017bce06db396a264ce3e2810dfffbb146dc312915161fb963d501c63b8902f

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

@@ -1 +0,0 @@
-74b3d837757148f010f9de7f4326c147

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

@@ -1 +0,0 @@
-f8382b9f12e9bded5c2f989ec68408ebc124ec17

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

@@ -1 +0,0 @@
-41a4e1bf181fb7caca7268a02c2b23fb21247d0c07c6c1155738e57cfde27f57

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

@@ -1 +0,0 @@
-66f48a1e9572da09ca4baa253315768294b18e279a62980d0c14a8ba18f08e2d21d44b76bb4b3814f1fe2f88dd6f6a552526d1f21d2b6e3a6a1c5c560a3362b5

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

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

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

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

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

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

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

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

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

@@ -1 +0,0 @@
-9901b0951eaca350873a41a34bc7eac6

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

@@ -1 +0,0 @@
-ed12ea36b32055fe3493f36aea99df23d332dba5

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

@@ -1 +0,0 @@
-4f641f7b7c7c6be232df7518cb17452e9881ee71b554705551e0556f2ff0712e

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

@@ -1 +0,0 @@
-d3a03f46781aa2c9a0b91c377ffe4e3729dba5a6e568715c7ce0cd0ead24258dbdc4b6c9d1215403d400d597eddb4cafb026a6b5697be619e5d5a99bc1f44c41

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)
-    }
-}