notifyReleaseStages -> enabledReleaseStages (#239)

Author: richardelms

bugsnag/src/main/java/com/bugsnag/Bugsnag.java

@@ -253,11 +253,15 @@ public void setIgnoreClasses(String... ignoreClasses) {
      * Set for which releaseStages errors should be sent to Bugsnag.
      * Use this to stop errors from development builds being sent.
      *
-     * @param notifyReleaseStages a list of releaseStages to notify for
+     * @param enabledReleaseStages a list of releaseStages to notify for
      * @see #setReleaseStage
      */
-    public void setNotifyReleaseStages(String... notifyReleaseStages) {
-        config.notifyReleaseStages = notifyReleaseStages;
+    public void setEnabledReleaseStages(String... enabledReleaseStages) {
+        if (enabledReleaseStages == null || enabledReleaseStages.length == 0) {
+            config.enabledReleaseStages = Collections.emptySet();
+        } else {
+            config.enabledReleaseStages = Set.of(enabledReleaseStages);
+        }
     }
 
     /**
@@ -289,7 +293,7 @@ public void setProxy(Proxy proxy) {
      * Set the current "release stage" of your application.
      *
      * @param releaseStage the release stage of the app
-     * @see #setNotifyReleaseStages
+     * @see #setEnabledReleaseStages
      */
     public void setReleaseStage(String releaseStage) {
         config.releaseStage = releaseStage;
@@ -302,14 +306,15 @@ public void setReleaseStage(String releaseStage) {
      * environment.
      *
      * @param sendThreads should we send thread state with error reports
-     * @see #setNotifyReleaseStages
+     * @see #setEnabledReleaseStages
      */
     public void setSendThreads(boolean sendThreads) {
         config.sendThreads = sendThreads;
     }
 
     /**
-     * Set a timeout (in ms) to use when delivering Bugsnag error reports and sessions.
+     * Set a timeout (in ms) to use when delivering Bugsnag error reports and
+     * sessions.
      * This is a convenient shorthand for bugsnag.getDelivery().setTimeout();
      *
      * @param timeout the timeout to set (in ms)
@@ -440,9 +445,9 @@ public boolean notify(Report report, Callback reportCallback) {
             return false;
         }
 
-        // Don't notify unless releaseStage is in notifyReleaseStages
+        // Don't notify unless releaseStage is in enabledReleaseStages
         if (!config.shouldNotifyForReleaseStage()) {
-            LOGGER.debug("Error not reported to Bugsnag - {} is not in 'notifyReleaseStages'",
+            LOGGER.debug("Error not reported to Bugsnag - {} is not in 'enabledReleaseStages'",
                     config.releaseStage);
             return false;
         }

bugsnag/src/main/java/com/bugsnag/BugsnagAppender.java

@@ -55,7 +55,7 @@ public class BugsnagAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
     private Set<String> ignoredClasses = new HashSet<String>();
 
     /** Release stages that should be notified. */
-    private Set<String> notifyReleaseStages = new HashSet<String>();
+    private Set<String> enabledReleaseStages = new HashSet<String>();
 
     /** Project packages. */
     private Set<String> projectPackages = new HashSet<String>();
@@ -254,20 +254,20 @@ private Bugsnag createBugsnag() {
             bugsnag.setTimeout(timeout);
         }
 
-        if (redactedKeys.size() > 0) {
+        if (!redactedKeys.isEmpty()) {
             bugsnag.setRedactedKeys(redactedKeys.toArray(new String[0]));
         }
 
         bugsnag.setIgnoreClasses(ignoredClasses.toArray(new String[0]));
 
-        if (notifyReleaseStages.size() > 0) {
-            bugsnag.setNotifyReleaseStages(notifyReleaseStages.toArray(new String[0]));
+        if (!enabledReleaseStages.isEmpty()) {
+            bugsnag.setEnabledReleaseStages(enabledReleaseStages.toArray(new String[0]));
         }
 
         bugsnag.setProjectPackages(projectPackages.toArray(new String[0]));
         bugsnag.setSendThreads(sendThreads);
 
-        // Add a callback to put global meta data on every report
+        // Add a callback to put global metadata on every report
         bugsnag.addCallback(new Callback() {
             @Override
             public void beforeNotify(Report report) {
@@ -417,25 +417,30 @@ public void setIgnoredClasses(String ignoredClasses) {
         }
     }
 
+    @Deprecated
+    public void setNotifyReleaseStage(String notifyReleaseStage) {
+        setEnabledReleaseStage(notifyReleaseStage);
+    }
+
     /**
-     * @see Bugsnag#setNotifyReleaseStages(String...)
+     * @see Bugsnag#setEnabledReleaseStages(String...)
      */
-    public void setNotifyReleaseStage(String notifyReleaseStage) {
-        this.notifyReleaseStages.add(notifyReleaseStage);
+    public void setEnabledReleaseStage(String enabledReleaseStage) {
+        this.enabledReleaseStages.add(enabledReleaseStage);
 
         if (bugsnag != null) {
-            bugsnag.setNotifyReleaseStages(this.notifyReleaseStages.toArray(new String[0]));
+            bugsnag.setEnabledReleaseStages(this.enabledReleaseStages.toArray(new String[0]));
         }
     }
 
     /**
-     * @see Bugsnag#setNotifyReleaseStages(String...)
+     * @see Bugsnag#setEnabledReleaseStages(String...)
      */
-    public void setNotifyReleaseStages(String notifyReleaseStages) {
-        this.notifyReleaseStages.addAll(split(notifyReleaseStages));
+    public void setEnabledReleaseStages(String enabledReleaseStages) {
+        this.enabledReleaseStages.addAll(split(enabledReleaseStages));
 
         if (bugsnag != null) {
-            bugsnag.setNotifyReleaseStages(this.notifyReleaseStages.toArray(new String[0]));
+            bugsnag.setEnabledReleaseStages(this.enabledReleaseStages.toArray(new String[0]));
         }
     }
 

bugsnag/src/main/java/com/bugsnag/Configuration.java

@@ -19,6 +19,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.ConcurrentLinkedQueue;
 import java.util.concurrent.atomic.AtomicBoolean;
 
@@ -36,9 +37,9 @@ public class Configuration {
     public Delivery delivery;
     public EndpointConfiguration endpointConfiguration;
     public Delivery sessionDelivery;
-    public String[] redactedKeys = new String[]{"password", "secret", "Authorization", "Cookie"};
+    public String[] redactedKeys = new String[] {"password", "secret", "Authorization", "Cookie"};
     public String[] ignoreClasses;
-    public String[] notifyReleaseStages = null;
+    public Set<String> enabledReleaseStages = null;
     public String[] projectPackages;
     public String releaseStage;
     public boolean sendThreads = false;
@@ -66,12 +67,10 @@ public class Configuration {
     }
 
     boolean shouldNotifyForReleaseStage() {
-        if (notifyReleaseStages == null) {
+        if (enabledReleaseStages == null) {
             return true;
         }
-
-        List<String> stages = Arrays.asList(notifyReleaseStages);
-        return stages.contains(releaseStage);
+        return enabledReleaseStages.contains(releaseStage);
     }
 
     boolean shouldIgnoreClass(String className) {

bugsnag/src/test/java/com/bugsnag/AppenderTest.java

@@ -150,20 +150,16 @@ public void testBugsnagConfig() {
         assertTrue(redactedKeys.contains("credit_card_number"));
 
         assertEquals(2, config.ignoreClasses.length);
-        ArrayList<String> ignoreClasses
-                = new ArrayList<String>(Arrays.asList(config.ignoreClasses));
+        ArrayList<String> ignoreClasses = new ArrayList<String>(Arrays.asList(config.ignoreClasses));
         assertTrue(ignoreClasses.contains("com.example.Custom"));
         assertTrue(ignoreClasses.contains("java.io.IOException"));
 
-        assertEquals(2, config.notifyReleaseStages.length);
-        ArrayList<String> notifyReleaseStages
-                = new ArrayList<String>(Arrays.asList(config.notifyReleaseStages));
-        assertTrue(notifyReleaseStages.contains("development"));
-        assertTrue(notifyReleaseStages.contains("test"));
+        assertEquals(2, config.enabledReleaseStages.size());
+        assertTrue(config.enabledReleaseStages.contains("development"));
+        assertTrue(config.enabledReleaseStages.contains("test"));
 
         assertEquals(2, config.projectPackages.length);
-        ArrayList<String> projectPackages
-                = new ArrayList<String>(Arrays.asList(config.projectPackages));
+        ArrayList<String> projectPackages = new ArrayList<String>(Arrays.asList(config.projectPackages));
         assertTrue(projectPackages.contains("com.company.package2"));
         assertTrue(projectPackages.contains("com.company.package1"));
 
@@ -208,7 +204,7 @@ public void testIgnoreClasses() {
     }
 
     @Test
-    public void testNotifyReleaseStages() {
+    public void testEnabledReleaseStages() {
         // Send a log with the release stage set to an excluded one
         appender.setReleaseStage("ignoredReleaseStage");
         LOGGER.warn("Release stage ignored", new RuntimeException("test"));

bugsnag/src/test/java/com/bugsnag/BugsnagTest.java

@@ -17,13 +17,14 @@
 import org.junit.Test;
 
 import java.io.ByteArrayOutputStream;
+
 import java.net.InetSocketAddress;
 import java.net.Proxy;
+
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
 
-
 public class BugsnagTest {
 
     private Bugsnag bugsnag;
@@ -73,25 +74,25 @@ public void testIgnoreClasses() {
     }
 
     @Test
-    public void testNotifyReleaseStages() {
+    public void testEnabledReleaseStages() {
         bugsnag.setDelivery(BugsnagTestUtils.generateDelivery());
 
         bugsnag.setReleaseStage("production");
 
         // Never send
-        bugsnag.setNotifyReleaseStages();
+        bugsnag.setEnabledReleaseStages();
         assertFalse(bugsnag.notify(new Throwable()));
 
         // Ignore 'production'
-        bugsnag.setNotifyReleaseStages("staging", "development");
+        bugsnag.setEnabledReleaseStages("staging");
         assertFalse(bugsnag.notify(new Throwable()));
 
         // Allow 'production'
-        bugsnag.setNotifyReleaseStages("production");
+        bugsnag.setEnabledReleaseStages("production");
         assertTrue(bugsnag.notify(new Throwable()));
 
         // Allow 'production' and others
-        bugsnag.setNotifyReleaseStages("production", "staging", "development");
+        bugsnag.setEnabledReleaseStages("production");
         assertTrue(bugsnag.notify(new Throwable()));
     }
 

bugsnag/src/test/java/com/bugsnag/SessionTrackerTest.java

@@ -14,6 +14,7 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import java.util.Collections;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
@@ -133,15 +134,15 @@ public void run() {
 
     @Test
     public void disabledReleaseStage() {
-        configuration.notifyReleaseStages = new String[]{"prod"};
+        configuration.enabledReleaseStages = Collections.singleton("prod");
         configuration.releaseStage = "dev";
         sessionTracker.startSession(new Date(), false);
         assertNull(sessionTracker.getSession());
     }
 
     @Test
     public void enabledReleaseStage() {
-        configuration.notifyReleaseStages = new String[]{"prod"};
+        configuration.enabledReleaseStages = Collections.singleton("prod");
         configuration.releaseStage = "prod";
         sessionTracker.startSession(new Date(), false);
         assertNotNull(sessionTracker.getSession());

bugsnag/src/test/resources/logback.xml

@@ -13,8 +13,8 @@
         <ignoredClass>java.io.IOException</ignoredClass>
         <ignoredClass>com.example.Custom</ignoredClass>
 
-        <notifyReleaseStage>test</notifyReleaseStage>
-        <notifyReleaseStage>development</notifyReleaseStage>
+        <enabledReleaseStage>test</enabledReleaseStage>
+        <enabledReleaseStage>development</enabledReleaseStage>
 
         <projectPackage>com.company.package1</projectPackage>
         <projectPackage>com.company.package2</projectPackage>

examples/logback/src/main/resources/logback.xml

@@ -23,8 +23,8 @@
         <!--<ignoredClass>java.io.IOException</ignoredClass>-->
         <!--<ignoredClass>com.example.Custom</ignoredClass>-->
 
-        <!--<notifyReleaseStage>production</notifyReleaseStage>-->
-        <!--<notifyReleaseStage>development</notifyReleaseStage>-->
+        <!--<enabledReleaseStage>production</enabledReleaseStage>-->
+        <!--<enabledReleaseStage>development</enabledReleaseStage>-->
 
         <!--<projectPackage>com.company.package1</projectPackage>-->
         <!--<projectPackage>com.company.package2</projectPackage>-->

features/fixtures/logback/ignore_release_stage_config.xml

@@ -7,8 +7,8 @@
         <releaseStage>staging</releaseStage>
         <appVersion>1.0.0</appVersion>
 
-		<notifyReleaseStage>production</notifyReleaseStage>
-		<notifyReleaseStage>development</notifyReleaseStage>
+		<enabledReleaseStage>production</enabledReleaseStage>
+		<enabledReleaseStage>development</enabledReleaseStage>
 
 		<endpoint>http://localhost:9339/notify</endpoint>
 	</appender>

features/fixtures/scenarios/src/main/java/com/bugsnag/mazerunner/scenarios/ArrayNotifyReleaseStageScenario.java

@@ -14,7 +14,7 @@ public ArrayNotifyReleaseStageScenario(Bugsnag bugsnag) {
     @Override
     public void run() {
         bugsnag.setReleaseStage("prod");
-        bugsnag.setNotifyReleaseStages("dev", "prod");
+        bugsnag.setEnabledReleaseStages("dev", "prod");
         bugsnag.notify(generateException());
     }
 }