Merge branch 'ray/ui-update'

* ray/ui-update: (55 commits)
  Defers most deprecation and restores deleted kdoc
  `View.environmentOrNull`, `View.screenOrNull`.
  Revert "Brings back `View.environment`, adds `View.getScreen`."
  Brings back `View.environment`, adds `View.getScreen`.
  Fixes a few typos in ScreenViewFactory kdoc
  Introduces ViewEnvironmentKey.combine, makes ViewRegistry use it.
  More consistent use of Compatible.keyFor
  Adds EnvironmentScreenLegacyViewFactory.
  Fixes BackStackContainer view persistence
  Hello ModalScreenOverlay
  Deletes extra copy of AndroidOverlay
  Fixes unused imports on LoaderSpinner
  Renames ScreenViewFactory.for* to .from*
  One more pass at the ScreenViewFactory kdoc
  Some method renaming and other polish from PR review.
  Snip a couple of unnecessary lambdas.
  Adds missing kdoc to ScreenViewFactory.unwrapping
  Moves and renames the bind methods, adds missing kdoc.
  ScreenViewHolder replaces View.* extensions and DecorativeViewFactory
  Adds missing integration tests EnvironmentScreen, NamedScreen.
  ...

Author: rjrjr

README.md

@@ -59,14 +59,6 @@ your `repositories` block, and then add dependencies on the following artifacts:
     <td nowrap><code>com.squareup.workflow1:workflow-ui-core-android:x.y.z</code></td>
     <td>You're writing an Android app that uses Workflows.</td>
   </tr>
-  <tr>
-    <td nowrap><code>com.squareup.workflow1:workflow-ui-modal-android:x.y.z</code></td>
-    <td>Your Android app uses modals (popups).</td>
-  </tr>
-  <tr>
-    <td nowrap><code>com.squareup.workflow1:workflow-ui-container-android:x.y.z</code></td>
-    <td>Your android app uses backstacks.</td>
-  </tr>
 </table>
 
 ### Lower-level Artifacts

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

@@ -9,10 +9,12 @@ import com.squareup.workflow1.Workflow
 import com.squareup.workflow1.action
 import com.squareup.workflow1.asWorker
 import com.squareup.workflow1.runningWorker
+import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import kotlinx.coroutines.flow.Flow
 
 typealias IsLoading = Boolean
 
+@OptIn(WorkflowUiExperimentalApi::class)
 class MaybeLoadingGatekeeperWorkflow<T : Any>(
   private val childWithLoading: Workflow<T, Any, OverviewDetailScreen>,
   private val childProps: T,

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

@@ -15,7 +15,7 @@ import com.squareup.sample.poetry.PoemWorkflow
 import com.squareup.sample.poetry.PoemWorkflow.ClosePoem
 import com.squareup.sample.poetry.StanzaListWorkflow
 import com.squareup.sample.poetry.StanzaListWorkflow.NO_SELECTED_STANZA
-import com.squareup.sample.poetry.StanzaRendering
+import com.squareup.sample.poetry.StanzaScreen
 import com.squareup.sample.poetry.StanzaWorkflow
 import com.squareup.sample.poetry.StanzaWorkflow.Output.CloseStanzas
 import com.squareup.sample.poetry.StanzaWorkflow.Output.ShowNextStanza
@@ -29,9 +29,10 @@ import com.squareup.workflow1.WorkflowAction
 import com.squareup.workflow1.WorkflowAction.Companion.noAction
 import com.squareup.workflow1.action
 import com.squareup.workflow1.runningWorker
+import com.squareup.workflow1.ui.Screen
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backstack.BackStackScreen
-import com.squareup.workflow1.ui.backstack.toBackStackScreen
+import com.squareup.workflow1.ui.container.BackStackScreen
+import com.squareup.workflow1.ui.container.toBackStackScreen
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.MutableStateFlow
 
@@ -124,7 +125,7 @@ class PerformancePoemWorkflow(
           }
         }
 
