Merge pull request #77 from skydoves/improve/baseline-profile

Improve generating baseline profiles scenario

Author: skydoves

app/src/main/baseline-prof.txt

@@ -30,6 +30,7 @@
   </data>
 
   <androidx.core.widget.NestedScrollView
+    android:id="@+id/nestedScroll"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     android:background="@color/background">

app/src/main/res/layout/activity_detail.xml

@@ -16,29 +16,65 @@
 
 package com.github.skydoves.benchmark
 
-import androidx.benchmark.macro.ExperimentalBaselineProfilesApi
+import androidx.benchmark.macro.ExperimentalStableBaselineProfilesApi
 import androidx.benchmark.macro.junit4.BaselineProfileRule
+import androidx.test.uiautomator.By
+import androidx.test.uiautomator.BySelector
+import androidx.test.uiautomator.Direction
+import androidx.test.uiautomator.UiDevice
+import androidx.test.uiautomator.UiObject2
+import androidx.test.uiautomator.Until
 import org.junit.Rule
 import org.junit.Test
 
 /**
  * Generates a baseline profile which can be copied to `app/src/main/baseline-prof.txt`.
  */
-@ExperimentalBaselineProfilesApi
 class BaselineProfileGenerator {
   @get:Rule
   val baselineProfileRule = BaselineProfileRule()
 
   @Test
+  @OptIn(ExperimentalStableBaselineProfilesApi::class)
   fun startup() =
-    baselineProfileRule.collectBaselineProfile(
-      packageName = "com.skydoves.pokedex"
+    baselineProfileRule.collectStableBaselineProfile(
+      packageName = packageName,
+      stableIterations = 2,
+      maxIterations = 8
     ) {
       pressHome()
       // This block defines the app's critical user journey. Here we are interested in
       // optimizing for app startup. But you can also navigate and scroll
       // through your most important UI.
       startActivityAndWait()
       device.waitForIdle()
+
+      // Navigate to the details screen
+      device.testDiscover() || return@collectStableBaselineProfile
+      device.navigateFromMainToDetails()
+      device.pressBack()
     }
 }
+
+private fun UiDevice.testDiscover(): Boolean {
+  // UI automator library has an issue about scrolling down.
+  //  waitForObject(By.res(packageName, "recyclerView")).scroll(Direction.DOWN, 1f).
+  return wait(Until.hasObject(By.res(packageName, "transformationLayout")), 1_000)
+}
+
+private fun UiDevice.navigateFromMainToDetails() {
+  // Open a show from one of the carousels
+  waitForObject(By.res(packageName, "transformationLayout")).click()
+  wait(Until.hasObject(By.res(packageName, "nestedScroll")), 1_000)
+  waitForObject(By.res(packageName, "nestedScroll")).scroll(Direction.DOWN, 1f)
+  waitForIdle()
+  pressBack()
+}
+
+private fun UiDevice.waitForObject(selector: BySelector, timeout: Long = 5_000): UiObject2 {
+  if (wait(Until.hasObject(selector), timeout)) {
+    return findObject(selector)
+  }
+
+  error("Object with selector [$selector] not found")
+}

benchmark/src/main/kotlin/com/github/skydoves/benchmark/BaselineProfileGenerator.kt

@@ -0,0 +1,19 @@
+/*
+ * Designed and developed by 2022 skydoves (Jaewoong Eum)
+ *
+ * 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
+ *
+ * http://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 com.github.skydoves.benchmark
+
+internal const val packageName: String = "com.skydoves.pokedex"

benchmark/src/main/kotlin/com/github/skydoves/benchmark/Constant.kt

@@ -71,7 +71,7 @@ abstract class AbstractStartupBenchmark(private val startupMode: StartupMode) {
   fun startupFullCompilation() = startup(CompilationMode.Full())
 
   private fun startup(compilationMode: CompilationMode) = benchmarkRule.measureRepeated(
-    packageName = "com.skydoves.pokedex",
+    packageName = packageName,
     metrics = listOf(StartupTimingMetric()),
     compilationMode = compilationMode,
     iterations = 5,

benchmark/src/main/kotlin/com/github/skydoves/benchmark/StartupBenchmark.kt

@@ -30,8 +30,8 @@ progressView = "1.1.3"
 rainbow = "1.0.3"
 timber = "5.0.1"
 baselineProfiles = "1.3.0"
-macroBenchmark = "1.1.0"
-uiAutomator = "2.2.0"
+macroBenchmark = "1.2.0-alpha12"
+uiAutomator = "2.3.0-alpha02"
 truth = "1.0.1"
 junit = "4.13.1"
 turbine = "0.6.0"