Merge pull request #3045 from DataDog/yl/profiling/add-next-launch-api

ambushwork · web-flow · commit 0342fdd31a0f · 2025-12-11T09:27:45.000+01:00
Add Profiling.profileNextAppStartup API
diff --git a/features/dd-sdk-android-profiling/api/apiSurface b/features/dd-sdk-android-profiling/api/apiSurface
@@ -7,6 +7,7 @@ class com.datadog.android.profiling.DdProfilingContentProvider : android.content
   override fun update(android.net.Uri, android.content.ContentValues?, String?, Array<String>?): Int
 object com.datadog.android.profiling.Profiling
   fun enable(ProfilingConfiguration = ProfilingConfiguration.DEFAULT, com.datadog.android.api.SdkCore = Datadog.getInstance())
+  fun profileNextAppStartup(com.datadog.android.api.SdkCore = Datadog.getInstance(), Boolean)
 data class com.datadog.android.profiling.ProfilingConfiguration
   class Builder
     fun useCustomEndpoint(String): Builder
diff --git a/features/dd-sdk-android-profiling/api/dd-sdk-android-profiling.api b/features/dd-sdk-android-profiling/api/dd-sdk-android-profiling.api
@@ -14,6 +14,9 @@ public final class com/datadog/android/profiling/Profiling {
 	public static final fun enable (Lcom/datadog/android/profiling/ProfilingConfiguration;)V
 	public static final fun enable (Lcom/datadog/android/profiling/ProfilingConfiguration;Lcom/datadog/android/api/SdkCore;)V
 	public static synthetic fun enable$default (Lcom/datadog/android/profiling/ProfilingConfiguration;Lcom/datadog/android/api/SdkCore;ILjava/lang/Object;)V
+	public static final fun profileNextAppStartup (Lcom/datadog/android/api/SdkCore;Z)V
+	public static final fun profileNextAppStartup (Z)V
+	public static synthetic fun profileNextAppStartup$default (Lcom/datadog/android/api/SdkCore;ZILjava/lang/Object;)V
 }
 
 public final class com/datadog/android/profiling/ProfilingConfiguration {
diff --git a/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/Profiling.kt b/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/Profiling.kt
@@ -10,7 +10,9 @@ import android.content.Context
 import android.os.Build
 import androidx.annotation.RequiresApi
 import com.datadog.android.Datadog
+import com.datadog.android.api.InternalLogger
 import com.datadog.android.api.SdkCore
+import com.datadog.android.api.feature.Feature
 import com.datadog.android.api.feature.FeatureSdkCore
 import com.datadog.android.internal.time.DefaultTimeProvider
 import com.datadog.android.profiling.internal.NoOpProfiler
@@ -28,8 +30,7 @@ object Profiling {
     private var profiler: Profiler = NoOpProfiler()
 
     /**
-     * Enables the Perfetto based profiler to start recording callstack samples during application
-     * launch.
+     * Enables the profiling feature.
      *
      * @param configuration Configuration to use for the feature.
      * @param sdkCore SDK instance to register feature in. If not provided, default SDK instance
@@ -51,6 +52,33 @@ object Profiling {
         featureSdkCore.registerFeature(profilingFeature)
     }
 
+    /**
+     * Decides if the next app launch should be profiled.
+     *
+     * @param sdkCore SDK instance to register feature in.
+     * @param enable enables the profiling for next app launch, otherwise disables it.
+     */
+    @JvmStatic
+    @JvmOverloads
+    @RequiresApi(Build.VERSION_CODES.VANILLA_ICE_CREAM)
+    fun profileNextAppStartup(
+        sdkCore: SdkCore = Datadog.getInstance(),
+        enable: Boolean
+    ) {
+        val featureSdkCore = sdkCore as FeatureSdkCore
+        val profilingFeature = featureSdkCore
+            .getFeature(Feature.PROFILING_FEATURE_NAME)?.let {
+                it.unwrap() as? ProfilingFeature
+            }
+        profilingFeature?.profileNextAppStartup(enable) ?: run {
+            featureSdkCore.internalLogger.log(
+                level = InternalLogger.Level.WARN,
+                target = InternalLogger.Target.USER,
+                messageBuilder = { "Profiling feature needs to be enabled before calling this method." }
+            )
+        }
+    }
+
     @RequiresApi(Build.VERSION_CODES.VANILLA_ICE_CREAM)
     internal fun start(context: Context, sdkInstanceNames: Set<String>) {
         profiler = PerfettoProfiler(
diff --git a/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingFeature.kt b/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingFeature.kt
@@ -34,6 +34,8 @@ internal class ProfilingFeature(
 
     private var perfettoResult: PerfettoResult? = null
 
+    internal lateinit var appContext: Context
+
     override val requestFactory: RequestFactory = ProfilingRequestFactory(
         configuration.customEndpointUrl,
         sdkCore.internalLogger
@@ -46,15 +48,14 @@ internal class ProfilingFeature(
         get() = Feature.Companion.PROFILING_FEATURE_NAME
 
     override fun onInitialize(appContext: Context) {
+        this.appContext = appContext
         profiler.apply {
             this.internalLogger = sdkCore.internalLogger
             registerProfilingCallback(sdkCore.name) { result ->
                 perfettoResult = result
                 tryWriteProfilingEvent()
             }
         }
-        // Set the profiling flag in SharedPreferences to profile for the next app launch
-        ProfilingStorage.addProfilingFlag(appContext, sdkCore.name)
         sdkCore.setEventReceiver(name, this)
         sdkCore.updateFeatureContext(Feature.PROFILING_FEATURE_NAME) { context ->
             context.put(PROFILER_IS_RUNNING, profiler.isRunning(sdkCore.name))
@@ -89,6 +90,15 @@ internal class ProfilingFeature(
         )
     }
 
+    internal fun profileNextAppStartup(enable: Boolean) {
+        // Set the profiling flag in SharedPreferences to profile for the next app launch
+        if (enable) {
+            ProfilingStorage.addProfilingFlag(appContext, sdkCore.name)
+        } else {
+            ProfilingStorage.removeProfilingFlag(appContext, setOf(sdkCore.name))
+        }
+    }
+
     private fun tryWriteProfilingEvent() {
         val perfettoResult = perfettoResult ?: return
         val ttidEvent = ttidEvent ?: return
diff --git a/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingStorage.kt b/features/dd-sdk-android-profiling/src/main/java/com/datadog/android/profiling/internal/ProfilingStorage.kt
@@ -15,6 +15,7 @@ internal object ProfilingStorage {
 
     private var sharedPreferencesStorage: SharedPreferencesStorage? = null
 
+    @JvmStatic
     internal fun addProfilingFlag(appContext: Context, sdkInstanceName: String) {
         getStorage(appContext).apply {
             val oldValue = getStringSet(KEY_PROFILING_ENABLED, emptySet())
@@ -23,10 +24,12 @@ internal object ProfilingStorage {
         }
     }
 
+    @JvmStatic
     internal fun getProfilingEnabledInstanceNames(appContext: Context): Set<String> {
         return getStorage(appContext).getStringSet(KEY_PROFILING_ENABLED)
     }
 
+    @JvmStatic
     internal fun removeProfilingFlag(appContext: Context, sdkInstanceNames: Set<String>) {
         getStorage(appContext).apply {
             val value = getStringSet(KEY_PROFILING_ENABLED).toMutableSet()
diff --git a/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/ProfilingFeatureTest.kt b/features/dd-sdk-android-profiling/src/test/kotlin/com/datadog/android/profiling/ProfilingFeatureTest.kt
@@ -15,6 +15,7 @@ import com.datadog.android.profiling.forge.Configurator
 import com.datadog.android.profiling.internal.Profiler
 import com.datadog.android.profiling.internal.ProfilingFeature
 import com.datadog.android.profiling.internal.ProfilingRequestFactory
+import com.datadog.android.profiling.internal.ProfilingStorage
 import com.datadog.android.rum.TTIDEvent
 import fr.xgouchet.elmyr.annotation.Forgery
 import fr.xgouchet.elmyr.annotation.StringForgery
@@ -26,6 +27,7 @@ import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
 import org.junit.jupiter.api.extension.Extensions
 import org.mockito.Mock
+import org.mockito.Mockito
 import org.mockito.junit.jupiter.MockitoExtension
 import org.mockito.junit.jupiter.MockitoSettings
 import org.mockito.kotlin.any
@@ -143,4 +145,32 @@ class ProfilingFeatureTest {
             .isEqualTo("Profiling feature receive an event of unsupported type=${String::class.java.canonicalName}.")
         verify(mockProfiler, never()).stop(fakeInstanceName)
     }
+
+    @Test
+    fun `M add profiling flag W profileNextAppStartup {enable = true}`() {
+        Mockito.mockStatic(ProfilingStorage::class.java).use { mockedStatic ->
+
+            // When
+            testedFeature.profileNextAppStartup(true)
+
+            // Then
+            mockedStatic.verify {
+                ProfilingStorage.addProfilingFlag(mockContext, fakeInstanceName)
+            }
+        }
+    }
+
+    @Test
+    fun `M remove profiling flag W profileNextAppStartup {enable = false}`() {
+        Mockito.mockStatic(ProfilingStorage::class.java).use { mockedStatic ->
+
+            // When
+            testedFeature.profileNextAppStartup(false)
+
+            // Then
+            mockedStatic.verify {
+                ProfilingStorage.removeProfilingFlag(mockContext, setOf(fakeInstanceName))
+            }
+        }
+    }
 }
diff --git a/sample/kotlin/src/main/kotlin/com/datadog/android/sample/SampleApplication.kt b/sample/kotlin/src/main/kotlin/com/datadog/android/sample/SampleApplication.kt
@@ -168,6 +168,7 @@ class SampleApplication : Application() {
 
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.VANILLA_ICE_CREAM) {
             Profiling.enable()
+            Profiling.profileNextAppStartup(enable = true)
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@ public final class com/datadog/android/profiling/Profiling {`
`14`	`14`	`public static final fun enable (Lcom/datadog/android/profiling/ProfilingConfiguration;)V`
`15`	`15`	`public static final fun enable (Lcom/datadog/android/profiling/ProfilingConfiguration;Lcom/datadog/android/api/SdkCore;)V`
`16`	`16`	`public static synthetic fun enable$default (Lcom/datadog/android/profiling/ProfilingConfiguration;Lcom/datadog/android/api/SdkCore;ILjava/lang/Object;)V`
	`17`	`+ public static final fun profileNextAppStartup (Lcom/datadog/android/api/SdkCore;Z)V`
	`18`	`+ public static final fun profileNextAppStartup (Z)V`
	`19`	`+ public static synthetic fun profileNextAppStartup$default (Lcom/datadog/android/api/SdkCore;ZILjava/lang/Object;)V`
`17`	`20`	`}`
`18`	`21`
`19`	`22`	`public final class com/datadog/android/profiling/ProfilingConfiguration {`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ internal object ProfilingStorage {`
`15`	`15`
`16`	`16`	`private var sharedPreferencesStorage: SharedPreferencesStorage? = null`
`17`	`17`
	`18`	`+ @JvmStatic`
`18`	`19`	`internal fun addProfilingFlag(appContext: Context, sdkInstanceName: String) {`
`19`	`20`	`getStorage(appContext).apply {`
`20`	`21`	`val oldValue = getStringSet(KEY_PROFILING_ENABLED, emptySet())`
`@@ -23,10 +24,12 @@ internal object ProfilingStorage {`
`23`	`24`	`}`
`24`	`25`	`}`
`25`	`26`
	`27`	`+ @JvmStatic`
`26`	`28`	`internal fun getProfilingEnabledInstanceNames(appContext: Context): Set<String> {`
`27`	`29`	`return getStorage(appContext).getStringSet(KEY_PROFILING_ENABLED)`
`28`	`30`	`}`
`29`	`31`
	`32`	`+ @JvmStatic`
`30`	`33`	`internal fun removeProfilingFlag(appContext: Context, sdkInstanceNames: Set<String>) {`
`31`	`34`	`getStorage(appContext).apply {`
`32`	`35`	`val value = getStringSet(KEY_PROFILING_ENABLED).toMutableSet()`
Original file line number	Diff line number	Diff line change
`@@ -168,6 +168,7 @@ class SampleApplication : Application() {`
`168`	`168`
`169`	`169`	`if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.VANILLA_ICE_CREAM) {`
`170`	`170`	`Profiling.enable()`
	`171`	`+ Profiling.profileNextAppStartup(enable = true)`
`171`	`172`	`}`
`172`	`173`	`}`
`173`	`174`