Make 0 sample rate a valid rate (#2573)

romtsn · web-flow · commit d691d8f63b53 · 2023-02-27T12:29:46.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@
 ### Fixes
 
 - Leave `inApp` flag for stack frames undecided in SDK if unsure and let ingestion decide instead ([#2547](https://github.com/getsentry/sentry-java/pull/2547))
+- Allow `0.0` error sample rate ([#2573](https://github.com/getsentry/sentry-java/pull/2573))
 
 ## 6.14.0
 
diff --git a/sentry/api/sentry.api b/sentry/api/sentry.api
@@ -3793,7 +3793,6 @@ public final class io/sentry/util/SampleRateUtils {
 	public fun <init> ()V
 	public static fun isValidProfilesSampleRate (Ljava/lang/Double;)Z
 	public static fun isValidSampleRate (Ljava/lang/Double;)Z
-	public static fun isValidSampleRate (Ljava/lang/Double;Z)Z
 	public static fun isValidTracesSampleRate (Ljava/lang/Double;)Z
 	public static fun isValidTracesSampleRate (Ljava/lang/Double;Z)Z
 }
diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -814,7 +814,7 @@ public void setProxy(@Nullable Proxy proxy) {
   }
 
   /**
-   * Sets the sampleRate Can be anything between 0.01 and 1.0 or null (default), to disable it.
+   * Sets the sampleRate Can be anything between 0.0 and 1.0 or null (default), to disable it.
    *
    * @param sampleRate the sample rate
    */
@@ -823,7 +823,7 @@ public void setSampleRate(Double sampleRate) {
       throw new IllegalArgumentException(
           "The value "
               + sampleRate
-              + " is not valid. Use null to disable or values > 0.0 and <= 1.0.");
+              + " is not valid. Use null to disable or values >= 0.0 and <= 1.0.");
     }
     this.sampleRate = sampleRate;
   }
diff --git a/sentry/src/main/java/io/sentry/util/SampleRateUtils.java b/sentry/src/main/java/io/sentry/util/SampleRateUtils.java
@@ -7,15 +7,7 @@
 public final class SampleRateUtils {
 
   public static boolean isValidSampleRate(@Nullable Double sampleRate) {
-    return isValidSampleRate(sampleRate, true);
-  }
-
-  public static boolean isValidSampleRate(@Nullable Double sampleRate, boolean allowNull) {
-    if (sampleRate == null) {
-      return allowNull;
-    }
-
-    return !(sampleRate.isNaN() || sampleRate > 1.0 || sampleRate <= 0.0);
+    return isValidRate(sampleRate, true);
   }
 
   public static boolean isValidTracesSampleRate(@Nullable Double tracesSampleRate) {
diff --git a/sentry/src/test/java/io/sentry/SentryOptionsTest.kt b/sentry/src/test/java/io/sentry/SentryOptionsTest.kt
@@ -91,11 +91,6 @@ class SentryOptionsTest {
         assertFailsWith<IllegalArgumentException> { SentryOptions().sampleRate = -0.0000000000001 }
     }
 
-    @Test
-    fun `when setSampling is set to exactly 0, setter throws`() {
-        assertFailsWith<IllegalArgumentException> { SentryOptions().sampleRate = 0.0 }
-    }
-
     @Test
     fun `when setTracesSampleRate is set to exactly 0, value is set`() {
         val options = SentryOptions().apply {
diff --git a/sentry/src/test/java/io/sentry/util/SampleRateUtilTest.kt b/sentry/src/test/java/io/sentry/util/SampleRateUtilTest.kt
@@ -17,8 +17,8 @@ class SampleRateUtilTest {
     }
 
     @Test
-    fun `rejects 0 for sample rate`() {
-        assertFalse(SampleRateUtils.isValidSampleRate(0.0))
+    fun `accepts 0 for sample rate`() {
+        assertTrue(SampleRateUtils.isValidSampleRate(0.0))
     }
 
     @Test
@@ -46,16 +46,6 @@ class SampleRateUtilTest {
         assertFalse(SampleRateUtils.isValidSampleRate(Double.NEGATIVE_INFINITY))
     }
 
-    @Test
-    fun `accepts null sample rate if told so`() {
-        assertTrue(SampleRateUtils.isValidSampleRate(null, true))
-    }
-
-    @Test
-    fun `rejects null sample rate if told so`() {
-        assertFalse(SampleRateUtils.isValidSampleRate(null, false))
-    }
-
     @Test
     fun `accepts 0 for traces sample rate`() {
         assertTrue(SampleRateUtils.isValidTracesSampleRate(0.0))

Original file line number	Diff line number	Diff line change
`@@ -3793,7 +3793,6 @@ public final class io/sentry/util/SampleRateUtils {`
`3793`	`3793`	`public fun <init> ()V`
`3794`	`3794`	`public static fun isValidProfilesSampleRate (Ljava/lang/Double;)Z`
`3795`	`3795`	`public static fun isValidSampleRate (Ljava/lang/Double;)Z`
`3796`		`- public static fun isValidSampleRate (Ljava/lang/Double;Z)Z`
`3797`	`3796`	`public static fun isValidTracesSampleRate (Ljava/lang/Double;)Z`
`3798`	`3797`	`public static fun isValidTracesSampleRate (Ljava/lang/Double;Z)Z`
`3799`	`3798`	`}`
Original file line number	Diff line number	Diff line change
`@@ -814,7 +814,7 @@ public void setProxy(@Nullable Proxy proxy) {`
`814`	`814`	`}`
`815`	`815`
`816`	`816`	`/**`
`817`		`- * Sets the sampleRate Can be anything between 0.01 and 1.0 or null (default), to disable it.`
	`817`	`+ * Sets the sampleRate Can be anything between 0.0 and 1.0 or null (default), to disable it.`
`818`	`818`	`*`
`819`	`819`	`* @param sampleRate the sample rate`
`820`	`820`	`*/`
`@@ -823,7 +823,7 @@ public void setSampleRate(Double sampleRate) {`
`823`	`823`	`throw new IllegalArgumentException(`
`824`	`824`	`"The value "`
`825`	`825`	`+ sampleRate`
`826`		`- + " is not valid. Use null to disable or values > 0.0 and <= 1.0.");`
	`826`	`+ + " is not valid. Use null to disable or values >= 0.0 and <= 1.0.");`
`827`	`827`	`}`
`828`	`828`	`this.sampleRate = sampleRate;`
`829`	`829`	`}`