simplified

Author: Shahroz16

location/src/main/kotlin/io/customer/location/LocationTracker.kt

@@ -9,14 +9,24 @@ import io.customer.sdk.util.EventNames
 
 /**
  * Coordinates all location state management: persistence, restoration,
- * profile enrichment, and sending location track events.
+ * identify context enrichment, and sending location track events.
  *
- * Implements [IdentifyContextProvider] to enrich identify event context
- * with the latest location. Sends location track events directly via
- * [DataPipeline], applying the userId gate and sync filter locally.
+ * Location reaches the backend through two independent paths:
  *
- * Tracks the last known userId to detect profile switches and reset
- * the sync filter accordingly.
+ * 1. **Identify context enrichment** — implements [IdentifyContextProvider].
+ *    Every identify() call enriches the event context with the latest
+ *    location coordinates. This is unfiltered — a new user always gets
+ *    the device's current location on their profile immediately.
+ *
+ * 2. **"Location Update" track event** — sent via [DataPipeline.track].
+ *    Gated by a userId check and a sync filter (24h / 1km threshold)
+ *    to avoid redundant events. This creates a discrete event in the
+ *    user's activity timeline for journey/segment triggers.
+ *
+ * Profile switch handling is intentionally not tracked here.
+ * On clearIdentify(), [onReset] clears all state (cache, persistence,
+ * sync filter). On identify(), the new user's profile receives the
+ * location via path 1 regardless of the sync filter's state.
  */
 internal class LocationTracker(
     private val dataPipeline: DataPipeline?,
@@ -28,9 +38,6 @@ internal class LocationTracker(
     @Volatile
     private var lastLocation: LocationCoordinates? = null
 
-    @Volatile
-    private var lastKnownUserId: String? = null
-
     override fun getIdentifyContext(): Map<String, Any> {
         val location = lastLocation ?: return emptyMap()
         return mapOf(
@@ -65,41 +72,35 @@ internal class LocationTracker(
     }
 
     /**
-     * Called when the user identity changes (identify or clearIdentify).
-     * Detects profile switches to reset the sync filter, then attempts
-     * to sync the cached location for the new user.
+     * Called when a user is identified. Attempts to sync the cached
+     * location as a track event for the newly identified user.
+     *
+     * The identify event itself already carries location via
+     * [getIdentifyContext] — this method handles the supplementary
+     * "Location Update" track event, subject to the sync filter.
      */
-    fun onUserChanged(userId: String?, anonymousId: String) {
-        val previousUserId = lastKnownUserId
-        lastKnownUserId = userId
-
-        // Detect profile switch: previous user existed and differs from new user
-        if (previousUserId != null && previousUserId != userId) {
-            logger.debug("Profile switch detected ($previousUserId -> $userId), clearing sync filter")
-            locationSyncFilter.clearSyncedData()
-        }
-
-        if (!userId.isNullOrEmpty()) {
-            syncCachedLocationIfNeeded()
-        }
+    fun onUserIdentified() {
+        syncCachedLocationIfNeeded()
     }
 
     /**
      * Clears all location state on identity reset (clearIdentify).
-     * Resets in-memory cache, persisted location, and sync filter.
+     * Resets in-memory cache, persisted location, and sync filter —
+     * similar to how device tokens and other per-user state are
+     * cleared on reset.
      */
     fun onReset() {
         lastLocation = null
-        lastKnownUserId = null
         locationPreferenceStore.clearCachedLocation()
         locationSyncFilter.clearSyncedData()
         logger.debug("Location state reset")
     }
 
     /**
      * Re-evaluates the cached location for sending.
-     * Called on identify (via [onUserChanged]) and on cold start to handle
-     * cases where a location was cached but not yet sent for the current user.
+     * Called on identify (via [onUserIdentified]) and on cold start
+     * (via replayed UserChangedEvent) to handle cases where a location
+     * was cached but not yet sent for the current user.
      */
     internal fun syncCachedLocationIfNeeded() {
         val lat = locationPreferenceStore.getCachedLatitude() ?: return

location/src/main/kotlin/io/customer/location/ModuleLocation.kt

@@ -77,15 +77,22 @@ class ModuleLocation @JvmOverloads constructor(
 
         locationTracker.restorePersistedLocation()
 
-        // Register as IdentifyContextProvider so location is added to identify event context
+        // Register as IdentifyContextProvider so location is added to identify event context.
+        // This ensures every identify() call carries the device's current location
+        // in the event context — the primary way location reaches a user's profile.
         SDKComponent.identifyContextRegistry.register(locationTracker)
 
         eventBus.subscribe<Event.ResetEvent> {
             locationTracker.onReset()
         }
 
+        // On identify, attempt to send a supplementary "Location Update" track event.
+        // The identify event itself already carries location via context enrichment —
+        // this track event is for journey/segment triggers in the user's timeline.
         eventBus.subscribe<Event.UserChangedEvent> {
-            locationTracker.onUserChanged(it.userId, it.anonymousId)
+            if (!it.userId.isNullOrEmpty()) {
+                locationTracker.onUserIdentified()
+            }
         }
 
         val locationProvider = FusedLocationProvider(context)

location/src/test/java/io/customer/location/LocationTrackerTest.kt

@@ -52,7 +52,7 @@ class LocationTrackerTest {
     }
 
     @Test
-    fun givenLocationReceived_noUserIdentified_expectTrackNotCalled() {
+    fun givenLocationReceived_noUserId_expectTrackNotCalled() {
         every { dataPipeline.isUserIdentified } returns false
 
         tracker.onLocationReceived(37.7749, -122.4194)
@@ -167,47 +167,14 @@ class LocationTrackerTest {
         context["location_longitude"] shouldBeEqualTo -122.4194
     }
 
-    // -- onUserChanged --
+    // -- onUserIdentified --
 
     @Test
-    fun givenProfileSwitch_expectClearsSyncFilter() {
-        every { store.getCachedLatitude() } returns null
-
-        // First call sets lastKnownUserId
-        tracker.onUserChanged("user-a", "anon-1")
-
-        // Switch to different user
-        tracker.onUserChanged("user-b", "anon-1")
-
-        verify { syncFilter.clearSyncedData() }
-    }
-
-    @Test
-    fun givenFirstIdentify_expectNoClearSyncFilter() {
-        every { store.getCachedLatitude() } returns null
-
-        tracker.onUserChanged("user-a", "anon-1")
-
-        // First identify should not clear (no previous user)
-        verify(exactly = 0) { syncFilter.clearSyncedData() }
-    }
-
-    @Test
-    fun givenSameUserIdentify_expectNoClearSyncFilter() {
-        every { store.getCachedLatitude() } returns null
-
-        tracker.onUserChanged("user-a", "anon-1")
-        tracker.onUserChanged("user-a", "anon-1")
-
-        verify(exactly = 0) { syncFilter.clearSyncedData() }
-    }
-
-    @Test
-    fun givenUserChangedWithUserId_expectSyncsCachedLocation() {
+    fun givenUserIdentified_withCachedLocation_expectSyncsCachedLocation() {
         every { store.getCachedLatitude() } returns 37.7749
         every { store.getCachedLongitude() } returns -122.4194
 
-        tracker.onUserChanged("user-a", "anon-1")
+        tracker.onUserIdentified()
 
         verify {
             dataPipeline.track(
@@ -218,32 +185,31 @@ class LocationTrackerTest {
     }
 
     @Test
-    fun givenUserChangedWithUserId_expectSyncFilterConsulted() {
+    fun givenUserIdentified_withCachedLocation_expectSyncFilterConsulted() {
         every { store.getCachedLatitude() } returns 37.7749
         every { store.getCachedLongitude() } returns -122.4194
 
-        tracker.onUserChanged("user-a", "anon-1")
+        tracker.onUserIdentified()
 
         verify { syncFilter.filterAndRecord(37.7749, -122.4194) }
     }
 
     @Test
-    fun givenUserChangedWithUserId_filterRejects_expectNoTrack() {
+    fun givenUserIdentified_filterRejects_expectNoTrack() {
         every { store.getCachedLatitude() } returns 37.7749
         every { store.getCachedLongitude() } returns -122.4194
         every { syncFilter.filterAndRecord(any(), any()) } returns false
 
-        tracker.onUserChanged("user-a", "anon-1")
+        tracker.onUserIdentified()
 
         verify(exactly = 0) { dataPipeline.track(any(), any()) }
     }
 
     @Test
-    fun givenUserChangedWithNullUserId_expectNoSync() {
-        every { store.getCachedLatitude() } returns 37.7749
-        every { store.getCachedLongitude() } returns -122.4194
+    fun givenUserIdentified_noCachedLocation_expectNoTrack() {
+        every { store.getCachedLatitude() } returns null
 
-        tracker.onUserChanged(null, "anon-1")
+        tracker.onUserIdentified()
 
         verify(exactly = 0) { dataPipeline.track(any(), any()) }
     }