Fixed EnhancedClient UpdateItem operation to make it work on nested attributes as well

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

@@ -22,6 +22,7 @@
 import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.enhanced.dynamodb.document.DocumentTableSchema;
 import software.amazon.awssdk.enhanced.dynamodb.document.EnhancedDocument;
+import software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDBEnhancedRequestConfiguration;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.BeanTableSchema;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.ImmutableTableSchema;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.StaticImmutableTableSchema;
@@ -240,8 +241,24 @@ default T mapToItem(Map<String, AttributeValue> attributeMap, boolean preserveEm
      * @param ignoreNulls If set to true; any null values in the Java object will not be added to the output map.
      *                    If set to false; null values in the Java object will be added as {@link AttributeValue} of
      *                    type 'nul' to the output map.
+     * @param requestConfiguration denotes the level of nesting, i.e. SHALLOW or NESTED, contained in the request params based
+     * which nested update query parameters would be dealt with
      * @return A map of String to {@link AttributeValue} representing all the modelled attributes in the model object.
      */
+    Map<String, AttributeValue> itemToMap(T item, boolean ignoreNulls,
+                                          DynamoDBEnhancedRequestConfiguration requestConfiguration);
+
+    /**
+     * This is deprecated in favour of itemToMap(T item, boolean ignoreNulls, DynamoDBEnhancedRequestOverrideConfiguration
+     * ddbRequestOverrideConfiguration) This method takes a modelled object and converts it into a raw map of
+     * {@link AttributeValue} that the DynamoDb low-level SDK can work with.
+     *
+     * @param item        The modelled Java object to convert into a map of attributes.
+     * @param ignoreNulls If set to true; any null values in the Java object will not be added to the output map. If set to false;
+     *                    null values in the Java object will be added as {@link AttributeValue} of type 'nul' to the output map.
+     * @return A map of String to {@link AttributeValue} representing all the modelled attributes in the model object.
+     */
+    @Deprecated
     Map<String, AttributeValue> itemToMap(T item, boolean ignoreNulls);
 
     /**

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/document/DocumentTableSchema.java

@@ -15,6 +15,8 @@
 
 package software.amazon.awssdk.enhanced.dynamodb.document;
 
+import static software.amazon.awssdk.enhanced.dynamodb.mapper.AttributeMapping.SHALLOW;
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -35,6 +37,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.EnhancedType;
 import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
+import software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDBEnhancedRequestConfiguration;
 import software.amazon.awssdk.enhanced.dynamodb.internal.converter.ConverterProviderResolver;
 import software.amazon.awssdk.enhanced.dynamodb.internal.document.DefaultEnhancedDocument;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.StaticImmutableTableSchema;
@@ -105,14 +108,20 @@ public EnhancedDocument mapToItem(Map<String, AttributeValue> attributeMap) {
      *
      */
     @Override
-    public Map<String, AttributeValue> itemToMap(EnhancedDocument item, boolean ignoreNulls) {
+    public Map<String, AttributeValue> itemToMap(EnhancedDocument item, boolean ignoreNulls,
+                                                 DynamoDBEnhancedRequestConfiguration requestConfiguration) {
         if (item == null) {
             return null;
         }
         List<AttributeConverterProvider> providers = mergeAttributeConverterProviders(item);
         return item.toBuilder().attributeConverterProviders(providers).build().toMap();
     }
 
+    @Override
+    public Map<String, AttributeValue> itemToMap(EnhancedDocument item, boolean ignoreNulls) {
+        return itemToMap(item, ignoreNulls, new DynamoDBEnhancedRequestConfiguration(SHALLOW));
+    }
+
     private List<AttributeConverterProvider> mergeAttributeConverterProviders(EnhancedDocument item) {
         if (item.attributeConverterProviders() != null && !item.attributeConverterProviders().isEmpty()) {
             Set<AttributeConverterProvider> providers = new LinkedHashSet<>();

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

@@ -0,0 +1,36 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.enhanced.dynamodb.internal;
+
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.enhanced.dynamodb.mapper.AttributeMapping;
+
+/**
+ * Configuration Object to define behaviour of DynamoDB operations.
+ */
+@SdkPublicApi
+public class DynamoDBEnhancedRequestConfiguration {
+    private final AttributeMapping attributeMapping;
+
+    public DynamoDBEnhancedRequestConfiguration(AttributeMapping attributeMapping) {
+        this.attributeMapping = attributeMapping;
+    }
+
+    public AttributeMapping attributeMapping() {
+        return attributeMapping;
+    }
+
+}

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

@@ -15,13 +15,16 @@
 
 package software.amazon.awssdk.enhanced.dynamodb.internal;
 
+import static software.amazon.awssdk.enhanced.dynamodb.mapper.StaticImmutableTableSchema.NESTED_OBJECT_UPDATE;
+
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.Function;
 import java.util.function.Supplier;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import software.amazon.awssdk.annotations.SdkInternalApi;
@@ -40,6 +43,7 @@ public final class EnhancedClientUtils {
     private static final Set<Character> SPECIAL_CHARACTERS = Stream.of(
         '*', '.', '-', '#', '+', ':', '/', '(', ')', ' ',
         '&', '<', '>', '?', '=', '!', '@', '%', '$', '|').collect(Collectors.toSet());
+    private static final Pattern PATTERN = Pattern.compile(NESTED_OBJECT_UPDATE);
 
     private EnhancedClientUtils() {
 
@@ -67,18 +71,30 @@ public static String cleanAttributeName(String key) {
         return somethingChanged ? new String(chars) : key;
     }
 
+    private static boolean isNestedAttribute(String key) {
+        return key.contains(NESTED_OBJECT_UPDATE);
+    }
+
     /**
      * Creates a key token to be used with an ExpressionNames map.
      */
     public static String keyRef(String key) {
-        return "#AMZN_MAPPED_" + cleanAttributeName(key);
+        String cleanAttributeName = cleanAttributeName(key);
+        cleanAttributeName = isNestedAttribute(cleanAttributeName) ?
+                             PATTERN.matcher(cleanAttributeName).replaceAll(".#AMZN_MAPPED_")
+                                                    : cleanAttributeName;
+        return "#AMZN_MAPPED_" + cleanAttributeName;
     }
 
     /**
      * Creates a value token to be used with an ExpressionValues map.
      */
     public static String valueRef(String value) {
-        return ":AMZN_MAPPED_" + cleanAttributeName(value);
+        String cleanAttributeName = cleanAttributeName(value);
+        cleanAttributeName = isNestedAttribute(cleanAttributeName) ?
+                             PATTERN.matcher(cleanAttributeName).replaceAll("_")
+                                                      : cleanAttributeName;
+        return ":AMZN_MAPPED_" + cleanAttributeName;
     }
 
     public static <T> T readAndTransformSingleItem(Map<String, AttributeValue> itemMap,

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/converter/attribute/DocumentAttributeConverter.java

@@ -15,12 +15,15 @@
 
 package software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute;
 
+import static software.amazon.awssdk.enhanced.dynamodb.mapper.AttributeMapping.SHALLOW;
+
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.enhanced.dynamodb.AttributeConverter;
 import software.amazon.awssdk.enhanced.dynamodb.AttributeValueType;
 import software.amazon.awssdk.enhanced.dynamodb.EnhancedType;
 import software.amazon.awssdk.enhanced.dynamodb.EnhancedTypeDocumentConfiguration;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
+import software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDBEnhancedRequestConfiguration;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 /**
@@ -54,7 +57,8 @@ public static <T> DocumentAttributeConverter<T> create(TableSchema<T> tableSchem
 
     @Override
     public AttributeValue transformFrom(T input) {
-        return AttributeValue.builder().m(tableSchema.itemToMap(input, ignoreNulls)).build();
+        return AttributeValue.builder().m(tableSchema.itemToMap(input, ignoreNulls,
+                                                                new DynamoDBEnhancedRequestConfiguration(SHALLOW))).build();
     }
 
     @Override

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

@@ -23,6 +23,8 @@
 import software.amazon.awssdk.enhanced.dynamodb.EnhancedType;
 import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
+import software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDBEnhancedRequestConfiguration;
+import software.amazon.awssdk.enhanced.dynamodb.mapper.AttributeMapping;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 /**
@@ -49,9 +51,15 @@ public T mapToItem(Map<String, AttributeValue> attributeMap) {
         return concreteTableSchema().mapToItem(attributeMap);
     }
 
+    @Override
+    public Map<String, AttributeValue> itemToMap(T item, boolean ignoreNulls,
+                                                 DynamoDBEnhancedRequestConfiguration requestConfiguration) {
+        return concreteTableSchema().itemToMap(item, ignoreNulls, requestConfiguration);
+    }
+
     @Override
     public Map<String, AttributeValue> itemToMap(T item, boolean ignoreNulls) {
-        return concreteTableSchema().itemToMap(item, ignoreNulls);
+        return itemToMap(item, ignoreNulls, new DynamoDBEnhancedRequestConfiguration(AttributeMapping.SHALLOW));
     }
 
     @Override

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

@@ -15,6 +15,8 @@
 
 package software.amazon.awssdk.enhanced.dynamodb.internal.operations;
 
+import static software.amazon.awssdk.enhanced.dynamodb.mapper.AttributeMapping.SHALLOW;
+
 import java.util.Map;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
@@ -26,6 +28,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
 import software.amazon.awssdk.enhanced.dynamodb.extensions.WriteModification;
+import software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDBEnhancedRequestConfiguration;
 import software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils;
 import software.amazon.awssdk.enhanced.dynamodb.internal.extensions.DefaultDynamoDbExtensionContext;
 import software.amazon.awssdk.enhanced.dynamodb.model.PutItemEnhancedRequest;
@@ -87,7 +90,8 @@ public PutItemRequest generateRequest(TableSchema<T> tableSchema,
 
         boolean alwaysIgnoreNulls = true;
         T item = request.map(PutItemEnhancedRequest::item, TransactPutItemEnhancedRequest::item);
-        Map<String, AttributeValue> itemMap = tableSchema.itemToMap(item, alwaysIgnoreNulls);
+        Map<String, AttributeValue> itemMap = tableSchema.itemToMap(item, alwaysIgnoreNulls,
+                                                                    new DynamoDBEnhancedRequestConfiguration(SHALLOW));
 
         WriteModification transformation =
             extension != null ? extension.beforeWrite(

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

@@ -17,6 +17,7 @@
 
 import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.readAndTransformSingleItem;
 import static software.amazon.awssdk.enhanced.dynamodb.internal.update.UpdateExpressionUtils.operationExpression;
+import static software.amazon.awssdk.enhanced.dynamodb.mapper.AttributeMapping.NESTED;
 import static software.amazon.awssdk.utils.CollectionUtils.filterMap;
 
 import java.util.Collection;
@@ -32,6 +33,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
 import software.amazon.awssdk.enhanced.dynamodb.extensions.WriteModification;
+import software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDBEnhancedRequestConfiguration;
 import software.amazon.awssdk.enhanced.dynamodb.internal.extensions.DefaultDynamoDbExtensionContext;
 import software.amazon.awssdk.enhanced.dynamodb.internal.update.UpdateExpressionConverter;
 import software.amazon.awssdk.enhanced.dynamodb.model.TransactUpdateItemEnhancedRequest;
@@ -90,7 +92,8 @@ public UpdateItemRequest generateRequest(TableSchema<T> tableSchema,
                                           r -> Optional.ofNullable(r.ignoreNulls()))
                                      .orElse(null);
 
-        Map<String, AttributeValue> itemMap = tableSchema.itemToMap(item, Boolean.TRUE.equals(ignoreNulls));
+        Map<String, AttributeValue> itemMap = tableSchema.itemToMap(item, Boolean.TRUE.equals(ignoreNulls),
+                                                                    new DynamoDBEnhancedRequestConfiguration(NESTED));
         TableMetadata tableMetadata = tableSchema.tableMetadata();
 
         WriteModification transformation =

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

@@ -18,17 +18,18 @@
 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.enhanced.dynamodb.mapper.StaticImmutableTableSchema.NESTED_OBJECT_UPDATE;
 import static software.amazon.awssdk.utils.CollectionUtils.filterMap;
 
-import java.util.Arrays;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Function;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
-import software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils;
 import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.UpdateBehaviorTag;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.UpdateBehavior;
 import software.amazon.awssdk.enhanced.dynamodb.update.RemoveAction;
@@ -39,6 +40,8 @@
 @SdkInternalApi
 public final class UpdateExpressionUtils {
 
+    private static final Pattern PATTERN = Pattern.compile(NESTED_OBJECT_UPDATE);
+
     private UpdateExpressionUtils() {
     }
 
@@ -99,7 +102,7 @@ private static List<RemoveAction> removeActionsFor(Map<String, AttributeValue> a
     private static RemoveAction remove(String attributeName) {
         return RemoveAction.builder()
                            .path(keyRef(attributeName))
-                           .expressionNames(Collections.singletonMap(keyRef(attributeName), attributeName))
+                           .expressionNames(expressionNamesFor(attributeName))
                            .build();
     }
 
@@ -136,9 +139,18 @@ private static Function<String, String> behaviorBasedValue(UpdateBehavior update
     /**
      * Simple utility method that can create an ExpressionNames map based on a list of attribute names.
      */
-    private static Map<String, String> expressionNamesFor(String... attributeNames) {
-        return Arrays.stream(attributeNames)
-                     .collect(Collectors.toMap(EnhancedClientUtils::keyRef, Function.identity()));
-    }
+    private static Map<String, String> expressionNamesFor(String attributeNames) {
+        Map<String, String> map = new HashMap<>();
+
+        if (attributeNames.contains(NESTED_OBJECT_UPDATE)) {
+            for (String attribute : PATTERN.split(attributeNames)) {
+                map.put(keyRef(attribute), attribute);
+            }
+        }
 
+        if (map.isEmpty()) {
+            map.put(keyRef(attributeNames), attributeNames);
+        }
+        return map;
+    }
 }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/mapper/AttributeMapping.java

@@ -0,0 +1,21 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.enhanced.dynamodb.mapper;
+
+public enum AttributeMapping {
+    SHALLOW,
+    NESTED
+}

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/mapper/BeanTableSchema.java

@@ -16,6 +16,7 @@
 package software.amazon.awssdk.enhanced.dynamodb.mapper;
 
 import static software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDbEnhancedLogger.BEAN_LOGGER;
+import static software.amazon.awssdk.enhanced.dynamodb.mapper.AttributeMapping.SHALLOW;
 
 import java.beans.BeanInfo;
 import java.beans.IntrospectionException;
@@ -51,6 +52,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.EnhancedTypeDocumentConfiguration;
 import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
 import software.amazon.awssdk.enhanced.dynamodb.internal.AttributeConfiguration;
+import software.amazon.awssdk.enhanced.dynamodb.internal.DynamoDBEnhancedRequestConfiguration;
 import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.BeanAttributeGetter;
 import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.BeanAttributeSetter;
 import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.MetaTableSchema;
@@ -65,6 +67,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbIgnoreNulls;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbImmutable;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.annotations.DynamoDbPreserveEmptyObject;
+import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
 
 /**
  * Implementation of {@link TableSchema} that builds a table schema based on properties and annotations of a bean
@@ -457,5 +460,10 @@ private static List<? extends Annotation> propertyAnnotations(PropertyDescriptor
     private static void debugLog(Class<?> beanClass, Supplier<String> logMessage) {
         BEAN_LOGGER.debug(() -> beanClass.getTypeName() + " - " + logMessage.get());
     }
+
+    @Override
+    public Map<String, AttributeValue> itemToMap(T item, boolean ignoreNulls) {
+        return itemToMap(item, ignoreNulls, new DynamoDBEnhancedRequestConfiguration(SHALLOW));
+    }
 }