detox 19.9.3 → 19.12.0

package/src/utils/trace.js

@@ -1,3 +1,7 @@
+const assert = require('assert');
+
+const TIMELINE_CONTEXT_TYPES = require('../artifacts/timeline/TimelineContextTypes');
+
 class Trace {
   constructor() {
     this.events = [];
@@ -35,20 +39,58 @@ class Trace {
 }
 
 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;
-  }
+
+/**
+ * Trace a single call, with a given name and arguments.
+ * @param sectionName The name of the section to trace.
+ * @param promiseOrFunction {Promise|Function} Promise or a function that provides a promise.
+ * @param args {Object} Optional arguments to pass to the trace.
+ * @returns {any} The returned value of the traced call.
+ *
+ * @see https://wix.github.io/Detox/docs/next/api/detox-object-api/#detoxtracecall.
+ */
+function traceCall(sectionName, promiseOrFunction, args = {}) {
+  assert(sectionName,
+    `must provide section name when calling \`traceCall\` with args: \n ${JSON.stringify(args)}`);
+
+  const promise = typeof promiseOrFunction === 'function' ? promiseOrFunction() : promiseOrFunction;
+
+  trace.startSection(sectionName, args);
+  return promise
+    .then((result) => {
+      trace.endSection(sectionName, { ...args, success: true });
+      return result;
+    })
+    .catch((error) => {
+      trace.endSection(sectionName, { ...args, success: false, error: error.toString() });
+      throw error;
+    });
+}
+
+function traceInvocationCall(sectionName, invocation, promise) {
+  return traceCall(
+    sectionName, promise, {
+      context: TIMELINE_CONTEXT_TYPES.INVOCATION,
+      stackTrace: _getCallStackTrace(),
+      invocation: JSON.stringify(invocation),
+    });
+}
+
+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');
 }
 
 module.exports = {
   Trace,
   trace,
   traceCall,
+  traceInvocationCall
 };

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-javadoc.jar.md5

@@ -1 +0,0 @@
-c6abf5f995f7efef0d18ced1782e394d

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-javadoc.jar.sha1

@@ -1 +0,0 @@
-e15ea02b4e45bc609564419df0e4f41637066243

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-javadoc.jar.sha256

@@ -1 +0,0 @@
-2bb9db3a4f4e8559730726edc7916b2a7f9862a8513b1b63adccb9ecc47945a8

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-javadoc.jar.sha512

@@ -1 +0,0 @@
-85f09e8ce6a8d918f4642011aa128ab7e9cc15775dee64c1aa68415338fd8885742654824f5f827102db2e3e0a14e0cbbd7c2840f5245f3782d484ef2c38e0e6

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-sources.jar.md5

@@ -1 +0,0 @@
-646e35b842ddf204cec125e12889afc3

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-sources.jar.sha1

@@ -1 +0,0 @@
-a19e3a9ee01e68181523ca45c5042f3ba969058b

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-sources.jar.sha256

@@ -1 +0,0 @@
-2bae62ac910e2b85a65732d408a57ee8a67086f09b34fff3f36cddcc53770e1d

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0-sources.jar.sha512

@@ -1 +0,0 @@
-f914567f3fa7f0aa444ca447fe0216bb5e8bf13039f273de27005c4fcb0581ef2cc647e762df524249c1cb1177b09ba6c956edabb34531bb14054b38f53f503b

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.aar.md5

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

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.aar.sha1

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

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.aar.sha256

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

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.aar.sha512

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

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.pom.md5

@@ -1 +0,0 @@
-a765d464fcaef42e8caff137de8d635c

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.pom.sha1

@@ -1 +0,0 @@
-00a980a61b3b2cea782cc10be620ad08f83ce69f

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.pom.sha256

@@ -1 +0,0 @@
-246f80766f6b9c4d4a4255fdec9b09540a0fab9e56d7d2ad71a363935de5bcbf

package/Detox-android/com/wix/detox/19.9.3-prerelease.0/detox-19.9.3-prerelease.0.pom.sha512

@@ -1 +0,0 @@
-a18048b41a07e0dc793b8340714cc3fe86c72269683b4302a41bc5b1100c3750e9a28874cc01b474818ead5c83ee8bb56475865167ddcb96ba9bb10566368697

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