Migs647/logger (#56)

* Added new Segment Logger

* Added abilitiy to predict lines and function

* Removed old metrics

* Updated API for logging

* Added unit tests for logging

* Added AndrodLogTarget

* Added performance updates

Author: migs647

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

@@ -5,10 +5,8 @@ import android.util.Log
 import com.segment.analytics.kotlin.android.plugins.AndroidContextPlugin
 import com.segment.analytics.kotlin.android.plugins.AndroidLifecyclePlugin
 import com.segment.analytics.kotlin.core.Analytics
-import com.segment.analytics.kotlin.core.BaseEvent
 import com.segment.analytics.kotlin.core.Configuration
-import com.segment.analytics.kotlin.core.platform.plugins.LogType
-import com.segment.analytics.kotlin.core.platform.plugins.Logger
+import com.segment.analytics.kotlin.core.platform.plugins.logger.*
 
 // A set of functions tailored to the Android implementation of analytics
 
@@ -54,28 +52,40 @@ public fun Analytics(
     }
 }
 
-// Logger instance that uses the android `Log` class
-object AndroidLogger : Logger() {
-    override fun log(type: LogType, message: String, event: BaseEvent?) {
-        when (type) {
-            LogType.ERROR -> {
-                Log.e("AndroidAnalyticsLogger", "message=$message, event=$event")
+// Android specific startup
+private fun Analytics.startup() {
+    add(AndroidContextPlugin())
+    add(AndroidLifecyclePlugin())
+    add(AndroidLogTarget(), LoggingType.log)
+    remove(targetType = ConsoleTarget::class)
+}
+
+class AndroidLogTarget: LogTarget {
+    override fun parseLog(log: LogMessage) {
+        var metadata = ""
+        val function = log.function
+        val line = log.line
+        if (function != null && line != null) {
+            metadata = " - $function:$line"
+        }
+
+        var eventString = ""
+        log.event.let {
+            eventString = ", event=$it"
+        }
+
+        when (log.kind) {
+            LogFilterKind.ERROR -> {
+                Log.e("AndroidLog", "message=${log.message}$eventString")
             }
-            LogType.WARNING -> {
-                Log.w("AndroidAnalyticsLogger", "message=$message, event=$event")
+            LogFilterKind.WARNING -> {
+                Log.w("AndroidLog", "message=${log.message}$eventString")
             }
-            LogType.INFO -> {
-                Log.i("AndroidAnalyticsLogger", "message=$message, event=$event")
+            LogFilterKind.DEBUG -> {
+                Log.d("AndroidLog", "message=${log.message}$eventString")
             }
         }
     }
 
-    override fun flush() {}
-}
-
-// Android specific startup
-private fun Analytics.startup() {
-    add(AndroidLogger)
-    add(AndroidContextPlugin())
-    add(AndroidLifecyclePlugin())
+    override fun flush() { }
 }

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

@@ -8,7 +8,7 @@ class TestRunPlugin(var closure: (BaseEvent?) -> Unit): EventPlugin {
     override lateinit var analytics: Analytics
     var ran = false
 
-    fun reset() {
+    override fun reset() {
         ran = false
     }
 

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

@@ -1,13 +1,14 @@
 package com.segment.analytics.kotlin.core
 
 import com.segment.analytics.kotlin.core.platform.DestinationPlugin
+import com.segment.analytics.kotlin.core.platform.EventPlugin
 import com.segment.analytics.kotlin.core.platform.Plugin
 import com.segment.analytics.kotlin.core.platform.Timeline
 import com.segment.analytics.kotlin.core.platform.plugins.ContextPlugin
 import com.segment.analytics.kotlin.core.platform.plugins.SegmentDestination
 import com.segment.analytics.kotlin.core.platform.plugins.StartupQueue
-import com.segment.analytics.kotlin.core.platform.plugins.log
 import kotlinx.coroutines.*
+import com.segment.analytics.kotlin.core.platform.plugins.logger.*
 import kotlinx.serialization.DeserializationStrategy
 import kotlinx.serialization.SerializationStrategy
 import kotlinx.serialization.json.Json
@@ -40,6 +41,12 @@ class Analytics internal constructor(
 
     internal val timeline: Timeline
     val storage: Storage
+    companion object {
+        var debugLogsEnabled: Boolean = false
+            set(value: Boolean) {
+                SegmentLog.loggingEnabled = value
+            }
+    }
 
     init {
         require(configuration.isValid()) { "invalid configuration" }
@@ -65,6 +72,7 @@ class Analytics internal constructor(
     // Initiates the initial call to settings and adds default system plugins
     internal fun build() {
         // because startup queue doesn't depend on a state, we can add it first
+        add(SegmentLog())
         add(StartupQueue())
         add(ContextPlugin())
 
@@ -402,7 +410,7 @@ class Analytics internal constructor(
 
     fun flush() {
         this.timeline.applyClosure {
-            (it as? DestinationPlugin)?.flush()
+            (it as? EventPlugin)?.flush()
         }
     }
 

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

@@ -2,8 +2,7 @@ package com.segment.analytics.kotlin.core
 
 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.platform.plugins.logger.*
 import com.segment.analytics.kotlin.core.utilities.LenientJson
 import com.segment.analytics.kotlin.core.utilities.safeJsonObject
 import kotlinx.coroutines.withContext
@@ -68,10 +67,10 @@ suspend fun Analytics.checkSettings() {
             val connection = HTTPClient(writeKey).settings(cdnHost)
             val settingsString =
                 connection.inputStream?.bufferedReader()?.use(BufferedReader::readText) ?: ""
-            log("Fetched Settings: $settingsString")
+            log( "Fetched Settings: $settingsString")
             LenientJson.decodeFromString(settingsString)
         } catch (ex: Exception) {
-            log(message = "${ex.message}: failed to fetch settings", type = LogType.ERROR)
+            Analytics.segmentLog("${ex.message}: failed to fetch settings", kind = LogFilterKind.ERROR)
             null
         }
 

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

@@ -1,8 +1,7 @@
 package com.segment.analytics.kotlin.core.platform
 
 import com.segment.analytics.kotlin.core.*
-import com.segment.analytics.kotlin.core.platform.plugins.LogType
-import com.segment.analytics.kotlin.core.platform.plugins.log
+import com.segment.analytics.kotlin.core.platform.plugins.logger.*
 import kotlinx.coroutines.*
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.channels.Channel.Factory.UNLIMITED
@@ -80,7 +79,7 @@ internal class EventPipeline(
                 storage.write(Storage.Constants.Events, event)
             }
             catch (e : Exception) {
-                analytics.log("Error adding payload: $event", type = LogType.ERROR)
+                Analytics.segmentLog("Error adding payload: $event", kind = LogFilterKind.ERROR)
             }
 
             // if flush condition met, generate paths
@@ -151,25 +150,25 @@ internal class EventPipeline(
             analytics.log("$logTag exception while uploading, ${e.message}")
             if (e.is4xx() && e.responseCode != 429) {
                 // Simply log and proceed to remove the rejected payloads from the queue.
-                analytics.log(
+                Analytics.segmentLog(
                     message = "Payloads were rejected by server. Marked for removal.",
-                    type = LogType.ERROR
+                    kind = LogFilterKind.ERROR
                 )
                 shouldCleanup = true
             } else {
-                analytics.log(
+                Analytics.segmentLog(
                     message = "Error while uploading payloads",
-                    type = LogType.ERROR
+                    kind = LogFilterKind.ERROR
                 )
             }
         }
         else {
-            analytics.log(
+            Analytics.segmentLog(
                 """
                     | Error uploading events from batch file
                     | fileUrl="${file.path}"
                     | msg=${e.message}
-                """.trimMargin(), type = LogType.ERROR
+                """.trimMargin(), kind = LogFilterKind.ERROR
             )
             e.printStackTrace()
         }

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

@@ -27,7 +27,7 @@ interface Plugin {
     val type: Type
     var analytics: Analytics // ideally will be auto-assigned by setup(), and can be declared as lateinit
 
-    // A simple setup function thats executed when plugin is attached to analytics
+    // A simple setup function that's executed when plugin is attached to analytics
     // If overridden, ensure that super.setup() is invoked
     fun setup(analytics: Analytics) {
         this.analytics = analytics
@@ -64,6 +64,10 @@ interface EventPlugin : Plugin {
     fun alias(payload: AliasEvent): BaseEvent? {
         return payload
     }
+
+    open fun flush() {}
+
+    open fun reset() {}
 }
 
 // Basic interface for device-mode destinations. Allows overriding track, identify, screen, group, alias, flush and reset
@@ -132,8 +136,4 @@ abstract class DestinationPlugin : EventPlugin {
     final override fun execute(event: BaseEvent): BaseEvent? {
         return null
     }
-
-    open fun flush() {}
-
-    open fun reset() {}
 }

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

@@ -5,6 +5,7 @@ import com.segment.analytics.kotlin.core.Constants.DEFAULT_API_HOST
 import com.segment.analytics.kotlin.core.platform.DestinationPlugin
 import com.segment.analytics.kotlin.core.platform.EventPipeline
 import com.segment.analytics.kotlin.core.platform.Plugin
+import com.segment.analytics.kotlin.core.platform.plugins.logger.*
 import com.segment.analytics.kotlin.core.utilities.EncodeDefaultsJson
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.encodeToString

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

@@ -6,6 +6,7 @@ import com.segment.analytics.kotlin.core.System
 import com.segment.analytics.kotlin.core.platform.Plugin
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
+import com.segment.analytics.kotlin.core.platform.plugins.logger.*
 import sovran.kotlin.Subscriber
 import java.util.Queue
 import java.util.concurrent.ConcurrentLinkedQueue
@@ -40,7 +41,7 @@ class StartupQueue : Plugin, Subscriber {
 
     override fun execute(event: BaseEvent): BaseEvent? {
         if (!started.get()) {
-            analytics.log("SegmentStartupQueue queueing event", event = event)
+            analytics.log("SegmentStartupQueue queueing event")
             // timeline hasn't started, so queue it up.
             if (queuedEvents.size >= maxSize) {
                 // if we've exceeded the max queue size start dropping events