Merge pull request #115 from cortinico/nc/p01-macrobenchmark

Optional challange - P01 – Measure the performance of the app

androidApp/build.gradle.kts

@@ -25,6 +25,11 @@ android {
             isMinifyEnabled = true
             signingConfig = signingConfigs.getByName("debug")
         }
+        create("benchmark") {
+            initWith(buildTypes.getByName("release"))
+            matchingFallbacks += listOf("release")
+            isDebuggable = false
+        }
     }
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_17

androidApp/src/main/AndroidManifest.xml

@@ -7,13 +7,17 @@
         android:supportsRtl="true"
         android:theme="@style/AppTheme"
         tools:ignore="DataExtractionRules">
+        <profileable android:shell="true" />
+
         <activity
             android:name="com.bumble.livemosaic.MainActivity"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
+
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
     </application>
-</manifest> 
+
+</manifest>

benchmark/.gitignore

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

benchmark/build.gradle.kts

@@ -0,0 +1,53 @@
+@Suppress("DSL_SCOPE_VIOLATION") // TODO: Remove once KTIJ-19369 is fixed
+plugins {
+  id("com.android.test")
+  kotlin("android")
+}
+
+android {
+  namespace = "com.bumble.appyx.livemosaic.android.benchmark"
+  compileSdk = 34
+
+  compileOptions {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+  }
+
+  kotlinOptions {
+    jvmTarget = "1.8"
+  }
+
+  defaultConfig {
+    minSdk = 23
+    targetSdk = 34
+
+    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")
+    }
+  }
+
+  targetProjectPath = ":androidApp"
+  experimentalProperties["android.experimental.self-instrumenting"] = true
+}
+
+dependencies {
+  implementation(libs.androidx.test.ext.junit)
+  implementation(libs.espresso.core)
+  implementation(libs.uiautomator)
+  implementation(libs.benchmark.macro.junit4)
+}
+
+androidComponents {
+  beforeVariants(selector().all()) {
+    it.enable = it.buildType == "benchmark"
+  }
+}

benchmark/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest />

benchmark/src/main/java/com/bumble/appyx/livemosaic/android/benchmark/ExampleStartupBenchmark.kt

@@ -0,0 +1,39 @@
+package com.bumble.appyx.livemosaic.android.benchmark
+
+import androidx.benchmark.macro.CompilationMode
+import androidx.benchmark.macro.StartupMode
+import androidx.benchmark.macro.StartupTimingMetric
+import androidx.benchmark.macro.junit4.MacrobenchmarkRule
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+/**
+ * This is an example startup benchmark.
+ *
+ * It navigates to the device's home screen, and launches the default activity.
+ *
+ * Before running this benchmark:
+ * 1) switch your app's active build variant in the Studio (affects Studio runs only)
+ * 2) add `<profileable android:shell="true" />` to your app's manifest, within the `<application>` tag
+ *
+ * Run this benchmark from Studio to see startup measurements, and captured system traces
+ * for investigating your app's performance.
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleStartupBenchmark {
+  @get:Rule
+  val benchmarkRule = MacrobenchmarkRule()
+
+  @Test
+  fun startup() = benchmarkRule.measureRepeated(
+    packageName = "com.bumble.appyx.livemosaic.android",
+    metrics = listOf(StartupTimingMetric()),
+    iterations = 5,
+    startupMode = StartupMode.COLD
+  ) {
+    pressHome()
+    startActivityAndWait()
+  }
+}

gradle/libs.versions.toml

@@ -25,6 +25,10 @@ resources = "0.22.3"
 serialization-json = "1.5.0"
 ktor = "2.3.4"
 uuid = "9.0.0"
+androidxtestext = "1.1.5"
+espresso-core = "3.5.1"
+uiautomator = "2.2.0"
+benchmark-macro-junit4 = "1.2.0-beta01"
 
 [libraries]
 androidx-activity-compose = "androidx.activity:activity-compose:1.7.2"
@@ -92,6 +96,10 @@ detekt-compose-rules = "io.nlopez.compose.rules:detekt:0.3.0"
 toolargetool = "com.gu.android:toolargetool:0.3.0"
 
 symbol-processing-api = { module = "com.google.devtools.ksp:symbol-processing-api", version.ref = "ksp" }
+androidx-test-ext-junit = { group = "androidx.test.ext", name = "junit", version.ref = "androidxtestext" }
+espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espresso-core" }
+uiautomator = { group = "androidx.test.uiautomator", name = "uiautomator", version.ref = "uiautomator" }
+benchmark-macro-junit4 = { group = "androidx.benchmark", name = "benchmark-macro-junit4", version.ref = "benchmark-macro-junit4" }
 
 [plugins]
 detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }

settings.gradle.kts

@@ -8,6 +8,7 @@ pluginManagement {
     plugins {
         kotlin("multiplatform")
         id("org.jetbrains.compose")
+        id("com.android.test")
     }
 }
 
@@ -27,3 +28,4 @@ include(":androidApp")
 include(":desktopApp")
 include(":webApp")
 include(":shared")
+include(":benchmark")