Refactor AddPaymentMethodActivity.Result

MIGRATING.md

@@ -100,6 +100,35 @@
         ```kotlin
         PaymentConfiguration.init(context, "pk_test", "acct_1234")
         ```
+    - `AddPaymentMethodActivity.Result` is now a sealed class with `Success`, `Failure`, and `Canceled` subclasses
+        ```kotlin
+        // before
+        val result = AddPaymentMethodActivityStarter.Result.fromIntent(
+            intent
+        )
+        when {
+            result != null -> result.paymentMethod
+            else -> {
+                // error happened or customer canceled
+            }
+        }
+
+        // after
+        val result = AddPaymentMethodActivityStarter.Result.fromIntent(
+            intent
+        )
+        when (result) {
+            is AddPaymentMethodActivityStarter.Result.Success -> {
+                result.paymentMethod
+            }
+            is AddPaymentMethodActivityStarter.Result.Failure -> {
+                result.exception
+            }
+            is AddPaymentMethodActivityStarter.Result.Canceled -> {
+                // customer canceled
+            }
+        }
+        ```
 - Changes to `Source`
     - `Source.SourceFlow` has been renamed to `Source.Flow` and is now an enum
     - `Source.SourceStatus` has been renamed to `Source.Status` and is now an enum

example/src/main/java/com/stripe/example/activity/FpxPaymentActivity.java

@@ -55,8 +55,10 @@ protected void onActivityResult(int requestCode, int resultCode, @Nullable Inten
 
         final AddPaymentMethodActivityStarter.Result result =
                 AddPaymentMethodActivityStarter.Result.fromIntent(data);
-        if (result != null) {
-            onPaymentMethodResult(result.getPaymentMethod());
+        if (result instanceof AddPaymentMethodActivityStarter.Result.Success) {
+            final AddPaymentMethodActivityStarter.Result.Success successResult =
+                    (AddPaymentMethodActivityStarter.Result.Success) result;
+            onPaymentMethodResult(successResult.getPaymentMethod());
         }
     }
 

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

@@ -90,6 +90,14 @@ class AddPaymentMethodActivity : StripeActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         configureView(args)
+        setResult(
+            Activity.RESULT_OK,
+            Intent()
+                .putExtras(
+                    AddPaymentMethodActivityStarter.Result.Canceled
+                        .toBundle()
+                )
+        )
     }
 
     override fun onResume() {
@@ -207,15 +215,21 @@ class AddPaymentMethodActivity : StripeActivity() {
                 })
             },
             onFailure = {
-                finish()
+                finishWithResult(AddPaymentMethodActivityStarter.Result.Failure(it))
             }
         )
     }
 
     private fun finishWithPaymentMethod(paymentMethod: PaymentMethod) {
+        finishWithResult(AddPaymentMethodActivityStarter.Result.Success(paymentMethod))
+    }
+
+    private fun finishWithResult(result: AddPaymentMethodActivityStarter.Result) {
         isProgressBarVisible = false
-        setResult(Activity.RESULT_OK, Intent()
-            .putExtras(AddPaymentMethodActivityStarter.Result(paymentMethod).toBundle()))
+        setResult(
+            Activity.RESULT_OK,
+            Intent().putExtras(result.toBundle())
+        )
         finish()
     }
 

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

@@ -145,23 +145,33 @@ class AddPaymentMethodActivityStarter : ActivityStarter<AddPaymentMethodActivity
      *
      * Retrieve in `#onActivityResult()` using [fromIntent].
      */
-    @Parcelize
-    data class Result internal constructor(
-        val paymentMethod: PaymentMethod
-    ) : ActivityStarter.Result {
+    sealed class Result : ActivityStarter.Result {
         override fun toBundle(): Bundle {
-            val bundle = Bundle()
-            bundle.putParcelable(ActivityStarter.Result.EXTRA, this)
-            return bundle
+            return Bundle().also {
+                it.putParcelable(ActivityStarter.Result.EXTRA, this)
+            }
         }
 
+        @Parcelize
+        data class Success internal constructor(
+            val paymentMethod: PaymentMethod
+        ) : Result()
+
+        @Parcelize
+        data class Failure internal constructor(
+            val exception: Throwable
+        ) : Result()
+
+        @Parcelize
+        object Canceled : Result()
+
         companion object {
             /**
-             * @return the [Result] object from the given `Intent`
+             * @return the [Result] object from the given `Intent`. [Canceled] by default.
              */
             @JvmStatic
-            fun fromIntent(intent: Intent?): Result? {
-                return intent?.getParcelableExtra(ActivityStarter.Result.EXTRA)
+            fun fromIntent(intent: Intent?): Result {
+                return intent?.getParcelableExtra(ActivityStarter.Result.EXTRA) ?: Canceled
             }
         }
     }

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

@@ -160,7 +160,17 @@ class PaymentMethodsActivity : AppCompatActivity() {
         data?.let {
             val result =
                 AddPaymentMethodActivityStarter.Result.fromIntent(data)
-            result?.paymentMethod?.let { onAddedPaymentMethod(it) }
+            when (result) {
+                is AddPaymentMethodActivityStarter.Result.Success -> {
+                    onAddedPaymentMethod(result.paymentMethod)
+                }
+                is AddPaymentMethodActivityStarter.Result.Failure -> {
+                    // TODO(mshafrir-stripe): notify user that payment method can not be added at this time
+                }
+                else -> {
+                    // no-op
+                }
+            }
         } ?: fetchCustomerPaymentMethods()
     }
 

stripe/src/test/java/com/stripe/android/view/AddPaymentMethodActivityStarterTest.kt

@@ -24,8 +24,9 @@ class AddPaymentMethodActivityStarterTest {
 
     @Test
     fun testResultParceling() {
-        val result =
-            AddPaymentMethodActivityStarter.Result(PaymentMethodFixtures.CARD_PAYMENT_METHOD)
+        val result = AddPaymentMethodActivityStarter.Result.Success(
+            PaymentMethodFixtures.CARD_PAYMENT_METHOD
+        )
         assertEquals(result, ParcelUtils.create(result))
     }
 }

stripe/src/test/java/com/stripe/android/view/AddPaymentMethodActivityTest.kt

@@ -35,7 +35,6 @@ import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertFalse
-import kotlin.test.assertNull
 import kotlin.test.assertTrue
 import org.junit.runner.RunWith
 import org.mockito.Mockito.never
@@ -159,10 +158,9 @@ class AddPaymentMethodActivityTest {
                 )
 
                 assertEquals(RESULT_OK, activityScenario.result.resultCode)
-                val paymentMethod = getPaymentMethodFromIntent(
-                    activityScenario.result.resultData
-                )
-                assertEquals(expectedPaymentMethod, paymentMethod)
+                assertThat(
+                    getPaymentMethodFromIntent(activityScenario.result.resultData)
+                ).isEqualTo(expectedPaymentMethod)
             }
         }
     }
