[Improvement] : Move CSHealthMetrics to Optional Setter

CHANGELOG.md

@@ -2,7 +2,13 @@
 
 Based on https://keepachangelog.com/en/1.0.0/
 
-## 0.2.36-snapshot
+## 0.2.39
 
 ### Update
-- Support Pluggable HealthMetrics
+- [Improvement] : Move CSHealthMetrics to Optional Setter
+
+
+## 0.2.36
+
+### Update
+- [[Feature] : Support Pluggable HealthMetrics](https://github.com/gojek/clickstream-android/discussions/6)

README.md

@@ -60,7 +60,6 @@ dependencies {
     // Required
     implementation 'com.gojek.clickstream:clickstream-android:[latest_version]'
     implementation 'com.gojek.clickstream:clickstream-lifecycle:[latest_version]'
-    implementation 'com.gojek.clickstream:clickstream-health-metrics-noop:[latest_version]'
 
     // Optional
     implementation 'com.gojek.clickstream:clickstream-health-metrics:[latest_version]'
@@ -105,6 +104,7 @@ class App : Application() {
                 healthGateway = DefaultOpCSHealthGateway.factory(/*args*/)
             ).apply {
                 setLogLevel(DEBUG)
+                /**/ 
                 setCSSocketConnectionListener(connectionListener())
             }.build())
     }

buildSrc/src/main/kotlin/deps.kt

