Setup Baseline Profile (#8135)

* Setup Baseline Profile

Adds Baseline Profile generator and startup time test.
Readme included in macrobenchmark module to run the generator.

* changes

app/build.gradle.kts

@@ -75,10 +75,20 @@ android {
             applicationIdSuffix = debugType.applicationIdSuffix
             matchingFallbacks.add("release")
         }
+        create("benchmark") {
+            initWith(getByName("release"))
+
+            signingConfig = signingConfigs.getByName("debug")
+            matchingFallbacks.add("release")
+            isDebuggable = false
+            versionNameSuffix = "-benchmark"
+            applicationIdSuffix = ".benchmark"
+        }
     }
 
     sourceSets {
         getByName("preview").res.srcDirs("src/debug/res")
+        getByName("benchmark").res.srcDirs("src/debug/res")
     }
 
     flavorDimensions.add("default")
@@ -193,6 +203,7 @@ dependencies {
     implementation(androidx.recyclerview)
     implementation(androidx.viewpager)
     implementation(androidx.glance)
+    implementation(androidx.profileinstaller)
 
     implementation(androidx.bundles.lifecycle)
 
@@ -282,6 +293,15 @@ dependencies {
     implementation(libs.leakcanary.plumber)
 }
 
+androidComponents {
+    beforeVariants { variantBuilder ->
+        // Disables standardBenchmark
+        if (variantBuilder.buildType == "benchmark") {
+            variantBuilder.enable = variantBuilder.productFlavors.containsAll(listOf("default" to "dev"))
+        }
+    }
+}
+
 tasks {
     withType<Test> {
         useJUnitPlatform()

app/src/main/AndroidManifest.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
 
     <!-- Internet -->
     <uses-permission android:name="android.permission.INTERNET" />
@@ -37,6 +38,11 @@
         android:supportsRtl="true"
         android:networkSecurityConfig="@xml/network_security_config">
 
+        <!-- enable profiling by macrobenchmark -->
+        <profileable
+            android:shell="true"
+            tools:targetApi="q" />
+
         <activity
             android:name=".ui.main.MainActivity"
             android:launchMode="singleTop"

build.gradle.kts

@@ -11,6 +11,7 @@ buildscript {
 plugins {
     alias(androidx.plugins.application) apply false
     alias(androidx.plugins.library) apply false
+    alias(androidx.plugins.test) apply false
     alias(kotlinx.plugins.android) apply false
     alias(libs.plugins.kotlinter)
     alias(libs.plugins.versionsx)

gradle/androidx.versions.toml

@@ -1,6 +1,9 @@
 [versions]
 agp_version = "7.3.0"
 lifecycle_version = "2.5.1"
+espresso = "3.4.0"
+macrobenchmark = "1.1.0"
+test = "1.1.3"
 
 [libraries]
 annotation = "androidx.annotation:annotation:1.5.0"
@@ -13,6 +16,7 @@ splashscreen = "androidx.core:core-splashscreen:1.0.0-alpha02"
 recyclerview = "androidx.recyclerview:recyclerview:1.3.0-rc01"
 viewpager = "androidx.viewpager:viewpager:1.1.0-alpha01"
 glance = "androidx.glance:glance-appwidget:1.0.0-alpha03"
+profileinstaller = "androidx.profileinstaller:profileinstaller:1.2.0"
 
 lifecycle-common = { module = "androidx.lifecycle:lifecycle-common", version.ref = "lifecycle_version" }
 lifecycle-process = { module = "androidx.lifecycle:lifecycle-process", version.ref = "lifecycle_version" }
@@ -26,6 +30,11 @@ paging-compose = "androidx.paging:paging-compose:1.0.0-alpha16"
 
 sqlite = "androidx.sqlite:sqlite-framework:2.2.0"
 
+benchmark-macro = { group = "androidx.benchmark", name = "benchmark-macro-junit4", version.ref = "macrobenchmark" }
+test-ext = { group = "androidx.test.ext", name = "junit-ktx", version.ref = "test" }
+test-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espresso" }
+test-uiautomator = { group = "androidx.test.uiautomator", name = "uiautomator", version.ref = "test" }
+
 [bundles]
 lifecycle = ["lifecycle-common", "lifecycle-process", "lifecycle-runtimektx"]
 workmanager = ["work-runtime", "guava"]
@@ -33,3 +42,4 @@ workmanager = ["work-runtime", "guava"]
 [plugins]
 application = { id = "com.android.application", version.ref = "agp_version" }
 library = { id = "com.android.library", version.ref = "agp_version" }
+test = { id = "com.android.test", version.ref = "agp_version"}

macrobenchmark/.gitignore

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

macrobenchmark/README.md

@@ -0,0 +1,11 @@
+# Baseline profiles
+
+The baseline profile for this app is located at [`app/src/main/baseline-prof.txt`](../app/src/main/baseline-prof.txt).
+It contains rules that enable AOT compilation of the critical user path taken during app launch.
+For more information on baseline profiles, read [this document](https://developer.android.com/studio/profile/baselineprofiles).
+
+> Note: The baseline profile needs to be re-generated for release builds that touch code which changes app startup.
+
+To generate the baseline profile, select the `devBenchmark` build variant and run the
+`BaselineProfileGenerator` benchmark test on an AOSP Android Emulator.
+Then copy the resulting baseline profile from the emulator to [`app/src/main/baseline-prof.txt`](../app/src/main/baseline-prof.txt).

macrobenchmark/build.gradle.kts

@@ -0,0 +1,52 @@
+plugins {
+    id("com.android.test")
+    kotlin("android")
+}
+
+android {
+    namespace = "tachiyomi.macrobenchmark"
+    compileSdk = AndroidConfig.compileSdk
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_1_8.toString()
+    }
+
+    defaultConfig {
+        minSdk = AndroidConfig.minSdk
+        targetSdk = AndroidConfig.targetSdk
+
+        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 = ":app"
+    experimentalProperties["android.experimental.self-instrumenting"] = true
+}
+
+dependencies {
+    implementation(androidx.test.ext)
+    implementation(androidx.test.espresso.core)
+    implementation(androidx.test.uiautomator)
+    implementation(androidx.benchmark.macro)
+}
+
+androidComponents {
+    beforeVariants(selector().all()) {
+        it.enable = it.buildType == "benchmark"
+    }
+}

macrobenchmark/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" />

macrobenchmark/src/main/java/tachiyomi/macrobenchmark/BaselineProfileGenerator.kt

@@ -0,0 +1,24 @@
+package tachiyomi.macrobenchmark
+
+import androidx.benchmark.macro.ExperimentalBaselineProfilesApi
+import androidx.benchmark.macro.junit4.BaselineProfileRule
+import org.junit.Rule
+import org.junit.Test
+
+@OptIn(ExperimentalBaselineProfilesApi::class)
+class BaselineProfileGenerator {
+    @get:Rule
+    val baselineProfileRule = BaselineProfileRule()
+
+    @Test
+    fun generate() = baselineProfileRule.collectBaselineProfile(
+        packageName = "eu.kanade.tachiyomi.benchmark",
+        profileBlock = {
+            pressHome()
+            startActivityAndWait()
+
+            // TODO: Navigate to browse-extensions screen when storage permission
+            // in sources screen moved. Possibly open manga details screen too?
+        }
+    )
+}

macrobenchmark/src/main/java/tachiyomi/macrobenchmark/StartupBenchmark.kt

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2022 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package tachiyomi.macrobenchmark
+
+import androidx.benchmark.macro.BaselineProfileMode
+import androidx.benchmark.macro.CompilationMode
+import androidx.benchmark.macro.StartupMode
+import androidx.benchmark.macro.StartupTimingMetric
+import androidx.benchmark.macro.junit4.MacrobenchmarkRule
+import androidx.test.internal.runner.junit4.AndroidJUnit4ClassRunner
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+/**
+ * Run this benchmark from Studio to see startup measurements, and captured system traces
+ * for investigating your app's performance from a cold state.
+ */
+@RunWith(AndroidJUnit4ClassRunner::class)
+class ColdStartupBenchmark : AbstractStartupBenchmark(StartupMode.COLD)
+
+/**
+ * Run this benchmark from Studio to see startup measurements, and captured system traces
+ * for investigating your app's performance from a warm state.
+ */
+@RunWith(AndroidJUnit4ClassRunner::class)
+class WarmStartupBenchmark : AbstractStartupBenchmark(StartupMode.WARM)
+
+/**
+ * Run this benchmark from Studio to see startup measurements, and captured system traces
+ * for investigating your app's performance from a hot state.
+ */
+@RunWith(AndroidJUnit4ClassRunner::class)
+class HotStartupBenchmark : AbstractStartupBenchmark(StartupMode.HOT)
+
+/**
+ * Base class for benchmarks with different startup modes.
+ * Enables app startups from various states of baseline profile or [CompilationMode]s.
+ */
+abstract class AbstractStartupBenchmark(private val startupMode: StartupMode) {
+    @get:Rule
+    val benchmarkRule = MacrobenchmarkRule()
+
+    @Test
+    fun startupNoCompilation() = startup(CompilationMode.None())
+
+    @Test
+    fun startupBaselineProfileDisabled() = startup(
+        CompilationMode.Partial(baselineProfileMode = BaselineProfileMode.Disable, warmupIterations = 1)
+    )
+
+    @Test
+    fun startupBaselineProfile() = startup(CompilationMode.Partial(baselineProfileMode = BaselineProfileMode.Require))
+
+    @Test
+    fun startupFullCompilation() = startup(CompilationMode.Full())
+
+    private fun startup(compilationMode: CompilationMode) = benchmarkRule.measureRepeated(
+        packageName = "eu.kanade.tachiyomi.benchmark",
+        metrics = listOf(StartupTimingMetric()),
+        compilationMode = compilationMode,
+        iterations = 10,
+        startupMode = startupMode,
+        setupBlock = {
+            pressHome()
+        }
+    ) {
+        startActivityAndWait()
+    }
+}

settings.gradle.kts

@@ -39,3 +39,4 @@ include(":app")
 include(":i18n")
 include(":source-api")
 include(":core")
+include(":macrobenchmark")