Merge pull request #889 from embrace-io/remove-user-info

Remove legacy user info field
embrace-io · May 30, 2024 · 203ee02 · 203ee02
2 parents 53a33ef + efdc127
commit 203ee02
Show file tree

Hide file tree

Showing 20 changed files with 56 additions and 69 deletions.
diff --git a/...src/integrationTest/kotlin/io/embrace/android/embracesdk/IntegrationTestRuleExtensions.kt b/...src/integrationTest/kotlin/io/embrace/android/embracesdk/IntegrationTestRuleExtensions.kt
@@ -215,7 +215,6 @@ internal fun verifySessionMessage(sessionMessage: SessionMessage) {
     assertNotNull(sessionMessage.deviceInfo)
 
     if (sessionMessage.session.messageType == "en") {
-        assertNotNull(sessionMessage.userInfo)
         assertNotNull(sessionMessage.performanceInfo)
     }
 }
@@ -231,7 +230,6 @@ internal fun verifyBgActivityMessage(message: SessionMessage) {
     assertNotNull(message.deviceInfo)
 
     if (message.session.messageType == "en") {
-        assertNotNull(message.userInfo)
         assertNotNull(message.performanceInfo)
     }
 }

diff --git a/.../src/integrationTest/kotlin/io/embrace/android/embracesdk/features/PersonaFeaturesTest.kt b/.../src/integrationTest/kotlin/io/embrace/android/embracesdk/features/PersonaFeaturesTest.kt
@@ -2,6 +2,9 @@ package io.embrace.android.embracesdk.features
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.embrace.android.embracesdk.IntegrationTestRule
+import io.embrace.android.embracesdk.config.remote.OTelRemoteConfig
+import io.embrace.android.embracesdk.config.remote.RemoteConfig
+import io.embrace.android.embracesdk.fakes.fakeOTelBehavior
 import io.embrace.android.embracesdk.payload.SessionMessage
 import io.embrace.android.embracesdk.payload.UserInfo
 import io.embrace.android.embracesdk.recordSession
