Setup a Macrobenchmark for RNTester

build.gradle.kts

@@ -12,6 +12,7 @@ plugins {
   alias(libs.plugins.download) apply false
   alias(libs.plugins.kotlin.android) apply false
   alias(libs.plugins.binary.compatibility.validator) apply true
+  alias(libs.plugins.android.test) apply false
 }
 
 val reactAndroidProperties = java.util.Properties()

packages/react-native/gradle/libs.versions.toml

@@ -10,12 +10,16 @@ agp = "8.8.0"
 androidx-annotation = "1.6.0"
 androidx-appcompat = "1.7.0"
 androidx-autofill = "1.1.0"
+androidx-benchmark-macro-junit4 = "1.3.3"
+androidx-profileinstaller = "1.4.1"
 androidx-swiperefreshlayout = "1.1.0"
 androidx-test = "1.5.0"
+androidx-test-junit = "1.2.1"
 androidx-tracing = "1.1.0"
 assertj = "3.21.0"
 binary-compatibility-validator = "0.13.2"
 download = "5.4.0"
+espresso-core = "3.6.1"
 fbjni = "0.7.0"
 fresco = "3.6.0"
 infer-annotation = "0.18.0"
@@ -32,6 +36,7 @@ okhttp = "4.9.2"
 okio = "2.9.0"
 robolectric = "4.9.2"
 soloader = "0.12.1"
+uiautomator = "2.3.0"
 xstream = "1.4.20"
 yoga-proguard-annotations = "1.19.0"
 # Native Dependencies
@@ -44,14 +49,19 @@ glog="0.3.5"
 gtest="1.12.1"
 
 [libraries]
+androidx-annotation = { module = "androidx.annotation:annotation", version.ref = "androidx-annotation" }
 androidx-appcompat = { module = "androidx.appcompat:appcompat", version.ref = "androidx-appcompat" }
 androidx-appcompat-resources = { module = "androidx.appcompat:appcompat-resources", version.ref = "androidx-appcompat" }
-androidx-annotation = { module = "androidx.annotation:annotation", version.ref = "androidx-annotation" }
 androidx-autofill = { module = "androidx.autofill:autofill", version.ref = "androidx-autofill" }
+androidx-benchmark-macro-junit4 = { group = "androidx.benchmark", name = "benchmark-macro-junit4", version.ref = "androidx-benchmark-macro-junit4" }
+androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espresso-core" }
+androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "androidx-test-junit" }
+androidx-profileinstaller = { group = "androidx.profileinstaller", name = "profileinstaller", version.ref = "androidx-profileinstaller" }
 androidx-swiperefreshlayout = { module = "androidx.swiperefreshlayout:swiperefreshlayout", version.ref = "androidx-swiperefreshlayout" }
-androidx-tracing = { module = "androidx.tracing:tracing", version.ref = "androidx-tracing" }
-androidx-test-runner = { module = "androidx.test:runner", version.ref = "androidx-test" }
 androidx-test-rules = { module = "androidx.test:rules", version.ref = "androidx-test" }
+androidx-test-runner = { module = "androidx.test:runner", version.ref = "androidx-test" }
+androidx-tracing = { module = "androidx.tracing:tracing", version.ref = "androidx-tracing" }
+androidx-uiautomator = { group = "androidx.test.uiautomator", name = "uiautomator", version.ref = "uiautomator" }
 
 fbjni = { module = "com.facebook.fbjni:fbjni", version.ref = "fbjni" }
 fresco = { module = "com.facebook.fresco:fresco", version.ref = "fresco" }
@@ -84,3 +94,4 @@ download = { id = "de.undercouch.download", version.ref = "download" }
 nexus-publish = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexus-publish" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 binary-compatibility-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "binary-compatibility-validator" }
+android-test = { id = "com.android.test", version.ref = "agp" }

packages/rn-tester/ReportFullyDrawnView/ReportFullyDrawnView.android.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+import ReportFullyDrawnViewNativeComponent from './ReportFullyDrawnViewNativeComponent';
+
+export default ReportFullyDrawnViewNativeComponent;

