Remove deprecated BroadcastReceiver logic from PaymentFlowActivity

This is a breaking change.

Implement `PaymentSessionConfig.shippingInformationValidator` and
`PaymentSessionConfig.shippingMethodsFactory` to replace logic
previously handled via broadcast.

The default implementation of `ShippingInformationValidator` will
treat all `ShippingInformation` instances as valid.

See migration guide for more info.

stripe/src/main/java/com/stripe/android/PaymentSessionConfig.kt

@@ -10,7 +10,6 @@ import com.stripe.android.model.ShippingMethod
 import com.stripe.android.view.AddPaymentMethodActivity
 import com.stripe.android.view.BillingAddressFields
 import com.stripe.android.view.PaymentFlowActivity
-import com.stripe.android.view.PaymentFlowExtras
 import com.stripe.android.view.SelectShippingMethodWidget
 import com.stripe.android.view.ShippingInfoWidget
 import com.stripe.android.view.ShippingInfoWidget.CustomizableShippingField
@@ -37,7 +36,7 @@ data class PaymentSessionConfig internal constructor(
     val billingAddressFields: BillingAddressFields = BillingAddressFields.None,
 
     internal val shouldPrefetchCustomer: Boolean = true,
-    internal val shippingInformationValidator: ShippingInformationValidator? = null,
+    internal val shippingInformationValidator: ShippingInformationValidator = DefaultShippingInfoValidator(),
     internal val shippingMethodsFactory: ShippingMethodsFactory? = null,
     internal val windowFlags: Int? = null
 ) : Parcelable {
@@ -51,11 +50,10 @@ data class PaymentSessionConfig internal constructor(
             }
         }
 
-        if (shippingInformationValidator != null && isShippingMethodRequired) {
+        if (isShippingMethodRequired) {
             requireNotNull(shippingMethodsFactory) {
                 """
-                If isShippingMethodRequired is true and a ShippingInformationValidator is provided,
-                a ShippingMethodsFactory must also be provided.
+                If isShippingMethodRequired is true a ShippingMethodsFactory must also be provided.
                 """.trimIndent()
             }
         }
@@ -217,9 +215,7 @@ data class PaymentSessionConfig internal constructor(
         }
 
         /**
-         * @param shippingInformationValidator if specified, will be used to validate
-         * [ShippingInformation] in [PaymentFlowActivity] instead of sending a broadcast with
-         * [PaymentFlowExtras.EVENT_SHIPPING_INFO_SUBMITTED].
+         * @param shippingInformationValidator used to validate [ShippingInformation] in [PaymentFlowActivity]
          *
          * Note: this instance must be [Serializable].
          */
@@ -263,12 +259,26 @@ data class PaymentSessionConfig internal constructor(
                 paymentMethodTypes = paymentMethodTypes,
                 shouldShowGooglePay = shouldShowGooglePay,
                 allowedShippingCountryCodes = allowedShippingCountryCodes,
-                shippingInformationValidator = shippingInformationValidator,
+                shippingInformationValidator = shippingInformationValidator
+                    ?: DefaultShippingInfoValidator(),
                 shippingMethodsFactory = shippingMethodsFactory,
                 windowFlags = windowFlags,
                 billingAddressFields = billingAddressFields,
                 shouldPrefetchCustomer = shouldPrefetchCustomer
             )
         }
     }
+
+    /**
+     * A [ShippingInformationValidator] that accepts any [ShippingInformation] as valid.
+     */
+    private class DefaultShippingInfoValidator : ShippingInformationValidator {
+        override fun isValid(shippingInformation: ShippingInformation): Boolean {
+            return true
+        }
+
+        override fun getErrorMessage(shippingInformation: ShippingInformation): String {
+            return ""
+        }
+    }
 }

stripe/src/main/java/com/stripe/android/view/PaymentFlowActivity.kt

@@ -1,14 +1,10 @@
 package com.stripe.android.view
 
 import android.app.Activity
-import android.content.BroadcastReceiver
-import android.content.Context
 import android.content.Intent