@@ -126,7 +126,6 @@ object deps {
     object workManager {
         const val workRuntimeKtx = "androidx.work:work-runtime-ktx:${versions.workManagerVersion}"
         const val workTesting = "androidx.work:work-testing:${versions.workManagerVersion}"
-
     }
 
     object utils {

clickstream-health-metrics-api/src/main/kotlin/clickstream/health/time/CSTimeStampGenerator.kt

@@ -1,6 +1,4 @@
-package clickstream.health
-
-import clickstream.health.time.CSEventGeneratedTimestampListener
+package clickstream.health.time
 
 public interface CSTimeStampGenerator {
     public fun getTimeStamp(): Long

clickstream-health-metrics/src/main/kotlin/clickstream/health/DefaultCSHealthGateway.kt

@@ -15,23 +15,24 @@ import clickstream.health.internal.DefaultCSHealthEventFactory
 import clickstream.health.internal.DefaultCSHealthEventProcessor
 import clickstream.health.internal.DefaultCSHealthEventRepository
 import clickstream.health.model.CSHealthEventConfig
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.lifecycle.CSAppLifeCycle
 import clickstream.logger.CSLogger
 import clickstream.util.CSAppVersionSharedPref
 import clickstream.util.impl.DefaultCSAppVersionSharedPref
-import java.util.UUID
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 
 public object DefaultCSHealthGateway {
 
     public fun factory(
+        appVersion: String,
+        sessionId: String,
         context: Context,
         healthEventConfig: CSHealthEventConfig,
         csInfo: CSInfo,
         logger: CSLogger,
         healthEventLogger: CSHealthEventLoggerListener,
-        appVersion: String,
         timeStampGenerator: CSTimeStampGenerator,
         metaProvider: CSMetaProvider,
         eventHealthListener: CSEventHealthListener,
@@ -45,7 +46,7 @@ public object DefaultCSHealthGateway {
             override val eventHealthListener: CSEventHealthListener = eventHealthListener
             override val healthEventRepository: CSHealthEventRepository by lazy {
                 DefaultCSHealthEventRepository(
-                    sessionId = UUID.randomUUID().toString(),
+                    sessionId = sessionId,
                     healthEventDao = CSHealthDatabase.getInstance(context).healthEventDao(),
                     info = csInfo
                 )

clickstream-health-metrics/src/main/kotlin/clickstream/health/internal/DefaultCSHealthEventFactory.kt

@@ -2,7 +2,7 @@ package clickstream.health.internal
 
 import androidx.annotation.RestrictTo
 import clickstream.api.CSMetaProvider
-import clickstream.health.CSTimeStampGenerator
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.health.identity.CSGuIdGenerator
 import clickstream.health.intermediate.CSHealthEventFactory
 import com.gojek.clickstream.internal.Health

clickstream/build.gradle.kts

@@ -34,10 +34,14 @@ dependencies {
     // Clickstream
     implementation(files("$rootDir/libs/proto-sdk-1.18.6.jar"))
     api(projects.clickstreamLogger)
+    api(projects.clickstreamHealthMetricsNoop)
     compileOnly(projects.clickstreamApi)
     compileOnly(projects.clickstreamHealthMetricsApi)
     compileOnly(projects.clickstreamLifecycle)
 
+    // Proto
+    api(deps.utils.protoLite)
+
     // Common
     deps.common.list.forEach(::implementation)
 

clickstream/src/main/kotlin/clickstream/config/CSConfiguration.kt

@@ -12,6 +12,7 @@ import clickstream.health.intermediate.CSHealthEventLoggerListener
 import clickstream.health.intermediate.CSHealthEventProcessor
 import clickstream.health.intermediate.CSHealthEventRepository
 import clickstream.health.CSHealthGateway
+import clickstream.health.NoOpCSHealthGateway
 import clickstream.health.time.CSEventGeneratedTimestampListener
 import clickstream.internal.NoOpCSEventHealthListener
 import clickstream.internal.analytics.impl.NoOpCSHealthEventLogger
@@ -88,14 +89,17 @@ public class CSConfiguration private constructor(
          */
         private val config: CSConfig,
 
-        private val appLifeCycle: CSAppLifeCycle,
-
-        private val healthGateway: CSHealthGateway 
+        /**
+         * Specify Clicstream lifecycle, this is needed in order to send events
+         * to the backend.
+         */
+        private val appLifeCycle: CSAppLifeCycle
     ) {
         private lateinit var dispatcher: CoroutineDispatcher
         private lateinit var eventGeneratedListener: CSEventGeneratedTimestampListener
         private lateinit var socketConnectionListener: CSSocketConnectionListener
         private lateinit var remoteConfig: CSRemoteConfig
+        private lateinit var healthGateway: CSHealthGateway
         private var logLevel: CSLogLevel = CSLogLevel.OFF
 
         /**
@@ -155,6 +159,17 @@ public class CSConfiguration private constructor(
                 this.remoteConfig = remoteConfig
             }
 
+        /**
+         * Specify implementation of [CSHealthGateway], by default it would use
+         * [NoOpCSHealthGateway]
+         *
+         * @return This [Builder] instance
+         */
+        public fun setHealthGateway(healthGateway: CSHealthGateway): Builder =
+            apply {
+                this.healthGateway = healthGateway
+            }
+
         /**
          * Builds a [CSConfiguration] object.
          *
@@ -173,6 +188,9 @@ public class CSConfiguration private constructor(
             if (::remoteConfig.isInitialized.not()) {
                 remoteConfig = NoOpCSRemoteConfig()
             }
+            if(::healthGateway.isInitialized.not()) {
+                healthGateway = NoOpCSHealthGateway.factory()
+            }
             return CSConfiguration(
                 context, dispatcher,
                 info, config,

clickstream/src/main/kotlin/clickstream/internal/di/impl/DefaultCServiceLocator.kt

@@ -7,15 +7,15 @@ import clickstream.config.CSConfig
 import clickstream.config.CSEventSchedulerConfig
 import clickstream.config.CSRemoteConfig
 import clickstream.connection.CSSocketConnectionListener
-import clickstream.health.CSTimeStampGenerator
-import clickstream.health.DefaultCSTimeStampGenerator
 import clickstream.health.identity.CSGuIdGenerator
 import clickstream.health.identity.DefaultCSGuIdGenerator
 import clickstream.health.intermediate.CSEventHealthListener
 import clickstream.health.intermediate.CSHealthEventFactory
 import clickstream.health.intermediate.CSHealthEventProcessor
 import clickstream.health.intermediate.CSHealthEventRepository
 import clickstream.health.time.CSEventGeneratedTimestampListener
+import clickstream.health.time.CSTimeStampGenerator
+import clickstream.health.time.DefaultCSTimeStampGenerator
 import clickstream.internal.db.CSDatabase
 import clickstream.internal.di.CSServiceLocator
 import clickstream.internal.eventprocessor.CSEventProcessor

clickstream/src/main/kotlin/clickstream/internal/eventscheduler/CSBackgroundScheduler.kt

@@ -2,13 +2,13 @@ package clickstream.internal.eventscheduler
 
 import clickstream.api.CSInfo
 import clickstream.config.CSEventSchedulerConfig
-import clickstream.health.CSTimeStampGenerator
 import clickstream.health.constant.CSEventNamesConstant.ClickStreamFlushOnBackground
 import clickstream.health.constant.CSEventTypesConstant
 import clickstream.health.identity.CSGuIdGenerator
 import clickstream.health.intermediate.CSEventHealthListener
 import clickstream.health.intermediate.CSHealthEventRepository
 import clickstream.health.model.CSHealthEventDTO
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.internal.di.CSServiceLocator
 import clickstream.internal.networklayer.CSBackgroundNetworkManager
 import clickstream.internal.utils.CSBatteryStatusObserver

clickstream/src/main/kotlin/clickstream/internal/eventscheduler/CSEventScheduler.kt

@@ -3,7 +3,6 @@ package clickstream.internal.eventscheduler
 import clickstream.api.CSInfo
 import clickstream.config.CSEventSchedulerConfig
 import clickstream.extension.isValidMessage
-import clickstream.health.CSTimeStampGenerator
 import clickstream.health.constant.CSEventNamesConstant.ClickStreamEventBatchCreated
 import clickstream.health.constant.CSEventNamesConstant.ClickStreamEventBatchTriggerFailed
 import clickstream.health.constant.CSEventNamesConstant.ClickStreamEventCached
@@ -13,6 +12,7 @@ import clickstream.health.identity.CSGuIdGenerator
 import clickstream.health.intermediate.CSEventHealthListener
 import clickstream.health.intermediate.CSHealthEventRepository
 import clickstream.health.model.CSHealthEventDTO
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.internal.analytics.CSErrorReasons
 import clickstream.internal.networklayer.CSNetworkManager
 import clickstream.internal.utils.CSBatteryLevel
@@ -236,12 +236,12 @@ internal open class CSEventScheduler(
         if (batch.isNotEmpty() && batch[0].messageName != Health::class.qualifiedName.orEmpty()) {
             logger.debug {
                 "CSEventScheduler#forwardEvents#batch - " +
-                "eventBatchId : ${eventRequest.reqGuid}, " +
-                "eventId : ${batch.joinToString { it.eventGuid }}"
+                        "eventBatchId : ${eventRequest.reqGuid}, " +
+                        "eventId : ${batch.joinToString { it.eventGuid }}"
             }
             logger.debug {
                 "CSEventScheduler#forwardEvents#batch - " +
-                "messageName : ${batch[0].messageName}"
+                        "messageName : ${batch[0].messageName}"
             }
             logHealthEvent(
                 CSHealthEventDTO(

clickstream/src/main/kotlin/clickstream/internal/networklayer/CSNetworkRepository.kt

@@ -3,7 +3,7 @@ package clickstream.internal.networklayer
 import clickstream.api.CSInfo
 import clickstream.config.CSNetworkConfig
 import clickstream.health.intermediate.CSHealthEventRepository
-import clickstream.health.CSTimeStampGenerator
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.internal.utils.CSCallback
 import clickstream.logger.CSLogger
 import com.gojek.clickstream.de.EventRequest

clickstream/src/main/kotlin/clickstream/internal/networklayer/CSRetryableCallback.kt

@@ -3,11 +3,11 @@ package clickstream.internal.networklayer
 import clickstream.api.CSInfo
 import clickstream.config.CSNetworkConfig
 import clickstream.extension.isHealthEvent
-import clickstream.health.CSTimeStampGenerator
 import clickstream.health.constant.CSEventNamesConstant
 import clickstream.health.constant.CSEventTypesConstant
 import clickstream.health.intermediate.CSHealthEventRepository
 import clickstream.health.model.CSHealthEventDTO
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.internal.analytics.CSErrorReasons
 import clickstream.internal.utils.CSTimeStampMessageBuilder
 import clickstream.logger.CSLogger

clickstream/src/test/kotlin/clickstream/ClickStreamFunctionalTest.kt

@@ -69,8 +69,7 @@ public class ClickStreamFunctionalTest {
                 info = csInfo,
                 config = createCSConfig(),
                 appLifeCycle = appLifecycle,
-                healthGateway = fakeHealthGateway
-            ).setDispatcher(coroutineRule.testDispatcher).build()
+            ).setDispatcher(coroutineRule.testDispatcher).setHealthGateway(fakeHealthGateway).build()
         )
 
         sut = ClickStream.getInstance()
@@ -98,9 +97,8 @@ public class ClickStreamFunctionalTest {
                 context = app,
                 info = csInfo,
                 config = createCSConfig(),
-                appLifeCycle = appLifecycle,
-                healthGateway = fakeHealthGateway
-            ).setDispatcher(coroutineRule.testDispatcher).build()
+                appLifeCycle = appLifecycle
+            ).setDispatcher(coroutineRule.testDispatcher).setHealthGateway(fakeHealthGateway).build()
         )
         sut = ClickStream.getInstance()
 

clickstream/src/test/kotlin/clickstream/internal/eventprocessor/impl/DefaultCSHealthEventFactoryTest.kt

@@ -2,7 +2,7 @@ package clickstream.internal.eventprocessor.impl
 
 import clickstream.api.CSMetaProvider
 import clickstream.extension.protoName
-import clickstream.health.CSTimeStampGenerator
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.health.identity.CSGuIdGenerator
 import clickstream.health.internal.DefaultCSHealthEventFactory
 import com.gojek.clickstream.internal.Health

clickstream/src/test/kotlin/clickstream/internal/eventscheduler/CSBackgroundSchedulerTest.kt

@@ -4,7 +4,7 @@ import clickstream.config.CSEventSchedulerConfig
 import clickstream.fake.FakeEventBatchDao
 import clickstream.fake.defaultEventWrapperData
 import clickstream.fake.fakeInfo
-import clickstream.health.CSTimeStampGenerator
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.health.identity.CSGuIdGenerator
 import clickstream.health.intermediate.CSHealthEventProcessor
 import clickstream.health.intermediate.CSHealthEventRepository

clickstream/src/test/kotlin/clickstream/internal/eventscheduler/CSEventSchedulerTest.kt

@@ -4,7 +4,7 @@ import clickstream.config.CSEventSchedulerConfig
 import clickstream.fake.FakeEventBatchDao
 import clickstream.fake.defaultEventWrapperData
 import clickstream.fake.fakeInfo
-import clickstream.health.CSTimeStampGenerator
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.health.identity.CSGuIdGenerator
 import clickstream.health.intermediate.CSHealthEventRepository
 import clickstream.internal.eventscheduler.impl.DefaultCSEventRepository

clickstream/src/test/kotlin/clickstream/internal/networklayer/CSRetryableCallbackTest.kt

@@ -2,7 +2,7 @@ package clickstream.internal.networklayer
 
 import clickstream.config.CSNetworkConfig
 import clickstream.fake.fakeCSInfo
-import clickstream.health.CSTimeStampGenerator
+import clickstream.health.time.CSTimeStampGenerator
 import clickstream.health.intermediate.CSHealthEventRepository
 import clickstream.internal.utils.CSFlowStreamAdapterFactory
 import clickstream.logger.CSLogLevel.OFF

scripts/versioning.gradle

@@ -1,3 +1,3 @@
 ext {
-    gitVersionName = "0.2.36"
+    gitVersionName = "0.2.39"
 }