cleanup

Author: Shahroz16

core/src/main/kotlin/io/customer/sdk/core/pipeline/IdentifyContextProvider.kt

@@ -0,0 +1,25 @@
+package io.customer.sdk.core.pipeline
+
+import io.customer.base.internal.InternalCustomerIOApi
+
+/**
+ * Hook for modules that participate in the identify event lifecycle.
+ *
+ * [getIdentifyContext] returns context entries (String, Number, Boolean)
+ * added to the identify event's context via `putInContext()`. Return an
+ * empty map when there is nothing to contribute. These are context-level
+ * enrichment data (e.g., location coordinates), NOT profile traits.
+ *
+ * [resetContext] is called synchronously during `analytics.reset()`
+ * (clearIdentify flow). Implementations must clear any cached data
+ * here to prevent stale context from enriching a subsequent identify.
+ * Full cleanup (persistence, filters) can happen asynchronously via
+ * EventBus ResetEvent.
+ *
+ * This is an internal SDK contract — not intended for use by host app developers.
+ */
+@InternalCustomerIOApi
+interface IdentifyHook {
+    fun getIdentifyContext(): Map<String, Any>
+    fun resetContext() {}
+}

core/src/main/kotlin/io/customer/sdk/core/pipeline/IdentifyContextRegistry.kt

@@ -0,0 +1,41 @@
+package io.customer.sdk.core.pipeline
+
+import io.customer.base.internal.InternalCustomerIOApi
+import io.customer.sdk.core.di.SDKComponent
+
+/**
+ * Thread-safe registry of [IdentifyHook] instances.
+ *
+ * Modules register hooks during initialization. The datapipelines module
+ * queries all hooks when enriching identify event context and on reset.
+ *
+ * Cleared automatically when [SDKComponent.reset] clears singletons.
+ *
+ * This is an internal SDK contract — not intended for use by host app developers.
+ */
+@InternalCustomerIOApi
+class IdentifyHookRegistry {
+    private val hooks = mutableListOf<IdentifyHook>()
+
+    @Synchronized
+    fun register(hook: IdentifyHook) {
+        if (hook !in hooks) {
+            hooks.add(hook)
+        }
+    }
+
+    @Synchronized
+    fun getAll(): List<IdentifyHook> = hooks.toList()
+
+    @Synchronized
+    fun clear() {
+        hooks.clear()
+    }
+}
+
+/**
+ * Singleton accessor for [IdentifyHookRegistry] via [SDKComponent].
+ */
+@InternalCustomerIOApi
+val SDKComponent.identifyHookRegistry: IdentifyHookRegistry
+    get() = singleton { IdentifyHookRegistry() }

core/src/main/kotlin/io/customer/sdk/core/pipeline/IdentifyHook.kt

@@ -6,29 +6,50 @@ import com.segment.analytics.kotlin.core.IdentifyEvent
 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.core.pipeline.IdentifyContextRegistry
