Introduce a more sensible impl of debug-sync (Android (wix#2725)

Merging because the main downstream build is green. Others failed for reasons related to Macstadium network.

Author: d4vidi

detox/android/detox/src/full/java/com/wix/detox/DetoxActionHandlers.kt

@@ -6,9 +6,8 @@ import androidx.test.espresso.IdlingResource
 import com.wix.detox.common.extractRootCause
 import com.wix.detox.instruments.DetoxInstrumentsException
 import com.wix.detox.instruments.DetoxInstrumentsManager
+import com.wix.detox.reactnative.idlingresources.DescriptiveIdlingResource
 import com.wix.invoke.MethodInvocation
-import org.json.JSONArray
-import org.json.JSONException
 import org.json.JSONObject
 import java.lang.reflect.InvocationTargetException
 
@@ -101,20 +100,27 @@ class QueryStatusActionHandler(
     override fun handle(params: String, messageId: Long) {
         val data = mutableMapOf<String, Any>()
         val busyResources = testEngineFacade.getBusyIdlingResources()
-        var status = ""
 
-        if (busyResources.isEmpty()) {
-            status = "The app is idle."
-        } else {
-            status = "Busy idling resources:\n"
-            for (res in busyResources) {
-                status += "\t- ${res.name}\n"
-            }
-        }
-
-        data["status"] = status
+        data["status"] = "App synchronization debug: " +
+                if (busyResources.isEmpty()) {
+                    "The app appears to be idle!"
+                } else {
+                    val summary = busyResources.joinToString("\n") { "\t - ${formatResource(it)}" }
+                    "The app is busy, due to: \n$summary"
+                }
         wsClient.sendAction("currentStatusResult", data, messageId)
     }
+
+    private fun formatResource(resource: IdlingResource): String =
+            if (resource is DescriptiveIdlingResource) {
+                resource.getDescription()
+            } else if (resource.javaClass.name.contains("LooperIdlingResource") && resource.name.contains("mqt_js")) {
+                "Javascript code execution"
+            } else if (resource.javaClass.name.contains("LooperIdlingResource") && resource.name.contains("mqt_native")) {
+                "Javascript code execution (native)"
+            } else {
+                "Resource ${resource.name} being busy"
+            }
 }
 
 class InstrumentsRecordingStateActionHandler(

detox/android/detox/src/full/java/com/wix/detox/TestEngineFacade.kt

@@ -3,10 +3,9 @@ package com.wix.detox
 import android.content.Context
 import android.util.Log
 import androidx.test.espresso.Espresso
-import androidx.test.espresso.IdlingResource
 import com.wix.detox.common.DetoxLog.Companion.LOG_TAG
-import com.wix.detox.espresso.EspressoDetox
 import com.wix.detox.espresso.UiAutomatorHelper
+import com.wix.detox.espresso.registry.IRStatusInquirer
 import com.wix.detox.reactnative.ReactNativeExtension
 
 class TestEngineFacade {
@@ -15,7 +14,9 @@ class TestEngineFacade {
         null
     }
     fun syncIdle() = UiAutomatorHelper.espressoSync() // TODO Check whether this can be replaced with #awaitIdle()
-    fun getBusyIdlingResources() = EspressoDetox.getBusyEspressoResources() as List<IdlingResource>
+    fun getBusyIdlingResources() = IRStatusInquirer.INSTANCE.getAllBusyResources()
+
+    // TODO Refactor RN related stuff away
     fun reloadReactNative(appContext: Context) = ReactNativeExtension.reloadReactNative(appContext)
     fun resetReactNative() = ReactNativeExtension.clearAllSynchronization()
 }

detox/android/detox/src/full/java/com/wix/detox/espresso/EspressoDetox.java

@@ -4,26 +4,21 @@
 import android.content.Context;
 import android.content.ContextWrapper;
 import android.content.pm.ActivityInfo;
-import android.os.Handler;
 import android.util.Log;
 import android.view.View;
 import android.view.ViewGroup;
 
+import com.wix.detox.common.UIThread;
 import com.wix.detox.reactnative.ReactNativeExtension;
 import com.wix.detox.reactnative.idlingresources.NetworkIdlingResource;
 
 import org.hamcrest.Matcher;
-import org.joor.Reflect;
-import org.joor.ReflectException;
 
 import java.util.ArrayList;
 
-import androidx.test.espresso.Espresso;
-import androidx.test.espresso.IdlingResource;
 import androidx.test.espresso.UiController;
 import androidx.test.espresso.ViewAction;
 import androidx.test.espresso.ViewInteraction;
-import androidx.test.platform.app.InstrumentationRegistry;
 
 import static androidx.test.espresso.Espresso.onView;
 import static androidx.test.espresso.matcher.ViewMatchers.isRoot;
@@ -113,71 +108,12 @@ public static void setSynchronization(boolean enabled) {
     }
 
     public static void setURLBlacklist(final ArrayList<String> urls) {
-        InstrumentationRegistry.getInstrumentation().runOnMainSync(new Runnable() {
+        UIThread.postSync(new Runnable() {
             @Override
             public void run() {
                 NetworkIdlingResource.setURLBlacklist(urls);
             }
         });
     }
-
-    public static ArrayList<IdlingResource> getBusyEspressoResources() {
-        // We do this in this complicated way for two reasons
-        // 1. we want to use postAtFrontOfQueue()
-        // 2. we want it to be synchronous
-        final ArrayList<IdlingResource> busyResources = new ArrayList<>();
-        final Handler handler = new Handler(InstrumentationRegistry.getInstrumentation().getTargetContext().getMainLooper());
-        final SyncRunnable sr = new SyncRunnable(new Runnable() {
-            @Override
-            public void run() {
-                // The following snippet works only in Espresso 3.0
-                try {
-                    ArrayList<Object> idlingStates = Reflect.on(Espresso.class)
-                            .field("baseRegistry")
-                            .field("idlingStates")
-                            .get();
-                    for (int i = 0; i < idlingStates.size(); ++i) {
-                        if (!(boolean)Reflect.on(idlingStates.get(i)).field("idle").get()) {
-                            busyResources.add((IdlingResource)Reflect.on(idlingStates.get(i)).field("resource").get());
-                        }
-                    }
-                } catch (ReflectException e) {
-                    Log.d(LOG_TAG, "Couldn't get busy resources", e);
-                }
-            }
-        });
-        handler.postAtFrontOfQueue(sr);
-        sr.waitForComplete();
-        return busyResources;
-    }
-
-
-    private static final class SyncRunnable implements Runnable {
-        private final Runnable mTarget;
-        private boolean mComplete;
-
-        public SyncRunnable(Runnable target) {
-            mTarget = target;
-        }
-
-        public void run() {
-            mTarget.run();
-            synchronized (this) {
-                mComplete = true;
-                notifyAll();
-            }
-        }
-
-        public void waitForComplete() {
-            synchronized (this) {
-                while (!mComplete) {
-                    try {
-                        wait();
-                    } catch (InterruptedException e) {
-                    }
-                }
-            }
-        }
-    }
 }
 

detox/android/detox/src/full/java/com/wix/detox/espresso/UiAutomatorHelper.java

@@ -6,6 +6,7 @@
 import android.util.Log;
 import android.view.Choreographer;
 
+import com.wix.detox.common.UIThread;
 import com.wix.detox.espresso.common.utils.UiControllerUtils;
 
 import org.joor.Reflect;
@@ -33,7 +34,7 @@ public static void espressoSync() {
         // I want to invoke Espresso's sync mechanism manually.
         // This turned out to be amazingly difficult. This below is the
         // nicest solution I could come up with.
-        InstrumentationRegistry.getInstrumentation().runOnMainSync(new Runnable() {
+        UIThread.runSync(new Runnable() {
             @Override
             public void run() {
                 try {
@@ -54,7 +55,7 @@ public static void espressoSync(final long millis) {
         // I want to invoke Espresso's sync mechanism manually.
         // This turned out to be amazingly difficult. This below is the
         // nicest solution I could come up with.
-        InstrumentationRegistry.getInstrumentation().runOnMainSync(new Runnable() {
+        UIThread.runSync(new Runnable() {
             @Override
             public void run() {
                 try {

detox/android/detox/src/full/java/com/wix/detox/espresso/registry/IRStatusInquirer.kt

@@ -0,0 +1,24 @@
+package com.wix.detox.espresso.registry
+
+import androidx.test.espresso.Espresso
+import androidx.test.espresso.IdlingResource
+import androidx.test.espresso.base.IdlingResourceRegistry
+import com.wix.detox.common.UIThread
+import org.joor.Reflect
+import java.util.concurrent.Callable
+
+class IRStatusInquirer(private val registry: IdlingResourceRegistry) {
+    fun getAllBusyResources(): List<IdlingResource> {
+        return UIThread.postFirstSync(Callable<List<IdlingResource>> {
+            registry.resources.filter { resource ->
+                !resource.isIdleNow
+            }
+        })
+    }
+
+    companion object {
+        val INSTANCE = IRStatusInquirer(getRegistryDefault())
+    }
+}
+
+private fun getRegistryDefault() = Reflect.on(Espresso::class.java).get<IdlingResourceRegistry>("baseRegistry")

detox/android/detox/src/full/java/com/wix/detox/reactnative/ReactNativeIdlingResources.kt

@@ -46,6 +46,7 @@ private class MQThreadReflected(private val queue: Any?, private val queueName:
 class ReactNativeIdlingResources constructor(
         private val reactContext: ReactContext,
         internal var networkSyncEnabled: Boolean = true)
+
     {
 
     companion object {
@@ -63,7 +64,7 @@ class ReactNativeIdlingResources constructor(
     private var networkIdlingResource: NetworkIdlingResource? = null
 
     fun registerAll() {
-        Log.i(LOG_TAG, "Setting up Espresso Idling Resources for React Native.")
+        Log.i(LOG_TAG, "Setting up Espresso Idling Resources for React Native")
 
         unregisterAll()
 

detox/android/detox/src/full/java/com/wix/detox/reactnative/helpers/RNHelpers.kt

@@ -14,11 +14,11 @@ object RNHelpers {
             if (reactContext.hasNativeModule(moduleClass)) {
                 reactContext.getNativeModule(moduleClass)
             } else {
-                Log.d(LOG_TAG, "Native module not resolved: no registered module")
+                Log.d(LOG_TAG, "Native RN module resolution (class $className): no registered module found")
                 null
             }
-        } catch (ex: Exception) {
-            Log.d(LOG_TAG, "Native module not resolved: no such class")
+        } catch (ex: ClassNotFoundException) {
+            Log.d(LOG_TAG, "Native RN module resolution (class $className): no such class")
             null
         }
 }

detox/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/AnimatedModuleIdlingResource.java

@@ -5,11 +5,11 @@
 
 import com.wix.detox.reactnative.ReactNativeInfo;
 
+import org.jetbrains.annotations.NotNull;
 import org.joor.Reflect;
 import org.joor.ReflectException;
 
 import androidx.annotation.NonNull;
-import androidx.test.espresso.IdlingResource;
 
 /**
  * Created by simonracz on 25/08/2017.
@@ -29,7 +29,7 @@
  *
  * @see <a href="https://github.com/facebook/react-native/blob/259eac8c30b536abddab7925f4c51f0bf7ced58d/ReactAndroid/src/main/java/com/facebook/react/animated/NativeAnimatedModule.java#L143">AnimatedModule</a>
  */
-public class AnimatedModuleIdlingResource implements IdlingResource, Choreographer.FrameCallback {
+public class AnimatedModuleIdlingResource implements DescriptiveIdlingResource, Choreographer.FrameCallback {
     private static final String LOG_TAG = "Detox";
 
     private final static String CLASS_ANIMATED_MODULE = "com.facebook.react.animated.NativeAnimatedModule";
@@ -63,6 +63,12 @@ public String getName() {
         return AnimatedModuleIdlingResource.class.getName();
     }
 
+    @NotNull
+    @Override
+    public String getDescription() {
+        return "Animations running on screen";
+    }
+
     @Override
     public boolean isIdleNow() {
         Class<?> animModuleClass = null;

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

@@ -28,7 +28,7 @@ open class AsyncStorageIdlingResource
     @JvmOverloads constructor(
         module: NativeModule,
         sexecutorReflectedGenFn: SExecutorReflectedGenFnType = defaultSExecutorReflectedGenFn)
-    : IdlingResource {
+    : DescriptiveIdlingResource {
 
     open val logTag: String
         get() = LOG_TAG
@@ -50,6 +50,7 @@ open class AsyncStorageIdlingResource
     }
 
     override fun getName(): String = javaClass.name
+    override fun getDescription() = "Disk I/O activity"
     override fun isIdleNow(): Boolean =
         checkIdle().also { idle ->
             if (!idle) {

detox/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/BridgeIdlingResource.java

@@ -5,6 +5,8 @@
 import com.facebook.react.bridge.NotThreadSafeBridgeIdleDebugListener;
 import com.facebook.react.bridge.ReactContext;
 
+import org.jetbrains.annotations.NotNull;
+
 import java.util.concurrent.atomic.AtomicBoolean;
 
 /**
@@ -38,6 +40,12 @@ public String getName() {
         return BridgeIdlingResource.class.getName();
     }
 
+    @NotNull
+    @Override
+    public String getDescription() {
+        return "Activity on the React-Native bridge";
+    }
+
     @Override
     protected boolean checkIdle() {
         boolean ret = idleNow.get();
@@ -64,6 +72,7 @@ public void onTransitionToBridgeBusy() {
         // Log.i(LOG_TAG, "JS Bridge transitions to busy.");
     }
 
+    @Override
     public void onBridgeDestroyed() {
     }
 

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

@@ -0,0 +1,7 @@
+package com.wix.detox.reactnative.idlingresources
+
+import androidx.test.espresso.IdlingResource
+
+interface DescriptiveIdlingResource: IdlingResource {
+    fun getDescription(): String
+}

detox/android/detox/src/full/java/com/wix/detox/reactnative/idlingresources/DetoxBaseIdlingResource.java

@@ -2,9 +2,7 @@
 
 import java.util.concurrent.atomic.AtomicBoolean;
 
-import androidx.test.espresso.IdlingResource;
-
-public abstract class DetoxBaseIdlingResource implements IdlingResource {
+public abstract class DetoxBaseIdlingResource implements DescriptiveIdlingResource {
     AtomicBoolean paused = new AtomicBoolean(false);
 
     public void pause() {

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

@@ -5,6 +5,8 @@
 
 import com.facebook.react.bridge.ReactContext;
 
+import org.jetbrains.annotations.NotNull;
+
 import java.util.ArrayList;
 import java.util.List;
 import java.util.regex.Pattern;
@@ -64,6 +66,12 @@ public String getName() {
         return NetworkIdlingResource.class.getName();
     }
 
+    @NotNull
+    @Override
+    public String getDescription() {
+        return "In-flight network activity";
+    }
+
     @Override
     protected boolean checkIdle() {
         boolean idle = true;