Merge pull request #711 from square/sedwards/update-benchmarks-readme

Refactor Perf Poetry to add Related Benchmarks

Author: steve-the-edwards

benchmarks/README.md

@@ -1,16 +1,17 @@
-# benchmark
+# benchmarks
 
 This module contains benchmarks. Used to measure and help improve Workflow performance. These tests
 should be run on physical devices.
 
 ## dungeon-benchmark
 
-Currently this is the only benchmark included here. It is for the /samples/dungeon/app. This
-includes a macrobenchmark [test](benchmarks/dungeon-benchmark/src/main/java/com/squareup/sample/dungeon/benchmark/WorkflowBaselineProfiles.kt)
-that exercises this sample app (with UiAutomator) to collect a [baseline profile](https://developer.android.com/studio/profile/baselineprofiles).
-After running this the `profile.txt` file can be taken off of the device and used directly in the
-/src/main directory of the application. This will include the profile into the APK for guided
-optimization at install time.
+This is for the /samples/dungeon/app. This includes a macrobenchmark
+[test](dungeon-benchmark/src/main/java/com/squareup/sample/dungeon/benchmark/WorkflowBaselineProfiles.kt)
+that exercises this sample app (with UiAutomator) to collect
+a [baseline profile](https://developer.android.com/studio/profile/baselineprofiles). After running
+this the `profile.txt` file can be taken off of the device and used directly in the /src/main
+directory of the application. This will include the profile into the APK for guided optimization at
+install time.
 
 Better yet, the profile can be split up and added into each Workflow module's src directory so that
 it will be included with all APKs built using Workflow (including 3rd party). To do this a java
@@ -28,8 +29,23 @@ This will create an output file separated by module and then also by package as
 profile for each module can be added into its /src/main directory as `baseline-prof.txt`. Then on a
 release build this will be included with the resulting APK/binary.
 
-The other [test](benchmarks/dungeon-benchmark/src/main/java/com/squareup/sample/dungeon/benchmark/WorkflowBaselineBenchmark.kt)
+The other [test](dungeon-benchmark/src/main/java/com/squareup/sample/dungeon/benchmark/WorkflowBaselineBenchmark.kt)
 is used to verify the results of including the baseline profiles on the startup time. This runs the
 same scenario with and without forcing the use of the profiles. To force the use of profiles, the
 `libs.androidx.profileinstaller` dependency is included into the app under profile (dungeon in this
 case) for side-loading the profiles.
+
+## performance-poetry
+
+Module of code for performance testing related to poetry applications.
+
+### complex-poetry
+
+This application is a modification of the samples/containers/app-poetry app which uses also the
+common components in samples/containers/common and samples/containers/poetry. It modifies this
+application to pass the Workflow
+a [SimulatedPerfConfig](performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/poetry/SimulatedPerfConfig.kt).
+
+In this case we specify that the app should be more 'complex' which adds delays into each of the
+selections that are run by Worker's which then trigger a loading state that is handled by the
+[MaybeLoadingGatekeeperWorkflow](performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/poetry/MaybeLoadingGatekeeperWorkflow.kt).

benchmarks/performancepoetry/build.gradle.kts renamed to benchmarks/performance-poetry/complex-poetry/build.gradle.kts

@@ -8,7 +8,7 @@ apply(from = rootProject.file(".buildscript/android-ui-tests.gradle"))
 
 android {
   defaultConfig {
-    applicationId = "com.squareup.benchmarks.performance.poetry"
+    applicationId = "com.squareup.benchmarks.performance.complex.poetry"
   }
 }
 

benchmarks/performancepoetry/src/main/AndroidManifest.xml renamed to benchmarks/performance-poetry/complex-poetry/src/main/AndroidManifest.xml

@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     xmlns:tools="http://schemas.android.com/tools"
-    package="com.squareup.benchmarks.performance.poetry">
+    package="com.squareup.benchmarks.performance.complex.poetry">
 
   <application
       android:allowBackup="false"
       android:label="@string/app_name"
       android:theme="@style/AppTheme"
       tools:ignore="AllowBackup,GoogleAppIndexingWarning,MissingApplicationIcon">
     <activity
-        android:name=".PerformancePoetryActivity"
+        android:name="com.squareup.benchmarks.performance.complex.poetry.PerformancePoetryActivity"
         android:exported="true">
       <intent-filter>
         <action android:name="android.intent.action.MAIN" />

benchmarks/performancepoetry/src/main/java/com/squareup/benchmarks/performance/poetry/MaybeLoadingGatekeeperWorkflow.kt renamed to benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/MaybeLoadingGatekeeperWorkflow.kt

@@ -1,7 +1,7 @@
-package com.squareup.benchmarks.performance.poetry
+package com.squareup.benchmarks.performance.complex.poetry
 
-import com.squareup.benchmarks.performance.poetry.views.LoaderSpinner
-import com.squareup.benchmarks.performance.poetry.views.MayBeLoadingScreen
+import com.squareup.benchmarks.performance.complex.poetry.views.LoaderSpinner
+import com.squareup.benchmarks.performance.complex.poetry.views.MayBeLoadingScreen
 import com.squareup.sample.container.overviewdetail.OverviewDetailScreen
 import com.squareup.workflow1.Snapshot
 import com.squareup.workflow1.StatefulWorkflow

benchmarks/performancepoetry/src/main/java/com/squareup/benchmarks/performance/poetry/PerformancePoemWorkflow.kt renamed to benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/PerformancePoemWorkflow.kt

@@ -1,14 +1,14 @@
-package com.squareup.benchmarks.performance.poetry
-
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.Action.ClearSelection
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.Action.HandleStanzaListOutput
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.Action.SelectNext
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.Action.SelectPrevious
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.State
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.State.ComplexCall
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.State.Initializing
-import com.squareup.benchmarks.performance.poetry.PerformancePoemWorkflow.State.Selected
-import com.squareup.benchmarks.performance.poetry.views.BlankScreen
+package com.squareup.benchmarks.performance.complex.poetry
+
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.Action.ClearSelection
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.Action.HandleStanzaListOutput
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.Action.SelectNext
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.Action.SelectPrevious
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.State
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.State.ComplexCall
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.State.Initializing
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow.State.Selected
+import com.squareup.benchmarks.performance.complex.poetry.views.BlankScreen
 import com.squareup.sample.container.overviewdetail.OverviewDetailScreen
 import com.squareup.sample.poetry.PoemWorkflow
 import com.squareup.sample.poetry.PoemWorkflow.ClosePoem

benchmarks/performancepoetry/src/main/java/com/squareup/benchmarks/performance/poetry/PerformancePoemsBrowserWorkflow.kt renamed to benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/PerformancePoemsBrowserWorkflow.kt

@@ -1,11 +1,11 @@
-package com.squareup.benchmarks.performance.poetry
+package com.squareup.benchmarks.performance.complex.poetry
 
-import com.squareup.benchmarks.performance.poetry.PerformancePoemsBrowserWorkflow.State
-import com.squareup.benchmarks.performance.poetry.PerformancePoemsBrowserWorkflow.State.ComplexCall
-import com.squareup.benchmarks.performance.poetry.PerformancePoemsBrowserWorkflow.State.Initializing
-import com.squareup.benchmarks.performance.poetry.PerformancePoemsBrowserWorkflow.State.NoSelection
-import com.squareup.benchmarks.performance.poetry.PerformancePoemsBrowserWorkflow.State.Selected
-import com.squareup.benchmarks.performance.poetry.views.BlankScreen
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowserWorkflow.State
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowserWorkflow.State.ComplexCall
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowserWorkflow.State.Initializing
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowserWorkflow.State.NoSelection
+import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowserWorkflow.State.Selected
+import com.squareup.benchmarks.performance.complex.poetry.views.BlankScreen
 import com.squareup.sample.container.overviewdetail.OverviewDetailScreen
 import com.squareup.sample.poetry.PoemListRendering.Companion.NO_POEM_SELECTED
 import com.squareup.sample.poetry.PoemListWorkflow

benchmarks/performancepoetry/src/main/java/com/squareup/benchmarks/performance/poetry/PerformancePoetryActivity.kt renamed to benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/PerformancePoetryActivity.kt

@@ -1,4 +1,4 @@
-package com.squareup.benchmarks.performance.poetry
+package com.squareup.benchmarks.performance.complex.poetry
 
 import android.os.Bundle
 import androidx.activity.viewModels
@@ -8,7 +8,7 @@ import androidx.lifecycle.SavedStateHandle
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import androidx.savedstate.SavedStateRegistryOwner
-import com.squareup.benchmarks.performance.poetry.views.LoaderContainer
+import com.squareup.benchmarks.performance.complex.poetry.views.LoaderContainer
 import com.squareup.sample.container.SampleContainers
 import com.squareup.sample.poetry.model.Poem
 import com.squareup.workflow1.ui.WorkflowLayout

benchmarks/performancepoetry/src/main/java/com/squareup/benchmarks/performance/poetry/PerformancePoetryComponent.kt renamed to benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/PerformancePoetryComponent.kt

@@ -1,4 +1,4 @@
-package com.squareup.benchmarks.performance.poetry
+package com.squareup.benchmarks.performance.complex.poetry
 
 import androidx.appcompat.app.AppCompatActivity
 import androidx.lifecycle.ViewModel

benchmarks/performancepoetry/src/main/java/com/squareup/benchmarks/performance/poetry/SimulatedPerfConfig.kt renamed to benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/SimulatedPerfConfig.kt

@@ -1,4 +1,4 @@
-package com.squareup.benchmarks.performance.poetry
+package com.squareup.benchmarks.performance.complex.poetry
 
 /**
  * We use this to 'simulate' different performance scenarios that we have seen that we want to

benchmarks/performancepoetry/src/main/java/com/squareup/benchmarks/performance/poetry/views/BlankScreen.kt renamed to benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/views/BlankScreen.kt

@@ -1,4 +1,4 @@
-package com.squareup.benchmarks.performance.poetry.views
+package com.squareup.benchmarks.performance.complex.poetry.views
 
 import android.content.Context
 import android.view.ViewGroup