Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions bugsnag/src/main/java/com/bugsnag/Bugsnag.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.regex.Pattern;

public class Bugsnag implements Closeable {
private static final Logger LOGGER = LoggerFactory.getLogger(Bugsnag.class);
Expand Down Expand Up @@ -241,10 +242,11 @@ public void setRedactedKeys(String... redactedKeys) {

/**
* Set which exception classes should be ignored (not sent) by Bugsnag.
* Uses Java regex patterns for matching exception class names.
*
* @param discardClasses a list of exception classes to ignore
* @param discardClasses compiled regex patterns to match exception class names
*/
public void setDiscardClasses(String... discardClasses) {
public void setDiscardClasses(Pattern... discardClasses) {
config.setDiscardClasses(discardClasses);
}

Expand Down
26 changes: 21 additions & 5 deletions bugsnag/src/main/java/com/bugsnag/BugsnagAppender.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import java.net.Proxy;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
Expand Down Expand Up @@ -262,7 +263,7 @@ private Bugsnag createBugsnag() {
bugsnag.setRedactedKeys(redactedKeys.toArray(new String[0]));
}

bugsnag.setDiscardClasses(discardClasses.toArray(new String[0]));
bugsnag.setDiscardClasses(compileDiscardPatterns(discardClasses));

if (!enabledReleaseStages.isEmpty()) {
bugsnag.setEnabledReleaseStages(enabledReleaseStages.toArray(new String[0]));
Expand Down Expand Up @@ -293,6 +294,21 @@ public boolean onError(Report report) {
return bugsnag;
}

/**
* Compiles a collection of pattern strings into an array of Pattern objects.
*
* @param patternStrings the collection of pattern strings to compile
* @return an array of compiled Pattern objects
*/
private Pattern[] compileDiscardPatterns(Collection<String> patternStrings) {
Pattern[] patterns = new Pattern[patternStrings.size()];
int idx = 0;
for (String pattern : patternStrings) {
patterns[idx++] = Pattern.compile(pattern);
}
return patterns;
}

/**
* Add a callback to execute code before/after every notification to Bugsnag.
*
Expand Down Expand Up @@ -406,24 +422,24 @@ public void setIgnoredClass(String ignoredClass) {
}

/**
* @see Bugsnag#setDiscardClasses(String...)
* @see Bugsnag#setDiscardClasses(Pattern...)
*/
public void setDiscardClass(String discardClass) {
this.discardClasses.add(discardClass);

if (bugsnag != null) {
bugsnag.setDiscardClasses(this.discardClasses.toArray(new String[0]));
bugsnag.setDiscardClasses(compileDiscardPatterns(this.discardClasses));
}
}

/**
* @see Bugsnag#setDiscardClasses(String...)
* @see Bugsnag#setDiscardClasses(Pattern...)
*/
public void setDiscardClasses(String discardClasses) {
this.discardClasses.addAll(split(discardClasses));

if (bugsnag != null) {
bugsnag.setDiscardClasses(this.discardClasses.toArray(new String[0]));
bugsnag.setDiscardClasses(compileDiscardPatterns(this.discardClasses));
}
}

Expand Down
63 changes: 53 additions & 10 deletions bugsnag/src/main/java/com/bugsnag/Configuration.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.regex.Pattern;

@SuppressWarnings("visibilitymodifier")
public class Configuration {
Expand All @@ -38,7 +38,8 @@ public class Configuration {
private EndpointConfiguration endpoints;
private Delivery sessionDelivery;
private String[] redactedKeys = new String[] {"password", "secret", "Authorization", "Cookie"};
private String[] discardClasses;
private Set<Pattern> discardClassRegexPatterns = new HashSet<Pattern>();
private Set<String> discardClassStringPatterns = new HashSet<String>();
Comment on lines +41 to +42
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not clear why we have the discardClassStringPatterns here at all. It's written to, but we never seem to read from it?

private Set<String> enabledReleaseStages = null;
private String[] projectPackages;
private String releaseStage;
Expand Down Expand Up @@ -74,12 +75,16 @@ boolean shouldNotifyForReleaseStage() {
}

boolean shouldIgnoreClass(String className) {
if (discardClasses == null) {
if (discardClassRegexPatterns == null || discardClassRegexPatterns.isEmpty()) {
return false;
}

List<String> classes = Arrays.asList(discardClasses);
return classes.contains(className);
for (Pattern pattern : discardClassRegexPatterns) {
if (pattern.matcher(className).matches()) {
return true;
}
}
return false;
}

void addCallback(Callback callback) {
Expand Down Expand Up @@ -252,12 +257,50 @@ public void setRedactedKeys(String[] redactedKeys) {
this.redactedKeys = redactedKeys;
}

public String[] getDiscardClasses() {
return discardClasses;
public Pattern[] getDiscardClasses() {
return discardClassRegexPatterns.toArray(new Pattern[0]);
}

public void setDiscardClasses(String[] discardClasses) {
this.discardClasses = discardClasses;
/**
* Set which exception classes should be ignored (not sent) by Bugsnag.
* Uses Java regex patterns for matching exception class names.
*
* @param discardClasses a list of compiled regex patterns to match exception class names
*/
public void setDiscardClasses(Pattern[] discardClasses) {
this.discardClassRegexPatterns.clear();
this.discardClassStringPatterns.clear();
if (discardClasses != null) {
for (Pattern pattern : discardClasses) {
if (pattern != null) {
// Store pattern
this.discardClassRegexPatterns.add(pattern);
// Store string representation for serialization
this.discardClassStringPatterns.add(pattern.pattern());
}
}
}
}

/**
* Set which exception classes should be ignored (not sent) by Bugsnag.
* Compiles the provided strings as Java regex patterns.
*
* @param discardClasses a list of regex pattern strings to match exception class names
*/
public void setDiscardClassesFromStrings(String[] discardClasses) {
this.discardClassRegexPatterns.clear();
this.discardClassStringPatterns.clear();
if (discardClasses != null) {
for (String patternStr : discardClasses) {
if (patternStr != null && !patternStr.isEmpty()) {
// Store original pattern string
this.discardClassStringPatterns.add(patternStr);
// Compile as regex pattern
this.discardClassRegexPatterns.add(Pattern.compile(patternStr));
}
}
}
}

public Set<String> getEnabledReleaseStages() {
Expand Down
17 changes: 14 additions & 3 deletions bugsnag/src/test/java/com/bugsnag/AppenderTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;

/**
* Test for the Bugsnag Appender
Expand Down Expand Up @@ -148,9 +149,19 @@ public void testBugsnagConfig() {
assertTrue(redactedKeys.contains("credit_card_number"));

assertEquals(2, config.getDiscardClasses().length);
ArrayList<String> discardClasses = new ArrayList<String>(Arrays.asList(config.getDiscardClasses()));
assertTrue(discardClasses.contains("com.example.Custom"));
assertTrue(discardClasses.contains("java.io.IOException"));
Pattern[] discardPatterns = config.getDiscardClasses();
boolean hasCustom = false;
boolean hasIoException = false;
for (Pattern pattern : discardPatterns) {
if (pattern.pattern().equals("com.example.Custom")) {
hasCustom = true;
}
if (pattern.pattern().equals("java.io.IOException")) {
hasIoException = true;
}
}
assertTrue(hasCustom);
assertTrue(hasIoException);

assertEquals(2, config.getEnabledReleaseStages().size());
assertTrue(config.getEnabledReleaseStages().contains("development"));
Expand Down
12 changes: 8 additions & 4 deletions bugsnag/src/test/java/com/bugsnag/BugsnagTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

public class BugsnagTest {

Expand Down Expand Up @@ -61,13 +62,16 @@ public void testIgnoreClasses() {
assertTrue(bugsnag.notify(new RuntimeException()));
assertTrue(bugsnag.notify(new TestException()));

// Ignore just RuntimeException
bugsnag.setDiscardClasses(RuntimeException.class.getName());
// Ignore just RuntimeException (compile pattern for exact match)
bugsnag.setDiscardClasses(Pattern.compile(Pattern.quote(RuntimeException.class.getName())));
assertFalse(bugsnag.notify(new RuntimeException()));
assertTrue(bugsnag.notify(new TestException()));

// Ignore both
bugsnag.setDiscardClasses(RuntimeException.class.getName(), TestException.class.getName());
// Ignore both (compile patterns for exact matches)
bugsnag.setDiscardClasses(
Pattern.compile(Pattern.quote(RuntimeException.class.getName())),
Pattern.compile(Pattern.quote(TestException.class.getName()))
);
assertFalse(bugsnag.notify(new RuntimeException()));
assertFalse(bugsnag.notify(new TestException()));
}
Expand Down
120 changes: 120 additions & 0 deletions bugsnag/src/test/java/com/bugsnag/ConfigurationDiscardClassesTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
package com.bugsnag;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import org.junit.Before;
import org.junit.Test;

import java.util.regex.Pattern;

/**
* Test for Configuration.shouldIgnoreClass with regex pattern matching
*/
public class ConfigurationDiscardClassesTest {

private Configuration config;

@Before
public void setUp() {
config = new Configuration("test-api-key");
}

@Test
public void testExactMatch() {
config.setDiscardClasses(new Pattern[] {Pattern.compile("com.example.CustomException")});

assertTrue(config.shouldIgnoreClass("com.example.CustomException"));
assertFalse(config.shouldIgnoreClass("com.example.OtherException"));
}

@Test
public void testWildcardMatch() {
config.setDiscardClasses(new Pattern[] {Pattern.compile("com\\.example\\..*")});

assertTrue(config.shouldIgnoreClass("com.example.CustomException"));
assertTrue(config.shouldIgnoreClass("com.example.OtherException"));
assertTrue(config.shouldIgnoreClass("com.example."));
assertFalse(config.shouldIgnoreClass("com.other.Exception"));
}

@Test
public void testMultipleWildcards() {
config.setDiscardClasses(new Pattern[] {Pattern.compile("com\\..*\\.Exception")});

assertTrue(config.shouldIgnoreClass("com.example.Exception"));
assertTrue(config.shouldIgnoreClass("com.other.Exception"));
assertFalse(config.shouldIgnoreClass("com.example.CustomException"));
}

@Test
public void testQuestionMarkWildcard() {
config.setDiscardClasses(new Pattern[] {Pattern.compile("com\\.example\\.Exception.")});

assertTrue(config.shouldIgnoreClass("com.example.Exception1"));
assertTrue(config.shouldIgnoreClass("com.example.ExceptionX"));
assertFalse(config.shouldIgnoreClass("com.example.Exception"));
assertFalse(config.shouldIgnoreClass("com.example.Exception12"));
}

@Test
public void testMultiplePatterns() {
config.setDiscardClasses(new Pattern[] {
Pattern.compile("java\\.io\\..*"),
Pattern.compile("com\\.example\\.CustomException"),
Pattern.compile("org\\..*\\.SpecialException")
});

assertTrue(config.shouldIgnoreClass("java.io.IOException"));
assertTrue(config.shouldIgnoreClass("java.io.FileNotFoundException"));
assertTrue(config.shouldIgnoreClass("com.example.CustomException"));
assertTrue(config.shouldIgnoreClass("org.apache.SpecialException"));
assertTrue(config.shouldIgnoreClass("org.springframework.SpecialException"));
assertFalse(config.shouldIgnoreClass("com.example.OtherException"));
}

@Test
public void testGetDiscardClassesReturnsOriginalPatterns() {
Pattern[] patterns = new Pattern[] {
Pattern.compile("com\\.example\\..*"),
Pattern.compile("java\\.io\\.IOException")
};
config.setDiscardClasses(patterns);

Pattern[] retrieved = config.getDiscardClasses();
assertEquals(2, retrieved.length);

// Check that patterns are returned
boolean hasWildcard = false;
boolean hasExact = false;
for (Pattern pattern : retrieved) {
if (pattern.pattern().equals("com\\.example\\..*")) {
hasWildcard = true;
}
if (pattern.pattern().equals("java\\.io\\.IOException")) {
hasExact = true;
}
}
assertTrue(hasWildcard);
assertTrue(hasExact);
}

@Test
public void testEmptyAndNullPatterns() {
config.setDiscardClasses(new Pattern[] {});
assertFalse(config.shouldIgnoreClass("com.example.Exception"));

config.setDiscardClasses(null);
assertFalse(config.shouldIgnoreClass("com.example.Exception"));
}

@Test
public void testSpecialCharactersAreEscaped() {
// In regex, $ is a special character (end of line), so it needs to be escaped
config.setDiscardClasses(new Pattern[] {Pattern.compile("com\\.example\\.Exception\\$Inner")});

assertTrue(config.shouldIgnoreClass("com.example.Exception$Inner"));
assertFalse(config.shouldIgnoreClass("com.example.ExceptionXInner"));
}
}
18 changes: 18 additions & 0 deletions features/fixtures/logback/ignored_class_wildcard_config.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/base.xml" />

<appender name="BUGSNAG" class="com.bugsnag.BugsnagAppender">
<apiKey>a35a2a72bd230ac0aa0f52715bbdc6aa</apiKey>
<releaseStage>production</releaseStage>
<appVersion>1.0.0</appVersion>

<discardClass>java\.lang\..*</discardClass>

<endpoint>http://localhost:9339/notify</endpoint>
</appender>

<root level="INFO">
<appender-ref ref="BUGSNAG"/>
</root>
</configuration>
Loading