added isStartProfilerOnAppStart experimental option

Author: stefanosiano

sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java

@@ -70,6 +70,8 @@ final class ManifestMetadataReader {
 
   static final String PROFILE_LIFECYCLE = "io.sentry.traces.profiling.lifecycle";
 
+  static final String PROFILER_START_ON_APP_START = "io.sentry.traces.profiling.start-on-app-start";
+
   @ApiStatus.Experimental static final String TRACE_SAMPLING = "io.sentry.traces.trace-sampling";
   static final String TRACE_PROPAGATION_TARGETS = "io.sentry.traces.trace-propagation-targets";
 
@@ -342,6 +344,10 @@ static void applyMetadata(
                   ProfileLifecycle.valueOf(profileLifecycle.toUpperCase(Locale.ROOT)));
         }
 
+        options.getExperimental().setStartProfilerOnAppStart(
+          readBool(
+            metadata, logger, PROFILER_START_ON_APP_START, options.isStartProfilerOnAppStart()));
+
         options.setEnableUserInteractionTracing(
             readBool(metadata, logger, TRACES_UI_ENABLE, options.isEnableUserInteractionTracing()));
 

sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt

@@ -868,6 +868,31 @@ class ManifestMetadataReaderTest {
         assertEquals(ProfileLifecycle.TRACE, fixture.options.profileLifecycle)
     }
 
+    @Test
+    fun `applyMetadata without specifying isStartProfilerOnAppStart, stays false`() {
+        // Arrange
+        val context = fixture.getContext()
+
+        // Act
+        ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
+
+        // Assert
+        assertFalse(fixture.options.isStartProfilerOnAppStart)
+    }
+
+    @Test
+    fun `applyMetadata reads isStartProfilerOnAppStart from metadata`() {
+        // Arrange
+        val bundle = bundleOf(ManifestMetadataReader.PROFILER_START_ON_APP_START to true)
+        val context = fixture.getContext(metaData = bundle)
+
+        // Act
+        ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
+
+        // Assert
+        assertTrue(fixture.options.isStartProfilerOnAppStart)
+    }
+
     @Test
     fun `applyMetadata reads tracePropagationTargets to options`() {
         // Arrange

sentry/src/main/java/io/sentry/ExperimentalOptions.java

@@ -27,6 +27,13 @@ public final class ExperimentalOptions {
    */
   private @NotNull ProfileLifecycle profileLifecycle = ProfileLifecycle.MANUAL;
 
+  /**
+   * Whether profiling can automatically be started as early as possible during the app lifecycle, to capture more of app startup.
+   * If {@link ExperimentalOptions#profileLifecycle} is {@link ProfileLifecycle#MANUAL} Profiling is started automatically on startup and stopProfileSession must be called manually whenever the app startup is completed
+   * If {@link ExperimentalOptions#profileLifecycle} is {@link ProfileLifecycle#TRACE} Profiling is started automatically on startup, and will automatically be stopped when the root span that is associated with app startup ends
+   */
+  private boolean startProfilerOnAppStart = false;
+
   public ExperimentalOptions(final boolean empty) {
     this.sessionReplay = new SentryReplayOptions(empty);
   }
@@ -74,4 +81,14 @@ public void setProfileSessionSampleRate(final @Nullable Double profileSessionSam
     }
     this.profileSessionSampleRate = profileSessionSampleRate;
   }
+
+  @ApiStatus.Experimental
+  public boolean isStartProfilerOnAppStart() {
+    return startProfilerOnAppStart;
+  }
+
+  @ApiStatus.Experimental
+  public void setStartProfilerOnAppStart(boolean startProfilerOnAppStart) {
+    this.startProfilerOnAppStart = startProfilerOnAppStart;
+  }
 }

sentry/src/main/java/io/sentry/Sentry.java

@@ -370,9 +370,10 @@ private static void handleAppStartProfilingConfig(
               try {
                 // We always delete the config file for app start profiling
                 FileUtils.deleteRecursively(appStartProfilingConfigFile);
-                if (!options.isEnableAppStartProfiling()) {
+                if (!options.isEnableAppStartProfiling() && !options.isStartProfilerOnAppStart()) {
                   return;
                 }
+                todo isStartProfilerOnAppStart doesn't need tracing! - SentryTest takes hours to run!
                 if (!options.isTracingEnabled()) {
                   options
                       .getLogger()
@@ -382,8 +383,8 @@ private static void handleAppStartProfilingConfig(
                   return;
                 }
                 if (appStartProfilingConfigFile.createNewFile()) {
-                  final @NotNull TracesSamplingDecision appStartSamplingDecision =
-                      sampleAppStartProfiling(options);
+                  // If old app start profiling is false, it means the transaction will not be sampled, but we create the file anyway to allow continuous profiling on app start
+                  final @NotNull TracesSamplingDecision appStartSamplingDecision = options.isEnableAppStartProfiling() ? sampleAppStartProfiling(options) : new TracesSamplingDecision(false);
                   final @NotNull SentryAppStartProfilingOptions appStartProfilingOptions =
                       new SentryAppStartProfilingOptions(options, appStartSamplingDecision);
                   try (final OutputStream outputStream =

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -1813,6 +1813,12 @@ public void setProfilesSampleRate(final @Nullable Double profilesSampleRate) {
     return experimental.getProfileLifecycle();
   }
 
+  /** Whether profiling can automatically be started as early as possible during the app lifecycle. */
+  @ApiStatus.Experimental
+  public boolean isStartProfilerOnAppStart() {
+    return experimental.isStartProfilerOnAppStart();
+  }
+
   /**
    * Returns the profiling traces dir. path if set
    *

sentry/src/test/java/io/sentry/SentryOptionsTest.kt

@@ -303,6 +303,20 @@ class SentryOptionsTest {
         assertEquals(ProfileLifecycle.MANUAL, options.profileLifecycle)
     }
 
+    @Test
+    fun `when isStartProfilerOnAppStart is set to a value, value is set`() {
+        val options = SentryOptions().apply {
+            this.experimental.isStartProfilerOnAppStart = true
+        }
+        assertTrue(options.isStartProfilerOnAppStart)
+    }
+
+    @Test
+    fun `isStartProfilerOnAppStart defaults to false`() {
+        val options = SentryOptions()
+        assertFalse(options.isStartProfilerOnAppStart)
+    }
+
     @Test
     fun `when options is initialized, compositePerformanceCollector is set`() {
         assertIs<CompositePerformanceCollector>(SentryOptions().compositePerformanceCollector)