#71 - Added Document Versioning DynamoDb Service

actions/src/test/java/com/formkiq/module/actions/ActionsServiceDynamoDbTest.java

@@ -43,6 +43,7 @@
 import com.formkiq.stacks.dynamodb.DocumentItemDynamoDb;
 import com.formkiq.stacks.dynamodb.DocumentService;
 import com.formkiq.stacks.dynamodb.DocumentServiceImpl;
+import com.formkiq.stacks.dynamodb.DocumentVersionServiceNoVersioning;
 import com.formkiq.testutils.aws.DynamoDbExtension;
 import com.formkiq.testutils.aws.DynamoDbTestServices;
 import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
@@ -66,7 +67,8 @@ public static void beforeAll() throws Exception {
 
     DynamoDbConnectionBuilder db = DynamoDbTestServices.getDynamoDbConnection(null);
     service = new ActionsServiceDynamoDb(db, DOCUMENTS_TABLE);
-    documentService = new DocumentServiceImpl(db, DOCUMENTS_TABLE);
+    documentService =
+        new DocumentServiceImpl(db, DOCUMENTS_TABLE, new DocumentVersionServiceNoVersioning());
   }
 
   /**

aws-dynamodb/build.gradle

@@ -7,7 +7,7 @@ dependencies {
 	implementation group: 'software.amazon.awssdk', name: 'url-connection-client', version: '2.17.252'
     implementation group: 'com.formkiq', name: 'graalvm-annotations', version: '1.1.0'
 
-    testImplementation group: 'junit', name: 'junit', version:'4.+'
+    testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version:'5.9.1'
 
     configurations.all {
    		exclude group: 'software.amazon.awssdk', module: 'apache-client'

aws-dynamodb/src/main/java/com/formkiq/aws/dynamodb/DynamoDbService.java

@@ -36,19 +36,28 @@ public interface DynamoDbService {
   /**
    * Delete DynamoDb Record.
    * 
-   * @param pk {@link String}
-   * @param sk {@link String}
+   * @param pk {@link AttributeValue}
+   * @param sk {@link AttributeValue}
    */
-  void deleteItem(String pk, String sk);
+  void deleteItem(AttributeValue pk, AttributeValue sk);
+
+  /**
+   * Whether Database Record Exists.
+   * 
+   * @param pk {@link AttributeValue}
+   * @param sk {@link AttributeValue}
+   * @return boolean
+   */
+  boolean exists(AttributeValue pk, AttributeValue sk);
 
   /**
    * Gets DynamoDB Record.
    * 
-   * @param pk {@link String}
-   * @param sk {@link String}
+   * @param pk {@link AttributeValue}
+   * @param sk {@link AttributeValue}
    * @return {@link Map}
    */
-  Map<String, AttributeValue> get(String pk, String sk);
+  Map<String, AttributeValue> get(AttributeValue pk, AttributeValue sk);
 
   /**
    * Put DynamoDb Record.
@@ -66,15 +75,5 @@ public interface DynamoDbService {
    * @return {@link Map}
    */
   Map<String, AttributeValue> updateFields(AttributeValue pk, AttributeValue sk,
-      Map<String, String> updateValues);
-
-  /**
-   * Update DynamoDB Record.
-   * 
-   * @param pk {@link String}
-   * @param sk {@link String}
-   * @param updateValues {@link Map}
-   * @return {@link Map}
-   */
-  Map<String, AttributeValue> updateFields(String pk, String sk, Map<String, String> updateValues);
+      Map<String, AttributeValue> updateValues);
 }

aws-dynamodb/src/main/java/com/formkiq/aws/dynamodb/DynamoDbServiceImpl.java

@@ -32,6 +32,7 @@
 import software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate;
 import software.amazon.awssdk.services.dynamodb.model.DeleteItemRequest;
 import software.amazon.awssdk.services.dynamodb.model.GetItemRequest;
+import software.amazon.awssdk.services.dynamodb.model.GetItemResponse;
 import software.amazon.awssdk.services.dynamodb.model.PutItemRequest;
 import software.amazon.awssdk.services.dynamodb.model.UpdateItemRequest;
 
@@ -64,46 +65,61 @@ public DynamoDbServiceImpl(final DynamoDbConnectionBuilder connection,
   }
 
   @Override
