Consolidate and disambiguate version checking for load traces capabil…

…ity detection
embrace-io · Jan 21, 2025 · 9424bbd · 9424bbd
1 parent a5e334e
commit 9424bbd
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 81 deletions.
diff --git a/...ures/src/main/kotlin/io/embrace/android/embracesdk/internal/capture/activity/UiLoadExt.kt b/...ures/src/main/kotlin/io/embrace/android/embracesdk/internal/capture/activity/UiLoadExt.kt
@@ -33,7 +33,7 @@ fun createActivityLoadEventEmitter(
         autoTraceEnabled = autoTraceEnabled,
         clock = clock,
     )
-    return if (versionChecker.isAtLeast(VERSION_CODES.Q)) {
+    return if (hasPrePostEvents(versionChecker)) {
         ActivityLoadEventEmitter(lifecycleEventEmitter)
     } else {
         LegacyActivityLoadEventEmitter(lifecycleEventEmitter)
@@ -45,6 +45,16 @@ fun createActivityLoadEventEmitter(
  */
 fun traceInstanceId(activity: Activity): Int = activity.hashCode()
 
+/**
+ * Determine if the current instance of the app will fire render events
+ */
+fun hasRenderEvent(versionChecker: VersionChecker) = versionChecker.isAtLeast(VERSION_CODES.Q)
+
+/**
+ * Determine if the current instance of the app will pre and post lifecycle events
+ */
+fun hasPrePostEvents(versionChecker: VersionChecker) = versionChecker.isAtLeast(VERSION_CODES.Q)
+
 /**
  * Implementation that works with Android 10+ APIs
  */

diff --git a/...main/kotlin/io/embrace/android/embracesdk/internal/capture/activity/UiLoadTraceEmitter.kt b/...main/kotlin/io/embrace/android/embracesdk/internal/capture/activity/UiLoadTraceEmitter.kt
@@ -1,7 +1,6 @@
 package io.embrace.android.embracesdk.internal.capture.activity
 
 import android.app.Application.ActivityLifecycleCallbacks
-import android.os.Build
 import io.embrace.android.embracesdk.internal.arch.schema.EmbType
 import io.embrace.android.embracesdk.internal.spans.PersistableEmbraceSpan
 import io.embrace.android.embracesdk.internal.spans.SpanService
@@ -105,7 +104,7 @@ class UiLoadTraceEmitter(
                 instanceId = instanceId,
                 timestampMs = timestampMs,
             )
-        } else if (hasRenderEvent()) {
+        } else if (hasRenderEvent(versionChecker)) {
             startChildSpan(
                 instanceId = instanceId,
                 timestampMs = timestampMs,
@@ -222,7 +221,7 @@ class UiLoadTraceEmitter(
     private fun determineEndEvent(manualEnd: Boolean): TraceCompleteTrigger {
         return if (manualEnd) {
             TraceCompleteTrigger.MANUAL
-        } else if (hasRenderEvent()) {
+        } else if (hasRenderEvent(versionChecker)) {
             TraceCompleteTrigger.RENDER
         } else {
             TraceCompleteTrigger.RESUME
@@ -266,8 +265,6 @@ class UiLoadTraceEmitter(
     private fun traceCompleteTrigger(instanceId: Int): TraceCompleteTrigger? =
         activeTraces[instanceId]?.traceCompleteTrigger
 
-    private fun hasRenderEvent(): Boolean = versionChecker.isAtLeast(Build.VERSION_CODES.Q)
-
     private fun traceName(
         activityName: String,
         uiLoadType: UiLoadType,

diff --git a/...n/kotlin/io/embrace/android/embracesdk/internal/capture/startup/AppStartupTraceEmitter.kt b/...n/kotlin/io/embrace/android/embracesdk/internal/capture/startup/AppStartupTraceEmitter.kt
@@ -103,7 +103,7 @@ internal class AppStartupTraceEmitter(
 
     private val startupRecorded = AtomicBoolean(false)
     private val dataCollectionComplete = AtomicBoolean(false)
-    private val endWithFrameDraw: Boolean = versionChecker.isAtLeast(VERSION_CODES.Q)
+    private val endWithFrameDraw: Boolean = startupHasRenderEvent(versionChecker)
 
     override fun applicationInitStart(timestampMs: Long?) {
         applicationInitStartMs = timestampMs ?: nowMs()
@@ -218,7 +218,7 @@ internal class AppStartupTraceEmitter(
             }
 
         val traceEndTimeMs: Long? =
-            if (versionChecker.isAtLeast(VERSION_CODES.Q)) {
+            if (endWithFrameDraw) {
                 firstFrameRenderedMs
             } else {
                 startupActivityResumedMs
@@ -472,5 +472,7 @@ internal class AppStartupTraceEmitter(
         } else {
             null
         }
+
+        fun startupHasRenderEvent(versionChecker: VersionChecker) = versionChecker.isAtLeast(VERSION_CODES.Q)
     }
 }
diff --git a/...n/kotlin/io/embrace/android/embracesdk/internal/injection/DataCaptureServiceModuleImpl.kt b/...n/kotlin/io/embrace/android/embracesdk/internal/injection/DataCaptureServiceModuleImpl.kt
@@ -1,10 +1,10 @@
 package io.embrace.android.embracesdk.internal.injection
 
-import android.os.Build
 import io.embrace.android.embracesdk.internal.Systrace
 import io.embrace.android.embracesdk.internal.capture.activity.UiLoadDataListener
 import io.embrace.android.embracesdk.internal.capture.activity.UiLoadTraceEmitter
 import io.embrace.android.embracesdk.internal.capture.activity.createActivityLoadEventEmitter
+import io.embrace.android.embracesdk.internal.capture.activity.hasRenderEvent
 import io.embrace.android.embracesdk.internal.capture.crumbs.ActivityBreadcrumbTracker
 import io.embrace.android.embracesdk.internal.capture.crumbs.PushNotificationCaptureService
 import io.embrace.android.embracesdk.internal.capture.startup.AppStartupDataCollector
@@ -104,7 +104,7 @@ internal class DataCaptureServiceModuleImpl @JvmOverloads constructor(
     }
 
     private fun createFirstDrawDetector(versionChecker: VersionChecker, logger: EmbLogger) =
-        if (versionChecker.isAtLeast(Build.VERSION_CODES.Q)) {
+        if (hasRenderEvent(versionChecker)) {
             FirstDrawDetector(logger)
         } else {
             null

diff --git a/...es/src/test/java/io/embrace/android/embracesdk/internal/capture/activity/UiLoadExtTest.kt b/...es/src/test/java/io/embrace/android/embracesdk/internal/capture/activity/UiLoadExtTest.kt
@@ -173,7 +173,7 @@ internal class UiLoadExtTest {
             }
             start()
             resume()
-            if (BuildVersionChecker.isAtLeast(Build.VERSION_CODES.Q)) {
+            if (hasRenderEvent(BuildVersionChecker)) {
                 drawEventEmitter.draw(activityController.get()) {
                     clock.tick(RENDER_DURATION)
                 }