Fixed bug in VersionedRecord that did not allow special characters in…

.changes/next-release/bugfix-AmazonDynamoDBEnhanced-c9b596d.json

@@ -0,0 +1,6 @@
+{
+    "category": "Amazon DynamoDB Enhanced", 
+    "contributor": "", 
+    "type": "bugfix", 
+    "description": "Adding usage of ExpressionNames to VersionedRecord, thereby allowing version attributes with reserved words and special characters"
+}

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/extensions/AtomicCounterExtension.java

@@ -15,9 +15,9 @@
 
 package software.amazon.awssdk.enhanced.dynamodb.extensions;
 
+import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.keyRef;
+import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.valueRef;
 import static software.amazon.awssdk.enhanced.dynamodb.internal.update.UpdateExpressionUtils.ifNotExists;
-import static software.amazon.awssdk.enhanced.dynamodb.internal.update.UpdateExpressionUtils.keyRef;
-import static software.amazon.awssdk.enhanced.dynamodb.internal.update.UpdateExpressionUtils.valueRef;
 
 import java.util.Collections;
 import java.util.HashMap;

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/extensions/VersionedRecordExtension.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.enhanced.dynamodb.extensions;
 
 import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.isNullAttributeValue;
+import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.keyRef;
 
 import java.util.Collections;
 import java.util.HashMap;
