detox 20.0.6-breaking.new-global-lifecycle.0 → 20.0.9-prerelease.0

package/src/{utils → logger/utils}/streamUtils.js

@@ -2,13 +2,16 @@ const { PassThrough, Transform } = require('stream');
 
 const bunyanDebugStream = require('bunyan-debug-stream');
 const duplexify = require('duplexify');
+const fs = require('fs-extra');
+const glob = require('glob');
 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 log = require('./logger').child({ cat: 'logger' });
+const temporary = require('../../artifacts/utils/temporaryPath');
+const log = require('../../utils/logger').child({ cat: 'logger' });
 
 function compareTimestamps(a, b) {
   return +(a.value.time > b.value.time) - +(a.value.time < b.value.time);
@@ -203,6 +206,29 @@ function readJSONL() {
   return duplexify.obj(preventErrorSubscriptions(writable), writable.pipe(readable));
 }
 
+/**
+ * @param {string} sessionId
+ * @returns {NodeJS.ReadableStream}
+ */
+function uniteSessionLogs(sessionId) {
+  const readable = through();
+
+  glob(temporary.for.jsonl(`${sessionId}.*`), function (err, logs) {
+    if (err) {
+      return readable.emit('error', err);
+    }
+
+    if (logs.length === 0) {
+      return;
+    }
+
+    const jsonlStreams = logs.map(filePath => fs.createReadStream(filePath).pipe(readJSONL()));
+    mergeSortedJSONL(jsonlStreams).pipe(readable);
+  });
+
+  return readable;
+}
+
 module.exports = {
   readJSONL,
   writeJSON,
@@ -210,4 +236,5 @@ module.exports = {
   mergeSortedJSONL,
   debugStream,
   chromeTraceStream,
+  uniteSessionLogs,
 };

package/src/logger/utils/tracerLegacy.js

@@ -8,15 +8,38 @@ const methods = {
   },
 
   traceCall(logger) {
-    return (name, action) => logger.trace.complete(name, action);
+    return (name, action, args = {}) => logger.trace.complete(args, name, action);
+  },
+
+  invocationCall(logger) {
+    return (sectionName, invocation, action) => {
+      return logger.trace.complete({
+        cat: 'ws-client,ws-client-invocation',
+        data: invocation,
+        stack: _getCallStackTrace(),
+      }, sectionName, action);
+    };
   },
 };
 
+function _getCallStackTrace() {
+  return new Error().stack
+    .split('\n')
+    .slice(1) // Ignore Error message
+    .map(line => line
+      .replace(/^\s*at\s+/, '')
+      .replace(process.cwd(), '')
+    )
+    .filter(line => !line.includes('/detox/src')) // Ignore detox internal calls
+    .join('\n');
+}
+
 function installLegacyTracerInterface(logger, target) {
   target.traceCall = methods.traceCall(logger);
   target.trace = Object.freeze({
     startSection: methods.startSection(logger),
     endSection: methods.endSection(logger),
+    invocationCall: methods.invocationCall(logger),
   });
 
   return this;

package/src/realms/DetoxContext.js

@@ -94,6 +94,14 @@ class DetoxContext {
   [symbols.onRunFinish] = (...args) => this[symbols.worker].onRunFinish(...args);
   [symbols.config] = funpermaproxy(() => this[symbols.session].detoxConfig);
   [symbols.session] = funpermaproxy(() => this[$sessionState]);
+  [symbols.tracing] = Object.freeze({
+    createEventStream: () => {
+      const streamUtils = require('../logger/utils/streamUtils');
+      return streamUtils
+        .uniteSessionLogs(this[$sessionState].id)
+        .pipe(streamUtils.chromeTraceStream());
+    },
+  });
   /** @abstract */
   [symbols.reportFailedTests](_testFilePaths, _permanent) {}
   /**

package/src/realms/DetoxInternalsFacade.js

@@ -29,7 +29,7 @@ class DetoxInternalsFacade {
     this.reportFailedTests = context[symbols.reportFailedTests];
     this.resolveConfig = context[symbols.resolveConfig];
     this.session = context[symbols.session];
-    this.trace = context.trace;
+    this.tracing = context[symbols.tracing];
     this.worker = funpermaproxy(() => context[symbols.worker]);
   }
 }

package/src/realms/DetoxPrimaryContext.js

@@ -170,11 +170,13 @@ class DetoxPrimaryContext extends DetoxContext {
 
       await fs.remove(this[$sessionState].detoxConfigSnapshotPath);
 
-      try {
-        this[_lifecycleLogger].trace.end();
-        await this[_finalizeLogs]();
-      } catch (err) {
-        this[_lifecycleLogger].error({ err }, 'Encountered an error while merging the process logs:');
+      if (this[_dirty]) {
+        try {
+          this[_lifecycleLogger].trace.end();
+          await this[_finalizeLogs]();
+        } catch (err) {
+          this[_lifecycleLogger].error({ err }, 'Encountered an error while merging the process logs:');
+        }
       }
     }
   }
@@ -230,17 +232,14 @@ class DetoxPrimaryContext extends DetoxContext {
     }
 
     if (this[_areLogsEnabled]()) {
-      const streamUtils = require('../utils/streamUtils');
+      const streamUtils = require('../logger/utils/streamUtils');
       const { rootDir } = this[symbols.config].artifacts;
 
       await fs.mkdirp(rootDir);
       const [out1Stream, out2Stream, out3Stream] = ['detox.log.jsonl', 'detox.log', 'detox.trace.json']
         .map((filename) => fs.createWriteStream(path.join(rootDir, filename)));
 
-      const mergedStream = streamUtils
-        .mergeSortedJSONL(
-          logs.map(filePath => fs.createReadStream(filePath).pipe(streamUtils.readJSONL()))
-        );
+      const mergedStream = streamUtils.uniteSessionLogs(sessionId);
 
       await Promise.all([
         pipe(mergedStream, streamUtils.writeJSONL(), out1Stream),

package/src/symbols.js

@@ -21,6 +21,7 @@
  *   readonly reportFailedTests: unique symbol;
  *   readonly resolveConfig: unique symbol;
  *   readonly session: unique symbol;
+ *   readonly tracing: unique symbol;
  *   readonly uninstallWorker: unique symbol;
  *   readonly worker: unique symbol;
  * }}
@@ -54,6 +55,7 @@ module.exports = {
   logger: Symbol('logger'),
   resolveConfig: Symbol('resolveConfig'),
   session: Symbol('session'),
+  tracing: Symbol('tracing'),
   uninstallWorker: Symbol('uninstallWorker'),
   worker: Symbol('worker'),
   //#endregion

package/src/utils/errorUtils.js

@@ -16,11 +16,12 @@ function filterErrorStack(error, predicate) {
 }
 
 function replaceErrorStack(source, target) {
-  const sourceStack = source.stack || source.message;
-  const targetStack = target.stack || target.message;
+  const sourceStack = (source.stack || '');
   const sourceMessage = sourceStack.replace(CLEAN_AT, '');
-  const targetMessage = targetStack.replace(CLEAN_AT, '');
   const actualSourceStack = sourceStack.slice(sourceMessage.length);
+
+  const targetMessage = target.message || target.stack.replace(CLEAN_AT, '');
+
   target.stack = targetMessage + actualSourceStack;
   return target;
 }

package/src/utils/invocationTraceDescriptions.js

@@ -0,0 +1,43 @@
+module.exports = {
+  actionDescription: {
+    adjustSliderToPosition: (newPosition) => `adjust slider to position ${newPosition}`,
+    clearText: () => 'clear input text',
+    getAttributes: () => 'get element attributes',
+    longPress: (duration) => `long press${duration !== undefined ? ` for ${duration}ms` : ''}`,
+    longPressAndDrag: (duration, startX, startY, targetElement, endX, endY, speed, holdDuration) =>
+      `long press and drag from ${startX}, ${startY} to ${endX}, ${endY} with speed ${speed} and hold duration ${holdDuration}`,
+    multiTap: (times) => `tap ${times} times`,
+    pinch: (scale, speed, angle) => `pinch with scale ${scale}, speed ${speed}, and angle ${angle}`,
+    pinchWithAngle: (direction, speed, angle) => `pinch with direction ${direction}, speed ${speed}, and angle ${angle}`,
+    replaceText: (value) => `replace input text: "${value}"`,
+    scroll: (amount, direction, startPositionX, startPositionY) =>
+      `scroll ${amount} pixels ${direction}${startPositionX !== undefined && startPositionY !== undefined ? ` from normalized position (${startPositionX}, ${startPositionY})` : ''}`,
+    scrollTo: (edge) => `scroll to ${edge}`,
+    scrollToIndex: (index) => `scroll to index #${index}`,
+    setColumnToValue: (column, value) => `set column ${column} to value ${value}`,
+    setDatePickerDate: (dateString, dateFormat) => `set date picker date to ${dateString} using format ${dateFormat}`,
+    swipe: (direction, speed, normalizedSwipeOffset, normalizedStartingPointX, normalizedStartingPointY) =>
+      `swipe ${direction} ${speed} with offset ${normalizedSwipeOffset}
+      ${!isNaN(normalizedStartingPointX) && !isNaN(normalizedStartingPointY) ? ` from normalized position (${normalizedStartingPointX}, ${normalizedStartingPointY})` : ''}`,
+    takeScreenshot: (screenshotName) => `take screenshot${screenshotName !== undefined ? ` with name "${screenshotName}"` : ''}`,
+    tapAtPoint: (value) => `tap${value !== undefined ? ` at ${JSON.stringify(value)}` : ''}`,
+    tapBackspaceKey: () => 'tap on backspace key',
+    tapReturnKey: () => 'tap on return key',
+    typeText: (value) => `type input text: "${value}"`,
+  },
+  expectDescription: {
+    waitFor: (actionDescription) => `wait for expectation while ${actionDescription}`,
+    waitForWithTimeout: (expectDescription, timeout) => `${expectDescription} with timeout (${timeout} ms)`,
+    withTimeout: (timeout) => `wait until timeout (${timeout} ms)`,
+    toBeFocused: () => 'to be focused',
+    toBeVisible: (percent) => `to be visible${percent !== undefined ? ` ${percent}%` : ''}`,
+    toExist: () => 'to exist',
+    toHaveText: (text) => `to have text: "${text}"`,
+    toHaveLabel: (label) => `to have label: "${label}"`,
+    toHaveId: (id) => `to have id: "${id}"`,
+    toHaveValue: (value) => `to have value: "${value}"`,
+    toHaveSliderPosition: (position, tolerance) => `to have slider position: ${position}${tolerance > 0 ? ` with tolerance ${tolerance}` : ''}`,
+    toHaveToggleValue: (value) => `to have toggle value: ${value}`,
+    full: (expectDescription, notCondition) => `expect element ${notCondition ? `not ${expectDescription}` : expectDescription}`
+  }
+};

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-javadoc.jar.md5

@@ -1 +0,0 @@
-91686ed0f19733f7c115a7139ed4186b

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-javadoc.jar.sha1

@@ -1 +0,0 @@
-b1948b37f2825ae6901ecf5b0f0e77974d383e90

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-javadoc.jar.sha256

@@ -1 +0,0 @@
-c78417c3025b0c430f0270d630bd8cc3d680cbd413481ce57f63f44f682fa734

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-javadoc.jar.sha512

@@ -1 +0,0 @@
-2ed2683d4799f88018b813696666c11fceba5be25b261a780fba9b4f85fa52518577315762760f2c5898bb75dfd8b9f7141a4fe276f17dbf431f4db2f8972b62

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-sources.jar.md5

@@ -1 +0,0 @@
-4a1f392222691dde5ff23796ed1f9be2

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-sources.jar.sha1

@@ -1 +0,0 @@
-a26bb973c995a237be6da201ee7ce88c73c1633f

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-sources.jar.sha256

@@ -1 +0,0 @@
-88cf8c98c0342ba8052e6483f32c0b21c55e8b49e3e821a8ab7f4d1241f3ac95

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0-sources.jar.sha512

@@ -1 +0,0 @@
-086ec58c930ddd33b055906bc7baeab54bf0c61e824168e714542b3c12435765ea79207f73084cf9f865d5afd4d0d277454bad7df260d91904fc839068ba3345

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.aar.md5

@@ -1 +0,0 @@
-e7043eb4fd0dfa3c309fd8cd35ee68e5

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.aar.sha1

@@ -1 +0,0 @@
-80bef0c22a710dabb0e72b8d15c59125db1bd58b

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.aar.sha256

@@ -1 +0,0 @@
-7828ffdff493f8a856efad9b7db540e4e6b13b91260292efe98791013ba2db04

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.aar.sha512

@@ -1 +0,0 @@
-a57448b5eec5edfb2b45b99b9c8a6714b3384f71ade0f25da7b453d14c29597e818690b293cefa9be9362be29efb2c420664283cb1fc994883cd143d46506a2f

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.pom.md5

@@ -1 +0,0 @@
-7ed72c62d3647105b8ba45872b8ea606

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.pom.sha1

@@ -1 +0,0 @@
-57c6d248535a325fb3b5f8ff5ae28fe452723d3c

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.pom.sha256

@@ -1 +0,0 @@
-33f28069a49462150368c6c44ea5644083c155771aefdd51f0e41858dc43e61d

package/Detox-android/com/wix/detox/20.0.6-breaking.new-global-lifecycle.0/detox-20.0.6-breaking.new-global-lifecycle.0.pom.sha512

@@ -1 +0,0 @@
-6d57cb6061f616f09785d65238df8c1bb4751a95e65f1dd038b4c4b7d7b72a5d6572fc49ee4085c26a44407219a8c952e46263457fee030a17b3767654557da6

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/timers/DefaultIdleInterrogationStrategy.kt

@@ -1,84 +0,0 @@
-@file:RNDropSupportTodo(62, "Remove all of this; Use DelegatedIdleInterrogationStrategy, instead.")
-
-package com.wix.detox.reactnative.idlingresources.timers
-
-import com.facebook.react.bridge.ReactContext
-import com.wix.detox.common.RNDropSupportTodo
-import com.wix.detox.reactnative.helpers.RNHelpers
-import org.joor.Reflect
-import java.util.*
-
-private const val BUSY_WINDOW_THRESHOLD = 1500
-
-private class TimerReflected(timer: Any) {
-    private var reflected = Reflect.on(timer)
-
-    val isRepeating: Boolean
-        get() = reflected.field("mRepeat").get()
-    val interval: Int
-        get() = reflected.field("mInterval").get()
-    val targetTime: Long
-        get() = reflected.field("mTargetTime").get()
-}
-
-private class TimingModuleReflected(private val timingModule: Any) {
-    val timersQueue: PriorityQueue<Any>
-        get() = Reflect.on(timingModule).field("mTimers").get()
-    val timersLock: Any
-        get() = Reflect.on(timingModule).field("mTimerGuard").get()
-
-    operator fun component1() = timersQueue
-    operator fun component2() = timersLock
-}
-
-class DefaultIdleInterrogationStrategy
-    internal constructor(private val timersModule: Any)
-    : IdleInterrogationStrategy {
-
-    override fun isIdleNow(): Boolean {
-        val (timersQueue, timersLock) = TimingModuleReflected(timersModule)
-        synchronized(timersLock) {
-            val nextTimer = timersQueue.peek()
-            nextTimer?.let {
-                return !isTimerInBusyWindow(it) && !hasBusyTimers(timersQueue)
-            }
-            return true
-        }
-    }
-
-    private fun isTimerInBusyWindow(timer: Any): Boolean {
-        val timerReflected = TimerReflected(timer)
-        return when {
-            timerReflected.isRepeating -> false
-            timerReflected.interval > BUSY_WINDOW_THRESHOLD -> false
-            else -> true
-        }
-    }
-
-    private fun hasBusyTimers(timersQueue: PriorityQueue<Any>): Boolean {
-        timersQueue.forEach {
-            if (isTimerInBusyWindow(it)) {
-                return true
-            }
-        }
-        return false
-    }
-
-    companion object {
-        fun createIfSupported(reactContext: ReactContext): DefaultIdleInterrogationStrategy? {
-            // RN = 0.62.0:
-            // Should have been handled by DelegatedIdleInterrogationStrategy.createIfSupported() but seems the new TimingModule class
-            // was released without the awaited-for "hasActiveTimersInRange()" method.
-            try {
-                val timingModule = RNHelpers.getNativeModule(reactContext, "com.facebook.react.modules.core.TimingModule")
-                val timersManager = Reflect.on(timingModule).get<Any>("mJavaTimerManager")
-                return DefaultIdleInterrogationStrategy(timersManager)
-            } catch (ex: Exception) {
-            }
-
-            // RN < 0.62
-            val timingModule = RNHelpers.getNativeModule(reactContext, "com.facebook.react.modules.core.Timing") ?: return null
-            return DefaultIdleInterrogationStrategy(timingModule)
-        }
-    }
-}

package/android/detox/src/testFull/java/com/wix/detox/reactnative/idlingresources/timers/DefaultIdleInterrogationStrategySpec.kt

@@ -1,115 +0,0 @@
-package com.wix.detox.reactnative.idlingresources.timers
-
-import com.facebook.react.bridge.NativeModule
-import com.wix.detox.UTHelpers
-import org.assertj.core.api.Assertions
-import org.spekframework.spek2.Spek
-import org.spekframework.spek2.style.specification.describe
-import java.util.*
-import java.util.concurrent.Executors
-
-private const val BUSY_INTERVAL_MS = 1500
-private const val MEANINGFUL_TIMER_INTERVAL = BUSY_INTERVAL_MS
-
-data class TimerStub(
-        private var mCallbackID: Int,
-        private var mTargetTime: Long,
-        private var mInterval: Int,
-        private var mRepeat: Boolean)
-
-class TimersNativeModuleStub : NativeModule {
-    val mTimers: PriorityQueue<Any> = PriorityQueue(2) { _, _ -> 0}
-    val mTimerGuard = "Lock-Mock"
-
-    override fun onCatalystInstanceDestroy() {}
-    override fun invalidate() {}
-
-    override fun getName(): String = "TimersNativeModuleStub"
-    override fun canOverrideExistingModule() = false
-    override fun initialize() {}
-}
-
-private fun now() = System.nanoTime() / 1000000L
-private fun aTimer(targetTime: Long, interval: Int, isRepeating: Boolean): TimerStub {
-    return TimerStub(-1, targetTime, interval, isRepeating)
-}
-private fun aTimer(interval: Int, isRepeating: Boolean) = aTimer(now() + interval + 10, interval, isRepeating)
-private fun aOneShotTimer(interval: Int) = aTimer(interval, false)
-private fun aRepeatingTimer(interval: Int) = aTimer(interval, true)
-private fun anOverdueTimer() = aTimer(now() - 100, 123, false)
-
-object DefaultIdleInterrogationStrategySpec: Spek({
-  describe("Default timers idle-interrogation strategy") {
-
-      lateinit var timersNativeModule: TimersNativeModuleStub
-
-      beforeEachTest {
-          timersNativeModule = TimersNativeModuleStub()
-      }
-
-      fun givenTimer(timer: Any) {
-          timersNativeModule.mTimers.add(timer)
-      }
-
-      fun uut() = DefaultIdleInterrogationStrategy(timersNativeModule)
-
-      it("should be idle if there are no timers in queue") {
-          Assertions.assertThat(uut().isIdleNow()).isTrue()
-      }
-
-      it("should be busy if there's a meaningful pending timer") {
-          givenTimer(aOneShotTimer(MEANINGFUL_TIMER_INTERVAL))
-          Assertions.assertThat(uut().isIdleNow()).isFalse()
-      }
-
-      it("should be idle if pending timer is too far away (ie not meaningful)") {
-          givenTimer(aOneShotTimer(BUSY_INTERVAL_MS + 1))
-          Assertions.assertThat(uut().isIdleNow()).isTrue()
-      }
-
-      it("should be idle if the only timer is a repeating one") {
-          givenTimer(aRepeatingTimer(MEANINGFUL_TIMER_INTERVAL))
-          Assertions.assertThat(uut().isIdleNow()).isTrue()
-      }
-
-      it("should be busy if a meaningful pending timer lies beyond a repeating one") {
-          givenTimer(aRepeatingTimer(BUSY_INTERVAL_MS / 10))
-          givenTimer(aOneShotTimer(BUSY_INTERVAL_MS))
-          Assertions.assertThat(uut().isIdleNow()).isFalse()
-      }
-
-      /**
-       * Note: Reversed logic due to this issue: https://github.com/wix/Detox/issues/1171 !!!
-       *
-       * Apparently at times (rare) this caused Espresso to think we're idle too soon, rendering
-       * it never to query any idling resource again even after the timer effectively expires...
-       */
-      it("should be *busy* even if all timers are overdue") {
-          givenTimer(anOverdueTimer())
-          givenTimer(anOverdueTimer())
-          Assertions.assertThat(uut().isIdleNow()).isFalse()
-      }
-
-      it("should be busy if has a meaningful pending timer set beyond an overdue timer") {
-          givenTimer(anOverdueTimer())
-          givenTimer(aOneShotTimer(MEANINGFUL_TIMER_INTERVAL))
-          Assertions.assertThat(uut().isIdleNow()).isFalse()
-      }
-
-      it("should yield to other threads using the timers module") {
-          val executor = Executors.newSingleThreadExecutor()
-          var isIdle: Boolean? = null
-
-          synchronized(timersNativeModule.mTimerGuard) {
-              executor.submit {
-                  isIdle = uut().isIdleNow()
-              }
-              UTHelpers.yieldToOtherThreads(executor)
-              Assertions.assertThat(isIdle).isNull()
-          }
-          UTHelpers.yieldToOtherThreads(executor)
-          Assertions.assertThat(isIdle).isNotNull()
-          executor.shutdownNow()
-      }
-  }
-})