detox 20.28.0 → 20.31.0

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/factory/DetoxIdlingResourceFactory.kt

@@ -0,0 +1,32 @@
+package com.wix.detox.reactnative.idlingresources.factory
+
+import com.facebook.react.bridge.ReactContext
+import com.wix.detox.reactnative.idlingresources.DetoxIdlingResource
+import com.wix.detox.reactnative.idlingresources.animations.AnimatedModuleIdlingResource
+import com.wix.detox.reactnative.idlingresources.bridge.BridgeIdlingResource
+import com.wix.detox.reactnative.idlingresources.network.NetworkIdlingResource
+import com.wix.detox.reactnative.idlingresources.storage.AsyncStorageIdlingResource
+import com.wix.detox.reactnative.idlingresources.timers.TimersIdlingResource
+import com.wix.detox.reactnative.idlingresources.uimodule.UIModuleIdlingResource
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
+
+class DetoxIdlingResourceFactory(private val reactContext: ReactContext) {
+    suspend fun create(): Map<IdlingResourcesName, DetoxIdlingResource> = withContext(Dispatchers.Main) {
+        val result = mutableMapOf(
+            IdlingResourcesName.Timers to TimersIdlingResource(reactContext),
+            IdlingResourcesName.RNBridge to BridgeIdlingResource(reactContext),
+            IdlingResourcesName.UIModule to UIModuleIdlingResource(reactContext),
+            IdlingResourcesName.Animations to AnimatedModuleIdlingResource(reactContext),
+            IdlingResourcesName.Network to NetworkIdlingResource(reactContext)
+        )
+
+        val asyncStorageIdlingResource = AsyncStorageIdlingResource.createIfNeeded(reactContext)
+        if (asyncStorageIdlingResource != null) {
+            result[IdlingResourcesName.AsyncStorage] = asyncStorageIdlingResource
+        }
+
+        return@withContext result
+    }
+}
+

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/factory/IdlingResourcesName.kt

@@ -0,0 +1,10 @@
+package com.wix.detox.reactnative.idlingresources.factory
+
+enum class IdlingResourcesName {
+    Timers,
+    AsyncStorage,
+    RNBridge,
+    UIModule,
+    Animations,
+    Network
+}

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/factory/LooperName.kt

@@ -0,0 +1,6 @@
+package com.wix.detox.reactnative.idlingresources.factory
+
+enum class LooperName {
+    JS,
+    NativeModules
+}

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/looper/MQThreadsReflector.kt

@@ -0,0 +1,47 @@
+package com.wix.detox.reactnative.idlingresources.looper
+
+import android.os.Looper
+import android.util.Log
+import com.facebook.react.bridge.ReactContext
+import org.joor.Reflect
+import org.joor.ReflectException
+
+
+private const val LOG_TAG = "DetoxRNIdleRes"
+private const val METHOD_GET_LOOPER = "getLooper"
+private const val FIELD_NATIVE_MODULES_MSG_QUEUE = "mNativeModulesMessageQueueThread"
+private const val FIELD_JS_MSG_QUEUE = "mJSMessageQueueThread"
+
+internal class MQThreadsReflector(private val reactContext: ReactContext) {
+
+    fun getJSMQueue(): MQThreadReflected? {
+        return getQueue(FIELD_JS_MSG_QUEUE)
+    }
+
+    fun getNativeModulesQueue(): MQThreadReflected? {
+        return getQueue(FIELD_NATIVE_MODULES_MSG_QUEUE)
+    }
+
+    private fun getQueue(queueName: String): MQThreadReflected? {
+        try {
+            val queue = Reflect.on(reactContext).field(queueName).get() as Any?
+            return MQThreadReflected(queue, queueName)
+        } catch (e: ReflectException) {
+            Log.e(LOG_TAG, "Could not find queue: $queueName", e)
+        }
+        return null
+    }
+}
+
+internal class MQThreadReflected(private val queue: Any?, private val queueName: String) {
+    fun getLooper(): Looper? {
+        try {
+            if (queue != null) {
+                return Reflect.on(queue).call(METHOD_GET_LOOPER).get()
+            }
+        } catch (e: ReflectException) {
+            Log.e(LOG_TAG, "Could not find looper for queue: $queueName", e)
+        }
+        return null
+    }
+}

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/network/NetworkIdlingResource.kt

