Move Compose runtime optimizations out of core/runtime

Author: steve-the-edwards

artifacts.json

@@ -23,6 +23,14 @@
     "packaging": "jar",
     "javaVersion": "1.8"
   },
+  {
+    "gradlePath": ":workflow-core-compose",
+    "group": "com.squareup.workflow1",
+    "artifactId": "workflow-core-compose",
+    "description": "Workflow Core Compose",
+    "packaging": "jar",
+    "javaVersion": "1.8"
+  },
   {
     "gradlePath": ":workflow-runtime",
     "group": "com.squareup.workflow1",

benchmarks/performance-poetry/complex-poetry/build.gradle.kts

@@ -52,6 +52,7 @@ dependencies {
   // API on an app module so these are transitive dependencies for the benchmarks.
   api(project(":samples:containers:android"))
   api(project(":samples:containers:poetry"))
+  api(project(":workflow-core-compose"))
   api(project(":workflow-ui:core-android"))
 
   implementation(libs.androidx.activity.ktx)

benchmarks/performance-poetry/complex-poetry/src/androidTest/java/com/squareup/benchmarks/performance/complex/poetry/RenderPassTest.kt

@@ -84,7 +84,7 @@ class RenderPassTest {
 
   @Ignore(
     "Not sure why but this gets stuck on initializing. Compose doesn't get the next" +
-      " frame when this is started by the test, but it does when running directly."
+      " frame when this is started by the test, but it does when running directly. See #835"
   )
   @Test fun renderPassCounterFrameTimeoutComposeComplexWithInitializingState() {
     runRenderPassCounter(COMPLEX_INITIALIZING, useFrameTimeout = true, useCompose = true)

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

@@ -9,19 +9,21 @@ import com.squareup.sample.container.overviewdetail.OverviewDetailScreen
 import com.squareup.workflow1.Snapshot
 import com.squareup.workflow1.StatefulWorkflow
 import com.squareup.workflow1.Workflow
+import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.action
+import com.squareup.workflow1.compose.StatefulComposeWorkflow
 import com.squareup.workflow1.runningWorker
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import kotlinx.coroutines.flow.Flow
 
 typealias IsLoading = Boolean
 
-@OptIn(WorkflowUiExperimentalApi::class)
+@OptIn(WorkflowUiExperimentalApi::class, WorkflowExperimentalRuntime::class)
 class MaybeLoadingGatekeeperWorkflow<T : Any>(
   private val childWithLoading: Workflow<T, Any, OverviewDetailScreen>,
   private val childProps: T,
   private val isLoading: Flow<Boolean>
-) : StatefulWorkflow<Unit, IsLoading, Unit, MayBeLoadingScreen>() {
+) : StatefulComposeWorkflow<Unit, IsLoading, Unit, MayBeLoadingScreen>() {
   override fun initialState(
     props: Unit,
     snapshot: Snapshot?
@@ -30,7 +32,7 @@ class MaybeLoadingGatekeeperWorkflow<T : Any>(
   override fun render(
     renderProps: Unit,
     renderState: IsLoading,
-    context: RenderContext
+    context: StatefulWorkflow<Unit, IsLoading, Unit, MayBeLoadingScreen>.RenderContext
   ): MayBeLoadingScreen {
     context.runningWorker(isLoading.asTraceableWorker("GatekeeperLoading")) {
       action {

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

@@ -31,7 +31,9 @@ import com.squareup.workflow1.StatefulWorkflow
 import com.squareup.workflow1.Worker
 import com.squareup.workflow1.WorkflowAction
 import com.squareup.workflow1.WorkflowAction.Companion.noAction
+import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.action
+import com.squareup.workflow1.compose.StatefulComposeWorkflow
 import com.squareup.workflow1.runningWorker
 import com.squareup.workflow1.ui.Screen
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
@@ -58,11 +60,11 @@ import kotlinx.coroutines.flow.flow
  * break ties/conflicts with a token in the start/stop requests. We leave that complexity out
  * here. **
  */
-@OptIn(WorkflowUiExperimentalApi::class)
+@OptIn(WorkflowUiExperimentalApi::class, WorkflowExperimentalRuntime::class)
 class PerformancePoemWorkflow(
   private val simulatedPerfConfig: SimulatedPerfConfig = SimulatedPerfConfig.NO_SIMULATED_PERF,
   private val isLoading: MutableStateFlow<Boolean>,
-) : PoemWorkflow, StatefulWorkflow<Poem, State, ClosePoem, OverviewDetailScreen>() {
+) : PoemWorkflow, StatefulComposeWorkflow<Poem, State, ClosePoem, OverviewDetailScreen>() {
 
   sealed class State {
     // N.B. This state is a smell. We include it to be able to mimic smells
@@ -95,7 +97,7 @@ class PerformancePoemWorkflow(
   override fun render(
     renderProps: Poem,
     renderState: State,
-    context: RenderContext
+    context: StatefulWorkflow<Poem, State, ClosePoem, OverviewDetailScreen>.RenderContext
   ): OverviewDetailScreen {
     return when (renderState) {
       Initializing -> {

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

@@ -19,7 +19,9 @@ import com.squareup.sample.poetry.PoemsBrowserWorkflow
 import com.squareup.sample.poetry.model.Poem
 import com.squareup.workflow1.Snapshot
 import com.squareup.workflow1.StatefulWorkflow
+import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.action
+import com.squareup.workflow1.compose.StatefulComposeWorkflow
 import com.squareup.workflow1.runningWorker
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import com.squareup.workflow1.ui.container.BackStackScreen
@@ -44,14 +46,14 @@ import java.lang.IllegalStateException
  * break ties/conflicts with a token in the start/stop requests. We leave that complexity out
  * here. **
  */
-@OptIn(WorkflowUiExperimentalApi::class)
+@OptIn(WorkflowUiExperimentalApi::class, WorkflowExperimentalRuntime::class)
 class PerformancePoemsBrowserWorkflow(
   private val simulatedPerfConfig: SimulatedPerfConfig,
   private val poemWorkflow: PoemWorkflow,
   private val isLoading: MutableStateFlow<Boolean>,
 ) :
   PoemsBrowserWorkflow,
-  StatefulWorkflow<List<Poem>, State, Unit, OverviewDetailScreen>() {
+  StatefulComposeWorkflow<List<Poem>, State, Unit, OverviewDetailScreen>() {
 
   sealed class State {
     // N.B. This state is a smell. We include it to be able to mimic smells
@@ -76,7 +78,7 @@ class PerformancePoemsBrowserWorkflow(
   override fun render(
     renderProps: List<Poem>,
     renderState: State,
-    context: RenderContext
+    context: StatefulWorkflow<List<Poem>, State, Unit, OverviewDetailScreen>.RenderContext
   ): OverviewDetailScreen {
     val poemListProps = Props(
       poems = renderProps,

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

@@ -1,3 +1,5 @@
+@file:OptIn(WorkflowExperimentalRuntime::class)
+
 package com.squareup.benchmarks.performance.complex.poetry
 
 import android.content.pm.ApplicationInfo
@@ -25,6 +27,7 @@ import com.squareup.workflow1.RuntimeConfig.FrameTimeout
 import com.squareup.workflow1.RuntimeConfig.RenderPerAction
 import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.WorkflowInterceptor
+import com.squareup.workflow1.compose.ComposeRuntimePlugin
 import com.squareup.workflow1.ui.Screen
 import com.squareup.workflow1.ui.ViewEnvironment.Companion.EMPTY
 import com.squareup.workflow1.ui.ViewRegistry
@@ -270,12 +273,14 @@ class PoetryModel(
   runtimeConfig: RuntimeConfig
 ) : ViewModel() {
   @OptIn(WorkflowUiExperimentalApi::class) val renderings: StateFlow<Screen> by lazy {
+    val runtimePlugin = if (runtimeConfig.useComposeInRuntime) ComposeRuntimePlugin else null
     renderWorkflowIn(
       workflow = workflow,
       scope = viewModelScope,
       savedStateHandle = savedState,
       interceptors = interceptor?.let { listOf(it) } ?: emptyList(),
-      runtimeConfig = runtimeConfig
+      runtimeConfig = runtimeConfig,
+      workflowRuntimePlugin = runtimePlugin
     )
   }
 

benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/instrumentation/ActionHandlingTracingInterceptor.kt

@@ -8,6 +8,9 @@ import com.squareup.workflow1.WorkflowAction
 import com.squareup.workflow1.WorkflowInterceptor
 import com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor
 import com.squareup.workflow1.WorkflowInterceptor.WorkflowSession
+import com.squareup.workflow1.compose.BaseComposeRenderContext
+import com.squareup.workflow1.compose.ComposeWorkflowInterceptor
+import com.squareup.workflow1.compose.ComposeWorkflowInterceptor.ComposeRenderContextInterceptor
 
 /**
  * We use this [WorkflowInterceptor] to add in tracing for the main thread messages that handle
@@ -22,13 +25,13 @@ import com.squareup.workflow1.WorkflowInterceptor.WorkflowSession
  * annotate the [Worker] using [TraceableWorker] which will set it up with a key such that when
  * the action for the result is sent to the sink the main thread message will be traced.
  */
-class ActionHandlingTracingInterceptor : WorkflowInterceptor, Resettable {
+class ActionHandlingTracingInterceptor : ComposeWorkflowInterceptor, Resettable {
 
   private val actionCounts: MutableMap<String, Int> = mutableMapOf()
 
   class EventHandlingTracingRenderContextInterceptor<P, S, O>(
     private val actionCounts: MutableMap<String, Int>
-  ) : RenderContextInterceptor<P, S, O> {
+  ) : ComposeRenderContextInterceptor<P, S, O> {
     override fun onActionSent(
       action: WorkflowAction<P, S, O>,
       proceed: (WorkflowAction<P, S, O>) -> Unit
@@ -76,9 +79,9 @@ class ActionHandlingTracingInterceptor : WorkflowInterceptor, Resettable {
   override fun <P, S, O, R> Rendering(
     renderProps: P,
     renderState: S,
-    context: BaseRenderContext<P, S, O>,
+    context: BaseComposeRenderContext<P, S, O>,
     session: WorkflowSession,
-    proceed: @Composable (P, S, RenderContextInterceptor<P, S, O>?) -> R
+    proceed: @Composable (P, S, ComposeRenderContextInterceptor<P, S, O>?) -> R
   ): R {
     val rci = remember {
       EventHandlingTracingRenderContextInterceptor<P, S, O>(actionCounts)

benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/instrumentation/PerformanceTracingInterceptor.kt

@@ -7,9 +7,11 @@ import androidx.tracing.Trace
 import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow
 import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowserWorkflow
 import com.squareup.workflow1.BaseRenderContext
-import com.squareup.workflow1.WorkflowInterceptor
 import com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor
 import com.squareup.workflow1.WorkflowInterceptor.WorkflowSession
+import com.squareup.workflow1.compose.BaseComposeRenderContext
+import com.squareup.workflow1.compose.ComposeWorkflowInterceptor
+import com.squareup.workflow1.compose.ComposeWorkflowInterceptor.ComposeRenderContextInterceptor
 import com.squareup.workflow1.workflowIdentifier
 
 /**
@@ -21,7 +23,7 @@ import com.squareup.workflow1.workflowIdentifier
  */
 class PerformanceTracingInterceptor(
   private val sample: Boolean = false
-) : WorkflowInterceptor, Resettable {
+) : ComposeWorkflowInterceptor, Resettable {
   private var totalRenderPasses = 0
 
   override fun <P, S, O, R> onRender(
@@ -42,9 +44,9 @@ class PerformanceTracingInterceptor(
   override fun <P, S, O, R> Rendering(
     renderProps: P,
     renderState: S,
-    context: BaseRenderContext<P, S, O>,
+    context: BaseComposeRenderContext<P, S, O>,
     session: WorkflowSession,
-    proceed: @Composable (P, S, RenderContextInterceptor<P, S, O>?) -> R
+    proceed: @Composable (P, S, ComposeRenderContextInterceptor<P, S, O>?) -> R
   ): R {
     // TODO: Fix that these are illegal side effects in a Composable
     val traceIdIndex = remember(session) {

benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/instrumentation/RenderPassCountingInterceptor.kt

@@ -4,9 +4,11 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.SideEffect
 import androidx.compose.runtime.remember
 import com.squareup.workflow1.BaseRenderContext
-import com.squareup.workflow1.WorkflowInterceptor
 import com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor
 import com.squareup.workflow1.WorkflowInterceptor.WorkflowSession
+import com.squareup.workflow1.compose.BaseComposeRenderContext
+import com.squareup.workflow1.compose.ComposeWorkflowInterceptor
+import com.squareup.workflow1.compose.ComposeWorkflowInterceptor.ComposeRenderContextInterceptor
 
 /**
  * Used to count the number of render passes for a Workflow tree as well as each time that a node
@@ -16,7 +18,7 @@ import com.squareup.workflow1.WorkflowInterceptor.WorkflowSession
  * This is convenient to use in integration tests that verify that the # of render passes and the
  * ratio of 'fresh' to 'stale' renderings for a scenario are constant.
  */
-class RenderPassCountingInterceptor : WorkflowInterceptor, Resettable {
+class RenderPassCountingInterceptor : ComposeWorkflowInterceptor, Resettable {
   val renderEfficiencyTracking = RenderEfficiency()
   private var renderPassStats: RenderStats = RenderStats()
   private val nodeStates: MutableMap<Long, String> = mutableMapOf()
@@ -38,10 +40,10 @@ class RenderPassCountingInterceptor : WorkflowInterceptor, Resettable {
   override fun <P, S, O, R> Rendering(
     renderProps: P,
     renderState: S,
-    context: BaseRenderContext<P, S, O>,
+    context: BaseComposeRenderContext<P, S, O>,
     session: WorkflowSession,
     proceed: @Composable
-    (P, S, RenderContextInterceptor<P, S, O>?) -> R
+    (P, S, ComposeRenderContextInterceptor<P, S, O>?) -> R
   ): R {
     val isRoot = remember(session, renderState) {
       before(session, renderState)