Skip to content

CC-42186: Sanitize DLQ WriteException/WriteConcernException (drop document BSON details) #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Sharan Rudresh (sharanrudresh) wants to merge 1 commit into
base: v2.0.x
Choose a base branch
from
+18 −16
Draft

CC-42186: Sanitize DLQ WriteException/WriteConcernException (drop document BSON details) #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions src/main/java/com/mongodb/kafka/connect/sink/dlq/WriteConcernException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,25 @@
import com.mongodb.bulk.WriteConcernError;

/**
* The {@linkplain #getMessage() message} {@linkplain Formatter format} is {@code "v=1, code=%d,
* codeName=%s, message=%s, details=%s"}, where {@code details} is JSON produced with {@link
* org.bson.BsonDocument#toJson()}. We may change it in the future, in which case the version
* (marked with {@code v}) will be incremented.
* The {@linkplain #getMessage() message} {@linkplain Formatter format} is {@code "v=2, code=%d,
* codeName=%s, message=%s"}. We may change it in the future, in which case the version (marked with
* {@code v}) will be incremented.
*
* <p>The {@code details} field (BSON of the failing document, previously emitted in {@code v=1}) is
* intentionally omitted: it carried record-derived content into the DLQ and into DEBUG logs.
*/
public final class WriteConcernException extends NoStackTraceDlqException {
private static final long serialVersionUID = 1L;
private static final int MESSAGE_FORMAT_VERSION = 1;
private static final int MESSAGE_FORMAT_VERSION = 2;

public WriteConcernException(final WriteConcernError error) {
super(
String.format(
Locale.ENGLISH,
"v=%d, code=%d, codeName=%s, message=%s, details=%s",
"v=%d, code=%d, codeName=%s, message=%s",
MESSAGE_FORMAT_VERSION,
error.getCode(),
error.getCodeName(),
error.getMessage(),
error.getDetails().toJson()));
error.getMessage()));
}
}
17 changes: 9 additions & 8 deletions src/main/java/com/mongodb/kafka/connect/sink/dlq/WriteException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,24 @@
import com.mongodb.WriteError;

/**
* The {@linkplain #getMessage() message} {@linkplain Formatter format} is {@code "v=1, code=%d,
* message=%s, details=%s"}, where {@code details} is JSON produced with {@link
* org.bson.BsonDocument#toJson()}. We may change it in the future, in which case the version
* (marked with {@code v}) will be incremented.
* The {@linkplain #getMessage() message} {@linkplain Formatter format} is {@code "v=2, code=%d,
* message=%s"}. We may change it in the future, in which case the version (marked with {@code v})
* will be incremented.
*
* <p>The {@code details} field (BSON of the failing document, previously emitted in {@code v=1}) is
* intentionally omitted: it carried record-derived content into the DLQ and into DEBUG logs.
*/
public final class WriteException extends NoStackTraceDlqException {
private static final long serialVersionUID = 1L;
private static final int MESSAGE_FORMAT_VERSION = 1;
private static final int MESSAGE_FORMAT_VERSION = 2;

public WriteException(final WriteError error) {
super(
String.format(
Locale.ENGLISH,
"v=%d, code=%d, message=%s, details=%s",
"v=%d, code=%d, message=%s",
MESSAGE_FORMAT_VERSION,
error.getCode(),
error.getMessage(),
error.getDetails().toJson()));
error.getMessage()));
}
}