Allow all activities to ge traced by default (#1789)

## Goal

Add in annotations that allow a local config to specify that all activities loads are traced, with an opt-out annotation for those that shouldn't be.

Note: a change to the swazzler is needed to properly wire this up, but the SDK changes are all contained and tested in this PR.

embrace-android-api/api/embrace-android-api.api

@@ -27,12 +27,15 @@ public final class io/embrace/android/embracesdk/Severity : java/lang/Enum {
 public abstract interface annotation class io/embrace/android/embracesdk/annotation/InternalApi : java/lang/annotation/Annotation {
 }
 
-public abstract interface annotation class io/embrace/android/embracesdk/annotation/ObservedActivity : java/lang/annotation/Annotation {
+public abstract interface annotation class io/embrace/android/embracesdk/annotation/NotTracedActivity : java/lang/annotation/Annotation {
 }
 
 public abstract interface annotation class io/embrace/android/embracesdk/annotation/StartupActivity : java/lang/annotation/Annotation {
 }
 
+public abstract interface annotation class io/embrace/android/embracesdk/annotation/TracedActivity : java/lang/annotation/Annotation {
+}
+
 public abstract interface class io/embrace/android/embracesdk/internal/api/BreadcrumbApi {
 	public abstract fun addBreadcrumb (Ljava/lang/String;)V
 }

embrace-android-api/src/main/kotlin/io/embrace/android/embracesdk/annotation/NotTracedActivity.kt

@@ -0,0 +1,9 @@
+package io.embrace.android.embracesdk.annotation
+
+/**
+ * The loading of Activities annotated with this class will not generate traces if the feature is enabled, irrespective of
+ * the configured defaults.
+ */
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+public annotation class NotTracedActivity

embrace-android-api/src/main/kotlin/io/embrace/android/embracesdk/annotation/TracedActivity.kt

@@ -0,0 +1,9 @@
+package io.embrace.android.embracesdk.annotation
+
+/**
+ * The loading of Activities annotated with this class will generate traces if the feature is enabled, irrespective of
+ * the configured defaults.
+ */
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+public annotation class TracedActivity

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/config/behavior/AutoDataCaptureBehavior.kt

@@ -70,6 +70,11 @@ interface AutoDataCaptureBehavior : ConfigBehavior<EnabledFeatureConfig, RemoteC
      */
     fun isUiLoadPerfCaptureEnabled(): Boolean
 
+    /**
+     * Whether the SDK is configured to capture traces for the performance of the opening of all Activities by default.
+     */
+    fun isUiLoadPerfAutoCaptureEnabled(): Boolean
+
     /**
      * Gates whether the SDK should use OkHttp or fallback to UrlConnection.
      */

embrace-android-core/src/main/kotlin/io/embrace/android/embracesdk/internal/config/behavior/AutoDataCaptureBehaviorImpl.kt

@@ -44,6 +44,7 @@ class AutoDataCaptureBehaviorImpl(
     override fun isNativeCrashCaptureEnabled(): Boolean = local.isNativeCrashCaptureEnabled()
     override fun isDiskUsageCaptureEnabled(): Boolean = local.isDiskUsageCaptureEnabled()
     override fun isUiLoadPerfCaptureEnabled(): Boolean = local.isUiLoadPerfCaptureEnabled()
+    override fun isUiLoadPerfAutoCaptureEnabled(): Boolean = local.isUiLoadPerfAutoCaptureEnabled()
 
     private val v2StorageImpl by lazy {
         thresholdCheck.isBehaviorEnabled(remote?.killSwitchConfig?.v2StoragePct) ?: V2_STORAGE_ENABLED_DEFAULT

embrace-android-core/src/test/java/io/embrace/android/embracesdk/internal/config/behavior/AutoDataCaptureBehaviorImplTest.kt

@@ -34,6 +34,7 @@ internal class AutoDataCaptureBehaviorImplTest {
             assertTrue(isDiskUsageCaptureEnabled())
             assertTrue(isThermalStatusCaptureEnabled())
             assertFalse(isUiLoadPerfCaptureEnabled())
+            assertFalse(isUiLoadPerfAutoCaptureEnabled())
             assertTrue(isThermalStatusCaptureEnabled())
             assertTrue(isV2StorageEnabled())
         }

embrace-android-features/src/main/kotlin/io/embrace/android/embracesdk/internal/capture/activity/UiLoadExt.kt

@@ -4,7 +4,8 @@ import android.app.Activity
 import android.os.Build.VERSION_CODES
 import android.os.Bundle
 import androidx.annotation.RequiresApi
-import io.embrace.android.embracesdk.annotation.ObservedActivity
+import io.embrace.android.embracesdk.annotation.NotTracedActivity
+import io.embrace.android.embracesdk.annotation.TracedActivity
 import io.embrace.android.embracesdk.internal.clock.nanosToMillis
 import io.embrace.android.embracesdk.internal.session.lifecycle.ActivityLifecycleListener
 import io.embrace.android.embracesdk.internal.utils.VersionChecker
@@ -18,11 +19,13 @@ import io.opentelemetry.sdk.common.Clock
  */
 fun createActivityLoadEventEmitter(
     uiLoadEventListener: UiLoadEventListener,
+    autoTraceEnabled: Boolean,
     clock: Clock,
     versionChecker: VersionChecker,
 ): ActivityLifecycleListener {
     val lifecycleEventEmitter = LifecycleEventEmitter(
         uiLoadEventListener = uiLoadEventListener,
+        autoTraceEnabled = autoTraceEnabled,
         clock = clock,
     )
     return if (versionChecker.isAtLeast(VERSION_CODES.Q)) {
@@ -32,50 +35,36 @@ fun createActivityLoadEventEmitter(
     }
 }
 
-fun Activity.observeOpening() = javaClass.isAnnotationPresent(ObservedActivity::class.java)
-
 /**
  * Implementation that works with Android 10+ APIs
  */
 @RequiresApi(VERSION_CODES.Q)
 private class ActivityLoadEventEmitter(
-    private val lifecycleEventEmitter: LifecycleEventEmitter
+    private val lifecycleEventEmitter: LifecycleEventEmitter,
 ) : ActivityLifecycleListener {
 
     override fun onActivityPreCreated(activity: Activity, savedInstanceState: Bundle?) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.create(activity)
-        }
+        lifecycleEventEmitter.create(activity)
     }
 
     override fun onActivityPostCreated(activity: Activity, savedInstanceState: Bundle?) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.createEnd(activity)
-        }
+        lifecycleEventEmitter.createEnd(activity)
     }
 
     override fun onActivityPreStarted(activity: Activity) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.start(activity)
-        }
+        lifecycleEventEmitter.start(activity)
     }
 
     override fun onActivityPostStarted(activity: Activity) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.startEnd(activity)
-        }
+        lifecycleEventEmitter.startEnd(activity)
     }
 
     override fun onActivityPreResumed(activity: Activity) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.resume(activity)
