Json Utility improvements & Re-add Alias Event (#29)

* improve usage of JSON

* improve test quality

* add jvm filenames to util files

* made getters safe to use improved test code quality for JSON

* add new safe conversion functions

* update usages of jsonCast to safe conversion

Author: prayansh

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

@@ -3,6 +3,7 @@ package com.segment.analytics.kotlin.android
 import com.segment.analytics.kotlin.android.utilities.AndroidKVS
 import com.segment.analytics.kotlin.android.utils.MemorySharedPreferences
 import com.segment.analytics.kotlin.core.*
+import com.segment.analytics.kotlin.core.utilities.EncodeDefaultsJson
 import com.segment.analytics.kotlin.core.utilities.EventsFileManager
 import io.mockk.every
 import io.mockk.mockkStatic
@@ -50,7 +51,7 @@ class EventsFileTests {
                 context = emptyJsonObject
                 timestamp = epochTimestamp
             }
-        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
         file.storeEvent(eventString)
 
         val expectedContents = """{"batch":[${eventString}"""
@@ -73,7 +74,7 @@ class EventsFileTests {
                 context = emptyJsonObject
                 timestamp = epochTimestamp
             }
-        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
         file.storeEvent(eventString)
         file.storeEvent(eventString)
 
@@ -97,7 +98,7 @@ class EventsFileTests {
                 context = emptyJsonObject
                 timestamp = epochTimestamp
             }
-        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
         file.storeEvent(eventString)
         // artificially add 500kb of data to file
         FileOutputStream(File(directory, "123-0.tmp"), true).write(
@@ -134,7 +135,7 @@ class EventsFileTests {
                 context = emptyJsonObject
                 timestamp = epochTimestamp
             }
-        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
         file.storeEvent(eventString)
 
         val fileUrls = file.read()
@@ -159,7 +160,7 @@ class EventsFileTests {
                 context = emptyJsonObject
                 timestamp = epochTimestamp
             }
-        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
         file.storeEvent(eventString)
 
         file.read().let {
@@ -190,7 +191,7 @@ class EventsFileTests {
                 context = emptyJsonObject
                 timestamp = epochTimestamp
             }
-        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
 
         val file1 = EventsFileManager(directory, "123", kvStore)
         val file2 = EventsFileManager(directory, "qwerty", kvStore)
@@ -215,7 +216,7 @@ class EventsFileTests {
 //                context = emptyJsonObject
 //                timestamp = epochTimestamp
 //            }
-//        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+//        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
 //        file.storeEvent(eventString)
 //
 //        val expectedContents = """{"batch":[${eventString}"""
@@ -244,7 +245,7 @@ class EventsFileTests {
                 context = emptyJsonObject
                 timestamp = epochTimestamp
             }
-        val eventString = Json { encodeDefaults = true }.encodeToString(trackEvent)
+        val eventString = EncodeDefaultsJson.encodeToString(trackEvent)
         file.storeEvent(eventString)
 
         val list = file.read()

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

@@ -4,6 +4,7 @@ import android.content.Context
 import android.content.SharedPreferences
 import com.segment.analytics.kotlin.core.*
 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.test.TestCoroutineDispatcher
@@ -33,8 +34,7 @@ class StorageTests {
 
         @BeforeEach
         fun setup() {
-            File("/tmp/analytics-android").deleteRecursively()
-            File("/tmp/analytics-android").mkdir()
+            clearPersistentStorage()
             store.provide(
                 UserInfo(
                     anonymousId = "oldAnonId",

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

@@ -27,9 +27,13 @@ fun mockContext(): Context {
     every { mockPkgMgr.getPackageInfo("com.foo", 0) } returns packageInfo
     val mock = mockk<Context> {
         every { getSharedPreferences(any(), any()) } returns mockPrefs
-        every { getDir(any(), any()) } returns File("/tmp/analytics-android/")
+        every { getDir(any(), any()) } returns File("/tmp/analytics-android-test/")
         every { packageName } returns "com.foo"
         every { packageManager } returns mockPkgMgr
     }
     return mock
 }
+
+fun clearPersistentStorage() {
+    File("/tmp/analytics-android-test/").deleteRecursively()
+}

core/src/main/java/com/segment/analytics/kotlin/core/Analytics.kt

@@ -312,7 +312,7 @@ class Analytics(val configuration: Configuration) : Subscriber {
     ) {
         group(groupId, traits, Json.serializersModule.serializer())
     }
-/*
+
     /**
      * The alias method is used to merge two user identities, effectively connecting two sets of
      * user data as one. This is an advanced method, but it is required to manage user identities
@@ -337,7 +337,6 @@ class Analytics(val configuration: Configuration) : Subscriber {
             log("failed to fetch current UserInfo state")
         }
     }
-*/
 
     fun process(event: BaseEvent) {
         log("applying base attributes on ${Thread.currentThread().name}")

core/src/main/java/com/segment/analytics/kotlin/core/SegmentDestination.kt

@@ -4,6 +4,7 @@ import com.segment.analytics.kotlin.core.platform.DestinationPlugin
 import com.segment.analytics.kotlin.core.platform.Plugin
 import com.segment.analytics.kotlin.core.platform.plugins.LogType
 import com.segment.analytics.kotlin.core.platform.plugins.log
+import com.segment.analytics.kotlin.core.utilities.EncodeDefaultsJson
 import kotlinx.coroutines.launch
 import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
@@ -64,9 +65,7 @@ class SegmentDestination(
 
     private inline fun <reified T : BaseEvent> enqueue(payload: T) {
         // needs to be inline reified for encoding using Json
-        val jsonVal = Json {
-            encodeDefaults = true
-        }.encodeToJsonElement(payload).jsonObject.filterNot { (k, v) ->
+        val jsonVal = EncodeDefaultsJson.encodeToJsonElement(payload).jsonObject.filterNot { (k, v) ->
             // filter out empty userId and traits values
             (k == "userId" && v.jsonPrimitive.content.isBlank()) || (k == "traits" && v == emptyJsonObject)
         }

core/src/main/java/com/segment/analytics/kotlin/core/Settings.kt

@@ -4,13 +4,14 @@ import com.segment.analytics.kotlin.core.platform.DestinationPlugin
 import com.segment.analytics.kotlin.core.platform.Plugin
 import com.segment.analytics.kotlin.core.platform.plugins.LogType
 import com.segment.analytics.kotlin.core.platform.plugins.log
+import com.segment.analytics.kotlin.core.utilities.LenientJson
+import com.segment.analytics.kotlin.core.utilities.safeJsonObject
 import kotlinx.coroutines.launch
 import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.decodeFromString
 import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.JsonObject
-import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.serializer
 import java.io.BufferedReader
 
@@ -24,8 +25,8 @@ data class Settings(
         name: String,
         strategy: DeserializationStrategy<T> = Json.serializersModule.serializer()
     ): T? {
-        val integrationData = integrations[name]?.jsonObject ?: return null
-        val typedSettings = Json.decodeFromJsonElement(strategy, integrationData)
+        val integrationData = integrations[name]?.safeJsonObject ?: return null
+        val typedSettings = LenientJson.decodeFromJsonElement(strategy, integrationData)
         return typedSettings
     }
 
@@ -61,7 +62,7 @@ fun Analytics.checkSettings() {
             val settingsString =
                 connection.inputStream?.bufferedReader()?.use(BufferedReader::readText) ?: ""
             log("Fetched Settings: $settingsString")
-            Json { ignoreUnknownKeys = true }.decodeFromString(settingsString)
+            LenientJson.decodeFromString(settingsString)
         } catch (ex: Exception) {
             log(message = "${ex.message}: failed to fetch settings", type = LogType.ERROR)
             null

core/src/main/java/com/segment/analytics/kotlin/core/platform/plugins/Metrics.kt

@@ -2,11 +2,11 @@ package com.segment.analytics.kotlin.core.platform.plugins
 
 import com.segment.analytics.kotlin.core.BaseEvent
 import com.segment.analytics.kotlin.core.DateSerializer
+import com.segment.analytics.kotlin.core.utilities.EncodeDefaultsJson
 import com.segment.analytics.kotlin.core.utilities.putInContext
+import com.segment.analytics.kotlin.core.utilities.safeJsonArray
 import kotlinx.serialization.Serializable
-import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.buildJsonArray
-import kotlinx.serialization.json.jsonArray
 import java.time.Instant
 
 enum class MetricType(val type: Int) {
@@ -41,10 +41,10 @@ fun BaseEvent.addMetric(
     )
 
     val metrics = buildJsonArray {
-        context["metrics"]?.jsonArray?.forEach {
+        context["metrics"]?.safeJsonArray?.forEach {
             add(it)
         }
-        add(Json { encodeDefaults = true }.encodeToJsonElement(Metric.serializer(), metric))
+        add(EncodeDefaultsJson.encodeToJsonElement(Metric.serializer(), metric))
     }
 
     putInContext("metrics", metrics)

core/src/main/java/com/segment/analytics/kotlin/core/utilities/Base64Utils.kt

@@ -1,3 +1,4 @@
+@file:JvmName("Base64Utils")
 package com.segment.analytics.kotlin.core.utilities
 
 // Encode string to base64

core/src/main/java/com/segment/analytics/kotlin/core/utilities/EventManipulationFunctions.kt

@@ -6,7 +6,6 @@ import kotlinx.serialization.SerializationStrategy
 import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.JsonObject
 import kotlinx.serialization.json.buildJsonObject
-import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.serializer
 
 // Mark integration as enabled, for this event
@@ -60,7 +59,7 @@ fun <T : Any> BaseEvent.putInContextUnderKey(
     value: T,
     serializationStrategy: SerializationStrategy<T>
 ): BaseEvent {
-    val parent = context[parentKey]?.jsonObject ?: emptyJsonObject
+    val parent: JsonObject = context[parentKey]?.safeJsonObject ?: emptyJsonObject
     context = buildJsonObject {
         putAll(context)
         val newParent = buildJsonObject {

core/src/main/java/com/segment/analytics/kotlin/core/utilities/FileUtils.kt

@@ -1,3 +1,4 @@
+@file:JvmName("FileUtils")
 package com.segment.analytics.kotlin.core.utilities
 
 import java.io.File