Report event when card requires more than 16 digits

Author: samer-stripe

payments-core/src/main/java/com/stripe/android/networking/PaymentAnalyticsEvent.kt

@@ -1,9 +1,11 @@
 package com.stripe.android.networking
 
 import androidx.annotation.Keep
+import androidx.annotation.RestrictTo
 import com.stripe.android.core.networking.AnalyticsEvent
 
-internal enum class PaymentAnalyticsEvent(val code: String) : AnalyticsEvent {
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+enum class PaymentAnalyticsEvent(val code: String) : AnalyticsEvent {
     // Token
     TokenCreate("token_creation"),
 
@@ -104,7 +106,10 @@ internal enum class PaymentAnalyticsEvent(val code: String) : AnalyticsEvent {
 
     CardMetadataLoadedTooSlow("card_metadata_loaded_too_slow"),
     CardMetadataLoadFailure("card_metadata_load_failure"),
-    CardMetadataMissingRange("card_metadata_missing_range");
+    CardMetadataMissingRange("card_metadata_missing_range"),
+    CardMetadataExpectedExtraDigitsButUserEntered16ThenSwitchedFields(
+        "card_metadata.expected_extra_digits_but_user_entered_16_then_switched_fields"
+    );
 
     @Keep
     override fun toString(): String {

payments-ui-core/src/main/java/com/stripe/android/ui/core/elements/CardNumberController.kt

@@ -25,8 +25,10 @@ import com.stripe.android.core.strings.ResolvableString
 import com.stripe.android.core.strings.resolvableString
 import com.stripe.android.model.AccountRange
 import com.stripe.android.model.CardBrand
+import com.stripe.android.networking.PaymentAnalyticsEvent
 import com.stripe.android.stripecardscan.cardscan.CardScanSheetResult
 import com.stripe.android.ui.core.R
+import com.stripe.android.ui.core.elements.events.LocalAnalyticsEventReporter
 import com.stripe.android.ui.core.elements.events.LocalCardBrandDisallowedReporter
 import com.stripe.android.ui.core.elements.events.LocalCardNumberCompletedEventReporter
 import com.stripe.android.uicore.elements.FieldError
@@ -45,6 +47,7 @@ import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.collectLatest
+import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.drop
 import kotlin.coroutines.CoroutineContext
 import com.stripe.android.R as PaymentsCoreR
@@ -368,9 +371,13 @@ internal class DefaultCardNumberController(
     ) {
         val reporter = LocalCardNumberCompletedEventReporter.current
         val disallowedBrandReporter = LocalCardBrandDisallowedReporter.current
+        val analyticsEventReporter = LocalAnalyticsEventReporter.current
 
         // Remember the last state indicating whether it was a disallowed card brand error
         var lastLoggedCardBrand by rememberSaveable { mutableStateOf<CardBrand?>(null) }
+        var hasReportedIncompleteCardNumberRequiringMoreThan16Digits by rememberSaveable {
+            mutableStateOf(false)
+        }
 
         LaunchedEffect(Unit) {
             // Drop the set empty value & initial value
@@ -395,6 +402,27 @@ internal class DefaultCardNumberController(
             }
         }
 
+        LaunchedEffect(Unit) {
+            combine(
+                fieldState.drop(1),
+                fieldValue,
+                _hasFocus,
+            ) { state, fieldValue, hasFocus ->
+                state is TextFieldStateConstants.Error.Incomplete &&
+                    !hasFocus &&
+                    !hasReportedIncompleteCardNumberRequiringMoreThan16Digits &&
+                    fieldValue.length == 16
+            }.collectLatest {
+                if (it) {
+                    analyticsEventReporter.onAnalyticsEvent(
+                        PaymentAnalyticsEvent.CardMetadataExpectedExtraDigitsButUserEntered16ThenSwitchedFields
+                    )
+
+                    hasReportedIncompleteCardNumberRequiringMoreThan16Digits = true
+                }
+            }
+        }
+
         super.ComposeUI(
             enabled,
             field,

payments-ui-core/src/main/java/com/stripe/android/ui/core/elements/events/AnalyticsEventReporter.kt

@@ -0,0 +1,27 @@
+package com.stripe.android.ui.core.elements.events
+
+import androidx.annotation.RestrictTo
+import androidx.compose.runtime.staticCompositionLocalOf
+import com.stripe.android.core.networking.AnalyticsEvent
+import com.stripe.android.uicore.BuildConfig
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+fun interface AnalyticsEventReporter {
+    fun onAnalyticsEvent(event: AnalyticsEvent)
+}
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+val LocalAnalyticsEventReporter =
+    staticCompositionLocalOf<AnalyticsEventReporter> {
+        EmptyAnalyticsEventReporter
+    }
+
+private object EmptyAnalyticsEventReporter : AnalyticsEventReporter {
+    override fun onAnalyticsEvent(event: AnalyticsEvent) {
+        if (BuildConfig.DEBUG) {
+            error(
+                "AnalyticsEventReporter.${event.eventName} was not reported"
+            )
+        }
+    }
+}

paymentsheet/src/main/java/com/stripe/android/customersheet/CustomerSheetViewAction.kt

@@ -1,5 +1,6 @@
 package com.stripe.android.customersheet
 
+import com.stripe.android.core.networking.AnalyticsEvent
 import com.stripe.android.core.strings.ResolvableString
 import com.stripe.android.lpmfoundations.luxe.SupportedPaymentMethod
 import com.stripe.android.model.CardBrand
@@ -13,6 +14,7 @@ internal sealed class CustomerSheetViewAction {
     object OnBackPressed : CustomerSheetViewAction()
     object OnEditPressed : CustomerSheetViewAction()
     object OnCardNumberInputCompleted : CustomerSheetViewAction()
+    class OnAnalyticsEvent(val event: AnalyticsEvent) : CustomerSheetViewAction()
     object OnAddCardPressed : CustomerSheetViewAction()
     object OnPrimaryButtonPressed : CustomerSheetViewAction()
     object OnCancelClose : CustomerSheetViewAction()

paymentsheet/src/main/java/com/stripe/android/customersheet/CustomerSheetViewModel.kt

@@ -16,6 +16,7 @@ import com.stripe.android.core.Logger
 import com.stripe.android.core.exception.StripeException
 import com.stripe.android.core.injection.IOContext
 import com.stripe.android.core.injection.IS_LIVE_MODE
+import com.stripe.android.core.networking.AnalyticsEvent
 import com.stripe.android.core.networking.ApiRequest
 import com.stripe.android.core.strings.ResolvableString
 import com.stripe.android.core.strings.orEmpty
@@ -271,6 +272,7 @@ internal class CustomerSheetViewModel(
             is CustomerSheetViewAction.OnAddCardPressed -> onAddCardPressed()
             is CustomerSheetViewAction.OnCardNumberInputCompleted -> onCardNumberInputCompleted()
             is CustomerSheetViewAction.OnDisallowedCardBrandEntered -> onDisallowedCardBrandEntered(viewAction.brand)
+            is CustomerSheetViewAction.OnAnalyticsEvent -> onAnalyticsEvent(viewAction.event)
             is CustomerSheetViewAction.OnBackPressed -> onBackPressed()
             is CustomerSheetViewAction.OnEditPressed -> onEditPressed()
             is CustomerSheetViewAction.OnModifyItem -> onModifyItem(viewAction.paymentMethod)
@@ -917,6 +919,10 @@ internal class CustomerSheetViewModel(
         eventReporter.onCardNumberCompleted()
     }
 
+    private fun onAnalyticsEvent(event: AnalyticsEvent) {
+        eventReporter.onAnalyticsEvent(event)
+    }
+
     private fun onDisallowedCardBrandEntered(brand: CardBrand) {
         eventReporter.onDisallowedCardBrandEntered(brand)
     }

paymentsheet/src/main/java/com/stripe/android/customersheet/analytics/CustomerSheetEventReporter.kt

@@ -1,5 +1,6 @@
 package com.stripe.android.customersheet.analytics
 
+import com.stripe.android.core.networking.AnalyticsEvent
 import com.stripe.android.customersheet.CustomerSheet
 import com.stripe.android.customersheet.CustomerSheetIntegration
 import com.stripe.android.model.CardBrand
@@ -129,6 +130,8 @@ internal interface CustomerSheetEventReporter {
 
     fun onDisallowedCardBrandEntered(brand: CardBrand)
 
+    fun onAnalyticsEvent(event: AnalyticsEvent)
+
     enum class Screen(val value: String) {
         AddPaymentMethod("add_payment_method"),
         SelectPaymentMethod("select_payment_method"),

paymentsheet/src/main/java/com/stripe/android/customersheet/analytics/DefaultCustomerSheetEventReporter.kt

@@ -1,6 +1,7 @@
 package com.stripe.android.customersheet.analytics
 
 import com.stripe.android.core.injection.IOContext
+import com.stripe.android.core.networking.AnalyticsEvent
 import com.stripe.android.core.networking.AnalyticsRequestExecutor
 import com.stripe.android.core.networking.AnalyticsRequestFactory
 import com.stripe.android.customersheet.CustomerSheet
@@ -215,6 +216,17 @@ internal class DefaultCustomerSheetEventReporter @Inject constructor(
         )
     }
 
+    override fun onAnalyticsEvent(event: AnalyticsEvent) {
+        CoroutineScope(workContext).launch {
+            analyticsRequestExecutor.executeAsync(
+                analyticsRequestFactory.createRequest(
+                    event = event,
+                    additionalParams = emptyMap(),
+                )
+            )
+        }
+    }
+
     private fun fireEvent(event: CustomerSheetEvent) {
         CoroutineScope(workContext).launch {
             analyticsRequestExecutor.executeAsync(

paymentsheet/src/main/java/com/stripe/android/customersheet/ui/CustomerSheetScreen.kt

@@ -18,6 +18,7 @@ import androidx.compose.ui.unit.dp
 import com.stripe.android.common.ui.BottomSheetLoadingIndicator
 import com.stripe.android.common.ui.BottomSheetScaffold
 import com.stripe.android.common.ui.PrimaryButton
+import com.stripe.android.core.networking.AnalyticsEvent
 import com.stripe.android.core.strings.ResolvableString
 import com.stripe.android.customersheet.CustomerSheetViewAction
 import com.stripe.android.customersheet.CustomerSheetViewModel
@@ -35,8 +36,10 @@ import com.stripe.android.paymentsheet.utils.PaymentSheetContentPadding
 import com.stripe.android.ui.core.elements.H4Text
 import com.stripe.android.ui.core.elements.Mandate
 import com.stripe.android.ui.core.elements.SimpleDialogElementUI
+import com.stripe.android.ui.core.elements.events.AnalyticsEventReporter
 import com.stripe.android.ui.core.elements.events.CardBrandDisallowedReporter
 import com.stripe.android.ui.core.elements.events.CardNumberCompletedEventReporter
+import com.stripe.android.ui.core.elements.events.LocalAnalyticsEventReporter
 import com.stripe.android.ui.core.elements.events.LocalCardBrandDisallowedReporter
 import com.stripe.android.ui.core.elements.events.LocalCardNumberCompletedEventReporter
 import com.stripe.android.uicore.strings.resolve
@@ -231,11 +234,15 @@ internal fun AddPaymentMethod(
         DefaultCardBrandDisallowedReporter(viewActionHandler)
     }
 
+    val analyticsEventReporter = remember(viewActionHandler) {
+        DefaultAnalyticsEventReporter(viewActionHandler)
+    }
+
     if (displayForm) {
         CompositionLocalProvider(
             LocalCardNumberCompletedEventReporter provides eventReporter,
-            LocalCardBrandDisallowedReporter provides disallowedReporter
-
+            LocalCardBrandDisallowedReporter provides disallowedReporter,
+            LocalAnalyticsEventReporter provides analyticsEventReporter,
         ) {
             PaymentElement(
                 enabled = viewState.enabled,
@@ -334,6 +341,14 @@ const val CUSTOMER_SHEET_CONFIRM_BUTTON_TEST_TAG = "CustomerSheetConfirmButton"
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 const val CUSTOMER_SHEET_SAVE_BUTTON_TEST_TAG = "CustomerSheetSaveButton"
 
+private class DefaultAnalyticsEventReporter(
+    private val viewActionHandler: (event: CustomerSheetViewAction) -> Unit
+) : AnalyticsEventReporter {
+    override fun onAnalyticsEvent(event: AnalyticsEvent) {
+        viewActionHandler.invoke(CustomerSheetViewAction.OnAnalyticsEvent(event))
+    }
+}
+
 private class DefaultCardNumberCompletedEventReporter(
     private val viewActionHandler: (CustomerSheetViewAction) -> Unit
 ) : CardNumberCompletedEventReporter {

paymentsheet/src/main/java/com/stripe/android/paymentsheet/analytics/DefaultEventReporter.kt

@@ -4,6 +4,7 @@ import android.content.Context
 import com.stripe.android.common.analytics.experiment.LoggableExperiment
 import com.stripe.android.common.model.CommonConfiguration
 import com.stripe.android.core.injection.IOContext
+import com.stripe.android.core.networking.AnalyticsEvent
 import com.stripe.android.core.networking.AnalyticsRequestExecutor
 import com.stripe.android.core.networking.AnalyticsRequestV2Executor
 import com.stripe.android.core.networking.AnalyticsRequestV2Factory
@@ -548,6 +549,17 @@ internal class DefaultEventReporter @Inject internal constructor(
         fireEvent(analyticsEvent)
     }
 
+    override fun onAnalyticsEvent(event: AnalyticsEvent) {
+        CoroutineScope(workContext).launch {
+            analyticsRequestExecutor.executeAsync(
+                paymentAnalyticsRequestFactory.createRequest(
+                    event = event,
+                    additionalParams = emptyMap(),
+                )
+            )
+        }
+    }
+
     private fun fireEvent(event: PaymentSheetEvent) {
         CoroutineScope(workContext).launch {
             analyticsRequestExecutor.executeAsync(

paymentsheet/src/main/java/com/stripe/android/paymentsheet/analytics/EventReporter.kt

@@ -3,6 +3,7 @@ package com.stripe.android.paymentsheet.analytics
 import androidx.annotation.Keep
 import com.stripe.android.common.analytics.experiment.LoggableExperiment
 import com.stripe.android.common.model.CommonConfiguration
+import com.stripe.android.core.networking.AnalyticsEvent
 import com.stripe.android.model.CardBrand
 import com.stripe.android.model.LinkMode
 import com.stripe.android.model.PaymentMethodCode
@@ -123,6 +124,8 @@ internal interface EventReporter {
 
     fun onDisallowedCardBrandEntered(brand: CardBrand)
 
+    fun onAnalyticsEvent(event: AnalyticsEvent)
+
     /**
      * The customer has pressed the confirm button.
      */

paymentsheet/src/main/java/com/stripe/android/paymentsheet/utils/EventReporterProviderUtil.kt

@@ -3,6 +3,7 @@ package com.stripe.android.paymentsheet.utils
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.CompositionLocalProvider
 import com.stripe.android.paymentsheet.analytics.EventReporter
+import com.stripe.android.ui.core.elements.events.LocalAnalyticsEventReporter
 import com.stripe.android.ui.core.elements.events.LocalCardBrandDisallowedReporter
 import com.stripe.android.ui.core.elements.events.LocalCardNumberCompletedEventReporter
 import com.stripe.android.uicore.elements.LocalAutofillEventReporter
@@ -15,7 +16,8 @@ internal fun EventReporterProvider(
     CompositionLocalProvider(
         LocalAutofillEventReporter provides eventReporter::onAutofill,
         LocalCardNumberCompletedEventReporter provides eventReporter::onCardNumberCompleted,
-        LocalCardBrandDisallowedReporter provides eventReporter::onDisallowedCardBrandEntered
+        LocalCardBrandDisallowedReporter provides eventReporter::onDisallowedCardBrandEntered,
+        LocalAnalyticsEventReporter provides eventReporter::onAnalyticsEvent,
     ) {
         content()
     }