feat: Move Mixpanel metrics to tools:analytics (#2086)

buildSrc/src/main/kotlin/Dependencies.kt

@@ -45,6 +45,8 @@ object Dependencies {
 
     const val PROGUARD = "com.guardsquare:proguard-gradle:${Versions.PROGUARD}"
 
+    const val JSON = "org.json:json:${Versions.JSON}"
+
     //region Test Dependencies
     const val JSOUP = "org.jsoup:jsoup:${Versions.JSOUP}"
     const val JUNIT = "junit:junit:${Versions.JUNIT}"

buildSrc/src/main/kotlin/Versions.kt

@@ -98,6 +98,9 @@ object Versions {
     // https://github.com/Guardsquare/proguard
     const val PROGUARD = "7.1.0"
 
+    // https://mvnrepository.com/artifact/org.json/json
+    const val JSON = "20210307"
+
     // ============== flank-scripts ==============
     const val KOTLIN_SERIALIZATION = "1.2.2"
     const val ARCHIVE_LIB = "1.1.0"

common/build.gradle.kts

@@ -15,6 +15,7 @@ tasks.withType<KotlinCompile> { kotlinOptions.jvmTarget = "1.8" }
 dependencies {
     api(Dependencies.Fuel.CORE)
     api(Dependencies.ARCHIVE_LIB)
+    api(Dependencies.JSON)
 
     testImplementation(Dependencies.JUNIT)
     testImplementation(Dependencies.MOCKK)

common/src/main/kotlin/flank/common/Json.kt

@@ -0,0 +1,5 @@
+package flank.common
+
+import org.json.JSONObject
+
+fun Map<*, *>.toJSONObject() = JSONObject(this)

corellium/domain/build.gradle.kts

@@ -26,6 +26,8 @@ dependencies {
     api(project(":tool:instrument:log"))
     api(project(":tool:junit"))
     api(project(":tool:log"))
+    api(project(":tool:analytics"))
+    api(project(":tool:analytics:mixpanel"))
 
     testImplementation(Dependencies.JUNIT)
     testImplementation(project(":corellium:adapter"))

settings.gradle.kts

@@ -21,7 +21,6 @@ include(
     ":corellium:adapter",
     ":corellium:client",
     ":corellium:sandbox",
-
     ":tool:apk",
     ":tool:config",
     ":tool:filter",
@@ -35,6 +34,9 @@ include(
     ":tool:log",
     ":tool:log:format",
     ":tool:execution:parallel",
+    ":tool:execution:synchronized",
+    ":tool:analytics",
+    ":tool:analytics:mixpanel",
     ":tool:execution:linear",
 )
 

test_runner/build.gradle.kts

@@ -212,6 +212,9 @@ dependencies {
 
     implementation(project(":corellium:cli"))
 
+    implementation(project(":tool:analytics"))
+    implementation(project(":tool:analytics:mixpanel"))
+
     testImplementation(Dependencies.JUNIT)
     testImplementation(Dependencies.SYSTEM_RULES)
     testImplementation(Dependencies.TRUTH)

test_runner/src/main/kotlin/ftl/adapter/google/GoogleTestMatrixAdapter.kt

@@ -3,7 +3,7 @@ package ftl.adapter.google
 import com.google.testing.model.FileReference
 import com.google.testing.model.TestExecution
 import com.google.testing.model.TestMatrix
-import ftl.analytics.toJSONObject
+import flank.common.toJSONObject
 import ftl.api.TestMatrix.Data
 import ftl.api.TestMatrix.Outcome
 import ftl.api.TestMatrix.SuiteOverview

test_runner/src/main/kotlin/ftl/analytics/InitUsageStatistics.kt

@@ -0,0 +1,16 @@
+package ftl.analytics
+
+import flank.tool.analytics.mixpanel.initializeStatisticsClient
+import ftl.args.AndroidArgs
+import ftl.args.IArgs
+import ftl.args.IosArgs
+import ftl.util.isGoogleAnalyticsDisabled
+
+internal fun IArgs.initUsageStatistics() {
+    initializeStatisticsClient(
+        disableUsageStatistics || isGoogleAnalyticsDisabled(flank.common.userHome),
+        AndroidArgs::class,
+        IosArgs::class,
+        IArgs::class
+    )
+}

test_runner/src/main/kotlin/ftl/analytics/SendAppId.kt

@@ -0,0 +1,17 @@
+package ftl.analytics
+
+import flank.tool.analytics.mixpanel.ANDROID
+import flank.tool.analytics.mixpanel.APP_ID
+import flank.tool.analytics.mixpanel.DEVICE_TYPE
+import flank.tool.analytics.mixpanel.IOS
+import flank.tool.analytics.mixpanel.sendConfiguration
+import ftl.args.AndroidArgs
+import ftl.args.IArgs
+
+fun IArgs.sendAppId(appId: String) {
+    initUsageStatistics()
+    when (this) {
+        is AndroidArgs -> sendConfiguration(project, mapOf(APP_ID to appId, DEVICE_TYPE to ANDROID), eventName = APP_ID)
+        else -> sendConfiguration(project, mapOf(APP_ID to appId, DEVICE_TYPE to IOS), eventName = APP_ID)
+    }
+}

test_runner/src/main/kotlin/ftl/analytics/SendConfiguration.kt

@@ -0,0 +1,33 @@
+package ftl.analytics
+
+import com.google.common.annotations.VisibleForTesting
+import flank.tool.analytics.mixpanel.filterSensitiveValues
+import flank.tool.analytics.mixpanel.objectToMap
+import flank.tool.analytics.mixpanel.removeNotNeededKeys
+import flank.tool.analytics.mixpanel.sendConfiguration
+import ftl.args.AndroidArgs
+import ftl.args.IArgs
+import ftl.args.IosArgs
+
+fun AndroidArgs.sendConfiguration() {
+    initUsageStatistics()
+    sendConfiguration(project = project, events = createEventMap())
+}
+
+internal fun AndroidArgs.createEventMap() =
+    toArgsMap().plus(commonArgs.toArgsMap()).removeNotNeededKeys().filterSensitiveValues()
+
+fun IosArgs.sendConfiguration() {
+    initUsageStatistics()
+    sendConfiguration(project = project, events = createEventMap())
+}
+
+private fun IosArgs.createEventMap() =
+    toArgsMap().plus(commonArgs.toArgsMap()).removeNotNeededKeys().filterSensitiveValues()
+
+private fun IArgs.toArgsMap() = objectToMap().filterNonCommonArgs()
+
+@VisibleForTesting
+internal fun Map<String, Any>.filterNonCommonArgs() = filter { it.key != COMMON_ARGS }
+
+private const val COMMON_ARGS = "commonArgs"

test_runner/src/main/kotlin/ftl/args/AndroidArgs.kt

@@ -1,7 +1,7 @@
 package ftl.args
 
-import ftl.analytics.AnonymizeInStatistics
-import ftl.analytics.IgnoreInStatistics
+import flank.tool.analytics.AnonymizeInStatistics
+import flank.tool.analytics.IgnoreInStatistics
 import ftl.api.ShardChunks
 import ftl.args.yml.AppTestPair
 import ftl.args.yml.Type

test_runner/src/main/kotlin/ftl/args/IArgs.kt

@@ -3,8 +3,8 @@ package ftl.args
 import flank.common.OutputLogLevel
 import flank.common.config.isTest
 import flank.common.setLogLevel
-import ftl.analytics.AnonymizeInStatistics
-import ftl.analytics.IgnoreInStatistics
+import flank.tool.analytics.AnonymizeInStatistics
+import flank.tool.analytics.IgnoreInStatistics
 import ftl.args.yml.Type
 import ftl.config.Device
 import ftl.config.common.CommonFlankConfig.Companion.defaultLocalResultsDir

test_runner/src/main/kotlin/ftl/args/IosArgs.kt

@@ -2,7 +2,7 @@ package ftl.args
 
 import com.fasterxml.jackson.annotation.JsonIgnore
 import com.google.common.annotations.VisibleForTesting
-import ftl.analytics.AnonymizeInStatistics
+import flank.tool.analytics.AnonymizeInStatistics
 import ftl.args.yml.Type
 import ftl.ios.xctest.XcTestRunData
 import ftl.ios.xctest.calculateXcTestRunData

test_runner/src/main/kotlin/ftl/domain/RunTestAndroid.kt

@@ -1,10 +1,11 @@
 package ftl.domain
 
 import flank.common.logLn
-import ftl.analytics.FIREBASE
-import ftl.analytics.FLANK_VERSION
-import ftl.analytics.FLANK_VERSION_PROPERTY
-import ftl.analytics.TEST_PLATFORM
+import flank.tool.analytics.mixpanel.FIREBASE
+import flank.tool.analytics.mixpanel.FLANK_VERSION
+import flank.tool.analytics.mixpanel.FLANK_VERSION_PROPERTY
+import flank.tool.analytics.mixpanel.TEST_PLATFORM
+import flank.tool.analytics.mixpanel.sendConfiguration
 import ftl.analytics.sendConfiguration
 import ftl.args.createAndroidArgs
 import ftl.args.setupLogLevel
@@ -60,8 +61,13 @@ operator fun RunTestAndroid.invoke() {
             DEVICE_SYSTEM to "android",
             TEST_TYPE to type?.name.orEmpty()
         )
+
         sendConfiguration()
-        sendConfiguration(mapOf(FLANK_VERSION_PROPERTY to readVersion(), TEST_PLATFORM to FIREBASE), eventName = FLANK_VERSION)
+        sendConfiguration(
+            project,
+            mapOf(FLANK_VERSION_PROPERTY to readVersion(), TEST_PLATFORM to FIREBASE),
+            eventName = FLANK_VERSION
+        )
     }.validate().also { args ->
         runBlocking {
             if (dumpShards)

test_runner/src/main/kotlin/ftl/domain/RunTestIos.kt

@@ -1,8 +1,11 @@
 package ftl.domain
 
 import flank.common.logLn
-import ftl.analytics.FLANK_VERSION
-import ftl.analytics.FLANK_VERSION_PROPERTY
+import flank.tool.analytics.mixpanel.FIREBASE
+import flank.tool.analytics.mixpanel.FLANK_VERSION
+import flank.tool.analytics.mixpanel.FLANK_VERSION_PROPERTY
+import flank.tool.analytics.mixpanel.TEST_PLATFORM
+import flank.tool.analytics.mixpanel.sendConfiguration
 import ftl.analytics.sendConfiguration
 import ftl.args.createIosArgs
 import ftl.args.setupLogLevel
@@ -58,8 +61,14 @@ operator fun RunIosTest.invoke() {
             DEVICE_SYSTEM to "ios",
             TEST_TYPE to type?.name.orEmpty()
         )
+
         sendConfiguration()
-        sendConfiguration(mapOf(FLANK_VERSION_PROPERTY to readVersion()), eventName = FLANK_VERSION)
+        sendConfiguration(
+            project,
+            mapOf(FLANK_VERSION_PROPERTY to readVersion(), TEST_PLATFORM to FIREBASE),
+            eventName = FLANK_VERSION
+        )
+
         if (dumpShards.not()) logLn(this)
     }.validate().run {
         if (dumpShards) dumpShards()

test_runner/src/main/kotlin/ftl/mock/MockServer.kt

@@ -41,7 +41,7 @@ import com.google.testing.model.TestExecution
 import com.google.testing.model.TestMatrix
 import com.google.testing.model.ToolResultsExecution
 import com.google.testing.model.ToolResultsStep
-import ftl.analytics.objectToMap
+import flank.tool.analytics.mixpanel.objectToMap
 import ftl.client.google.run.toClientInfoDetailList
 import ftl.config.FtlConstants
 import ftl.config.FtlConstants.JSON_FACTORY

test_runner/src/main/kotlin/ftl/reports/CostReport.kt

@@ -1,16 +1,12 @@
 package ftl.reports
 
 import flank.common.println
-import ftl.analytics.sendConfiguration
 import ftl.api.JUnitTest
 import ftl.args.IArgs
 import ftl.config.FtlConstants.indent
 import ftl.json.MatrixMap
 import ftl.reports.util.IReport
 import ftl.reports.util.ReportManager
-import ftl.util.calculatePhysicalCost
-import ftl.util.calculateTotalCost
-import ftl.util.calculateVirtualCost
 import ftl.util.estimateCosts
 import java.io.StringWriter
 
@@ -19,7 +15,7 @@ object CostReport : IReport {
 
     override val extension = ".txt"
 
-    private fun estimate(args: IArgs, matrices: MatrixMap): String {
+    private fun estimate(matrices: MatrixMap): String {
         var totalBillableVirtualMinutes = 0L
         var totalBillablePhysicalMinutes = 0L
 
@@ -28,26 +24,11 @@ object CostReport : IReport {
             totalBillablePhysicalMinutes += it.billableMinutes.physical
         }
 
-        val virtualCost = calculateVirtualCost(totalBillableVirtualMinutes.toBigDecimal())
-        val physicalCost = calculatePhysicalCost(totalBillablePhysicalMinutes.toBigDecimal())
-
-        args.sendConfiguration(
-            events = mapOf(
-                "virtual_cost" to virtualCost,
-                "physical_cost" to physicalCost,
-                "cost_total" to calculateTotalCost(
-                    virtualCost,
-                    physicalCost
-                )
-            ),
-            eventName = "devices_cost"
-        )
-
         return estimateCosts(totalBillableVirtualMinutes, totalBillablePhysicalMinutes)
     }
 
-    private fun generate(args: IArgs, matrices: MatrixMap): String {
-        val cost = estimate(args, matrices)
+    private fun generate(matrices: MatrixMap): String {
+        val cost = estimate(matrices)
         StringWriter().use { writer ->
             writer.println(reportName())
             cost.split("\n").forEach { writer.println(indent + it) }
@@ -56,7 +37,7 @@ object CostReport : IReport {
     }
 
     override fun run(matrices: MatrixMap, result: JUnitTest.Result?, printToStdout: Boolean, args: IArgs) {
-        val output = generate(args, matrices)
+        val output = generate(matrices)
         if (printToStdout) print(output)
         write(matrices, output, args)
         ReportManager.uploadReportResult(output, args, fileName())

test_runner/src/main/kotlin/ftl/run/common/SaveSessionId.kt

@@ -1,7 +1,7 @@
 package ftl.run.common
 
+import flank.tool.analytics.mixpanel.sessionId
 import ftl.args.IArgs
-import ftl.util.sessionId
 import java.nio.file.Paths
 
 const val SESSION_ID_FILE = "session_id.txt"