[Ft]:[DEVX-8764]:Clickstream Health refactor

Author: kshitij6325

app/src/main/java/com/clickstream/app/App.kt

@@ -9,7 +9,6 @@ import clickstream.connection.CSConnectionEvent
 import clickstream.connection.CSSocketConnectionListener
 import clickstream.eventvisualiser.CSEventVisualiserListener
 import clickstream.eventvisualiser.ui.CSEventVisualiserUI
-import clickstream.health.DefaultCSHealthGateway
 import clickstream.logger.CSLogLevel
 import com.clickstream.app.config.csConfig
 import com.clickstream.app.config.csInfo

app/src/main/java/com/clickstream/app/config/CSInfo.kt

@@ -7,7 +7,7 @@ import clickstream.api.CSSessionInfo
 import clickstream.api.CSUserInfo
 
 fun csInfo() = CSInfo(
-    appInfo = CSAppInfo(appVersion = "1.1.0"),
+    appInfo = CSAppInfo(appVersion = "2.1.0"),
     locationInfo = CSLocationInfo(
         latitude = -6.1753871,
         longitude = 106.8249641,

app/src/main/java/com/clickstream/app/config/DefaultCSConfig.kt

@@ -4,7 +4,6 @@ import clickstream.config.CSConfig
 import clickstream.config.CSEventProcessorConfig
 import clickstream.config.CSEventSchedulerConfig
 import clickstream.config.CSNetworkConfig
-import clickstream.health.constant.CSTrackedVia
 import clickstream.health.model.CSHealthEventConfig
 import com.clickstream.app.helper.load
 
@@ -28,6 +27,5 @@ fun csConfig(
                 "X-UniqueId" to deviceId
             )
         ),
-        healthEventConfig = CSHealthEventConfig.default(trackedVia = CSTrackedVia.Both)
     )
 }

app/src/main/java/com/clickstream/app/config/DefaultHealthConfig.kt

@@ -1,52 +1,50 @@
 package com.clickstream.app.config
 
+import DefaultCSHealthGateway
 import android.content.Context
-import clickstream.health.DefaultCSHealthGateway
-import clickstream.health.constant.CSTrackedVia
-import clickstream.health.intermediate.CSEventHealthListener
+import android.util.Log
 import clickstream.health.intermediate.CSHealthEventLoggerListener
-import clickstream.health.model.CSEventHealth
-import clickstream.health.model.CSHealthEvent
+import clickstream.health.intermediate.CSMemoryStatusProvider
 import clickstream.health.model.CSHealthEventConfig
 import clickstream.health.time.CSHealthTimeStampGenerator
-import clickstream.lifecycle.impl.DefaultCSAppLifeCycleObserver
 import clickstream.logger.CSLogLevel
 import clickstream.logger.CSLogger
 
 
