feat: add diagnostics client (#346)

* feat: add diagnostics client

* refactor with actor

* fix ut

* fix

* update

* update

* use xxhash32 for sampling

* update

* update

* add RestrictedAmplitudeFeature

* update

* make isInSample public

Author: sojingle

android/src/main/java/com/amplitude/android/Amplitude.kt

@@ -2,6 +2,7 @@ package com.amplitude.android
 
 import android.app.Application
 import android.content.Context
+import com.amplitude.android.diagnostics.AndroidDiagnosticsContextProvider
 import com.amplitude.android.migration.MigrationManager
 import com.amplitude.android.plugins.AnalyticsConnectorIdentityPlugin
 import com.amplitude.android.plugins.AnalyticsConnectorPlugin
@@ -11,6 +12,7 @@ import com.amplitude.android.plugins.AndroidNetworkConnectivityCheckerPlugin
 import com.amplitude.android.storage.AndroidStorageContextV3
 import com.amplitude.android.utilities.ActivityLifecycleObserver
 import com.amplitude.core.State
+import com.amplitude.core.diagnostics.DiagnosticsContextProvider
 import com.amplitude.core.platform.plugins.AmplitudeDestination
 import com.amplitude.core.platform.plugins.GetAmpliExtrasPlugin
 import com.amplitude.id.IdentityConfiguration
@@ -20,6 +22,7 @@ import kotlinx.coroutines.Deferred
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.asCoroutineDispatcher
 import kotlinx.coroutines.launch
+import java.io.File
 import java.util.concurrent.Executors
 import com.amplitude.core.Amplitude as CoreAmplitude
 
@@ -111,6 +114,16 @@ open class Amplitude internal constructor(
         (timeline as Timeline).start()
     }
 
+    override fun diagnosticsContextProvider(): DiagnosticsContextProvider? {
+        val configuration = configuration as Configuration
+        return AndroidDiagnosticsContextProvider(configuration.context)
+    }
+
+    override fun diagnosticsStorageDirectory(): File {
+        val configuration = configuration as Configuration
+        return configuration.getStorageDirectory()
+    }
+
     /**
      * Reset identity:
      *  - reset userId to "null"

android/src/main/java/com/amplitude/android/AutocaptureOptions.kt

@@ -125,3 +125,29 @@ class AutocaptureOptionsBuilder {
  * @return Set of autocapture options.
  */
 fun autocaptureOptions(init: AutocaptureOptionsBuilder.() -> Unit): Set<AutocaptureOption> = AutocaptureOptionsBuilder().apply(init).build()
+
+fun Set<AutocaptureOption>.stringRepresentation(): String {
+    if (isEmpty()) return "none"
+
+    val options = mutableListOf<String>()
+    if (contains(AutocaptureOption.SESSIONS)) {
+        options.add("sessions")
+    }
+    if (contains(AutocaptureOption.APP_LIFECYCLES)) {
+        options.add("appLifecycles")
+    }
+    if (contains(AutocaptureOption.DEEP_LINKS)) {
+        options.add("deepLinks")
+    }
+    if (contains(AutocaptureOption.SCREEN_VIEWS)) {
+        options.add("screenViews")
+    }
+    if (contains(AutocaptureOption.ELEMENT_INTERACTIONS)) {
+        options.add("elementInteractions")
+    }
+    if (contains(AutocaptureOption.FRUSTRATION_INTERACTIONS)) {
+        options.add("frustrationInteractions")
+    }
+
+    return options.joinToString(separator = ",")
+}

android/src/main/java/com/amplitude/android/Configuration.kt

@@ -50,6 +50,7 @@ open class Configuration(
     override var sessionId: Long? = null,
     override var httpClient: HttpClientInterface? = null,
     var interactionsOptions: InteractionsOptions = InteractionsOptions(),
+    override var enableDiagnostics: Boolean = true,
 ) : Configuration(
         apiKey,
         flushQueueSize,
@@ -74,6 +75,7 @@ open class Configuration(
         deviceId,
         sessionId,
         httpClient,
+        enableDiagnostics = enableDiagnostics,
     ) {
     companion object {
         const val MIN_TIME_BETWEEN_SESSIONS_MILLIS: Long = 300000
@@ -118,6 +120,7 @@ open class Configuration(
         sessionId: Long? = null,
         httpClient: HttpClientInterface? = null,
         interactionsOptions: InteractionsOptions = InteractionsOptions(),
+        enableDiagnostics: Boolean = true,
     ) : this(
         apiKey,
         context,
@@ -154,6 +157,7 @@ open class Configuration(
         sessionId,
         httpClient,
         interactionsOptions,
+        enableDiagnostics,
     ) {
         if (!trackingSessionEvents) {
             defaultTracking.sessions = false

android/src/main/java/com/amplitude/android/diagnostics/AndroidDiagnosticsContextProvider.kt

@@ -0,0 +1,30 @@
+package com.amplitude.android.diagnostics
+
+import android.content.Context
+import android.os.Build
+import com.amplitude.core.diagnostics.DiagnosticsContextInfo
+import com.amplitude.core.diagnostics.DiagnosticsContextProvider
+
+class AndroidDiagnosticsContextProvider(
+    private val context: Context,
+) : DiagnosticsContextProvider {
+    override fun getContextInfo(): DiagnosticsContextInfo {
+        return DiagnosticsContextInfo(
+            manufacturer = Build.MANUFACTURER,
+            model = Build.MODEL,
+            osName = "Android",
+            osVersion = Build.VERSION.RELEASE,
+            platform = "Android",
+            appVersion = fetchVersionName(),
+        )
+    }
+
+    private fun fetchVersionName(): String? {
+        return try {
+            val info = context.packageManager.getPackageInfo(context.packageName, 0)
+            info.versionName
+        } catch (_: Exception) {
+            null
+        }
+    }
+}

android/src/main/java/com/amplitude/android/plugins/AndroidContextPlugin.kt

@@ -5,10 +5,12 @@ import com.amplitude.android.Configuration
 import com.amplitude.android.TrackingOptions
 import com.amplitude.common.android.AndroidContextProvider
 import com.amplitude.core.Amplitude
+import com.amplitude.core.RestrictedAmplitudeFeature
 import com.amplitude.core.events.BaseEvent
 import com.amplitude.core.platform.Plugin
 import java.util.UUID
 
+@OptIn(RestrictedAmplitudeFeature::class)
 open class AndroidContextPlugin : Plugin {
     override val type: Plugin.Type = Plugin.Type.Before
     override lateinit var amplitude: Amplitude
@@ -25,6 +27,11 @@ open class AndroidContextPlugin : Plugin {
                 configuration.trackingOptions.shouldTrackAppSetId(),
             )
         initializeDeviceId(configuration)
+
+        amplitude.diagnosticsClient.setTag(
+            name = "sdk.${SDK_LIBRARY}.version",
+            value = SDK_VERSION,
+        )
     }
 
     override fun execute(event: BaseEvent): BaseEvent? {

android/src/main/java/com/amplitude/android/plugins/AndroidLifecyclePlugin.kt

@@ -13,17 +13,19 @@ import com.amplitude.android.GuardedAmplitudeFeature
 import com.amplitude.android.InteractionType.DeadClick
 import com.amplitude.android.InteractionType.RageClick
 import com.amplitude.android.internal.gestures.WindowCallbackManager
+import com.amplitude.android.stringRepresentation
 import com.amplitude.android.utilities.ActivityCallbackType
 import com.amplitude.android.utilities.ActivityLifecycleObserver
 import com.amplitude.android.utilities.DefaultEventUtils
 import com.amplitude.core.Amplitude
+import com.amplitude.core.RestrictedAmplitudeFeature
 import com.amplitude.core.platform.Plugin
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.launch
 import com.amplitude.android.Amplitude as AndroidAmplitude
 
-@OptIn(GuardedAmplitudeFeature::class)
+@OptIn(GuardedAmplitudeFeature::class, RestrictedAmplitudeFeature::class)
 class AndroidLifecyclePlugin(
     private val activityLifecycleObserver: ActivityLifecycleObserver,
 ) : Application.ActivityLifecycleCallbacks,
@@ -58,6 +60,12 @@ class AndroidLifecyclePlugin(
                 androidConfiguration.interactionsOptions,
             )
 
+        // Set autocapture state to diagnostics client
+        amplitude.diagnosticsClient.setTag(
+            name = "autocapture.enabled",
+            value = androidConfiguration.autocapture.stringRepresentation(),
+        )
+
         val application = androidConfiguration.context as Application
 
         // Initialize frustration interactions detector if rage or dead click is enabled

android/src/main/java/com/amplitude/android/storage/AndroidStorageContextV1.kt

@@ -5,6 +5,8 @@ import com.amplitude.android.Amplitude
 import com.amplitude.android.Configuration
 import com.amplitude.android.migration.AndroidStorageMigration
 import com.amplitude.android.migration.IdentityStorageMigration
+import com.amplitude.core.RestrictedAmplitudeFeature
+import com.amplitude.core.diagnostics.DiagnosticsClientProvider
 import com.amplitude.core.utilities.FileStorage
 import com.amplitude.id.FileIdentityStorage
 import com.amplitude.id.IdentityConfiguration
@@ -23,6 +25,7 @@ import java.io.File
  * /shared_prefs
  *   /amplitude-android-{api_key}.xml
  */
+@OptIn(RestrictedAmplitudeFeature::class)
 internal class AndroidStorageContextV1(
     private val amplitude: Amplitude,
     configuration: Configuration,
@@ -83,6 +86,7 @@ internal class AndroidStorageContextV1(
             sharedPreferences,
             storageDirectory,
             amplitude.diagnostics,
+            DiagnosticsClientProvider { amplitude.diagnosticsClient },
         )
     }
 

android/src/main/java/com/amplitude/android/storage/AndroidStorageContextV2.kt

@@ -5,6 +5,8 @@ import com.amplitude.android.Amplitude
 import com.amplitude.android.Configuration
 import com.amplitude.android.migration.AndroidStorageMigration
 import com.amplitude.android.migration.IdentityStorageMigration
+import com.amplitude.core.RestrictedAmplitudeFeature
+import com.amplitude.core.diagnostics.DiagnosticsClientProvider
 import com.amplitude.core.utilities.FileStorage
 import com.amplitude.id.FileIdentityStorage
 import com.amplitude.id.IdentityConfiguration
@@ -23,6 +25,7 @@ import java.io.File
  * /shared_prefs
  *   /amplitude-android-{instance_name}.xml
  */
+@OptIn(RestrictedAmplitudeFeature::class)
 internal class AndroidStorageContextV2(
     private val amplitude: Amplitude,
     configuration: Configuration,
@@ -100,6 +103,7 @@ internal class AndroidStorageContextV2(
             sharedPreferences,
             storageDirectory,
             amplitude.diagnostics,
+            DiagnosticsClientProvider { amplitude.diagnosticsClient },
         )
     }