Merge pull request #2768 from DataDog/maciey/RUM-10621/clear-user-info

maciejburda · web-flow · commit 0249aa83bcd9 · 2025-07-03T12:30:17.000+01:00
RUM-10621 Add clear user info API
diff --git a/dd-sdk-android-core/api/apiSurface b/dd-sdk-android-core/api/apiSurface
@@ -10,6 +10,7 @@ object com.datadog.android.Datadog
   fun setUserInfo(String, String? = null, String? = null, Map<String, Any?> = emptyMap(), com.datadog.android.api.SdkCore = getInstance())
   DEPRECATED fun setUserInfo(String? = null, String? = null, String? = null, Map<String, Any?> = emptyMap(), com.datadog.android.api.SdkCore = getInstance())
   fun addUserProperties(Map<String, Any?>, com.datadog.android.api.SdkCore = getInstance())
+  fun clearUserInfo(com.datadog.android.api.SdkCore = getInstance())
   fun clearAllData(com.datadog.android.api.SdkCore = getInstance())
   fun setAccountInfo(String, String? = null, Map<String, Any?> = emptyMap(), com.datadog.android.api.SdkCore = getInstance())
   fun addAccountExtraInfo(Map<String, Any?> = emptyMap(), com.datadog.android.api.SdkCore = getInstance())
@@ -60,6 +61,7 @@ interface com.datadog.android.api.SdkCore
   fun setTrackingConsent(com.datadog.android.privacy.TrackingConsent)
   fun setUserInfo(String? = null, String? = null, String? = null, Map<String, Any?> = emptyMap())
   fun addUserProperties(Map<String, Any?>)
+  fun clearUserInfo()
   fun clearAllData()
   fun setAccountInfo(String, String? = null, Map<String, Any?> = emptyMap())
   fun addAccountExtraInfo(Map<String, Any?> = emptyMap())