-        val previousStanzas: List<StanzaRendering> =
+        val previousStanzas: List<StanzaScreen> =
           if (stanzaIndex == NO_SELECTED_STANZA) emptyList()
           else renderProps.stanzas.subList(0, stanzaIndex)
             .mapIndexed { index, _ ->
@@ -149,7 +150,7 @@ class PerformancePoemWorkflow(
           }
 
         val stackedStanzas = visibleStanza?.let {
-          (previousStanzas + visibleStanza).toBackStackScreen<Any>()
+          (previousStanzas + visibleStanza).toBackStackScreen<Screen>()
         }
 
         val stanzaListOverview =

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

@@ -8,7 +8,7 @@ import com.squareup.benchmarks.performance.complex.poetry.PerformancePoemsBrowse
 import com.squareup.benchmarks.performance.complex.poetry.instrumentation.SimulatedPerfConfig
 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.PoemListScreen.Companion.NO_POEM_SELECTED
 import com.squareup.sample.poetry.PoemListWorkflow
 import com.squareup.sample.poetry.PoemWorkflow
 import com.squareup.sample.poetry.PoemsBrowserWorkflow
@@ -19,7 +19,7 @@ import com.squareup.workflow1.Worker
 import com.squareup.workflow1.action
 import com.squareup.workflow1.runningWorker
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backstack.BackStackScreen
+import com.squareup.workflow1.ui.container.BackStackScreen
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.MutableStateFlow
 

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

@@ -10,20 +10,22 @@ import androidx.lifecycle.viewModelScope
 import androidx.savedstate.SavedStateRegistryOwner
 import com.squareup.benchmarks.performance.complex.poetry.instrumentation.PerformanceTracingInterceptor
 import com.squareup.benchmarks.performance.complex.poetry.instrumentation.SimulatedPerfConfig
-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.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.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.backstack.BackStackContainer
-import com.squareup.workflow1.ui.plus
+import com.squareup.workflow1.ui.container.withEnvironment
 import com.squareup.workflow1.ui.renderWorkflowIn
 import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.map
 import timber.log.Timber
 
 @OptIn(WorkflowUiExperimentalApi::class)
-private val viewRegistry = SampleContainers + BackStackContainer + LoaderContainer
+private val viewEnvironment = EMPTY + (ViewRegistry to SampleContainers)
 
 class PerformancePoetryActivity : AppCompatActivity() {
   @OptIn(WorkflowUiExperimentalApi::class)
@@ -51,7 +53,12 @@ class PerformancePoetryActivity : AppCompatActivity() {
     val component = PerformancePoetryComponent(installedInterceptor, simulatedPerfConfig)
     val model: PoetryModel by viewModels { component.poetryModelFactory(this) }
     setContentView(
-      WorkflowLayout(this).apply { start(lifecycle, model.renderings, viewRegistry) }
+      WorkflowLayout(this).apply {
+        take(
+          lifecycle,
+          model.renderings.map { it.withEnvironment(viewEnvironment) }
+        )
+      }
     )
 
     // We can report this here as the first rendering from the Workflow is rendered synchronously.
@@ -84,7 +91,7 @@ class PoetryModel(
   workflow: MaybeLoadingGatekeeperWorkflow<List<Poem>>,
   interceptor: WorkflowInterceptor?
 ) : ViewModel() {
-  @OptIn(WorkflowUiExperimentalApi::class) val renderings: StateFlow<Any> by lazy {
+  @OptIn(WorkflowUiExperimentalApi::class) val renderings: StateFlow<Screen> by lazy {
     renderWorkflowIn(
       workflow = workflow,
       scope = viewModelScope,

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

@@ -1,30 +1,21 @@
 package com.squareup.benchmarks.performance.complex.poetry.views
 
-import android.content.Context
 import android.view.ViewGroup
 import android.view.ViewGroup.LayoutParams.MATCH_PARENT
 import android.widget.FrameLayout
-import com.squareup.workflow1.ui.AndroidViewRendering
-import com.squareup.workflow1.ui.BuilderViewFactory
-import com.squareup.workflow1.ui.ViewEnvironment
-import com.squareup.workflow1.ui.ViewFactory
+import com.squareup.workflow1.ui.AndroidScreen
+import com.squareup.workflow1.ui.ScreenViewFactory
+import com.squareup.workflow1.ui.ScreenViewHolder
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.bindShowRendering
 
 @OptIn(WorkflowUiExperimentalApi::class)
-object BlankScreen : AndroidViewRendering<BlankScreen> {
-  override val viewFactory: ViewFactory<BlankScreen>
-    get() = BuilderViewFactory<BlankScreen>(
-      type = BlankScreen::class,
-      viewConstructor = { initialRendering: BlankScreen,
-        initialViewEnvironment: ViewEnvironment,
-        contextForNewView: Context,
-        container: ViewGroup? ->
-        FrameLayout(contextForNewView).apply {
-          layoutParams =
-            container?.layoutParams ?: ViewGroup.LayoutParams(MATCH_PARENT, MATCH_PARENT)
-          bindShowRendering(initialRendering, initialViewEnvironment) { _, _ -> }
-        }
+object BlankScreen : AndroidScreen<BlankScreen> {
+  override val viewFactory: ScreenViewFactory<BlankScreen>
+    get() = ScreenViewFactory.fromCode<BlankScreen> { _, initialEnvironment, context, container ->
+      FrameLayout(context).let { view ->
+        view.layoutParams =
+          container?.layoutParams ?: ViewGroup.LayoutParams(MATCH_PARENT, MATCH_PARENT)
+        ScreenViewHolder(initialEnvironment, view) { _, _ -> }
       }
-    )
+    }
 }

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

@@ -1,34 +1,31 @@
 package com.squareup.benchmarks.performance.complex.poetry.views
 
-import android.content.Context
+import android.view.Gravity.CENTER
 import android.view.ViewGroup
-import android.view.ViewGroup.LayoutParams
+import android.view.ViewGroup.LayoutParams.WRAP_CONTENT
+import android.widget.FrameLayout
 import android.widget.ProgressBar
-import com.squareup.workflow1.ui.AndroidViewRendering
-import com.squareup.workflow1.ui.BuilderViewFactory
-import com.squareup.workflow1.ui.ViewEnvironment
-import com.squareup.workflow1.ui.ViewFactory
+import com.squareup.workflow1.ui.AndroidScreen
+import com.squareup.workflow1.ui.ScreenViewFactory
+import com.squareup.workflow1.ui.ScreenViewHolder
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.bindShowRendering
 
 @OptIn(WorkflowUiExperimentalApi::class)
-object LoaderSpinner : AndroidViewRendering<LoaderSpinner> {
-  override val viewFactory: ViewFactory<LoaderSpinner>
-    get() = BuilderViewFactory<LoaderSpinner>(
-      type = LoaderSpinner::class,
-      viewConstructor = { initialRendering: LoaderSpinner,
-        initialViewEnvironment: ViewEnvironment,
-        contextForNewView: Context,
-        container: ViewGroup? ->
-        ProgressBar(contextForNewView).apply {
-          layoutParams =
-            container?.layoutParams ?: LayoutParams(
-              LayoutParams.WRAP_CONTENT,
-              LayoutParams.WRAP_CONTENT
-            )
-          this.isIndeterminate = true
-          bindShowRendering(initialRendering, initialViewEnvironment) { _, _ -> }
+object LoaderSpinner : AndroidScreen<LoaderSpinner> {
+  override val viewFactory =
+    ScreenViewFactory.fromCode<LoaderSpinner> { _, initialEnvironment, context, _ ->
+      val progressBar = ProgressBar(context).apply {
+        layoutParams = FrameLayout.LayoutParams(
+          ViewGroup.LayoutParams(WRAP_CONTENT, WRAP_CONTENT)
+        ).apply {
+          gravity = CENTER
         }
+        isIndeterminate = true
       }
-    )
+
+      FrameLayout(context).let { view ->
+        view.addView(progressBar)
+        ScreenViewHolder(initialEnvironment, view) { _, _ -> }
+      }
+    }
 }

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

@@ -1,20 +1,30 @@
 package com.squareup.benchmarks.performance.complex.poetry.views
 
 import com.squareup.sample.container.overviewdetail.OverviewDetailScreen
-import com.squareup.sample.container.panel.ScrimContainerScreen
+import com.squareup.sample.container.panel.ScrimScreen
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
-import com.squareup.workflow1.ui.modal.HasModals
+import com.squareup.workflow1.ui.container.BodyAndModalsScreen
+import com.squareup.workflow1.ui.container.ModalScreenOverlay
 
 @OptIn(WorkflowUiExperimentalApi::class)
-class MayBeLoadingScreen(
-  private val baseScreen: OverviewDetailScreen,
-  private val loaders: List<LoaderSpinner> = emptyList()
-) : HasModals<ScrimContainerScreen<OverviewDetailScreen>, LoaderSpinner> {
-  override val beneathModals: ScrimContainerScreen<OverviewDetailScreen>
-    get() = ScrimContainerScreen(
-      wrapped = baseScreen,
-      dimmed = loaders.isNotEmpty()
-    )
-  override val modals: List<LoaderSpinner>
-    get() = loaders
+typealias MayBeLoadingScreen =
+  BodyAndModalsScreen<ScrimScreen<OverviewDetailScreen>, ModalScreenOverlay<LoaderSpinner>>
+
+@OptIn(WorkflowUiExperimentalApi::class)
+fun MayBeLoadingScreen(
+  baseScreen: OverviewDetailScreen,
+  loaders: List<LoaderSpinner> = emptyList()
+): MayBeLoadingScreen {
+  return BodyAndModalsScreen(
+    ScrimScreen(baseScreen, dimmed = loaders.isNotEmpty()),
+    loaders.map { ModalScreenOverlay(it) }
+  )
 }
+
+@OptIn(WorkflowUiExperimentalApi::class)
+val MayBeLoadingScreen.baseScreen: OverviewDetailScreen
+  get() = body.content
+
+@OptIn(WorkflowUiExperimentalApi::class)
+val MayBeLoadingScreen.loaders: List<LoaderSpinner>
+  get() = modals.map { it.content }