Merge pull request #2487 from DataDog/maciey/RUM-7797/anonymous-id

RUM-7797 Anonymous RUM Identifier

Author: maciejburda

dd-sdk-android-core/api/apiSurface

@@ -89,7 +89,7 @@ data class com.datadog.android.api.context.ProcessInfo
 data class com.datadog.android.api.context.TimeInfo
   constructor(Long, Long, Long, Long)
 data class com.datadog.android.api.context.UserInfo
-  constructor(kotlin.String? = null, kotlin.String? = null, kotlin.String? = null, Map<kotlin.String, kotlin.Any?> = emptyMap())
+  constructor(kotlin.String? = null, kotlin.String? = null, kotlin.String? = null, kotlin.String? = null, Map<kotlin.String, kotlin.Any?> = emptyMap())
 interface com.datadog.android.api.feature.Feature
   val name: String
   fun onInitialize(android.content.Context)
@@ -123,6 +123,7 @@ interface com.datadog.android.api.feature.FeatureSdkCore : com.datadog.android.a
   fun removeEventReceiver(String)
   fun createSingleThreadExecutorService(String): java.util.concurrent.ExecutorService
   fun createScheduledExecutorService(String): java.util.concurrent.ScheduledExecutorService
+  fun setAnonymousId(java.util.UUID?)
 interface com.datadog.android.api.feature.StorageBackedFeature : Feature
   val requestFactory: com.datadog.android.api.net.RequestFactory
   val storageConfiguration: com.datadog.android.api.storage.FeatureStorageConfiguration

dd-sdk-android-core/api/dd-sdk-android-core.api

@@ -281,18 +281,20 @@ public final class com/datadog/android/api/context/TimeInfo {
 
 public final class com/datadog/android/api/context/UserInfo {
 	public fun <init> ()V
-	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)V
-	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Ljava/lang/String;
 	public final fun component2 ()Ljava/lang/String;
 	public final fun component3 ()Ljava/lang/String;
-	public final fun component4 ()Ljava/util/Map;
-	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)Lcom/datadog/android/api/context/UserInfo;
-	public static synthetic fun copy$default (Lcom/datadog/android/api/context/UserInfo;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;ILjava/lang/Object;)Lcom/datadog/android/api/context/UserInfo;
+	public final fun component4 ()Ljava/lang/String;
+	public final fun component5 ()Ljava/util/Map;
+	public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;)Lcom/datadog/android/api/context/UserInfo;
+	public static synthetic fun copy$default (Lcom/datadog/android/api/context/UserInfo;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/Map;ILjava/lang/Object;)Lcom/datadog/android/api/context/UserInfo;
 	public fun equals (Ljava/lang/Object;)Z
 	public static final fun fromJson (Ljava/lang/String;)Lcom/datadog/android/api/context/UserInfo;
 	public static final fun fromJsonObject (Lcom/google/gson/JsonObject;)Lcom/datadog/android/api/context/UserInfo;
 	public final fun getAdditionalProperties ()Ljava/util/Map;
+	public final fun getAnonymousId ()Ljava/lang/String;
 	public final fun getEmail ()Ljava/lang/String;
 	public final fun getId ()Ljava/lang/String;
 	public final fun getName ()Ljava/lang/String;
@@ -355,6 +357,7 @@ public abstract interface class com/datadog/android/api/feature/FeatureSdkCore :
 	public abstract fun registerFeature (Lcom/datadog/android/api/feature/Feature;)V
 	public abstract fun removeContextUpdateReceiver (Ljava/lang/String;Lcom/datadog/android/api/feature/FeatureContextUpdateReceiver;)V
 	public abstract fun removeEventReceiver (Ljava/lang/String;)V
