Skip to content

Increase test coverage and bug fix in JacksonEvent #6181

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

Merged
dlvenable merged 2 commits into from
Nov 4, 2025
Merged

Increase test coverage and bug fix in JacksonEvent #6181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f91303
Increase test coverage in JacksonEvent and fix a bug with trying to m…
dlvenable Oct 16, 2025
55722e9
Further improvement for normalizing keys.
dlvenable Oct 17, 2025
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
23 changes: 11 additions & 12 deletions data-prepper-api/src/main/java/org/opensearch/dataprepper/model/event/JacksonEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,31 +150,29 @@ public JsonNode getJsonNode() {
return jsonNode;
}

void normalizeKeys(Map<String, Object> map) {
Map<String, Object> toAdd = new HashMap<>();
private Map<String, Object> normalizeKeys(final Map<String, Object> map) {

@san81 san81 Oct 20, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is it possible that there could be existing use cases that are functioning based on the expectation that the map they are passing gets modified?

@dlvenable dlvenable Oct 20, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@san81 , Possibly, but I don't think we should support that. For example, if you create the Map in the builder that always copies.

final Map<String, Object> replacementMap = new HashMap<>();
Iterator<Map.Entry<String, Object>> iterator = map.entrySet().iterator();
while (iterator.hasNext()) {
Map.Entry<String, Object> entry = iterator.next();
String key = entry.getKey();
Object value = entry.getValue();
final String newKey = JacksonEventKey.replaceInvalidCharacters(key);
if (value instanceof Map) {
normalizeKeys((Map<String, Object>)value);
}
if (!newKey.equals(key)) {
toAdd.put(newKey, value);
iterator.remove();
value = normalizeKeys((Map<String, Object>)value);
}
replacementMap.put(newKey, value);
}
map.putAll(toAdd);
return replacementMap;
}

@Override
public void put(EventKey key, Object value, boolean replaceInvalidCharacters) {
if (replaceInvalidCharacters && (value instanceof Map)) {
normalizeKeys((Map<String, Object>)value);
put(key, normalizeKeys((Map<String, Object>)value));
} else {
put(key, value);
}
put(key, value);
}

@Override
Expand Down Expand Up @@ -203,13 +201,14 @@ public void put(EventKey key, Object value) {

@Override
public void put(String key, final Object value, final boolean replaceInvalidCharacters) {
Object valueToPut = value;
if (replaceInvalidCharacters) {
key = JacksonEventKey.replaceInvalidCharacters(key);
if (value instanceof Map) {
normalizeKeys((Map<String, Object>)value);
valueToPut = normalizeKeys((Map<String, Object>)value);
}
}
put(key, value);
put(key, valueToPut);
}

public EventFailureMetadata updateFailureMetadata() {
Expand Down
31 changes: 31 additions & 0 deletions data-prepper-api/src/test/java/org/opensearch/dataprepper/model/event/JacksonEventTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,37 @@ public void testPutWithReplaceInvalidKeyChars(final String key) {
assertThat(event.get("key_1", String.class), equalTo(value));
}

@ParameterizedTest
@ValueSource(strings = {"key&1", "key^1", "key%1", "key_1"})
public void testPutWithReplaceInvalidKeyChars_for_map(final String key) {
final String value = UUID.randomUUID().toString();
final Map<String, String> mapToPut = Map.of(key, value);

event.put("myMap", mapToPut, true);
assertThat(event.get("myMap/key_1", String.class), equalTo(value));
}

@ParameterizedTest
@ValueSource(strings = {"key&1", "key^1", "key%1", "key_1"})
public void testPutEventKeyWithReplaceInvalidKeyChars_for_map(final String key) {
final String value = UUID.randomUUID().toString();
final Map<String, String> mapToPut = Map.of(key, value);

final EventKey eventKey = new JacksonEventKey("myMap");
event.put(eventKey, mapToPut, true);
assertThat(event.get("myMap/key_1", String.class), equalTo(value));
}

@ParameterizedTest
@ValueSource(strings = {"key&1", "key^1", "key%1", "key_1"})
public void testPutEventKeyWithReplaceInvalidKeyCharsFalse_for_map(final String key) {
final String value = UUID.randomUUID().toString();
final Map<String, String> mapToPut = Map.of(key, value);

final EventKey eventKey = new JacksonEventKey("myMap");
event.put(eventKey, mapToPut, false);

@san81 san81 Oct 20, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

No assertion needed here?

}

@ParameterizedTest
@ValueSource(strings = {"key&1", "key^1", "key%1"})
public void testPutWithoutReplaceInvalidKeyChars(final String key) {
Expand Down
Loading