-import android.content.IntentFilter
 import android.os.Bundle
 import androidx.lifecycle.Observer
 import androidx.lifecycle.ViewModelProviders
-import androidx.localbroadcastmanager.content.LocalBroadcastManager
 import androidx.viewpager.widget.ViewPager
 import com.stripe.android.CustomerSession
 import com.stripe.android.PaymentSession.Companion.EXTRA_PAYMENT_SESSION_DATA
@@ -32,8 +28,6 @@ class PaymentFlowActivity : StripeActivity() {
     private lateinit var customerSession: CustomerSession
     private lateinit var viewModel: PaymentFlowViewModel
 
-    private var shippingInfoSubmittedBroadcastReceiver: BroadcastReceiver? = null
-
     private val keyboardController: KeyboardController by lazy {
         KeyboardController(this)
     }
@@ -84,40 +78,9 @@ class PaymentFlowActivity : StripeActivity() {
             }
         })
 
-        if (paymentSessionConfig.shippingInformationValidator == null) {
-            shippingInfoSubmittedBroadcastReceiver = createShippingInfoSubmittedBroadcastReceiver()
-        }
-
         title = paymentFlowPagerAdapter.getPageTitle(shipping_flow_viewpager.currentItem)
     }
 
-    private fun createShippingInfoSubmittedBroadcastReceiver(): BroadcastReceiver {
-        return object : BroadcastReceiver() {
-            override fun onReceive(context: Context, intent: Intent) {
-                val isShippingInfoValid = intent.getBooleanExtra(
-                    PaymentFlowExtras.EXTRA_IS_SHIPPING_INFO_VALID,
-                    false)
-                if (isShippingInfoValid) {
-                    val shippingMethods: List<ShippingMethod>? =
-                        intent.getParcelableArrayListExtra(
-                            PaymentFlowExtras.EXTRA_VALID_SHIPPING_METHODS
-                        )
-                    val defaultShippingMethod: ShippingMethod? = intent
-                        .getParcelableExtra(PaymentFlowExtras.EXTRA_DEFAULT_SHIPPING_METHOD)
-
-                    onShippingInfoValidated(
-                        shippingMethods.orEmpty(),
-                        defaultShippingMethod
-                    )
-                } else {
-                    val errorMessage =
-                        intent.getStringExtra(PaymentFlowExtras.EXTRA_SHIPPING_INFO_ERROR)
-                    onShippingInfoError(errorMessage)
-                }
-            }
-        }
-    }
-
     override fun onRestoreInstanceState(savedInstanceState: Bundle) {
         super.onRestoreInstanceState(savedInstanceState)
         shipping_flow_viewpager.currentItem = savedInstanceState.getInt(STATE_CURRENT_ITEM, 0)
@@ -132,25 +95,6 @@ class PaymentFlowActivity : StripeActivity() {
         }
     }
 
-    override fun onPause() {
-        super.onPause()
-
-        shippingInfoSubmittedBroadcastReceiver?.let {
-            LocalBroadcastManager.getInstance(this).unregisterReceiver(it)
-        }
-    }
-
-    override fun onResume() {
-        super.onResume()
-
-        shippingInfoSubmittedBroadcastReceiver?.let {
-            LocalBroadcastManager.getInstance(this).registerReceiver(
-                it,
-                IntentFilter(PaymentFlowExtras.EVENT_SHIPPING_INFO_PROCESSED)
-            )
-        }
-    }
-
     override fun onSaveInstanceState(outState: Bundle) {
         super.onSaveInstanceState(outState)
         outState.putParcelable(STATE_SHIPPING_INFO, shippingInfo)
@@ -216,17 +160,11 @@ class PaymentFlowActivity : StripeActivity() {
             )
             setCommunicatingProgress(true)
 
-            val shippingInfoValidator =
-                paymentSessionConfig.shippingInformationValidator
-            if (shippingInfoValidator != null) {
-                validateShippingInformation(
-                    shippingInfoValidator,
-                    paymentSessionConfig.shippingMethodsFactory,
-                    shippingInfo
-                )
-            } else {
-                broadcastShippingInfoSubmitted(shippingInfo)
-            }
+            validateShippingInformation(
+                paymentSessionConfig.shippingInformationValidator,
+                paymentSessionConfig.shippingMethodsFactory,
+                shippingInfo
+            )
         }
     }
 