-        }
+        lifecycleEventEmitter.resume(activity)
     }
 
     override fun onActivityPostResumed(activity: Activity) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.resumeEnd(activity)
-        }
+        lifecycleEventEmitter.resumeEnd(activity)
     }
 
     override fun onActivityPrePaused(activity: Activity) {
@@ -87,27 +76,21 @@ private class ActivityLoadEventEmitter(
  * Version of [ActivityLoadEventEmitter] that works with all Android version and used for Android 9 or lower
  */
 private class LegacyActivityLoadEventEmitter(
-    private val lifecycleEventEmitter: LifecycleEventEmitter
+    private val lifecycleEventEmitter: LifecycleEventEmitter,
 ) : ActivityLifecycleListener {
 
     override fun onActivityCreated(activity: Activity, bundle: Bundle?) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.create(activity)
-        }
+        lifecycleEventEmitter.create(activity)
     }
 
     override fun onActivityStarted(activity: Activity) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.createEnd(activity)
-            lifecycleEventEmitter.start(activity)
-        }
+        lifecycleEventEmitter.createEnd(activity)
+        lifecycleEventEmitter.start(activity)
     }
 
     override fun onActivityResumed(activity: Activity) {
-        if (activity.observeOpening()) {
-            lifecycleEventEmitter.startEnd(activity)
-            lifecycleEventEmitter.resume(activity)
-        }
+        lifecycleEventEmitter.startEnd(activity)
+        lifecycleEventEmitter.resume(activity)
     }
 
     override fun onActivityPaused(activity: Activity) {
@@ -120,60 +103,80 @@ private class LegacyActivityLoadEventEmitter(
  */
 private class LifecycleEventEmitter(
     private val uiLoadEventListener: UiLoadEventListener,
+    private val autoTraceEnabled: Boolean,
     private val clock: Clock,
 ) {
 
     fun create(activity: Activity) {
-        uiLoadEventListener.create(
-            instanceId = traceInstanceId(activity),
-            activityName = activity.localClassName,
-            timestampMs = nowMs(),
-            manualEnd = false,
-        )
+        if (activity.observe()) {
+            uiLoadEventListener.create(
+                instanceId = traceInstanceId(activity),
+                activityName = activity.localClassName,
+                timestampMs = nowMs(),
+                manualEnd = false,
+            )
+        }
     }
 
     fun createEnd(activity: Activity) {
-        uiLoadEventListener.createEnd(
-            instanceId = traceInstanceId(activity),
-            timestampMs = nowMs()
-        )
+        if (activity.observe()) {
+            uiLoadEventListener.createEnd(
+                instanceId = traceInstanceId(activity),
+                timestampMs = nowMs()
+            )
+        }
     }
 
     fun start(activity: Activity) {
-        uiLoadEventListener.start(
-            instanceId = traceInstanceId(activity),
-            activityName = activity.localClassName,
-            timestampMs = nowMs(),
-            manualEnd = false,
-        )
+        if (activity.observe()) {
+            uiLoadEventListener.start(
+                instanceId = traceInstanceId(activity),
+                activityName = activity.localClassName,
+                timestampMs = nowMs(),
+                manualEnd = false,
+            )
+        }
     }
 
     fun startEnd(activity: Activity) {
-        uiLoadEventListener.startEnd(
-            instanceId = traceInstanceId(activity),
-            timestampMs = nowMs()
-        )
+        if (activity.observe()) {
+            uiLoadEventListener.startEnd(
+                instanceId = traceInstanceId(activity),
+                timestampMs = nowMs()
+            )
+        }
     }
 
     fun resume(activity: Activity) {
-        uiLoadEventListener.resume(
-            instanceId = traceInstanceId(activity),
-            timestampMs = nowMs()
-        )
+        if (activity.observe()) {
+            uiLoadEventListener.resume(
+                instanceId = traceInstanceId(activity),
+                timestampMs = nowMs()
+            )
+        }
     }
 
     fun resumeEnd(activity: Activity) {
-        uiLoadEventListener.resumeEnd(
-            instanceId = traceInstanceId(activity),
-            timestampMs = nowMs()
-        )
+        if (activity.observe()) {
+            uiLoadEventListener.resumeEnd(
+                instanceId = traceInstanceId(activity),
+                timestampMs = nowMs()
+            )
+        }
     }
 
     fun pause(activity: Activity) {
-        uiLoadEventListener.discard(
-            instanceId = traceInstanceId(activity),
-            timestampMs = nowMs()
-        )
+        if (activity.observe()) {
+            uiLoadEventListener.discard(
+                instanceId = traceInstanceId(activity),
+                timestampMs = nowMs()
+            )
+        }
+    }
+
+    private fun Activity.observe(): Boolean {
+        return javaClass.isAnnotationPresent(TracedActivity::class.java) ||
+            autoTraceEnabled && !javaClass.isAnnotationPresent(NotTracedActivity::class.java)
     }
 
     private fun traceInstanceId(activity: Activity): Int = activity.hashCode()

embrace-android-features/src/main/kotlin/io/embrace/android/embracesdk/internal/injection/DataCaptureServiceModuleImpl.kt

@@ -83,6 +83,7 @@ internal class DataCaptureServiceModuleImpl @JvmOverloads constructor(
         if (configService.autoDataCaptureBehavior.isUiLoadPerfCaptureEnabled()) {
             createActivityLoadEventEmitter(
                 uiLoadEventListener = uiLoadTraceEmitter,
+                autoTraceEnabled = configService.autoDataCaptureBehavior.isUiLoadPerfAutoCaptureEnabled(),
                 clock = openTelemetryModule.openTelemetryClock,
                 versionChecker = versionChecker
             )