Wenxi/suspendable analytics (#50)

* init changes to make sdk suspendable

* get ride of singleton dispatchers

* fix configuration issue

* fix unit test errors

* fix android errors

* fix android unit tests errors

* fix destination unit tests errors

* remove weak reference from SegmentDestination.kt

* update settings to use withContext

* refactor dispatcher to be injectable

* fix core unit tests

* fix android unit tests

* fix destination unit tests

* separate base data for accuracy

* fix unit test

* add blocking api warning

* fix JavaAnalytics.kt

* refactor annotation class to a separate file

* update sovran version

* add comments to constructors

Author: wenxi-zeng

android/build.gradle

@@ -46,7 +46,7 @@ android {
 dependencies {
     // MAIN DEPS
     api project(':core')
-    api 'com.github.segmentio:sovran-kotlin:0.1.0'
+    api 'com.github.segmentio:sovran-kotlin:1.1.0'
     api "org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.1"
     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9'
     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'

android/src/main/java/com/segment/analytics/kotlin/android/Storage.kt

@@ -29,18 +29,20 @@ class AndroidStorage(
     internal val eventsFile =
         EventsFileManager(storageDirectory, writeKey, AndroidKVS(sharedPreferences))
 
-    override fun subscribeToStore() {
+    override suspend fun subscribeToStore() {
         store.subscribe(
             this,
             UserInfo::class,
             initialState = true,
-            handler = ::userInfoUpdate
+            handler = ::userInfoUpdate,
+            queue = ioDispatcher
         )
         store.subscribe(
             this,
             System::class,
             initialState = true,
-            handler = ::systemUpdate
+            handler = ::systemUpdate,
+            queue = ioDispatcher
         )
     }
 

android/src/main/java/com/segment/analytics/kotlin/android/plugins/AndroidLifecyclePlugin.kt

@@ -73,7 +73,7 @@ class AndroidLifecyclePlugin() : Application.ActivityLifecycleCallbacks, Default
     }
 
     private fun runOnAnalyticsThread(block: () -> Unit) = with(analytics) {
-        analyticsScope.launch(processingDispatcher) {
+        analyticsScope.launch(analyticsDispatcher) {
             block()
         }
     }

android/src/test/java/com/segment/analytics/kotlin/android/AndroidLifecyclePluginTests.kt

@@ -12,6 +12,7 @@ import com.segment.analytics.kotlin.android.utils.TestRunPlugin
 import com.segment.analytics.kotlin.core.platform.Plugin
 import com.segment.analytics.kotlin.android.plugins.AndroidLifecycle
 import com.segment.analytics.kotlin.android.plugins.AndroidLifecyclePlugin
+import com.segment.analytics.kotlin.android.utils.mockHTTPClient
 import io.mockk.*
 import kotlinx.serialization.json.buildJsonObject
 import kotlinx.serialization.json.put
@@ -47,6 +48,8 @@ class AndroidLifecyclePluginTests {
         every { Instant.now() } returns Date(0).toInstant()
         mockkStatic(UUID::class)
         every { UUID.randomUUID().toString() } returns "qwerty-qwerty-123"
+
+        mockHTTPClient()
     }
 
     @Before

android/src/test/java/com/segment/analytics/kotlin/android/StorageTests.kt

@@ -7,6 +7,7 @@ import com.segment.analytics.kotlin.android.utils.MemorySharedPreferences
 import com.segment.analytics.kotlin.android.utils.clearPersistentStorage
 import com.segment.analytics.kotlin.android.utils.mockAnalytics
 import com.segment.analytics.kotlin.android.utils.mockContext
+import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.test.TestCoroutineDispatcher
 import kotlinx.coroutines.test.runBlockingTest
 import kotlinx.serialization.decodeFromString
@@ -33,7 +34,7 @@ class StorageTests {
         private var mockContext: Context = mockContext()
 
         @BeforeEach
-        fun setup() {
+        fun setup() = runBlocking  {
             clearPersistentStorage()
             store.provide(
                 UserInfo(
@@ -62,7 +63,7 @@ class StorageTests {
 
 
         @Test
-        fun `userInfo update calls write`() = runBlockingTest {
+        fun `userInfo update calls write`() = runBlocking {
             val action = object : Action<UserInfo> {
                 override fun reduce(state: UserInfo): UserInfo {
                     return UserInfo(
@@ -83,7 +84,7 @@ class StorageTests {
         }
 
         @Test
-        fun `system update calls write for settings`() = runBlockingTest {
+        fun `system update calls write for settings`() = runBlocking {
             val action = object : Action<System> {
                 override fun reduce(state: System): System {
                     return System(

android/src/test/java/com/segment/analytics/kotlin/android/utils/Mocks.kt

@@ -3,17 +3,33 @@ package com.segment.analytics.kotlin.android.utils
 import android.content.Context
 import android.content.pm.PackageInfo
 import android.content.pm.PackageManager
-import com.segment.analytics.kotlin.android.utils.MemorySharedPreferences
 import com.segment.analytics.kotlin.core.Analytics
+import com.segment.analytics.kotlin.core.Connection
+import com.segment.analytics.kotlin.core.HTTPClient
 import io.mockk.every
 import io.mockk.mockk
+import io.mockk.mockkConstructor
+import io.mockk.spyk
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.test.TestCoroutineDispatcher
+import kotlinx.coroutines.test.TestCoroutineScope
 import sovran.kotlin.Store
+import java.io.ByteArrayInputStream
 import java.io.File
+import java.net.HttpURLConnection
+import kotlin.coroutines.CoroutineContext
 
 fun mockAnalytics(): Analytics {
     val mock = mockk<Analytics>(relaxed = true)
-    val mockStore = Store()
+    val scope = TestCoroutineScope()
+    val dispatcher = TestCoroutineDispatcher()
+    val mockStore = spyStore(scope, dispatcher)
     every { mock.store } returns mockStore
+    every { mock.analyticsScope } returns scope
+    every { mock.fileIODispatcher } returns dispatcher
+    every { mock.networkIODispatcher } returns dispatcher
+    every { mock.analyticsDispatcher } returns dispatcher
     return mock
 }
 
@@ -37,3 +53,23 @@ fun mockContext(): Context {
 fun clearPersistentStorage() {
     File("/tmp/analytics-android-test/").deleteRecursively()
 }
+
+fun spyStore(scope: CoroutineScope, dispatcher: CoroutineDispatcher): Store {
+    val store = spyk(Store())
+    every { store getProperty "sovranScope" } propertyType CoroutineScope::class returns scope
+    every { store getProperty "syncQueue" } propertyType CoroutineContext::class returns dispatcher
+    every { store getProperty "updateQueue" } propertyType CoroutineContext::class returns dispatcher
+    return store
+}
+
+fun mockHTTPClient() {
+    mockkConstructor(HTTPClient::class)
+    val settingsStream = ByteArrayInputStream(
+        """
+                {"integrations":{"Segment.io":{"apiKey":"1vNgUqwJeCHmqgI9S1sOm9UHCyfYqbaQ"}},"plan":{},"edgeFunction":{}}
+            """.trimIndent().toByteArray()
+    )
+    val httpConnection: HttpURLConnection = mockk()
+    val connection = object : Connection(httpConnection, settingsStream, null) {}
+    every { anyConstructed<HTTPClient>().settings("cdn-settings.segment.com/v1") } returns connection
+}

core/build.gradle

@@ -16,7 +16,7 @@ test {
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     // MAIN DEPS
-    api 'com.github.segmentio:sovran-kotlin:1.0.0'
+    api 'com.github.segmentio:sovran-kotlin:1.1.0'
     api "org.jetbrains.kotlinx:kotlinx-serialization-json:1.0.1"
     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9'