Merge branch 'feat/continuous-profiling-part1' into feat/continuous-profiling-lifecycle

# Conflicts:
#	CHANGELOG.md
#	sentry-android-core/api/sentry-android-core.api
#	sentry-android-core/src/main/java/io/sentry/android/core/AndroidContinuousProfiler.java
#	sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java
#	sentry-android-core/src/main/java/io/sentry/android/core/SentryPerformanceProvider.java
#	sentry-android-core/src/test/java/io/sentry/android/core/AndroidContinuousProfilerTest.kt
#	sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt
#	sentry/api/sentry.api
#	sentry/src/main/java/io/sentry/ExperimentalOptions.java
#	sentry/src/main/java/io/sentry/IContinuousProfiler.java
#	sentry/src/main/java/io/sentry/NoOpContinuousProfiler.java
#	sentry/src/main/java/io/sentry/Scopes.java
#	sentry/src/main/java/io/sentry/SentryOptions.java
#	sentry/src/main/java/io/sentry/TracesSampler.java
#	sentry/src/test/java/io/sentry/NoOpContinuousProfilerTest.kt
#	sentry/src/test/java/io/sentry/ScopesTest.kt
#	sentry/src/test/java/io/sentry/SentryOptionsTest.kt
#	sentry/src/test/java/io/sentry/SentryTest.kt

Author: stefanosiano

CHANGELOG.md

