chore(flipcash): add base set of analytics events (transfers)

Signed-off-by: Brandon McAnsh <git@bmcreations.dev>

Author: bmc08gt

apps/flipcash/features/login/src/main/kotlin/com/flipcash/app/login/seed/SeedInputViewModel.kt

@@ -38,7 +38,6 @@ data class SeedInputUiModel(
 
 @HiltViewModel
 class SeedInputViewModel @Inject constructor(
-    private val analytics: FlipcashAnalyticsService,
     private val authManager: AuthManager,
     private val resources: ResourceHelper,
     private val mnemonicManager: MnemonicManager,

apps/flipcash/features/withdrawal/src/main/kotlin/com/flipcash/app/withdrawal/WithdrawalViewModel.kt

@@ -9,6 +9,8 @@ import com.flipcash.app.activityfeed.ActivityFeedCoordinator
 import com.flipcash.app.core.extensions.onResult
 import com.flipcash.app.core.ui.CurrencyHolder
 import com.flipcash.features.withdrawal.R
+import com.flipcash.services.analytics.AnalyticsEvent
+import com.flipcash.services.analytics.FlipcashAnalyticsService
 import com.flipcash.services.user.UserManager
 import com.getcode.manager.BottomBarAction
 import com.getcode.manager.BottomBarManager
@@ -68,6 +70,7 @@ internal class WithdrawalViewModel @Inject constructor(
     transactionController: TransactionController,
     clipboardManager: ClipboardManager,
     activityFeedCoordinator: ActivityFeedCoordinator,
+    analytics: FlipcashAnalyticsService
 ) : BaseViewModel2<WithdrawalViewModel.State, WithdrawalViewModel.Event>(
     initialState = State(),
     updateStateForEvent = updateStateForEvent
@@ -403,13 +406,23 @@ internal class WithdrawalViewModel @Inject constructor(
                 )
             }.onResult(
                 onError = {
+                    analytics.transfer(
+                        event = AnalyticsEvent.Withdrawal,
+                        amount = stateFlow.value.amountEntryState.selectedAmount,
+                        successful = false,
+                        error = it,
+                    )
                     dispatchEvent(Event.UpdateWithdrawalState(loading = false))
                     BottomBarManager.showError(
                         title = resources.getString(R.string.error_title_failedWithdrawal),
                         message = resources.getString(R.string.error_description_failedWithdrawal)
                     )
                 },
                 onSuccess = {
+                    analytics.transfer(
+                        AnalyticsEvent.Withdrawal,
+                        amount = stateFlow.value.amountEntryState.selectedAmount
+                    )
                     viewModelScope.launch {
                         coroutineScope {
                             activityFeedCoordinator.fetchSinceLatest()

apps/flipcash/shared/session/src/main/kotlin/com/flipcash/app/session/internal/RealSessionController.kt

@@ -25,6 +25,8 @@ import com.flipcash.app.shareable.ShareSheetController
 import com.flipcash.app.shareable.Shareable
 import com.flipcash.app.shareable.ShareableConfirmationController
 import com.flipcash.core.R
+import com.flipcash.services.analytics.AnalyticsEvent
+import com.flipcash.services.analytics.FlipcashAnalyticsService
 import com.flipcash.services.billing.BillingClient
 import com.flipcash.services.controllers.AccountController
 import com.flipcash.services.user.UserManager
@@ -91,8 +93,8 @@ class RealSessionController @Inject constructor(
     private val toastController: ToastController,
     private val billingClient: BillingClient,
     private val balanceController: BalanceController,
-    private val exchange: Exchange,
     private val featureFlagController: FeatureFlagController,
+    private val analytics: FlipcashAnalyticsService,
     appSettingsCoordinator: AppSettingsCoordinator,
 ) : SessionController {
 
@@ -345,6 +347,7 @@ class RealSessionController @Inject constructor(
             amount = bill.amount,
             owner = owner,
             onGrabbed = {
+                analytics.transfer(AnalyticsEvent.GiveBill, bill.amount)
                 toastController.enqueue(bill.amount, isDeposit = false)
                 dismissBill(Grabbed)
                 vibrator.vibrate()
@@ -358,7 +361,15 @@ class RealSessionController @Inject constructor(
 //                    CodeAnalyticsManager.BillPresentationStyle.Slide
 //                )
             },
-            onError = { dismissBill(action = PutInWallet) },
+            onError = {
+                analytics.transfer(
+                    event = AnalyticsEvent.GiveBill,
+                    amount = bill.amount,
+                    successful = false,
+                    error = it
+                )
+                dismissBill(action = PutInWallet)
+            },
             present = { data ->
                 if (!bill.didReceive) {
                     trace(
@@ -405,7 +416,8 @@ class RealSessionController @Inject constructor(
                             delay(CASH_LINK_CONFIRMATION_DELAY)
 
                             // confirm the result of the share
-                            val confirmResult = shareConfirmationController.confirm(shareable, result)
+                            val confirmResult =
+                                shareConfirmationController.confirm(shareable, result)
 
                             // reset isChecking after confirmation
                             shareSheetController.reset(setChecked = false)
@@ -423,6 +435,7 @@ class RealSessionController @Inject constructor(
                                             dismissBill(Grabbed)
                                             vibrator.vibrate()
                                             bringActivityFeedCurrent()
+                                            analytics.transfer(AnalyticsEvent.SentCashLink(clipboard = true), amount)
                                             trace(
                                                 tag = "Session",
                                                 message = "Cash link copied to clipboard",
@@ -438,6 +451,7 @@ class RealSessionController @Inject constructor(
                                             dismissBill(Grabbed)
                                             vibrator.vibrate()
                                             bringActivityFeedCurrent()
+                                            analytics.transfer(AnalyticsEvent.SentCashLink(app = result.to), amount)
                                             trace(
                                                 tag = "Session",
                                                 message = "Cash link shared with ${result.to}",
@@ -549,7 +563,6 @@ class RealSessionController @Inject constructor(
             return
         }
 
-        // TODO: analytics
         claimGiftCard(owner = owner, entropy = entropy, claimIfOwned = false)
     }
 
@@ -569,6 +582,7 @@ class RealSessionController @Inject constructor(
             owner = owner,
             claimIfOwned = claimIfOwned,
             onReceived = {
+                analytics.transfer(AnalyticsEvent.ClaimedCashLink, amount = it)
                 toastController.enqueue(it, isDeposit = true)
                 showBill(
                     bill = Bill.Cash(amount = it, didReceive = true),
@@ -578,6 +592,15 @@ class RealSessionController @Inject constructor(
                 bringActivityFeedCurrent()
             },
             onError = { cause ->
+                if (cause !is ReceiveGiftTransactorError.UsersGiftCard) {
+                    analytics.transfer(
+                        AnalyticsEvent.ClaimedCashLink,
+                        amount = null,
+                        successful = false,
+                        error = cause
+                    )
+                }
+
                 when (cause) {
                     is ReceiveGiftTransactorError.UsersGiftCard -> {
                         // present confirmation to claim (cancel) own gift card
@@ -609,6 +632,7 @@ class RealSessionController @Inject constructor(
                             }
                         )
                     }
+
                     is ReceiveGiftTransactorError.AlreadyClaimed -> {
                         BottomBarManager.showError(
                             resources.getString(R.string.error_title_alreadyCollected),
@@ -645,6 +669,7 @@ class RealSessionController @Inject constructor(
             owner = owner,
             payload = payload,
             onGrabbed = { amount ->
+                analytics.transfer(AnalyticsEvent.GrabBill, amount)
                 BottomBarManager.clear()
                 toastController.enqueue(amount, isDeposit = true)
                 showBill(
@@ -655,6 +680,12 @@ class RealSessionController @Inject constructor(
                 bringActivityFeedCurrent()
             },
             onError = {
+                analytics.transfer(
+                    event = AnalyticsEvent.GrabBill,
+                    fiat = payload.fiat,
+                    successful = false,
+                    error = it
+                )
                 scannedRendezvous.remove(payload.rendezvous.publicKey)
                 ErrorUtils.handleError(it)
             }

services/flipcash/src/main/kotlin/com/flipcash/services/analytics/Analytics.kt

@@ -3,26 +3,153 @@ package com.flipcash.services.analytics
 import com.getcode.libs.analytics.AnalyticsService
 import com.getcode.libs.analytics.AppAction
 import com.getcode.libs.analytics.AppActionSource
+import com.getcode.opencode.model.financial.Fiat
+import com.getcode.opencode.model.financial.LocalFiat
+import com.getcode.services.flipcash.BuildConfig
+import com.getcode.utils.TraceType
+import com.getcode.utils.trace
+import com.google.firebase.ktx.Firebase
+import com.google.firebase.perf.ktx.performance
+import com.google.firebase.perf.metrics.Trace
 import com.mixpanel.android.mpmetrics.MixpanelAPI
+import org.json.JSONObject
+import timber.log.Timber
 import javax.inject.Inject
 
 interface FlipcashAnalyticsService : AnalyticsService {
+    fun transfer(
+        event: AnalyticsEvent,
+        amount: LocalFiat? = null,
+        successful: Boolean = true,
+        error: Throwable? = null
+    )
+    fun transfer(
+        event: AnalyticsEvent,
+        fiat: Fiat? = null,
+        successful: Boolean = true,
+        error: Throwable? = null
+    )
 }
 
 class FlipcashAnalyticsManager @Inject constructor(
     private val mixpanelAPI: MixpanelAPI
 ) : FlipcashAnalyticsService {
 
+    private var traceAppInit: Trace? = null
+    private var timeAppInit: Long? = null
+
     override fun onAppStart() {
+        timeAppInit = System.currentTimeMillis()
+        traceAppInit = Firebase.performance.newTrace("Init")
+        traceAppInit?.start()
     }
 
     override fun onAppStarted() {
+        traceAppInit ?: return
+        traceAppInit?.stop()
+        traceAppInit = null
+        val duration = System.currentTimeMillis() - (timeAppInit ?: 0)
+        trace(
+            tag = "Analytics",
+            message = "App started",
+            metadata = {
+                "duration" to duration
+            },
+            type = TraceType.Process
+        )
+    }
+
+    override fun unintentionalLogout() = Unit
+
+    override fun action(action: AppAction, source: AppActionSource?) = Unit
+
+    override fun transfer(event: AnalyticsEvent, amount: LocalFiat?, successful: Boolean, error: Throwable?) {
+        val properties = event.properties(localizedAmount = amount, successful = successful, error = error)
+        track(event.name, *properties.toList().toTypedArray())
     }
 
-    override fun unintentionalLogout() {
+    override fun transfer(event: AnalyticsEvent, fiat: Fiat?, successful: Boolean, error: Throwable?) {
+        val properties = event.properties(nativeAmount = fiat, successful = successful, error = error)
+        track(event.name, *properties.toList().toTypedArray())
     }
 
-    override fun action(action: AppAction, source: AppActionSource?) {
+    private fun track(name: String, vararg properties: Pair<String, String>) {
+        if (BuildConfig.DEBUG) {
+            trace(
+                "debug track ${name}, ${properties.joinToString { "${it.first} => ${it.second}" }}",
+                type = TraceType.Silent
+            )
+            return
+        } //no logging in debug
+
+        val jsonObject = JSONObject()
+        properties.forEach { property ->
+            jsonObject.put(property.first, property.second)
+        }
+        mixpanelAPI.track(name, jsonObject)
     }
+}
+
+sealed class AnalyticsEvent(val name: String) {
+    data object GrabBill : AnalyticsEvent("Grab Bill")
+    data object GiveBill : AnalyticsEvent("Give Bill")
+    data object Withdrawal : AnalyticsEvent("Withdrawal")
+    data class SentCashLink(val clipboard: Boolean? = null, val app: String? = null) : AnalyticsEvent("Sent Cash Link")
+    data object ClaimedCashLink : AnalyticsEvent("Receive Cash Link")
+}
+
+private fun AnalyticsEvent.properties(
+    localizedAmount: LocalFiat? = null,
+    nativeAmount: Fiat? = null,
+    successful: Boolean,
+    error: Throwable?
+): Map<String, String> {
+    return buildMap {
+        if (successful) {
+            put("State", "Success")
+        } else {
+            put("State", "Failure")
+        }
 
+        when (val event = this@properties) {
+            is AnalyticsEvent.SentCashLink -> {
+                if (event.clipboard == true) {
+                    put("Cash Link Choice", "Copied to clipboard")
+                } else if (event.app != null) {
+                    put("Cash Link Choice", "Shared to app")
+                    put("App", event.app)
+                }
+            }
+            AnalyticsEvent.Withdrawal,
+            AnalyticsEvent.ClaimedCashLink,
+            AnalyticsEvent.GiveBill,
+            AnalyticsEvent.GrabBill -> Unit
+        }
+
+        if (localizedAmount != null) {
+            putAll(localizedAmount.asProperties())
+        } else if (nativeAmount != null) {
+            putAll(nativeAmount.asProperties())
+        }
+
+        if (error != null) {
+            put("Error", error.message.orEmpty())
+        }
+    }
+}
+
+private fun LocalFiat.asProperties(): Map<String, String> {
+    return buildMap {
+        putAll(usdc.asProperties())
+        "Fiat" to converted.doubleValue.toString()
+        "Exchange Rate" to rate.fx.toString()
+        "Currency" to rate.currency.name
+    }
+}
+
+private fun Fiat.asProperties(): Map<String, String> {
+    return buildMap {
+        "USDC" to doubleValue.toString()
+        "Quarks" to quarks.toDouble().toString()
+    }
 }