@@ -0,0 +1,105 @@
+package com.wix.detox.reactnative.idlingresources.network
+
+import android.util.Log
+import android.view.Choreographer
+import androidx.test.espresso.IdlingResource.ResourceCallback
+import com.facebook.react.bridge.ReactContext
+import com.wix.detox.reactnative.idlingresources.DetoxIdlingResource
+import okhttp3.Dispatcher
+import java.util.regex.Pattern
+import java.util.regex.PatternSyntaxException
+
+/**
+ * Created by simonracz on 09/10/2017.
+ *
+ * Idling Resource which monitors React Native's OkHttpClient.
+ *
+ *
+ * Must call stop() on it, before removing it from Espresso.
+ */
+class NetworkIdlingResource(private val dispatcher: Dispatcher) : DetoxIdlingResource(),
+    Choreographer.FrameCallback {
+    private val busyResources: MutableSet<String> = HashSet()
+
+    constructor(reactContext: ReactContext) : this(NetworkingModuleReflected(reactContext).getHttpClient()!!.dispatcher)
+
+    override fun getName(): String {
+        return NetworkIdlingResource::class.java.name
+    }
+
+    override fun getDebugName(): String {
+        return "network"
+    }
+
+    @Synchronized
+    override fun getBusyHint(): Map<String, Any> = mapOf("urls" to ArrayList(busyResources))
+
+    override fun registerIdleTransitionCallback(callback: ResourceCallback?) {
+        super.registerIdleTransitionCallback(callback)
+        Choreographer.getInstance().postFrameCallback(this)
+    }
+
+    override fun doFrame(frameTimeNanos: Long) {
+        isIdleNow
+    }
+
+    @Synchronized
+    override fun checkIdle(): Boolean {
+        busyResources.clear()
+
+        val calls = dispatcher.runningCalls()
+        for (call in calls) {
+            val url = call.request().url.toString()
+
+            if (!isUrlBlacklisted(url)) {
+                busyResources.add(url)
+            }
+        }
+
+        if (busyResources.isNotEmpty()) {
+            Log.i(LOG_TAG, "Network is busy, with " + busyResources.size + " in-flight calls")
+            Choreographer.getInstance().postFrameCallback(this)
+            return false
+        }
+
+        notifyIdle()
+        return true
+    }
+
+    private fun isUrlBlacklisted(url: String): Boolean {
+        for (pattern in blacklist) {
+            if (pattern.matcher(url).matches()) {
+                return true
+            }
+        }
+        return false
+    }
+
+    companion object {
+        private const val LOG_TAG = "Detox"
+
+        private val blacklist = ArrayList<Pattern>()
+
+        /**
+         * Must be called on the UI thread.
+         *
+         * @param urls list of regexes of blacklisted urls
+         */
+        @JvmStatic
+        fun setURLBlacklist(urls: List<String>?) {
+            blacklist.clear()
+            if (urls == null) return
+
+            for (url in urls) {
+                try {
+                    blacklist.add(Pattern.compile(url))
+                } catch (e: PatternSyntaxException) {
+                    Log.e(
+                        LOG_TAG,
+                        "Couldn't parse regular expression for Black list url: $url", e
+                    )
+                }
+            }
+        }
+    }
+}

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/{NetworkingModuleReflected.kt → network/NetworkingModuleReflected.kt}

@@ -1,4 +1,4 @@
-package com.wix.detox.reactnative.idlingresources
+package com.wix.detox.reactnative.idlingresources.network
 
 import android.util.Log
 import com.facebook.react.bridge.ReactContext

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/{AsyncStorageIdlingResource.kt → storage/AsyncStorageIdlingResource.kt}

@@ -1,16 +1,18 @@
-package com.wix.detox.reactnative.idlingresources
+package com.wix.detox.reactnative.idlingresources.storage
 
 import android.util.Log
 import androidx.test.espresso.IdlingResource
 import com.facebook.react.bridge.NativeModule
 import com.facebook.react.bridge.ReactContext
-import com.wix.detox.espresso.idlingresources.DescriptiveIdlingResource
 import com.wix.detox.reactnative.helpers.RNHelpers
+import com.wix.detox.reactnative.idlingresources.DetoxIdlingResource
 import org.joor.Reflect
 import java.util.concurrent.Executor
 
 private typealias SExecutorReflectedGenFnType = (executor: Executor) -> SerialExecutorReflected
