Updated code for deep links should have context:referrer like Swift sdk

neelkanth-kaushik · neelkanth-kaushik · commit 30e3a685ba31 · 2025-06-27T11:48:28.000+05:30
diff --git a/android/src/main/java/com/segment/analytics/kotlin/android/utilities/DeepLinkUtils.kt b/android/src/main/java/com/segment/analytics/kotlin/android/utilities/DeepLinkUtils.kt
@@ -15,6 +15,7 @@ class DeepLinkUtils(val analytics: Analytics) {
             return
         }
 
+        analytics.updateReferrer(intent.data.toString())
         val properties = extractLinkProperties(referrer, intent.data)
         analytics.track("Deep Link Opened", properties)
     }
diff --git a/android/src/test/java/com/segment/analytics/kotlin/android/StorageTests.kt b/android/src/test/java/com/segment/analytics/kotlin/android/StorageTests.kt
@@ -55,7 +55,8 @@ class StorageTests {
                 UserInfo(
                     anonymousId = "oldAnonId",
                     userId = "oldUserId",
-                    traits = buildJsonObject { put("behaviour", "bad") }
+                    traits = buildJsonObject { put("behaviour", "bad") },
+                    referrer = "oldReferrer",
                 ))
 
             store.provide(
@@ -85,7 +86,8 @@ class StorageTests {
                     return UserInfo(
                         anonymousId = "newAnonId",
                         userId = "newUserId",
-                        traits = emptyJsonObject
+                        traits = emptyJsonObject,
+                        referrer = "newReferrer"
                     )
                 }
             }
