detox 20.0.3-breaking.new-global-lifecycle.0 → 20.0.3

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

@@ -1,20 +1,26 @@
 package com.wix.detox.reactnative.idlingresources
 
 class IdlingResourceDescription private constructor(
-  private val name: String,
-  private val description: Map<String, Any>) {
-    fun json(): Map<String, Any> = mutableMapOf<String, Any>("name" to name)
-      .apply { if (description.isNotEmpty()) put("description", description) }
+    private val name: String,
+    private val description: Map<String, Any>) {
 
-    override fun equals(other: Any?): Boolean = other is IdlingResourceDescription &&
-        other.json() == this.json()
+    fun json() =
+        mutableMapOf<String, Any>("name" to name)
+          .apply {
+            if (description.isNotEmpty()) put("description", description)
+          }.toMap()
 
-    data class Builder(
-      var name: String = "unknown",
-      var description: MutableMap<String, Any> = mutableMapOf()) {
+    override fun equals(other: Any?) =
+      (other is IdlingResourceDescription && other.json() == this.json())
+
+    override fun hashCode(): Int =
+      (31 * name.hashCode() + description.hashCode())
 
-        fun name(name: String) = apply { this.name = name }
-        fun addDescription(key: String, value: Any) = apply { this.description[key] = value }
-        fun build() = IdlingResourceDescription(name, description)
-    }
+    data class Builder(
+        var name: String = "unknown",
+        var description: MutableMap<String, Any> = mutableMapOf()) {
+            fun name(value: String) = apply { name = value }
+            fun addDescription(key: String, value: Any) = apply { description[key] = value }
+            fun build() = IdlingResourceDescription(name, description)
+      }
 }

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

@@ -69,42 +69,13 @@ public class NetworkIdlingResource extends DetoxBaseIdlingResource implements Ch
 
     @NotNull
     @Override
-    public IdlingResourceDescription getDescription() {
+    public synchronized IdlingResourceDescription getDescription() {
         return new IdlingResourceDescription.Builder()
                 .name("network")
                 .addDescription("urls", new ArrayList<>(busyResources))
                 .build();
     }
 
-    @Override
-    protected boolean checkIdle() {
-        boolean idle = true;
-        busyResources.clear();
-        List<Call> calls = dispatcher.runningCalls();
-        for (Call call : calls) {
-            idle = false;
-            String url = call.request().url().toString();
-            for (Pattern pattern : blacklist) {
-                if (pattern.matcher(url).matches()) {
-                    idle = true;
-                    break;
-                }
-            }
-            if (!idle) {
-                busyResources.add(call.request().url().toString());
-            }
-        }
-        if (!idle) {
-            Choreographer.getInstance().postFrameCallback(this);
-            Log.i(LOG_TAG, "Network is busy");
-        } else {
-            if (callback != null) {
-                callback.onTransitionToIdle();
-            }
-        }
-        return idle;
-    }
-
     @Override
     public void registerIdleTransitionCallback(ResourceCallback callback) {
         this.callback = callback;
@@ -116,10 +87,42 @@ public class NetworkIdlingResource extends DetoxBaseIdlingResource implements Ch
         isIdleNow();
     }
 
+    @Override
+    protected synchronized boolean checkIdle() {
+        busyResources.clear();
+
+        List<Call> calls = dispatcher.runningCalls();
+        for (Call call: calls) {
+            final String url = call.request().url().toString();
+
+            if (!isUrlBlacklisted(url)) {
+                busyResources.add(url);
+            }
+        }
+
+        if (!busyResources.isEmpty()) {
+            Log.i(LOG_TAG, "Network is busy, with " + busyResources.size() + " in-flight calls");
+            Choreographer.getInstance().postFrameCallback(this);
+            return false;
+        }
+
+        notifyIdle();
+        return true;
+    }
+
     @Override
     protected void notifyIdle() {
         if (callback != null) {
             callback.onTransitionToIdle();
         }
     }
+
+    private boolean isUrlBlacklisted(String url) {
+        for (Pattern pattern: blacklist) {
+            if (pattern.matcher(url).matches()) {
+                return true;
+            }
+        }
+        return false;
+    }
 }

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

