Skip to content
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

Fixed a bug where null values are not handled properly when S3EventNo… #5770

Merged
merged 2 commits into from
Jan 4, 2025
Merged

Fixed a bug where null values are not handled properly when S3EventNo… #5770

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
ca8dd82
Fixed a bug where null values are not handled properly when S3EventNo…
zoewangg Jan 3, 2025
09183c0
Merge branch 'master' into zoewang/S3EventNotificationFix
zoewangg Jan 4, 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
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-S3EventNotifications-86f3901.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "S3 Event Notifications",
"contributor": "",
"description": "Fixed a bug where null values are not handled properly when `S3EventNotification#fromJson` is invoked, throwing `IllegalArgumentException`. See [#5730](https://github.com/aws/aws-sdk-java-v2/issues/5730)"
}
14 changes: 9 additions & 5 deletions ...ftware/amazon/awssdk/eventnotifications/s3/internal/DefaultS3EventNotificationReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ private S3EventNotification readEvent(JsonNode jsonNode) {
}

private List<S3EventNotificationRecord> readRecords(JsonNode node) {
if (node == null || node.isNull()) {
if (isNull(node)) {
return null;
}
List<JsonNode> recordArray = expectArrayOrNull(node, "Records");
Expand Down Expand Up @@ -274,23 +274,27 @@ private String expectStringOrNull(Map<String, JsonNode> node, String name) {
}

private String expectStringOrNull(JsonNode node, String name) {
if (node == null) {
if (isNull(node)) {
return null;
}
Validate.isTrue(node.isString(), "'%s' was not a string", name);
return node.asString();
}

private static boolean isNull(JsonNode node) {
return node == null || node.isNull();
}

private List<JsonNode> expectArrayOrNull(JsonNode node, String name) {
if (node == null) {
if (isNull(node)) {
return null;
}
Validate.isTrue(node.isArray(), "expected '%s' to be an array, but was not.", name);
return node.asArray();
}

private Map<String, JsonNode> expectObjectOrNull(JsonNode node, String name) {
if (node == null) {
if (isNull(node)) {
return null;
}
return expectObject(node, name);
Expand All @@ -302,7 +306,7 @@ private Map<String, JsonNode> expectObject(JsonNode node, String name) {
}

private Long expectLong(JsonNode node, String name) {
if (node == null) {
if (isNull(node)) {
return null;
}
Validate.isTrue(node.isNumber(), "expected '%s' to be numeric, but was not", name);
Expand Down
69 changes: 69 additions & 0 deletions ...ava/software/amazon/awssdk/eventnotifications/s3/model/S3EventNotificationReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,75 @@

class S3EventNotificationReaderTest {

@Test
void fromJson_containsNullValues_shouldSucceed() {
S3EventNotification eventNotification = new S3EventNotification(
Collections.singletonList(new S3EventNotificationRecord(
"us-west-2",
"ObjectCreated:Put",
"aws:s3",
"1970-01-01T00:00:00.000Z",
"2.1",
null,
new ResponseElements(
null, null),
new S3(
"testConfigRule",
new S3Bucket(
"mybucket",
new UserIdentity("A3NL1KOZZKExample"),
"arn:aws:s3:::mybucket"),
new S3Object(
"HappyFace.jpg",
null,
"d41d8cd98f00b204e9800998ecf8427e",
null,
"0055AED6DCD90281E5"),
"1.0"
),
new UserIdentity("AIDAJDPLRKLG7UEXAMPLE"),
null, null, null, null)
));
String json = eventNotification.toJsonPretty();
assertThat(json).isEqualTo("{\n"
+ " \"Records\" : [ {\n"
+ " \"eventVersion\" : \"2.1\",\n"
+ " \"eventSource\" : \"aws:s3\",\n"
+ " \"awsRegion\" : \"us-west-2\",\n"
+ " \"eventTime\" : \"1970-01-01T00:00:00Z\",\n"
+ " \"eventName\" : \"ObjectCreated:Put\",\n"
+ " \"userIdentity\" : {\n"
+ " \"principalId\" : \"AIDAJDPLRKLG7UEXAMPLE\"\n"
+ " },\n"
+ " \"requestParameters\" : null,\n"
+ " \"responseElements\" : {\n"
+ " \"x-amz-request-id\" : null,\n"
+ " \"x-amz-id-2\" : null\n"
+ " },\n"
+ " \"s3\" : {\n"
+ " \"s3SchemaVersion\" : \"1.0\",\n"
+ " \"configurationId\" : \"testConfigRule\",\n"
+ " \"bucket\" : {\n"
+ " \"name\" : \"mybucket\",\n"
+ " \"ownerIdentity\" : {\n"
+ " \"principalId\" : \"A3NL1KOZZKExample\"\n"
+ " },\n"
+ " \"arn\" : \"arn:aws:s3:::mybucket\"\n"
+ " },\n"
+ " \"object\" : {\n"
+ " \"key\" : \"HappyFace.jpg\",\n"
+ " \"size\" : null,\n"
+ " \"eTag\" : \"d41d8cd98f00b204e9800998ecf8427e\",\n"
+ " \"versionId\" : null,\n"
+ " \"sequencer\" : \"0055AED6DCD90281E5\"\n"
+ " }\n"
+ " }\n"
+ " } ]\n"
+ "}");
S3EventNotification actual = S3EventNotification.fromJson(json);
assertThat(actual).isEqualTo(eventNotification);
}

@Test
void givenEventWithoutOptionalFields_whenReadingJson_expectOnlyRequiredFields() {
String eventJson = "{ "
Expand Down
Loading