3DS2 Analytics Delegate

3ds2playground/src/main/kotlin/com/stripe/android/stripe3ds2playground/MainActivity.kt

@@ -409,7 +409,8 @@ class MainActivity : AppCompatActivity() {
         StripeThreeDs2ServiceImpl(
             this,
             enableLogging = true,
-            workContext = Dispatchers.IO
+            workContext = Dispatchers.IO,
+            analyticsDelegate = null
         )
     }
 

3ds2sdk/api/3ds2sdk.api

@@ -400,6 +400,16 @@ public final class com/stripe/android/stripe3ds2/security/StripeEphemeralKeyPair
 	public fun generate ()Ljava/security/KeyPair;
 }
 
+public final class com/stripe/android/stripe3ds2/service/AnalyticsSingleton {
+	public static final field Companion Lcom/stripe/android/stripe3ds2/service/AnalyticsSingleton$Companion;
+	public final fun getAnalyticsDelegate ()Lcom/stripe/android/stripe3ds2/utils/AnalyticsDelegate;
+	public final fun setAnalyticsDelegate (Lcom/stripe/android/stripe3ds2/utils/AnalyticsDelegate;)V
+}
+
+public final class com/stripe/android/stripe3ds2/service/AnalyticsSingleton$Companion {
+	public final fun getInstance ()Lcom/stripe/android/stripe3ds2/service/AnalyticsSingleton;
+}
+
 public abstract interface class com/stripe/android/stripe3ds2/service/StripeThreeDs2Service {
 	public abstract fun cleanup ()V
 	public abstract fun createTransaction (Lcom/stripe/android/stripe3ds2/transaction/SdkTransactionId;Ljava/lang/String;Ljava/lang/String;ZLjava/lang/String;Ljava/util/List;Ljava/security/PublicKey;Ljava/lang/String;Lcom/stripe/android/stripe3ds2/init/ui/StripeUiCustomization;)Lcom/stripe/android/stripe3ds2/transaction/Transaction;
@@ -408,11 +418,11 @@ public abstract interface class com/stripe/android/stripe3ds2/service/StripeThre
 }
 
 public final class com/stripe/android/stripe3ds2/service/StripeThreeDs2ServiceImpl : com/stripe/android/stripe3ds2/service/StripeThreeDs2Service {
-	public fun <init> (Landroid/content/Context;Ljava/lang/String;ZLkotlin/coroutines/CoroutineContext;)V
-	public synthetic fun <init> (Landroid/content/Context;Ljava/lang/String;ZLkotlin/coroutines/CoroutineContext;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
-	public fun <init> (Landroid/content/Context;Lkotlin/coroutines/CoroutineContext;)V
-	public fun <init> (Landroid/content/Context;ZLkotlin/coroutines/CoroutineContext;)V
-	public synthetic fun <init> (Landroid/content/Context;ZLkotlin/coroutines/CoroutineContext;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Landroid/content/Context;Lcom/stripe/android/stripe3ds2/utils/AnalyticsDelegate;Lkotlin/coroutines/CoroutineContext;)V
+	public fun <init> (Landroid/content/Context;Ljava/lang/String;ZLcom/stripe/android/stripe3ds2/utils/AnalyticsDelegate;Lkotlin/coroutines/CoroutineContext;)V
+	public synthetic fun <init> (Landroid/content/Context;Ljava/lang/String;ZLcom/stripe/android/stripe3ds2/utils/AnalyticsDelegate;Lkotlin/coroutines/CoroutineContext;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Landroid/content/Context;ZLcom/stripe/android/stripe3ds2/utils/AnalyticsDelegate;Lkotlin/coroutines/CoroutineContext;)V
+	public synthetic fun <init> (Landroid/content/Context;ZLcom/stripe/android/stripe3ds2/utils/AnalyticsDelegate;Lkotlin/coroutines/CoroutineContext;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun cleanup ()V
 	public fun createTransaction (Lcom/stripe/android/stripe3ds2/transaction/SdkTransactionId;Ljava/lang/String;Ljava/lang/String;ZLjava/lang/String;Ljava/util/List;Ljava/security/PublicKey;Ljava/lang/String;Lcom/stripe/android/stripe3ds2/init/ui/StripeUiCustomization;)Lcom/stripe/android/stripe3ds2/transaction/Transaction;
 	public fun getPublicKey (Ljava/lang/String;)Ljava/security/PublicKey;
@@ -1393,6 +1403,15 @@ public final class com/stripe/android/stripe3ds2/transactions/UiType : java/lang
 	public static fun values ()[Lcom/stripe/android/stripe3ds2/transactions/UiType;
 }
 
+public abstract interface class com/stripe/android/stripe3ds2/utils/AnalyticsDelegate {
+	public abstract fun cancelButtonTappedWithTransactionId (Ljava/lang/String;)V
+	public abstract fun didReceiveChallengeResponseWithTransactionId (Ljava/lang/String;Ljava/lang/String;)V
+	public abstract fun oobContinueButtonTappedWithTransactionID (Ljava/lang/String;)V
+	public abstract fun oobFlowDidPause (Ljava/lang/String;)V
+	public abstract fun oobFlowDidResume (Ljava/lang/String;)V
+	public abstract fun otpSubmitButtonTappedWithTransactionID (Ljava/lang/String;)V
+}
+
 public final class com/stripe/android/stripe3ds2/utils/CustomizeUtils {
 	public static final field INSTANCE Lcom/stripe/android/stripe3ds2/utils/CustomizeUtils;
 	public final fun buildStyledText (Landroid/content/Context;Ljava/lang/String;Lcom/stripe/android/stripe3ds2/init/ui/Customization;)Landroid/text/SpannableString;

3ds2sdk/src/main/kotlin/com/stripe/android/stripe3ds2/service/StripeThreeDs2ServiceImpl.kt

@@ -24,6 +24,7 @@ import com.stripe.android.stripe3ds2.transaction.MessageVersionRegistry
 import com.stripe.android.stripe3ds2.transaction.SdkTransactionId
 import com.stripe.android.stripe3ds2.transaction.Transaction
 import com.stripe.android.stripe3ds2.transaction.TransactionFactory
+import com.stripe.android.stripe3ds2.utils.AnalyticsDelegate
 import com.stripe.android.stripe3ds2.utils.ImageCache
 import com.stripe.android.stripe3ds2.views.Brand
 import java.security.PublicKey
@@ -36,30 +37,36 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
     private val errorReporter: ErrorReporter,
     private val transactionFactory: TransactionFactory,
     private val publicKeyFactory: PublicKeyFactory,
+    private val analyticsDelegate: AnalyticsDelegate?,
     override val warnings: List<Warning>,
 ) : StripeThreeDs2Service {
+
     @JvmOverloads
     constructor(
         context: Context,
         enableLogging: Boolean = false,
+        analyticsDelegate: AnalyticsDelegate?,
         workContext: CoroutineContext
     ) : this(
         context,
         STRIPE_SDK_REFERENCE_NUMBER,
         enableLogging,
+        analyticsDelegate,
         workContext
     )
 
     constructor(
         context: Context,
         sdkReferenceNumber: String,
         enableLogging: Boolean = false,
+        analyticsDelegate: AnalyticsDelegate?,
         workContext: CoroutineContext
     ) : this(
         context,
         ImageCache.Default,
         sdkReferenceNumber,
         enableLogging,
+        analyticsDelegate,
         workContext = workContext
     )
 
@@ -68,6 +75,7 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
         imageCache: ImageCache,
         sdkReferenceNumber: String,
         enableLogging: Boolean,
+        analyticsDelegate: AnalyticsDelegate?,
         workContext: CoroutineContext
     ) : this(
         context,
@@ -78,6 +86,7 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
             context = context.applicationContext,
             logger = Logger.get(enableLogging)
         ),
+        analyticsDelegate,
         workContext
     )
 
@@ -86,6 +95,7 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
         imageCache: ImageCache,
         sdkReferenceNumber: String,
         errorReporter: ErrorReporter,
+        analyticsDelegate: AnalyticsDelegate?,
         workContext: CoroutineContext
     ) : this(
         context,
@@ -95,6 +105,7 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
         StripeEphemeralKeyPairGenerator(errorReporter),
         DefaultSecurityChecker(),
         MessageVersionRegistry(),
+        analyticsDelegate,
         DefaultAppInfoRepository(context, workContext),
         workContext
     )
@@ -107,6 +118,7 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
         ephemeralKeyPairGenerator: EphemeralKeyPairGenerator,
         securityChecker: SecurityChecker,
         messageVersionRegistry: MessageVersionRegistry,
+        analyticsDelegate: AnalyticsDelegate?,
         appInfoRepository: AppInfoRepository,
         workContext: CoroutineContext
     ) : this(
@@ -132,10 +144,15 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
             ephemeralKeyPairGenerator,
             sdkReferenceNumber,
         ),