@@ -16,7 +19,11 @@ internal class PersonaFeaturesTest {
     @JvmField
     val testRule: IntegrationTestRule = IntegrationTestRule(
         harnessSupplier = {
-            IntegrationTestRule.newHarness(startImmediately = false)
+            IntegrationTestRule.Harness(startImmediately = false).apply {
+                overriddenConfigService.oTelBehavior = fakeOTelBehavior {
+                    RemoteConfig(oTelConfig = OTelRemoteConfig(isDevEnabled = true))
+                }
+            }
         }
     )
 
@@ -57,7 +64,8 @@ internal class PersonaFeaturesTest {
     private fun SessionMessage.assertPersonaDoesNotExist(persona: String) = assertPersona(false, this, persona)
 
     private fun assertPersona(exists: Boolean, session: SessionMessage, persona: String) {
-        assertEquals(exists, session.userInfo?.personas?.find { it == persona } != null)
+        val personas = checkNotNull(session.metadata).personas
+        assertEquals(exists, personas?.find { it == persona } != null)
         assertEquals(
             exists,
             testRule.harness.overriddenAndroidServicesModule.preferencesService.userPersonas?.find { it == persona } != null

diff --git a/...sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/features/UserFeaturesTest.kt b/...sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/features/UserFeaturesTest.kt
@@ -2,6 +2,9 @@ package io.embrace.android.embracesdk.features
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.embrace.android.embracesdk.IntegrationTestRule
+import io.embrace.android.embracesdk.config.remote.OTelRemoteConfig
+import io.embrace.android.embracesdk.config.remote.RemoteConfig
+import io.embrace.android.embracesdk.fakes.fakeOTelBehavior
 import io.embrace.android.embracesdk.payload.SessionMessage
 import io.embrace.android.embracesdk.prefs.PreferencesService
 import io.embrace.android.embracesdk.recordSession
@@ -17,7 +20,11 @@ internal class UserFeaturesTest {
     @JvmField
     val testRule: IntegrationTestRule = IntegrationTestRule(
         harnessSupplier = {
-            IntegrationTestRule.newHarness(startImmediately = false)
+            IntegrationTestRule.Harness(startImmediately = false).apply {
+                overriddenConfigService.oTelBehavior = fakeOTelBehavior {
+                    RemoteConfig(oTelConfig = OTelRemoteConfig(isDevEnabled = true))
+                }
+            }
         }
     )
 
@@ -56,11 +63,11 @@ internal class UserFeaturesTest {
     }
 
     private fun SessionMessage.assertUserInfo(preferencesService: PreferencesService, userId: String?, userName: String?, email: String?) {
-        assertEquals(userId, userInfo?.userId)
+        assertEquals(userId, checkNotNull(metadata).userId)
         assertEquals(userId, preferencesService.userIdentifier)
-        assertEquals(userName, userInfo?.username)
+        assertEquals(userName, metadata.username)
         assertEquals(userName, preferencesService.username)
-        assertEquals(email, userInfo?.email)
+        assertEquals(email, metadata.email)
         assertEquals(email, preferencesService.userEmailAddress)
     }
 }
diff --git a/...-android-sdk/src/main/java/io/embrace/android/embracesdk/gating/SessionSanitizerFacade.kt b/...-android-sdk/src/main/java/io/embrace/android/embracesdk/gating/SessionSanitizerFacade.kt
@@ -1,5 +1,6 @@
 package io.embrace.android.embracesdk.gating
 
+import io.embrace.android.embracesdk.internal.payload.EnvelopeMetadata
 import io.embrace.android.embracesdk.payload.SessionMessage
 
 internal class SessionSanitizerFacade(
@@ -9,15 +10,27 @@ internal class SessionSanitizerFacade(
 
     fun getSanitizedMessage(): SessionMessage {
         val sanitizedSession = SessionSanitizer(sessionMessage.session, components).sanitize()
-        val sanitizedUserInfo = UserInfoSanitizer(sessionMessage.userInfo, components).sanitize()
         val sanitizedPerformanceInfo = PerformanceInfoSanitizer(sessionMessage.performanceInfo, components).sanitize()
         val sanitizedSpans = SpanSanitizer(sessionMessage.spans, components).sanitize()
 
         return sessionMessage.copy(
             session = sanitizedSession,
-            userInfo = sanitizedUserInfo,
             performanceInfo = sanitizedPerformanceInfo,
-            spans = sanitizedSpans
+            spans = sanitizedSpans,
+            metadata = sanitizeMetadata(components)
         )
     }
+
+    private fun sanitizeMetadata(enabledComponents: Set<String>): EnvelopeMetadata {
+        if (sessionMessage.metadata == null) {
+            return EnvelopeMetadata()
+        }
+        if (!shouldSendUserPersonas(enabledComponents)) {
+            return sessionMessage.metadata.copy(personas = null)
+        }
+        return sessionMessage.metadata
+    }
+
+    private fun shouldSendUserPersonas(enabledComponents: Set<String>) =
+        enabledComponents.contains(SessionGatingKeys.USER_PERSONAS)
 }
diff --git a/embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/injection/SessionModule.kt b/embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/injection/SessionModule.kt
@@ -53,7 +53,6 @@ internal class SessionModuleImpl(
             dataContainerModule.performanceInfoService,
             dataCaptureServiceModule.webviewService,
             nativeModule.nativeThreadSamplerService,
-            essentialServiceModule.userService,
             androidServicesModule.preferencesService,
             openTelemetryModule.spanRepository,
             openTelemetryModule.spanSink,

diff --git a/embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/payload/SessionMessage.kt b/embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/payload/SessionMessage.kt
@@ -21,12 +21,6 @@ internal data class SessionMessage @JvmOverloads internal constructor(
     @Json(name = "s")
     val session: Session,
 
-    /**
-     * The user information.
-     */
-    @Json(name = "u")
-    val userInfo: UserInfo? = null,
-
     /**
      * The app information.
      */

diff --git a/...k/src/main/java/io/embrace/android/embracesdk/session/message/V1PayloadMessageCollator.kt b/...k/src/main/java/io/embrace/android/embracesdk/session/message/V1PayloadMessageCollator.kt
@@ -8,7 +8,6 @@ import io.embrace.android.embracesdk.capture.PerformanceInfoService
 import io.embrace.android.embracesdk.capture.internal.errors.InternalErrorService
 import io.embrace.android.embracesdk.capture.metadata.MetadataService
 import io.embrace.android.embracesdk.capture.startup.StartupService
-import io.embrace.android.embracesdk.capture.user.UserService
 import io.embrace.android.embracesdk.capture.webview.WebViewService
 import io.embrace.android.embracesdk.event.EventService
 import io.embrace.android.embracesdk.event.LogMessageService
@@ -35,7 +34,6 @@ internal class V1PayloadMessageCollator(
     private val performanceInfoService: PerformanceInfoService,
     private val webViewService: WebViewService,
     private val nativeThreadSamplerService: NativeThreadSamplerService?,
-    private val userService: UserService,
     private val preferencesService: PreferencesService,
     private val spanRepository: SpanRepository,
     private val spanSink: SpanSink,
@@ -178,7 +176,6 @@ internal class V1PayloadMessageCollator(
 
         return SessionMessage(
             session = finalPayload,
-            userInfo = captureDataSafely(logger, userService::getUserInfo),
             appInfo = captureDataSafely(logger, metadataService::getAppInfo),
             deviceInfo = captureDataSafely(logger, metadataService::getDeviceInfo),
             performanceInfo = captureDataSafely(logger) {

diff --git a/...roid-sdk/src/test/java/io/embrace/android/embracesdk/EmbraceGatingServiceV1PayloadTest.kt b/...roid-sdk/src/test/java/io/embrace/android/embracesdk/EmbraceGatingServiceV1PayloadTest.kt
@@ -32,6 +32,7 @@ import io.embrace.android.embracesdk.gating.SessionGatingKeys.SESSION_PROPERTIES
 import io.embrace.android.embracesdk.gating.SessionGatingKeys.SESSION_USER_TERMINATION
 import io.embrace.android.embracesdk.gating.SessionGatingKeys.STARTUP_MOMENT
 import io.embrace.android.embracesdk.gating.SessionGatingKeys.USER_PERSONAS
+import io.embrace.android.embracesdk.internal.payload.EnvelopeMetadata
 import io.embrace.android.embracesdk.internal.serialization.EmbraceSerializer
 import io.embrace.android.embracesdk.internal.utils.Uuid
 import io.embrace.android.embracesdk.logging.EmbLogger
@@ -357,18 +358,18 @@ internal class EmbraceGatingServiceV1PayloadTest {
 
     @Test
     fun `test gate user personas for Session`() {
-        val userInfo = UserInfo(personas = setOf("persona"))
-
         val sessionMessage = SessionMessage(
             session = fakeSession(),
-            userInfo = userInfo,
-            performanceInfo = PerformanceInfo()
+            metadata = EnvelopeMetadata(
+                personas = setOf("persona")
+            ),
+            performanceInfo = PerformanceInfo(),
         )
 
         cfg = buildCustomRemoteConfig(setOf(USER_PERSONAS), null)
 
         val sanitizedMessage = gatingService.gateSessionMessage(sessionMessage)
-        assertNotNull(sanitizedMessage.userInfo?.personas)
+        assertNotNull(sanitizedMessage.metadata?.personas)
     }
 
     @Test

diff --git a/embrace-android-sdk/src/test/java/io/embrace/android/embracesdk/FakeBackgroundActivity.kt b/embrace-android-sdk/src/test/java/io/embrace/android/embracesdk/FakeBackgroundActivity.kt
@@ -1,30 +1,31 @@
 package io.embrace.android.embracesdk
 
+import io.embrace.android.embracesdk.internal.payload.EnvelopeMetadata
 import io.embrace.android.embracesdk.internal.spans.EmbraceSpanData
 import io.embrace.android.embracesdk.payload.AppInfo
 import io.embrace.android.embracesdk.payload.DeviceInfo
 import io.embrace.android.embracesdk.payload.DiskUsage
 import io.embrace.android.embracesdk.payload.PerformanceInfo
 import io.embrace.android.embracesdk.payload.Session
 import io.embrace.android.embracesdk.payload.SessionMessage
-import io.embrace.android.embracesdk.payload.UserInfo
 import io.opentelemetry.api.trace.StatusCode
 
 internal fun fakeBackgroundActivityMessage(): SessionMessage {
     val backgroundActivity = fakeBackgroundActivity()
-    val userInfo = UserInfo("fake-user-id")
     val appInfo = AppInfo("fake-app-id")
     val deviceInfo = DeviceInfo("fake-manufacturer")
     val spans = listOf(EmbraceSpanData("fake-span-id", "", "", "", 0, 0, StatusCode.OK))
     val perfInfo = PerformanceInfo(DiskUsage(1, 2))
 
     return SessionMessage(
         backgroundActivity,
-        userInfo,
         appInfo,
         deviceInfo,
         perfInfo,
-        spans
+        spans,
+        metadata = EnvelopeMetadata(
+            userId = "fake-user-id"
+        )
     )
 }
 

diff --git a/...ace-android-sdk/src/test/java/io/embrace/android/embracesdk/SessionSanitizerFacadeTest.kt b/...ace-android-sdk/src/test/java/io/embrace/android/embracesdk/SessionSanitizerFacadeTest.kt
@@ -4,11 +4,11 @@ import io.embrace.android.embracesdk.fakes.fakePerformanceInfo
 import io.embrace.android.embracesdk.fakes.fakeSession
 import io.embrace.android.embracesdk.gating.SessionGatingKeys
 import io.embrace.android.embracesdk.gating.SessionSanitizerFacade
+import io.embrace.android.embracesdk.internal.payload.EnvelopeMetadata
 import io.embrace.android.embracesdk.payload.AppInfo
 import io.embrace.android.embracesdk.payload.DeviceInfo
 import io.embrace.android.embracesdk.payload.Orientation
 import io.embrace.android.embracesdk.payload.SessionMessage
-import io.embrace.android.embracesdk.payload.UserInfo
 import org.junit.Assert.assertNotNull
 import org.junit.Assert.assertNull
 import org.junit.Test
@@ -17,11 +17,6 @@ internal class SessionSanitizerFacadeTest {
 
     private val sessionPerformanceInfo = fakePerformanceInfo()
 
-    private val userInfo = UserInfo(
-        personas = setOf("personas"),
-        email = "example@embrace.com"
-    )
-
     private val session = fakeSession().copy(
         properties = mapOf("example" to "example"),
         orientations = listOf(Orientation(0, 0L)),
@@ -38,10 +33,13 @@ internal class SessionSanitizerFacadeTest {
 
     private val sessionMessage = SessionMessage(
         session = session,
-        userInfo = userInfo,
         appInfo = AppInfo(),
         deviceInfo = DeviceInfo(),
-        performanceInfo = sessionPerformanceInfo
+        performanceInfo = sessionPerformanceInfo,
+        metadata = EnvelopeMetadata(
+            email = "example@embrace.com",
+            personas = setOf("personas")
+        )
     )
 
     private val enabledComponents = setOf(
@@ -70,7 +68,7 @@ internal class SessionSanitizerFacadeTest {
         val sanitizedMessage =
             SessionSanitizerFacade(sessionMessage, enabledComponents).getSanitizedMessage()
 
-        assertNotNull(sanitizedMessage.userInfo?.personas)
+        assertNotNull(sanitizedMessage.metadata?.personas)
 
         assertNotNull(sanitizedMessage.session.properties)
         assertNotNull(sanitizedMessage.session.orientations)
@@ -96,7 +94,7 @@ internal class SessionSanitizerFacadeTest {
         val sanitizedMessage =
             SessionSanitizerFacade(sessionMessage, setOf()).getSanitizedMessage()
 
-        assertNull(sanitizedMessage.userInfo?.personas)
+        assertNull(sanitizedMessage.metadata?.personas)
 
         assertNull(sanitizedMessage.session.properties)
         assertNull(sanitizedMessage.session.orientations)

diff --git a/...-sdk/src/test/java/io/embrace/android/embracesdk/payload/BackgroundActivityMessageTest.kt b/...-sdk/src/test/java/io/embrace/android/embracesdk/payload/BackgroundActivityMessageTest.kt
@@ -14,15 +14,13 @@ import org.junit.Test
 internal class BackgroundActivityMessageTest {
 
     private val backgroundActivity = fakeBackgroundActivity()
-    private val userInfo = UserInfo("fake-user-id")
     private val appInfo = AppInfo("fake-app-id")
     private val deviceInfo = DeviceInfo("fake-manufacturer")
     private val spans = listOf(EmbraceSpanData("fake-span-id", "", "", "", 0, 0, StatusCode.OK))
     private val perfInfo = PerformanceInfo(DiskUsage(1, 2))
 
     private val info = SessionMessage(
         backgroundActivity,
-        userInfo,
         appInfo,
         deviceInfo,
         perfInfo,
@@ -40,7 +38,6 @@ internal class BackgroundActivityMessageTest {
         assertNotNull(obj)
 
         assertEquals(backgroundActivity.startTime, obj.session.startTime)
-        assertEquals(userInfo, obj.userInfo)
         assertEquals(appInfo, obj.appInfo)
         assertEquals(deviceInfo, obj.deviceInfo)
         assertEquals(perfInfo, obj.performanceInfo)

diff --git a/...ace-android-sdk/src/test/java/io/embrace/android/embracesdk/payload/SessionMessageTest.kt b/...ace-android-sdk/src/test/java/io/embrace/android/embracesdk/payload/SessionMessageTest.kt
@@ -19,7 +19,6 @@ import org.junit.Test
 internal class SessionMessageTest {
 
     private val session = fakeSession()
-    private val userInfo = UserInfo("fake-user-id", "fake-user-name")
     private val appInfo = AppInfo("fake-app-version")
     private val deviceInfo = DeviceInfo("fake-manufacturer")
     private val performanceInfo = PerformanceInfo(DiskUsage(150923409L, 509209823L))
@@ -40,7 +39,6 @@ internal class SessionMessageTest {
 
     private val info = SessionMessage(
         session,
-        userInfo,
         appInfo,
         deviceInfo,
         performanceInfo,
@@ -58,7 +56,6 @@ internal class SessionMessageTest {
         val obj = deserializeJsonFromResource<SessionMessage>("session_message_expected.json")
         assertNotNull(obj)
         assertEquals(session, obj.session)
-        assertEquals(userInfo, obj.userInfo)
         assertEquals(appInfo, obj.appInfo)
         assertEquals(deviceInfo, obj.deviceInfo)
         assertEquals(performanceInfo, obj.performanceInfo)

diff --git a/...e-android-sdk/src/test/java/io/embrace/android/embracesdk/session/PayloadFactoryBaTest.kt b/...e-android-sdk/src/test/java/io/embrace/android/embracesdk/session/PayloadFactoryBaTest.kt
@@ -166,7 +166,6 @@ internal class PayloadFactoryBaTest {
             performanceInfoService,
             FakeWebViewService(),
             null,
-            userService,
             preferencesService,
             spanRepository,
             spanSink,

diff --git a/...ace-android-sdk/src/test/java/io/embrace/android/embracesdk/session/SessionHandlerTest.kt b/...ace-android-sdk/src/test/java/io/embrace/android/embracesdk/session/SessionHandlerTest.kt
@@ -157,7 +157,6 @@ internal class SessionHandlerTest {
             performanceInfoService,
             webViewService,
             null,
-            userService,
             preferencesService,
             initModule.openTelemetryModule.spanRepository,
             initModule.openTelemetryModule.spanSink,

diff --git a/...d-sdk/src/test/java/io/embrace/android/embracesdk/session/V1PayloadMessageCollatorTest.kt b/...d-sdk/src/test/java/io/embrace/android/embracesdk/session/V1PayloadMessageCollatorTest.kt
@@ -12,7 +12,6 @@ import io.embrace.android.embracesdk.fakes.FakeMetadataService
 import io.embrace.android.embracesdk.fakes.FakePerformanceInfoService
 import io.embrace.android.embracesdk.fakes.FakePreferenceService
 import io.embrace.android.embracesdk.fakes.FakeStartupService
-import io.embrace.android.embracesdk.fakes.FakeUserService
 import io.embrace.android.embracesdk.fakes.FakeWebViewService
 import io.embrace.android.embracesdk.fakes.fakeCompletedAnrInterval
 import io.embrace.android.embracesdk.fakes.fakeInProgressAnrInterval
@@ -61,7 +60,6 @@ internal class V1PayloadMessageCollatorTest {
             gatingService = gatingService,
             nativeThreadSamplerService = null,
             webViewService = FakeWebViewService(),
-            userService = FakeUserService(),
             preferencesService = FakePreferenceService(),
             eventService = FakeEventService(),
             logMessageService = FakeLogMessageService(),
@@ -205,7 +203,6 @@ internal class V1PayloadMessageCollatorTest {
     private fun SessionMessage.verifyFinalFieldsPopulated(
         payloadType: PayloadType
     ) {
-        assertNotNull(userInfo)
         assertNotNull(appInfo)
         assertNotNull(deviceInfo)
         assertNotNull(performanceInfo)