diff --git a/core/src/main/java/com/segment/analytics/kotlin/core/Analytics.kt b/core/src/main/java/com/segment/analytics/kotlin/core/Analytics.kt
@@ -580,7 +580,7 @@ open class Analytics protected constructor(
      */
     fun reset() {
         val newAnonymousId = UUID.randomUUID().toString()
-        userInfo = UserInfo(newAnonymousId, null, null)
+        userInfo = UserInfo(newAnonymousId, null, null, null)
 
         analyticsScope.launch(analyticsDispatcher) {
             store.dispatch(UserInfo.ResetAction(newAnonymousId), UserInfo::class)
@@ -740,6 +740,16 @@ open class Analytics protected constructor(
             catch (ignored: Exception) {}
         }
     }
+
+    fun updateReferrer(referrerUrl: String?) {
+        userInfo.referrer = referrerUrl
+        analyticsScope.launch {
+            store.dispatch(
+                UserInfo.SetReferrerAction(referrerUrl),
+                UserInfo::class
+            )
+        }
+    }
 }
 
 
diff --git a/core/src/main/java/com/segment/analytics/kotlin/core/State.kt b/core/src/main/java/com/segment/analytics/kotlin/core/State.kt
@@ -7,7 +7,7 @@ import kotlinx.serialization.json.buildJsonObject
 import kotlinx.serialization.json.put
 import sovran.kotlin.Action
 import sovran.kotlin.State
-import java.util.*
+import java.util.UUID
 
 /**
  * Stores state related to the analytics system
@@ -143,11 +143,13 @@ data class System(
  * - anonymousId (String)
  * - userId (String)
  * - traits (Map)
+ * - referrer (String)
  */
 data class UserInfo(
     var anonymousId: String,
     var userId: String?,
-    var traits: JsonObject?
+    var traits: JsonObject?,
+    var referrer: String?,
 ) : State {
 
     companion object {
@@ -160,25 +162,33 @@ data class UserInfo(
             val anonymousId: String =
                 storage.read(Storage.Constants.AnonymousId) ?: UUID.randomUUID().toString()
 
-            return UserInfo(anonymousId, userId, traits)
+            return UserInfo(anonymousId, userId, traits, null)
         }
     }
 
     class ResetAction(var anonymousId: String = UUID.randomUUID().toString()) : Action<UserInfo> {
         override fun reduce(state: UserInfo): UserInfo {
-            return UserInfo(anonymousId, null, null)
+            return UserInfo(anonymousId, null, null, null)
         }
     }
 
     class SetUserIdAction(var userId: String) : Action<UserInfo> {
         override fun reduce(state: UserInfo): UserInfo {
-            return UserInfo(state.anonymousId, userId, state.traits)
+            return state.copy(
+                userId = userId
+            )
         }
     }
 
     class SetAnonymousIdAction(var anonymousId: String) : Action<UserInfo> {
         override fun reduce(state: UserInfo): UserInfo {
-            return UserInfo(anonymousId, state.userId, state.traits)
+            return state.copy(anonymousId = anonymousId)
+        }
+    }
+
+    class SetReferrerAction(var referrer: String?) : Action<UserInfo> {
+        override fun reduce(state: UserInfo): UserInfo {
+            return state.copy(referrer = referrer)
         }
     }
 
@@ -190,7 +200,10 @@ data class UserInfo(
 
     class SetUserIdAndTraitsAction(var userId: String, var traits: JsonObject) : Action<UserInfo> {
         override fun reduce(state: UserInfo): UserInfo {
-            return UserInfo(state.anonymousId, userId, traits)
+            return state.copy(
+                userId = userId,
+                traits = traits
+            )
         }
     }
 }
diff --git a/core/src/main/java/com/segment/analytics/kotlin/core/platform/plugins/ContextPlugin.kt b/core/src/main/java/com/segment/analytics/kotlin/core/platform/plugins/ContextPlugin.kt
@@ -8,7 +8,7 @@ import com.segment.analytics.kotlin.core.utilities.putAll
 import kotlinx.serialization.json.JsonObject
 import kotlinx.serialization.json.buildJsonObject
 import kotlinx.serialization.json.put
-import java.util.*
+import java.util.UUID
 
 /**
  * Analytics plugin used to populate events with basic context data.
@@ -27,6 +27,8 @@ class ContextPlugin : Plugin {
         const val LIBRARY_NAME_KEY = "name"
         const val LIBRARY_VERSION_KEY = "version"
         const val INSTANCE_ID_KEY = "instanceId"
+        const val REFERRER_KEY = "referrer"
+        const val URL_KEY = "url"
     }
 
     override fun setup(analytics: Analytics) {
@@ -45,6 +47,13 @@ class ContextPlugin : Plugin {
             // putLibrary
             put(LIBRARY_KEY, library)
             put(INSTANCE_ID_KEY, instanceId)
+
+            // add additional context data
+            analytics.userInfo.referrer?.let {  referrer ->
+                put(REFERRER_KEY, buildJsonObject {
+                    put(URL_KEY, referrer)
+                })
+            }
         }
         event.context = newContext
     }
diff --git a/core/src/test/kotlin/com/segment/analytics/kotlin/core/AnalyticsTests.kt b/core/src/test/kotlin/com/segment/analytics/kotlin/core/AnalyticsTests.kt
@@ -472,8 +472,8 @@ class AnalyticsTests {
                     UserInfo(
                         userId = "oldUserId",
                         traits = buildJsonObject { put("behaviour", "bad") },
-                        anonymousId = "qwerty-qwerty-123"
-                    ), curUserInfo
+                        anonymousId = "qwerty-qwerty-123",
+                        referrer = null), curUserInfo
                 )
 
                 analytics.identify("newUserId", buildJsonObject { put("behaviour", "good") })
@@ -483,7 +483,8 @@ class AnalyticsTests {
                     UserInfo(
                         userId = "newUserId",
                         traits = buildJsonObject { put("behaviour", "good") },
-                        anonymousId = "qwerty-qwerty-123"
+                        anonymousId = "qwerty-qwerty-123",
+                        referrer = null
                     ), newUserInfo
                 )
             }
@@ -501,7 +502,8 @@ class AnalyticsTests {
                     UserInfo(
                         userId = "oldUserId",
                         traits = buildJsonObject { put("behaviour", "bad") },
-                        anonymousId = "qwerty-qwerty-123"
+                        anonymousId = "qwerty-qwerty-123",
+                        referrer = null
                     ), curUserInfo
                 )
 
@@ -512,7 +514,8 @@ class AnalyticsTests {
                     UserInfo(
                         userId = "oldUserId",
                         traits = buildJsonObject { put("behaviour", "good") },
-                        anonymousId = "qwerty-qwerty-123"
+                        anonymousId = "qwerty-qwerty-123",
+                        referrer = null
                     ), newUserInfo
                 )
             }
@@ -782,7 +785,8 @@ class AnalyticsTests {
                     UserInfo(
                         userId = "newId",
                         traits = emptyJsonObject,
-                        anonymousId = "qwerty-qwerty-123"
+                        anonymousId = "qwerty-qwerty-123",
+                        referrer = null
                     ), newUserInfo
                 )
             }
@@ -890,6 +894,25 @@ class AnalyticsTests {
         }
     }
 
+    @Nested
+    inner class Referrer {
+        @Test
+        fun `updateReferrer non-null update`() = runTest {
+            analytics.updateReferrer("https://example.com")
+            val newUserInfo = analytics.store.currentState(UserInfo::class)
+            assertEquals(analytics.userInfo.referrer, "https://example.com")
+            assertEquals(newUserInfo?.referrer, "https://example.com")
+        }
+
+        @Test
+        fun `updateReferrer null update`() = runTest {
+            analytics.updateReferrer(null)
+            val newUserInfo = analytics.store.currentState(UserInfo::class)
+            assertEquals(analytics.userInfo.referrer, null)
+            assertEquals(newUserInfo?.referrer, null)
+        }
+    }
+    
     @Test
     fun `settings fetches current Analytics Settings`() = runTest {
         val settings = Settings(
diff --git a/core/src/test/kotlin/com/segment/analytics/kotlin/core/StateTest.kt b/core/src/test/kotlin/com/segment/analytics/kotlin/core/StateTest.kt
@@ -99,4 +99,25 @@ internal class StateTest {
             assertEquals(traits, (analytics.store.currentState(UserInfo::class))?.traits)
         }
     }
+    
+        @Test
+        fun setReferrerAction() = runTest  {
+            analytics.store.dispatch(UserInfo.SetReferrerAction("oldReferrer"), UserInfo::class)
+            assertEquals("oldReferrer", (analytics.store.currentState(UserInfo::class))?.referrer)
+
+            analytics.store.dispatch(UserInfo.SetReferrerAction("newReferrer"), UserInfo::class)
+            assertEquals("newReferrer", (analytics.store.currentState(UserInfo::class))?.referrer)
+        }
+
+
+        @Test
+        fun `setReferrerAction state change`() = runTest  {
+            val traits = buildJsonObject { put("behaviour", "bad") }
+            analytics.store.dispatch(UserInfo.SetReferrerAction("newReferrer"), UserInfo::class)
+            analytics.store.dispatch(UserInfo.SetUserIdAction("oldUserId"), UserInfo::class)
+            analytics.store.dispatch(UserInfo.SetAnonymousIdAction("anonymous"), UserInfo::class)
+            analytics.store.dispatch(UserInfo.SetTraitsAction(traits), UserInfo::class)
+
+            assertEquals("newReferrer", (analytics.store.currentState(UserInfo::class))?.referrer)
+        }
 }
diff --git a/core/src/test/kotlin/com/segment/analytics/kotlin/core/utilities/InMemoryStorageTest.kt b/core/src/test/kotlin/com/segment/analytics/kotlin/core/utilities/InMemoryStorageTest.kt
@@ -61,7 +61,8 @@ internal class InMemoryStorageTest {
                 return UserInfo(
                     anonymousId = "newAnonId",
                     userId = "newUserId",
-                    traits = emptyJsonObject
+                    traits = emptyJsonObject,
+                    referrer = "newReferrer"
                 )
             }
         }
@@ -294,7 +295,8 @@ internal class InMemoryStorageTest {
                     return UserInfo(
                         anonymousId = "newAnonId",
                         userId = "newUserId",
-                        traits = emptyJsonObject
+                        traits = emptyJsonObject,
+                        referrer = "newReferrer"
                     )
                 }
             }
diff --git a/core/src/test/kotlin/com/segment/analytics/kotlin/core/utilities/StorageImplTest.kt b/core/src/test/kotlin/com/segment/analytics/kotlin/core/utilities/StorageImplTest.kt
@@ -48,7 +48,8 @@ internal class StorageImplTest {
             UserInfo(
                 anonymousId = "oldAnonId",
                 userId = "oldUserId",
-                traits = buildJsonObject { put("behaviour", "bad") }
+                traits = buildJsonObject { put("behaviour", "bad") },
+                referrer = "oldReferrer"
             ))
 
         store.provide(
@@ -86,7 +87,8 @@ internal class StorageImplTest {
                 return UserInfo(
                     anonymousId = "newAnonId",
                     userId = "newUserId",
-                    traits = emptyJsonObject
+                    traits = emptyJsonObject,
+                    referrer = "newReferrer"
                 )
             }
         }
@@ -341,7 +343,8 @@ internal class StorageImplTest {
                     return UserInfo(
                         anonymousId = "newAnonId",
                         userId = "newUserId",
-                        traits = emptyJsonObject
+                        traits = emptyJsonObject,
+                        referrer = "newReferrer"
                     )
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ class DeepLinkUtils(val analytics: Analytics) {`
`15`	`15`	`return`
`16`	`16`	`}`
`17`	`17`
	`18`	`+ analytics.updateReferrer(intent.data.toString())`
`18`	`19`	`val properties = extractLinkProperties(referrer, intent.data)`
`19`	`20`	`analytics.track("Deep Link Opened", properties)`
`20`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,8 @@ class StorageTests {`
`55`	`55`	`UserInfo(`
`56`	`56`	`anonymousId = "oldAnonId",`
`57`	`57`	`userId = "oldUserId",`
`58`		`- traits = buildJsonObject { put("behaviour", "bad") }`
	`58`	`+ traits = buildJsonObject { put("behaviour", "bad") },`
	`59`	`+ referrer = "oldReferrer",`
`59`	`60`	`))`
`60`	`61`
`61`	`62`	`store.provide(`
`@@ -85,7 +86,8 @@ class StorageTests {`
`85`	`86`	`return UserInfo(`
`86`	`87`	`anonymousId = "newAnonId",`
`87`	`88`	`userId = "newUserId",`
`88`		`- traits = emptyJsonObject`
	`89`	`+ traits = emptyJsonObject,`
	`90`	`+ referrer = "newReferrer"`
`89`	`91`	`)`
`90`	`92`	`}`
`91`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,8 @@ internal class InMemoryStorageTest {`
`61`	`61`	`return UserInfo(`
`62`	`62`	`anonymousId = "newAnonId",`
`63`	`63`	`userId = "newUserId",`
`64`		`- traits = emptyJsonObject`
	`64`	`+ traits = emptyJsonObject,`
	`65`	`+ referrer = "newReferrer"`
`65`	`66`	`)`
`66`	`67`	`}`
`67`	`68`	`}`
`@@ -294,7 +295,8 @@ internal class InMemoryStorageTest {`
`294`	`295`	`return UserInfo(`
`295`	`296`	`anonymousId = "newAnonId",`
`296`	`297`	`userId = "newUserId",`
`297`		`- traits = emptyJsonObject`
	`298`	`+ traits = emptyJsonObject,`
	`299`	`+ referrer = "newReferrer"`
`298`	`300`	`)`
`299`	`301`	`}`
`300`	`302`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,8 @@ internal class StorageImplTest {`
`48`	`48`	`UserInfo(`
`49`	`49`	`anonymousId = "oldAnonId",`
`50`	`50`	`userId = "oldUserId",`
`51`		`- traits = buildJsonObject { put("behaviour", "bad") }`
	`51`	`+ traits = buildJsonObject { put("behaviour", "bad") },`
	`52`	`+ referrer = "oldReferrer"`
`52`	`53`	`))`
`53`	`54`
`54`	`55`	`store.provide(`
`@@ -86,7 +87,8 @@ internal class StorageImplTest {`
`86`	`87`	`return UserInfo(`
`87`	`88`	`anonymousId = "newAnonId",`
`88`	`89`	`userId = "newUserId",`
`89`		`- traits = emptyJsonObject`
	`90`	`+ traits = emptyJsonObject,`
	`91`	`+ referrer = "newReferrer"`
`90`	`92`	`)`
`91`	`93`	`}`
`92`	`94`	`}`
`@@ -341,7 +343,8 @@ internal class StorageImplTest {`
`341`	`343`	`return UserInfo(`
`342`	`344`	`anonymousId = "newAnonId",`
`343`	`345`	`userId = "newUserId",`
`344`		`- traits = emptyJsonObject`
	`346`	`+ traits = emptyJsonObject,`
	`347`	`+ referrer = "newReferrer"`
`345`	`348`	`)`
`346`	`349`	`}`
`347`	`350`	`}`