+import io.customer.sdk.core.pipeline.IdentifyHookRegistry
 import io.customer.sdk.core.util.Logger
 import kotlinx.serialization.json.JsonPrimitive
 
 /**
- * Generic Segment enrichment plugin that queries all registered
- * [IdentifyContextProvider][io.customer.sdk.core.pipeline.IdentifyContextProvider]
- * instances and adds their entries to the identify event context.
+ * Segment enrichment plugin that delegates to registered [IdentifyHook]
+ * instances for both identify enrichment and reset lifecycle.
  *
- * This plugin has zero knowledge of specific modules — providers
+ * On identify: queries all hooks for context entries and adds them
+ * to the event context via `putInContext()`.
+ *
+ * On reset: propagates synchronously to all hooks so they clear
+ * cached state before a subsequent identify() picks up stale values.
+ *
+ * This plugin has zero knowledge of specific modules — hooks
  * manage their own state and return primitive-valued maps.
  */
 internal class IdentifyContextPlugin(
-    private val registry: IdentifyContextRegistry,
+    private val registry: IdentifyHookRegistry,
     private val logger: Logger
 ) : EventPlugin {
     override val type: Plugin.Type = Plugin.Type.Enrichment
     override lateinit var analytics: Analytics
 
+    /**
+     * Called synchronously by analytics.reset() during clearIdentify().
+     * Propagates to all hooks so they clear cached data before a subsequent
+     * identify() can pick up stale values.
+     */
+    override fun reset() {
+        super.reset()
+        for (hook in registry.getAll()) {
+            try {
+                hook.resetContext()
+            } catch (e: Exception) {
+                logger.error("IdentifyHook reset failed: ${e.message}")
+            }
+        }
+    }
+
     override fun identify(payload: IdentifyEvent): BaseEvent {
-        for (provider in registry.getAll()) {
+        for (hook in registry.getAll()) {
             try {
-                val context = provider.getIdentifyContext()
+                val context = hook.getIdentifyContext()
                 if (context.isEmpty()) continue
                 for ((key, value) in context) {
                     val jsonValue = when (value) {
@@ -43,7 +64,7 @@ internal class IdentifyContextPlugin(
                     payload.putInContext(key, jsonValue)
                 }
             } catch (e: Exception) {
-                logger.error("IdentifyContextProvider failed: ${e.message}")
+                logger.error("IdentifyHook failed: ${e.message}")
             }
         }
         return payload

core/src/main/kotlin/io/customer/sdk/core/pipeline/IdentifyHookRegistry.kt

@@ -33,7 +33,7 @@ import io.customer.sdk.core.di.AndroidSDKComponent
 import io.customer.sdk.core.di.SDKComponent
 import io.customer.sdk.core.module.CustomerIOModule
 import io.customer.sdk.core.pipeline.DataPipeline
-import io.customer.sdk.core.pipeline.identifyContextRegistry
+import io.customer.sdk.core.pipeline.identifyHookRegistry
 import io.customer.sdk.core.util.CioLogLevel
 import io.customer.sdk.core.util.Logger
 import io.customer.sdk.data.model.CustomAttributes
@@ -130,7 +130,7 @@ class CustomerIO private constructor(
 
         // Add plugin to filter events based on SDK configuration
         analytics.add(ScreenFilterPlugin(moduleConfig.screenViewUse))
-        analytics.add(IdentifyContextPlugin(SDKComponent.identifyContextRegistry, logger))
+        analytics.add(IdentifyContextPlugin(SDKComponent.identifyHookRegistry, logger))
         analytics.add(ApplicationLifecyclePlugin())
 
         // Register this instance as DataPipeline so modules can send track events directly

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

@@ -3,7 +3,7 @@ package io.customer.location
 import io.customer.location.store.LocationPreferenceStore
 import io.customer.location.sync.LocationSyncFilter
 import io.customer.sdk.core.pipeline.DataPipeline
-import io.customer.sdk.core.pipeline.IdentifyContextProvider
+import io.customer.sdk.core.pipeline.IdentifyHook
 import io.customer.sdk.core.util.Logger
 import io.customer.sdk.util.EventNames
 
@@ -13,7 +13,7 @@ import io.customer.sdk.util.EventNames
  *
  * Location reaches the backend through two independent paths:
  *
- * 1. **Identify context enrichment** — implements [IdentifyContextProvider].
+ * 1. **Identify context enrichment** — implements [IdentifyHook].
  *    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.
@@ -24,16 +24,17 @@ import io.customer.sdk.util.EventNames
  *    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.
+ * On clearIdentify(), [resetContext] clears all state (cache, persistence,
+ * sync filter) synchronously during analytics.reset(). 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?,
     private val locationPreferenceStore: LocationPreferenceStore,
     private val locationSyncFilter: LocationSyncFilter,
     private val logger: Logger
-) : IdentifyContextProvider {
+) : IdentifyHook {
 
     @Volatile
     private var lastLocation: LocationCoordinates? = null
@@ -46,6 +47,20 @@ internal class LocationTracker(
         )
     }
 
+    /**
+     * Called synchronously by analytics.reset() during clearIdentify.
+     * Clears all location state: in-memory cache, persisted coordinates,
+     * and sync filter — similar to how device tokens and other per-user
+     * state are cleared on reset. This runs before ResetEvent is published,
+     * guaranteeing no stale data is available for a subsequent identify().
+     */
+    override fun resetContext() {
+        lastLocation = null
+        locationPreferenceStore.clearCachedLocation()
+        locationSyncFilter.clearSyncedData()
+        logger.debug("Location state reset")
+    }
+
     /**
      * Reads persisted cached location from the preference store and sets the
      * in-memory cache so that identify events have location context
@@ -83,19 +98,6 @@ internal class LocationTracker(
         syncCachedLocationIfNeeded()
     }
 
-    /**
-     * Clears all location state on identity reset (clearIdentify).
-     * 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
-        locationPreferenceStore.clearCachedLocation()
-        locationSyncFilter.clearSyncedData()
-        logger.debug("Location state reset")
-    }
-
     /**
      * Re-evaluates the cached location for sending.
      * Called on identify (via [onUserIdentified]) and on cold start

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

@@ -10,7 +10,7 @@ import io.customer.sdk.communication.subscribe
 import io.customer.sdk.core.di.SDKComponent
 import io.customer.sdk.core.module.CustomerIOModule
 import io.customer.sdk.core.pipeline.DataPipeline
-import io.customer.sdk.core.pipeline.identifyContextRegistry
+import io.customer.sdk.core.pipeline.identifyHookRegistry
 import io.customer.sdk.core.util.Logger
 
 /**
@@ -77,14 +77,11 @@ class ModuleLocation @JvmOverloads constructor(
 
         locationTracker.restorePersistedLocation()
 
-        // 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()
-        }
+        // Register as IdentifyHook so location is added to identify event context
+        // and cleared synchronously during analytics.reset(). 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.identifyHookRegistry.register(locationTracker)
 
         // On identify, attempt to send a supplementary "Location Update" track event.
         // The identify event itself already carries location via context enrichment —

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

@@ -214,16 +214,18 @@ class LocationTrackerTest {
         verify(exactly = 0) { dataPipeline.track(any(), any()) }
     }
 
-    // -- onReset --
+    // -- resetContext (synchronous, called by analytics.reset during clearIdentify) --
 
     @Test
-    fun givenReset_expectClearsEverything() {
+    fun givenResetContext_expectClearsEverything() {
         tracker.onLocationReceived(37.7749, -122.4194)
 
-        tracker.onReset()
+        tracker.resetContext()
 
+        // In-memory location cleared — no stale data for next identify
+        tracker.getIdentifyContext().shouldBeEmpty()
+        // Persistence and sync filter also cleared synchronously
         verify { store.clearCachedLocation() }
         verify { syncFilter.clearSyncedData() }
-        tracker.getIdentifyContext().shouldBeEmpty()
     }
 }