Move common confirmation option parameters to `ConfirmationHandler.Ar…

…gs` (#9758)
stripe · Dec 9, 2024 · 6749823 · 6749823
1 parent c13fae8
commit 6749823
Show file tree

Hide file tree

Showing 41 changed files with 492 additions and 481 deletions.
diff --git a/paymentsheet/api/paymentsheet.api b/paymentsheet/api/paymentsheet.api
@@ -324,6 +324,14 @@ public final class com/stripe/android/paymentelement/EmbeddedPaymentElement$Conf
 	public synthetic fun newArray (I)[Ljava/lang/Object;
 }
 
+public final class com/stripe/android/paymentelement/confirmation/ConfirmationDefinition$Parameters$Creator : android/os/Parcelable$Creator {
+	public fun <init> ()V
+	public final fun createFromParcel (Landroid/os/Parcel;)Lcom/stripe/android/paymentelement/confirmation/ConfirmationDefinition$Parameters;
+	public synthetic fun createFromParcel (Landroid/os/Parcel;)Ljava/lang/Object;
+	public final fun newArray (I)[Lcom/stripe/android/paymentelement/confirmation/ConfirmationDefinition$Parameters;
+	public synthetic fun newArray (I)[Ljava/lang/Object;
+}
+
 public final class com/stripe/android/paymentelement/confirmation/ConfirmationHandler$Args$Creator : android/os/Parcelable$Creator {
 	public fun <init> ()V
 	public final fun createFromParcel (Landroid/os/Parcel;)Lcom/stripe/android/paymentelement/confirmation/ConfirmationHandler$Args;

diff --git a/paymentsheet/src/main/java/com/stripe/android/customersheet/CustomerSheetViewModel.kt b/paymentsheet/src/main/java/com/stripe/android/customersheet/CustomerSheetViewModel.kt
@@ -1032,15 +1032,16 @@ internal class CustomerSheetViewModel(
     ) {
         confirmationHandler.start(
             arguments = ConfirmationHandler.Args(
-                intent = stripeIntent,
                 confirmationOption = PaymentMethodConfirmationOption.Saved(
-                    initializationMode = PaymentElementLoader.InitializationMode.SetupIntent(
-                        clientSecret = clientSecret
-                    ),
-                    shippingDetails = null,
                     paymentMethod = paymentMethod,
                     optionsParams = null,
                 ),
+                intent = stripeIntent,
+                initializationMode = PaymentElementLoader.InitializationMode.SetupIntent(
+                    clientSecret = clientSecret
+                ),
+                shippingDetails = null,
+                appearance = configuration.appearance,
             )
         )
 

diff --git a/...et/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationDefinition.kt b/...et/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationDefinition.kt
@@ -5,6 +5,10 @@ import androidx.activity.result.ActivityResultCaller
 import com.stripe.android.core.strings.ResolvableString
 import com.stripe.android.model.StripeIntent
 import com.stripe.android.paymentelement.confirmation.intent.DeferredIntentConfirmationType
+import com.stripe.android.paymentsheet.PaymentSheet
+import com.stripe.android.paymentsheet.addresselement.AddressDetails
+import com.stripe.android.paymentsheet.state.PaymentElementLoader
+import kotlinx.parcelize.Parcelize
 
 internal interface ConfirmationDefinition<
     TConfirmationOption : ConfirmationHandler.Option,
@@ -20,14 +24,14 @@ internal interface ConfirmationDefinition<
 
     suspend fun action(
         confirmationOption: TConfirmationOption,
-        intent: StripeIntent,
+        confirmationParameters: Parameters,
     ): Action<TLauncherArgs>
 
     fun launch(
         launcher: TLauncher,
         arguments: TLauncherArgs,
         confirmationOption: TConfirmationOption,
-        intent: StripeIntent,
+        confirmationParameters: Parameters,
     )
 
     fun createLauncher(
@@ -41,11 +45,19 @@ internal interface ConfirmationDefinition<
 
     fun toResult(
         confirmationOption: TConfirmationOption,
+        confirmationParameters: Parameters,
         deferredIntentConfirmationType: DeferredIntentConfirmationType?,
-        intent: StripeIntent,
         result: TLauncherResult,
     ): Result
 
+    @Parcelize
+    data class Parameters(
+        val intent: StripeIntent,
+        val appearance: PaymentSheet.Appearance,
+        val initializationMode: PaymentElementLoader.InitializationMode,
+        val shippingDetails: AddressDetails?
+    ) : Parcelable
+
     sealed interface Result {
         data class Canceled(
             val action: ConfirmationHandler.Result.Canceled.Action,
@@ -57,8 +69,8 @@ internal interface ConfirmationDefinition<
         ) : Result
 
         data class NextStep(
-            val intent: StripeIntent,
             val confirmationOption: ConfirmationHandler.Option,
+            val parameters: Parameters,
         ) : Result
 
         data class Failed(

diff --git a/...sheet/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationHandler.kt b/...sheet/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationHandler.kt
@@ -6,6 +6,9 @@ import androidx.lifecycle.LifecycleOwner
 import com.stripe.android.core.strings.ResolvableString
 import com.stripe.android.model.StripeIntent
 import com.stripe.android.paymentelement.confirmation.intent.DeferredIntentConfirmationType
+import com.stripe.android.paymentsheet.PaymentSheet
+import com.stripe.android.paymentsheet.addresselement.AddressDetails
+import com.stripe.android.paymentsheet.state.PaymentElementLoader
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.parcelize.Parcelize
@@ -69,7 +72,22 @@ internal interface ConfirmationHandler {
         /**
          * The confirmation option used to in order to potentially confirm the intent
          */
-        val confirmationOption: Option
+        val confirmationOption: Option,
+
+        /**
+         * Appearance values to be used when styling the launched activities
+         */
+        val appearance: PaymentSheet.Appearance,
+
+        /**
+         * The mode that a Payment Element product was initialized with
+         */
+        val initializationMode: PaymentElementLoader.InitializationMode,
+
+        /**
+         * The shipping details of the customer that can be attached during the confirmation flow
+         */
+        val shippingDetails: AddressDetails?
     ) : Parcelable
 
     /**

diff --git a/...heet/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationMediator.kt b/...heet/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationMediator.kt
@@ -46,7 +46,7 @@ internal class ConfirmationMediator<
             val confirmationResult = persistedParameters?.let { params ->
                 definition.toResult(
                     confirmationOption = params.confirmationOption,
-                    intent = params.intent,
+                    confirmationParameters = params.confirmationParameters,
                     result = result,
                     deferredIntentConfirmationType = params.deferredIntentConfirmationType
                 )
@@ -76,7 +76,7 @@ internal class ConfirmationMediator<
 
     suspend fun action(
         option: ConfirmationHandler.Option,
-        intent: StripeIntent
+        parameters: ConfirmationDefinition.Parameters,
     ): Action {
         val confirmationOption = definition.option(option)
             ?: return Action.Fail(
@@ -88,22 +88,22 @@ internal class ConfirmationMediator<
                 errorType = ConfirmationHandler.Result.Failed.ErrorType.Internal,
             )
 
-        return when (val action = definition.action(confirmationOption, intent)) {
+        return when (val action = definition.action(confirmationOption, parameters)) {
             is ConfirmationDefinition.Action.Launch -> {
                 launcher?.let {
                     Action.Launch(
                         launch = {
                             persistedParameters = Parameters(
                                 confirmationOption = confirmationOption,
-                                intent = intent,
+                                confirmationParameters = parameters,
                                 deferredIntentConfirmationType = action.deferredIntentConfirmationType,
                             )
 
                             definition.launch(
                                 launcher = it,
                                 arguments = action.launcherArguments,
                                 confirmationOption = confirmationOption,
-                                intent = intent,
+                                confirmationParameters = parameters,
                             )
                         },
                         receivesResultInProcess = action.receivesResultInProcess,
@@ -159,7 +159,7 @@ internal class ConfirmationMediator<
     @Parcelize
     internal data class Parameters<TConfirmationOption : ConfirmationHandler.Option>(
         val confirmationOption: TConfirmationOption,
-        val intent: StripeIntent,
+        val confirmationParameters: ConfirmationDefinition.Parameters,
         val deferredIntentConfirmationType: DeferredIntentConfirmationType?,
     ) : Parcelable
 

diff --git a/...eet/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationOptionKtx.kt b/...eet/src/main/java/com/stripe/android/paymentelement/confirmation/ConfirmationOptionKtx.kt
@@ -8,20 +8,14 @@ import com.stripe.android.paymentelement.confirmation.bacs.BacsConfirmationOptio
 import com.stripe.android.paymentelement.confirmation.epms.ExternalPaymentMethodConfirmationOption
 import com.stripe.android.paymentelement.confirmation.gpay.GooglePayConfirmationOption
 import com.stripe.android.paymentelement.confirmation.link.LinkConfirmationOption
-import com.stripe.android.paymentsheet.PaymentSheet
 import com.stripe.android.paymentsheet.model.PaymentSelection
-import com.stripe.android.paymentsheet.state.PaymentElementLoader
 
 internal fun PaymentSelection.toConfirmationOption(
-    initializationMode: PaymentElementLoader.InitializationMode,
     configuration: CommonConfiguration,
-    appearance: PaymentSheet.Appearance,
     linkConfiguration: LinkConfiguration?,
 ): ConfirmationHandler.Option? {
     return when (this) {
         is PaymentSelection.Saved -> PaymentMethodConfirmationOption.Saved(
-            initializationMode = initializationMode,
-            shippingDetails = configuration.shippingDetails,
             paymentMethod = paymentMethod,
             optionsParams = paymentMethodOptionsParams,
         )
@@ -34,15 +28,11 @@ internal fun PaymentSelection.toConfirmationOption(
                 // For Instant Debits, we create the PaymentMethod inside the bank auth flow. Therefore,
                 // we can just use the already created object here.
                 PaymentMethodConfirmationOption.Saved(
-                    initializationMode = initializationMode,
-                    shippingDetails = configuration.shippingDetails,
                     paymentMethod = instantDebits.paymentMethod,
                     optionsParams = paymentMethodOptionsParams,
                 )
             } else {
                 PaymentMethodConfirmationOption.New(
-                    initializationMode = initializationMode,
-                    shippingDetails = configuration.shippingDetails,
                     createParams = paymentMethodCreateParams,
                     optionsParams = paymentMethodOptionsParams,
                     shouldSave = customerRequestedSave == PaymentSelection.CustomerRequestedSave.RequestReuse,
@@ -52,16 +42,11 @@ internal fun PaymentSelection.toConfirmationOption(
         is PaymentSelection.New -> {
             if (paymentMethodCreateParams.typeCode == PaymentMethod.Type.BacsDebit.code) {
                 BacsConfirmationOption(
-                    initializationMode = initializationMode,
-                    shippingDetails = configuration.shippingDetails,
                     createParams = paymentMethodCreateParams,
                     optionsParams = paymentMethodOptionsParams,
-                    appearance = appearance,
                 )
             } else {
                 PaymentMethodConfirmationOption.New(
-                    initializationMode = initializationMode,
-                    shippingDetails = configuration.shippingDetails,
                     createParams = paymentMethodCreateParams,
                     optionsParams = paymentMethodOptionsParams,
                     shouldSave = customerRequestedSave == PaymentSelection.CustomerRequestedSave.RequestReuse,
@@ -70,8 +55,6 @@ internal fun PaymentSelection.toConfirmationOption(
         }
         is PaymentSelection.GooglePay -> configuration.googlePay?.let { googlePay ->
             GooglePayConfirmationOption(
-                initializationMode = initializationMode,
-                shippingDetails = configuration.shippingDetails,
                 config = GooglePayConfirmationOption.Config(
                     environment = googlePay.environment,
                     merchantName = configuration.merchantDisplayName,
@@ -85,11 +68,7 @@ internal fun PaymentSelection.toConfirmationOption(
             )
         }
         is PaymentSelection.Link -> linkConfiguration?.let {
-            LinkConfirmationOption(
-                initializationMode = initializationMode,
-                shippingDetails = configuration.shippingDetails,
-                configuration = linkConfiguration,
-            )
+            LinkConfirmationOption(configuration = linkConfiguration)
         }
     }
 }
diff --git a/...rc/main/java/com/stripe/android/paymentelement/confirmation/DefaultConfirmationHandler.kt b/...rc/main/java/com/stripe/android/paymentelement/confirmation/DefaultConfirmationHandler.kt
@@ -7,7 +7,6 @@ import androidx.lifecycle.LifecycleOwner
 import androidx.lifecycle.SavedStateHandle
 import com.stripe.android.core.exception.StripeException
 import com.stripe.android.core.strings.resolvableString
-import com.stripe.android.model.StripeIntent
 import com.stripe.android.payments.core.analytics.ErrorReporter
 import com.stripe.android.paymentsheet.R
 import kotlinx.coroutines.CoroutineScope
@@ -90,10 +89,7 @@ internal class DefaultConfirmationHandler(
         _state.value = ConfirmationHandler.State.Confirming(arguments.confirmationOption)
 
         coroutineScope.launch {
-            confirm(
-                intent = arguments.intent,
-                confirmationOption = arguments.confirmationOption,
-            )
+            confirm(arguments)
         }
     }
 
@@ -110,9 +106,10 @@ internal class DefaultConfirmationHandler(
     }
 
     private suspend fun confirm(
-        confirmationOption: ConfirmationHandler.Option,
-        intent: StripeIntent,
+        arguments: ConfirmationHandler.Args,
     ) {
+        val confirmationOption = arguments.confirmationOption
+
         _state.value = ConfirmationHandler.State.Confirming(confirmationOption)
 
         val mediator = mediators.find { mediator ->
@@ -142,7 +139,7 @@ internal class DefaultConfirmationHandler(
             return
         }
 
-        when (val action = mediator.action(confirmationOption, intent)) {
+        when (val action = mediator.action(confirmationOption, arguments.toParameters())) {
             is ConfirmationMediator.Action.Launch -> {
                 storeIsAwaitingForResult(
                     key = mediator.key,
@@ -178,9 +175,16 @@ internal class DefaultConfirmationHandler(
                 removeIsAwaitingForResult()
 
                 coroutineScope.launch {
+                    val parameters = result.parameters
+
                     confirm(
-                        intent = result.intent,
-                        confirmationOption = result.confirmationOption,
+                        arguments = ConfirmationHandler.Args(
+                            intent = parameters.intent,
+                            shippingDetails = parameters.shippingDetails,
+                            appearance = parameters.appearance,
+                            initializationMode = parameters.initializationMode,
+                            confirmationOption = result.confirmationOption,
+                        )
                     )
                 }
 
@@ -229,6 +233,15 @@ internal class DefaultConfirmationHandler(
         return savedStateHandle.get<AwaitingConfirmationResultData>(AWAITING_CONFIRMATION_RESULT_KEY)
     }
 
+    private fun ConfirmationHandler.Args.toParameters(): ConfirmationDefinition.Parameters {
+        return ConfirmationDefinition.Parameters(
+            appearance = appearance,
+            shippingDetails = shippingDetails,
+            initializationMode = initializationMode,
+            intent = intent
+        )
+    }
+
     private suspend inline fun <reified T> Flow<*>.firstInstanceOf(): T {
         return first {
             it is T

diff --git a/...in/java/com/stripe/android/paymentelement/confirmation/PaymentMethodConfirmationOption.kt b/...in/java/com/stripe/android/paymentelement/confirmation/PaymentMethodConfirmationOption.kt
@@ -2,26 +2,17 @@ package com.stripe.android.paymentelement.confirmation
 
 import com.stripe.android.model.PaymentMethodCreateParams
 import com.stripe.android.model.PaymentMethodOptionsParams
-import com.stripe.android.paymentsheet.addresselement.AddressDetails
-import com.stripe.android.paymentsheet.state.PaymentElementLoader
 import kotlinx.parcelize.Parcelize
 
 internal sealed interface PaymentMethodConfirmationOption : ConfirmationHandler.Option {
-    val initializationMode: PaymentElementLoader.InitializationMode
-    val shippingDetails: AddressDetails?
-
     @Parcelize
     data class Saved(
-        override val initializationMode: PaymentElementLoader.InitializationMode,
-        override val shippingDetails: AddressDetails?,
         val paymentMethod: com.stripe.android.model.PaymentMethod,
         val optionsParams: PaymentMethodOptionsParams?,
     ) : PaymentMethodConfirmationOption
 
     @Parcelize
     data class New(
-        override val initializationMode: PaymentElementLoader.InitializationMode,
-        override val shippingDetails: AddressDetails?,
         val createParams: PaymentMethodCreateParams,
         val optionsParams: PaymentMethodOptionsParams?,
         val shouldSave: Boolean