Merge branch 'v1.8.0-beta10-release'

* v1.8.0-beta10-release:
  Finish releasing v1.8.0-beta10.
  Releasing v1.8.0-beta10
  It is not safe to touch decorView before Dialog.show()
  Preparing v1.8.0-beta10 as a patch on v1.8.0-beta09

Author: rjrjr

gradle.properties

@@ -8,7 +8,7 @@ android.useAndroidX=true
 systemProp.org.gradle.internal.publish.checksums.insecure=true
 
 GROUP=com.squareup.workflow1
-VERSION_NAME=1.8.0-beta10-SNAPSHOT
+VERSION_NAME=1.8.0-beta11-SNAPSHOT
 
 POM_DESCRIPTION=Square Workflow
 

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/DialogOverlay.kt

@@ -6,23 +6,28 @@ import com.squareup.workflow1.ui.R
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 
 /**
- * Returns the most recent [Overlay] rendering [shown][OverlayDialogHolder.show] in this [Dialog],
- * or throws a [NullPointerException] if the receiver was not created via
+ * Returns the most recent [Overlay] rendering [shown][OverlayDialogHolder.show]
+ * in this [Dialog]. Throws a [NullPointerException] if the receiver was not created via
  * [OverlayDialogFactory.buildDialog].
+ *
+ * Note that it is not safe to call this until after the [Dialog] has been shown.
  */
 @WorkflowUiExperimentalApi
-public var Dialog.overlay: Overlay
+internal var Dialog.overlay: Overlay
   get() = checkNotNull(overlayOrNull) {
     "Expected to find an Overlay in tag R.id.workflow_overlay on the decor view of $this"
   }
   internal set(value) = decorView.setTag(R.id.workflow_overlay, value)
 
 /**
- * Returns the most recent [Overlay] rendering [shown][OverlayDialogHolder.show] in this [Dialog],
- * or `null` if the receiver was not created via [OverlayDialogFactory.buildDialog].
+ * Returns the most recent [Overlay] rendering [shown][OverlayDialogHolder.show]
+ * in this [Dialog], or `null` if the receiver was not created via
+ * [OverlayDialogFactory.buildDialog].
+ *
+ * Note that this will return `null` before the [Dialog] is shown.
  */
 @WorkflowUiExperimentalApi
-public val Dialog.overlayOrNull: Overlay?
+internal val Dialog.overlayOrNull: Overlay?
   get() = decorViewOrNull?.getTag(R.id.workflow_overlay) as? Overlay
 
 internal val Dialog.decorView: View

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/DialogSession.kt

@@ -46,6 +46,24 @@ internal class DialogSession(
       }
     }
 
+  /**
+   * Nasty hack to fix https://github.com/square/workflow-kotlin/issues/863.
+   * - [OverlayDialogHolder.canShow] relies on comparing the new [Overlay] to `Dialog.overlay`
+   * - `Dialog.overlay` is written to the decor view
+   * - That normally happens as a side effect of [OverlayDialogHolder.show]
+   * - We have to call [OverlayDialogHolder.show] before `Dialog.show`, so that the `Dialog`
+   *   is initialized before it is shown
+   * - It is dangerous to call `decorView` before `Dialog.show`.
+   *
+   * Fix is that [OverlayDialogHolder.canShow] does not update `Dialog.overlay` if
+   * peekDecorView is null. Which means we have to bootstrap it into place when
+   * we call `Dialog.show`.
+   *
+   * We keep this nullable pointer to the very first [Overlay] so that we can put it
+   * in place, and then drop the reference and avoid leaking.
+   */
+  private var initialOverlay: Overlay? = initialOverlay
+
   /**
    * Wrap the given dialog holder to maintain [allowEvents] on each update.
    */
@@ -92,6 +110,11 @@ internal class DialogSession(
     }
 
     dialog.show()
+    initialOverlay?.let {
+      dialog.overlay = it
+      initialOverlay = null
+    }
+
     dialog.decorView.also { decorView ->
       // Implementations of buildDialog may set their own WorkflowLifecycleOwner on the
       // content view, so to avoid interfering with them we also set it here. When the views

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/container/OverlayDialogHolder.kt

@@ -79,7 +79,15 @@ public fun <OverlayT : Overlay> OverlayDialogHolder<OverlayT>.show(
   // Why is this an extension rather than part of the interface?
   // When wrapping, we need to prevent recursive calls from clobbering
   // `overlayOrNull` with the nested rendering type.
-  dialog.overlay = overlay
+
+  if (dialog.decorViewOrNull != null) {
+    // https://github.com/square/workflow-kotlin/issues/863
+    // This writes to the decor view, which is not safe to do before the
+    // dialog has been shown, because why would it be? (Note that DialogSession
+    // primes the pump for us, setting the first `overlay` value right
+    // after the first call to Dialog.show.)
+    dialog.overlay = overlay
+  }
   runner(overlay, environment)
 }