@@ -56,7 +57,7 @@
 @SdkPublicApi
 @ThreadSafe
 public final class VersionedRecordExtension implements DynamoDbEnhancedClientExtension {
-    private static final Function<String, String> EXPRESSION_KEY_MAPPER = key -> ":old_" + key + "_value";
+    private static final Function<String, String> VERSIONED_RECORD_EXPRESSION_VALUE_KEY_MAPPER = key -> ":old_" + key + "_value";
     private static final String CUSTOM_METADATA_KEY = "VersionedRecordExtension:VersionAttribute";
     private static final VersionAttribute VERSION_ATTRIBUTE = new VersionAttribute();
 
@@ -101,6 +102,8 @@ public WriteModification beforeWrite(DynamoDbExtensionContext.BeforeWrite contex
         }
 
         Map<String, AttributeValue> itemToTransform = new HashMap<>(context.items());
+
+        String attributeKeyRef = keyRef(versionAttributeKey.get());
         AttributeValue newVersionValue;
         Expression condition;
         Optional<AttributeValue> existingVersionValue =
@@ -110,7 +113,8 @@ public WriteModification beforeWrite(DynamoDbExtensionContext.BeforeWrite contex
             // First version of the record
             newVersionValue = AttributeValue.builder().n("1").build();
             condition = Expression.builder()
-                                  .expression(String.format("attribute_not_exists(%s)", versionAttributeKey.get()))
+                                  .expression(String.format("attribute_not_exists(%s)", attributeKeyRef))
+                                  .expressionNames(Collections.singletonMap(attributeKeyRef, versionAttributeKey.get()))
                                   .build();
         } else {
             // Existing record, increment version
@@ -120,11 +124,11 @@ public WriteModification beforeWrite(DynamoDbExtensionContext.BeforeWrite contex
             }
 
             int existingVersion = Integer.parseInt(existingVersionValue.get().n());
-            String existingVersionValueKey = EXPRESSION_KEY_MAPPER.apply(versionAttributeKey.get());
+            String existingVersionValueKey = VERSIONED_RECORD_EXPRESSION_VALUE_KEY_MAPPER.apply(versionAttributeKey.get());
             newVersionValue = AttributeValue.builder().n(Integer.toString(existingVersion + 1)).build();
             condition = Expression.builder()
-                                  .expression(String.format("%s = %s", versionAttributeKey.get(),
-                                                            existingVersionValueKey))
+                                  .expression(String.format("%s = %s", attributeKeyRef, existingVersionValueKey))
+                                  .expressionNames(Collections.singletonMap(attributeKeyRef, versionAttributeKey.get()))
                                   .expressionValues(Collections.singletonMap(existingVersionValueKey,
                                                                              existingVersionValue.get()))
                                   .build();

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/EnhancedClientUtils.java

@@ -67,6 +67,20 @@ public static String cleanAttributeName(String key) {
         return somethingChanged ? new String(chars) : key;
     }
 
+    /**
+     * Creates a key token to be used with an ExpressionNames map.
+     */
+    public static String keyRef(String key) {
+        return "#AMZN_MAPPED_" + cleanAttributeName(key);
+    }
+
+    /**
+     * Creates a value token to be used with an ExpressionValues map.
+     */
+    public static String valueRef(String value) {
+        return ":AMZN_MAPPED_" + cleanAttributeName(value);
+    }
+
     public static <T> T readAndTransformSingleItem(Map<String, AttributeValue> itemMap,
                                             TableSchema<T> tableSchema,
                                             OperationContext operationContext,

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/conditional/BeginsWithConditional.java

@@ -16,25 +16,20 @@
 package software.amazon.awssdk.enhanced.dynamodb.internal.conditional;
 
 import static software.amazon.awssdk.enhanced.dynamodb.internal.AttributeValues.nullAttributeValue;
-import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.cleanAttributeName;
 
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.function.UnaryOperator;
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.enhanced.dynamodb.Expression;
 import software.amazon.awssdk.enhanced.dynamodb.Key;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
+import software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils;
 import software.amazon.awssdk.enhanced.dynamodb.model.QueryConditional;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 @SdkInternalApi
 public class BeginsWithConditional implements QueryConditional {
-    private static final UnaryOperator<String> EXPRESSION_KEY_MAPPER =
-        k -> "#AMZN_MAPPED_" + cleanAttributeName(k);
-    private static final UnaryOperator<String> EXPRESSION_VALUE_KEY_MAPPER =
-        k -> ":AMZN_MAPPED_" + cleanAttributeName(k);
 
     private final Key key;
 
@@ -56,10 +51,10 @@ public Expression expression(TableSchema<?> tableSchema, String indexName) {
                                                + "a numeric sort key.");
         }
 
-        String partitionKeyToken = EXPRESSION_KEY_MAPPER.apply(queryConditionalKeyValues.partitionKey());
-        String partitionValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(queryConditionalKeyValues.partitionKey());
-        String sortKeyToken = EXPRESSION_KEY_MAPPER.apply(queryConditionalKeyValues.sortKey());
-        String sortValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(queryConditionalKeyValues.sortKey());
+        String partitionKeyToken = EnhancedClientUtils.keyRef(queryConditionalKeyValues.partitionKey());
+        String partitionValueToken = EnhancedClientUtils.valueRef(queryConditionalKeyValues.partitionKey());
+        String sortKeyToken = EnhancedClientUtils.keyRef(queryConditionalKeyValues.sortKey());
+        String sortValueToken = EnhancedClientUtils.valueRef(queryConditionalKeyValues.sortKey());
 
         String queryExpression = String.format("%s = %s AND begins_with ( %s, %s )",
                                                partitionKeyToken,

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/conditional/BetweenConditional.java

@@ -26,15 +26,13 @@
 import software.amazon.awssdk.enhanced.dynamodb.Expression;
 import software.amazon.awssdk.enhanced.dynamodb.Key;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
+import software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils;
 import software.amazon.awssdk.enhanced.dynamodb.model.QueryConditional;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 @SdkInternalApi
 public class BetweenConditional implements QueryConditional {
-    private static final UnaryOperator<String> EXPRESSION_KEY_MAPPER =
-        k -> "#AMZN_MAPPED_" + cleanAttributeName(k);
-    private static final UnaryOperator<String> EXPRESSION_VALUE_KEY_MAPPER =
-        k -> ":AMZN_MAPPED_" + cleanAttributeName(k);
+
     private static final UnaryOperator<String> EXPRESSION_OTHER_VALUE_KEY_MAPPER =
         k -> ":AMZN_MAPPED_" + cleanAttributeName(k) + "2";
 
@@ -57,10 +55,10 @@ public Expression expression(TableSchema<?> tableSchema, String indexName) {
                                                + "of the items has a null sort key.");
         }
 
-        String partitionKeyToken = EXPRESSION_KEY_MAPPER.apply(queryConditionalKeyValues1.partitionKey());
-        String partitionValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(queryConditionalKeyValues1.partitionKey());
-        String sortKeyToken = EXPRESSION_KEY_MAPPER.apply(queryConditionalKeyValues1.sortKey());
-        String sortKeyValueToken1 = EXPRESSION_VALUE_KEY_MAPPER.apply(queryConditionalKeyValues1.sortKey());
+        String partitionKeyToken = EnhancedClientUtils.keyRef(queryConditionalKeyValues1.partitionKey());
+        String partitionValueToken = EnhancedClientUtils.valueRef(queryConditionalKeyValues1.partitionKey());
+        String sortKeyToken = EnhancedClientUtils.keyRef(queryConditionalKeyValues1.sortKey());
+        String sortKeyValueToken1 = EnhancedClientUtils.valueRef(queryConditionalKeyValues1.sortKey());
         String sortKeyValueToken2 = EXPRESSION_OTHER_VALUE_KEY_MAPPER.apply(queryConditionalKeyValues2.sortKey());
 
         String queryExpression = String.format("%s = %s AND %s BETWEEN %s AND %s",

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/conditional/EqualToConditional.java

@@ -16,27 +16,22 @@
 package software.amazon.awssdk.enhanced.dynamodb.internal.conditional;
 
 import static software.amazon.awssdk.enhanced.dynamodb.internal.AttributeValues.nullAttributeValue;
-import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.cleanAttributeName;
 import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.isNullAttributeValue;
 
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
-import java.util.function.UnaryOperator;
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.enhanced.dynamodb.Expression;
 import software.amazon.awssdk.enhanced.dynamodb.Key;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
+import software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils;
 import software.amazon.awssdk.enhanced.dynamodb.model.QueryConditional;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 @SdkInternalApi
 public class EqualToConditional implements QueryConditional {
-    private static final UnaryOperator<String> EXPRESSION_KEY_MAPPER =
-        k -> "#AMZN_MAPPED_" + cleanAttributeName(k);
-    private static final UnaryOperator<String> EXPRESSION_VALUE_KEY_MAPPER =
-        k -> ":AMZN_MAPPED_" + cleanAttributeName(k);
 
     private final Key key;
 
@@ -77,8 +72,8 @@ public Expression expression(TableSchema<?> tableSchema, String indexName) {
     private Expression partitionOnlyExpression(String partitionKey,
                                                AttributeValue partitionValue) {
 
-        String partitionKeyToken = EXPRESSION_KEY_MAPPER.apply(partitionKey);
-        String partitionKeyValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(partitionKey);
+        String partitionKeyToken = EnhancedClientUtils.keyRef(partitionKey);
+        String partitionKeyValueToken = EnhancedClientUtils.valueRef(partitionKey);
         String queryExpression = String.format("%s = %s", partitionKeyToken, partitionKeyValueToken);
 
         return Expression.builder()
@@ -99,10 +94,10 @@ private Expression partitionAndSortExpression(String partitionKey,
             return partitionOnlyExpression(partitionKey, partitionValue);
         }
 
-        String partitionKeyToken = EXPRESSION_KEY_MAPPER.apply(partitionKey);
-        String partitionKeyValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(partitionKey);
-        String sortKeyToken = EXPRESSION_KEY_MAPPER.apply(sortKey);
-        String sortKeyValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(sortKey);
+        String partitionKeyToken = EnhancedClientUtils.keyRef(partitionKey);
+        String partitionKeyValueToken = EnhancedClientUtils.valueRef(partitionKey);
+        String sortKeyToken = EnhancedClientUtils.keyRef(sortKey);
+        String sortKeyValueToken = EnhancedClientUtils.valueRef(sortKey);
 
         String queryExpression = String.format("%s = %s AND %s = %s",
                                                partitionKeyToken,

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/conditional/SingleKeyItemConditional.java

@@ -16,15 +16,14 @@
 package software.amazon.awssdk.enhanced.dynamodb.internal.conditional;
 
 import static software.amazon.awssdk.enhanced.dynamodb.internal.AttributeValues.nullAttributeValue;
-import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.cleanAttributeName;
 
 import java.util.HashMap;
 import java.util.Map;
-import java.util.function.UnaryOperator;
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.enhanced.dynamodb.Expression;
 import software.amazon.awssdk.enhanced.dynamodb.Key;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
+import software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils;
 import software.amazon.awssdk.enhanced.dynamodb.model.QueryConditional;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
@@ -37,10 +36,6 @@
  */
 @SdkInternalApi
 public class SingleKeyItemConditional implements QueryConditional {
-    private static final UnaryOperator<String> EXPRESSION_KEY_MAPPER =
-        k -> "#AMZN_MAPPED_" + cleanAttributeName(k);
-    private static final UnaryOperator<String> EXPRESSION_VALUE_KEY_MAPPER =
-        k -> ":AMZN_MAPPED_" + cleanAttributeName(k);
 
     private final Key key;
     private final String operator;
@@ -59,10 +54,10 @@ public Expression expression(TableSchema<?> tableSchema, String indexName) {
                                                + "null sort key.");
         }
 
-        String partitionKeyToken = EXPRESSION_KEY_MAPPER.apply(queryConditionalKeyValues.partitionKey());
-        String partitionValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(queryConditionalKeyValues.partitionKey());
-        String sortKeyToken = EXPRESSION_KEY_MAPPER.apply(queryConditionalKeyValues.sortKey());
-        String sortValueToken = EXPRESSION_VALUE_KEY_MAPPER.apply(queryConditionalKeyValues.sortKey());
+        String partitionKeyToken = EnhancedClientUtils.keyRef(queryConditionalKeyValues.partitionKey());
+        String partitionValueToken = EnhancedClientUtils.valueRef(queryConditionalKeyValues.partitionKey());
+        String sortKeyToken = EnhancedClientUtils.keyRef(queryConditionalKeyValues.sortKey());
+        String sortValueToken = EnhancedClientUtils.valueRef(queryConditionalKeyValues.sortKey());
 
         String queryExpression = String.format("%s = %s AND %s %s %s",
                                                partitionKeyToken,

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/update/UpdateExpressionUtils.java

@@ -16,6 +16,8 @@
 package software.amazon.awssdk.enhanced.dynamodb.internal.update;
 
 import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.isNullAttributeValue;
+import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.keyRef;
+import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.valueRef;
 import static software.amazon.awssdk.utils.CollectionUtils.filterMap;
 
 import java.util.Arrays;
@@ -40,20 +42,6 @@ public final class UpdateExpressionUtils {
     private UpdateExpressionUtils() {
     }
 
-    /**
-     * Creates a key token to be used with an ExpressionNames map.
-     */
-    public static String keyRef(String key) {
-        return "#AMZN_MAPPED_" + EnhancedClientUtils.cleanAttributeName(key);
-    }
-
-    /**
-     * Creates a value token to be used with an ExpressionValues map.
-     */
-    public static String valueRef(String value) {
-        return ":AMZN_MAPPED_" + EnhancedClientUtils.cleanAttributeName(value);
-    }
-
     /**
      * A function to specify an initial value if the attribute represented by 'key' does not exist.
      */
@@ -150,7 +138,7 @@ private static Function<String, String> behaviorBasedValue(UpdateBehavior update
      */
     private static Map<String, String> expressionNamesFor(String... attributeNames) {
         return Arrays.stream(attributeNames)
-                     .collect(Collectors.toMap(UpdateExpressionUtils::keyRef, Function.identity()));
+                     .collect(Collectors.toMap(EnhancedClientUtils::keyRef, Function.identity()));
     }
 
 }

services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/extensions/VersionedRecordExtensionTest.java

@@ -68,7 +68,10 @@ public void beforeWrite_initialVersion_expressionIsCorrect() {
                     .operationContext(PRIMARY_CONTEXT).build());
 
         assertThat(result.additionalConditionalExpression(),
-                   is(Expression.builder().expression("attribute_not_exists(version)").build()));
+                   is(Expression.builder()
+                                .expression("attribute_not_exists(#AMZN_MAPPED_version)")
+                                .expressionNames(singletonMap("#AMZN_MAPPED_version", "version"))
+                                .build()));
     }
 
     @Test
@@ -123,7 +126,8 @@ public void beforeWrite_existingVersion_expressionIsCorrect() {
 
         assertThat(result.additionalConditionalExpression(),
                    is(Expression.builder()
-                                .expression("version = :old_version_value")
+                                .expression("#AMZN_MAPPED_version = :old_version_value")
+                                .expressionNames(singletonMap("#AMZN_MAPPED_version", "version"))
                                 .expressionValues(singletonMap(":old_version_value",
                                                                AttributeValue.builder().n("13").build()))
                                 .build()));