Merge pull request #551 from code-payments/chore/add-metrics-to-photo-processing

chore: add metrics to photo processing (scanning)

Author: bmc08gt

api/src/main/java/com/getcode/analytics/AnalyticsManager.kt

@@ -289,6 +289,14 @@ class AnalyticsManager @Inject constructor(
         )
     }
 
+    override fun photoScanned(successful: Boolean, timeToScanInMillis: Long) {
+        track(
+            Name.PhotoScanned,
+            Property.Result to successful.toString(),
+            Property.Time to timeToScanInMillis.toInt().toString()
+        )
+    }
+
     override fun action(action: Action, source: ActionSource?) {
         track(
             action = action,
@@ -343,6 +351,7 @@ class AnalyticsManager @Inject constructor(
         PrivacyMigration("Privacy Migration"),
         BackgroundSwap("Background Swap Initiated"),
         Withdrawal("Withdrawal"),
+        PhotoScanned("Photo Scanned"),
 
         // Errors
         ErrorRequest("Error Request"),
@@ -365,6 +374,7 @@ class AnalyticsManager @Inject constructor(
         Result("Result"),
         MillisecondsToConfirm("Milliseconds to confirm"),
         GrabTime("Grab Time"),
+        Time("Time"),
 
         // Bill
         State("State"),

api/src/main/java/com/getcode/analytics/AnalyticsService.kt

@@ -52,6 +52,8 @@ interface AnalyticsService {
 
     fun appSettingToggled(setting: AppSetting, value: Boolean)
 
+    fun photoScanned(successful: Boolean, timeToScanInMillis: Long)
+
     fun action(action: Action, source: ActionSource? = null)
 }
 
@@ -98,5 +100,7 @@ class AnalyticsServiceNull : AnalyticsService {
     override fun backgroundSwapInitiated() = Unit
     override fun unintentionalLogout() = Unit
     override fun appSettingToggled(setting: AppSetting, value: Boolean) = Unit
+    override fun photoScanned(successful: Boolean, timeToScanInMillis: Long) = Unit
+
     override fun action(action: Action, source: ActionSource?) = Unit
 }

api/src/main/java/com/getcode/utils/Logging.kt

@@ -4,6 +4,7 @@ import android.annotation.SuppressLint
 import com.bugsnag.android.BreadcrumbType
 import com.bugsnag.android.Bugsnag
 import timber.log.Timber
+import kotlin.time.Duration
 import kotlin.time.measureTime
 
 sealed interface TraceType {
@@ -103,6 +104,7 @@ fun <T> timedTrace(
     type: TraceType = TraceType.Log,
     metadata: MetadataBuilder.() -> Unit = {},
     error: Throwable? = null,
+    onComplete: (T, Duration) -> Unit = { _, _ -> },
     block: () -> T
 ): T {
     var result: T
@@ -117,7 +119,7 @@ fun <T> timedTrace(
     }
 
     trace(message, tag, type, timedMetadata, error)
-
+    onComplete(result, time)
     return result
 }
 
@@ -127,6 +129,7 @@ suspend fun <T> timedTraceSuspend(
     type: TraceType = TraceType.Log,
     metadata: MetadataBuilder.() -> Unit = {},
     error: Throwable? = null,
+    onComplete: (T, Duration) -> Unit = { _, _ -> },
     block: suspend () -> T
 ): T {
     var result: T
@@ -141,7 +144,7 @@ suspend fun <T> timedTraceSuspend(
     }
 
     trace(message, tag, type, timedMetadata, error)
-
+    onComplete(result, time)
     return result
 }
 

app/src/main/java/com/kik/kikx/kikcodes/implementation/StaticImageHelper.kt

@@ -7,6 +7,7 @@ import android.icu.text.DateFormat
 import android.icu.text.SimpleDateFormat
 import android.net.Uri
 import android.os.Environment
+import com.getcode.analytics.AnalyticsService
 import com.getcode.util.save
 import com.getcode.util.toByteArray
 import com.getcode.util.uriToBitmap
@@ -26,6 +27,7 @@ class StaticImageHelper @Inject constructor(
     @ApplicationContext
     private val context: Context,
     private val scanner: KikCodeScanner,
+    private val analytics: AnalyticsService,
 ) {
     suspend fun analyze(uri: Uri): Result<ScannableKikCode> {
         val bitmap = context.uriToBitmap(uri)
@@ -66,7 +68,10 @@ class StaticImageHelper @Inject constructor(
         return timedTraceSuspend(
             message = "analyzing image",
             tag = "Image Analysis",
-            type = TraceType.Process
+            type = TraceType.Process,
+            onComplete = { result, time ->
+                analytics.photoScanned(result.isSuccess, time.inWholeMilliseconds)
+            }
         ) {
             // try scanning raw
             val raw = scan(bitmap)