-private val defaultSExecutorReflectedGenFn: SExecutorReflectedGenFnType = { executor: Executor -> SerialExecutorReflected(executor) }
+
+private val defaultSExecutorReflectedGenFn: SExecutorReflectedGenFnType =
+    { executor: Executor -> SerialExecutorReflected(executor) }
 
 private class ModuleReflected(module: NativeModule, sexecutorReflectedGen: SExecutorReflectedGenFnType) {
     private val executorReflected: SerialExecutorReflected
@@ -25,17 +27,16 @@ private class ModuleReflected(module: NativeModule, sexecutorReflectedGen: SExec
         get() = executorReflected
 }
 
-open class AsyncStorageIdlingResource
-    @JvmOverloads constructor(
-        module: NativeModule,
-        sexecutorReflectedGenFn: SExecutorReflectedGenFnType = defaultSExecutorReflectedGenFn)
-    : DescriptiveIdlingResource {
+class AsyncStorageIdlingResource
+@JvmOverloads constructor(
+    module: NativeModule,
+    sexecutorReflectedGenFn: SExecutorReflectedGenFnType = defaultSExecutorReflectedGenFn
+) : DetoxIdlingResource() {
 
-    open val logTag: String
+    val logTag: String
         get() = LOG_TAG
 
     private val moduleReflected = ModuleReflected(module, sexecutorReflectedGenFn)
-    private var callback: IdlingResource.ResourceCallback? = null
     private var idleCheckTask: Runnable? = null
     private val idleCheckTaskImpl = Runnable {
         with(moduleReflected.sexecutor) {
@@ -44,7 +45,7 @@ open class AsyncStorageIdlingResource
                     executeTask(idleCheckTask!!)
                 } else {
                     clearIdleCheckTask()
-                    callback?.onTransitionToIdle()
+                    notifyIdle()
                 }
             }
         }
@@ -54,22 +55,24 @@ open class AsyncStorageIdlingResource
     override fun getDebugName() = "io"
     override fun getBusyHint(): Map<String, Any>? = null
 
-    override fun isIdleNow(): Boolean =
-        checkIdle().also { idle ->
-            if (!idle) {
-                Log.d(logTag, "Async-storage is busy!")
-                enqueueIdleCheckTask()
+
+    private fun checkIdleInternal(): Boolean =
+        with(moduleReflected.sexecutor) {
+            synchronized(executor()) {
+                !hasActiveTask() && !hasPendingTasks()
             }
         }
+
     override fun registerIdleTransitionCallback(callback: IdlingResource.ResourceCallback?) {
-        this.callback = callback
+        super.registerIdleTransitionCallback(callback)
         enqueueIdleCheckTask()
     }
 
-    private fun checkIdle(): Boolean =
-        with(moduleReflected.sexecutor) {
-            synchronized(executor()) {
-                !hasActiveTask() && !hasPendingTasks()
+    override fun checkIdle(): Boolean =
+        checkIdleInternal().also { idle ->
+            if (!idle) {
+                Log.d(logTag, "Async-storage is busy!")
+                enqueueIdleCheckTask()
             }
         }
 
@@ -94,26 +97,21 @@ open class AsyncStorageIdlingResource
     companion object {
         private const val LOG_TAG = "AsyncStorageIR"
 
-        fun createIfNeeded(reactContext: ReactContext, legacy: Boolean): AsyncStorageIdlingResource? {
-            Log.d(LOG_TAG, "Checking whether a custom IR for Async-Storage is required... (legacy=$legacy)")
+        fun createIfNeeded(reactContext: ReactContext): AsyncStorageIdlingResource? {
+            Log.d(LOG_TAG, "Checking whether a custom IR for Async-Storage is required...")
 
-            return RNHelpers.getNativeModule(reactContext, className(legacy))?.let { module ->
-                Log.d(LOG_TAG, "IR for Async-Storage is required! (legacy=$legacy)")
-                createInstance(module, legacy)
+            return RNHelpers.getNativeModule(reactContext, className())?.let { module ->
+                Log.d(LOG_TAG, "IR for Async-Storage is required!")
+                createInstance(module)
             }
         }
 
-        private fun className(legacy: Boolean): String {
-            val packageName = if (legacy) "com.facebook.react.modules.storage" else "com.reactnativecommunity.asyncstorage"
+        private fun className(): String {
+            val packageName = "com.reactnativecommunity.asyncstorage"
             return "$packageName.AsyncStorageModule"
         }
 
-        private fun createInstance(module: NativeModule, legacy: Boolean) =
-            if (legacy) AsyncStorageIdlingResourceLegacy(module) else AsyncStorageIdlingResource(module)
+        private fun createInstance(module: NativeModule) =
+            AsyncStorageIdlingResource(module)
     }
 }
-
-class AsyncStorageIdlingResourceLegacy(module: NativeModule): AsyncStorageIdlingResource(module) {
-    override val logTag: String
-        get() = super.logTag + "Legacy"
-}

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/{SerialExecutorReflected.kt → storage/SerialExecutorReflected.kt}

@@ -1,4 +1,4 @@
-package com.wix.detox.reactnative.idlingresources
+package com.wix.detox.reactnative.idlingresources.storage
 
 import org.joor.Reflect
 import java.util.concurrent.Executor

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

@@ -1,43 +1,45 @@
 package com.wix.detox.reactnative.idlingresources.timers
 
+import android.annotation.SuppressLint
 import android.view.Choreographer
 import androidx.test.espresso.IdlingResource
-import com.wix.detox.reactnative.idlingresources.DetoxBaseIdlingResource
+import com.facebook.react.bridge.ReactContext
+import com.facebook.react.modules.core.TimingModule
+import com.wix.detox.reactnative.idlingresources.DetoxIdlingResource
+
+private const val BUSY_WINDOW_THRESHOLD = 1500L
 
 class TimersIdlingResource @JvmOverloads constructor(
-        private val interrogationStrategy: IdleInterrogationStrategy,
-        private val getChoreographer: () -> Choreographer = { Choreographer.getInstance() }
-    ) : DetoxBaseIdlingResource(), Choreographer.FrameCallback {
+    reactContext: ReactContext,
+    private val getChoreographer: () -> Choreographer = { Choreographer.getInstance() }
+) : DetoxIdlingResource(), Choreographer.FrameCallback {
 
-    private var callback: IdlingResource.ResourceCallback? = null
+    private val timingModule: TimingModule = reactContext.getNativeModule(TimingModule::class.java)!!
 
     override fun getName(): String = this.javaClass.name
     override fun getDebugName(): String = "timers"
     override fun getBusyHint(): Map<String, Any>? = null
 
     override fun registerIdleTransitionCallback(callback: IdlingResource.ResourceCallback?) {
-        this.callback = callback
+        super.registerIdleTransitionCallback(callback)
         getChoreographer().postFrameCallback(this)
     }
 
+    @SuppressLint("VisibleForTests")
     override fun checkIdle(): Boolean {
-        return interrogationStrategy.isIdleNow().also { result ->
-            if (result) {
-                notifyIdle()
-            } else {
-                getChoreographer().postFrameCallback(this@TimersIdlingResource)
-            }
-        }
-    }
+        val isIdle = !timingModule.hasActiveTimersInRange(BUSY_WINDOW_THRESHOLD)
 
-    override fun doFrame(frameTimeNanos: Long) {
-        callback?.let {
-            isIdleNow
+        if (isIdle) {
+            notifyIdle()
+        } else {
+            getChoreographer().postFrameCallback(this)
         }
+
+        return isIdle
     }
 
-    override fun notifyIdle() {
-        callback?.onTransitionToIdle()
+    override fun doFrame(frameTimeNanos: Long) {
+        isIdleNow
     }
 
     companion object {

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/uimodule/UIManagerModuleReflected.kt

@@ -18,20 +18,12 @@ private const val FIELD_NON_BATCHED_OPS_LOCK = "mNonBatchedOperationsLock"
 
 class UIManagerModuleReflected(private val reactContext: ReactContext) {
 
-    fun getUIOpsCount(): Int = (viewCommandOperations()?.size ?: 0)
-    fun getNextUIOpReflected() = viewCommandOperations()?.firstCommandReflected()
-
-    fun nativeViewHierarchyManager(): NativeHierarchyManagerReflected? =
-            getUIOperationQueue()?.let {
-                NativeHierarchyManagerReflected(it)
-            }
-
     fun isRunnablesListEmpty(): Boolean =
         getUIOperationQueue()?.let {
-            synchronized(Reflect.on(it).field(FIELD_DISPATCH_RUNNABLES_LOCK).get())  {
+            synchronized(Reflect.on(it).field(FIELD_DISPATCH_RUNNABLES_LOCK).get()) {
                 Reflect.on(it)
                     .field(FIELD_DISPATCH_RUNNABLES)
-                    .call(METHOD_IS_EMPTY).get<Boolean>()
+                    .call(METHOD_IS_EMPTY).get()
             }
         } ?: true
 
@@ -39,32 +31,32 @@ class UIManagerModuleReflected(private val reactContext: ReactContext) {
         getUIOperationQueue()?.let {
             synchronized(Reflect.on(it).field(FIELD_NON_BATCHED_OPS_LOCK).get()) {
                 Reflect.on(it)
-                        .field(FIELD_NON_BATCHED_OPS)
-                        .call(METHOD_IS_EMPTY).get<Boolean>()
+                    .field(FIELD_NON_BATCHED_OPS)
+                    .call(METHOD_IS_EMPTY).get()
             }
         } ?: true
 
     fun isOperationQueueEmpty(): Boolean =
         getUIOperationQueue()?.let {
-            Reflect.on(it).call(METHOD_IS_EMPTY).get<Boolean>()
+            Reflect.on(it).call(METHOD_IS_EMPTY).get()
         } ?: true
 
     private fun viewCommandOperations(): ViewCommandOpsQueueReflected? =
-            getUIOperationQueue()?.let {
-                ViewCommandOpsQueueReflected(it)
-            }
+        getUIOperationQueue()?.let {
+            ViewCommandOpsQueueReflected(it)
+        }
 
 
     private fun getUIOperationQueue(): UIViewOperationQueue? =
-            try {
-                val uiModuleClass = Class.forName(CLASS_UI_MANAGER_MODULE)
-                Reflect.on(reactContext)
-                        .call(METHOD_GET_NATIVE_MODULE, uiModuleClass)
-                        .call(METHOD_GET_UI_IMPLEMENTATION)
-                        .field(FIELD_UI_OPERATION_QUEUE)
-                        .get()
-            } catch (e: Exception) {
-                Log.e(LOG_TAG, "failed to get $CLASS_UI_MANAGER_MODULE instance ", e)
-                null
-            }
+        try {
+            val uiModuleClass = Class.forName(CLASS_UI_MANAGER_MODULE)
+            Reflect.on(reactContext)
+                .call(METHOD_GET_NATIVE_MODULE, uiModuleClass)
+                .call(METHOD_GET_UI_IMPLEMENTATION)
+                .field(FIELD_UI_OPERATION_QUEUE)
+                .get()
+        } catch (e: Exception) {
+            Log.e(LOG_TAG, "failed to get $CLASS_UI_MANAGER_MODULE instance ", e)
+            null
+        }
 }

package/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/uimodule/UIModuleIdlingResource.kt

@@ -5,7 +5,7 @@ import android.view.Choreographer
 import androidx.test.espresso.IdlingResource.ResourceCallback
 import com.facebook.react.bridge.ReactContext
 import com.wix.detox.reactnative.helpers.RNHelpers
-import com.wix.detox.reactnative.idlingresources.DetoxBaseIdlingResource
+import com.wix.detox.reactnative.idlingresources.DetoxIdlingResource
 import org.joor.ReflectException
 
 /**
@@ -13,11 +13,9 @@ import org.joor.ReflectException
  * Hooks up to React Native internals to grab the pending ui operations from it.
  */
 class UIModuleIdlingResource(private val reactContext: ReactContext)
-    : DetoxBaseIdlingResource(), Choreographer.FrameCallback {
+    : DetoxIdlingResource(), Choreographer.FrameCallback {
 
-    private val rn66workaround = RN66Workaround()
     private val uiManagerModuleReflected = UIManagerModuleReflected(reactContext)
-    private var callback: ResourceCallback? = null
 
     override fun getName(): String = UIModuleIdlingResource::class.java.name
     override fun getDebugName(): String = " ui"
@@ -39,11 +37,7 @@ class UIModuleIdlingResource(private val reactContext: ReactContext)
 
             val runnablesAreEmpty = uiManagerModuleReflected.isRunnablesListEmpty()
             val nonBatchesOpsEmpty = uiManagerModuleReflected.isNonBatchOpsEmpty()
-            var operationQueueEmpty = uiManagerModuleReflected.isOperationQueueEmpty()
-
-            if (!operationQueueEmpty) {
-                operationQueueEmpty = rn66workaround.isScarceUISwitchCommandStuckInQueue(uiManagerModuleReflected)
-            }
+            val operationQueueEmpty = uiManagerModuleReflected.isOperationQueueEmpty()
 
             if (runnablesAreEmpty && nonBatchesOpsEmpty && operationQueueEmpty) {
                 notifyIdle()
@@ -60,8 +54,8 @@ class UIModuleIdlingResource(private val reactContext: ReactContext)
         return true
     }
 
-    override fun registerIdleTransitionCallback(callback: ResourceCallback) {
-        this.callback = callback
+    override fun registerIdleTransitionCallback(callback: ResourceCallback?) {
+        super.registerIdleTransitionCallback(callback)
         Choreographer.getInstance().postFrameCallback(this)
     }
 
@@ -69,12 +63,6 @@ class UIModuleIdlingResource(private val reactContext: ReactContext)
         isIdleNow
     }
 
-    override fun notifyIdle() {
-        callback?.run {
-            onTransitionToIdle()
-        }
-    }
-
     companion object {
         private const val LOG_TAG = "Detox"
     }