@@ -294,7 +292,12 @@ class AddPaymentMethodActivityTest {
                     viewModel, PaymentMethodCreateParamsFixtures.DEFAULT_CARD
                 )
 
-                assertNull(shadowOf(activity).resultIntent)
+                val result = AddPaymentMethodActivityStarter.Result.fromIntent(
+                    shadowOf(activity).resultIntent
+                )
+                assertThat(result)
+                    .isEqualTo(AddPaymentMethodActivityStarter.Result.Canceled)
+
                 assertFalse(activity.isFinishing)
                 assertEquals(View.GONE, progressBar.visibility)
 
@@ -328,12 +331,11 @@ class AddPaymentMethodActivityTest {
                     listenerArgumentCaptor.capture()
                 )
 
-                assertEquals(
-                    setOf(
-                        AddPaymentMethodActivity.PRODUCT_TOKEN,
-                        PaymentSession.PRODUCT_TOKEN
-                    ),
+                assertThat(
                     productUsageArgumentCaptor.firstValue
+                ).containsExactly(
+                    AddPaymentMethodActivity.PRODUCT_TOKEN,
+                    PaymentSession.PRODUCT_TOKEN
                 )
 
                 assertEquals(EXPECTED_PAYMENT_METHOD.id, paymentMethodIdCaptor.firstValue)
@@ -342,8 +344,12 @@ class AddPaymentMethodActivityTest {
                 whenever(error.localizedMessage).thenReturn(ERROR_MESSAGE)
                 listenerArgumentCaptor.firstValue.onError(400, ERROR_MESSAGE, null)
 
-                val intent = shadowOf(activity).resultIntent
-                assertNull(intent)
+                val result = AddPaymentMethodActivityStarter.Result.fromIntent(
+                    shadowOf(activity).resultIntent
+                )
+                assertThat(result)
+                    .isEqualTo(AddPaymentMethodActivityStarter.Result.Canceled)
+
                 assertFalse(activity.isFinishing)
                 assertEquals(View.GONE, progressBar.visibility)
 
@@ -367,6 +373,13 @@ class AddPaymentMethodActivityTest {
                     viewModel,
                     PaymentMethodCreateParamsFixtures.DEFAULT_CARD
                 )
+
+                val result = AddPaymentMethodActivityStarter.Result.fromIntent(
+                    shadowOf(activity).resultIntent
+                ) as? AddPaymentMethodActivityStarter.Result.Failure
+                assertThat(result?.exception?.message)
+                    .isEqualTo("Attempted to get instance of CustomerSession without initialization.")
+
                 assertThat(activity.isFinishing)
                     .isTrue()
             }
@@ -384,14 +397,17 @@ class AddPaymentMethodActivityTest {
 
     private fun verifyFinishesWithResult(activityResult: Instrumentation.ActivityResult) {
         assertEquals(RESULT_OK, activityResult.resultCode)
-        val paymentMethod = getPaymentMethodFromIntent(activityResult.resultData)
-        assertEquals(EXPECTED_PAYMENT_METHOD, paymentMethod)
+        assertThat(getPaymentMethodFromIntent(activityResult.resultData))
+            .isEqualTo(EXPECTED_PAYMENT_METHOD)
     }
 
-    private fun getPaymentMethodFromIntent(intent: Intent): PaymentMethod {
+    private fun getPaymentMethodFromIntent(intent: Intent): PaymentMethod? {
         val result =
-            requireNotNull(AddPaymentMethodActivityStarter.Result.fromIntent(intent))
-        return result.paymentMethod
+            AddPaymentMethodActivityStarter.Result.fromIntent(intent)
+        return when (result) {
+            is AddPaymentMethodActivityStarter.Result.Success -> result.paymentMethod
+            else -> null
+        }
     }
 
     private fun createArgs(

stripe/src/test/java/com/stripe/android/view/PaymentMethodsActivityTest.kt

@@ -169,7 +169,10 @@ class PaymentMethodsActivityTest {
                 assertNotNull(paymentMethod)
 
                 val resultIntent = Intent()
-                    .putExtras(AddPaymentMethodActivityStarter.Result(paymentMethod).toBundle())
+                    .putExtras(
+                        AddPaymentMethodActivityStarter.Result.Success(paymentMethod)
+                            .toBundle()
+                    )
                 activity.onActivityResult(
                     AddPaymentMethodActivityStarter.REQUEST_CODE, RESULT_OK, resultIntent
                 )