@@ -6,7 +6,7 @@
 
 - Add Continuous Profiling Support ([#3710](https://github.com/getsentry/sentry-java/pull/3710))
 
-  To enable Continuous Profiling use the `Sentry.startProfileSession` and `Sentry.stopProfileSession` experimental APIs. Sampling rate can be set through `options.profileSessionSampleRate` (defaults to 0.0).   
+  To enable Continuous Profiling use the `Sentry.startProfileSession` and `Sentry.stopProfileSession` experimental APIs. Sampling rate can be set through `options.profileSessionSampleRate`, which defaults to null (disabled).   
   Note: Both `options.profilesSampler` and `options.profilesSampleRate` must **not** be set to enable Continuous Profiling.
 
   ```java

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

@@ -321,7 +321,7 @@ static void applyMetadata(
           }
         }
 
-        if (options.getProfileSessionSampleRate() == 0.0) {
+        if (options.getProfileSessionSampleRate() == null) {
           final double profileSessionSampleRate =
               readDouble(metadata, logger, PROFILE_SESSION_SAMPLE_RATE);
           if (profileSessionSampleRate != -1) {

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

@@ -185,7 +185,7 @@ private void createAndStartContinuousProfiler(
     // Let's fake a sampler to accept the sampling decision that was calculated on last run
     sentryOptions
         .getExperimental()
-        .setProfileSessionSampleRate(profilingOptions.isContinuousProfileSampled() ? 1 : 0);
+        .setProfileSessionSampleRate(profilingOptions.isContinuousProfileSampled() ? 1.0 : 0.0);
     appStartContinuousProfiler.startProfileSession(
         profilingOptions.getProfileLifecycle(), new TracesSampler(sentryOptions));
   }

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

@@ -831,41 +831,41 @@ class ManifestMetadataReaderTest {
     }
 
     @Test
-    fun `applyMetadata without specifying profileLifecycle, stays MANUAL`() {
+    fun `applyMetadata without specifying profileSessionSampleRate, stays null`() {
         // Arrange
         val context = fixture.getContext()
 
         // Act
         ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
 
         // Assert
-        assertEquals(ProfileLifecycle.MANUAL, fixture.options.profileLifecycle)
+        assertNull(fixture.options.profileSessionSampleRate)
     }
 
     @Test
-    fun `applyMetadata reads profileLifecycle from metadata`() {
+    fun `applyMetadata without specifying profileLifecycle, stays MANUAL`() {
         // Arrange
-        val expectedLifecycle = "trace"
-        val bundle = bundleOf(ManifestMetadataReader.PROFILE_LIFECYCLE to expectedLifecycle)
-        val context = fixture.getContext(metaData = bundle)
+        val context = fixture.getContext()
 
         // Act
         ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
 
         // Assert
-        assertEquals(ProfileLifecycle.TRACE, fixture.options.profileLifecycle)
+        assertEquals(ProfileLifecycle.MANUAL, fixture.options.profileLifecycle)
     }
 
     @Test
-    fun `applyMetadata without specifying profileSessionSampleRate, stays 0`() {
+    fun `applyMetadata reads profileLifecycle from metadata`() {
         // Arrange
-        val context = fixture.getContext()
+        val expectedLifecycle = "trace"
+        val bundle = bundleOf(ManifestMetadataReader.PROFILE_LIFECYCLE to expectedLifecycle)
+        val context = fixture.getContext(metaData = bundle)
 
         // Act
         ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
 
         // Assert
-        assertEquals(0.0, fixture.options.profileSessionSampleRate)
+        assertEquals(ProfileLifecycle.TRACE, fixture.options.profileLifecycle)
     }
 
     @Test

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

@@ -3,6 +3,7 @@
 import io.sentry.util.SampleRateUtils;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Experimental options for new features, these options are going to be promoted to SentryOptions
@@ -15,10 +16,10 @@ public final class ExperimentalOptions {
 
   /**
    * Indicates the percentage in which the profiles for the session will be created. Specifying 0
-   * means never, 1.0 means always. The value needs to be >= 0.0 and <= 1.0 The default is 0
+   * means never, 1.0 means always. The value needs to be >= 0.0 and <= 1.0 The default is null
    * (disabled).
    */
-  private double profileSessionSampleRate = 0.0;
+  private @Nullable Double profileSessionSampleRate;
 
   /**
    * Whether the profiling lifecycle is controlled manually or based on the trace lifecycle.
@@ -60,12 +61,12 @@ public void setProfileLifecycle(final @NotNull ProfileLifecycle profileLifecycle
   }
 
   @ApiStatus.Experimental
-  public double getProfileSessionSampleRate() {
+  public @Nullable Double getProfileSessionSampleRate() {
     return profileSessionSampleRate;
   }
 
   @ApiStatus.Experimental
-  public void setProfileSessionSampleRate(final double profileSessionSampleRate) {
+  public void setProfileSessionSampleRate(final @Nullable Double profileSessionSampleRate) {
     if (!SampleRateUtils.isValidContinuousProfilesSampleRate(profileSessionSampleRate)) {
       throw new IllegalArgumentException(
           "The value "

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

@@ -1742,6 +1742,7 @@ public boolean isProfilingEnabled() {
   public boolean isContinuousProfilingEnabled() {
     return profilesSampleRate == null
         && profilesSampler == null
+        && experimental.getProfileSessionSampleRate() != null
         && experimental.getProfileSessionSampleRate() > 0;
   }
 
@@ -1790,14 +1791,14 @@ public void setProfilesSampleRate(final @Nullable Double profilesSampleRate) {
   }
 
   /**
-   * Returns the session sample rate. Default is 0 (disabled). ProfilesSampleRate takes precedence
-   * over this. To enable continuous profiling, don't set profilesSampleRate or profilesSampler, or
-   * set them to null.
+   * Returns the session sample rate. Default is null (disabled). ProfilesSampleRate takes
+   * precedence over this. To enable continuous profiling, don't set profilesSampleRate or
+   * profilesSampler, or set them to null.
    *
    * @return the sample rate
    */
   @ApiStatus.Experimental
-  public double getProfileSessionSampleRate() {
+  public @Nullable Double getProfileSessionSampleRate() {
     return experimental.getProfileSessionSampleRate();
   }
 
@@ -1808,7 +1809,7 @@ public double getProfileSessionSampleRate() {
    * @return the profile lifecycle
    */
   @ApiStatus.Experimental
-  public ProfileLifecycle getProfileLifecycle() {
+  public @NotNull ProfileLifecycle getProfileLifecycle() {
     return experimental.getProfileLifecycle();
   }
 

sentry/src/main/java/io/sentry/TracesSampler.java

@@ -86,8 +86,8 @@ public TracesSamplingDecision sample(final @NotNull SamplingContext samplingCont
   }
 
   public boolean sampleSessionProfile() {
-    final double sampling = options.getProfileSessionSampleRate();
-    return sample(sampling);
+    final @Nullable Double sampling = options.getProfileSessionSampleRate();
+    return sampling != null && sample(sampling);
   }
 
   private boolean sample(final @NotNull Double aDouble) {

sentry/src/main/java/io/sentry/util/SampleRateUtils.java

@@ -23,8 +23,8 @@ public static boolean isValidProfilesSampleRate(@Nullable Double profilesSampleR
     return isValidRate(profilesSampleRate, true);
   }
 
-  public static boolean isValidContinuousProfilesSampleRate(double profilesSampleRate) {
-    return isValidRate(profilesSampleRate, false);
+  public static boolean isValidContinuousProfilesSampleRate(@Nullable Double profilesSampleRate) {
+    return isValidRate(profilesSampleRate, true);
   }
 
   private static boolean isValidRate(final @Nullable Double rate, final boolean allowNull) {

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

@@ -237,14 +237,22 @@ class SentryOptionsTest {
     }
 
     @Test
-    fun `when profileSessionSampleRate is set to a 0, isProfilingEnabled is false and isContinuousProfilingEnabled is false`() {
+    fun `when profileSessionSampleRate is set to 0, isProfilingEnabled is false and isContinuousProfilingEnabled is false`() {
         val options = SentryOptions().apply {
             this.experimental.profileSessionSampleRate = 0.0
         }
         assertFalse(options.isProfilingEnabled)
         assertFalse(options.isContinuousProfilingEnabled)
     }
 
+    @Test
+    fun `when profileSessionSampleRate is null, isProfilingEnabled is false and isContinuousProfilingEnabled is false`() {
+        val options = SentryOptions()
+        assertNull(options.experimental.profileSessionSampleRate)
+        assertFalse(options.isProfilingEnabled)
+        assertFalse(options.isContinuousProfilingEnabled)
+    }
+
     @Test
     fun `when setProfilesSampleRate is set to exactly 0, value is set`() {
         val options = SentryOptions().apply {

sentry/src/test/java/io/sentry/util/SampleRateUtilTest.kt

@@ -141,6 +141,11 @@ class SampleRateUtilTest {
         assertTrue(SampleRateUtils.isValidContinuousProfilesSampleRate(1.0))
     }
 
+    @Test
+    fun `accepts null continuous profiles sample rate`() {
+        assertTrue(SampleRateUtils.isValidProfilesSampleRate(null))
+    }
+
     @Test
     fun `rejects negative continuous profiles sample rate`() {
         assertFalse(SampleRateUtils.isValidContinuousProfilesSampleRate(-0.5))