Fix empty form in vertical mode when there are no form elements. (#11582)

* Fix empty form in vertical mode when there are no form elements.

* Move logic for deciding header information into state

* Update `VerticalModeInitialScreenFactoryTest`

Author: samer-stripe

paymentsheet/src/main/java/com/stripe/android/paymentelement/embedded/form/EmbeddedFormInteractorFactory.kt

@@ -14,6 +14,7 @@ import com.stripe.android.paymentsheet.ui.transformToPaymentSelection
 import com.stripe.android.paymentsheet.verticalmode.DefaultVerticalModeFormInteractor
 import com.stripe.android.paymentsheet.verticalmode.PaymentMethodIncentiveInteractor
 import com.stripe.android.uicore.utils.mapAsStateFlow
+import com.stripe.android.uicore.utils.stateFlowOf
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.MutableSharedFlow
@@ -81,6 +82,8 @@ internal class EmbeddedFormInteractorFactory @Inject constructor(
             ),
             isLiveMode = paymentMethodMetadata.stripeIntent.isLiveMode,
             processing = formActivityStateHelper.state.mapAsStateFlow { it.isProcessing },
+            // Should never show wallets header in Embedded form
+            showsWalletHeader = stateFlowOf(false),
             paymentMethodIncentive = PaymentMethodIncentiveInteractor(
                 paymentMethodMetadata.paymentMethodIncentive
             ).displayedIncentive,

paymentsheet/src/main/java/com/stripe/android/paymentelement/embedded/form/FormActivityUI.kt

@@ -61,7 +61,6 @@ internal fun FormActivityUI(
             content = {
                 VerticalModeFormUI(
                     interactor = interactor,
-                    showsWalletHeader = false
                 )
                 USBankAccountMandate(state)
                 FormActivityError(state)

paymentsheet/src/main/java/com/stripe/android/paymentsheet/navigation/PaymentSheetScreen.kt

@@ -328,7 +328,6 @@ internal sealed interface PaymentSheetScreen {
 
     class VerticalModeForm(
         private val interactor: VerticalModeFormInteractor,
-        private val showsWalletHeader: Boolean = false,
     ) : PaymentSheetScreen, Closeable {
 
         override val buyButtonState = stateFlowOf(
@@ -354,12 +353,12 @@ internal sealed interface PaymentSheetScreen {
         }
 
         override fun showsWalletsHeader(isCompleteFlow: Boolean): StateFlow<Boolean> {
-            return stateFlowOf(showsWalletHeader)
+            return interactor.state.mapAsStateFlow { it.showsWalletHeader }
         }
 
         @Composable
         override fun Content(modifier: Modifier) {
-            VerticalModeFormUI(interactor, showsWalletHeader, modifier)
+            VerticalModeFormUI(interactor, modifier)
         }
 
         override fun close() {

paymentsheet/src/main/java/com/stripe/android/paymentsheet/verticalmode/VerticalModeFormInteractor.kt

@@ -12,6 +12,7 @@ import com.stripe.android.paymentsheet.paymentdatacollection.ach.USBankAccountFo
 import com.stripe.android.paymentsheet.viewmodels.BaseSheetViewModel
 import com.stripe.android.uicore.elements.FormElement
 import com.stripe.android.uicore.utils.combineAsStateFlow
+import com.stripe.android.uicore.utils.mapAsStateFlow
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.SupervisorJob
@@ -38,9 +39,15 @@ internal interface VerticalModeFormInteractor {
         private val isValidating: Boolean,
         val usBankAccountFormArguments: USBankAccountFormArguments,
         val formArguments: FormArguments,
+        val showsWalletHeader: Boolean,
         private val formElements: List<FormElement>,
-        val headerInformation: FormHeaderInformation?,
+        private val paymentMethodIncentive: PaymentMethodIncentive?,
+        private val headerInformation: FormHeaderInformation?,
     ) {
+        val formHeader = headerInformation?.copy(
+            promoBadge = paymentMethodIncentive?.takeIfMatches(selectedPaymentMethodCode)?.displayText,
+        )?.takeIf { !showsWalletHeader }
+
         val formUiElements = formElements.onEach { element ->
             element.onValidationStateChanged(isValidating)
         }
@@ -59,6 +66,7 @@ internal class DefaultVerticalModeFormInteractor(
     private val onFormFieldValuesChanged: (formValues: FormFieldValues?, selectedPaymentMethodCode: String) -> Unit,
     private val usBankAccountArguments: USBankAccountFormArguments,
     private val reportFieldInteraction: (String) -> Unit,
+    private val showsWalletHeader: StateFlow<Boolean>,
     private val headerInformation: FormHeaderInformation?,
     override val isLiveMode: Boolean,
     processing: StateFlow<Boolean>,
@@ -73,17 +81,18 @@ internal class DefaultVerticalModeFormInteractor(
         processing,
         paymentMethodIncentive,
         isValidating,
-    ) { isProcessing, paymentMethodIncentive, isValidating ->
+        showsWalletHeader,
+    ) { isProcessing, paymentMethodIncentive, isValidating, showsWalletHeader ->
         VerticalModeFormInteractor.State(
             selectedPaymentMethodCode = selectedPaymentMethodCode,
             isProcessing = isProcessing,
             usBankAccountFormArguments = usBankAccountArguments,
             formArguments = formArguments,
             formElements = formElements,
             isValidating = isValidating,
-            headerInformation = headerInformation?.copy(
-                promoBadge = paymentMethodIncentive?.takeIfMatches(selectedPaymentMethodCode)?.displayText,
-            ),
+            showsWalletHeader = showsWalletHeader,
+            paymentMethodIncentive = paymentMethodIncentive,
+            headerInformation = headerInformation,
         )
     }
 
@@ -138,6 +147,7 @@ internal class DefaultVerticalModeFormInteractor(
                     selectedPaymentMethodCode = selectedPaymentMethodCode,
                     bankFormInteractor = bankFormInteractor,
                 ),
+                showsWalletHeader = viewModel.walletsState.mapAsStateFlow { it != null },
                 headerInformation = paymentMethodMetadata.formHeaderInformationForCode(
                     selectedPaymentMethodCode,
                     customerHasSavedPaymentMethods = customerStateHolder.paymentMethods.value.any {

paymentsheet/src/main/java/com/stripe/android/paymentsheet/verticalmode/VerticalModeFormUI.kt

@@ -34,7 +34,6 @@ const val TEST_TAG_HEADER_TITLE = "TEST_TAG_HEADER_TITLE"
 @Composable
 internal fun VerticalModeFormUI(
     interactor: VerticalModeFormInteractor,
-    showsWalletHeader: Boolean,
     modifier: Modifier = Modifier
 ) {
     val horizontalPadding = StripeTheme.getOuterFormInsets()
@@ -43,9 +42,9 @@ internal fun VerticalModeFormUI(
     val state by interactor.state.collectAsState()
 
     Column(modifier) {
-        val headerInformation = state.headerInformation
+        val headerInformation = state.formHeader
         val enabled = !state.isProcessing
-        if (headerInformation != null && !showsWalletHeader) {
+        if (headerInformation != null) {
             VerticalModeFormHeaderUI(isEnabled = enabled, formHeaderInformation = headerInformation)
         }
 

paymentsheet/src/main/java/com/stripe/android/paymentsheet/verticalmode/VerticalModeInitialScreenFactory.kt

@@ -16,8 +16,13 @@ internal object VerticalModeInitialScreenFactory {
     ): List<PaymentSheetScreen> {
         val supportedPaymentMethodTypes = paymentMethodMetadata.supportedPaymentMethodTypes()
         val bankFormInteractor = BankFormInteractor.create(viewModel)
+        val formHelper = DefaultFormHelper.create(viewModel, paymentMethodMetadata)
 
-        if (supportedPaymentMethodTypes.size == 1 && customerStateHolder.paymentMethods.value.isEmpty()) {
+        if (
+            supportedPaymentMethodTypes.size == 1 &&
+            customerStateHolder.paymentMethods.value.isEmpty() &&
+            formHelper.formTypeForCode(supportedPaymentMethodTypes[0]) == FormHelper.FormType.UserInteractionRequired
+        ) {
             return listOf(
                 PaymentSheetScreen.VerticalModeForm(
                     interactor = DefaultVerticalModeFormInteractor.create(
@@ -27,7 +32,6 @@ internal object VerticalModeInitialScreenFactory {
                         customerStateHolder = customerStateHolder,
                         bankFormInteractor = bankFormInteractor,
                     ),
-                    showsWalletHeader = true,
                 )
             )
         }
@@ -45,8 +49,6 @@ internal object VerticalModeInitialScreenFactory {
             (viewModel.selection.value as? PaymentSelection.New?)?.let { newPaymentSelection ->
                 val paymentMethodCode = newPaymentSelection.paymentMethodCreateParams.typeCode
 
-                val formHelper = DefaultFormHelper.create(viewModel, paymentMethodMetadata)
-
                 if (formHelper.formTypeForCode(paymentMethodCode) == FormHelper.FormType.UserInteractionRequired) {
                     add(
                         PaymentSheetScreen.VerticalModeForm(

paymentsheet/src/test/java/com/stripe/android/paymentsheet/navigation/PaymentSheetScreenVerticalModeFormTest.kt

@@ -2,6 +2,8 @@ package com.stripe.android.paymentsheet.navigation
 
 import app.cash.turbine.test
 import com.google.common.truth.Truth.assertThat
+import com.stripe.android.lpmfoundations.paymentmethod.PaymentMethodMetadataFactory
+import com.stripe.android.paymentsheet.forms.FormArgumentsFactory
 import com.stripe.android.paymentsheet.verticalmode.VerticalModeFormInteractor
 import com.stripe.android.uicore.utils.stateFlowOf
 import kotlinx.coroutines.flow.StateFlow
@@ -43,6 +45,58 @@ internal class PaymentSheetScreenVerticalModeFormTest {
         assertThat(hasCalledOnClose).isTrue()
     }
 
+    @Test
+    fun `showWalletsHeader is true when interactor state is true`() = runTest {
+        val interactor = FakeVerticalModeFormInteractor(
+            state = stateFlowOf(
+                VerticalModeFormInteractor.State(
+                    selectedPaymentMethodCode = "card",
+                    isProcessing = false,
+                    isValidating = false,
+                    usBankAccountFormArguments = mock(),
+                    formArguments = FormArgumentsFactory.create(
+                        paymentMethodCode = "card",
+                        metadata = PaymentMethodMetadataFactory.create(),
+                    ),
+                    formElements = emptyList(),
+                    showsWalletHeader = false,
+                    paymentMethodIncentive = null,
+                    headerInformation = null,
+                )
+            )
+        )
+
+        PaymentSheetScreen.VerticalModeForm(interactor).showsWalletsHeader(isCompleteFlow = true).test {
+            assertThat(awaitItem()).isFalse()
+        }
+    }
+
+    @Test
+    fun `showWalletsHeader is false when interactor state is false`() = runTest {
+        val interactor = FakeVerticalModeFormInteractor(
+            state = stateFlowOf(
+                VerticalModeFormInteractor.State(
+                    selectedPaymentMethodCode = "card",
+                    isProcessing = false,
+                    isValidating = false,
+                    usBankAccountFormArguments = mock(),
+                    formArguments = FormArgumentsFactory.create(
+                        paymentMethodCode = "card",
+                        metadata = PaymentMethodMetadataFactory.create(),
+                    ),
+                    formElements = emptyList(),
+                    showsWalletHeader = true,
+                    paymentMethodIncentive = null,
+                    headerInformation = null,
+                )
+            )
+        )
+
+        PaymentSheetScreen.VerticalModeForm(interactor).showsWalletsHeader(isCompleteFlow = true).test {
+            assertThat(awaitItem()).isTrue()
+        }
+    }
+
     private class FakeVerticalModeFormInteractor(
         override val state: StateFlow<VerticalModeFormInteractor.State> = stateFlowOf(mock()),
         override val isLiveMode: Boolean = false,

paymentsheet/src/test/java/com/stripe/android/paymentsheet/verticalmode/DefaultVerticalModeFormInteractorTest.kt

@@ -8,6 +8,7 @@ import com.google.common.truth.Truth.assertThat
 import com.stripe.android.core.strings.resolvableString
 import com.stripe.android.core.utils.FeatureFlags
 import com.stripe.android.isInstanceOf
+import com.stripe.android.lpmfoundations.FormHeaderInformation
 import com.stripe.android.lpmfoundations.paymentmethod.PaymentMethodMetadataFactory
 import com.stripe.android.lpmfoundations.paymentmethod.PaymentMethodSaveConsentBehavior
 import com.stripe.android.model.PaymentMethodFixtures
@@ -234,6 +235,62 @@ internal class DefaultVerticalModeFormInteractorTest {
         FeatureFlags.cardScanGooglePayMigration.setEnabled(false)
     }
 
+    @Test
+    fun `'headerInformation' is not null if 'showWalletsHeaders' is false`() {
+        val headerInformation = FormHeaderInformation(
+            displayName = "Card".resolvableString,
+            shouldShowIcon = false,
+            iconResource = 0,
+            iconResourceNight = null,
+            lightThemeIconUrl = null,
+            darkThemeIconUrl = null,
+            iconRequiresTinting = false,
+            promoBadge = null,
+        )
+
+        runScenario(
+            selectedPaymentMethodCode = "card",
+            headerInformation = headerInformation,
+        ) {
+            showWalletsHeaderSource.emit(false)
+
+            interactor.state.test {
+                val state = awaitItem()
+
+                assertThat(state.showsWalletHeader).isFalse()
+                assertThat(state.formHeader).isEqualTo(headerInformation)
+            }
+        }
+    }
+
+    @Test
+    fun `'headerInformation' is null if 'showWalletsHeaders' is true`() {
+        val headerInformation = FormHeaderInformation(
+            displayName = "Card".resolvableString,
+            shouldShowIcon = false,
+            iconResource = 0,
+            iconResourceNight = null,
+            lightThemeIconUrl = null,
+            darkThemeIconUrl = null,
+            iconRequiresTinting = false,
+            promoBadge = null,
+        )
+
+        runScenario(
+            selectedPaymentMethodCode = "card",
+            headerInformation = headerInformation,
+        ) {
+            showWalletsHeaderSource.emit(true)
+
+            interactor.state.test {
+                val state = awaitItem()
+
+                assertThat(state.showsWalletHeader).isTrue()
+                assertThat(state.formHeader).isNull()
+            }
+        }
+    }
+
     private fun testSetAsDefaultElements(
         hasSavedPaymentMethods: Boolean,
         block: (SaveForFutureUseElement?, SetAsDefaultPaymentMethodElement?) -> Unit
@@ -328,11 +385,13 @@ internal class DefaultVerticalModeFormInteractorTest {
     private fun runScenario(
         selectedPaymentMethodCode: String,
         formElements: List<FormElement> = emptyList(),
+        headerInformation: FormHeaderInformation? = null,
         testBlock: suspend TestParams.() -> Unit,
     ) {
         val formArguments = mock<FormArguments>()
         val usBankAccountArguments = mock<USBankAccountFormArguments>()
         val processing: MutableStateFlow<Boolean> = MutableStateFlow(false)
+        val showWalletsHeader: MutableStateFlow<Boolean> = MutableStateFlow(false)
         val validationRequested = MutableSharedFlow<Unit>()
 
         val onFormFieldValuesChangedTurbine = Turbine<Pair<FormFieldValues?, String>>()
@@ -349,18 +408,20 @@ internal class DefaultVerticalModeFormInteractorTest {
             reportFieldInteraction = {
                 reportFieldInteractionTurbine.add(it)
             },
-            headerInformation = null,
+            headerInformation = headerInformation,
             isLiveMode = true,
             processing = processing,
             validationRequested = validationRequested,
             coroutineScope = CoroutineScope(UnconfinedTestDispatcher()),
             paymentMethodIncentive = stateFlowOf(null),
+            showsWalletHeader = showWalletsHeader,
             uiContext = UnconfinedTestDispatcher(),
         )
 
         TestParams(
             interactor = interactor,
             processingSource = processing,
+            showWalletsHeaderSource = showWalletsHeader,
             validationRequestedSource = validationRequested,
             onFormFieldValuesChangedTurbine = onFormFieldValuesChangedTurbine,
             reportFieldInteractionTurbine = reportFieldInteractionTurbine,
@@ -378,6 +439,7 @@ internal class DefaultVerticalModeFormInteractorTest {
     private class TestParams(
         val interactor: DefaultVerticalModeFormInteractor,
         val processingSource: MutableStateFlow<Boolean>,
+        val showWalletsHeaderSource: MutableStateFlow<Boolean>,
         val validationRequestedSource: MutableSharedFlow<Unit>,
         val onFormFieldValuesChangedTurbine: ReceiveTurbine<Pair<FormFieldValues?, String>>,
         val reportFieldInteractionTurbine: ReceiveTurbine<String>,

paymentsheet/src/test/java/com/stripe/android/paymentsheet/verticalmode/FakeVerticalModeFormInteractor.kt

@@ -29,6 +29,7 @@ internal class FakeVerticalModeFormInteractor private constructor(
             metadata: PaymentMethodMetadata,
             isProcessing: Boolean = false,
             isValidating: Boolean = false,
+            showsWalletHeader: Boolean = false,
         ): VerticalModeFormInteractor {
             val formArguments = FormArgumentsFactory.create(
                 paymentMethodCode = paymentMethodCode,
@@ -53,6 +54,8 @@ internal class FakeVerticalModeFormInteractor private constructor(
                         uiDefinitionFactoryArgumentsFactory = uiDefinitionArgumentsFactory,
                     )!!,
                     isValidating = isValidating,
+                    showsWalletHeader = showsWalletHeader,
+                    paymentMethodIncentive = null,
                     headerInformation = metadata.formHeaderInformationForCode(
                         code = paymentMethodCode,
                         customerHasSavedPaymentMethods = false,

paymentsheet/src/test/java/com/stripe/android/paymentsheet/verticalmode/VerticalModeFormUIScreenshotTest.kt

@@ -368,8 +368,8 @@ internal class VerticalModeFormUIScreenshotTest {
             FakeVerticalModeFormInteractor.create(
                 paymentMethodCode = "card",
                 metadata = metadata,
+                showsWalletHeader = true,
             ),
-            showsWalletHeader = true,
         )
         val viewModel = FakeBaseSheetViewModel.create(metadata, initialScreen, canGoBack = false)
         viewModel.walletsStateSource.value = WalletsState(
@@ -464,8 +464,8 @@ internal class VerticalModeFormUIScreenshotTest {
                     paymentMethodCode = paymentMethodCode,
                     metadata = metadata,
                     isProcessing = isProcessing,
+                    showsWalletHeader = showsWalletHeader,
                 ),
-                showsWalletHeader = showsWalletHeader,
             )
         }
     }