refactor(sendThreads): replaced sendThreads boolean with ThreadSendPolicy

Author: lemnik

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

@@ -308,15 +308,13 @@ public void setReleaseStage(String releaseStage) {
     }
 
     /**
-     * Set whether Bugsnag should capture and report thread-state for all
-     * running threads. This is often not useful for Java web apps, since
-     * there could be thousands of active threads depending on your
-     * environment.
+     * Set when Bugsnag should capture and report thread-state for all
+     * running threads.
      *
      * @param sendThreads should we send thread state with error reports
      * @see #setEnabledReleaseStages
      */
-    public void setSendThreads(boolean sendThreads) {
+    public void setSendThreads(ThreadSendPolicy sendThreads) {
         config.setSendThreads(sendThreads);
     }
 

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

@@ -69,7 +69,7 @@ public class BugsnagAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
     private String releaseStage;
 
     /** Whether thread state should be sent to Bugsnag. */
-    private boolean sendThreads = false;
+    private ThreadSendPolicy sendThreads = ThreadSendPolicy.NEVER;
 
     /** Bugsnag API request timeout. */
     private int timeout;
@@ -527,9 +527,9 @@ public void setReleaseStage(String releaseStage) {
     }
 
     /**
-     * @see Bugsnag#setSendThreads(boolean)
+     * @see Bugsnag#setSendThreads(ThreadSendPolicy)
      */
-    public void setSendThreads(boolean sendThreads) {
+    public void setSendThreads(ThreadSendPolicy sendThreads) {
         this.sendThreads = sendThreads;
 
         if (bugsnag != null) {

bugsnag/src/main/java/com/bugsnag/BugsnagEvent.java

@@ -36,16 +36,16 @@ public class BugsnagEvent {
      */
     protected BugsnagEvent(Configuration config, Throwable throwable) {
         this(config, throwable, HandledState.newInstance(
-                HandledState.SeverityReasonType.REASON_HANDLED_EXCEPTION), java.lang.Thread.currentThread(), null);
+                HandledState.SeverityReasonType.REASON_HANDLED_EXCEPTION), Thread.currentThread(), null);
     }
 
     BugsnagEvent(Configuration config, Throwable throwable,
-                 HandledState handledState, java.lang.Thread currentThread) {
+                 HandledState handledState, Thread currentThread) {
         this(config, throwable, handledState, currentThread, null);
     }
 
     BugsnagEvent(Configuration config, Throwable throwable,
-                 HandledState handledState, java.lang.Thread currentThread, FeatureFlagStore clientFeatureFlagStore) {
+                 HandledState handledState, Thread currentThread, FeatureFlagStore clientFeatureFlagStore) {
         this.config = config;
         this.error = new BugsnagError(config, throwable);
         this.handledState = handledState;
@@ -58,9 +58,11 @@ protected BugsnagEvent(Configuration config, Throwable throwable) {
             featureFlagStore.merge(clientFeatureFlagStore);
         }
 
-        if (config.isSendThreads()) {
+        boolean sendThreads = config.getSendThreads() == ThreadSendPolicy.ALWAYS ||
+                (config.getSendThreads() == ThreadSendPolicy.UNHANDLED_ONLY && handledState.isUnhandled());
+        if (sendThreads) {
             Throwable exc = handledState.isUnhandled() ? throwable : null;
-            Map<java.lang.Thread, StackTraceElement[]> allStackTraces = java.lang.Thread.getAllStackTraces();
+            Map<Thread, StackTraceElement[]> allStackTraces = Thread.getAllStackTraces();
             threads = BugsnagThread.getLiveThreads(config, currentThread, allStackTraces, exc);
         } else {
             threads = null;

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

@@ -43,7 +43,7 @@ public class Configuration {
     private Set<String> enabledReleaseStages = null;
     private String[] projectPackages;
     private String releaseStage;
-    private boolean sendThreads = false;
+    private ThreadSendPolicy sendThreads = ThreadSendPolicy.NEVER;
     private Serializer serializer = new DefaultSerializer();
 
     Collection<Callback> callbacks = new ConcurrentLinkedQueue<Callback>();
@@ -328,11 +328,11 @@ public void setReleaseStage(String releaseStage) {
         this.releaseStage = releaseStage;
     }
 
-    public boolean isSendThreads() {
+    public ThreadSendPolicy getSendThreads() {
         return sendThreads;
     }
 
-    public void setSendThreads(boolean sendThreads) {
+    public void setSendThreads(ThreadSendPolicy sendThreads) {
         this.sendThreads = sendThreads;
     }
 

bugsnag/src/main/java/com/bugsnag/ThreadSendPolicy.java

@@ -0,0 +1,22 @@
+package com.bugsnag;
+
+/**
+ * Controls whether we should capture and serialize the state of all threads at the time of an error.
+ */
+public enum ThreadSendPolicy {
+    /**
+     * Threads should be captured for all events. This is often not useful for Java web apps, since
+     * there could be thousands of active threads depending on your environment.
+     */
+    ALWAYS,
+
+    /**
+     * Threads should be captured for unhandled events only.
+     */
+    UNHANDLED_ONLY,
+
+    /**
+     * Threads should never be captured.
+     */
+    NEVER
+}

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

@@ -138,7 +138,6 @@ public void testExceptionSeverities() {
 
     @Test
     public void testBugsnagConfig() {
-
         // Get the Bugsnag instance
         Configuration config = getConfig(appender.getClient());
         assertEquals("test", config.getReleaseStage());
@@ -175,7 +174,7 @@ public void testBugsnagConfig() {
         assertTrue(projectPackages.contains("com.company.package2"));
         assertTrue(projectPackages.contains("com.company.package1"));
 
-        assertTrue(config.isSendThreads());
+        assertEquals(ThreadSendPolicy.ALWAYS, config.getSendThreads());
     }
 
     @Test

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

@@ -438,13 +438,13 @@ public void close() {
 
     @Test
     public void testSendThreads() {
-        bugsnag.setSendThreads(true);
+        bugsnag.setSendThreads(ThreadSendPolicy.ALWAYS);
         bugsnag.setDelivery(new Delivery() {
             @Override
             public void deliver(Serializer serializer, Object object, Map<String, String> headers) {
                 BugsnagEvent event = ((Notification) object).getEvents().get(0);
                 // There is information about at least one thread
-                assertTrue(event.getThreads().size() > 0);
+                assertFalse(event.getThreads().isEmpty());
             }
 
             @Override

bugsnag/src/test/resources/logback.xml

@@ -33,7 +33,7 @@
             </tab>
         </metadata>
 
-        <sendThreads>true</sendThreads>
+        <sendThreads>ALWAYS</sendThreads>
 
 	</appender>