Support baseline profile generation for coil-base. (#1572)

* Create setupTestModule for the benchmarking module.

* Move Proguard files.

* Clean up.

* Update package.

* Fix compilation.

* Pass project name through.

* Update filtering.

* Suppress.

* Clean up scripts.

* Update publish script.

* Use pixel 6.

assemble_baseline_profile.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+./gradlew :coil-benchmark:pixel6Api31BenchmarkAndroidTest -P android.testInstrumentationRunnerArguments.class=coil.benchmark.BaselineProfileGenerator#generate -Dproject=view
+mv coil-benchmark/build/outputs/managed_device_android_test_additional_output/pixel6Api31/BaselineProfileGenerator_generate-baseline-prof.txt coil-base/src/main/baseline-prof.txt
+./gradlew :coil-benchmark:pixel6Api31BenchmarkAndroidTest -P android.testInstrumentationRunnerArguments.class=coil.benchmark.BaselineProfileGenerator#generate -Dproject=compose
+mv coil-benchmark/build/outputs/managed_device_android_test_additional_output/pixel6Api31/BaselineProfileGenerator_generate-baseline-prof.txt coil-compose-base/src/main/baseline-prof.txt

buildSrc/src/main/kotlin/Projects.kt

@@ -4,6 +4,7 @@ import com.android.build.api.dsl.CommonExtension
 import com.android.build.api.dsl.Lint
 import com.android.build.gradle.BaseExtension
 import com.android.build.gradle.LibraryExtension
+import com.android.build.gradle.TestExtension
 import com.android.build.gradle.internal.dsl.BaseAppModuleExtension
 import org.gradle.api.JavaVersion
 import org.gradle.api.Project
@@ -21,7 +22,7 @@ fun Project.setupLibraryModule(
     buildConfig: Boolean = false,
     publish: Boolean = false,
     document: Boolean = publish,
-    block: LibraryExtension.() -> Unit = {}
+    block: LibraryExtension.() -> Unit = {},
 ) = setupBaseModule<LibraryExtension>(name) {
     libraryVariants.all {
         generateBuildConfigProvider?.configure { enabled = buildConfig }
@@ -54,6 +55,7 @@ fun Project.setupAppModule(
     block: BaseAppModuleExtension.() -> Unit = {}
 ) = setupBaseModule<BaseAppModuleExtension>(name) {
     defaultConfig {
+        applicationId = name
         versionCode = project.versionCode
         versionName = project.versionName
         resourceConfigurations += "en"
@@ -62,9 +64,20 @@ fun Project.setupAppModule(
     block()
 }
 
+fun Project.setupTestModule(
+    name: String?,
+    block: TestExtension.() -> Unit = {},
+) = setupBaseModule<TestExtension>(name) {
+    defaultConfig {
+        resourceConfigurations += "en"
+        vectorDrawables.useSupportLibrary = true
+    }
+    block()
+}
+
 private inline fun <reified T : BaseExtension> Project.setupBaseModule(
     name: String?,
-    crossinline block: T.() -> Unit = {}
+    crossinline block: T.() -> Unit = {},
 ) = extensions.configure<T>("android") {
     namespace = name
     compileSdkVersion(project.compileSdk)
@@ -91,7 +104,7 @@ private inline fun <reified T : BaseExtension> Project.setupBaseModule(
             "-Xno-param-assertions",
             "-Xno-receiver-assertions",
         )
-        if (project.name != "coil-test") {
+        if (project.name != "coil-benchmark" && project.name != "coil-test") {
             arguments += "-opt-in=coil.annotation.ExperimentalCoilApi"
         }
         // https://youtrack.jetbrains.com/issue/KT-41985

coil-benchmark/build.gradle.kts

@@ -0,0 +1,48 @@
+import coil.setupTestModule
+import com.android.build.api.dsl.ManagedVirtualDevice
+
+plugins {
+    id("com.android.test")
+    id("kotlin-android")
+}
+
+setupTestModule(name = "coil.benchmark") {
+    val targetProject = System.getProperty("project", "view")
+    defaultConfig {
+        minSdk = 23
+        buildConfigField("String", "PROJECT", "\"$targetProject\"")
+    }
+    buildTypes {
+        create("benchmark") {
+            isDebuggable = true
+            signingConfig = getByName("debug").signingConfig
+            matchingFallbacks += listOf("release")
+        }
+    }
+    testOptions {
+        managedDevices {
+            devices {
+                create<ManagedVirtualDevice>("pixel6Api31") {
+                    device = "Pixel 6"
+                    apiLevel = 31
+                    systemImageSource = "aosp"
+                }
+            }
+        }
+    }
+    targetProjectPath = ":coil-sample-$targetProject"
+    experimentalProperties["android.experimental.self-instrumenting"] = true
+}
+
+dependencies {
+    implementation(libs.androidx.benchmark.macro)
+    implementation(libs.androidx.test.espresso)
+    implementation(libs.androidx.test.junit)
+    implementation(libs.androidx.test.uiautomator)
+}
+
+androidComponents {
+    beforeVariants(selector().all()) {
+        it.enable = it.buildType == "benchmark"
+    }
+}

coil-compose-benchmark/src/main/AndroidManifest.xml → coil-benchmark/src/main/AndroidManifest.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
-
     <queries>
-        <package android:name="sample.compose" />
+        <package android:name="sample.compose"/>
+        <package android:name="sample.view"/>
     </queries>
 </manifest>

coil-compose-benchmark/src/main/java/coil/compose/benchmark/BaselineProfileBenchmark.kt → coil-benchmark/src/main/java/coil/benchmark/BaselineProfileBenchmark.kt

@@ -1,17 +1,19 @@
-package coil.compose.benchmark
+package coil.benchmark
 
 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.ext.junit.runners.AndroidJUnit4
+import coil.benchmark.BuildConfig.PROJECT
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 class BaselineProfileBenchmark {
+
     @get:Rule
     val benchmarkRule = MacrobenchmarkRule()
 
@@ -22,17 +24,12 @@ class BaselineProfileBenchmark {
 
     @Test
     fun startupPartialCompilation() {
-        startup(CompilationMode.Partial(
-            baselineProfileMode = BaselineProfileMode.Disable,
-            warmupIterations = 3
-        ))
+        startup(CompilationMode.Partial(BaselineProfileMode.Disable, warmupIterations = 3))
     }
 
     @Test
     fun startupBaselineProfile() {
-        startup(CompilationMode.Partial(
-            baselineProfileMode = BaselineProfileMode.Require
-        ))
+        startup(CompilationMode.Partial(BaselineProfileMode.Require))
     }
 
     @Test
@@ -42,16 +39,13 @@ class BaselineProfileBenchmark {
 
     private fun startup(compilationMode: CompilationMode) {
         benchmarkRule.measureRepeated(
-            packageName = "sample.compose",
+            packageName = "sample.$PROJECT",
             metrics = listOf(StartupTimingMetric()),
             iterations = 10,
             startupMode = StartupMode.COLD,
             compilationMode = compilationMode,
-            setupBlock = {
-                pressHome()
-            }
-        ) {
-            startActivityAndWait()
-        }
+            setupBlock = { pressHome() },
+            measureBlock = { startActivityAndWait() },
+        )
     }
 }

coil-benchmark/src/main/java/coil/benchmark/BaselineProfileGenerator.kt

@@ -0,0 +1,45 @@
+package coil.benchmark
+
+import androidx.benchmark.macro.junit4.BaselineProfileRule
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
+import androidx.test.uiautomator.By
+import androidx.test.uiautomator.Direction
+import androidx.test.uiautomator.UiDevice
+import coil.benchmark.BuildConfig.PROJECT
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4::class)
+@Suppress("KotlinConstantConditions") // BuildConfig constant can change.
+class BaselineProfileGenerator {
+
+    @get:Rule
+    val baselineProfileRule = BaselineProfileRule()
+
+    @Test
+    fun generate() = baselineProfileRule.collectBaselineProfile(
+        packageName = "sample.$PROJECT",
+        filterPredicate = newFilterPredicate(),
+    ) {
+        pressHome()
+        startActivityAndWait()
+        UiDevice.getInstance(getInstrumentation())
+            .findObject(
+                if (PROJECT == "compose") {
+                    By.res("list")
+                } else {
+                    By.res(packageName, "list")
+                },
+            )
+            .fling(Direction.DOWN, 3000)
+        device.waitForIdle()
+    }
+
+    private fun newFilterPredicate(): (String) -> Boolean {
+        // Only include Compose-specific rules in the coil-compose module.
+        val packageName = if (PROJECT == "compose") "coil/compose/" else "coil/"
+        return { line -> packageName in line && "sample/" !in line }
+    }
+}

coil-sample-compose/build.gradle.kts

@@ -6,22 +6,22 @@ plugins {
 }
 
 setupAppModule(name = "sample.compose") {
-    defaultConfig {
-        applicationId = "sample.compose"
-    }
     buildTypes {
         release {
             isMinifyEnabled = true
             isShrinkResources = true
-            proguardFiles("shrinker-rules.pro", "shrinker-rules-android.pro")
+            proguardFiles(
+                "../coil-sample-common/shrinker-rules.pro",
+                "../coil-sample-common/shrinker-rules-android.pro",
+            )
             signingConfig = signingConfigs["debug"]
         }
-
         create("benchmark") {
-            signingConfig = signingConfigs.getByName("debug")
-            matchingFallbacks += listOf("release")
             isDebuggable = false
-            proguardFiles("baseline-profile-rules.pro")
+            isMinifyEnabled = false
+            isShrinkResources = false
+            matchingFallbacks += listOf("release")
+            signingConfig = signingConfigs.getByName("debug")
         }
     }
     buildFeatures {

coil-sample-compose/src/main/java/sample/compose/MainActivity.kt

@@ -172,9 +172,9 @@ private fun ListScreen(
     val numColumns = remember(context) { numberOfColumns(context) }
 
     LazyVerticalStaggeredGrid(
-        modifier = Modifier.testTag("scrollableContent"),
         columns = StaggeredGridCells.Fixed(numColumns),
         state = gridState,
+        modifier = Modifier.testTag("list"),
     ) {
         items(images) { image ->
             // Scale the image to fit the width of a column.