+        analyticsDelegate = analyticsDelegate,
         warnings = securityChecker.getWarnings(),
         publicKeyFactory = PublicKeyFactory(context, errorReporter)
     )
 
+    init {
+        AnalyticsSingleton.getInstance().analyticsDelegate = analyticsDelegate
+    }
+
     @Throws(InvalidInputException::class, SDKRuntimeException::class)
     override fun createTransaction(
         sdkTransactionId: SdkTransactionId,
@@ -200,3 +217,18 @@ class StripeThreeDs2ServiceImpl @VisibleForTesting internal constructor(
         private const val STRIPE_SDK_REFERENCE_NUMBER = "3DS_LOA_SDK_STIN_020100_00142"
     }
 }
+
+class AnalyticsSingleton private constructor() {
+
+    var analyticsDelegate: AnalyticsDelegate? = null
+
+    companion object {
+
+        @Volatile private var instance: AnalyticsSingleton? = null // Volatile modifier is necessary
+
+        fun getInstance() =
+            instance ?: synchronized(this) { // synchronized to avoid concurrency problem
+                instance ?: AnalyticsSingleton().also { instance = it }
+            }
+    }
+}

3ds2sdk/src/main/kotlin/com/stripe/android/stripe3ds2/utils/AnalyticsDelegate.kt