diff --git a/dd-sdk-android-core/api/dd-sdk-android-core.api b/dd-sdk-android-core/api/dd-sdk-android-core.api
@@ -25,6 +25,9 @@ public final class com/datadog/android/Datadog {
 	public static final fun clearAllData ()V
 	public static final fun clearAllData (Lcom/datadog/android/api/SdkCore;)V
 	public static synthetic fun clearAllData$default (Lcom/datadog/android/api/SdkCore;ILjava/lang/Object;)V
+	public static final fun clearUserInfo ()V
+	public static final fun clearUserInfo (Lcom/datadog/android/api/SdkCore;)V
+	public static synthetic fun clearUserInfo$default (Lcom/datadog/android/api/SdkCore;ILjava/lang/Object;)V
 	public static final fun getInstance ()Lcom/datadog/android/api/SdkCore;
 	public static final fun getInstance (Ljava/lang/String;)Lcom/datadog/android/api/SdkCore;
 	public static synthetic fun getInstance$default (Ljava/lang/String;ILjava/lang/Object;)Lcom/datadog/android/api/SdkCore;
@@ -135,6 +138,7 @@ public abstract interface class com/datadog/android/api/SdkCore {
 	public abstract fun addUserProperties (Ljava/util/Map;)V
 	public abstract fun clearAccountInfo ()V
 	public abstract fun clearAllData ()V
+	public abstract fun clearUserInfo ()V
 	public abstract fun getName ()Ljava/lang/String;
 	public abstract fun getService ()Ljava/lang/String;
 	public abstract fun getTime ()Lcom/datadog/android/api/context/TimeInfo;
diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/Datadog.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/Datadog.kt
@@ -305,6 +305,32 @@ object Datadog {
         sdkCore.addUserProperties(extraInfo)
     }
 
+    /**
+     * Clear the current user information.
+     *
+     * User information will be set to null.
+     * After calling this api, Logs, Traces, RUM Events will not include the user information anymore.
+     *
+     * Any active RUM Session, active RUM View at the time of call will have their `usr` attribute cleared.
+     *
+     * If you want to retain the current `usr` on the active RUM session,
+     * you need to stop the session first by using `GlobalRumMonitor.get().stopSession()`
+     *
+     * If you want to retain the current `usr` on the active RUM views,
+     * you need to stop the view first by using `GlobalRumMonitor.get().stopView()`.
+     *
+     * @param sdkCore SDK instance to clear user info. If not provided,
+     * default SDK instance will be used.
+     */
+    @JvmStatic
+    @JvmOverloads
+    @AnyThread
+    fun clearUserInfo(
+        sdkCore: SdkCore = getInstance()
+    ) {
+        sdkCore.clearUserInfo()
+    }
+
     /**
      * Clears all unsent data in all registered features.
      *
diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/SdkCore.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/api/SdkCore.kt
@@ -76,6 +76,23 @@ interface SdkCore {
     @AnyThread
     fun addUserProperties(extraInfo: Map<String, Any?>)
 
+    /**
+     * Clear the current user information.
+     *
+     * User information will be set to null.
+     * After calling this api, Logs, Traces, RUM Events will not include the user information anymore.
+     *
+     * Any active RUM Session, active RUM View at the time of call will have their `usr` attribute cleared.
+     *
+     * If you want to retain the current `usr` on the active RUM session,
+     * you need to stop the session first by using `GlobalRumMonitor.get().stopSession()`
+     *
+     * If you want to retain the current `usr` on the active RUM views,
+     * you need to stop the view first by using `GlobalRumMonitor.get().stopView()`
+     */
+    @AnyThread
+    fun clearUserInfo()
+
     /**
      * Clears all unsent data in all registered features.
      */
diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/DatadogCore.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/DatadogCore.kt
@@ -176,6 +176,12 @@ internal class DatadogCore(
         coreFeature.userInfoProvider.addUserProperties(extraInfo)
     }
 
+    /** @inheritDoc */
+    @AnyThread
+    override fun clearUserInfo() {
+        coreFeature.userInfoProvider.clearUserInfo()
+    }
+
     /** @inheritDoc */
     @AnyThread
     override fun clearAllData() {
diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/NoOpInternalSdkCore.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/NoOpInternalSdkCore.kt
@@ -88,6 +88,8 @@ internal object NoOpInternalSdkCore : InternalSdkCore {
 
     override fun addUserProperties(extraInfo: Map<String, Any?>) = Unit
 
+    override fun clearUserInfo() = Unit
+
     override fun clearAllData() = Unit
 
     override fun setAccountInfo(
diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/user/DatadogUserInfoProvider.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/user/DatadogUserInfoProvider.kt
@@ -41,6 +41,10 @@ internal class DatadogUserInfoProvider(
         )
     }
 
+    override fun clearUserInfo() {
+        internalUserInfo = UserInfo(internalUserInfo.anonymousId)
+    }
+
     override fun getUserInfo(): UserInfo {
         return internalUserInfo
     }
diff --git a/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/user/MutableUserInfoProvider.kt b/dd-sdk-android-core/src/main/kotlin/com/datadog/android/core/internal/user/MutableUserInfoProvider.kt
@@ -21,4 +21,6 @@ internal interface MutableUserInfoProvider : UserInfoProvider {
     fun setAnonymousId(id: String?)
 
     fun addUserProperties(properties: Map<String, Any?>)
+
+    fun clearUserInfo()
 }
diff --git a/dd-sdk-android-core/src/test/kotlin/com/datadog/android/DatadogTest.kt b/dd-sdk-android-core/src/test/kotlin/com/datadog/android/DatadogTest.kt
@@ -540,6 +540,18 @@ internal class DatadogTest {
         verify(mockSdkCore).addUserProperties(fakeUserProperties)
     }
 
+    @Test
+    fun `M clear user info W clearUserInfo()`() {
+        // Given
+        val mockSdkCore = mock<SdkCore>()
+
+        // When
+        Datadog.clearUserInfo(mockSdkCore)
+
+        // Then
+        verify(mockSdkCore).clearUserInfo()
+    }
+
     @Test
     fun `M clear all data W clearAllData()`() {
         // Given
diff --git a/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/DatadogCoreTest.kt b/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/DatadogCoreTest.kt
@@ -291,6 +291,19 @@ internal class DatadogCoreTest {
         )
     }
 
+    @Test
+    fun `M clear user info W clearUserInfo() is called`() {
+        // Given
+        val mockUserInfoProvider = mock<MutableUserInfoProvider>()
+        testedCore.coreFeature.userInfoProvider = mockUserInfoProvider
+
+        // When
+        testedCore.clearUserInfo()
+
+        // Then
+        verify(mockUserInfoProvider).clearUserInfo()
+    }
+
     @Test
     fun `M update accountInfoProvider W setAccountInfo()`(
         @StringForgery(type = StringForgeryType.HEXADECIMAL) id: String,
diff --git a/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/internal/CoreFeatureTest.kt b/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/internal/CoreFeatureTest.kt
@@ -67,6 +67,7 @@ import okhttp3.TlsVersion
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
 import org.junit.jupiter.api.extension.Extensions
@@ -209,6 +210,7 @@ internal class CoreFeatureTest {
     }
 
     @Test
+    @Disabled // RUM-10684: ApiLevelExtension is not able to set API level property
     fun `M initialize network info provider W initialize`() {
         // When
         testedFeature.initialize(
@@ -231,6 +233,7 @@ internal class CoreFeatureTest {
 
     @Test
     @TestTargetApi(Build.VERSION_CODES.N)
+    @Disabled // RUM-10684: ApiLevelExtension is not able to set API level property
     fun `M initialize network info provider W initialize {N}`() {
         // When
         testedFeature.initialize(
diff --git a/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/internal/user/DatadogUserInfoProviderTest.kt b/dd-sdk-android-core/src/test/kotlin/com/datadog/android/core/internal/user/DatadogUserInfoProviderTest.kt
@@ -333,4 +333,46 @@ internal class DatadogUserInfoProviderTest {
         // Then
         assertThat(testedProvider.getUserInfo().additionalProperties).isEqualTo(fakeExpectedUserProperties)
     }
+
+    @Test
+    fun `M return default userInfo W clearUserInfo()`(
+        @StringForgery(type = StringForgeryType.HEXADECIMAL) id: String,
+        @StringForgery name: String,
+        @StringForgery(regex = "\\w+@\\w+") email: String,
+        @MapForgery(
+            key = AdvancedForgery(string = [StringForgery(StringForgeryType.ALPHA_NUMERICAL)]),
+            value = AdvancedForgery(string = [StringForgery(StringForgeryType.ALPHA_NUMERICAL)])
+        ) fakeUserProperties: Map<String, String>
+    ) {
+        // Given
+        testedProvider.setUserInfo(id, name, email, fakeUserProperties)
+
+        // When
+        testedProvider.clearUserInfo()
+
+        // Then
+        assertThat(testedProvider.getUserInfo()).isEqualTo(UserInfo())
+    }
+
+    @Test
+    fun `M delegate to persister W clearUserInfo()`(
+        @StringForgery(type = StringForgeryType.HEXADECIMAL) id: String,
+        @StringForgery(type = StringForgeryType.HEXADECIMAL) anonymousId: String,
+        @StringForgery name: String,
+        @StringForgery(regex = "\\w+@\\w+") email: String,
+        @MapForgery(
+            key = AdvancedForgery(string = [StringForgery(StringForgeryType.ALPHA_NUMERICAL)]),
+            value = AdvancedForgery(string = [StringForgery(StringForgeryType.ALPHA_NUMERICAL)])
+        ) fakeUserProperties: Map<String, String>
+    ) {
+        // Given
+        testedProvider.setUserInfo(id, name, email, fakeUserProperties)
+        testedProvider.setAnonymousId(anonymousId)
+
+        // When
+        testedProvider.clearUserInfo()
+
+        // Then
+        verify(mockWriter).write(UserInfo(anonymousId))
+    }
 }
diff --git a/reliability/core-it/src/androidTest/kotlin/com/datadog/android/core/integration/tests/SdkCoreTest.kt b/reliability/core-it/src/androidTest/kotlin/com/datadog/android/core/integration/tests/SdkCoreTest.kt
@@ -117,6 +117,28 @@ class SdkCoreTest : MockServerTest() {
             .containsExactlyInAnyOrderEntriesOf(fakeUserAdditionalProperties)
     }
 
+    @Test
+    fun must_clearUserInformation_when_clearUserInfo() {
+        // Given
+        testedSdkCore?.setUserInfo(fakeUserId, fakeUserName, fakeUserEmail, fakeUserAdditionalProperties)
+
+        // When
+        testedSdkCore?.clearUserInfo()
+
+        // Then
+        val countDownLatch = CountDownLatch(1)
+        var readUserInfo: UserInfo? = null
+        featureSdkCore?.getFeature(stubFeature.name)?.withWriteContext { datadogContext, _ ->
+            readUserInfo = datadogContext.userInfo
+            countDownLatch.countDown()
+        }
+        countDownLatch.await(SHORT_WAIT_MS, TimeUnit.MILLISECONDS)
+        assertThat(readUserInfo?.id).isNull()
+        assertThat(readUserInfo?.name).isNull()
+        assertThat(readUserInfo?.email).isNull()
+        assertThat(readUserInfo?.additionalProperties).isEmpty()
+    }
+
     // endregion
 
     // region set AccountInfo
diff --git a/reliability/stub-core/src/main/kotlin/com/datadog/android/core/stub/StubSDKCore.kt b/reliability/stub-core/src/main/kotlin/com/datadog/android/core/stub/StubSDKCore.kt
@@ -193,6 +193,10 @@ class StubSDKCore(
         stubUserInfo(UserInfo(null, id, name, email, extraInfo))
     }
 
+    override fun clearUserInfo() {
+        stubUserInfo(UserInfo())
+    }
+
     override fun setAccountInfo(
         id: String,
         name: String?,
@@ -201,5 +205,9 @@ class StubSDKCore(
         stubAccountInfo(AccountInfo(id, name, extraInfo))
     }
 
+    override fun clearAccountInfo() {
+        datadogContext = datadogContext.copy(accountInfo = null)
+    }
+
     // endregion
 }
diff --git a/sample/kotlin/src/main/kotlin/com/datadog/android/sample/Preferences.kt b/sample/kotlin/src/main/kotlin/com/datadog/android/sample/Preferences.kt
@@ -151,6 +151,17 @@ internal object Preferences {
                 .apply()
         }
 
+        fun clearUserCredentials() {
+            PreferenceManager.getDefaultSharedPreferences(applicationContext)
+                .edit()
+                .remove(PREF_USR_ID)
+                .remove(PREF_USR_NAME)
+                .remove(PREF_USR_EMAIL)
+                .remove(PREF_USR_GENDER)
+                .remove(PREF_USR_AGE)
+                .apply()
+        }
+
         fun setTrackingConsent(consent: TrackingConsent) {
             PreferenceManager.getDefaultSharedPreferences(applicationContext)
                 .edit()
diff --git a/sample/kotlin/src/main/kotlin/com/datadog/android/sample/user/UserFragment.kt b/sample/kotlin/src/main/kotlin/com/datadog/android/sample/user/UserFragment.kt
@@ -40,6 +40,7 @@ internal class UserFragment : Fragment(), View.OnClickListener {
         userGenderField = rootView.findViewById(R.id.user_gender)
         userAgeField = rootView.findViewById(R.id.user_age)
         rootView.findViewById<View>(R.id.save_user).setOnClickListener(this)
+        rootView.findViewById<View>(R.id.clear_user).setOnClickListener(this)
         return rootView
     }
 
@@ -58,24 +59,44 @@ internal class UserFragment : Fragment(), View.OnClickListener {
     // region View.OnClickListener
 
     override fun onClick(v: View) {
-        withinSpan("updateUserInfo") {
-            val id: String = idField.text.toString()
-            val name: String = nameField.text.toString()
-            val email: String = emailField.text.toString()
-            val gender: String = userGenderField.text.toString()
-            val age: Int = Integer.valueOf(userAgeField.text.toString())
-            Preferences.defaultPreferences(requireContext())
-                .setUserCredentials(id, name, email, gender, age)
-            Datadog.setUserInfo(id, name, email, emptyMap())
-            Datadog.addUserProperties(
-                mapOf<String, Any>(
-                    GENDER_KEY to gender,
-                    AGE_KEY to age
-                )
-            )
-            log("Updated user info")
+        when (v.id) {
+            R.id.save_user -> {
+                withinSpan("updateUserInfo") {
+                    val id: String = idField.text.toString()
+                    val name: String = nameField.text.toString()
+                    val email: String = emailField.text.toString()
+                    val gender: String = userGenderField.text.toString()
+                    val age: Int = Integer.valueOf(userAgeField.text.toString())
+                    Preferences.defaultPreferences(requireContext())
+                        .setUserCredentials(id, name, email, gender, age)
+                    Datadog.setUserInfo(id, name, email, emptyMap())
+                    Datadog.addUserProperties(
+                        mapOf<String, Any>(
+                            GENDER_KEY to gender,
+                            AGE_KEY to age
+                        )
+                    )
+                    log("Updated user info")
+                }
+                Snackbar.make(view ?: v.rootView, "User info updated", Snackbar.LENGTH_SHORT).show()
+            }
+            R.id.clear_user -> {
+                withinSpan("clearUserInfo") {
+                    // Clear preferences
+                    Preferences.defaultPreferences(requireContext()).clearUserCredentials()
+                    // Clear Datadog user info
+                    Datadog.clearUserInfo()
+                    // Clear UI fields
+                    idField.text.clear()
+                    nameField.text.clear()
+                    emailField.text.clear()
+                    userGenderField.text.clear()
+                    userAgeField.text.clear()
+                    log("Cleared user info")
+                }
+                Snackbar.make(view ?: v.rootView, "User info cleared", Snackbar.LENGTH_SHORT).show()
+            }
         }
-        Snackbar.make(view ?: v.rootView, "User info updated", Snackbar.LENGTH_SHORT).show()
     }
 
     // endregion
diff --git a/sample/kotlin/src/main/res/layout/fragment_user.xml b/sample/kotlin/src/main/res/layout/fragment_user.xml
@@ -78,6 +78,18 @@
         android:layout_gravity="center_horizontal"
         android:layout_margin="8dp"
         app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintEnd_toStartOf="@+id/clear_user"
+        app:layout_constraintTop_toBottomOf="@id/user_age"
+    />
+
+    <androidx.appcompat.widget.AppCompatButton
+        android:id="@+id/clear_user"
+        android:layout_width="0dp"
+        android:layout_height="wrap_content"
+        android:text="@string/button_clear"
+        android:layout_gravity="center_horizontal"
+        android:layout_margin="8dp"
+        app:layout_constraintStart_toEndOf="@+id/save_user"
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintTop_toBottomOf="@id/user_age"
     />
diff --git a/sample/kotlin/src/main/res/values/strings.xml b/sample/kotlin/src/main/res/values/strings.xml

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,10 @@ internal class DatadogUserInfoProvider(`
`41`	`41`	`)`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ override fun clearUserInfo() {`
	`45`	`+ internalUserInfo = UserInfo(internalUserInfo.anonymousId)`
	`46`	`+ }`
	`47`	`+`
`44`	`48`	`override fun getUserInfo(): UserInfo {`
`45`	`49`	`return internalUserInfo`
`46`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,6 @@ internal interface MutableUserInfoProvider : UserInfoProvider {`
`21`	`21`	`fun setAnonymousId(id: String?)`
`22`	`22`
`23`	`23`	`fun addUserProperties(properties: Map<String, Any?>)`
	`24`	`+`
	`25`	`+ fun clearUserInfo()`
`24`	`26`	`}`