Merge branch 'main' into wenli/workflow-viewer

Author: wenli-cai

RELEASING.md

@@ -93,7 +93,7 @@
       1. `git merge --no-ff origin/yourname/kotlin-v0.1.0`
       1. `git push origin gh-pages`
 
-1. _Don't do this until the tutorial gets updated._ Once Maven artifacts are synced, update the workflow version used by the tutorial in
+1. Once Maven artifacts are synced, update the workflow version used by the tutorial in
    `samples/tutorial/build.gradle`.
 
 ### Validating Markdown

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

@@ -27,7 +27,7 @@ class MaybeLoadingGatekeeperWorkflow<T : Any>(
   override fun render(
     renderProps: Unit,
     renderState: IsLoading,
-    context: RenderContext
+    context: RenderContext<Unit, IsLoading, Unit>
   ): MayBeLoadingScreen {
     context.runningWorker(isLoading.asTraceableWorker("GatekeeperLoading")) {
       action("GatekeeperLoading") {

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

@@ -96,7 +96,7 @@ class PerformancePoemWorkflow(
   override fun render(
     renderProps: Poem,
     renderState: State,
-    context: RenderContext
+    context: RenderContext<Poem, State, ClosePoem>
   ): OverviewDetailScreen<*> {
     if (simulatedPerfConfig.simultaneousActions > 0) {
       repeat(simulatedPerfConfig.simultaneousActions) { index ->

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

@@ -86,7 +86,7 @@ class PerformancePoemsBrowserWorkflow(
   override fun render(
     renderProps: ConfigAndPoems,
     renderState: State,
-    context: RenderContext
+    context: RenderContext<ConfigAndPoems, State, Unit>
   ): OverviewDetailScreen<*> {
     when (renderState) {
       is Recurse -> {

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

@@ -1,7 +1,6 @@
 package com.squareup.benchmarks.performance.complex.poetry
 
 import android.content.pm.ApplicationInfo
-import android.os.Build
 import android.os.Bundle
 import android.os.Handler
 import android.os.Looper
@@ -26,9 +25,9 @@ import com.squareup.workflow1.WorkflowInterceptor
 import com.squareup.workflow1.ui.Screen
 import com.squareup.workflow1.ui.ViewEnvironment.Companion.EMPTY
 import com.squareup.workflow1.ui.ViewRegistry
-import com.squareup.workflow1.ui.WorkflowLayout
 import com.squareup.workflow1.ui.renderWorkflowIn
 import com.squareup.workflow1.ui.withEnvironment
+import com.squareup.workflow1.ui.workflowContentView
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.onEach
@@ -97,13 +96,9 @@ class PerformancePoetryActivity : AppCompatActivity() {
       model.renderings
     }
 
-    setContentView(
-      WorkflowLayout(this).apply {
-        take(
-          lifecycle,
-          instrumentedRenderings.map { it.withEnvironment(viewEnvironment) }
-        )
-      }
+    workflowContentView.take(
+      lifecycle,
+      instrumentedRenderings.map { it.withEnvironment(viewEnvironment) }
     )
 
     // We can report this here as the first rendering from the Workflow is rendered synchronously.
@@ -125,7 +120,7 @@ class PerformancePoetryActivity : AppCompatActivity() {
     val traceMain = intent.getBooleanExtra(EXTRA_TRACE_ALL_MAIN_THREAD_MESSAGES, false)
     val traceSelectOnTimeout = intent.getBooleanExtra(EXTRA_TRACE_SELECT_TIMEOUTS, false)
     val areTracingViaMainLooperCurrently = traceMain || traceSelectOnTimeout
-    val ableToTrace = Build.VERSION.SDK_INT != 28 && (debuggable || profileable)
+    val ableToTrace = debuggable || profileable
 
     if (areTracingViaMainLooperCurrently && ableToTrace) {
       // Add main message tracing to see everything happening in Perfetto.

design-docs/compose-based-workflows-design.md

@@ -282,7 +282,7 @@ A more interesting, comprehensive example that ties this in with the First Primi
 ```kotlin
 class IdentityWorkflow(
   private val child: Workflow<Props, Output, Rendering>
-) : StatelessWorkflow<Props, Output, Rendering {
+) : StatelessWorkflow<Props, Output, Rendering> {
   override fun render(props: Props, context: RenderContext): Rendering {
     return context.renderComposable {
       renderWorkflow(child, props, onOutput = { output ->
@@ -379,8 +379,7 @@ public abstract class ComposeWorkflow<
 To implement the `Workflow` interface, we need to have a function that returns a `StatefulWorkflow` with the actual implementation. That's trivial: we just return a really simple workflow that does nothing but call `renderComposable` from above in its render method:
 
 ```kotlin
-  private inner class ComposeWorkflowWrapper :
-    StatefulWorkflow<PropsT, Unit, OutputT, RenderingT>() {
+  inner class ComposeWorkflowWrapper : StatefulWorkflow<PropsT, Unit, OutputT, RenderingT>() {
 
     override fun initialState(
       props: PropsT,
@@ -392,7 +391,7 @@ To implement the `Workflow` interface, we need to have a function that returns a
     override fun render(
       renderProps: PropsT,
       renderState: Unit,
-      context: RenderContext
+      context: StatefulWorkflow.RenderContext<PropsT,Unit,OutputT>
     ): RenderingT = context.renderComposable {
       // Explicitly remember the output function since we know that actionSink
       // is stable even though Compose might not know that.

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocompose/HelloComposeWorkflow.kt

@@ -32,7 +32,7 @@ object HelloComposeWorkflow : StatefulWorkflow<Unit, State, Nothing, HelloCompos
   override fun render(
     renderProps: Unit,
     renderState: State,
-    context: RenderContext
+    context: RenderContext<Unit, State, Nothing>
   ): HelloComposeScreen = HelloComposeScreen(
     message = renderState.name,
     onClick = { context.actionSink.send(helloAction) }

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocomposebinding/HelloBindingActivity.kt

@@ -15,11 +15,11 @@ import com.squareup.workflow1.mapRendering
 import com.squareup.workflow1.ui.Screen
 import com.squareup.workflow1.ui.ViewEnvironment
 import com.squareup.workflow1.ui.ViewRegistry
-import com.squareup.workflow1.ui.WorkflowLayout
 import com.squareup.workflow1.ui.compose.withComposeInteropSupport
 import com.squareup.workflow1.ui.plus
 import com.squareup.workflow1.ui.renderWorkflowIn
 import com.squareup.workflow1.ui.withEnvironment
+import com.squareup.workflow1.ui.workflowContentView
 import kotlinx.coroutines.flow.StateFlow
 
 private val viewEnvironment =
@@ -37,13 +37,9 @@ class HelloBindingActivity : AppCompatActivity() {
     super.onCreate(savedInstanceState)
 
     val model: HelloBindingModel by viewModels()
-    setContentView(
-      WorkflowLayout(this).apply {
-        take(
-          lifecycle = lifecycle,
-          renderings = model.renderings,
-        )
-      }
+    workflowContentView.take(
+      lifecycle = lifecycle,
+      renderings = model.renderings,
     )
   }
 

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocomposebinding/HelloWorkflow.kt

@@ -39,7 +39,7 @@ object HelloWorkflow : StatefulWorkflow<Unit, State, Nothing, Rendering>() {
   override fun render(
     renderProps: Unit,
     renderState: State,
-    context: RenderContext
+    context: RenderContext<Unit, State, Nothing>
   ): Rendering {
     return Rendering(
       message = renderState.name,

samples/compose-samples/src/main/java/com/squareup/sample/compose/hellocomposeworkflow/ComposeWorkflowImpl.kt

@@ -59,7 +59,7 @@ internal class ComposeWorkflowImpl<PropsT, OutputT : Any>(
   override fun render(
     renderProps: PropsT,
     renderState: State<PropsT, OutputT>,
-    context: RenderContext
+    context: RenderContext<PropsT, State<PropsT, OutputT>, OutputT>
   ): ComposeScreen {
     // The first render pass needs to cache the sink. The sink is reusable, so we can just pass the
     // same one every time.