Merge pull request #795 from square/sedwards/empty-channel

Optimize Action Handling by handling all possible actions within a reasonable frame rate.

Author: steve-the-edwards

.github/workflows/kotlin.yml

@@ -92,10 +92,42 @@ jobs :
         with :
           report_paths : '**/build/test-results/test/TEST-*.xml'
 
+  jvm-timeout-runtime-test:
+    name: Frame Timeout Runtime JVM Tests
+    runs-on : ubuntu-latest
+    timeout-minutes : 20
+    steps :
+      - uses : actions/checkout@v3
+      - uses : gradle/wrapper-validation-action@v1
+      - name : set up JDK 11
+        uses : actions/setup-java@v3
+        with :
+          distribution: 'zulu'
+          java-version : 11
+
+      ## Actual task
+      - uses : burrunan/gradle-cache-action@v1
+        name : Check with Gradle
+        with :
+          gradle-dependencies-cache-key : |
+            gradle/libs.versions.toml
+          arguments : |
+            jvmTest --no-daemon --stacktrace --continue -Pworkflow.runtime=timeout
+          concurrent : true
+          gradle-build-scan-report : false
+          gradle-distribution-sha-256-sum-warning : false
+
+      # Report as Github Pull Request Check.
+      - name : Publish Test Report
+        uses : mikepenz/action-junit-report@v3
+        if : always() # always run even if the previous step fails
+        with :
+          report_paths : '**/build/test-results/test/TEST-*.xml'
+
   ios-tests :
     name : iOS Tests
     runs-on : macos-latest
-    timeout-minutes : 20
+    timeout-minutes : 30
     steps :
       - uses : actions/checkout@v3
       - uses : gradle/wrapper-validation-action@v1
@@ -136,6 +168,56 @@ jobs :
         with :
           report_paths : '**/build/test-results/test/TEST-*.xml'
 
+  performance-tests :
+    name : Performance tests
+    runs-on : macos-latest
+    timeout-minutes : 30
+    strategy :
+      # Allow tests to continue on other devices if they fail on one device.
+      fail-fast : false
+      matrix :
+        api-level :
+          - 29
+      # Unclear that older versions actually honor command to disable animation.
+      # Newer versions are reputed to be too slow: https://github.com/ReactiveCircus/android-emulator-runner/issues/222
+    steps :
+      - uses : actions/checkout@v3
+      - name : set up JDK 11
+        uses : actions/setup-java@v3
+        with :
+          distribution : 'zulu'
+          java-version : 11
+
+      ## Build before running tests, using cache.
+      - uses : burrunan/gradle-cache-action@v1
+        name : Build instrumented tests
+        with :
+          gradle-dependencies-cache-key : |
+            gradle/libs.versions.toml
+          arguments : |
+            :benchmarks:performance-poetry:complex-poetry:assembleDebugAndroidTest --no-daemon --stacktrace
+          concurrent : true
+          gradle-build-scan-report : false
+          gradle-distribution-sha-256-sum-warning : false
+
+      ## Actual task
+      - name : Render Pass Counting Test
+        uses : reactivecircus/android-emulator-runner@v2
+        with :
+          # @ychescale9 suspects Galaxy Nexus is the fastest one
+          profile : Galaxy Nexus
+          api-level : ${{ matrix.api-level }}
+          arch : x86_64
+          # Skip the benchmarks as this is running on emulators
+          script : ./gradlew :benchmarks:performance-poetry:complex-poetry:connectedCheck --no-daemon --stacktrace --continue
+
+      - name : Upload results
+        if : ${{ always() }}
+        uses : actions/upload-artifact@v3
+        with :
+          name : instrumentation-test-results-${{ matrix.api-level }}
+          path : ./**/build/reports/androidTests/connected/**
+
   instrumentation-tests :
     name : Instrumentation tests
     runs-on : macos-latest
@@ -177,7 +259,59 @@ jobs :
           api-level : ${{ matrix.api-level }}
           arch : x86_64
           # Skip the benchmarks as this is running on emulators
-          script : ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck --no-daemon --stacktrace
+          script : ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck --no-daemon --stacktrace
+
+      - name : Upload results
+        if : ${{ always() }}
+        uses : actions/upload-artifact@v3
+        with :
+          name : instrumentation-test-results-${{ matrix.api-level }}
+          path : ./**/build/reports/androidTests/connected/**
+
+  frame-timeout-instrumentation-tests :
+    name : Frame Timeout Instrumentation tests
+    runs-on : macos-latest
+    timeout-minutes : 45
+    strategy :
+      # Allow tests to continue on other devices if they fail on one device.
+      fail-fast : false
+      matrix :
+        api-level :
+          - 29
+      # Unclear that older versions actually honor command to disable animation.
+      # Newer versions are reputed to be too slow: https://github.com/ReactiveCircus/android-emulator-runner/issues/222
+    steps :
+      - uses : actions/checkout@v3
+      - name : set up JDK 11
+        uses : actions/setup-java@v3
+        with :
+          distribution : 'zulu'
+          java-version : 11
+
+      ## Build before running tests, using cache.
+      - uses : burrunan/gradle-cache-action@v1
+        name : Build instrumented tests
+        with :
+          gradle-dependencies-cache-key : |
+            gradle/libs.versions.toml
+          # Unfortunately I don't think we can key this cache based on our project property so
+          # we clean and rebuild.
+          arguments : |
+            clean assembleDebugAndroidTest --no-daemon --stacktrace -Pworkflow.runtime=timeout
+          concurrent : true
+          gradle-build-scan-report : false
+          gradle-distribution-sha-256-sum-warning : false
+
+      ## Actual task
+      - name : Instrumentation Tests
+        uses : reactivecircus/android-emulator-runner@v2
+        with :
+          # @ychescale9 suspects Galaxy Nexus is the fastest one
+          profile : Galaxy Nexus
+          api-level : ${{ matrix.api-level }}
+          arch : x86_64
+          # Skip the benchmarks as this is running on emulators
+          script : ./gradlew connectedCheck -x :benchmarks:dungeon-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-benchmark:connectedCheck -x :benchmarks:performance-poetry:complex-poetry:connectedCheck --no-daemon --stacktrace -Pworkflow.runtime=timeout
 
       - name : Upload results
         if : ${{ always() }}

artifacts.json

@@ -55,6 +55,22 @@
     "packaging": "jar",
     "javaVersion": "1.8"
   },
+  {
+    "gradlePath": ":workflow-config:config-android",
+    "group": "com.squareup.workflow1",
+    "artifactId": "workflow-config-android",
+    "description": "Workflow Runtime Android Configuration",
+    "packaging": "aar",
+    "javaVersion": "1.8"
+  },
+  {
+    "gradlePath": ":workflow-config:config-jvm",
+    "group": "com.squareup.workflow1",
+    "artifactId": "workflow-config-jvm",
+    "description": "Workflow Runtime JVM Configuration",
+    "packaging": "jar",
+    "javaVersion": "1.8"
+  },
   {
     "gradlePath": ":workflow-ui:compose",
     "group": "com.squareup.workflow1",

benchmarks/performance-poetry/complex-benchmark/src/main/java/com/squareup/benchmarks/performance/complex/poetry/benchmark/ComplexPoetryBenchmarks.kt

@@ -31,6 +31,8 @@ import org.junit.runner.RunWith
  * The above can be run as tests using Full, Partial, or No aot compiling on the app.
  *
  * For the rest of the benchmarks, see individual kdoc.
+ *
+ * Note that full benchmark suite without startup tests take 3hr+.
  */
 @OptIn(ExperimentalMetricApi::class)
 @RunWith(AndroidJUnit4::class)