-  public void deleteItem(final String pk, final String sk) {
-    Map<String, AttributeValue> sourceKey =
-        Map.of(PK, AttributeValue.fromS(pk), SK, AttributeValue.fromS(sk));
+  public void deleteItem(final AttributeValue pk, final AttributeValue sk) {
+    Map<String, AttributeValue> sourceKey = Map.of(PK, pk, SK, sk);
     this.dbClient
         .deleteItem(DeleteItemRequest.builder().tableName(this.tableName).key(sourceKey).build());
   }
 
   @Override
-  public Map<String, AttributeValue> get(final String pk, final String sk) {
-    Map<String, AttributeValue> key =
-        Map.of(PK, AttributeValue.fromS(pk), SK, AttributeValue.fromS(sk));
+  public boolean exists(final AttributeValue pk, final AttributeValue sk) {
+    GetItemRequest r = GetItemRequest.builder().key(Map.of(PK, pk, SK, sk))
+        .tableName(this.tableName).projectionExpression("PK").build();
+    GetItemResponse response = this.dbClient.getItem(r);
+    return !response.item().isEmpty();
+  }
+
+  @Override
+  public Map<String, AttributeValue> get(final AttributeValue pk, final AttributeValue sk) {
+    Map<String, AttributeValue> key = Map.of(PK, pk, SK, sk);
     return this.dbClient
         .getItem(GetItemRequest.builder().tableName(this.tableName).key(key).build()).item();
   }
 
   @Override
   public void putItem(final Map<String, AttributeValue> attributes) {
+    putItem(this.tableName, attributes);
+  }
+
+  /**
+   * Put Item in DynamoDb.
+   * 
+   * @param dynamoDbTable {@link String}
+   * @param attributes {@link Map}
+   */
+  private void putItem(final String dynamoDbTable, final Map<String, AttributeValue> attributes) {
     this.dbClient
-        .putItem(PutItemRequest.builder().tableName(this.tableName).item(attributes).build());
+        .putItem(PutItemRequest.builder().tableName(dynamoDbTable).item(attributes).build());
   }
 
   @Override
   public Map<String, AttributeValue> updateFields(final AttributeValue pk, final AttributeValue sk,
-      final Map<String, String> updateValues) {
+      final Map<String, AttributeValue> updateValues) {
+    return updateFields(this.tableName, pk, sk, updateValues);
+  }
+
+  private Map<String, AttributeValue> updateFields(final String dynamoDbTable,
+      final AttributeValue pk, final AttributeValue sk,
+      final Map<String, AttributeValue> updateValues) {
 
     Map<String, AttributeValue> dbKey = Map.of(PK, pk, SK, sk);
 
     Map<String, AttributeValueUpdate> values = new HashMap<>();
     updateValues.forEach((key, value) -> {
-      values.put(key,
-          AttributeValueUpdate.builder().value(AttributeValue.builder().s(value).build()).build());
+      values.put(key, AttributeValueUpdate.builder().value(value).build());
     });
 
-    return this.dbClient.updateItem(UpdateItemRequest.builder().tableName(this.tableName).key(dbKey)
+    return this.dbClient.updateItem(UpdateItemRequest.builder().tableName(dynamoDbTable).key(dbKey)
         .attributeUpdates(values).build()).attributes();
   }
-
-  @Override
-  public Map<String, AttributeValue> updateFields(final String pk, final String sk,
-      final Map<String, String> updateValues) {
-    return updateFields(AttributeValue.fromS(pk), AttributeValue.fromS(sk), updateValues);
-  }
 }

aws-dynamodb/src/main/java/com/formkiq/aws/dynamodb/ReadRequestBuilder.java

@@ -0,0 +1,149 @@
+/**
+ * MIT License
+ * 
+ * Copyright (c) 2018 - 2020 FormKiQ
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.formkiq.aws.dynamodb;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import com.formkiq.aws.dynamodb.objects.Objects;
+import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
+import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
+import software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest;
+import software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse;
+import software.amazon.awssdk.services.dynamodb.model.KeysAndAttributes;
+import software.amazon.awssdk.services.dynamodb.model.WriteRequest;
+
+/**
+ * Helper class for building Batch Read Requets.
+ *
+ */
+public class ReadRequestBuilder {
+
+  /** Max Batch Size. */
+  private static final int MAX_BATCH_SIZE = 100;
+  /** {@link Map} of {@link AttributeValue}. */
+  private Map<String, Collection<Map<String, AttributeValue>>> items = new HashMap<>();
+
+  /**
+   * constructor.
+   */
+  public ReadRequestBuilder() {
+
+  }
+
+  /**
+   * Collects {@link WriteRequest} and adds to a internal list.
+   * 
+   * @param tableName {@link String}
+   * @param keys {@link Collection}
+   * @return {@link ReadRequestBuilder}
+   */
+  public ReadRequestBuilder append(final String tableName,
+      final Collection<Map<String, AttributeValue>> keys) {
+
+    if (this.items.containsKey(tableName)) {
+      Collection<Map<String, AttributeValue>> values = this.items.get(tableName);
+      values.addAll(keys);
+    } else {
+      this.items.put(tableName, new HashSet<>(keys));
+    }
+
+    return this;
+  }
+
+  /**
+   * Batch Read Items.
+   * 
+   * @param dbClient {@link DynamoDbClient}
+   * @return {@link BatchGetItemResponse}
+   */
+  public Map<String, List<Map<String, AttributeValue>>> batchReadItems(
+      final DynamoDbClient dbClient) {
+
+    Map<String, List<Map<String, AttributeValue>>> map = new HashMap<>();
+
+    for (Map.Entry<String, Collection<Map<String, AttributeValue>>> e : this.items.entrySet()) {
+
+      if (e.getValue().size() > MAX_BATCH_SIZE) {
+
+        Collection<List<Map<String, AttributeValue>>> parition =
+            Objects.parition(new ArrayList<>(e.getValue()), MAX_BATCH_SIZE);
+
+        for (List<Map<String, AttributeValue>> list : parition) {
+
+          Map<String, List<Map<String, AttributeValue>>> values =
+              batchReadItems(dbClient, e.getKey(), list).responses();
+
+          for (Map.Entry<String, List<Map<String, AttributeValue>>> ee : values.entrySet()) {
+
+            if (map.containsKey(ee.getKey())) {
+              map.get(ee.getKey()).addAll(ee.getValue());
+            } else {
+              map.put(ee.getKey(), new ArrayList<>(ee.getValue()));
+            }
+          }
+        }
+
+      } else {
+        map = batchReadItems(dbClient, e.getKey(), e.getValue()).responses();
+      }
+    }
+
+    return map;
+  }
+
+  private BatchGetItemResponse batchReadItems(final DynamoDbClient dbClient, final String tableName,
+      final Collection<Map<String, AttributeValue>> keys) {
+
+    Map<String, KeysAndAttributes> requestedItems =
+        Map.of(tableName, KeysAndAttributes.builder().keys(keys).build());
+
+    BatchGetItemRequest batchReq =
+        BatchGetItemRequest.builder().requestItems(requestedItems).build();
+    BatchGetItemResponse batchResponse = dbClient.batchGetItem(batchReq);
+
+    return batchResponse;
+  }
+
+  /**
+   * Get Read Items.
+   * 
+   * @return {@link Map}
+   */
+  public Map<String, Collection<Map<String, AttributeValue>>> getItems() {
+    return this.items;
+  }
+
+  /**
+   * Are there any requests.
+   * 
+   * @return boolean
+   */
+  public boolean isEmpty() {
+    return this.items.isEmpty();
+  }
+}

aws-dynamodb/src/test/java/com/formkiq/aws/dynamodb/objects/ObjectsTest.java

@@ -23,11 +23,11 @@
  */
 package com.formkiq.aws.dynamodb.objects;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 /**
  * 

aws-s3/src/main/java/com/formkiq/aws/s3/S3ObjectMetadata.java

@@ -31,16 +31,18 @@
  *
  */
 public class S3ObjectMetadata {
-  /** S3 Object ETag. */
-  private String etag;
+  /** Content Length. */
+  private Long contentLength;
   /** Object Content Type. */
   private String contentType;
+  /** S3 Object ETag. */
+  private String etag;
   /** Object Metadata. */
   private Map<String, String> metadata;
   /** boolean. */
   private boolean objectExists;
-  /** Content Length. */
-  private Long contentLength;
+  /** S3 Version Id. */
+  private String versionId;
 
   /**
    * constructor.
@@ -83,6 +85,15 @@ public Map<String, String> getMetadata() {
     return Collections.unmodifiableMap(this.metadata);
   }
 
+  /**
+   * Get S3 Version Id.
+   * 
+   * @return {@link String}
+   */
+  public String getVersionId() {
+    return this.versionId;
+  }
+
   /**
    * Does Object Exist.
    * 
@@ -144,4 +155,15 @@ public S3ObjectMetadata setObjectExists(final boolean exists) {
     this.objectExists = exists;
     return this;
   }
+
+  /**
+   * Set S3 Version Id.
+   * 
+   * @param s3VersionId {@link String}
+   * @return {@link S3ObjectMetadata}
+   */
+  public S3ObjectMetadata setVersionId(final String s3VersionId) {
+    this.versionId = s3VersionId;
+    return this;
+  }
 }