Implement CardAuthLauncher deep linking refactor.

Author: sshropshire

CardPayments/src/main/java/com/paypal/android/cardpayments/CardAuthLauncher.kt

@@ -3,9 +3,10 @@ package com.paypal.android.cardpayments
 import android.app.Activity
 import android.content.Intent
 import com.paypal.android.corepayments.BrowserSwitchRequestCodes
-import com.paypal.android.corepayments.PayPalSDKError
+import com.paypal.android.corepayments.CaptureDeepLinkResult
+import com.paypal.android.corepayments.CardApproveOrderComplete
+import com.paypal.android.corepayments.CardVaultComplete
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchClient
-import com.paypal.android.corepayments.browserswitch.BrowserSwitchFinishResult
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchOptions
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchPendingState
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchStartResult
@@ -69,46 +70,21 @@ internal class CardAuthLauncher(
     fun completeApproveOrderAuthRequest(
         intent: Intent,
         authState: String
-    ): CardFinishApproveOrderResult {
-        val pendingState = BrowserSwitchPendingState.fromBase64(authState)
-        return if (pendingState == null) {
-            val invalidAuthStateError = PayPalSDKError(0, "Auth State Invalid.")
-            CardFinishApproveOrderResult.Failure(invalidAuthStateError)
-        } else {
-            val requestCode = BrowserSwitchRequestCodes.CARD_APPROVE_ORDER
-            when (val finalResult = pendingState.match(intent, requestCode)) {
-                is BrowserSwitchFinishResult.Success -> parseApproveOrderSuccessResult(finalResult)
-                is BrowserSwitchFinishResult.DeepLinkNotPresent,
-                is BrowserSwitchFinishResult.DeepLinkDoesNotMatch,
-                is BrowserSwitchFinishResult.RequestCodeDoesNotMatch -> CardFinishApproveOrderResult.NoResult
-            }
-        }
+    ) = when (val result = captureDeepLink<CardApproveOrderComplete>(intent, authState)) {
+        is CaptureDeepLinkResult.Success -> parseApproveOrderSuccessResult(result.deepLink)
+        else -> CardFinishApproveOrderResult.NoResult
     }
 
-    fun completeVaultAuthRequest(intent: Intent, authState: String): CardFinishVaultResult {
-        val pendingState = BrowserSwitchPendingState.fromBase64(authState)
-        return if (pendingState == null) {
-            val invalidAuthStateError = PayPalSDKError(0, "Auth State Invalid.")
-            CardFinishVaultResult.Failure(invalidAuthStateError)
-        } else {
-            when (captureDeepLink<CardVaultComplete>(intent, pendingState)) {
-
-            }
-            val requestCode = BrowserSwitchRequestCodes.CARD_VAULT
-            when (val finalResult = pendingState.match(intent, requestCode)) {
-                is BrowserSwitchFinishResult.Success ->
-                    parseVaultSuccessResult(pendingState.originalOptions)
-
-                is BrowserSwitchFinishResult.DeepLinkNotPresent,
-                is BrowserSwitchFinishResult.DeepLinkDoesNotMatch,
-                is BrowserSwitchFinishResult.RequestCodeDoesNotMatch -> CardFinishVaultResult.NoResult
-            }
+    fun completeVaultAuthRequest(intent: Intent, authState: String) =
+        when (val result = captureDeepLink<CardVaultComplete>(intent, authState)) {
+            is CaptureDeepLinkResult.Success -> parseVaultSuccessResult(result.deepLink)
+            else -> CardFinishVaultResult.NoResult
         }
-    }
 
     private fun parseVaultSuccessResult(
-        originalOptions: BrowserSwitchOptions
+        deepLink: CardVaultComplete
     ): CardFinishVaultResult {
+        val originalOptions = deepLink.originalOptions
         val setupTokenId = originalOptions.metadata?.optString(METADATA_KEY_SETUP_TOKEN_ID)
         return if (setupTokenId == null) {
             CardFinishVaultResult.Failure(CardError.unknownError)
@@ -124,19 +100,17 @@ internal class CardAuthLauncher(
     }
 
     private fun parseApproveOrderSuccessResult(
-        finalResult: BrowserSwitchFinishResult.Success
-    ): CardFinishApproveOrderResult =
-        if (finalResult.requestCode == BrowserSwitchRequestCodes.CARD_APPROVE_ORDER) {
-            val orderId = finalResult.requestMetadata?.optString(METADATA_KEY_ORDER_ID)
-            if (orderId == null) {
-                CardFinishApproveOrderResult.Failure(CardError.unknownError)
-            } else {
-                CardFinishApproveOrderResult.Success(
-                    orderId = orderId,
-                    didAttemptThreeDSecureAuthentication = true
-                )
-            }
+        deepLink: CardApproveOrderComplete
+    ): CardFinishApproveOrderResult {
+        val originalOptions = deepLink.originalOptions
+        val orderId = originalOptions.metadata?.optString(METADATA_KEY_ORDER_ID)
+        return if (orderId == null) {
+            CardFinishApproveOrderResult.Failure(CardError.unknownError)
         } else {
-            CardFinishApproveOrderResult.NoResult
+            CardFinishApproveOrderResult.Success(
+                orderId = orderId,
+                didAttemptThreeDSecureAuthentication = true
+            )
         }
+    }
 }

CardPayments/src/test/java/com/paypal/android/cardpayments/CardAuthLauncherUnitTest.kt

@@ -2,13 +2,12 @@ package com.paypal.android.cardpayments
 
 import android.content.Intent
 import android.net.Uri
+import androidx.core.net.toUri
 import androidx.fragment.app.FragmentActivity
-import com.braintreepayments.api.BrowserSwitchClient
-import com.braintreepayments.api.BrowserSwitchFinalResult
-import com.braintreepayments.api.BrowserSwitchOptions
-import com.braintreepayments.api.BrowserSwitchStartResult
 import com.paypal.android.corepayments.BrowserSwitchRequestCodes
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchClient
+import com.paypal.android.corepayments.browserswitch.BrowserSwitchOptions
+import com.paypal.android.corepayments.browserswitch.BrowserSwitchPendingState
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchStartResult
 import io.mockk.every
 import io.mockk.mockk
@@ -66,7 +65,7 @@ class CardAuthLauncherUnitTest {
     @Test
     fun `presentAuthChallenge() browser switches to approve order auth challenge url`() {
         val slot = slot<BrowserSwitchOptions>()
-        val browserSwitchResult = BrowserSwitchStartResult.Started("pending request")
+        val browserSwitchResult = BrowserSwitchStartResult.Success
         every { browserSwitchClient.start(activity, capture(slot)) } returns browserSwitchResult
 
         val returnUrl = "merchant.app://return.com/deep-link"
@@ -81,14 +80,14 @@ class CardAuthLauncherUnitTest {
         val metadata = browserSwitchOptions.metadata
         assertEquals("fake-order-id", metadata?.getString("order_id"))
         assertEquals("merchant.app", browserSwitchOptions.returnUrlScheme)
-        assertEquals(Uri.parse("https://fake.com/destination"), browserSwitchOptions.url)
+        assertEquals(Uri.parse("https://fake.com/destination"), browserSwitchOptions.targetUri)
         assertEquals(BrowserSwitchRequestCodes.CARD_APPROVE_ORDER, browserSwitchOptions.requestCode)
     }
 
     @Test
     fun `presentAuthChallenge() browser switches to vault auth challenge url`() {
         val slot = slot<BrowserSwitchOptions>()
-        val browserSwitchResult = BrowserSwitchStartResult.Started("pending request")
+        val browserSwitchResult = BrowserSwitchStartResult.Success
         every { browserSwitchClient.start(activity, capture(slot)) } returns browserSwitchResult
 
         val returnUrl = "merchant.app://return.com/deep-link"
@@ -103,7 +102,7 @@ class CardAuthLauncherUnitTest {
         val metadata = browserSwitchOptions.metadata
         assertEquals("fake-setup-token-id", metadata?.getString("setup_token_id"))
         assertEquals("merchant.app", browserSwitchOptions.returnUrlScheme)
-        assertEquals(Uri.parse("https://fake.com/destination"), browserSwitchOptions.url)
+        assertEquals(Uri.parse("https://fake.com/destination"), browserSwitchOptions.targetUri)
         assertEquals(BrowserSwitchRequestCodes.CARD_VAULT, browserSwitchOptions.requestCode)
     }
 
@@ -115,17 +114,17 @@ class CardAuthLauncherUnitTest {
         val domain = "example.com"
         val successDeepLink =
             "$scheme://$domain/return_url?state=undefined&code=undefined&liability_shift=NO"
-
-        val finalResult = createBrowserSwitchSuccessFinalResult(
-            BrowserSwitchRequestCodes.CARD_APPROVE_ORDER,
-            approveOrderMetadata,
-            Uri.parse(successDeepLink)
+        val options = BrowserSwitchOptions(
+            targetUri = "https://fake.com/destination".toUri(),
+            requestCode = BrowserSwitchRequestCodes.CARD_APPROVE_ORDER,
+            returnUrlScheme = scheme,
+            appLinkUrl = null,
+            metadata = approveOrderMetadata
         )
-        every {
-            browserSwitchClient.completeRequest(intent, "pending request")
-        } returns finalResult
+        val authState = BrowserSwitchPendingState(options).toBase64EncodedJSON()
+        intent.data = successDeepLink.toUri()
 
-        val result = sut.completeApproveOrderAuthRequest(intent, "pending request")
+        val result = sut.completeApproveOrderAuthRequest(intent, authState)
                 as CardFinishApproveOrderResult.Success
 
         assertEquals("fake-order-id", result.orderId)
@@ -140,32 +139,19 @@ class CardAuthLauncherUnitTest {
         val scheme = "com.paypal.android.demo"
         val domain = "example.com"
         val successDeepLink = "$scheme://$domain/success"
-
-        val finalResult = createBrowserSwitchSuccessFinalResult(
-            BrowserSwitchRequestCodes.CARD_VAULT,
-            vaultMetadata,
-            Uri.parse(successDeepLink)
+        val options = BrowserSwitchOptions(
+            targetUri = "https://fake.com/destination".toUri(),
+            requestCode = BrowserSwitchRequestCodes.CARD_VAULT,
+            returnUrlScheme = scheme,
+            appLinkUrl = null,
+            metadata = vaultMetadata
         )
-        every {
-            browserSwitchClient.completeRequest(intent, "pending request")
-        } returns finalResult
+        val authState = BrowserSwitchPendingState(options).toBase64EncodedJSON()
+        intent.data = successDeepLink.toUri()
 
         val result =
-            sut.completeVaultAuthRequest(intent, "pending request") as CardFinishVaultResult.Success
+            sut.completeVaultAuthRequest(intent, authState) as CardFinishVaultResult.Success
         assertEquals("fake-setup-token-id", result.setupTokenId)
         assertNull(result.status)
     }
-
-    private fun createBrowserSwitchSuccessFinalResult(
-        requestCode: Int,
-        metadata: JSONObject,
-        deepLinkUrl: Uri
-    ): BrowserSwitchFinalResult.Success {
-        val finalResult = mockk<BrowserSwitchFinalResult.Success>(relaxed = true)
-        every { finalResult.returnUrl } returns deepLinkUrl
-        every { finalResult.requestMetadata } returns metadata
-        every { finalResult.requestCode } returns requestCode
-        every { finalResult.requestUrl } returns Uri.parse("https://example.com/url")
-        return finalResult
-    }
 }

CorePayments/src/main/java/com/paypal/android/corepayments/captureDeepLink.kt

@@ -6,10 +6,15 @@ import androidx.annotation.RestrictTo
 import androidx.core.net.toUri
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchOptions
 import com.paypal.android.corepayments.browserswitch.BrowserSwitchPendingState
-import kotlin.text.equals
 
 sealed class DeepLink(val uri: Uri, val originalOptions: BrowserSwitchOptions)
 
+class CardApproveOrderComplete(uri: Uri, originalOptions: BrowserSwitchOptions) :
+    DeepLink(uri, originalOptions)
+
+class CardVaultComplete(uri: Uri, originalOptions: BrowserSwitchOptions) :
+    DeepLink(uri, originalOptions)
+
 class PayPalVaultComplete(uri: Uri, originalOptions: BrowserSwitchOptions) :
     DeepLink(uri, originalOptions)
 
@@ -27,6 +32,12 @@ sealed class CaptureDeepLinkResult<out T : DeepLink>() {
 }
 
 // Ref: https://stackoverflow.com/a/33158859
+inline fun <reified T : DeepLink> isCardApproveOrder(klass: Class<T>) =
+    klass.isAssignableFrom(CardApproveOrderComplete::class.java)
+
+inline fun <reified T : DeepLink> isCardVault(klass: Class<T>) =
+    klass.isAssignableFrom(CardVaultComplete::class.java)
+
 inline fun <reified T : DeepLink> isPayPalCheckout(klass: Class<T>) =
     klass.isAssignableFrom(PayPalCheckoutComplete::class.java)
 
@@ -57,7 +68,11 @@ inline fun <reified T : DeepLink> captureDeepLink(
 
     val options = pendingState.originalOptions
     val klass = T::class.java
-    val requestCode = if (isPayPalVault(klass)) {
+    val requestCode = if (isCardApproveOrder(klass)) {
+        BrowserSwitchRequestCodes.CARD_APPROVE_ORDER
+    } else if (isCardVault(klass)) {
+        BrowserSwitchRequestCodes.CARD_VAULT
+    } else if (isPayPalVault(klass)) {
         BrowserSwitchRequestCodes.PAYPAL_VAULT
     } else if (isPayPalCheckout(klass)) {
         BrowserSwitchRequestCodes.PAYPAL_CHECKOUT
@@ -77,13 +92,18 @@ inline fun <reified T : DeepLink> captureDeepLink(
     val isMatchingDeepLink =
         isCustomSchemeMatch(options, deepLinkUri) || isAppLinkMatch(options, deepLinkUri)
     return if (isMatchingDeepLink) {
-        val deepLink = if (isPayPalVault(klass)) {
+        val deepLink = if (isCardApproveOrder(klass)) {
+            CardApproveOrderComplete(deepLinkUri, options)
+        } else if (isCardVault(klass)) {
+            CardVaultComplete(deepLinkUri, options)
+        } else if (isPayPalVault(klass)) {
             PayPalVaultComplete(deepLinkUri, options)
         } else if (isPayPalCheckout(klass)) {
             PayPalCheckoutComplete(deepLinkUri, options)
         } else {
             null
         }
+
         if (deepLink is T) {
             CaptureDeepLinkResult.Success(deepLink)
         } else {