+	public abstract fun setAnonymousId (Ljava/util/UUID;)V
 	public abstract fun setContextUpdateReceiver (Ljava/lang/String;Lcom/datadog/android/api/feature/FeatureContextUpdateReceiver;)V
 	public abstract fun setEventReceiver (Ljava/lang/String;Lcom/datadog/android/api/feature/FeatureEventReceiver;)V
 	public abstract fun updateFeatureContext (Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/context/UserInfo.kt

@@ -22,12 +22,14 @@ import kotlin.jvm.Throws
 
 /**
  * Holds information about the current User.
+ * @property anonymousId a unique anonymous identifier for the device, or null
  * @property id a unique identifier for the user, or null
  * @property name the name of the user, or null
  * @property email the email address of the user, or null
  * @property additionalProperties a dictionary of custom properties attached to the current user
  */
 data class UserInfo(
+    val anonymousId: String? = null,
     val id: String? = null,
     val name: String? = null,
     val email: String? = null,
@@ -37,6 +39,9 @@ data class UserInfo(
     @Suppress("StringLiteralDuplication")
     internal fun toJson(): JsonElement {
         val json = JsonObject()
+        anonymousId?.let { idNonNull ->
+            json.addProperty("anonymous_id", idNonNull)
+        }
         id?.let { idNonNull ->
             json.addProperty("id", idNonNull)
         }
@@ -79,6 +84,7 @@ data class UserInfo(
         @Suppress("StringLiteralDuplication", "ThrowsCount")
         fun fromJsonObject(jsonObject: JsonObject): UserInfo {
             try {
+                val anonymousId = jsonObject.get("anonymous_id")?.asString
                 val id = jsonObject.get("id")?.asString
                 val name = jsonObject.get("name")?.asString
                 val email = jsonObject.get("email")?.asString
@@ -88,7 +94,7 @@ data class UserInfo(
                         additionalProperties[entry.key] = entry.value
                     }
                 }
-                return UserInfo(id, name, email, additionalProperties)
+                return UserInfo(anonymousId, id, name, email, additionalProperties)
             } catch (e: IllegalStateException) {
                 throw JsonParseException(
                     "Unable to parse json into type UserInfo",

dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/feature/FeatureSdkCore.kt

@@ -8,6 +8,7 @@ package com.datadog.android.api.feature
 
 import com.datadog.android.api.InternalLogger
 import com.datadog.android.api.SdkCore
+import java.util.UUID
 import java.util.concurrent.ExecutorService
 import java.util.concurrent.ScheduledExecutorService
 
@@ -16,6 +17,7 @@ import java.util.concurrent.ScheduledExecutorService
  *
  * SDK core is always guaranteed to implement this interface.
  */
+@Suppress("TooManyFunctions")
 interface FeatureSdkCore : SdkCore {
 
     /**
@@ -104,4 +106,11 @@ interface FeatureSdkCore : SdkCore {
      * @param executorContext Context to be used for logging and naming threads running on this executor.
      */
     fun createScheduledExecutorService(executorContext: String): ScheduledExecutorService
+
+    /**
+     * Allows the given feature to set the anonymous ID for the SDK.
+     *
+     * @param anonymousId Anonymous ID to set. Can be null if feature is disabled.
+     */
+    fun setAnonymousId(anonymousId: UUID?)
 }

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/DatadogCore.kt

@@ -44,6 +44,7 @@ import com.datadog.android.privacy.TrackingConsent
 import com.google.gson.JsonObject
 import java.io.File
 import java.util.Locale
+import java.util.UUID
 import java.util.concurrent.ConcurrentHashMap
 import java.util.concurrent.ExecutorService
 import java.util.concurrent.ScheduledExecutorService
@@ -268,6 +269,10 @@ internal class DatadogCore(
         return coreFeature.createScheduledExecutorService(executorContext)
     }
 
+    override fun setAnonymousId(anonymousId: UUID?) {
+        coreFeature.userInfoProvider.setAnonymousId(anonymousId?.toString())
+    }
+
     override fun isCoreActive(): Boolean = isActive
 
     // endregion

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/NoOpContextProvider.kt

@@ -45,7 +45,7 @@ internal class NoOpContextProvider : ContextProvider {
                 cellularTechnology = null
             ),
             deviceInfo = DeviceInfo("", "", "", DeviceType.OTHER, "", "", "", "", ""),
-            userInfo = UserInfo(null, null, null, emptyMap()),
+            userInfo = UserInfo(null, null, null, null, emptyMap()),
             trackingConsent = TrackingConsent.NOT_GRANTED,
             appBuildId = null,
             featuresContext = emptyMap()

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/NoOpInternalSdkCore.kt

@@ -22,6 +22,7 @@ import com.datadog.android.core.internal.net.FirstPartyHostHeaderTypeResolver
 import com.datadog.android.privacy.TrackingConsent
 import com.google.gson.JsonObject
 import java.io.File
+import java.util.UUID
 import java.util.concurrent.Callable
 import java.util.concurrent.Delayed
 import java.util.concurrent.ExecutionException
@@ -128,6 +129,8 @@ internal object NoOpInternalSdkCore : InternalSdkCore {
         return NoOpScheduledExecutorService()
     }
 
+    override fun setAnonymousId(anonymousId: UUID?) = Unit
+
     // endregion
 
     // region InternalSdkCore

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/user/DatadogUserInfoProvider.kt

@@ -29,6 +29,12 @@ internal class DatadogUserInfoProvider(
         )
     }
 
+    override fun setAnonymousId(id: String?) {
+        internalUserInfo = internalUserInfo.copy(
+            anonymousId = id
+        )
+    }
+
     override fun addUserProperties(properties: Map<String, Any?>) {
         internalUserInfo = internalUserInfo.copy(
             additionalProperties = internalUserInfo.additionalProperties + properties

dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/user/MutableUserInfoProvider.kt

@@ -18,5 +18,7 @@ internal interface MutableUserInfoProvider : UserInfoProvider {
         extraInfo: Map<String, Any?>
     )
 
+    fun setAnonymousId(id: String?)
+
     fun addUserProperties(properties: Map<String, Any?>)
 }

dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/DatadogCoreTest.kt

@@ -77,6 +77,7 @@ import org.mockito.kotlin.whenever
 import org.mockito.quality.Strictness
 import java.util.Collections
 import java.util.Locale
+import java.util.UUID
 import java.util.concurrent.CountDownLatch
 import java.util.concurrent.Future
 import java.util.concurrent.TimeUnit
@@ -228,6 +229,35 @@ internal class DatadogCoreTest {
         verify(mockUserInfoProvider).setUserInfo(id, name, email, fakeUserProperties)
     }
 
+    @Test
+    fun `M update anonymousId W setAnonymousId()`(
+        forge: Forge
+    ) {
+        // Given
+        val uuid = forge.getForgery<UUID>()
+        val mockUserInfoProvider = mock<MutableUserInfoProvider>()
+        testedCore.coreFeature.userInfoProvider = mockUserInfoProvider
+
+        // When
+        testedCore.setAnonymousId(uuid)
+
+        // Then
+        verify(mockUserInfoProvider).setAnonymousId(uuid.toString())
+    }
+
+    @Test
+    fun `M clears anonymousId W setAnonymousId(null)`() {
+        // Given
+        val mockUserInfoProvider = mock<MutableUserInfoProvider>()
+        testedCore.coreFeature.userInfoProvider = mockUserInfoProvider
+
+        // When
+        testedCore.setAnonymousId(null)
+
+        // Then
+        verify(mockUserInfoProvider).setAnonymousId(null)
+    }
+
     @Test
     fun `M set additional user info W addUserProperties() is called`(
         @StringForgery(type = StringForgeryType.HEXADECIMAL) id: String,