shift files

Author: Shahroz16

core/api/core.api

@@ -29,6 +29,17 @@ public final class io/customer/sdk/communication/Event$LocationData {
 	public fun toString ()Ljava/lang/String;
 }
 
+public final class io/customer/sdk/communication/Event$LocationTrackedEvent : io/customer/sdk/communication/Event {
+	public fun <init> (Lio/customer/sdk/communication/Event$LocationData;)V
+	public final fun component1 ()Lio/customer/sdk/communication/Event$LocationData;
+	public final fun copy (Lio/customer/sdk/communication/Event$LocationData;)Lio/customer/sdk/communication/Event$LocationTrackedEvent;
+	public static synthetic fun copy$default (Lio/customer/sdk/communication/Event$LocationTrackedEvent;Lio/customer/sdk/communication/Event$LocationData;ILjava/lang/Object;)Lio/customer/sdk/communication/Event$LocationTrackedEvent;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getLocation ()Lio/customer/sdk/communication/Event$LocationData;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
 public final class io/customer/sdk/communication/Event$RegisterDeviceTokenEvent : io/customer/sdk/communication/Event {
 	public fun <init> (Ljava/lang/String;)V
 	public final fun component1 ()Ljava/lang/String;
@@ -128,6 +139,11 @@ public final class io/customer/sdk/communication/EventBusImpl : io/customer/sdk/
 	public fun subscribe (Lkotlin/reflect/KClass;Lkotlin/jvm/functions/Function2;)Lkotlinx/coroutines/Job;
 }
 
+public abstract interface class io/customer/sdk/communication/LocationCache {
+	public abstract fun getLastLocation ()Lio/customer/sdk/communication/Event$LocationData;
+	public abstract fun setLastLocation (Lio/customer/sdk/communication/Event$LocationData;)V
+}
+
 public final class io/customer/sdk/core/BuildConfig {
 	public static final field BUILD_TYPE Ljava/lang/String;
 	public static final field DEBUG Z

core/src/main/kotlin/io/customer/sdk/communication/Event.kt

@@ -61,6 +61,10 @@ sealed class Event {
         val location: LocationData
     ) : Event()
 
+    data class LocationTrackedEvent(
+        val location: LocationData
+    ) : Event()
+
     /**
      * Location data in a framework-agnostic format.
      * Used to pass location information between modules without

core/src/main/kotlin/io/customer/sdk/communication/LocationCache.kt

@@ -0,0 +1,5 @@
+package io.customer.sdk.communication
+
+interface LocationCache {
+    var lastLocation: Event.LocationData?
+}

datapipelines/src/main/kotlin/io/customer/datapipelines/di/SDKComponentExt.kt

@@ -2,8 +2,6 @@ package io.customer.datapipelines.di
 
 import com.segment.analytics.kotlin.core.Analytics
 import io.customer.datapipelines.config.DataPipelinesModuleConfig
-import io.customer.datapipelines.store.LocationPreferenceStore
-import io.customer.datapipelines.store.LocationPreferenceStoreImpl
 import io.customer.sdk.DataPipelinesLogger
 import io.customer.sdk.core.di.SDKComponent
 import io.customer.sdk.core.extensions.getOrNull
@@ -14,8 +12,3 @@ internal val SDKComponent.analyticsFactory: ((moduleConfig: DataPipelinesModuleC
 
 internal val SDKComponent.dataPipelinesLogger: DataPipelinesLogger
     get() = singleton<DataPipelinesLogger> { DataPipelinesLogger(logger) }
-
-internal val SDKComponent.locationPreferenceStore: LocationPreferenceStore
-    get() = singleton<LocationPreferenceStore> {
-        LocationPreferenceStoreImpl(android().applicationContext, logger)
-    }

datapipelines/src/main/kotlin/io/customer/datapipelines/plugins/LocationPlugin.kt

@@ -7,19 +7,20 @@ import com.segment.analytics.kotlin.core.platform.EventPlugin
 import com.segment.analytics.kotlin.core.platform.Plugin
 import com.segment.analytics.kotlin.core.utilities.putInContext
 import io.customer.sdk.communication.Event
+import io.customer.sdk.communication.LocationCache
 import io.customer.sdk.core.util.Logger
 import kotlinx.serialization.json.JsonPrimitive
 
 /**
  * Plugin that enriches identify events with the last known location in context,
  * so Customer.io knows where the user is when their profile is identified.
  */
-internal class LocationPlugin(private val logger: Logger) : EventPlugin {
+internal class LocationPlugin(private val logger: Logger) : EventPlugin, LocationCache {
     override val type: Plugin.Type = Plugin.Type.Enrichment
     override lateinit var analytics: Analytics
 
     @Volatile
-    internal var lastLocation: Event.LocationData? = null
+    override var lastLocation: Event.LocationData? = null
 
     override fun identify(payload: IdentifyEvent): BaseEvent {
         val location = lastLocation ?: return payload

datapipelines/src/main/kotlin/io/customer/sdk/CustomerIO.kt

@@ -14,12 +14,10 @@ import io.customer.base.internal.InternalCustomerIOApi
 import io.customer.datapipelines.config.DataPipelinesModuleConfig
 import io.customer.datapipelines.di.analyticsFactory
 import io.customer.datapipelines.di.dataPipelinesLogger
-import io.customer.datapipelines.di.locationPreferenceStore
 import io.customer.datapipelines.extensions.asMap
 import io.customer.datapipelines.extensions.sanitizeForJson
 import io.customer.datapipelines.extensions.type
 import io.customer.datapipelines.extensions.updateAnalyticsConfig
-import io.customer.datapipelines.location.LocationTracker
 import io.customer.datapipelines.migration.TrackingMigrationProcessor
 import io.customer.datapipelines.plugins.ApplicationLifecyclePlugin
 import io.customer.datapipelines.plugins.AutoTrackDeviceAttributesPlugin
@@ -30,6 +28,7 @@ import io.customer.datapipelines.plugins.CustomerIODestination
 import io.customer.datapipelines.plugins.LocationPlugin
 import io.customer.datapipelines.plugins.ScreenFilterPlugin
 import io.customer.sdk.communication.Event
+import io.customer.sdk.communication.LocationCache
 import io.customer.sdk.communication.subscribe
 import io.customer.sdk.core.di.AndroidSDKComponent
 import io.customer.sdk.core.di.SDKComponent
@@ -111,7 +110,6 @@ class CustomerIO private constructor(
 
     private val contextPlugin: ContextPlugin = ContextPlugin(deviceStore)
     private val locationPlugin: LocationPlugin = LocationPlugin(logger)
-    private val locationTracker: LocationTracker = LocationTracker(locationPlugin, SDKComponent.locationPreferenceStore, logger) { analytics.userId() }
 
     init {
         // Set analytics logger and debug logs based on SDK logger configuration
@@ -135,8 +133,8 @@ class CustomerIO private constructor(
         analytics.add(locationPlugin)
         analytics.add(ApplicationLifecyclePlugin())
 
-        // Restore persisted location so identify events have context immediately
-        locationTracker.restorePersistedLocation()
+        // Register LocationPlugin as LocationCache so the location module can update it
+        SDKComponent.registerDependency<LocationCache> { locationPlugin }
 
         // subscribe to journey events emitted from push/in-app module to send them via data pipelines
         subscribeToJourneyEvents()
@@ -161,10 +159,10 @@ class CustomerIO private constructor(
             registerDeviceToken(deviceToken = it.token)
         }
         eventBus.subscribe<Event.TrackLocationEvent> {
-            locationTracker.onLocationReceived(it)?.let { location ->
-                sendLocationTrack(location)
-                locationTracker.confirmSync(location.latitude, location.longitude)
-            }
+            val userId = analytics.userId()
+            if (userId.isNullOrEmpty()) return@subscribe
+            sendLocationTrack(it.location)
+            eventBus.publish(Event.LocationTrackedEvent(location = it.location))
         }
     }
 
@@ -213,12 +211,6 @@ class CustomerIO private constructor(
         if (moduleConfig.trackApplicationLifecycleEvents) {
             analytics.add(AutomaticApplicationLifecycleTrackingPlugin())
         }
-
-        // Re-evaluate cached location on cold start (e.g. >24h + >1km since last sync)
-        locationTracker.syncCachedLocationIfNeeded()?.let { location ->
-            sendLocationTrack(location)
-            locationTracker.confirmSync(location.latitude, location.longitude)
-        }
     }
 
     @Deprecated("Use setProfileAttributes() function instead")
@@ -274,20 +266,15 @@ class CustomerIO private constructor(
 
         logger.info("identify profile with identifier $userId and traits $traits")
 
-        // publish event to EventBus for other modules to consume
-        eventBus.publish(Event.UserChangedEvent(userId = userId, anonymousId = analytics.anonymousId()))
         analytics.identify(
             userId = userId,
             traits = traits,
             serializationStrategy = serializationStrategy
         )
-
-        // Re-evaluate cached location now that the user is identified.
-        // Must come after analytics.identify() so userIdProvider returns the correct userId.
-        locationTracker.syncCachedLocationIfNeeded()?.let { location ->
-            sendLocationTrack(location)
-            locationTracker.confirmSync(location.latitude, location.longitude)
-        }
+        // publish event to EventBus for other modules to consume
+        // Must come after analytics.identify() so that analytics.userId() returns the
+        // new userId when downstream subscribers (e.g. location resync) gate on it.
+        eventBus.publish(Event.UserChangedEvent(userId = userId, anonymousId = analytics.anonymousId()))
 
         if (isFirstTimeIdentifying || isChangingIdentifiedProfile) {
             logger.debug("first time identified or changing identified profile")
@@ -337,7 +324,6 @@ class CustomerIO private constructor(
         }
 
         logger.debug("resetting user profile")
-        locationTracker.onUserReset()
         // publish event to EventBus for other modules to consume
         eventBus.publish(Event.ResetEvent)
         analytics.reset()

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

@@ -4,7 +4,6 @@ import io.customer.location.provider.LocationProvider
 import io.customer.location.provider.LocationRequestException
 import io.customer.location.type.LocationGranularity
 import io.customer.sdk.communication.Event
-import io.customer.sdk.communication.EventBus
 import io.customer.sdk.core.util.Logger
 import kotlinx.coroutines.CancellationException
 
@@ -15,7 +14,7 @@ import kotlinx.coroutines.CancellationException
 internal class LocationOrchestrator(
     private val config: LocationModuleConfig,
     private val logger: Logger,
-    private val eventBus: EventBus,
+    private val locationTracker: LocationTracker,
     private val locationProvider: LocationProvider
 ) {
 
@@ -52,6 +51,6 @@ internal class LocationOrchestrator(
             latitude = latitude,
             longitude = longitude
         )
-        eventBus.publish(Event.TrackLocationEvent(location = locationData))
+        locationTracker.onLocationReceived(locationData)
     }
 }

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

@@ -2,7 +2,6 @@ package io.customer.location
 
 import android.location.Location
 import io.customer.sdk.communication.Event
-import io.customer.sdk.communication.EventBus
 import io.customer.sdk.core.util.Logger
 import java.util.concurrent.locks.ReentrantLock
 import kotlin.concurrent.withLock
@@ -18,7 +17,7 @@ import kotlinx.coroutines.launch
 internal class LocationServicesImpl(
     private val config: LocationModuleConfig,
     private val logger: Logger,
-    private val eventBus: EventBus,
+    private val locationTracker: LocationTracker,
     private val orchestrator: LocationOrchestrator,
     private val scope: CoroutineScope
 ) : LocationServices {
@@ -43,7 +42,7 @@ internal class LocationServicesImpl(
             latitude = latitude,
             longitude = longitude
         )
-        eventBus.publish(Event.TrackLocationEvent(location = locationData))
+        locationTracker.onLocationReceived(locationData)
     }
 
     override fun setLastKnownLocation(location: Location) {

…atapipelines/location/LocationTracker.kt …/io/customer/location/LocationTracker.ktdatapipelines/src/main/kotlin/io/customer/datapipelines/location/LocationTracker.kt renamed to location/src/main/kotlin/io/customer/location/LocationTracker.kt datapipelines/src/main/kotlin/io/customer/datapipelines/location/LocationTracker.kt renamed to location/src/main/kotlin/io/customer/location/LocationTracker.kt

@@ -1,9 +1,10 @@
-package io.customer.datapipelines.location
+package io.customer.location
 
 import android.location.Location
-import io.customer.datapipelines.plugins.LocationPlugin
-import io.customer.datapipelines.store.LocationPreferenceStore
+import io.customer.location.store.LocationPreferenceStore
 import io.customer.sdk.communication.Event
+import io.customer.sdk.communication.EventBus
+import io.customer.sdk.communication.LocationCache
 import io.customer.sdk.core.util.Logger
 
 /**
@@ -20,90 +21,85 @@ import io.customer.sdk.core.util.Logger
  * 2. >= 1 km distance from the last synced location.
  *
  * If no synced location exists yet (first time), the filter passes automatically.
+ *
+ * Unlike the datapipelines version, this tracker does NOT gate on userId.
+ * The userId gate is handled by datapipelines when it subscribes to
+ * [Event.TrackLocationEvent].
  */
 internal class LocationTracker(
-    private val locationPlugin: LocationPlugin,
+    private val locationCache: LocationCache?,
     private val locationPreferenceStore: LocationPreferenceStore,
     private val logger: Logger,
-    private val userIdProvider: () -> String?
+    private val eventBus: EventBus
 ) {
     /**
      * Reads persisted cached location from the preference store and sets it on
-     * the [LocationPlugin] so that identify events have location context
+     * the [LocationCache] so that identify events have location context
      * immediately after SDK restart.
      */
     fun restorePersistedLocation() {
         val lat = locationPreferenceStore.getCachedLatitude() ?: return
         val lng = locationPreferenceStore.getCachedLongitude() ?: return
-        locationPlugin.lastLocation = Event.LocationData(latitude = lat, longitude = lng)
+        locationCache?.lastLocation = Event.LocationData(latitude = lat, longitude = lng)
         logger.debug("Restored persisted location: lat=$lat, lng=$lng")
     }
 
     /**
-     * Processes an incoming location event: always caches in the plugin and
-     * persists coordinates for identify enrichment. Only returns non-null
-     * (signalling the caller to send a "Location Update" track) when the
-     * [shouldSync] filter passes.
-     *
-     * @return the [Event.LocationData] to send as a track, or null if suppressed.
+     * Processes an incoming location: always caches in the plugin and
+     * persists coordinates for identify enrichment. Publishes a
+     * [Event.TrackLocationEvent] when the [shouldSync] filter passes.
      */
-    fun onLocationReceived(event: Event.TrackLocationEvent): Event.LocationData? {
-        val location = event.location
+    fun onLocationReceived(location: Event.LocationData) {
         logger.debug("Location update received: lat=${location.latitude}, lng=${location.longitude}")
 
         // Always cache and persist so identifies have context and location
         // survives app restarts — regardless of whether we send a track
-        locationPlugin.lastLocation = location
+        locationCache?.lastLocation = location
         locationPreferenceStore.saveCachedLocation(location.latitude, location.longitude)
 
-        // Only send location tracks for identified users
-        if (userIdProvider().isNullOrEmpty()) {
-            logger.debug("Location cached but track skipped: no identified user")
-            return null
-        }
-
         if (!shouldSync(location.latitude, location.longitude)) {
             logger.debug("Location cached but track suppressed: filter not met")
-            return null
+            return
         }
 
-        logger.debug("Location filter passed, sending Location Update track")
-        return location
+        logger.debug("Location filter passed, publishing TrackLocationEvent")
+        eventBus.publish(Event.TrackLocationEvent(location = location))
     }
 
     /**
      * Re-evaluates whether the cached location should be synced. Called on
-     * identify and on cold start to handle cases where:
+     * identify (via [Event.UserChangedEvent]) and on cold start to handle
+     * cases where:
      * - An identify was sent without location context in a previous session,
      *   and location has since arrived.
      * - The app was restarted after >24h and the cached location should be
      *   re-sent.
-     *
-     * @return the [Event.LocationData] to send as a track, or null if
-     *   the filter does not pass or no cached location exists.
      */
-    fun syncCachedLocationIfNeeded(): Event.LocationData? {
-        if (userIdProvider().isNullOrEmpty()) return null
-
-        val lat = locationPreferenceStore.getCachedLatitude() ?: return null
-        val lng = locationPreferenceStore.getCachedLongitude() ?: return null
+    fun syncCachedLocationIfNeeded() {
+        val lat = locationPreferenceStore.getCachedLatitude() ?: return
+        val lng = locationPreferenceStore.getCachedLongitude() ?: return
 
-        if (!shouldSync(lat, lng)) return null
+        if (!shouldSync(lat, lng)) return
 
         logger.debug("Syncing cached location: lat=$lat, lng=$lng")
-        return Event.LocationData(latitude = lat, longitude = lng)
+        eventBus.publish(Event.TrackLocationEvent(location = Event.LocationData(latitude = lat, longitude = lng)))
     }
 
     /**
-     * Returns true if the [LocationPlugin] has a cached location.
+     * Records that a location was successfully queued for delivery.
+     * Called when [Event.LocationTrackedEvent] is received, confirming
+     * that datapipelines sent the track.
      */
-    fun hasLocationContext(): Boolean = locationPlugin.lastLocation != null
+    fun confirmSync(latitude: Double, longitude: Double) {
+        locationPreferenceStore.saveSyncedLocation(latitude, longitude, System.currentTimeMillis())
+    }
 
     /**
-     * Resets user-level location state on logout. Clears synced data
-     * (timestamp and synced coordinates) so the next user gets their own
-     * location track — not gated by the previous user's 24h window.
-     * Cached coordinates are kept as they are device-level, not user-level.
+     * Resets user-level location state on logout or profile switch.
+     * Clears synced data (timestamp and synced coordinates) so the next
+     * user gets their own location track — not gated by the previous
+     * user's 24h window. Cached coordinates are kept as they are
+     * device-level, not user-level.
      */
     fun onUserReset() {
         locationPreferenceStore.clearSyncedData()
@@ -133,17 +129,6 @@ internal class LocationTracker(
         return distance >= MINIMUM_DISTANCE_METERS
     }
 
-    /**
-     * Records that a location was successfully queued for delivery.
-     * Must be called AFTER the "Location Update" track has been enqueued
-     * via [analytics.track], so that if the process is killed between
-     * the track and the record, the worst case is a harmless duplicate
-     * rather than a missed send.
-     */
-    fun confirmSync(latitude: Double, longitude: Double) {
-        locationPreferenceStore.saveSyncedLocation(latitude, longitude, System.currentTimeMillis())
-    }
-
     /**
      * Computes the distance in meters between two lat/lng points using
      * [android.location.Location.distanceBetween]. This is a static math