@@ -203,6 +205,7 @@ class ComplexPoetryBenchmarks {
         }
         putExtra(PerformancePoetryActivity.EXTRA_PERF_CONFIG_INITIALIZING, true)
         putExtra(PerformancePoetryActivity.EXTRA_PERF_CONFIG_ACTION_TRACING, true)
+        putExtra(PerformancePoetryActivity.EXTRA_TRACE_SELECT_TIMEOUTS, true)
       }
     }
 
@@ -278,17 +281,19 @@ class ComplexPoetryBenchmarks {
     const val PACKAGE_NAME = "com.squareup.benchmarks.performance.complex.poetry"
 
     val ACTION_TRACE_SECTIONS = listOf(
-      "E-PoemList-PoemSelected-00",
-      "Worker-ComplexCallBrowser(2)-Finished-00",
-      "E-StanzaList-StanzaSelected-00",
-      "E-StanzaList-Exit-00",
-      "Worker-ComplexCallBrowser(-1)-Finished-00",
+      "E-PoemList-PoemSelected-${0.pad()}",
+      "Worker-ComplexCallBrowser(2)-Finished-${0.pad()}",
+      "E-StanzaList-StanzaSelected-${0.pad()}",
+      "E-StanzaList-Exit-${0.pad()}",
+      "Worker-ComplexCallBrowser(-1)-Finished-${0.pad()}",
     ) + (0..11).map {
       "Worker-PoemLoading-Finished-${it.pad()}"
     } + (0..4).map {
       "E-StanzaWorkflow-ShowNextStanza-${it.pad()}"
     } + (0..4).map {
       "E-StanzaWorkflow-ShowPreviousStanza-${it.pad()}"
+    } + (1..42).map {
+      "E-Runtime-OnTimeout-${it.pad()}"
     }
 
     val ACTION_TRACE_SECTIONS_HIGH_FREQUENCY = ACTION_TRACE_SECTIONS + (0..250).map {