(CI) Switch to Google ARM emulators for SDK35 (#4814)

Author: d4vidi

.buildkite/jobs/pipeline.android_rn_79.yml

@@ -5,7 +5,7 @@
  env:
  REACT_NATIVE_VERSION: 0.79.5
  RCT_NEW_ARCH_ENABLED: 1
- USE_GENYCLOUD_ARM64: true # Scarce resource: Use this only for the latest RN version
+ USE_GOOGLE_ARM64: true
  DETOX_DISABLE_POD_INSTALL: true
  DETOX_DISABLE_POSTINSTALL: true
  artifact_paths:

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

@@ -19,7 +19,6 @@ abstract class DetoxIdlingResource : DescriptiveIdlingResource {
  paused.set(false)
  }
 
-
  override fun registerIdleTransitionCallback(callback: IdlingResource.ResourceCallback?) {
  this.callback = callback
  }
@@ -37,7 +36,6 @@ abstract class DetoxIdlingResource : DescriptiveIdlingResource {
 
  protected abstract fun checkIdle(): Boolean
 
-
  fun notifyIdle() {
  callback?.onTransitionToIdle()
  }

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

@@ -16,7 +16,6 @@ import com.wix.detox.reactnative.idlingresources.network.NetworkIdlingResource
 import kotlinx.coroutines.runBlocking
 import org.joor.Reflect
 
-
 private const val LOG_TAG = "DetoxRNIdleRes"
 
 class ReactNativeIdlingResources(

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

@@ -0,0 +1,74 @@
+package com.wix.detox.reactnative.idlingresources
+
+import androidx.test.espresso.IdlingResource.ResourceCallback
+/**
+ * A wrapper for idling resources that exhibit "flapping" behavior.
+ * This wrapper artificially stabilizes them by mindfully extending their "busy" state periods.
+ *
+ * #### What does flapping mean?
+ *
+ * Some idling resources have extremely short busy periods. While this shouldn't theoretically be an issue,
+ * in real-world scenarios (e.g., a React Native environment), the number of idling resources can accumulate.
+ * Unfortunately, the process of checking if all resources are idle (idle interrogation)
+ * isn't atomic. With many resources involved, this process might miss those brief busy periods
+ * of resources that "flap" (quickly switch between busy and idle) during the interrogation.
+ *
+ * #### How does this wrapper fix flapping?
+ *
+ * This wrapper requires the wrapped resource to report itself as "idle" multiple times consecutively
+ * before the wrapper itself is considered idle. This dramatically reduces the likelihood of it's busy phase being
+ * missed by the idle interrogation process.
+ */
+class StabilizedIdlingResource(
+ private val idlingResource: DetoxIdlingResource,
+ private val size: Int): DetoxIdlingResource(), ResourceCallback {
+
+ private val name = "${idlingResource.name} (stable@$size)"
+ private var idleCounter = 0
+
+ init {
+ if (size <= 1) {
+ throw IllegalArgumentException("Size must be > 1 in order for the usage of this class to make sense")
+ }
+ idlingResource.registerIdleTransitionCallback(this)
+ }
+
+ /**
+ * Implemented according to these 3 guiding principles:
+ * 1. As long as the actual resource is busy - we consider ourselves busy too.
+ * 2. Once actual resource is idle enough times in a row - we consider ourselves "idle", in a *sticky* way
+ * (until it returns "busy" in an interrogation).
+ * 3. Espresso requires that just before we officially transition ourselves -- idle -> busy, we actively notify it
+ * via the callback.
+ */
+ @Synchronized
+ override fun checkIdle(): Boolean {
+ if (!idlingResource.isIdleNow) {
+ idleCounter = 0
+ return false
+ }
+
+ if (idleCounter < size) {
+ idleCounter++
+
+ if (idleCounter == size) {
+ notifyIdle()
+ }
+ }
+ return (idleCounter == size)
+ }
+
+ /**
+ * Resets the counter to 0, assuming that Espresso will re-query this (among all other) resources
+ * immediately after this "I'm idle" notification.
+ */
+ @Synchronized
+ override fun onTransitionToIdle() {
+ idleCounter = 0
+ notifyIdle()
+ }
+
+ override fun getName(): String = name
+ override fun getDebugName(): String = idlingResource.getDebugName()
+ override fun getBusyHint(): Map<String, Any>? = idlingResource.getBusyHint()
+}

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

@@ -1,9 +1,9 @@
 package com.wix.detox.reactnative.idlingresources.factory
 
 import com.facebook.react.ReactApplication
-import com.wix.detox.reactnative.getCurrentReactContext
 import com.wix.detox.reactnative.getCurrentReactContextSafe
 import com.wix.detox.reactnative.idlingresources.DetoxIdlingResource
+import com.wix.detox.reactnative.idlingresources.StabilizedIdlingResource
 import com.wix.detox.reactnative.idlingresources.animations.AnimatedModuleIdlingResource
 import com.wix.detox.reactnative.idlingresources.network.NetworkIdlingResource
 import com.wix.detox.reactnative.idlingresources.storage.AsyncStorageIdlingResource
@@ -23,7 +23,7 @@ class FabricDetoxIdlingResourceFactoryStrategy(private val reactApplication: Rea
  IdlingResourcesName.Animations to AnimatedModuleIdlingResource(reactContext),
  IdlingResourcesName.Timers to FabricTimersIdlingResource(reactContext),
  IdlingResourcesName.Network to NetworkIdlingResource(reactContext),
- IdlingResourcesName.AsyncStorage to AsyncStorageIdlingResource(reactContext)
+ IdlingResourcesName.AsyncStorage to StabilizedIdlingResource(AsyncStorageIdlingResource(reactContext), 2)
  )
 
  return@withContext result

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

@@ -1,6 +1,5 @@
 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
@@ -9,36 +8,17 @@ import com.wix.detox.reactnative.idlingresources.DetoxIdlingResource
 import org.joor.Reflect
 import java.util.concurrent.Executor
 
-private const val LOG_TAG = "AsyncStorageIR"
-
 private typealias SExecutorReflectedGenFnType = (executor: Executor) -> SerialExecutorReflected
 
 private val defaultSExecutorReflectedGenFn: SExecutorReflectedGenFnType =
  { executor: Executor -> SerialExecutorReflected(executor) }
 
-private class ModuleReflected(module: NativeModule, sexecutorReflectedGen: SExecutorReflectedGenFnType) {
- private val executorReflected: SerialExecutorReflected
-
- init {
- val reflected = Reflect.on(module)
- val executor: Executor = reflected.field("executor").get()
- executorReflected = sexecutorReflectedGen(executor)
- }
-
- val sexecutor: SerialExecutorReflected
- get() = executorReflected
-}
-
-class AsyncStorageIdlingResource
-@JvmOverloads constructor(
+class AsyncStorageIdlingResource @JvmOverloads constructor(
  private val reactContext: ReactContext,
  private val sexecutorReflectedGenFn: SExecutorReflectedGenFnType = defaultSExecutorReflectedGenFn,
- private val rnHelpers: RNHelpers = RNHelpers()
+ private val rnHelpers: RNHelpers = RNHelpers(),
 ) : DetoxIdlingResource() {
 
- val logTag: String
- get() = LOG_TAG
-
  private val moduleReflected: ModuleReflected? = null
  private var idleCheckTask: Runnable? = null
  private val idleCheckTaskImpl = Runnable {
@@ -86,13 +66,14 @@ class AsyncStorageIdlingResource
 
  override fun registerIdleTransitionCallback(callback: IdlingResource.ResourceCallback?) {
  super.registerIdleTransitionCallback(callback)
+
+ // TODO Don't do?
  enqueueIdleCheckTask()
  }
 
  override fun checkIdle(): Boolean =
  checkIdleInternal().also { idle ->
  if (!idle) {
- Log.d(logTag, "Async-storage is busy!")
  enqueueIdleCheckTask()
  }
  }
@@ -117,3 +98,16 @@ class AsyncStorageIdlingResource
  idleCheckTask = null
  }
 }
+
+private class ModuleReflected(module: NativeModule, sexecutorReflectedGen: SExecutorReflectedGenFnType) {
+ private val executorReflected: SerialExecutorReflected
+
+ init {
+ val reflected = Reflect.on(module)
+ val executor: Executor = reflected.field("executor").get()
+ executorReflected = sexecutorReflectedGen(executor)
+ }
+
+ val sexecutor: SerialExecutorReflected
+ get() = executorReflected
+}

detox/test/e2e/detox.config.js

@@ -106,9 +106,8 @@ const config = {
  'android.emulator': {
  type: 'android.emulator',
  headless: Boolean(process.env.CI),
- gpuMode: process.env.CI ? 'off' : undefined,
  device: {
- avdName: 'Pixel_3a_API_34'
+ avdName: 'Pixel_3a_API_35'
  },
  utilBinaryPaths: ["e2e/util-binary/detoxbutler-1.0.4-aosp-release.apk"]
  },

detox/test/e2e/helpers/AndroidUIInit/DeviceInitCache.js

@@ -0,0 +1,6 @@
+const deviceInitCache = new Set();
+
+module.exports = {
+ isInitialized: (deviceId) => deviceInitCache.has(deviceId),
+ markInitialized: (deviceId) => deviceInitCache.add(deviceId),
+};

detox/test/e2e/helpers/AndroidUIInit/index.js

@@ -0,0 +1,85 @@
+const { device } = require('detox');
+
+const initCache = require('./DeviceInitCache');
+const sleep = require('../../utils/sleep');
+const log = {
+ info: (...args) => console.log('[AndroidUIInit]', ...args),
+}
+const adbWrapper = () => {
+ const adbName = device.id;
+ const { adb } = device.deviceDriver;
+
+ const shell = async (cmd) => {
+ await adb.shell(adbName, cmd);
+ await sleep(200);
+ };
+
+ return {
+ name: adbName,
+ shell,
+ };
+};
+
+class AndroidUIInitHelper {
+ subscribe({ testEvents }) {
+ testEvents.on('setup', this._handleSetupEvent.bind(this));
+ }
+
+ async _handleSetupEvent() {
+ if (device.getPlatform() !== 'android') {
+ return;
+ }
+
+
+ const adb = adbWrapper();
+
+ if (initCache.isInitialized(adb.name)) {
+ log.info(`Skipping setup for ${adb.name} (already initialized by this worker)`);
+ return;
+ }
+
+ log.info(`Running init for ${adb.name}`);
+
+ await this._setupKeyboardBehavior(adb);
+ await this._setupPointerIndicators(adb);
+ await this._setupNavigationMode(adb);
+ await this._setupStatusBar(adb);
+
+ initCache.markInitialized(adb.name);
+ log.info(`Finished init for ${adb.name}`);
+ }
+
+ async _setupKeyboardBehavior(adb) {
+ // Force-hide the on-screen keyboard
+ await adb.shell('settings put Secure show_ime_with_hard_keyboard 0');
+ }
+
+ async _setupPointerIndicators(adb) {
+ await adb.shell('settings put system show_touches 1');
+ await adb.shell('settings put system pointer_location 1');
+ }
+
+ async _setupNavigationMode(adb) {
+ await adb.shell('cmd overlay enable com.android.internal.systemui.navbar.threebutton');
+ }
+
+ // Ref: https://android.googlesource.com/platform/frameworks/base/+/master/packages/SystemUI/docs/demo_mode.md
+ async _setupStatusBar(adb) {
+ // Enable, then get out (= reset status-bar) and back into demo mode
+ await adb.shell('settings put global sysui_demo_allowed 1');
+ await adb.shell('am broadcast -a com.android.systemui.demo -e command exit');
+ await adb.shell('am broadcast -a com.android.systemui.demo -e command enter');
+
+ // Force status bar content
+ await adb.shell('am broadcast -a com.android.systemui.demo -e command notifications -e visible false');
+ await adb.shell('am broadcast -a com.android.systemui.demo -e command network -e wifi hide');
+ await adb.shell('am broadcast -a com.android.systemui.demo -e command network -e wifi show -e level 4 -e fully true');
+ await adb.shell('am broadcast -a com.android.systemui.demo -e command network -e mobile hide');
+ // Best to keep this last due to a "charging" indicator animation which can
+ // break UI changes made by consequent commands
+ await adb.shell('am broadcast -a com.android.systemui.demo -e command battery -e level 100 -e plugged true');
+ await sleep(1500); // Wait for the animation to finish
+ }
+}
+
+module.exports = new AndroidUIInitHelper();

detox/test/e2e/testEnvironment.js

@@ -1,7 +1,14 @@
 const { DetoxCircusEnvironment } = require('detox/runners/jest');
 const { worker } = require('detox/internals')
+const AndroidUIInitHelper = require('./helpers/AndroidUIInit');
 
 class CustomDetoxEnvironment extends DetoxCircusEnvironment {
+ constructor(...args) {
+ super(...args);
+
+ AndroidUIInitHelper.subscribe({ testEvents: this.testEvents});
+ }
+
  async setup() {
  await super.setup();