Mixpanel + Firebase Refactor (#43)

* refactor firebase destination

* refactor mixpanel destination

* cleanup dependency lists

* update kotlin version

* update readme

* update circle config

* resolve PR comments

Author: prayansh

.circleci/config.yml

@@ -19,8 +19,14 @@ jobs:
             - ~/.gradle
           key: jars-{{ checksum "build.gradle" }}-{{ checksum  "samples/kotlin-android-app/build.gradle" }}-{{ checksum  "samples/java-android-app/build.gradle" }}
       - run:
-          name: Run Tests
-          command: ./gradlew lint test
+          name: Run Core Tests
+          command: ./gradlew core:test
+      - run:
+          name: Run Android Tests
+          command: ./gradlew android:test
+      - run:
+          name: Run Sample Destination Tests
+          command: ./gradlew samples:kotlin-android-app-destinations:test
       - run:
           name: Snyk
           command: curl -sL https://raw.githubusercontent.com/segmentio/snyk_helpers/master/initialization/snyk.sh | sh

build.gradle

@@ -1,6 +1,6 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 buildscript {
-    ext.kotlin_version = "1.4.10"
+    ext.kotlin_version = "1.5.30"
     ext.writeKey = "hAh3QxoRCsQsnyabTLMpWbpxoIN4O2mU"
     repositories {
         google()

samples/kotlin-android-app-destinations/README.md

@@ -2,50 +2,17 @@
 This is a sample android app that uses the `analytics-kotlin` library and the new `Plugins` concepts. It is meant to be simplistic, and easy to understand all the while showcasing the power of the analytics-kotlin library
 
 ## Plugins
-- Android AdvertisingId Plugin
-Using the `play-services-ads` library this plugin adds the `advertisingId` to all payloads (under the `context` key) going through the analytics timeline
+- [Amplitude Session](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/AmplitudeSession.kt)
+Sample plugin to enable users to enrich data for the Amplitude Actions destination
 
-- Android Record Screen Plugin
-Using the application lifecycle, this plugin automatically sends `Screen` events through the analytics timeline, on Activity start
+- [Firebase](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/FirebaseDestination.kt)
+Sample plugin to enable users to send data to the device-mode Firebase destination 
 
-- Consent Tracking
-Presents user with a dialog to consent to tracking. If consent is given, any queued events will be sent out to the analytics timeline. If consent is not given, all queued events and future events will be dropped
-** Note: You will have to switch to the `ConsentActivity` inside of AndroidManifest.xml to view this feature **
+- [Intercom](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/IntercomDestination.kt)
+Sample plugin to enable users to send data to the device-mode Intercom destination
 
-- Webhook Plugin
-A destination plugin that allows you to send the event from the analytics timeline to a webhook of your choice. Ideal for debugging payloads in an internal network.
+- [Mixpanel](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/MixpanelDestination.kt)
+Sample plugin to enable users to send data to the device-mode Mixpanel destination
 
-## Tracking Deep Links
-The sample app is configured to open links with the schema and hostname `https://segment-sample.com`
-
-Here is how you can do it via adb
-```bash
-adb shell am start -W -a android.intent.action.VIEW -d "https://segment-sample.com?utm_source=cli\&utm_click=2" com.segment.analytics.next
-```
-
-## FCM
-This project is setup to track push notification received and opened events. This code is strictly optional and must be customized as per your needs. The code here is only for demonstration purposes
-### Setup
-- Add your FCM project's `google-services.json` to this folder
-- Modify `MyFirebaseService.kt` to customize the notification displayed to the user.
-- Here is how to send a push notification using cURL [this uses the legacy api](https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-using-the-legacy-app-server-protocols)
-```bash
-curl --request POST \
-  --url https://fcm.googleapis.com/fcm/send \
-  --header 'Authorization: key=<SERVER_KEY>' \
-  --header 'Content-Type: application/json' \
-  --data '{
-	"data": {
-		"title": "Hello World"
-		"content": "You have mail",
-	},
-	"to": "<FCM_TOKEN_FOR_DEVICE>"
-}'
-```
-
-### How it works
-- We have 2 core changes
-  - MyFirebaseService.kt
-  The core component to handle FCM push messages. This is responsible for handling the incoming message and assigning the intents for the notification. It is also responsible for firing the `Push Notification Received` event.
-  - PushNotificationTracking.kt
-  The analytics plugin responsible for firing the "Push Notification Tapped" event. This is a lifecycle plugin that will be invoked for any Activity onCreate.
+- [Webhook Plugin](https://github.com/segmentio/analytics-kotlin/blob/master/samples/kotlin-android-app-destinations/src/main/java/com/segment/analytics/destinations/plugins/WebhookPlugin.kt)
+An after plugin that allows you to send the event from the analytics timeline to a webhook of your choice. Ideal for debugging payloads in an internal network.

samples/kotlin-android-app-destinations/build.gradle

@@ -28,55 +28,72 @@ android {
         }
     }
     compileOptions {
+        coreLibraryDesugaringEnabled true
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
     kotlinOptions {
         jvmTarget = '1.8'
     }
     testOptions {
+        unitTests.returnDefaultValues = true
+        unitTests.includeAndroidResources = true
         unitTests.all {
             useJUnitPlatform()
         }
     }
 }
 
 dependencies {
+    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.5'
 
+    implementation project(':android')
+    implementation 'androidx.multidex:multidex:2.0.1'
+
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+    implementation 'androidx.core:core-ktx:1.6.0'
+    implementation 'androidx.appcompat:appcompat:1.3.1'
+    implementation 'com.google.android.material:material:1.4.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.0'
+
+    implementation 'androidx.lifecycle:lifecycle-process:2.3.1'
+    implementation 'androidx.lifecycle:lifecycle-common-java8:2.3.1'
+}
+
+// Partner Dependencies
+dependencies {
     // Mixpanel
     api 'com.mixpanel.android:mixpanel-android:5.8.7'
 
     // Firebase
     implementation platform('com.google.firebase:firebase-bom:28.2.1')
-    // Declare the dependency for the Analytics library
-    // When using the BoM, you don't specify versions in Firebase library dependencies
     implementation 'com.google.firebase:firebase-analytics-ktx'
 
     // Intercom
     implementation 'io.intercom.android:intercom-sdk-base:10.1.1'
     implementation 'io.intercom.android:intercom-sdk-fcm:10.1.1'
+}
 
-    implementation project(':android')
-
-    implementation 'androidx.multidex:multidex:2.0.1'
+// Test Dependencies
+dependencies {
+    testImplementation 'junit:junit:4.+'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
+    testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.3.2'
 
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9'
-    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
+    testImplementation 'io.mockk:mockk:1.10.6'
+    testImplementation(platform("org.junit:junit-bom:5.7.2"))
+    testImplementation("org.junit.jupiter:junit-jupiter")
 
-    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-    implementation 'androidx.core:core-ktx:1.3.2'
-    implementation 'androidx.appcompat:appcompat:1.2.0'
-    implementation 'com.google.android.material:material:1.3.0'
-    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
+    // Add Roboelectric dependencies.
+    testImplementation 'org.robolectric:robolectric:4.5'
+    testImplementation 'androidx.test:core:1.3.0'
 
-    implementation 'androidx.lifecycle:lifecycle-process:2.3.1'
-    implementation 'androidx.lifecycle:lifecycle-common-java8:2.3.1'
+    // Add JUnit4 legacy dependencies.
+    testImplementation 'junit:junit:4.13.2'
+    testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.7.0'
 
-    testImplementation 'io.mockk:mockk:1.10.6'
-    testImplementation 'junit:junit:4.+'
-    testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.3.2'
-    testImplementation platform("org.junit:junit-bom:5.7.2")
-    testImplementation "org.junit.jupiter:junit-jupiter"
-    androidTestImplementation 'androidx.test.ext:junit:1.1.1'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
+    // For JSON Object testing
+    testImplementation 'org.json:json:20180813'
+    testImplementation 'org.skyscreamer:jsonassert:1.5.0'
 }