chore: allow screens to track own screen views on composition (#8)

Signed-off-by: Brandon McAnsh <[email protected]>

Author: bmc08gt

api/src/main/java/com/getcode/manager/AnalyticsManager.kt

@@ -14,20 +14,40 @@ import timber.log.Timber
 import javax.inject.Inject
 import javax.inject.Singleton
 
+interface AnalyticsService {
+    fun open(screen: AnalyticsManager.Screen)
+    fun login(ownerPublicKey: String, autoCompleteCount: Int, inputChangeCount: Int)
+    fun logout()
+    fun track(event: AnalyticsManager.Name, vararg properties: Pair<AnalyticsManager.Property, String>)
+}
+
+class AnalyticsServiceNull : AnalyticsService {
+    override fun open(screen: AnalyticsManager.Screen) = Unit
+
+    override fun login(ownerPublicKey: String, autoCompleteCount: Int, inputChangeCount: Int) = Unit
+
+    override fun logout() = Unit
+
+    override fun track(
+        event: AnalyticsManager.Name,
+        vararg properties: Pair<AnalyticsManager.Property, String>
+    ) = Unit
+}
+
 @Singleton
-class AnalyticsManager @Inject constructor(private val mixpanelAPI: MixpanelAPI) {
+class AnalyticsManager @Inject constructor(private val mixpanelAPI: MixpanelAPI): AnalyticsService {
     private var grabStartMillis: Long = 0L
     private var cashLinkGrabStartMillis: Long = 0L
 
-    fun open(screen: Screen) {
+    override fun open(screen: Screen) {
         track(Name.Open, Pair(Property.Screen, screen.value))
     }
 
-    fun logout() {
+    override fun logout() {
         track(Name.Logout)
     }
 
-    fun login(ownerPublicKey: String, autoCompleteCount: Int, inputChangeCount: Int) {
+    override fun login(ownerPublicKey: String, autoCompleteCount: Int, inputChangeCount: Int) {
         track(
             Name.Login,
             Pair(Property.OwnerPublicKey, ownerPublicKey),
@@ -151,8 +171,11 @@ class AnalyticsManager @Inject constructor(private val mixpanelAPI: MixpanelAPI)
         Timber.i("Bill scanned. From start: " + (System.currentTimeMillis() - (timeAppInit ?: 0)))
     }
 
-    private fun track(event: Name, vararg properties: Pair<Property, String>) {
-        if (BuildConfig.DEBUG) return //no logging in debug
+    override fun track(event: Name, vararg properties: Pair<Property, String>) {
+        if (BuildConfig.DEBUG) {
+            Timber.d("debug track $event, ${properties.map { "${it.first.name}, ${it.second}" }}")
+            return
+        } //no logging in debug
 
         val jsonObject = JSONObject()
         properties.forEach { property ->

app/src/main/java/com/getcode/Analytics.kt

@@ -0,0 +1,8 @@
+package com.getcode
+
+import androidx.compose.runtime.ProvidableCompositionLocal
+import androidx.compose.runtime.staticCompositionLocalOf
+import com.getcode.manager.AnalyticsService
+import com.getcode.manager.AnalyticsServiceNull
+
+val LocalAnalytics: ProvidableCompositionLocal<AnalyticsService> = staticCompositionLocalOf { AnalyticsServiceNull() }

app/src/main/java/com/getcode/analytics/AnalyticsScreenWatcher.kt

@@ -0,0 +1,15 @@
+package com.getcode.analytics
+
+import androidx.compose.runtime.Composable
+import androidx.lifecycle.LifecycleOwner
+import com.getcode.manager.AnalyticsManager
+
+@Composable
+fun AnalyticsScreenWatcher(
+    lifecycleOwner: LifecycleOwner,
+    event: AnalyticsManager.Screen,
+) {
+    AnalyticsWatcher(lifecycleOwner = lifecycleOwner, onEvent = { analytics, context ->
+        analytics.open(event)
+    })
+}

app/src/main/java/com/getcode/analytics/AnalyticsWatcher.kt

@@ -0,0 +1,35 @@
+package com.getcode.analytics
+
+import android.content.Context
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.rememberUpdatedState
+import androidx.compose.ui.platform.LocalContext
+import androidx.lifecycle.Lifecycle
+import androidx.lifecycle.LifecycleOwner
+import com.getcode.LocalAnalytics
+import com.getcode.manager.AnalyticsService
+import com.getcode.util.RepeatOnLifecycle
+
+@Composable
+fun AnalyticsWatcher(
+    lifecycleOwner: LifecycleOwner,
+    onEvent: (AnalyticsService, Context) -> Unit,
+    onDispose: (AnalyticsService, Context) -> Unit = { _, _ -> },
+) {
+    val context = LocalContext.current
+    val analyticsService = LocalAnalytics.current
+
+    val updatedOnEvent by rememberUpdatedState(newValue = onEvent)
+    val updatedOnDispose by rememberUpdatedState(newValue = onDispose)
+
+    RepeatOnLifecycle(
+        lifecycleOwner = lifecycleOwner,
+        targetState = Lifecycle.State.RESUMED,
+        doOnDispose = {
+            updatedOnDispose(analyticsService, context)
+        },
+    ) {
+        updatedOnEvent(analyticsService, context)
+    }
+}

app/src/main/java/com/getcode/util/RepeatOnLifecycle.kt

@@ -0,0 +1,30 @@
+package com.getcode.util
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.DisposableEffect
+import androidx.compose.ui.platform.LocalLifecycleOwner
+import androidx.lifecycle.Lifecycle
+import androidx.lifecycle.LifecycleOwner
+import androidx.lifecycle.lifecycleScope
+import androidx.lifecycle.repeatOnLifecycle
+import kotlinx.coroutines.launch
+
+@Composable
+fun RepeatOnLifecycle(
+    lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current,
+    targetState: Lifecycle.State,
+    doOnDispose: () -> Unit = {},
+    action: suspend () -> Unit,
+) {
+    DisposableEffect(lifecycleOwner) {
+        val job = lifecycleOwner.lifecycleScope.launch {
+            lifecycleOwner.repeatOnLifecycle(targetState) {
+                action()
+            }
+        }
+        onDispose {
+            job.cancel()
+            doOnDispose()
+        }
+    }
+}

app/src/main/java/com/getcode/view/MainActivity.kt

@@ -6,6 +6,7 @@ import android.os.Bundle
 import android.os.Debug
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
+import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.DisposableEffect
 import androidx.compose.runtime.rememberUpdatedState
 import androidx.core.util.Consumer
@@ -15,6 +16,7 @@ import androidx.navigation.NavController
 import androidx.navigation.NavHostController
 import androidx.navigation.findNavController
 import com.getcode.CodeApp
+import com.getcode.LocalAnalytics
 import com.getcode.manager.AnalyticsManager
 import com.getcode.manager.AuthManager
 import com.getcode.manager.SessionManager
@@ -78,7 +80,9 @@ class MainActivity : FragmentActivity() {
         setContent {
             val appState = rememberCodeAppState()
             currentNavHostController = appState.navController
-            CodeApp(appState)
+            CompositionLocalProvider(LocalAnalytics provides analyticsManager) {
+                CodeApp(appState)
+            }
         }
     }
 

app/src/main/java/com/getcode/view/main/account/AccountAccessKey.kt

@@ -13,6 +13,7 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.asImageBitmap
 import androidx.compose.ui.layout.ContentScale
 import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.platform.LocalLifecycleOwner
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.unit.dp
@@ -22,6 +23,8 @@ import androidx.hilt.navigation.compose.hiltViewModel
 import androidx.navigation.NavController
 import com.getcode.App
 import com.getcode.R
+import com.getcode.analytics.AnalyticsScreenWatcher
+import com.getcode.manager.AnalyticsManager
 import com.getcode.manager.TopBarManager
 import com.getcode.theme.BrandLight
 import com.getcode.util.IntentUtils
@@ -76,6 +79,11 @@ fun AccountAccessKey(navController: NavController) {
         }
     }
 
+    AnalyticsScreenWatcher(
+        lifecycleOwner = LocalLifecycleOwner.current,
+        event = AnalyticsManager.Screen.Backup
+    )
+
     ConstraintLayout(
         modifier = Modifier
             .fillMaxSize()

app/src/main/java/com/getcode/view/main/account/AccountDeposit.kt

@@ -10,11 +10,14 @@ import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.draw.clip
 import androidx.compose.ui.platform.LocalClipboardManager
+import androidx.compose.ui.platform.LocalLifecycleOwner
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.text.AnnotatedString
 import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.unit.dp
 import com.getcode.R
+import com.getcode.analytics.AnalyticsScreenWatcher
+import com.getcode.manager.AnalyticsManager
 import com.getcode.manager.SessionManager
 import com.getcode.solana.organizer.AccountType
 import com.getcode.theme.*
@@ -32,6 +35,11 @@ fun AccountDeposit() {
     val localClipboardManager = LocalClipboardManager.current
     var isCopied by remember { mutableStateOf(false) }
 
+    AnalyticsScreenWatcher(
+        lifecycleOwner = LocalLifecycleOwner.current,
+        event = AnalyticsManager.Screen.Deposit
+    )
+
     Column(
         modifier = Modifier
             .background(Brand)

app/src/main/java/com/getcode/view/main/account/AccountDetails.kt

@@ -22,12 +22,6 @@ fun AccountDetails(
     viewModel: AccountSheetViewModel = hiltViewModel(),
 ) {
     val dataState by viewModel.stateFlow.collectAsState()
-    val context = LocalContext.current
-
-    fun onPage(page: AccountPage) {
-        onPageSelected(page)
-        viewModel.dispatchEvent(AccountSheetViewModel.Event.Navigate(page))
-    }
 
     Box(modifier = Modifier.fillMaxHeight()) {
         Column(
@@ -48,7 +42,7 @@ fun AccountDetails(
                             positiveText = App.getInstance()
                                 .getString(R.string.action_viewAccessKey),
                             negativeText = App.getInstance().getString(R.string.action_cancel),
-                            onPositive = { onPage(AccountPage.ACCESS_KEY) },
+                            onPositive = { onPageSelected(AccountPage.ACCESS_KEY) },
                             onNegative = {}
                         )
                     )
@@ -58,11 +52,11 @@ fun AccountDetails(
                     name = R.string.title_phoneNumber,
                     icon = R.drawable.ic_menu_phone,
                     isPhoneLinked = dataState.isPhoneLinked,
-                ) { onPage(AccountPage.PHONE) },
+                ) { onPageSelected(AccountPage.PHONE) },
                 AccountMainItem(
                     name = R.string.action_deleteAccount,
                     icon = R.drawable.ic_delete
-                 ) { onPage(AccountPage.DELETE_ACCOUNT) },
+                 ) { onPageSelected(AccountPage.DELETE_ACCOUNT) },
             )
 
             for (action in actions) {

app/src/main/java/com/getcode/view/main/account/AccountFaq.kt

@@ -10,12 +10,15 @@ import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalLifecycleOwner
 import androidx.compose.ui.text.font.FontWeight
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
 import androidx.hilt.navigation.compose.hiltViewModel
 import com.getcode.R
+import com.getcode.analytics.AnalyticsScreenWatcher
+import com.getcode.manager.AnalyticsManager
 import com.getcode.theme.White
 import com.getcode.theme.sheetHeight
 import com.getcode.view.components.MarkdownText
@@ -27,6 +30,11 @@ fun AccountFaq(
 ) {
     val dataState by viewModel.stateFlow.collectAsState()
 
+    AnalyticsScreenWatcher(
+        lifecycleOwner = LocalLifecycleOwner.current,
+        event = AnalyticsManager.Screen.Faq
+    )
+
     Box(
         modifier = Modifier
             .padding(horizontal = 20.dp)

app/src/main/java/com/getcode/view/main/account/AccountHome.kt

@@ -57,11 +57,6 @@ fun AccountHome(
     val dataState by viewModel.stateFlow.collectAsState()
     val context = LocalContext.current
 
-    fun onPage(page: AccountPage) {
-        onPageSelected(page)
-        viewModel.dispatchEvent(AccountSheetViewModel.Event.Navigate(page))
-    }
-
     Box(modifier = Modifier.fillMaxHeight()) {
         Column(
             modifier = Modifier
@@ -71,23 +66,23 @@ fun AccountHome(
                 AccountMainItem(
                     name = R.string.title_buyAndSellKin,
                     icon = R.drawable.ic_currency_dollar_active
-                ) { onPage(AccountPage.BUY_AND_SELL_KIN) },
+                ) { onPageSelected(AccountPage.BUY_AND_SELL_KIN) },
                 AccountMainItem(
                     name = R.string.title_depositKin,
                     icon = R.drawable.ic_menu_deposit
-                ) { onPage(AccountPage.DEPOSIT) },
+                ) { onPageSelected(AccountPage.DEPOSIT) },
                 AccountMainItem(
                     name = R.string.title_withdrawKin,
                     icon = R.drawable.ic_menu_withdraw
-                ) { onPage(AccountPage.WITHDRAW) },
+                ) { onPageSelected(AccountPage.WITHDRAW) },
                 AccountMainItem(
                     name = R.string.title_myAccount,
                     icon = R.drawable.ic_menu_account
-                ) { onPage(AccountPage.ACCOUNT_DETAILS) },
+                ) { onPageSelected(AccountPage.ACCOUNT_DETAILS) },
                 AccountMainItem(
                     name = R.string.title_faq,
                     icon = R.drawable.ic_faq,
-                ) { onPage(AccountPage.FAQ) },
+                ) { onPageSelected(AccountPage.FAQ) },
                 AccountMainItem(
                     name = R.string.action_logout,
                     icon = R.drawable.ic_menu_logout
@@ -115,7 +110,7 @@ fun AccountHome(
                 AccountMainItem(
                     name = R.string.account_debug_options,
                     icon = R.drawable.ic_bug,
-                ) { onPage(AccountPage.ACCOUNT_DEBUG_OPTIONS) }
+                ) { onPageSelected(AccountPage.ACCOUNT_DEBUG_OPTIONS) }
                     .let { actions.add(4, it) }
             }
 

app/src/main/java/com/getcode/view/main/account/AccountPhone.kt

@@ -7,7 +7,10 @@ import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.layout.size
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Text
-import androidx.compose.runtime.*
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.SideEffect
+import androidx.compose.runtime.collectAsState
+import androidx.compose.runtime.getValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
@@ -16,14 +19,16 @@ import androidx.constraintlayout.compose.ConstraintLayout
 import androidx.hilt.navigation.compose.hiltViewModel
 import androidx.navigation.NavController
 import com.getcode.App
+import com.getcode.R
 import com.getcode.manager.BottomBarManager
 import com.getcode.manager.SessionManager
 import com.getcode.network.repository.urlEncode
 import com.getcode.theme.Brand
-import com.getcode.view.*
+import com.getcode.view.ARG_IS_PHONE_LINKING
+import com.getcode.view.ARG_SIGN_IN_ENTROPY_B64
+import com.getcode.view.LoginSections
 import com.getcode.view.components.ButtonState
 import com.getcode.view.components.CodeButton
-import com.getcode.R
 
 @Composable
 fun AccountPhone(navController: NavController? = null) {