Skip to content

DDB-Enhanced: Bug fix for handling special characters '#' and ':' in … #1807

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
merged 1 commit into from
May 1, 2020
+26 −8
Merged

DDB-Enhanced: Bug fix for handling special characters '#' and ':' in … #1807

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
5 changes: 5 additions & 0 deletions .changes/next-release/bugfix-AmazonDynamoDBEnhancedClient-4a4542c.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"type": "bugfix",
"category": "Amazon DynamoDB Enhanced Client",
"description": "Bugfix for handling special characters ':' and '#' in attribute names"
}
6 changes: 5 additions & 1 deletion .../src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/EnhancedClientUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,11 @@ public static String cleanAttributeName(String key) {
char[] chars = key.toCharArray();

for (int i = 0; i < chars.length; ++i) {
if (chars[i] == '*' || chars[i] == '.' || chars[i] == '-') {
if (chars[i] == '*'
|| chars[i] == '.'
|| chars[i] == '-'
|| chars[i] == '#'
|| chars[i] == ':') {
chars[i] = '_';
somethingChanged = true;
}
Expand Down
16 changes: 9 additions & 7 deletions ...src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/BasicCrudTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
import software.amazon.awssdk.services.dynamodb.model.ProjectionType;

public class BasicCrudTest extends LocalDynamoDbSyncTestBase {
private static final String ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS = "a*t:t.r-i#bute3";

private static class Record {
private String id;
private String sort;
Expand Down Expand Up @@ -181,7 +183,7 @@ public int hashCode() {
.getter(Record::getAttribute2)
.setter(Record::setAttribute2)
.tags(secondaryPartitionKey("gsi_1")))
.addAttribute(String.class, a -> a.name("attribute3")
.addAttribute(String.class, a -> a.name(ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS)
.getter(Record::getAttribute3)
.setter(Record::setAttribute3)
.tags(secondarySortKey("gsi_1")))
Expand Down Expand Up @@ -350,7 +352,7 @@ public void putWithConditionThatSucceeds() {
Expression conditionExpression = Expression.builder()
.expression("#key = :value OR #key1 = :value1")
.putExpressionName("#key", "attribute")
.putExpressionName("#key1", "attribute3")
.putExpressionName("#key1", ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS)
.putExpressionValue(":value", stringValue("wrong"))
.putExpressionValue(":value1", stringValue("three"))
.build();
Expand Down Expand Up @@ -378,7 +380,7 @@ public void putWithConditionThatFails() {
Expression conditionExpression = Expression.builder()
.expression("#key = :value OR #key1 = :value1")
.putExpressionName("#key", "attribute")
.putExpressionName("#key1", "attribute3")
.putExpressionName("#key1", ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS)
.putExpressionValue(":value", stringValue("wrong"))
.putExpressionValue(":value1", stringValue("wrong"))
.build();
Expand Down Expand Up @@ -409,7 +411,7 @@ public void deleteWithConditionThatSucceeds() {
Expression conditionExpression = Expression.builder()
.expression("#key = :value OR #key1 = :value1")
.putExpressionName("#key", "attribute")
.putExpressionName("#key1", "attribute3")
.putExpressionName("#key1", ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS)
.putExpressionValue(":value", stringValue("wrong"))
.putExpressionValue(":value1", stringValue("three"))
.build();
Expand All @@ -435,7 +437,7 @@ public void deleteWithConditionThatFails() {
Expression conditionExpression = Expression.builder()
.expression("#key = :value OR #key1 = :value1")
.putExpressionName("#key", "attribute")
.putExpressionName("#key1", "attribute3")
.putExpressionName("#key1", ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS)
.putExpressionValue(":value", stringValue("wrong"))
.putExpressionValue(":value1", stringValue("wrong"))
.build();
Expand Down Expand Up @@ -598,7 +600,7 @@ public void updateWithConditionThatSucceeds() {
Expression conditionExpression = Expression.builder()
.expression("#key = :value OR #key1 = :value1")
.putExpressionName("#key", "attribute")
.putExpressionName("#key1", "attribute3")
.putExpressionName("#key1", ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS)
.putExpressionValue(":value", stringValue("wrong"))
.putExpressionValue(":value1", stringValue("three"))
.build();
Expand Down Expand Up @@ -627,7 +629,7 @@ public void updateWithConditionThatFails() {
Expression conditionExpression = Expression.builder()
.expression("#key = :value OR #key1 = :value1")
.putExpressionName("#key", "attribute")
.putExpressionName("#key1", "attribute3")
.putExpressionName("#key1", ATTRIBUTE_NAME_WITH_SPECIAL_CHARACTERS)
.putExpressionValue(":value", stringValue("wrong"))
.putExpressionValue(":value1", stringValue("wrong"))
.build();
Expand Down
7 changes: 7 additions & 0 deletions .../test/java/software/amazon/awssdk/enhanced/dynamodb/internal/EnhancedClientUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,11 @@ public void createKeyFromMap_partitionAndSort() {
assertThat(key.partitionKeyValue()).isEqualTo(PARTITION_VALUE);
assertThat(key.sortKeyValue()).isEqualTo(Optional.of(SORT_VALUE));
}

@Test
public void cleanAttributeName_cleansSpecialCharacters() {
String result = EnhancedClientUtils.cleanAttributeName("a*b.c-d:e#f");

assertThat(result).isEqualTo("a_b_c_d_e_f");
}
}