Merge pull request #115 from Web3Auth/feat/segment_analytics

feat: Segment analytics initialization and events added

Author: grvgoel81

core/src/main/java/com/web3auth/core/Web3Auth.kt

@@ -0,0 +1,36 @@
+package com.web3auth.core.analytics
+
+object AnalyticsEvents {
+    const val SDK_INITIALIZATION_COMPLETED = "SDK Initialization Completed"
+    const val SDK_INITIALIZATION_FAILED = "SDK Initialization Failed"
+    const val CONNECTION_STARTED = "Connection Started"
+    const val CONNECTION_COMPLETED = "Connection Completed"
+    const val CONNECTION_FAILED = "Connection Failed"
+    const val MFA_ENABLEMENT_STARTED = "MFA Enablement Started"
+    const val MFA_ENABLEMENT_COMPLETED = "MFA Enablement Completed"
+    const val MFA_ENABLEMENT_FAILED = "MFA Enablement Failed"
+    const val MFA_MANAGEMENT_STARTED = "MFA Management Started"
+    const val MFA_MANAGEMENT_FAILED = "MFA Management Failed"
+    const val MFA_MANAGEMENT_COMPLETED = "MFA Management Completed"
+    const val WALLET_UI_CLICKED = "Wallet UI Clicked"
+    const val WALLET_SERVICES_FAILED = "Wallet Services Failed"
+    const val LOGOUT_STARTED = "Logout Started"
+    const val LOGOUT_COMPLETED = "Logout Completed"
+    const val LOGOUT_FAILED = "Logout Failed"
+    const val REQUEST_FUNCTION_STARTED = "Request Function Started"
+    const val REQUEST_FUNCTION_COMPLETED = "Request Function Completed"
+    const val REQUEST_FUNCTION_FAILED = "Request Function Failed"
+
+    const val SDK_VERSION = "10.0.0"
+}
+
+object AnalyticsSdkType {
+    const val ANDROID = "android"
+}
+
+object SegmentKeys {
+    const val SEGMENT_WRITE_KEY = "f6LbNqCeVRf512ggdME4b6CyflhF1tsX" // Production key
+    const val SEGMENT_WRITE_KEY_DEV = "rpE5pCcpA6ME2oFu2TbuVydhOXapjHs3" // Development key
+}
+
+

core/src/main/java/com/web3auth/core/analytics/AnalyticsConstant.kt

@@ -4,13 +4,17 @@ import android.content.Context
 import com.segment.analytics.Analytics
 import com.segment.analytics.Properties
 import com.segment.analytics.Traits
+import com.web3auth.core.BuildConfig
 
 internal object AnalyticsManager {
 
-    private const val SEGMENT_WRITE_KEY = "YOUR_SECRET_WRITE_KEY"
+    private const val SEGMENT_WRITE_KEY =
+        SegmentKeys.SEGMENT_WRITE_KEY // Use (SEGMENT_WRITE_KEY) in production builds and (SEGMENT_WRITE_KEY_DEV) in development/testing builds
     private var analytics: Analytics? = null
     private var isInitialized = false
 
+    private val globalProperties: MutableMap<String, Any> = mutableMapOf()
+
     fun initialize(context: Context) {
         if (isInitialized) return
 
@@ -23,20 +27,25 @@ internal object AnalyticsManager {
         isInitialized = true
     }
 
-    fun trackEvent(eventName: String, properties: Map<String, Any>? = null) {
+    fun setGlobalProperties(properties: Map<String, Any>) {
+        globalProperties.putAll(properties)
+    }
+
+    fun trackEvent(eventName: String, properties: Map<String, Any?>? = null) {
         if (!isInitialized) return
+        if (isSkipped()) return
 
-        val props = properties?.let {
-            Properties().apply {
-                it.forEach { (k, v) -> putValue(k, v) }
-            }
+        val combinedProps = Properties().apply {
+            globalProperties.forEach { (k, v) -> putValue(k, v) }
+            properties?.forEach { (k, v) -> putValue(k, v) }
         }
 
-        analytics?.track(eventName, props)
+        analytics?.track(eventName, combinedProps)
     }
 
-    fun identifyUser(userId: String, traits: Map<String, Any>? = null) {
+    fun identify(userId: String, traits: Map<String, Any>? = null) {
         if (!isInitialized) return
+        if (isSkipped()) return
 
         val traitsObj = traits?.let {
             Traits().apply {
@@ -50,5 +59,11 @@ internal object AnalyticsManager {
     fun reset() {
         analytics?.reset()
         isInitialized = false
+        globalProperties.clear()
+    }
+
+    private fun isSkipped(): Boolean {
+        return BuildConfig.DEBUG
     }
 }
+

core/src/main/java/com/web3auth/core/analytics/AnalyticsManager.kt

@@ -10,4 +10,16 @@ data class MfaSettings(
     @Keep private var passwordFactor: MfaSetting? = null,
     @Keep private var passkeysFactor: MfaSetting? = null,
     @Keep private var authenticatorFactor: MfaSetting? = null,
-)
+) {
+    fun merge(other: MfaSettings?): MfaSettings {
+        if (other == null) return this
+        return MfaSettings(
+            deviceShareFactor = other.deviceShareFactor ?: this.deviceShareFactor,
+            backUpShareFactor = other.backUpShareFactor ?: this.backUpShareFactor,
+            socialBackupFactor = other.socialBackupFactor ?: this.socialBackupFactor,
+            passwordFactor = other.passwordFactor ?: this.passwordFactor,
+            passkeysFactor = other.passkeysFactor ?: this.passkeysFactor,
+            authenticatorFactor = other.authenticatorFactor ?: this.authenticatorFactor
+        )
+    }
+}

core/src/main/java/com/web3auth/core/types/MfaSettings.kt

@@ -23,6 +23,8 @@ data class ProjectConfigResponse(
     @Keep val wallet_connect_enabled: Boolean?,
     @Keep val walletConnectProjectId: String?,
     @Keep val whitelabel: WhiteLabelData? = null,
+    @Keep val teamId: Int? = null,
+    @Keep val mfaSettings: MfaSettings? = null
 )
 
 @Keep

core/src/main/java/com/web3auth/core/types/ProjectConfigResponse.kt

@@ -28,7 +28,7 @@ data class Web3AuthOptions(
     @Keep val web3AuthNetwork: Web3AuthNetwork,
     @Keep val useSFAKey: Boolean? = false,
     @Keep val walletServicesConfig: WalletServicesConfig? = null,
-    @Keep val mfaSettings: MfaSettings? = null,
+    @Keep var mfaSettings: MfaSettings? = null,
 ) {
     init {
         if (dashboardUrl == null) {