Refactor plugin interface and update apis (#19)

* disable destination based on settings

* revert Main.kt

* update README.md

* remove `name` prop from plugin, change `name` to key in DestinationPlugin, refactor find/remove plugin apis

* update webhook plugin and AmplitudeSession plugin

* fix tests

Author: prayansh

README.md

@@ -105,7 +105,6 @@ JVM
 ```kotlin
 Analytics("SEGMENT_API_KEY") {
     collectDeviceId = true
-    recordScreenViews = true
     trackApplicationLifecycleEvents = true
     trackDeepLinks = true
     flushAt = 1
@@ -115,7 +114,6 @@ Analytics("SEGMENT_API_KEY") {
 Analytics(Configuration (
     writeKey = "123",
     collectDeviceId = true,
-    recordScreenViews = true,
     trackApplicationLifecycleEvents = true,
     trackDeepLinks = true,
     flushAt = 1,
@@ -132,7 +130,6 @@ Analytics(Configuration (
 | ioDispatcher | `Dispatchers.IO` |  Dispatcher running IO tasks |
 | storageProvider | `ConcreteStorageProvider` |  Provider for storage class, generally do not want to modify |
 | collectDeviceId | `false` |  automatically collect deviceId |
-| recordScreenViews | `false` |  automatically trigger screen events on Activity Start |
 | trackApplicationLifecycleEvents | `false` |  automatically track Lifecycle events |
 | trackDeepLinks | `false` |  automatically track [Deep link](https://developer.android.com/training/app-links/deep-linking) opened based on intents |
 | useLifecycleObserver | `false` |  enables the use of LifecycleObserver to track Application lifecycle events |
@@ -200,7 +197,7 @@ analytics.screen("ScreenName", buildJsonObject {
     put("productSlug", "example-product-123")
 });
 ```
-You can enable automatic screen tracking using the Config option `autoRecordScreenViews = true`
+You can also opt-into auto screen tracking by adding this [plugin](https://github.com/segmentio/analytics-kotlin/blob/main/samples/kotlin-android-app/src/main/java/com/segment/analytics/next/plugins/AndroidRecordScreenPlugin.kt)
 
 ### group
 The group API call is how you associate an individual user with a group—be it a company, organization, account, project, team or whatever other crazy name you came up with for the same concept! This includes a unique group ID and any optional group traits you know about them like the company name industry, number of employees, etc. The traits option can include any information you might want to tie to the group, but when using any of the reserved group traits, you should make sure to only use them for their intended meaning.

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

@@ -67,7 +67,7 @@ public fun Analytics(
 }
 
 // Logger instance that uses the android `Log` class
-object AndroidLogger : Logger("AndroidLogger") {
+object AndroidLogger : Logger() {
     override fun log(type: LogType, message: String, event: BaseEvent?) {
         when (type) {
             LogType.ERROR -> {

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

@@ -29,7 +29,6 @@ import java.lang.System as JavaSystem
 // Plugin that applies context related changes. Auto-added to system on build
 class AndroidContextPlugin : Plugin {
     override val type: Plugin.Type = Plugin.Type.Before
-    override val name: String = "AndroidContextCollector"
     override lateinit var analytics: Analytics
     private lateinit var context: Context
     private lateinit var storage: Storage

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

@@ -28,7 +28,6 @@ class AndroidLifecyclePlugin() : Application.ActivityLifecycleCallbacks, Default
     Plugin {
 
     override val type: Plugin.Type = Plugin.Type.Utility
-    override val name: String = "AnalyticsActivityLifecycleCallbacks"
     override lateinit var analytics: Analytics
     private lateinit var packageInfo: PackageInfo
     private lateinit var application: Application

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

@@ -83,7 +83,6 @@ class AndroidLifecyclePluginTests {
         var invokedSaveInstance = false
         val test = object : Plugin, AndroidLifecycle {
             override val type: Plugin.Type = Plugin.Type.Utility
-            override val name: String = "TestPlugin"
             override lateinit var analytics: Analytics
 
             override fun onActivityCreated(activity: Activity?, savedInstanceState: Bundle?) {

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

@@ -3,7 +3,7 @@ package com.segment.analytics.kotlin.android.utils
 import com.segment.analytics.kotlin.core.*
 import com.segment.analytics.kotlin.core.platform.*
 
-class TestRunPlugin(override val name: String = "TestRunPlugin", var closure: (BaseEvent?) -> Unit): EventPlugin {
+class TestRunPlugin(var closure: (BaseEvent?) -> Unit): EventPlugin {
     override val type: Plugin.Type = Plugin.Type.Before
     override lateinit var analytics: Analytics
     var ran = false
@@ -48,7 +48,7 @@ class TestRunPlugin(override val name: String = "TestRunPlugin", var closure: (B
     }
 }
 
-class StubPlugin(override val name: String = "StubPlugin") : EventPlugin {
+class StubPlugin : EventPlugin {
     override val type: Plugin.Type = Plugin.Type.Before
     override lateinit var analytics: Analytics
 }

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

@@ -18,6 +18,7 @@ import kotlinx.serialization.json.jsonObject
 import kotlinx.serialization.serializer
 import sovran.kotlin.Store
 import sovran.kotlin.Subscriber
+import kotlin.reflect.KClass
 
 class Analytics(val configuration: Configuration) : Subscriber {
 
@@ -355,30 +356,29 @@ class Analytics(val configuration: Configuration) : Subscriber {
      */
     fun add(plugin: Plugin): Analytics {
         this.timeline.add(plugin)
-        if (plugin is DestinationPlugin && plugin.name != "Segment.io") {
+        if (plugin is DestinationPlugin && plugin !is SegmentDestination) {
             analyticsScope.launch(ioDispatcher) {
-                store.dispatch(System.AddIntegrationAction(plugin.name), System::class)
+                store.dispatch(System.AddIntegrationAction(plugin.key), System::class)
             }
         }
         return this
     }
 
     /**
-     * Retrieve a registered plugin by name
-     * @param pluginName [String]
+     * Retrieve a registered plugin by reference
+     * @param plugin [Plugin]
      */
-    fun find(pluginName: String): Plugin? = this.timeline.find(pluginName)
+    fun <T: Plugin> find(plugin: KClass<T>): T? = this.timeline.find(plugin)
 
     /**
      * Remove a plugin from the analytics timeline using its name
      * @param pluginName [Plugin] to be remove
      */
-    fun remove(pluginName: String): Analytics {
-        val pluginToRemove = find(pluginName)
-        this.timeline.remove(pluginName)
-        if (pluginToRemove is DestinationPlugin && pluginToRemove.name != "Segment.io") {
+    fun remove(plugin: Plugin): Analytics {
+        this.timeline.remove(plugin)
+        if (plugin is DestinationPlugin && plugin !is SegmentDestination) {
             analyticsScope.launch(ioDispatcher) {
-                store.dispatch(System.RemoveIntegrationAction(pluginToRemove.name), System::class)
+                store.dispatch(System.RemoveIntegrationAction(plugin.key), System::class)
             }
         }
         return this

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

@@ -30,7 +30,7 @@ class SegmentDestination(
     private var apiHost: String = "api.segment.io/v1"
 ) : DestinationPlugin() {
 
-    override val name: String = "Segment.io"
+    override val key: String = "Segment.io"
     internal val httpClient: HTTPClient = HTTPClient()
     internal lateinit var storage: Storage
     lateinit var flushScheduler: ScheduledExecutorService
@@ -71,7 +71,7 @@ class SegmentDestination(
         }
 
         val stringVal = Json.encodeToString(jsonVal)
-        analytics.log("$name running $stringVal")
+        analytics.log("$key running $stringVal")
         try {
             storage.write(Storage.Constants.Events, stringVal)
             if (eventCount.incrementAndGet() >= flushCount) {
@@ -108,7 +108,7 @@ class SegmentDestination(
     }
 
     override fun update(settings: Settings) {
-        settings.integrations[name]?.jsonObject?.let {
+        settings.integrations[key]?.jsonObject?.let {
             apiKey = it["apiKey"]?.jsonPrimitive?.content ?: apiKey
             apiHost = it["apiHost"]?.jsonPrimitive?.content ?: apiHost
         }
@@ -126,7 +126,7 @@ class SegmentDestination(
         if (eventCount.get() < 1) {
             return
         }
-        analytics.log("$name performing flush")
+        analytics.log("$key performing flush")
         val fileUrls = parseFilePaths(storage.read(Storage.Constants.Events))
         if (fileUrls.isEmpty()) {
             analytics.log("No events to upload")
@@ -153,9 +153,9 @@ class SegmentDestination(
                 }
                 // Cleanup uploaded payloads
                 storage.removeFile(fileUrl)
-                analytics.log("$name uploaded $fileUrl")
+                analytics.log("$key uploaded $fileUrl")
             } catch (e: HTTPException) {
-                analytics.log("$name exception while uploading, ${e.message}")
+                analytics.log("$key 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(

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

@@ -1,5 +1,6 @@
 package com.segment.analytics.kotlin.core
 
+import com.segment.analytics.kotlin.core.platform.DestinationPlugin
 import com.segment.analytics.kotlin.core.platform.plugins.LogType
 import com.segment.analytics.kotlin.core.platform.plugins.log
 import kotlinx.coroutines.launch
@@ -34,6 +35,9 @@ data class Settings(
 
 internal fun Analytics.update(settings: Settings) {
     timeline.applyClosure { plugin ->
+        if (plugin is DestinationPlugin) {
+            plugin.enabled = settings.isDestinationEnabled(plugin.key)
+        }
         // tell all top level plugins to update.
         // For destination plugins they auto-handle propagation to sub-plugins
         plugin.update(settings)

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

@@ -6,6 +6,7 @@ import com.segment.analytics.kotlin.core.GroupEvent
 import com.segment.analytics.kotlin.core.IdentifyEvent
 import com.segment.analytics.kotlin.core.ScreenEvent
 import com.segment.analytics.kotlin.core.TrackEvent
+import kotlin.reflect.KClass
 
 // Platform abstraction for managing plugins' execution (of a specific type)
 // All operations are thread safe via the `synchronized` function
@@ -15,8 +16,8 @@ internal class Mediator(internal val plugins: MutableList<Plugin>) {
         plugins.add(plugin)
     }
 
-    fun remove(pluginName: String) = synchronized(plugins) {
-        plugins.removeAll { it.name == pluginName }
+    fun remove(plugin: Plugin) = synchronized(plugins) {
+        plugins.removeAll { it === plugin } // remove only if reference is the same
     }
 
     fun execute(event: BaseEvent): BaseEvent? = synchronized(plugins) {
@@ -62,10 +63,10 @@ internal class Mediator(internal val plugins: MutableList<Plugin>) {
         }
     }
 
-    fun find(pluginName: String): Plugin? = synchronized(plugins) {
+    fun <T: Plugin> find(pluginClass: KClass<T>): T? = synchronized(plugins) {
         plugins.forEach {
-            if (it.name == pluginName) {
-                return it
+            if (it::class == pluginClass) {
+                return it as T
             }
         }
         return null