@@ -0,0 +1,15 @@
+package com.stripe.android.stripe3ds2.utils
+
+interface AnalyticsDelegate {
+    fun didReceiveChallengeResponseWithTransactionId(transactionId: String, flow: String)
+
+    fun cancelButtonTappedWithTransactionId(transactionId: String)
+
+    fun otpSubmitButtonTappedWithTransactionID(transactionId: String)
+
+    fun oobContinueButtonTappedWithTransactionID(transactionId: String)
+
+    fun oobFlowDidPause(transactionId: String)
+
+    fun oobFlowDidResume(transactionId: String)
+}

3ds2sdk/src/main/kotlin/com/stripe/android/stripe3ds2/views/ChallengeActivity.kt

@@ -15,6 +15,7 @@ import com.stripe.android.stripe3ds2.init.ui.UiCustomization
 import com.stripe.android.stripe3ds2.observability.DefaultErrorReporter
 import com.stripe.android.stripe3ds2.observability.ErrorReporter
 import com.stripe.android.stripe3ds2.observability.Stripe3ds2ErrorReporterConfig
+import com.stripe.android.stripe3ds2.service.AnalyticsSingleton
 import com.stripe.android.stripe3ds2.transaction.ChallengeAction
 import com.stripe.android.stripe3ds2.transaction.ChallengeActionHandler
 import com.stripe.android.stripe3ds2.transaction.ChallengeResult
@@ -93,11 +94,14 @@ class ChallengeActivity : AppCompatActivity() {
     }
 
     private var progressDialog: Dialog? = null
