Improve prefill in bank flows (#9518)

* Prefill email and phone number in bank flows * Tweak code and address test issue
stripe · Oct 29, 2024 · 64142f2 · 64142f2
1 parent 0f3d653
commit 64142f2
Show file tree

Hide file tree

Showing 16 changed files with 191 additions and 20 deletions.
diff --git a/...om/stripe/android/financialconnections/example/FinancialConnectionsPlaygroundViewModel.kt b/...om/stripe/android/financialconnections/example/FinancialConnectionsPlaygroundViewModel.kt
@@ -140,6 +140,11 @@ internal class FinancialConnectionsPlaygroundViewModel(
                                 billingDetails = ElementsSessionContext.BillingDetails(
                                     email = settings.get<EmailSetting>().selectedOption,
                                 ),
+                                prefillDetails = ElementsSessionContext.PrefillDetails(
+                                    email = settings.get<EmailSetting>().selectedOption,
+                                    phone = null,
+                                    phoneCountryCode = null,
+                                ),
                             ),
                             experience = settings.get<ExperienceSetting>().selectedOption,
                             integrationType = settings.get<IntegrationTypeSetting>().selectedOption,

diff --git a/financial-connections/api/financial-connections.api b/financial-connections/api/financial-connections.api
@@ -193,6 +193,14 @@ public final class com/stripe/android/financialconnections/FinancialConnectionsS
 	public synthetic fun newArray (I)[Ljava/lang/Object;
 }
 
+public final class com/stripe/android/financialconnections/FinancialConnectionsSheet$ElementsSessionContext$PrefillDetails$Creator : android/os/Parcelable$Creator {
+	public fun <init> ()V
+	public final fun createFromParcel (Landroid/os/Parcel;)Lcom/stripe/android/financialconnections/FinancialConnectionsSheet$ElementsSessionContext$PrefillDetails;
+	public synthetic fun createFromParcel (Landroid/os/Parcel;)Ljava/lang/Object;
+	public final fun newArray (I)[Lcom/stripe/android/financialconnections/FinancialConnectionsSheet$ElementsSessionContext$PrefillDetails;
+	public synthetic fun newArray (I)[Ljava/lang/Object;
+}
+
 public final class com/stripe/android/financialconnections/FinancialConnectionsSheetComposeKt {
 	public static final fun rememberFinancialConnectionsSheet (Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;I)Lcom/stripe/android/financialconnections/FinancialConnectionsSheet;
 	public static final fun rememberFinancialConnectionsSheetForToken (Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;I)Lcom/stripe/android/financialconnections/FinancialConnectionsSheet;

diff --git a/...ctions/src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheet.kt b/...ctions/src/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheet.kt
@@ -47,6 +47,7 @@ class FinancialConnectionsSheet internal constructor(
         val currency: String?,
         val linkMode: LinkMode?,
         val billingDetails: BillingDetails?,
+        val prefillDetails: PrefillDetails,
     ) : Parcelable {
 
         val paymentIntentId: String?
@@ -91,6 +92,14 @@ class FinancialConnectionsSheet internal constructor(
                 val country: String? = null,
             ) : Parcelable
         }
+
+        @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+        @Parcelize
+        data class PrefillDetails(
+            val email: String?,
+            val phone: String?,
+            val phoneCountryCode: String?,
+        ) : Parcelable
     }
 
     /**

diff --git a/...c/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetViewModel.kt b/...c/main/java/com/stripe/android/financialconnections/FinancialConnectionsSheetViewModel.kt
@@ -54,7 +54,6 @@ import com.stripe.android.financialconnections.navigation.topappbar.TopAppBarSta
 import com.stripe.android.financialconnections.presentation.FinancialConnectionsViewModel
 import com.stripe.android.financialconnections.ui.FinancialConnectionsSheetNativeActivity
 import com.stripe.android.financialconnections.utils.parcelable
-import com.stripe.android.model.LinkMode
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.sync.Mutex
 import kotlinx.coroutines.sync.withLock
@@ -128,16 +127,13 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
             logNoBrowserAvailableAndFinish()
             return
         }
+
         val manifest = sync.manifest
-        val isInstantDebits = stateFlow.value.isInstantDebits
         val nativeAuthFlowEnabled = nativeRouter.nativeAuthFlowEnabled(manifest)
         nativeRouter.logExposure(manifest)
 
-        val linkMode = initialState.initialArgs.elementsSessionContext?.linkMode
         val hostedAuthUrl = buildHostedAuthUrl(
             hostedAuthUrl = manifest.hostedAuthUrl,
-            isInstantDebits = isInstantDebits,
-            linkMode = linkMode,
         )
         if (hostedAuthUrl == null) {
             finishWithResult(
@@ -171,15 +167,15 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
         }
     }
 
-    private fun buildHostedAuthUrl(
-        hostedAuthUrl: String?,
-        isInstantDebits: Boolean,
-        linkMode: LinkMode?,
-    ): String? {
+    private fun buildHostedAuthUrl(hostedAuthUrl: String?): String? {
         if (hostedAuthUrl == null) {
             return null
         }
 
+        val isInstantDebits = stateFlow.value.isInstantDebits
+        val elementsSessionContext = initialState.initialArgs.elementsSessionContext
+        val linkMode = elementsSessionContext?.linkMode
+
         val queryParams = mutableListOf(hostedAuthUrl)
         if (isInstantDebits) {
             // For Instant Debits, add a query parameter to the hosted auth URL so that payment account creation
@@ -188,6 +184,12 @@ internal class FinancialConnectionsSheetViewModel @Inject constructor(
             linkMode?.let { queryParams.add("link_mode=${it.value}") }
         }
 
+        elementsSessionContext?.prefillDetails?.run {
+            email?.let { queryParams.add("email=$it") }
+            phone?.let { queryParams.add("linkMobilePhone=$it") }
+            phoneCountryCode?.let { queryParams.add("linkMobilePhoneCountry=$it") }
+        }
+
         return queryParams.joinToString("&")
     }
 

diff --git a/.../android/financialconnections/features/networkinglinksignup/NetworkingLinkSignupScreen.kt b/.../android/financialconnections/features/networkinglinksignup/NetworkingLinkSignupScreen.kt
@@ -151,7 +151,9 @@ private fun NetworkingLinkSignupLoaded(
     LaunchedEffect(showFullForm) {
         if (showFullForm) {
             scrollState.animateScrollToBottom()
-            phoneNumberFocusRequester.requestFocus()
+            if (payload.focusPhoneFieldOnShow) {
+                phoneNumberFocusRequester.requestFocus()
+            }
         }
     }
 

diff --git a/...droid/financialconnections/features/networkinglinksignup/NetworkingLinkSignupViewModel.kt b/...droid/financialconnections/features/networkinglinksignup/NetworkingLinkSignupViewModel.kt
@@ -6,6 +6,7 @@ import androidx.lifecycle.viewModelScope
 import androidx.lifecycle.viewmodel.initializer
 import androidx.lifecycle.viewmodel.viewModelFactory
 import com.stripe.android.core.Logger
+import com.stripe.android.financialconnections.FinancialConnectionsSheet.ElementsSessionContext
 import com.stripe.android.financialconnections.R
 import com.stripe.android.financialconnections.analytics.FinancialConnectionsAnalyticsEvent.Click
 import com.stripe.android.financialconnections.analytics.FinancialConnectionsAnalyticsEvent.NetworkingNewConsumer
@@ -68,6 +69,7 @@ internal class NetworkingLinkSignupViewModel @AssistedInject constructor(
     private val logger: Logger,
     private val presentSheet: PresentSheet,
     private val linkSignupHandler: LinkSignupHandler,
+    private val elementsSessionContext: ElementsSessionContext?,
 ) : FinancialConnectionsViewModel<NetworkingLinkSignupState>(initialState, nativeAuthFlowCoordinator) {
 
     private val pane: Pane
@@ -93,16 +95,19 @@ internal class NetworkingLinkSignupViewModel @AssistedInject constructor(
 
             eventTracker.track(PaneLoaded(pane))
 
+            val prefillDetails = elementsSessionContext?.prefillDetails
+
             NetworkingLinkSignupState.Payload(
                 content = requireNotNull(content),
                 merchantName = sync.manifest.getBusinessName(),
                 emailController = SimpleTextFieldController(
                     textFieldConfig = EmailConfig(label = R.string.stripe_networking_signup_email_label),
-                    initialValue = sync.manifest.accountholderCustomerEmailAddress,
+                    initialValue = sync.manifest.accountholderCustomerEmailAddress ?: prefillDetails?.email,
                     showOptionalLabel = false
                 ),
                 phoneController = PhoneNumberController.createPhoneNumberController(
-                    initialValue = sync.manifest.accountholderPhoneNumber ?: "",
+                    initialValue = sync.manifest.accountholderPhoneNumber ?: prefillDetails?.phone ?: "",
+                    initiallySelectedCountryCode = prefillDetails?.phoneCountryCode,
                 ),
                 isInstantDebits = initialState.isInstantDebits,
             )
@@ -340,6 +345,9 @@ internal data class NetworkingLinkSignupState(
 
         val focusEmailField: Boolean
             get() = isInstantDebits && emailController.initialValue.isNullOrBlank()
+
+        val focusPhoneFieldOnShow: Boolean
+            get() = phoneController.initialPhoneNumber.isBlank()
     }
 
     data class Content(

diff --git a/...com/stripe/android/financialconnections/launcher/FinancialConnectionsSheetActivityArgs.kt b/...com/stripe/android/financialconnections/launcher/FinancialConnectionsSheetActivityArgs.kt
@@ -20,14 +20,16 @@ sealed class FinancialConnectionsSheetActivityArgs(
     @Parcelize
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     data class ForData(
-        override val configuration: FinancialConnectionsSheet.Configuration
-    ) : FinancialConnectionsSheetActivityArgs(configuration, elementsSessionContext = null)
+        override val configuration: FinancialConnectionsSheet.Configuration,
+        override val elementsSessionContext: FinancialConnectionsSheet.ElementsSessionContext? = null,
+    ) : FinancialConnectionsSheetActivityArgs(configuration, elementsSessionContext)
 
     @Parcelize
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     data class ForToken(
-        override val configuration: FinancialConnectionsSheet.Configuration
-    ) : FinancialConnectionsSheetActivityArgs(configuration, elementsSessionContext = null)
+        override val configuration: FinancialConnectionsSheet.Configuration,
+        override val elementsSessionContext: FinancialConnectionsSheet.ElementsSessionContext? = null,
+    ) : FinancialConnectionsSheetActivityArgs(configuration, elementsSessionContext)
 
     @Parcelize
     @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)

diff --git a/.../stripe/android/financialconnections/launcher/FinancialConnectionsSheetForDataLauncher.kt b/.../stripe/android/financialconnections/launcher/FinancialConnectionsSheetForDataLauncher.kt
@@ -56,7 +56,8 @@ class FinancialConnectionsSheetForDataLauncher(
     ) {
         activityResultLauncher.launch(
             FinancialConnectionsSheetActivityArgs.ForData(
-                configuration
+                configuration = configuration,
+                elementsSessionContext = elementsSessionContext,
             )
         )
     }

diff --git a/...stripe/android/financialconnections/launcher/FinancialConnectionsSheetForTokenLauncher.kt b/...stripe/android/financialconnections/launcher/FinancialConnectionsSheetForTokenLauncher.kt
@@ -54,7 +54,8 @@ internal class FinancialConnectionsSheetForTokenLauncher(
     ) {
         activityResultLauncher.launch(
             FinancialConnectionsSheetActivityArgs.ForToken(
-                configuration
+                configuration = configuration,
+                elementsSessionContext = elementsSessionContext,
             )
         )
     }

diff --git a/...ripe/android/financialconnections/launcher/FinancialConnectionsSheetNativeActivityArgs.kt b/...ripe/android/financialconnections/launcher/FinancialConnectionsSheetNativeActivityArgs.kt
@@ -6,7 +6,7 @@ import com.stripe.android.financialconnections.model.SynchronizeSessionResponse
 import kotlinx.parcelize.Parcelize
 
 @Parcelize
-internal data class FinancialConnectionsSheetNativeActivityArgs constructor(
+internal data class FinancialConnectionsSheetNativeActivityArgs(
     val configuration: FinancialConnectionsSheet.Configuration,
     val initialSyncResponse: SynchronizeSessionResponse,
     val elementsSessionContext: FinancialConnectionsSheet.ElementsSessionContext? = null,

diff --git a/...st/java/com/stripe/android/financialconnections/FinancialConnectionsSheetViewModelTest.kt b/...st/java/com/stripe/android/financialconnections/FinancialConnectionsSheetViewModelTest.kt
@@ -150,6 +150,11 @@ class FinancialConnectionsSheetViewModelTest {
                             currency = "usd",
                             linkMode = LinkMode.LinkPaymentMethod,
                             billingDetails = null,
+                            prefillDetails = ElementsSessionContext.PrefillDetails(
+                                email = null,
+                                phone = null,
+                                phoneCountryCode = null,
+                            )
                         ),
                     )
                 )
@@ -182,6 +187,11 @@ class FinancialConnectionsSheetViewModelTest {
                         currency = "usd",
                         linkMode = null,
                         billingDetails = null,
+                        prefillDetails = ElementsSessionContext.PrefillDetails(
+                            email = null,
+                            phone = null,
+                            phoneCountryCode = null,
+                        )
                     ),
                 )
             )
@@ -196,6 +206,47 @@ class FinancialConnectionsSheetViewModelTest {
         }
     }
 
+    @Test
+    fun `init - hosted auth url contains prefill details`() = runTest {
+        // Given
+        whenever(browserManager.canOpenHttpsUrl()).thenReturn(true)
+        whenever(getOrFetchSync(any())).thenReturn(syncResponse)
+        whenever(nativeRouter.nativeAuthFlowEnabled(any())).thenReturn(false)
+
+        // When
+        val viewModel = createViewModel(
+            defaultInitialState.copy(
+                initialArgs = ForInstantDebits(
+                    configuration = configuration,
+                    elementsSessionContext = ElementsSessionContext(
+                        initializationMode = ElementsSessionContext.InitializationMode.PaymentIntent("pi_123"),
+                        amount = 123,
+                        currency = "usd",
+                        linkMode = null,
+                        billingDetails = null,
+                        prefillDetails = ElementsSessionContext.PrefillDetails(
+                            email = "email@email.com",
+                            phone = "5555551234",
+                            phoneCountryCode = "US",
+                        )
+                    ),
+                )
+            )
+        )
+
+        // Then
+        withState(viewModel) {
+            val viewEffect = it.viewEffect as OpenAuthFlowWithUrl
+            assertThat(viewEffect.url).isEqualTo(
+                syncResponse.manifest.hostedAuthUrl +
+                    "&return_payment_method=true" +
+                    "&email=email@email.com" +
+                    "&linkMobilePhone=5555551234" +
+                    "&linkMobilePhoneCountry=US"
+            )
+        }
+    }
+
     @Test
     fun `init - when data flow and non-native, hosted auth url without query params is launched`() = runTest {
         // Given

diff --git a/.../java/com/stripe/android/financialconnections/domain/RealCreateInstantDebitsResultTest.kt b/.../java/com/stripe/android/financialconnections/domain/RealCreateInstantDebitsResultTest.kt
@@ -219,6 +219,11 @@ class RealCreateInstantDebitsResultTest {
             currency = "usd",
             linkMode = linkMode,
             billingDetails = billingDetails,
+            prefillDetails = ElementsSessionContext.PrefillDetails(
+                email = null,
+                phone = null,
+                phoneCountryCode = null,
+            )
         )
     }
 }
diff --git a/...d/financialconnections/features/networkinglinksignup/NetworkingLinkSignupViewModelTest.kt b/...d/financialconnections/features/networkinglinksignup/NetworkingLinkSignupViewModelTest.kt
@@ -9,6 +9,8 @@ import com.stripe.android.financialconnections.ApiKeyFixtures.consumerSessionSig
 import com.stripe.android.financialconnections.ApiKeyFixtures.sessionManifest
 import com.stripe.android.financialconnections.ApiKeyFixtures.syncResponse
 import com.stripe.android.financialconnections.CoroutineTestRule
+import com.stripe.android.financialconnections.FinancialConnectionsSheet.ElementsSessionContext
+import com.stripe.android.financialconnections.FinancialConnectionsSheet.ElementsSessionContext.InitializationMode
 import com.stripe.android.financialconnections.TestFinancialConnectionsAnalyticsTracker
 import com.stripe.android.financialconnections.analytics.FinancialConnectionsAnalyticsEvent.ConsentAgree.analyticsValue
 import com.stripe.android.financialconnections.domain.GetCachedAccounts
@@ -32,6 +34,7 @@ import com.stripe.android.financialconnections.repository.FinancialConnectionsCo
 import com.stripe.android.financialconnections.utils.TestHandleError
 import com.stripe.android.financialconnections.utils.UriUtils
 import com.stripe.android.model.ConsumerSessionLookup
+import com.stripe.android.model.LinkMode
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.test.runTest
 import org.junit.Rule
@@ -58,6 +61,7 @@ class NetworkingLinkSignupViewModelTest {
     private fun buildViewModel(
         state: NetworkingLinkSignupState,
         signupHandler: LinkSignupHandler = mockLinkSignupHandlerForNetworking(),
+        elementsSessionContext: ElementsSessionContext? = null,
     ) = NetworkingLinkSignupViewModel(
         getOrFetchSync = getOrFetchSync,
         logger = Logger.noop(),
@@ -69,6 +73,7 @@ class NetworkingLinkSignupViewModelTest {
         nativeAuthFlowCoordinator = nativeAuthFlowCoordinator,
         presentSheet = mock(),
         linkSignupHandler = signupHandler,
+        elementsSessionContext = elementsSessionContext,
     )
 
     @Test
@@ -95,6 +100,44 @@ class NetworkingLinkSignupViewModelTest {
         assertThat(payload.emailController.fieldValue.value).isEqualTo("test@test.com")
     }
 
+    @Test
+    fun `init - creates controllers with Elements billing details`() = runTest {
+        val manifest = sessionManifest()
+
+        whenever(getOrFetchSync(any())).thenReturn(
+            syncResponse().copy(
+                manifest = manifest,
+                text = TextUpdate(
+                    consent = null,
+                    networkingLinkSignupPane = networkingLinkSignupPane(),
+                )
+            )
+        )
+        whenever(lookupAccount(any())).thenReturn(ConsumerSessionLookup(exists = false))
+
+        val viewModel = buildViewModel(
+            state = NetworkingLinkSignupState(),
+            elementsSessionContext = ElementsSessionContext(
+                initializationMode = InitializationMode.PaymentIntent("pi_1234"),
+                amount = null,
+                currency = null,
+                linkMode = LinkMode.LinkPaymentMethod,
+                billingDetails = null,
+                prefillDetails = ElementsSessionContext.PrefillDetails(
+                    email = "email@email.com",
+                    phone = "5555555555",
+                    phoneCountryCode = "US",
+                ),
+            )
+        )
+
+        val state = viewModel.stateFlow.value
+        val payload = requireNotNull(state.payload())
+        assertThat(payload.emailController.fieldValue.value).isEqualTo("email@email.com")
+        assertThat(payload.phoneController.fieldValue.value).isEqualTo("5555555555")
+        assertThat(payload.phoneController.countryDropdownController.rawFieldValue.value).isEqualTo("US")
+    }
+
     @Test
     fun `init - focuses email field if no email provided in Instant Debits flow`() = runTest {
         val manifest = sessionManifest().copy(

diff --git a/.../financialconnections/repository/FinancialConnectionsConsumerSessionRepositoryImplTest.kt b/.../financialconnections/repository/FinancialConnectionsConsumerSessionRepositoryImplTest.kt
@@ -164,6 +164,11 @@ class FinancialConnectionsConsumerSessionRepositoryImplTest {
                 currency = "cad",
                 linkMode = LinkMode.LinkPaymentMethod,
                 billingDetails = null,
+                prefillDetails = ElementsSessionContext.PrefillDetails(
+                    email = null,
+                    phone = null,
+                    phoneCountryCode = null,
+                ),
             )
         )