Make several logging improvements for FC

- Fix `extraMessage` in `ErrorViewModel`
- Report `pane` in various events
- Add `status` to complete event

financial-connections/detekt-baseline.xml

@@ -7,6 +7,7 @@
  <ID>LongMethod:AccountItem.kt$@Composable @Preview internal fun AccountItemPreview()</ID>
  <ID>LongMethod:Button.kt$@Composable internal fun FinancialConnectionsButton( onClick: () -> Unit, modifier: Modifier = Modifier, type: Type = Primary, size: FinancialConnectionsButton.Size = FinancialConnectionsButton.Size.Regular, enabled: Boolean = true, loading: Boolean = false, content: @Composable (RowScope.() -> Unit) )</ID>
  <ID>LongMethod:FinancialConnectionsSheetNativeActivity.kt$FinancialConnectionsSheetNativeActivity$@Composable fun NavHost( initialPane: Pane, testMode: Boolean, )</ID>
+ <ID>LongMethod:FinancialConnectionsSheetNativeViewModel.kt$FinancialConnectionsSheetNativeViewModel$private fun closeAuthFlow( earlyTerminationCause: EarlyTerminationCause? = null, closeAuthFlowError: Throwable? = null )</ID>
  <ID>LongMethod:InstitutionPickerScreen.kt$private fun LazyListScope.searchResults( isInputEmpty: Boolean, payload: Payload, selectedInstitutionId: String?, onInstitutionSelected: (FinancialConnectionsInstitution, Boolean) -> Unit, institutions: Async&lt;InstitutionResponse>, onManualEntryClick: () -> Unit, onSearchMoreClick: () -> Unit )</ID>
  <ID>LongMethod:LinkAccountPickerPreviewParameterProvider.kt$LinkAccountPickerPreviewParameterProvider$private fun partnerAccountList()</ID>
  <ID>LongMethod:NetworkingSaveToLinkVerificationScreen.kt$@Composable private fun NetworkingSaveToLinkVerificationLoaded( confirmVerificationAsync: Async&lt;Unit>, payload: Payload, onCloseFromErrorClick: (Throwable) -> Unit, onSkipClick: () -> Unit, )</ID>

financial-connections/src/main/java/com/stripe/android/financialconnections/analytics/FinancialConnectionsAnalyticsEvent.kt

@@ -67,14 +67,18 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  )
 
  class Complete(
+ pane: Pane,
  exception: Throwable?,
  exceptionExtraMessage: String?,
- connectedAccounts: Int?
+ connectedAccounts: Int?,
+ status: String,
  ) : FinancialConnectionsAnalyticsEvent(
  name = "complete",
  mapOf(
+ "pane" to pane.analyticsValue,
  "num_linked_accounts" to connectedAccounts?.toString(),
- "type" to if (exception == null) "object" else "error"
+ "type" to if (exception == null) "object" else "error",
+ "status" to status,
  )
  .plus(exception?.toEventParams(exceptionExtraMessage) ?: emptyMap())
  .filterNotNullValues()
@@ -89,15 +93,6 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  ).filterNotNullValues()
  )
 
- class ClickDisconnectLink(
- pane: Pane
- ) : FinancialConnectionsAnalyticsEvent(
- name = "click.disconnect_link",
- mapOf(
- "pane" to pane.analyticsValue,
- ).filterNotNullValues()
- )
-
  class Click(
  eventName: String,
  pane: Pane
@@ -171,17 +166,20 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  )
 
  class PollAccountsSucceeded(
+ pane: Pane,
  authSessionId: String,
  duration: Long
  ) : FinancialConnectionsAnalyticsEvent(
  name = "polling.accounts.success",
  mapOf(
+ "pane" to pane.analyticsValue,
  "authSessionId" to authSessionId,
  "duration" to duration.toString(),
  ).filterNotNullValues()
  )
 
  class AccountSelected(
+ pane: Pane,
  selected: Boolean,
  isSingleAccount: Boolean,
  accountId: String,
@@ -192,6 +190,7 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  "click.account_picker.account_unselected"
  },
  mapOf(
+ "pane" to pane.analyticsValue,
  "is_single_account" to isSingleAccount.toString(),
  "account" to accountId,
  ).filterNotNullValues()
@@ -211,22 +210,26 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  )
 
  class AccountsAutoSelected(
+ pane: Pane,
  accountIds: Set<String>,
  isSingleAccount: Boolean
  ) : FinancialConnectionsAnalyticsEvent(
  name = "account_picker.accounts_auto_selected",
  mapOf(
+ "pane" to pane.analyticsValue,
  "account_ids" to accountIds.joinToString(" "),
  "is_single_account" to isSingleAccount.toString(),
  ).filterNotNullValues()
  )
 
  class PollAttachPaymentsSucceeded(
+ pane: Pane,
  authSessionId: String,
  duration: Long
  ) : FinancialConnectionsAnalyticsEvent(
  name = "polling.attachPayment.success",
  mapOf(
+ "pane" to pane.analyticsValue,
  "authSessionId" to authSessionId,
  "duration" to duration.toString(),
  ).filterNotNullValues()
@@ -268,15 +271,6 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  ).filterNotNullValues()
  )
 