-    private var currentUITypeCode = ""
+
+    private var currentChallengeResponseData: ChallengeResponseData? = null
+    private val analyticsDelegate = AnalyticsSingleton.getInstance().analyticsDelegate
 
     override fun onCreate(savedInstanceState: Bundle?) {
         supportFragmentManager.fragmentFactory = ChallengeFragmentFactory(
             uiCustomization = viewArgs.uiCustomization,
+            analyticsDelegate = analyticsDelegate,
             transactionTimer = transactionTimer,
             errorRequestExecutor = errorRequestExecutor,
             errorReporter = errorReporter,
@@ -158,7 +162,7 @@ class ChallengeActivity : AppCompatActivity() {
             if (cres != null) {
                 startFragment(cres)
 
-                currentUITypeCode = cres.uiType?.code.orEmpty()
+                currentChallengeResponseData = cres
             }
         }
 
@@ -170,13 +174,15 @@ class ChallengeActivity : AppCompatActivity() {
             if (isTimeout == true) {
                 viewModel.onFinish(
                     ChallengeResult.Timeout(
-                        currentUITypeCode,
+                        currentChallengeResponseData?.uiType?.code.orEmpty(),
                         viewArgs.cresData.uiType,
                         viewArgs.intentData
                     )
                 )
             }
         }
+
+        currentChallengeResponseData = viewArgs.cresData
     }
 
     private fun startFragment(
@@ -215,7 +221,11 @@ class ChallengeActivity : AppCompatActivity() {
     override fun onPause() {
         super.onPause()
         viewModel.shouldRefreshUi = true
-        viewModel.shouldAutoSubmitOOB = UiType.fromCode(currentUITypeCode) == UiType.OutOfBand
+
+        val uiType = UiType.fromCode(currentChallengeResponseData?.uiType?.code.orEmpty())
+        val isOutOfBandChallenge = uiType == UiType.OutOfBand
+        viewModel.shouldAutoSubmitOOB = isOutOfBandChallenge
+
         dismissKeyboard()
     }
 
@@ -240,6 +250,10 @@ class ChallengeActivity : AppCompatActivity() {
         cancelButton?.setOnClickListener {
             cancelButton.isClickable = false
             viewModel.submit(ChallengeAction.Cancel)
+
+            currentChallengeResponseData?.let {
+                analyticsDelegate?.cancelButtonTappedWithTransactionId(it.serverTransId)
+            }
         }
     }
 

3ds2sdk/src/main/kotlin/com/stripe/android/stripe3ds2/views/ChallengeFragment.kt

@@ -25,10 +25,12 @@ import com.stripe.android.stripe3ds2.transactions.ChallengeRequestData
 import com.stripe.android.stripe3ds2.transactions.ChallengeResponseData
 import com.stripe.android.stripe3ds2.transactions.ErrorData
 import com.stripe.android.stripe3ds2.transactions.UiType
+import com.stripe.android.stripe3ds2.utils.AnalyticsDelegate
 import kotlin.coroutines.CoroutineContext
 
 internal class ChallengeFragment(
     private val uiCustomization: StripeUiCustomization,
+    private val analyticsDelegate: AnalyticsDelegate?,
     private val transactionTimer: TransactionTimer,
     private val errorRequestExecutor: ErrorRequestExecutor,
     private val errorReporter: ErrorReporter,
@@ -119,7 +121,9 @@ internal class ChallengeFragment(
             )
             return
         }
+
         cresData = nullableCres
+        analyticsDelegate?.didReceiveChallengeResponseWithTransactionId(cresData.serverTransId, uiTypeCode)
 
         _viewBinding = StripeChallengeFragmentBinding.bind(view)
 
@@ -147,6 +151,22 @@ internal class ChallengeFragment(
         configureInformationZoneView()
     }
 
+    override fun onResume() {
+        super.onResume()
+
+        if (cresData.uiType == UiType.OutOfBand) {
+            analyticsDelegate?.oobFlowDidResume(cresData.serverTransId)
+        }
+    }
+
+    override fun onPause() {
+        super.onPause()
+
+        if (cresData.uiType == UiType.OutOfBand) {
+            analyticsDelegate?.oobFlowDidPause(cresData.serverTransId)
+        }
+    }
+
     override fun onDestroyView() {
         super.onDestroyView()
         _viewBinding = null
@@ -269,6 +289,15 @@ internal class ChallengeFragment(
 
         challengeZoneView.setSubmitButtonClickListener {
             viewModel.onSubmitClicked(challengeAction)
+
+            when (cresData.uiType) {
+                UiType.Text ->
+                    analyticsDelegate?.otpSubmitButtonTappedWithTransactionID(cresData.serverTransId)
+                UiType.OutOfBand ->
+                    analyticsDelegate?.oobContinueButtonTappedWithTransactionID((cresData.serverTransId))
+                UiType.SingleSelect, UiType.MultiSelect, UiType.Html -> { }
+                null -> { }
+            }
         }
         challengeZoneView.setResendButtonClickListener {
             viewModel.submit(ChallengeAction.Resend)
@@ -340,6 +369,8 @@ internal class ChallengeFragment(
         } else {
             viewModel.onNextScreen(cresData)
         }
+
+        analyticsDelegate?.didReceiveChallengeResponseWithTransactionId(cresData.serverTransId, uiTypeCode)
     }
 
     private fun onError(data: ErrorData) {

3ds2sdk/src/main/kotlin/com/stripe/android/stripe3ds2/views/ChallengeFragmentFactory.kt

@@ -9,10 +9,12 @@ import com.stripe.android.stripe3ds2.transaction.ErrorRequestExecutor
 import com.stripe.android.stripe3ds2.transaction.IntentData
 import com.stripe.android.stripe3ds2.transaction.TransactionTimer
 import com.stripe.android.stripe3ds2.transactions.UiType
+import com.stripe.android.stripe3ds2.utils.AnalyticsDelegate
 import kotlin.coroutines.CoroutineContext
 
 internal class ChallengeFragmentFactory(
     private val uiCustomization: StripeUiCustomization,
+    private val analyticsDelegate: AnalyticsDelegate?,
     private val transactionTimer: TransactionTimer,
     private val errorRequestExecutor: ErrorRequestExecutor,
     private val errorReporter: ErrorReporter,
@@ -26,6 +28,7 @@ internal class ChallengeFragmentFactory(
             ChallengeFragment::class.java.name -> {
                 ChallengeFragment(
                     uiCustomization,
+                    analyticsDelegate,
                     transactionTimer,
                     errorRequestExecutor,
                     errorReporter,

3ds2sdk/src/test/kotlin/com/stripe/android/stripe3ds2/service/StripeThreeDs2ServiceImplTest.kt

@@ -48,6 +48,7 @@ class StripeThreeDs2ServiceImplTest {
             errorReporter,
             transactionFactory,
             publicKeyFactory,
+            null,
             warnings
         )
     }