@@ -1,43 +1,23 @@
+
 package com.wix.detox.reactnative.idlingresources.timers
 
-import com.facebook.react.bridge.NativeModule
 import com.facebook.react.bridge.ReactContext
-import com.wix.detox.common.RNDropSupportTodo
-import com.wix.detox.reactnative.helpers.RNHelpers
-import org.joor.Reflect
+import com.facebook.react.modules.core.TimingModule
 
 private const val BUSY_WINDOW_THRESHOLD = 1500L
 
-private class RN62TimingModuleReflected(private val timingModule: NativeModule) {
-    fun hasActiveTimers(): Boolean = Reflect.on(timingModule).call("hasActiveTimersInRange", BUSY_WINDOW_THRESHOLD).get()
-}
-
 /**
  * Delegates the interrogation to the native module itself, added
  * [here](https://github.com/facebook/react-native/pull/27539) in the context
  * of RN v0.62 (followed by a previous refactor and rename of the class).
  */
-@RNDropSupportTodo(62, """
-    When min RN version supported by Detox is 0.62.x (or higher), can (and
-    should) remove any usage of reflection here.
-    That includes the unit test's stub being used for that reason in particular.
-    """)
-class DelegatedIdleInterrogationStrategy(timingModule: NativeModule): IdleInterrogationStrategy {
-    private val timingModuleReflected = RN62TimingModuleReflected(timingModule)
-
-    override fun isIdleNow(): Boolean = !timingModuleReflected.hasActiveTimers()
+class DelegatedIdleInterrogationStrategy(private val timingModule: TimingModule): IdleInterrogationStrategy {
+    override fun isIdleNow(): Boolean = !timingModule.hasActiveTimersInRange(BUSY_WINDOW_THRESHOLD)
 
     companion object {
-        fun createIfSupported(reactContext: ReactContext): DelegatedIdleInterrogationStrategy? {
-            val module = RNHelpers.getNativeModule(reactContext, "com.facebook.react.modules.core.TimingModule")
-                    ?: return null
-
-            return try {
-                module.javaClass.getDeclaredMethod("hasActiveTimersInRange", Long::class.java)
-                DelegatedIdleInterrogationStrategy(module)
-            } catch (ex: Exception) {
-                null
-            }
+        fun create(reactContext: ReactContext): DelegatedIdleInterrogationStrategy {
+            val timingModule = reactContext.getNativeModule(TimingModule::class.java)!!
+            return DelegatedIdleInterrogationStrategy(timingModule)
         }
     }
 }

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

@@ -1,6 +1,5 @@
 package com.wix.detox.reactnative.idlingresources.timers
 
-import android.util.Log
 import com.facebook.react.bridge.ReactContext
 import com.wix.detox.common.UIThread
 import java.util.concurrent.Callable
@@ -13,14 +12,5 @@ fun getInterrogationStrategy(reactContext: ReactContext): IdleInterrogationStrat
     // Getting a native-module (inside) also initializes it if needed. That has to run on a
     // looper thread, and the easiest to make sure that happens is to use the main thread.
     UIThread.runSync(Callable {
-        DelegatedIdleInterrogationStrategy.createIfSupported(reactContext)?.let {
-            return@Callable it
-        }
-
-        DefaultIdleInterrogationStrategy.createIfSupported(reactContext)?.let {
-            return@Callable it
-        }
-
-        Log.e(TimersIdlingResource.LOG_TAG, "Failed to determine proper implementation-strategy for timers idling resource")
-        null
+        return@Callable DelegatedIdleInterrogationStrategy.create(reactContext)
     })

package/android/detox/src/main/java/com/wix/detox/common/TextFileReader.kt

@@ -3,5 +3,5 @@ package com.wix.detox.common
 import java.io.File
 
 internal class TextFileReader(private val fileName: String) {
-    fun read() = File(fileName).inputStream().readBytes().toString(Charsets.UTF_8)
+    fun read() = File(fileName).readText(Charsets.UTF_8)
 }

package/android/detox/src/testFull/java/com/wix/detox/espresso/action/DetoxMultiTapSpec.kt

@@ -11,6 +11,7 @@ import org.assertj.core.api.Assertions.assertThat
 import org.mockito.kotlin.*
 import org.spekframework.spek2.Spek
 import org.spekframework.spek2.style.specification.describe
+import java.lang.NullPointerException
 import kotlin.test.assertFailsWith
 
 object DetoxMultiTapSpec: Spek({
@@ -136,17 +137,17 @@ object DetoxMultiTapSpec: Spek({
         }
 
         it("should throw if no UI-controller provided") {
-            assertFailsWith(KotlinNullPointerException::class) {
+            assertFailsWith(NullPointerException::class) {
                 uut(1).sendTap(null, coordinates, precision, -1, -1)
             }
         }
 
         it("should throw if no coordinates / precision are provided") {
-            assertFailsWith(KotlinNullPointerException::class) {
+            assertFailsWith(NullPointerException::class) {
                 uut(1).sendTap(uiController, null, precision, -1, -1)
             }
 
-            assertFailsWith(KotlinNullPointerException::class) {
+            assertFailsWith(NullPointerException::class) {
                 uut(1).sendTap(uiController, coordinates, null, -1, -1)
             }
         }

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

@@ -0,0 +1,61 @@
+package com.wix.detox.reactnative.idlingresources
+
+import com.wix.detox.UTHelpers.yieldToOtherThreads
+import org.assertj.core.api.Assertions.assertThat
+
+import okhttp3.Dispatcher
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+import java.util.concurrent.Executors
+
+@RunWith(RobolectricTestRunner::class)
+class NetworkIdlingResourcesTest {
+    lateinit var dispatcher: Dispatcher
+    lateinit var uut: NetworkIdlingResource
+
+    @Before
+    fun setup() {
+        dispatcher = Dispatcher()
+        uut = NetworkIdlingResource(dispatcher)
+    }
+
+    // Note: Ideally, we should test that the list of busy resources is protected,
+    // rather than testing thread-safety as a whole.
+    @Test
+    fun `should return the description in a thread-safe way`() {
+        val localExecutor = Executors.newSingleThreadExecutor()
+        var description: IdlingResourceDescription? = null
+
+        synchronized(uut) {
+            localExecutor.submit {
+                description = uut.getDescription()
+            }
+
+            yieldToOtherThreads(localExecutor)
+            assertThat(description).isNull()
+        }
+        yieldToOtherThreads(localExecutor)
+        assertThat(description).isNotNull()
+    }
+
+    // Note: Ideally, we should test that the list of busy resources is protected,
+    // rather than testing thread-safety as a whole.
+    @Test
+    fun `should check for idle in a thread-safe way`() {
+        val localExecutor = Executors.newSingleThreadExecutor()
+        var idle = false
+
+        synchronized(uut) {
+            localExecutor.submit {
+                idle = uut.isIdleNow
+            }
+
+            yieldToOtherThreads(localExecutor)
+            assertThat(idle).isFalse
+        }
+        yieldToOtherThreads(localExecutor)
+        assertThat(idle).isTrue
+    }
+}

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

@@ -5,22 +5,14 @@ import org.assertj.core.api.Assertions.assertThat
 import org.mockito.kotlin.*
 import org.spekframework.spek2.Spek
 import org.spekframework.spek2.style.specification.describe
+import com.facebook.react.modules.core.TimingModule
 
 private const val BUSY_INTERVAL_MS = 1500L
 
-abstract class TimingModuleStub: NativeModule {
-    abstract fun hasActiveTimersInRange(rangeMs: Long): Boolean
-
-    override fun onCatalystInstanceDestroy() {}
-    override fun getName(): String = "TimersNativeModuleStub"
-    override fun canOverrideExistingModule() = false
-    override fun initialize() {}
-}
-
 object DelegatedIdleInterrogationStrategySpec : Spek({
-    describe("RN62+ timers idle-interrogation strategy") {
+    describe("Timers idle-interrogation strategy") {
 
-        lateinit var timingModule: TimingModuleStub
+        lateinit var timingModule: TimingModule
 
         beforeEachTest {
             timingModule = mock()