@@ -247,14 +185,6 @@ class PaymentFlowActivity : StripeActivity() {
             }
         }
 
-    private fun broadcastShippingInfoSubmitted(shippingInformation: ShippingInformation) {
-        LocalBroadcastManager.getInstance(this)
-            .sendBroadcast(
-                Intent(PaymentFlowExtras.EVENT_SHIPPING_INFO_SUBMITTED)
-                    .putExtra(PaymentFlowExtras.EXTRA_SHIPPING_INFO_DATA, shippingInformation)
-            )
-    }
-
     private fun hasNextPage(): Boolean {
         return shipping_flow_viewpager.currentItem + 1 < paymentFlowPagerAdapter.count
     }

stripe/src/main/java/com/stripe/android/view/PaymentFlowActivityStarter.kt

@@ -69,8 +69,9 @@ class PaymentFlowActivityStarter :
 
             override fun build(): Args {
                 return Args(
-                    paymentSessionConfig = paymentSessionConfig
-                        ?: PaymentSessionConfig.Builder().build(),
+                    paymentSessionConfig = requireNotNull(paymentSessionConfig) {
+                        "PaymentFlowActivity launched without PaymentSessionConfig"
+                    },
                     paymentSessionData = requireNotNull(paymentSessionData) {
                         "PaymentFlowActivity launched without PaymentSessionData"
                     },

stripe/src/test/java/com/stripe/android/CustomerSessionTest.kt

@@ -53,36 +53,38 @@ class CustomerSessionTest {
     @Mock
     private lateinit var threadPoolExecutor: ThreadPoolExecutor
 
-    private lateinit var productUsageArgumentCaptor: KArgumentCaptor<Set<String>>
-    private lateinit var sourceArgumentCaptor: KArgumentCaptor<Source>
-    private lateinit var paymentMethodArgumentCaptor: KArgumentCaptor<PaymentMethod>
-    private lateinit var paymentMethodsArgumentCaptor: KArgumentCaptor<List<PaymentMethod>>
-    private lateinit var customerArgumentCaptor: KArgumentCaptor<Customer>
-    private lateinit var intentArgumentCaptor: KArgumentCaptor<Intent>
-    private lateinit var requestOptionsArgumentCaptor: KArgumentCaptor<ApiRequest.Options>
+    private val productUsageArgumentCaptor: KArgumentCaptor<Set<String>> by lazy {
+        argumentCaptor<Set<String>>()
+    }
+    private val sourceArgumentCaptor: KArgumentCaptor<Source> by lazy {
+        argumentCaptor<Source>()
+    }
+    private val paymentMethodArgumentCaptor: KArgumentCaptor<PaymentMethod> by lazy {
+        argumentCaptor<PaymentMethod>()
+    }
+    private val paymentMethodsArgumentCaptor: KArgumentCaptor<List<PaymentMethod>> by lazy {
+        argumentCaptor<List<PaymentMethod>>()
+    }
+    private val customerArgumentCaptor: KArgumentCaptor<Customer> by lazy {
+        argumentCaptor<Customer>()
+    }
+    private val intentArgumentCaptor: KArgumentCaptor<Intent> by lazy {
+        argumentCaptor<Intent>()
+    }
+    private val requestOptionsArgumentCaptor: KArgumentCaptor<ApiRequest.Options> by lazy {
+        argumentCaptor<ApiRequest.Options>()
+    }
 
     private val ephemeralKeyProvider: TestEphemeralKeyProvider = TestEphemeralKeyProvider()
 
     private val activityScenarioFactory: ActivityScenarioFactory by lazy {
         ActivityScenarioFactory(ApplicationProvider.getApplicationContext())
     }
 
-    private fun getCustomerEphemeralKey(key: String): EphemeralKey {
-        return EphemeralKeyJsonParser().parse(JSONObject(key))
-    }
-
     @BeforeTest
     fun setup() {
         MockitoAnnotations.initMocks(this)
 
-        productUsageArgumentCaptor = argumentCaptor()
-        sourceArgumentCaptor = argumentCaptor()
-        paymentMethodArgumentCaptor = argumentCaptor()
-        paymentMethodsArgumentCaptor = argumentCaptor()
-        customerArgumentCaptor = argumentCaptor()
-        intentArgumentCaptor = argumentCaptor()
-        requestOptionsArgumentCaptor = argumentCaptor()
-
         `when`<Customer>(stripeRepository.retrieveCustomer(any(), any()))
             .thenReturn(FIRST_CUSTOMER, SECOND_CUSTOMER)
 
@@ -586,6 +588,9 @@ class CustomerSessionTest {
         val customerSession = createCustomerSession(null)
         CustomerSession.instance = customerSession
 
+        val config = PaymentSessionFixtures.CONFIG.copy(
+            allowedShippingCountryCodes = emptySet()
+        )
         activityScenarioFactory.create<PaymentFlowActivity>(
             PaymentSessionFixtures.PAYMENT_FLOW_ARGS
         ).use { activityScenario ->
@@ -600,10 +605,9 @@ class CustomerSessionTest {
         val customerSession = createCustomerSession(null)
         CustomerSession.instance = customerSession
 
-        val config = PaymentSessionConfig.Builder()
-            .setShippingInfoRequired(false)
-            .build()
-
+        val config = PaymentSessionFixtures.CONFIG.copy(
+            isShippingInfoRequired = false
+        )
         activityScenarioFactory.create<PaymentFlowActivity>(
             PaymentFlowActivityStarter.Args(
                 paymentSessionConfig = config,
@@ -909,5 +913,9 @@ class CustomerSessionTest {
         private val SECOND_CUSTOMER = CustomerFixtures.OTHER_CUSTOMER
 
         private val PAYMENT_METHOD = PaymentMethodFixtures.CARD_PAYMENT_METHOD
+
+        private fun getCustomerEphemeralKey(key: String): EphemeralKey {
+            return EphemeralKeyJsonParser().parse(JSONObject(key))
+        }
     }
 }

stripe/src/test/java/com/stripe/android/PaymentSessionConfigTest.kt

@@ -1,6 +1,6 @@
 package com.stripe.android
 
-import com.stripe.android.PaymentSessionFixtures.PAYMENT_SESSION_CONFIG
+import com.stripe.android.PaymentSessionFixtures.CONFIG
 import com.stripe.android.model.ShippingInformation
 import com.stripe.android.utils.ParcelUtils
 import kotlin.test.Test
@@ -15,21 +15,21 @@ class PaymentSessionConfigTest {
 
     @Test
     fun testParcel() {
-        assertEquals(PAYMENT_SESSION_CONFIG, ParcelUtils.create(PAYMENT_SESSION_CONFIG))
+        assertEquals(CONFIG, ParcelUtils.create(CONFIG))
     }
 
     @Test
     fun create_withValidCountryCode_succeeds() {
         val allowedShippingCountryCodes = setOf("us", "CA")
-        val config = PAYMENT_SESSION_CONFIG.copy(
+        val config = CONFIG.copy(
             allowedShippingCountryCodes = allowedShippingCountryCodes
         )
         assertEquals(allowedShippingCountryCodes, config.allowedShippingCountryCodes)
     }
 
     @Test
     fun create_withEmptyCountryCodesList_succeeds() {
-        val config = PAYMENT_SESSION_CONFIG.copy(
+        val config = CONFIG.copy(
             allowedShippingCountryCodes = emptySet()
         )
         assertTrue(config.allowedShippingCountryCodes.isEmpty())
@@ -38,7 +38,7 @@ class PaymentSessionConfigTest {
     @Test
     fun create_withInvalidCountryCode_throwsException() {
         val exception: IllegalArgumentException = assertFailsWith {
-            PAYMENT_SESSION_CONFIG.copy(
+            CONFIG.copy(
                 allowedShippingCountryCodes = setOf("invalid_country_code")
             )
         }