packages/rn-tester/ReportFullyDrawnView/ReportFullyDrawnView.js

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+import {View} from 'react-native';
+
+export default View;

packages/rn-tester/ReportFullyDrawnView/ReportFullyDrawnViewNativeComponent.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ */
+
+import type {HostComponent} from 'react-native';
+import type {ViewProps} from 'react-native/Libraries/Components/View/ViewPropTypes';
+
+import codegenNativeComponent from 'react-native/Libraries/Utilities/codegenNativeComponent';
+
+type NativeProps = $ReadOnly<{
+  ...ViewProps,
+}>;
+
+export type ReportFullyDrawnViewType = HostComponent<ViewProps>;
+
+export default (codegenNativeComponent<NativeProps>(
+  'RNTReportFullyDrawnView',
+): ReportFullyDrawnViewType);

packages/rn-tester/android/app/benchmark/.gitignore

@@ -0,0 +1 @@
+/build

packages/rn-tester/android/app/benchmark/build.gradle.kts

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+plugins {
+  alias(libs.plugins.android.test)
+  alias(libs.plugins.kotlin.android)
+}
+
+android {
+  namespace = "com.example.benchmark"
+  compileSdk = libs.versions.compileSdk.get().toInt()
+
+  defaultConfig {
+    minSdk = libs.versions.minSdk.get().toInt()
+    targetSdk = libs.versions.targetSdk.get().toInt()
+
+    testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+  }
+
+  buildTypes {
+    // This benchmark buildType is used for benchmarking, and should function like your
+    // release build (for example, with minification on). It"s signed with a debug key
+    // for easy local/CI testing.
+    create("benchmark") {
+      isDebuggable = true
+      signingConfig = getByName("debug").signingConfig
+      matchingFallbacks += listOf("release")
+    }
+  }
+
+  flavorDimensions += listOf("vm")
+  productFlavors {
+    create("hermes") { dimension = "vm" }
+    create("jsc") { dimension = "vm" }
+  }
+
+  targetProjectPath = ":packages:rn-tester:android:app"
+  experimentalProperties["android.experimental.self-instrumenting"] = true
+}
+
+dependencies {
+  implementation(libs.androidx.junit)
+  implementation(libs.androidx.espresso.core)
+  implementation(libs.androidx.uiautomator)
+  implementation(libs.androidx.benchmark.macro.junit4)
+}
+
+androidComponents { beforeVariants(selector().all()) { it.enable = it.buildType == "benchmark" } }

packages/rn-tester/android/app/benchmark/src/main/java/com/facebook/react/uiapp/benchmark/RNTesterStartupBenchmark.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package com.facebook.react.uiapp.benchmark
+
+import androidx.benchmark.macro.StartupMode
+import androidx.benchmark.macro.StartupTimingMetric
+import androidx.benchmark.macro.junit4.MacrobenchmarkRule
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.uiautomator.By
+import androidx.test.uiautomator.Until
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+/**
+ * RNTester benchmarks.
+ *
+ * Run this benchmark from Android Studio to see startup measurements, and captured system traces for
+ * investigating performance.
+ */
+@RunWith(AndroidJUnit4::class)
+class RNTesterStartupBenchmark {
+  @get:Rule val benchmarkRule = MacrobenchmarkRule()
+
+  @Test
+  fun startup() =
+      benchmarkRule.measureRepeated(
+          packageName = "com.facebook.react.uiapp",
+          metrics = listOf(StartupTimingMetric()),
+          iterations = 10,
+          startupMode = StartupMode.COLD,
+          setupBlock = {
+            pressHome()
+          }) {
+            startActivityAndWait()
+
+            // Waits for an element that corresponds to fully drawn state
+            device.wait(Until.hasObject(By.text("Components")), 10_000)
+            device.waitForIdle()
+          }
+}

packages/rn-tester/android/app/build.gradle.kts

@@ -165,6 +165,7 @@ dependencies {
   "jscImplementation"(jscFlavor)
 
   testImplementation(libs.junit)
+  implementation(libs.androidx.profileinstaller)
 }
 
 android {