-fun getHealthGateway(context: Context) =
-    DefaultCSHealthGateway.factory(
-        appVersion = "1.0.0",
-        sessionId = "abc",
-        context = context,
-        healthEventConfig = CSHealthEventConfig(
-            "1.0.0",
-            listOf(), CSTrackedVia.Both
-        ),
-        csInfo = csInfo(),
-        logger = CSLogger(CSLogLevel.DEBUG),
-        healthEventLogger = healthEventLogger(),
-        eventHealthListener = healthEventListener(),
-        timeStampGenerator = timeStampGenerator(),
-        appLifeCycle = DefaultCSAppLifeCycleObserver(CSLogger(CSLogLevel.DEBUG))
-    )
+fun getHealthGateway(context: Context) = DefaultCSHealthGateway(
+    context = context,
+    csInfo = csInfo(),
+    logger = CSLogger(CSLogLevel.DEBUG),
+    timeStampGenerator = timeStampGenerator(),
+    csMemoryStatusProvider = memoryStatusProvider(),
+    csHealthEventConfig = healthConfig(),
+    csHealthEventLoggerListener = healthEventLogger()
+)
 
 
 fun healthEventLogger() = object : CSHealthEventLoggerListener {
-    override fun logEvent(eventName: String, healthEvent: CSHealthEvent) {
-
+    override fun logEvent(eventName: String, healthData: HashMap<String, Any>) {
+        Log.d("CS External Logger", "$eventName: $healthData")
     }
-}
 
-fun healthEventListener() = object : CSEventHealthListener {
-    override fun onEventCreated(healthEvent: CSEventHealth) {
+}
 
+fun memoryStatusProvider() = object : CSMemoryStatusProvider {
+    override fun isLowMemory(): Boolean {
+        return false
     }
 }
 
 fun timeStampGenerator() = object : CSHealthTimeStampGenerator {
     override fun getTimeStamp(): Long {
         return System.currentTimeMillis()
     }
+}
 
-}
+fun healthConfig() =
+    CSHealthEventConfig(
+        minTrackedVersion = "1.1.0",
+        randomUserIdRemainder = (0..9).toList(),
+        destination = listOf("CS", "CT"),
+        verbosityLevel = "minimum"
+    )

clickstream-health-metrics-api/build.gradle.kts

@@ -35,6 +35,8 @@ android {
 dependencies {
     // Clickstream
     compileOnly(files("$rootDir/libs/proto-sdk-1.18.6.jar"))
+    implementation(deps.kotlin.coroutines.core)
+
 
     implementation(deps.android.core.annotation)
 }

clickstream-health-metrics-api/src/main/kotlin/clickstream/health/CSHealthGateway.kt

@@ -1,18 +1,25 @@
 package clickstream.health
 
 import androidx.annotation.RestrictTo
-import clickstream.health.intermediate.CSEventHealthListener
-import clickstream.health.intermediate.CSHealthEventFactory
 import clickstream.health.intermediate.CSHealthEventProcessor
-import clickstream.health.intermediate.CSHealthEventRepository
 
+/**
+ * Wrapper class that creates [CSHealthEventProcessor].
+ *
+ * */
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 public interface CSHealthGateway {
-    public val eventHealthListener: CSEventHealthListener
 
-    public val healthEventRepository: CSHealthEventRepository
+    /**
+     * Class to process health events.
+     *
+     * */
+    public val healthEventProcessor: CSHealthEventProcessor?
 
-    public val healthEventProcessor: CSHealthEventProcessor
+    /**
+     * Clears health events on app version upgrade.
+     *
+     * */
+    public suspend fun clearHealthEventsForVersionChange()
 
-    public val healthEventFactory: CSHealthEventFactory
 }

clickstream-health-metrics-api/src/main/kotlin/clickstream/health/constant/CSEventNamesConstant.kt

@@ -3,141 +3,23 @@ package clickstream.health.constant
 import androidx.annotation.RestrictTo
 
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
-public enum class CSEventNamesConstant(public val value: String) {;
+public enum class CSHealthEventName(public val value: String) {
 
-    public enum class Instant(public val value: String) {
-        /**
-         * Tracks the instances where the connection gets dropped.
-         *
-         * Type: Instant
-         * Priority: Critical
-         */
-        ClickStreamConnectionDropped("Clickstream Connection Dropped"),
+    // Batch sent events
+    ClickStreamBatchSent("ClickStream Batch Sent"),
+    ClickStreamEventBatchTriggerFailed("Clickstream Event Batch Trigger Failed"),
+    ClickStreamBatchWriteFailed("ClickStream Write to Socket Failed"),
 
-        /**
-         * Tracks the connection attempt instances.
-         *
-         * Type: Instant
-         * Priority: Critical
-         */
-        ClickStreamConnectionAttempt("Clickstream Connection Attempt"),
+    // Socket connection events
+    ClickStreamConnectionFailed("ClickStream Connection Failed"),
 
-        /**
-         * Tracks the connection attempt success instances.
-         *
-         * Type: Instant
-         * Priority: Critical
-         */
-        ClickStreamConnectionSuccess("Clickstream Connection Success"),
+    // Batch acknowledgement events
+    ClickStreamEventBatchErrorResponse("Clickstream Event Batch Error response"),
+    ClickStreamEventBatchAck("Clickstream Event Batch Success Ack"),
+    ClickStreamEventBatchTimeout("Clickstream Event Batch Timeout"),
 
-        /**
-         * Tracks the connection attempt failure instances.
-         *
-         * Type: Instant
-         * Priority: Critical
-         */
-        ClickStreamConnectionFailure("Clickstream Connection Failure"),
-
-        /**
-         * Tracks the instances when the clickstream event batch gets timed out.
-         *
-         * Type: Instant
-         * Priority: Critical
-         */
-        ClickStreamEventBatchTimeout("Clickstream Event Batch Timeout"),
-
-        /**
-         * Tracks the instances when the clickstream event batch fails to get written on the socket.
-         *
-         * Type: Instant
-         * Priority: Critical
-         */
-        ClickStreamWriteToSocketFailed("ClickStream Write to Socket Failed"),
-
-        /**
-         * Tracks the instances when the batch fails to get triggered.
-         *
-         * Type: Instant
-         * Priority: Low
-         */
-        ClickStreamEventBatchTriggerFailed("Clickstream Event Batch Trigger Failed"),
-
-        /**
-         * Tracks the instances when the clickstream request results in a error response.
-         *
-         * Type: Instant
-         * Priority: Critical
-         */
-        ClickStreamEventBatchErrorResponse("Clickstream Event Batch Error response"),
-    }
-
-    public enum class Flushed(public val value: String) {
-        /**
-         * This event is track the drop rate comparison only and not the part of the funnel.
-         * Would be triggered for the event which is used to track the drops Eg. `AdCardEvent`
-         *
-         * Type: Flushed
-         * Priority: Critical
-         */
-        ClickStreamEventReceivedForDropRate("Clickstream Event Received For Drop Rate"),
-
-        /**
-         * Tracks the instances where the event is received by the Clickstream library
-         *
-         * Type: Flushed
-         * Priority: Critical
-         */
-        ClickStreamEventReceived("Clickstream Event Received"),
-    }
-
-    public enum class AggregatedAndFlushed(public val value: String) {
-        /**
-         * Tracks the instances when the clickstream event object is cached.
-         *
-         * Type: Aggregated and Flushed
-         * Priority: Low
-         */
-        ClickStreamEventCached("Clickstream Event Cached"),
-
-        /**
-         * Tracks the instances when the clickstream event batch is created.
-         *
-         * Type: Aggregated and Flushed
-         * Priority: Low
-         */
-        ClickStreamEventBatchCreated("Clickstream Event Batch Created"),
-
-        /**
-         * Tracks the instances when the clickstream batch gets successfully sent to raccoon.
-         *
-         * Type: Aggregated and Flushed
-         * Priority: Low
-         */
-        ClickStreamBatchSent("ClickStream Batch Sent"),
-
-        /**
-         * Tracks the instances when raccoon acks the event request.
-         *
-         * Type: Aggregated and Flushed
-         * Priority: Low
-         */
-        ClickStreamEventBatchSuccessAck("Clickstream Event Batch Success Ack"),
-
-        /**
-         * Tracks the instances when the clickstream batches are flushed on background.
-         *
-         * Type: Aggregated and Flushed
-         * Priority: Critical
-         */
-        ClickStreamFlushOnBackground("ClickStream Flush On Background"),
-
-        /**
-         * Tracks the instances when the clickstream batches are flushed on background.
-         *
-         * Type: Aggregated and Flushed
-         * Priority: Critical
-         */
-        ClickStreamFlushOnForeground("ClickStream Flush On Foreground"),
-    }
+    // Flush events
+    ClickStreamFlushOnBackground("ClickStream Flush On Background"),
+    ClickStreamFlushOnForeground("Clickstream Flush On Foreground"),
 }
 

clickstream-health-metrics-api/src/main/kotlin/clickstream/health/constant/CSEventTypesConstant.kt

@@ -2,6 +2,7 @@ package clickstream.health.constant
 
 import androidx.annotation.RestrictTo
 
+
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 public object CSEventTypesConstant {
     public const val INSTANT: String = "instant"