Skip to content

Commit 2cc8a9c

Browse files
committed
Fix 4990, allow null values in S3 object metadata
Change tests to check keys in any order instead of relying on keySets implicit ordering.
1 parent fd73a6a commit 2cc8a9c

File tree

3 files changed

+20
-8
lines changed

3 files changed

+20
-8
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "bugfix",
3+
"category": "Amazon S3",
4+
"contributor": "dropofwill",
5+
"description": "Fixes issue 4990 allowing null values in S3 object metadata"
6+
}

services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/handlers/ObjectMetadataInterceptor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
package software.amazon.awssdk.services.s3.internal.handlers;
1717

18+
import java.util.HashMap;
1819
import java.util.Map;
19-
import java.util.stream.Collectors;
2020
import software.amazon.awssdk.annotations.SdkInternalApi;
2121
import software.amazon.awssdk.core.SdkRequest;
2222
import software.amazon.awssdk.core.interceptor.Context;
@@ -69,6 +69,6 @@ private CreateMultipartUploadRequest trimMetadataNames(CreateMultipartUploadRequ
6969

7070
private Map<String, String> trimKeys(Map<String, String> map) {
7171
return map.entrySet().stream()
72-
.collect(Collectors.toMap(e -> StringUtils.trim(e.getKey()), Map.Entry::getValue));
72+
.collect(HashMap::new, (hm, entry) -> hm.put(StringUtils.trim(entry.getKey()), entry.getValue()), HashMap::putAll);
7373
}
7474
}

services/s3/src/test/java/software/amazon/awssdk/services/s3/internal/handlers/ObjectMetadataInterceptorTest.java

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import static org.mockito.Mockito.mock;
2121
import static org.mockito.Mockito.when;
2222

23+
import java.util.ArrayList;
2324
import java.util.List;
2425
import java.util.Map;
2526
import java.util.stream.Collectors;
@@ -37,15 +38,20 @@
3738
public class ObjectMetadataInterceptorTest {
3839
private static final ObjectMetadataInterceptor INTERCEPTOR = new ObjectMetadataInterceptor();
3940

40-
41-
4241
public static List<TestCase> testCases() {
42+
List<String> listWithNulls = new ArrayList<>();
43+
listWithNulls.add("\tc\r\n");
44+
listWithNulls.add(null);
45+
46+
List<String> listWithNullsTrimmed = new ArrayList<>();
47+
listWithNullsTrimmed.add("c");
48+
listWithNullsTrimmed.add(null);
4349
return asList(
4450
tc(asList("a", "b", "c"), asList("a", "b", "c")),
4551
tc(asList(" a ", "b", "c"), asList("a", "b", "c")),
4652
tc(asList(" a", "\tb", "\tc"), asList("a", "b", "c")),
47-
tc(asList("a\n", "\tb", "\tc\r\n"), asList("a", "b", "c"))
48-
53+
tc(asList("a\n", "\tb", "\tc\r\n"), asList("a", "b", "c")),
54+
tc(listWithNulls, listWithNullsTrimmed)
4955
);
5056
}
5157

@@ -68,7 +74,7 @@ public void modifyRequest_putObject_metadataKeysAreTrimmed(TestCase tc) {
6874

6975
PutObjectRequest modified = (PutObjectRequest) INTERCEPTOR.modifyRequest(ctx, attrs);
7076

71-
assertThat(modified.metadata().keySet()).containsExactlyElementsOf(tc.expectedKeys);
77+
assertThat(modified.metadata().keySet()).containsOnlyOnceElementsOf(tc.expectedKeys);
7278
}
7379

7480
@ParameterizedTest
@@ -90,7 +96,7 @@ public void modifyRequest_creatMultipartUpload_metadataKeysAreTrimmed(TestCase t
9096

9197
CreateMultipartUploadRequest modified = (CreateMultipartUploadRequest) INTERCEPTOR.modifyRequest(ctx, attrs);
9298

93-
assertThat(modified.metadata().keySet()).containsExactlyElementsOf(tc.expectedKeys);
99+
assertThat(modified.metadata().keySet()).containsOnlyOnceElementsOf(tc.expectedKeys);
94100
}
95101

96102
@Test

0 commit comments

Comments
 (0)