refactor(OnErrorCallback): renamed Callback -> OnErrorCallback & removed BugsnagEvent.cancel()

Author: lemnik

bugsnag-spring/src/main/java/com/bugsnag/BugsnagSpringConfiguration.java

@@ -1,6 +1,6 @@
 package com.bugsnag;
 
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -25,15 +25,15 @@ public class BugsnagSpringConfiguration implements InitializingBean {
      * Add a callback to add the version of Spring used by the application
      */
     @Bean
-    Callback springVersionErrorCallback() {
-        Callback callback = new Callback() {
+    OnErrorCallback springVersionErrorCallback() {
+        OnErrorCallback callback = new OnErrorCallback() {
             @Override
             public boolean onError(BugsnagEvent report) {
                 addSpringRuntimeVersion(report.getDevice());
                 return true;
             }
         };
-        bugsnag.addCallback(callback);
+        bugsnag.addOnError(callback);
         return callback;
     }
 

bugsnag-spring/src/main/java/com/bugsnag/ExceptionClassCallback.java

@@ -1,7 +1,7 @@
 package com.bugsnag;
 
 import com.bugsnag.HandledState.SeverityReasonType;
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 
 import org.springframework.beans.ConversionNotSupportedException;
 import org.springframework.beans.TypeMismatchException;
@@ -35,7 +35,7 @@
  * Exceptions that automatically resolve to 500 (internal server error) responses
  * map to severity to ERROR.
  */
-class ExceptionClassCallback implements Callback {
+class ExceptionClassCallback implements OnErrorCallback {
 
     private static final Map<Class<? extends java.lang.Exception>, Severity> EXCEPTION_TO_SEVERITY;
 

bugsnag-spring/src/main/java/com/bugsnag/JakartaMvcConfiguration.java

@@ -30,6 +30,6 @@ BugsnagJakartaMvcExceptionHandler bugsnagHandlerExceptionResolver() {
      */
     @Override
     public void afterPropertiesSet() {
-        bugsnag.addCallback(new ExceptionClassCallback());
+        bugsnag.addOnError(new ExceptionClassCallback());
     }
 }

bugsnag-spring/src/main/java/com/bugsnag/SpringBootConfiguration.java

@@ -1,6 +1,6 @@
 package com.bugsnag;
 
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.SpringBootVersion;
@@ -16,15 +16,15 @@ public class SpringBootConfiguration {
      * Add a callback to add the version of Spring Boot used by the application.
      */
     @Bean
-    Callback springBootVersionErrorCallback() {
-        Callback callback = new Callback() {
+    OnErrorCallback springBootVersionErrorCallback() {
+        OnErrorCallback callback = new OnErrorCallback() {
             @Override
             public boolean onError(BugsnagEvent report) {
                 addSpringRuntimeVersion(report.getDevice());
                 return true;
             }
         };
-        bugsnag.addCallback(callback);
+        bugsnag.addOnError(callback);
         return callback;
     }
 

bugsnag-spring/src/test/java/com/bugsnag/SpringMvcTest.java

@@ -14,7 +14,7 @@
 
 import com.bugsnag.HandledState.SeverityReasonType;
 
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 import com.bugsnag.delivery.Delivery;
 
 import com.bugsnag.serialization.Serializer;
@@ -188,7 +188,7 @@ public void unhandledTypeMismatchExceptionSeverityInfo() {
     public void unhandledTypeMismatchExceptionCallbackSeverity()
             throws IllegalAccessException, NoSuchFieldException {
         BugsnagEvent event;
-        Callback callback = new Callback() {
+        OnErrorCallback callback = new OnErrorCallback() {
             @Override
             public boolean onError(BugsnagEvent report) {
                 report.setSeverity(Severity.WARNING);
@@ -197,16 +197,16 @@ public boolean onError(BugsnagEvent report) {
         };
 
         try {
-            bugsnag.addCallback(callback);
+            bugsnag.addOnError(callback);
 
             callUnhandledTypeMismatchExceptionEndpoint();
 
             event = verifyAndGetReport(delivery);
         } finally {
             // Remove the callback via reflection so that subsequent tests do not use it
             Field callbacksField = Configuration.class.getDeclaredField("callbacks");
-            @SuppressWarnings(value = "unchecked") Collection<Callback> callbacks =
-                    (Collection<Callback>) callbacksField.get(bugsnag.getConfig());
+            @SuppressWarnings(value = "unchecked") Collection<OnErrorCallback> callbacks =
+                    (Collection<OnErrorCallback>) callbacksField.get(bugsnag.getConfig());
             callbacks.remove(callback);
         }
 

bugsnag-spring/src/test/java/com/bugsnag/testapp/springboot/TestController.java

@@ -4,7 +4,7 @@
 
 import com.bugsnag.BugsnagEvent;
 import com.bugsnag.Severity;
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 
 import org.springframework.beans.TypeMismatchException;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -65,7 +65,7 @@ public void handledTypeMismatchExceptionCallbackSeverity() {
         try {
             throw new TypeMismatchException("Test", String.class);
         } catch (TypeMismatchException ex) {
-            bugsnag.notify(ex, new Callback() {
+            bugsnag.notify(ex, new OnErrorCallback() {
                 @Override
                 public boolean onError(BugsnagEvent event) {
                     event.setSeverity(Severity.WARNING);

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

@@ -1,6 +1,6 @@
 package com.bugsnag;
 
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 import com.bugsnag.delivery.Delivery;
 import com.bugsnag.delivery.HttpDelivery;
 import com.bugsnag.util.DaemonThreadFactory;
@@ -142,10 +142,10 @@ public void run() {
      * sent to Bugsnag completely.
      *
      * @param callback a callback to run before sending errors to Bugsnag
-     * @see Callback
+     * @see OnErrorCallback
      */
-    public void addCallback(Callback callback) {
-        config.addCallback(callback);
+    public void addOnError(OnErrorCallback callback) {
+        config.addOnError(callback);
     }
 
     /**
@@ -370,10 +370,10 @@ public boolean notify(Throwable throwable) {
      * Notify Bugsnag of a handled exception.
      *
      * @param throwable the exception to send to Bugsnag
-     * @param callback  the {@link Callback} object to run for this Report
+     * @param callback  the {@link OnErrorCallback} object to run for this Report
      * @return true unless the error report was ignored
      */
-    public boolean notify(Throwable throwable, Callback callback) {
+    public boolean notify(Throwable throwable, OnErrorCallback callback) {
         return notify(buildReport(throwable), callback);
     }
 
@@ -395,10 +395,10 @@ public boolean notify(Throwable throwable, Severity severity) {
      * @param throwable the exception to send to Bugsnag
      * @param severity  the severity of the error, one of {#link Severity#ERROR},
      *                  {@link Severity#WARNING} or {@link Severity#INFO}
-     * @param callback  the {@link Callback} object to run for this Report
+     * @param callback  the {@link OnErrorCallback} object to run for this Report
      * @return true unless the error report was ignored
      */
-    public boolean notify(Throwable throwable, Severity severity, Callback callback) {
+    public boolean notify(Throwable throwable, Severity severity, OnErrorCallback callback) {
         if (throwable == null) {
             LOGGER.warn("Tried to notify with a null Throwable");
             return false;
@@ -436,12 +436,12 @@ boolean notify(Throwable throwable, HandledState handledState, java.lang.Thread
      * for this particular error report.
      *
      * @param event         the {@link BugsnagEvent} object to send to Bugsnag
-     * @param reportCallback the {@link Callback} object to run for this Report
+     * @param reportCallback the {@link OnErrorCallback} object to run for this Report
      * @return false if the error report was ignored
      * @see BugsnagEvent
      * @see #buildReport
      */
-    public boolean notify(BugsnagEvent event, Callback reportCallback) {
+    public boolean notify(BugsnagEvent event, OnErrorCallback reportCallback) {
         if (event == null) {
             LOGGER.warn("Tried to call notify with a null Report");
             return false;
@@ -462,10 +462,10 @@ public boolean notify(BugsnagEvent event, Callback reportCallback) {
         }
 
         // Run all client-wide onError callbacks
-        for (Callback callback : config.callbacks) {
+        for (OnErrorCallback callback : config.callbacks) {
             try {
                 boolean proceed = callback.onError(event);
-                if (!proceed || event.getShouldCancel()) {
+                if (!proceed) {
                     LOGGER.debug("Error not reported to Bugsnag - cancelled by a client-wide onError callback");
                     return false;
                 }
@@ -481,7 +481,7 @@ public boolean notify(BugsnagEvent event, Callback reportCallback) {
         if (reportCallback != null) {
             try {
                 boolean proceed = reportCallback.onError(event);
-                if (!proceed || event.getShouldCancel()) {
+                if (!proceed) {
                     LOGGER.debug("Error not reported to Bugsnag - cancelled by a report-specific callback");
                     return false;
                 }

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

@@ -1,6 +1,6 @@
 package com.bugsnag;
 
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 import com.bugsnag.delivery.Delivery;
 import com.bugsnag.logback.BugsnagMarker;
 import com.bugsnag.logback.LogbackFeatureFlag;
@@ -120,7 +120,7 @@ protected void append(final ILoggingEvent loggingEvent) {
         if (bugsnag != null) {
             Throwable throwable = extractThrowable(loggingEvent);
 
-            final Callback reportCallback;
+            final OnErrorCallback reportCallback;
             Marker marker = loggingEvent.getMarker();
             if (marker instanceof BugsnagMarker) {
                 reportCallback = ((BugsnagMarker) marker).getCallback();
@@ -136,7 +136,7 @@ protected void append(final ILoggingEvent loggingEvent) {
                 bugsnag.notify(
                         throwable,
                         calculateSeverity(loggingEvent),
-                        new Callback() {
+                        new OnErrorCallback() {
                             @Override
                             public boolean onError(BugsnagEvent event) {
 
@@ -281,7 +281,7 @@ private Bugsnag createBugsnag() {
         }
 
         // Add a callback to put global metadata on every report
-        bugsnag.addCallback(new Callback() {
+        bugsnag.addOnError(new OnErrorCallback() {
             @Override
             public boolean onError(BugsnagEvent event) {
 
@@ -325,11 +325,11 @@ private Pattern[] compileDiscardPatterns(Collection<String> patternStrings) {
      * sent to Bugsnag completely.
      *
      * @param callback a callback to run before sending errors to Bugsnag
-     * @see Callback
+     * @see OnErrorCallback
      */
-    public void addCallback(Callback callback) {
+    public void addCallback(OnErrorCallback callback) {
         if (bugsnag != null) {
-            bugsnag.addCallback(callback);
+            bugsnag.addOnError(callback);
         }
     }
 

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

@@ -23,7 +23,6 @@ public class BugsnagEvent {
     private Severity severity;
     private String groupingHash;
     private Diagnostics diagnostics;
-    private boolean shouldCancel = false;
     private Map<String, Object> sessionMap;
     private final List<BugsnagThread> threads;
     private final FeatureFlagStore featureFlagStore;
@@ -334,15 +333,6 @@ public BugsnagEvent setUserName(String name) {
         return this;
     }
 
-    public BugsnagEvent cancel() {
-        this.shouldCancel = true;
-        return this;
-    }
-
-    public boolean getShouldCancel() {
-        return this.shouldCancel;
-    }
-
     HandledState getHandledState() {
         return handledState;
     }

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

@@ -1,7 +1,7 @@
 package com.bugsnag;
 
 import com.bugsnag.callbacks.AppCallback;
-import com.bugsnag.callbacks.Callback;
+import com.bugsnag.callbacks.OnErrorCallback;
 import com.bugsnag.callbacks.DeviceCallback;
 import com.bugsnag.callbacks.JakartaServletCallback;
 import com.bugsnag.delivery.AsyncHttpDelivery;
@@ -19,7 +19,7 @@
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
-import java.util.concurrent.ConcurrentLinkedQueue;
+import java.util.concurrent.CopyOnWriteArraySet;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.regex.Pattern;
 
@@ -37,7 +37,7 @@ public class Configuration {
     private Delivery delivery;
     private EndpointConfiguration endpoints;
     private Delivery sessionDelivery;
-    private String[] redactedKeys = new String[] {"password", "secret", "Authorization", "Cookie"};
+    private String[] redactedKeys = new String[]{"password", "secret", "Authorization", "Cookie"};
     private Set<Pattern> discardClassRegexPatterns = new HashSet<Pattern>();
     private Set<String> discardClassStringPatterns = new HashSet<String>();
     private Set<String> enabledReleaseStages = null;
@@ -46,16 +46,16 @@ public class Configuration {
     private ThreadSendPolicy sendThreads = ThreadSendPolicy.NEVER;
     private Serializer serializer = new DefaultSerializer();
 
-    Collection<Callback> callbacks = new ConcurrentLinkedQueue<Callback>();
+    Set<OnErrorCallback> callbacks = new CopyOnWriteArraySet<>();
     private final AtomicBoolean autoCaptureSessions = new AtomicBoolean(true);
     private final AtomicBoolean sendUncaughtExceptions = new AtomicBoolean(true);
     private final FeatureFlagStore featureFlagStore = new FeatureFlagStore();
 
     Configuration(String apiKey) {
         this.apiKey = apiKey;
         // Add built-in callbacks
-        addCallback(new AppCallback(this));
-        addCallback(new DeviceCallback());
+        addOnError(new AppCallback(this));
+        addOnError(new DeviceCallback());
         DeviceCallback.initializeCache();
 
         endpoints = EndpointConfiguration.fromApiKey(apiKey);
@@ -64,7 +64,7 @@ public class Configuration {
         this.sessionDelivery = new AsyncHttpDelivery(endpoints.getSessionEndpoint());
 
         if (JakartaServletCallback.isAvailable()) {
-            addCallback(new JakartaServletCallback());
+            addOnError(new JakartaServletCallback());
         }
     }
 
@@ -88,10 +88,8 @@ boolean shouldIgnoreClass(String className) {
         return false;
     }
 
-    void addCallback(Callback callback) {
-        if (!callbacks.contains(callback)) {
-            callbacks.add(callback);
-        }
+    void addOnError(OnErrorCallback callback) {
+        callbacks.add(callback);
     }
 
     boolean inProject(String className) {
@@ -348,7 +346,7 @@ public void setSerializer(Serializer serializer) {
      * Add a feature flag with the specified name and variant.
      * If the name already exists, the variant will be updated.
      *
-     * @param name the feature flag name
+     * @param name    the feature flag name
      * @param variant the feature flag variant (can be null)
      */
     public void addFeatureFlag(String name, String variant) {