Merge 58e605d into adf8fe3

Author: lbloder

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Disable Sentry with SentryOptions ([#2840](https://github.com/getsentry/sentry-java/pull/2840))
+
 ## 6.25.1
 
 ### Fixes

sentry-spring-boot-starter-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt

@@ -155,7 +155,8 @@ class SentryAutoConfigurationTest {
             "sentry.tags.tag1=tag1-value",
             "sentry.tags.tag2=tag2-value",
             "sentry.ignored-exceptions-for-type=java.lang.RuntimeException,java.lang.IllegalStateException,io.sentry.Sentry",
-            "sentry.trace-propagation-targets=localhost,^(http|https)://api\\..*\$"
+            "sentry.trace-propagation-targets=localhost,^(http|https)://api\\..*\$",
+            "sentry.enabled=false"
         ).run {
             val options = it.getBean(SentryProperties::class.java)
             assertThat(options.readTimeoutMillis).isEqualTo(10)
@@ -184,6 +185,7 @@ class SentryAutoConfigurationTest {
             assertThat(options.tags).containsEntry("tag1", "tag1-value").containsEntry("tag2", "tag2-value")
             assertThat(options.ignoredExceptionsForType).containsOnly(RuntimeException::class.java, IllegalStateException::class.java)
             assertThat(options.tracePropagationTargets).containsOnly("localhost", "^(http|https)://api\\..*\$")
+            assertThat(options.isEnabled).isEqualTo(false)
         }
     }
 

sentry-spring-boot-starter/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt

@@ -155,7 +155,8 @@ class SentryAutoConfigurationTest {
             "sentry.tags.tag1=tag1-value",
             "sentry.tags.tag2=tag2-value",
             "sentry.ignored-exceptions-for-type=java.lang.RuntimeException,java.lang.IllegalStateException,io.sentry.Sentry",
-            "sentry.trace-propagation-targets=localhost,^(http|https)://api\\..*\$"
+            "sentry.trace-propagation-targets=localhost,^(http|https)://api\\..*\$",
+            "sentry.enabled=false"
         ).run {
             val options = it.getBean(SentryProperties::class.java)
             assertThat(options.readTimeoutMillis).isEqualTo(10)
@@ -184,6 +185,7 @@ class SentryAutoConfigurationTest {
             assertThat(options.tags).containsEntry("tag1", "tag1-value").containsEntry("tag2", "tag2-value")
             assertThat(options.ignoredExceptionsForType).containsOnly(RuntimeException::class.java, IllegalStateException::class.java)
             assertThat(options.tracePropagationTargets).containsOnly("localhost", "^(http|https)://api\\..*\$")
+            assertThat(options.isEnabled).isEqualTo(false)
         }
     }
 

sentry/api/sentry.api

@@ -272,12 +272,14 @@ public final class io/sentry/ExternalOptions {
 	public fun getTracePropagationTargets ()Ljava/util/List;
 	public fun getTracesSampleRate ()Ljava/lang/Double;
 	public fun getTracingOrigins ()Ljava/util/List;
+	public fun isEnabled ()Ljava/lang/Boolean;
 	public fun setDebug (Ljava/lang/Boolean;)V
 	public fun setDist (Ljava/lang/String;)V
 	public fun setDsn (Ljava/lang/String;)V
 	public fun setEnableDeduplication (Ljava/lang/Boolean;)V
 	public fun setEnableTracing (Ljava/lang/Boolean;)V
 	public fun setEnableUncaughtExceptionHandler (Ljava/lang/Boolean;)V
+	public fun setEnabled (Ljava/lang/Boolean;)V
 	public fun setEnvironment (Ljava/lang/String;)V
 	public fun setIdleTimeout (Ljava/lang/Long;)V
 	public fun setMaxRequestBodySize (Lio/sentry/SentryOptions$RequestSize;)V
@@ -1772,6 +1774,7 @@ public class io/sentry/SentryOptions {
 	public fun isEnableUncaughtExceptionHandler ()Z
 	public fun isEnableUserInteractionBreadcrumbs ()Z
 	public fun isEnableUserInteractionTracing ()Z
+	public fun isEnabled ()Z
 	public fun isPrintUncaughtStackTrace ()Z
 	public fun isProfilingEnabled ()Z
 	public fun isSendClientReports ()Z
@@ -1806,6 +1809,7 @@ public class io/sentry/SentryOptions {
 	public fun setEnableUncaughtExceptionHandler (Z)V
 	public fun setEnableUserInteractionBreadcrumbs (Z)V
 	public fun setEnableUserInteractionTracing (Z)V
+	public fun setEnabled (Z)V
 	public fun setEnvelopeDiskCache (Lio/sentry/cache/IEnvelopeCache;)V
 	public fun setEnvelopeReader (Lio/sentry/IEnvelopeReader;)V
 	public fun setEnvironment (Ljava/lang/String;)V

sentry/src/main/java/io/sentry/ExternalOptions.java

@@ -42,6 +42,7 @@ public final class ExternalOptions {
   private @Nullable Boolean printUncaughtStackTrace;
   private @Nullable Boolean sendClientReports;
   private @NotNull Set<String> bundleIds = new CopyOnWriteArraySet<>();
+  private @Nullable Boolean enabled;
 
   @SuppressWarnings("unchecked")
   public static @NotNull ExternalOptions from(
@@ -115,6 +116,8 @@ public final class ExternalOptions {
     }
     options.setIdleTimeout(propertiesProvider.getLongProperty("idle-timeout"));
 
+    options.setEnabled(propertiesProvider.getBooleanProperty("enabled"));
+
     for (final String ignoredExceptionType :
         propertiesProvider.getList("ignored-exceptions-for-type")) {
       try {
@@ -347,4 +350,12 @@ public void setSendClientReports(final @Nullable Boolean sendClientReports) {
   public void addBundleId(final @NotNull String bundleId) {
     bundleIds.add(bundleId);
   }
+
+  public @Nullable Boolean isEnabled() {
+    return enabled;
+  }
+
+  public void setEnabled(final @Nullable Boolean enabled) {
+    this.enabled = enabled;
+  }
 }

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

@@ -288,8 +288,9 @@ private static boolean initConfigurations(final @NotNull SentryOptions options)
 
     final String dsn = options.getDsn();
     if (dsn == null) {
-      throw new IllegalArgumentException("DSN is required. Use empty string to disable SDK.");
-    } else if (dsn.isEmpty()) {
+      throw new IllegalArgumentException(
+          "DSN is required. Use empty string or set enabled to false in SentryOptions to disable SDK.");
+    } else if (dsn.isEmpty() || !options.isEnabled()) {
       close();
       return false;
     }

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

@@ -434,6 +434,9 @@ public class SentryOptions {
   private final @NotNull FullyDisplayedReporter fullyDisplayedReporter =
       FullyDisplayedReporter.getInstance();
 
+  /** Whether Sentry should be enabled */
+  private boolean enabled = true;
+
   /**
    * Adds an event processor
    *
@@ -2096,6 +2099,24 @@ public void setTraceOptionsRequests(boolean traceOptionsRequests) {
     this.traceOptionsRequests = traceOptionsRequests;
   }
 
+  /**
+   * Whether Sentry is enabled.
+   *
+   * @return true if Sentry should be enabled
+   */
+  public boolean isEnabled() {
+    return enabled;
+  }
+
+  /**
+   * Whether Sentry should be enabled.
+   *
+   * @param enabled true if Sentry should be enabled
+   */
+  public void setEnabled(boolean enabled) {
+    this.enabled = enabled;
+  }
+
   /** Returns the current {@link SentryDateProvider} that is used to retrieve the current date. */
   @ApiStatus.Internal
   public @NotNull SentryDateProvider getDateProvider() {
@@ -2333,6 +2354,10 @@ public void merge(final @NotNull ExternalOptions options) {
     for (String bundleId : options.getBundleIds()) {
       addBundleId(bundleId);
     }
+
+    if (options.isEnabled() != null) {
+      setEnabled(options.isEnabled());
+    }
   }
 
   private @NotNull SdkVersion createSdkVersion() {

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

@@ -247,6 +247,13 @@ class ExternalOptionsTest {
         }
     }
 
+    @Test
+    fun `creates options with enabled set to true`() {
+        withPropertiesFile("enabled=true") { options ->
+            assertTrue(options.isEnabled() == true)
+        }
+    }
+
     private fun withPropertiesFile(textLines: List<String> = emptyList(), logger: ILogger = mock(), fn: (ExternalOptions) -> Unit) {
         // create a sentry.properties file in temporary folder
         val temporaryFolder = TemporaryFolder()

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

@@ -368,6 +368,7 @@ class SentryOptionsTest {
         externalOptions.proguardUuid = "1234"
         externalOptions.idleTimeout = 1500L
         externalOptions.bundleIds.addAll(listOf("12ea7a02-46ac-44c0-a5bb-6d1fd9586411 ", " faa3ab42-b1bd-4659-af8e-1682324aa744"))
+        externalOptions.isEnabled = false
         val options = SentryOptions()
 
         options.merge(externalOptions)
@@ -392,6 +393,7 @@ class SentryOptionsTest {
         assertEquals("1234", options.proguardUuid)
         assertEquals(1500L, options.idleTimeout)
         assertEquals(setOf("12ea7a02-46ac-44c0-a5bb-6d1fd9586411", "faa3ab42-b1bd-4659-af8e-1682324aa744"), options.bundleIds)
+        assertFalse(options.isEnabled)
     }
 
     @Test
@@ -483,4 +485,9 @@ class SentryOptionsTest {
     fun `when options are initialized, FullyDrawnReporter is set`() {
         assertEquals(FullyDisplayedReporter.getInstance(), SentryOptions().fullyDisplayedReporter)
     }
+
+    @Test
+    fun `when options are initialized, enabled is set to true by default`() {
+        assertTrue(SentryOptions().isEnabled)
+    }
 }

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

@@ -167,6 +167,23 @@ class SentryTest {
         }
     }
 
+    @Test
+    fun `initializes Sentry with enabled=false, thus disabling Sentry even if dsn is set`() {
+        Sentry.init {
+            it.isEnabled = false
+            it.dsn = "http://key@localhost/proj"
+        }
+
+        Sentry.setTag("none", "shouldNotExist")
+
+        var value: String? = null
+        Sentry.getCurrentHub().configureScope {
+            value = it.tags[value]
+        }
+        assertTrue(Sentry.getCurrentHub() is NoOpHub)
+        assertNull(value)
+    }
+
     @Test
     fun `captureUserFeedback gets forwarded to client`() {
         Sentry.init { it.dsn = dsn }