WIP Add a config to use Compose for the runtime.

See go/compose-based-workflows.

Author: zach-klippenstein

benchmarks/dungeon-benchmark/build.gradle.kts

@@ -48,7 +48,7 @@ kotlin {
 }
 
 dependencies {
-  implementation(libs.androidx.macro.benchmark)
+  implementation(libs.androidx.benchmark.macro)
   implementation(libs.androidx.test.espresso.core)
   implementation(libs.androidx.test.junit)
   implementation(libs.androidx.test.uiautomator)

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

@@ -57,7 +57,7 @@ kotlin {
 }
 
 dependencies {
-  implementation(libs.androidx.macro.benchmark)
+  implementation(libs.androidx.benchmark.macro)
   implementation(libs.androidx.test.espresso.core)
   implementation(libs.androidx.test.junit)
   implementation(libs.androidx.test.uiautomator)

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

@@ -3,6 +3,7 @@ package com.squareup.benchmarks.performance.complex.poetry.instrumentation
 import androidx.tracing.Trace
 import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemWorkflow
 import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowserWorkflow
+import com.squareup.benchmarks.performance.complex.poetry.instrumentation.PerformanceTracingInterceptor.Companion.NODES_TO_TRACE
 import com.squareup.workflow1.BaseRenderContext
 import com.squareup.workflow1.WorkflowInterceptor
 import com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor
@@ -27,6 +28,13 @@ class PerformanceTracingInterceptor(
     context: BaseRenderContext<P, S, O>,
     proceed: (P, S, RenderContextInterceptor<P, S, O>?) -> R,
     session: WorkflowSession
+  ): R = traceRender(session) {
+    proceed(renderProps, renderState, null)
+  }
+
+  private inline fun <R> traceRender(
+    session: WorkflowSession,
+    render: () -> R
   ): R {
     val isRoot = session.parent == null
     val traceIdIndex = NODES_TO_TRACE.indexOfFirst { it.second == session.identifier }
@@ -45,7 +53,7 @@ class PerformanceTracingInterceptor(
       Trace.beginSection(sectionName)
     }
 
-    return proceed(renderProps, renderState, null).also {
+    return render().also {
       if (traceIdIndex > -1 && !sample) {
         Trace.endSection()
       }

build.gradle.kts

@@ -28,6 +28,7 @@ plugins {
   alias(libs.plugins.dokka)
   alias(libs.plugins.ktlint)
   alias(libs.plugins.compose.compiler) apply false
+  alias(libs.plugins.androidx.benchmark) apply false
 }
 
 shardConnectedCheckTasks(project)

gradle/libs.versions.toml

@@ -11,7 +11,7 @@ jdk-toolchain = "17"
 
 androidx-activity = "1.8.2"
 androidx-appcompat = "1.7.0"
-androidx-benchmark = "1.3.3"
+androidx-benchmark = "1.3.4"
 androidx-cardview = "1.0.0"
 androidx-collection = "1.5.0"
 # see https://developer.android.com/jetpack/compose/bom/bom-mapping
@@ -98,11 +98,13 @@ timber = "5.0.1"
 truth = "1.4.4"
 turbine = "1.0.0"
 vanniktech-publish = "0.32.0"
+agp = "8.8.0"
 
 [plugins]
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 
 compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+androidx-benchmark = { id = "androidx.benchmark", version.ref = "androidx-benchmark" }
 
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 
@@ -116,6 +118,8 @@ kotlinx-apiBinaryCompatibility = { id = "org.jetbrains.kotlinx.binary-compatibil
 mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "vanniktech-publish" }
 
 jetbrains-compose = { id = "org.jetbrains.compose", version.ref = "jetbrains-compose-plugin" }
+android-library = { id = "com.android.library", version.ref = "agp" }
+kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 
 [libraries]
 
@@ -167,7 +171,8 @@ androidx-lifecycle-viewmodel-core = { module = "androidx.lifecycle:lifecycle-vie
 androidx-lifecycle-viewmodel-ktx = { module = "androidx.lifecycle:lifecycle-viewmodel-ktx", version.ref = "androidx-lifecycle" }
 androidx-lifecycle-viewmodel-savedstate = { module = "androidx.lifecycle:lifecycle-viewmodel-savedstate", version.ref = "androidx-lifecycle" }
 
-androidx-macro-benchmark = { module = "androidx.benchmark:benchmark-macro-junit4", version.ref = "androidx-benchmark" }
+androidx-benchmark = { module = "androidx.benchmark:benchmark-junit4", version.ref = "androidx-benchmark" }
+androidx-benchmark-macro = { module = "androidx.benchmark:benchmark-macro-junit4", version.ref = "androidx-benchmark" }
 
 androidx-profileinstaller = { module = "androidx.profileinstaller:profileinstaller", version.ref = "androidx-profileinstaller" }
 
@@ -270,7 +275,7 @@ squareup-moshi-kotlin = { module = "com.squareup.moshi:moshi-kotlin", version.re
 
 squareup-okio = { module = "com.squareup.okio:okio", version.ref = "squareup-okio" }
 
-squareup-papa = { module = "com.squareup.papa:papa", version.ref = "squareup-papa"}
+squareup-papa = { module = "com.squareup.papa:papa", version.ref = "squareup-papa" }
 
 squareup-radiography = { module = "com.squareup.radiography:radiography", version.ref = "squareup-radiography" }
 

samples/compose-samples/src/main/java/com/squareup/sample/compose/nestedrenderings/NestedRenderingsActivity.kt

@@ -11,6 +11,8 @@ import androidx.compose.ui.platform.AndroidUiDispatcher
 import androidx.lifecycle.SavedStateHandle
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
+import com.squareup.workflow1.RuntimeConfigOptions.COMPOSE_RUNTIME
+import com.squareup.workflow1.SimpleLoggingWorkflowInterceptor
 import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.android.renderWorkflowIn
 import com.squareup.workflow1.config.AndroidRuntimeConfigTools
@@ -49,7 +51,8 @@ class NestedRenderingsActivity : AppCompatActivity() {
         workflow = RecursiveWorkflow.mapRendering { it.withEnvironment(viewEnvironment) },
         scope = viewModelScope + AndroidUiDispatcher.Main,
         savedStateHandle = savedState,
-        runtimeConfig = AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
+        runtimeConfig = setOf(COMPOSE_RUNTIME), // AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
+        interceptors = listOf(SimpleLoggingWorkflowInterceptor()),
       )
     }
   }

samples/containers/app-poetry/src/main/java/com/squareup/sample/poetryapp/PoetryActivity.kt

@@ -12,6 +12,7 @@ import com.squareup.sample.container.SampleContainers
 import com.squareup.sample.poetry.RealPoemWorkflow
 import com.squareup.sample.poetry.RealPoemsBrowserWorkflow
 import com.squareup.sample.poetry.model.Poem
+import com.squareup.workflow1.RuntimeConfigOptions.COMPOSE_RUNTIME
 import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.android.renderWorkflowIn
 import com.squareup.workflow1.config.AndroidRuntimeConfigTools
@@ -47,7 +48,7 @@ class PoetryModel(savedState: SavedStateHandle) : ViewModel() {
       scope = viewModelScope,
       prop = 0 to 0 to Poem.allPoems,
       savedStateHandle = savedState,
-      runtimeConfig = AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
+      runtimeConfig = setOf(COMPOSE_RUNTIME), // AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
     ).reportNavigation {
       Timber.i("Navigated to %s", it)
     }

samples/containers/app-raven/src/main/java/com/squareup/sample/ravenapp/RavenActivity.kt

@@ -12,6 +12,7 @@ import androidx.lifecycle.viewModelScope
 import com.squareup.sample.container.SampleContainers
 import com.squareup.sample.poetry.RealPoemWorkflow
 import com.squareup.sample.poetry.model.Raven
+import com.squareup.workflow1.RuntimeConfigOptions.COMPOSE_RUNTIME
 import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.android.renderWorkflowIn
 import com.squareup.workflow1.config.AndroidRuntimeConfigTools
@@ -56,7 +57,7 @@ class RavenModel(savedState: SavedStateHandle) : ViewModel() {
       scope = viewModelScope,
       savedStateHandle = savedState,
       prop = Raven,
-      runtimeConfig = AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
+      runtimeConfig = setOf(COMPOSE_RUNTIME), // AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
     ) {
       running.complete()
     }.reportNavigation {

samples/containers/hello-back-button/src/main/java/com/squareup/sample/hellobackbutton/HelloBackButtonActivity.kt

@@ -10,6 +10,7 @@ import androidx.lifecycle.ViewModel
 import androidx.lifecycle.lifecycleScope
 import androidx.lifecycle.viewModelScope
 import com.squareup.sample.container.SampleContainers
+import com.squareup.workflow1.RuntimeConfigOptions.COMPOSE_RUNTIME
 import com.squareup.workflow1.WorkflowExperimentalRuntime
 import com.squareup.workflow1.android.renderWorkflowIn
 import com.squareup.workflow1.config.AndroidRuntimeConfigTools
@@ -53,7 +54,7 @@ class HelloBackButtonModel(savedState: SavedStateHandle) : ViewModel() {
       workflow = AreYouSureWorkflow,
       scope = viewModelScope,
       savedStateHandle = savedState,
-      runtimeConfig = AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
+      runtimeConfig = setOf(COMPOSE_RUNTIME), // AndroidRuntimeConfigTools.getAppWorkflowRuntimeConfig()
     ) {
       // This workflow handles the back button itself, so the activity can't.
       // Instead, the workflow emits an output to signal that it's time to shut things down.

samples/dungeon/app/build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
   id("kotlin-android")
   id("android-sample-app")
   id("android-ui-tests")
+  alias(libs.plugins.compose.compiler)
 }
 
 android {
@@ -43,12 +44,15 @@ dependencies {
   implementation(libs.rxjava2.rxandroid)
   implementation(libs.squareup.cycler)
   implementation(libs.squareup.okio)
+  implementation(platform(libs.androidx.compose.bom))
+  implementation(libs.androidx.compose.foundation)
 
   implementation(project(":samples:dungeon:common"))
   implementation(project(":samples:dungeon:timemachine"))
   implementation(project(":samples:dungeon:timemachine-shakeable"))
   implementation(project(":workflow-ui:core-android"))
   implementation(project(":workflow-ui:core-common"))
+  implementation(project(":workflow-ui:compose"))
 
   testImplementation(libs.junit)
   testImplementation(libs.truth)