- class VerificationSuccessNoAccounts(
- pane: Pane,
- ) : FinancialConnectionsAnalyticsEvent(
- name = "networking.verification.success_no_accounts",
- mapOf(
- "pane" to pane.analyticsValue,
- ).filterNotNullValues()
- )
-
  class VerificationError(
  pane: Pane,
  error: Error
@@ -292,7 +286,6 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  LookupConsumerSession("LookupConsumerSession"),
  StartVerificationSessionError("StartVerificationSessionError"),
  ConfirmVerificationSessionError("ConfirmVerificationSessionError"),
- NetworkedAccountsRetrieveMethodError("NetworkedAccountsRetrieveMethodError"),
  MarkLinkVerifiedError("MarkLinkVerifiedError"),
  }
  }
@@ -366,15 +359,20 @@ internal sealed class FinancialConnectionsAnalyticsEvent(
  includePrefix = false,
  )
 
- class AuthSessionUrlReceived(url: String, status: String, authSessionId: String?) :
- FinancialConnectionsAnalyticsEvent(
- name = "auth_session.url_received",
- params = mapOf(
- "status" to status,
- "url" to url,
- "auth_session_id" to (authSessionId ?: "")
- ).filterNotNullValues(),
- )
+ class AuthSessionUrlReceived(
+ pane: Pane,
+ url: String,
+ status: String,
+ authSessionId: String?
+ ) : FinancialConnectionsAnalyticsEvent(
+ name = "auth_session.url_received",
+ params = mapOf(
+ "pane" to pane.analyticsValue,
+ "status" to status,
+ "url" to url,
+ "auth_session_id" to (authSessionId ?: "")
+ ).filterNotNullValues(),
+ )
 
  class AuthSessionRetrieved(nextPane: Pane, authSessionId: String) :
  FinancialConnectionsAnalyticsEvent(

financial-connections/src/main/java/com/stripe/android/financialconnections/domain/NativeAuthFlowCoordinator.kt

@@ -32,8 +32,14 @@ internal class NativeAuthFlowCoordinator @Inject constructor() {
  data class Complete(
  val cause: EarlyTerminationCause? = null
  ) : Message {
- enum class EarlyTerminationCause(val value: String) {
- USER_INITIATED_WITH_CUSTOM_MANUAL_ENTRY("user_initiated_with_custom_manual_entry")
+ enum class EarlyTerminationCause(
+ val value: String,
+ val analyticsValue: String,
+ ) {
+ USER_INITIATED_WITH_CUSTOM_MANUAL_ENTRY(
+ value = "user_initiated_with_custom_manual_entry",
+ analyticsValue = "custom_manual_entry"
+ )
  }
  }
 

financial-connections/src/main/java/com/stripe/android/financialconnections/features/accountpicker/AccountPickerViewModel.kt

@@ -98,6 +98,7 @@ internal class AccountPickerViewModel @AssistedInject constructor(
  if (partnerAccountList.data.isNotEmpty()) {
  eventTracker.track(
  PollAccountsSucceeded(
+ pane = PANE,
  authSessionId = activeAuthSession.id,
  duration = millis
  )
@@ -156,6 +157,7 @@ internal class AccountPickerViewModel @AssistedInject constructor(
  val selectedId = setOfNotNull(payload.selectableAccounts.firstOrNull()?.id)
  eventTracker.track(
  AccountsAutoSelected(
+ pane = PANE,
  isSingleAccount = true,
  accountIds = selectedId
  )
@@ -168,6 +170,7 @@ internal class AccountPickerViewModel @AssistedInject constructor(
  val selectedIds = payload.selectableAccounts.map { it.id }.toSet()
  eventTracker.track(
  AccountsAutoSelected(
+ pane = PANE,
  isSingleAccount = false,
  accountIds = selectedIds
  )
@@ -236,6 +239,7 @@ internal class AccountPickerViewModel @AssistedInject constructor(
  if (newIds.size == 1) {
  eventTracker.track(
  AccountSelected(
+ pane = PANE,
  isSingleAccount = isSingleAccount,
  selected = true,
  accountId = newIds.first()
@@ -245,6 +249,7 @@ internal class AccountPickerViewModel @AssistedInject constructor(
  if (removedIds.size == 1) {
  eventTracker.track(
  AccountSelected(
+ pane = PANE,
  isSingleAccount = isSingleAccount,
  selected = false,
  accountId = removedIds.first()

financial-connections/src/main/java/com/stripe/android/financialconnections/features/attachpayment/AttachPaymentViewModel.kt

@@ -77,6 +77,7 @@ internal class AttachPaymentViewModel @AssistedInject constructor(
  }
  eventTracker.track(
  PollAttachPaymentsSucceeded(
+ pane = PANE,
  authSessionId = authSession.id,
  duration = millis
  )

financial-connections/src/main/java/com/stripe/android/financialconnections/features/error/ErrorViewModel.kt

@@ -67,7 +67,7 @@ internal class ErrorViewModel @AssistedInject constructor(
  ErrorState::payload,
  onFail = { error ->
  eventTracker.logError(
- extraMessage = "Error linking more accounts",
+ extraMessage = "Error loading the error screen payload",
  error = error,
  logger = logger,
  pane = PANE

financial-connections/src/main/java/com/stripe/android/financialconnections/features/linkaccountpicker/LinkAccountPickerViewModel.kt

@@ -268,6 +268,7 @@ internal class LinkAccountPickerViewModel @AssistedInject constructor(
  val isNewSelection = partnerAccount.id !in state.selectedAccountIds
 
  val event = FinancialConnectionsAnalyticsEvent.AccountSelected(
+ pane = PANE,
  selected = isNewSelection,
  isSingleAccount = payload.singleAccount,
  accountId = partnerAccount.id,

financial-connections/src/main/java/com/stripe/android/financialconnections/features/partnerauth/PartnerAuthViewModel.kt

@@ -271,6 +271,7 @@ internal class PartnerAuthViewModel @AssistedInject constructor(
  val authSession = getOrFetchSync().manifest.activeAuthSession
  eventTracker.track(
  AuthSessionUrlReceived(
+ pane = PANE,
  url = url,
  authSessionId = authSession?.id,
  status = "failed"
@@ -309,6 +310,7 @@ internal class PartnerAuthViewModel @AssistedInject constructor(
  val authSession = manifest.activeAuthSession
  eventTracker.track(
  AuthSessionUrlReceived(
+ pane = PANE,
  url = url ?: "none",
  authSessionId = authSession?.id,
  status = "cancelled"
@@ -381,6 +383,7 @@ internal class PartnerAuthViewModel @AssistedInject constructor(
  val authSession = getOrFetchSync().manifest.activeAuthSession
  eventTracker.track(
  AuthSessionUrlReceived(
+ pane = PANE,
  url = url,
  authSessionId = authSession?.id,
  status = "success"

financial-connections/src/main/java/com/stripe/android/financialconnections/presentation/FinancialConnectionsSheetNativeViewModel.kt

@@ -296,11 +296,14 @@ internal class FinancialConnectionsSheetNativeViewModel @Inject constructor(
  setState { copy(completed = true) }
  runCatching {
  val session = completeFinancialConnectionsSession(earlyTerminationCause?.value)
+ val status = computeSessionCompletionStatus(session, earlyTerminationCause, closeAuthFlowError)
  eventTracker.track(
  Complete(
+ pane = currentPane.value,
  exception = null,
  exceptionExtraMessage = null,
- connectedAccounts = session.accounts.data.count()
+ connectedAccounts = session.accounts.data.count(),
+ status = status,
  )
  )
  when {
@@ -340,16 +343,26 @@ internal class FinancialConnectionsSheetNativeViewModel @Inject constructor(
  logger.error(errorMessage, completeSessionError)
  eventTracker.track(
  Complete(
+ pane = currentPane.value,
  exception = completeSessionError,
  exceptionExtraMessage = errorMessage,
- connectedAccounts = null
+ connectedAccounts = null,
+ status = "failed",
  )
  )
  finishWithResult(Failed(closeAuthFlowError ?: completeSessionError))
  }
  }
  }
 
+ private fun computeSessionCompletionStatus(
+ session: FinancialConnectionsSession,
+ earlyTerminationCause: EarlyTerminationCause?,
+ closeAuthFlowError: Throwable?,
+ ): String {
+ return earlyTerminationCause?.analyticsValue ?: session.completionStatus(closeAuthFlowError)
+ }
+
  private fun finishWithResult(
  result: FinancialConnectionsSheetActivityResult
  ) {
@@ -567,3 +580,16 @@ private fun FinancialConnectionsSheetNativeState.toTopAppBarState(
  isTestMode = testMode,
  )
 }
+
+private fun FinancialConnectionsSession.completionStatus(
+ closeAuthFlowError: Throwable?,
+): String {
+ val completed = accounts.data.isNotEmpty() || paymentAccount != null || bankAccountToken != null
+ return if (completed) {
+ "completed"
+ } else if (closeAuthFlowError != null) {
+ "failed"
+ } else {
+ "canceled"
+ }
+}