feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite operation #5462

prateek-vats · 2024-08-03T19:13:33Z

Motivation and Context

Currently the response returned by a BatchWriteItem and TransctWriteItem operations don't return the Capacity consumed unlike some other requests. This PR introduces that feature
Open issue: #4123

Modifications

Added CapacityConsumed to the BatchWriteResult POJO
Added support for returnCapacityConsumed to the EnhancedBatchWriteRequest
Make TransctWriteItems operation return TransctWriteEnhancedItemResponse which will contain ConsumedCapacity and ItemCollectionMetrics
Added support for returnCapacityConsumed to the TransctWriteEnhancedItemRequest

Testing

Added unit tests and functional tests

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Checklist

I have read the CONTRIBUTING document
Local run of mvn install succeeds
My code follows the code style of this project
My change requires a change to the Javadoc documentation
I have updated the Javadoc documentation accordingly
I have added tests to cover my changes
All new and existing tests passed
I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

I confirm that this pull request can be released under the Apache 2 license

...nced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedAsyncClient.java

.changes/next-release/feature-DynamoDBEnhancedClient-a84a047.json

This reverts commit a7bd547.

zoewangg · 2024-08-13T21:33:17Z

...va/software/amazon/awssdk/enhanced/dynamodb/internal/operations/BatchWriteItemOperation.java

-        return BatchWriteResult.builder().unprocessedRequests(response.unprocessedItems()).build();
+        return BatchWriteResult.builder()
+                               .unprocessedRequests(response.unprocessedItems())
+            .consumedCapacity(response.consumedCapacity())


Nit: formatting seems a bit off.

.../main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchWriteItemEnhancedRequest.java

...-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchWriteResult.java

zoewangg · 2024-08-15T22:38:38Z

...db-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/model/WriteBatchTest.java

@@ -134,6 +138,16 @@ public void builder_missing_mapped_table_resource_error_message() {
                                                     errorMessageDeleteKeyFromItem);
    }

+    @Test
+    public void hashCode_includesConsumedCapacity() {


Can we use equalsVerifier to test equals and hashcode? https://github.com/aws/aws-sdk-java-v2/blob/master/core/sdk-core/src/test/java/software/amazon/awssdk/core/async/ResponsePublisherTest.java#L25

We may need to add equalsverifier test dependency.

Added a test for equals and hashcode using equalsverifier. Looks like the test dependency was already there

(cherry picked from commit a7bd547)

This reverts commit c58db98.

zoewangg

Just some minor comments on the javadoc. Triggering builds

zoewangg · 2024-08-16T17:04:27Z

...-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchWriteResult.java

+    }
+
+    /**
+     * The capacity units consumed by the {@code Write} operation.


Collection metrics?

Ah, my bad. Fixed

zoewangg · 2024-08-16T17:04:52Z

...-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchWriteResult.java

+        }
+
+        /**
+         * Set the capacity units consumed by the batch write operation.


collection metrics?

Ah, my bad. Fixed

zoewangg · 2024-08-16T17:14:30Z

.../main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchWriteItemEnhancedRequest.java

+        }
+
+        /**
+         * Whether to return the item collection metrics.


Nit: this method does not return a boolean value though. Suggesting

Sets the item collection metrics.

zoewangg · 2024-08-16T17:14:35Z

.../main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchWriteItemEnhancedRequest.java

+        }
+
+        /**
+         * Whether to return the item collection metrics.


prateek-vats · 2024-08-16T21:18:01Z

Any ideas why all the jdk builds are failing?
@zoewangg

zoewangg · 2024-08-16T21:22:24Z

It seems there are checkstyle erros

[ERROR] Failed to execute goal 
org.apache.maven.plugins:maven-checkstyle-plugin:3.1.2:check 
(checkstyle) on project dynamodb-enhanced: Failed during checkstyle 
execution: There are 6 errors reported by Checkstyle 8.42 with 
software/amazon/awssdk/checkstyle.xml ruleset. -&gt; [Help 1]

Could you run it locally and fix them?

mvn clean install -pl :bom-internal,:dynamodb-enhanced -P quick --am
mvn clean install -pl :dynamodb-enhanced

prateek-vats · 2024-08-16T22:18:12Z

It seems there are checkstyle erros

[ERROR] Failed to execute goal 
org.apache.maven.plugins:maven-checkstyle-plugin:3.1.2:check 
(checkstyle) on project dynamodb-enhanced: Failed during checkstyle 
execution: There are 6 errors reported by Checkstyle 8.42 with 
software/amazon/awssdk/checkstyle.xml ruleset. -&gt; [Help 1]

Could you run it locally and fix them?

mvn clean install -pl :bom-internal,:dynamodb-enhanced -P quick --am
mvn clean install -pl :dynamodb-enhanced

Thank you, @zoewangg . I've made the changes to fix the build

sonarcloud · 2024-08-16T23:05:43Z

Quality Gate passed

Issues
15 New issues
0 Accepted issues

Measures
0 Security Hotspots
89.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

zoewangg · 2024-08-20T16:21:45Z

@all-contributors please add @prateek-vats for code

allcontributors · 2024-08-20T16:21:54Z

@zoewangg

I've put up a pull request to add @prateek-vats! 🎉

Add support for ConsumedCapacity in a BatchWrite request

d185260

prateek-vats requested a review from a team as a code owner August 3, 2024 19:13

Added changelog

1d72986

prateek-vats mentioned this pull request Aug 3, 2024

DynamoDbEnhancedClient allow to request to return capacity on all data plane operations #4123

Open

2 tasks

prateek-vats added 3 commits August 6, 2024 12:13

Merge branch 'master' into master

a093d60

Merge branch 'master' into master

833dfcf

Merge branch 'master' into master

35ecbaa

debora-ito assigned zoewangg Aug 9, 2024

Merge branch 'master' into master

4430299

prateek-vats changed the title ~~feature: Add support for ConsumedCapacity in a BatchWrite request~~ feature: Add support for ConsumedCapacity in a BatchWriteItems and TransactWriteItems request Aug 10, 2024

Add support for consumed capacity in transactWriteItems

a7bd547

prateek-vats changed the title ~~feature: Add support for ConsumedCapacity in a BatchWriteItems and TransactWriteItems request~~ feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite and TransctWriteItems operation Aug 10, 2024

zoewangg requested changes Aug 12, 2024

View reviewed changes

...nced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/DynamoDbEnhancedAsyncClient.java Outdated Show resolved Hide resolved

.changes/next-release/feature-DynamoDBEnhancedClient-a84a047.json Outdated Show resolved Hide resolved

Revert "Add support for consumed capacity in transactWriteItems"

aa5aa3b

This reverts commit a7bd547.

prateek-vats changed the title ~~feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite and TransctWriteItems operation~~ feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite operation Aug 12, 2024

prateek-vats requested a review from zoewangg August 12, 2024 17:21

prateek-vats added 3 commits August 12, 2024 12:57

Merge branch 'master' into master

276d440

Merge branch 'master' into master

d4626a2

Merge branch 'master' into master

39a6134

millems mentioned this pull request Aug 13, 2024

feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's TransactWriteItem operation #5501

Merged

12 tasks

Merge branch 'master' into master

0d4b13e

zoewangg reviewed Aug 15, 2024

View reviewed changes

prateek-vats and others added 4 commits August 16, 2024 10:20

Merge branch 'master' into master

bdbcfb7

Add support for consumed capacity in transactWriteItems

c58db98

(cherry picked from commit a7bd547)

Address review comments

95ff316

Revert "Add support for consumed capacity in transactWriteItems"

384c44c

This reverts commit c58db98.

prateek-vats requested a review from zoewangg August 16, 2024 15:28

zoewangg reviewed Aug 16, 2024

View reviewed changes

ragnar9780 and others added 2 commits August 16, 2024 12:24

Address javadoc comments

0b526f9

Merge branch 'master' into master

ed57230

prateek-vats requested a review from zoewangg August 16, 2024 17:33

prateek-vats and others added 2 commits August 16, 2024 14:59

Merge branch 'master' into master

3fcf937

Merge branch 'master' into master

4724e84

Fix build

103ecf7

zoewangg approved these changes Aug 16, 2024

View reviewed changes

zoewangg added this pull request to the merge queue Aug 16, 2024

Merged via the queue into aws:master with commit b4ecd2d Aug 17, 2024
9 checks passed

allcontributors bot mentioned this pull request Aug 20, 2024

docs: add prateek-vats as a contributor for code #5518

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite operation #5462

feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite operation #5462

prateek-vats commented Aug 3, 2024 •

edited

Loading

zoewangg Aug 13, 2024

prateek-vats Aug 16, 2024

zoewangg Aug 15, 2024

prateek-vats Aug 16, 2024

zoewangg left a comment

zoewangg Aug 16, 2024

prateek-vats Aug 16, 2024

zoewangg Aug 16, 2024

prateek-vats Aug 16, 2024

zoewangg Aug 16, 2024

prateek-vats Aug 16, 2024

zoewangg Aug 16, 2024

prateek-vats Aug 16, 2024

prateek-vats commented Aug 16, 2024 •

edited

Loading

zoewangg commented Aug 16, 2024

prateek-vats commented Aug 16, 2024

sonarcloud bot commented Aug 16, 2024

zoewangg commented Aug 20, 2024

allcontributors bot commented Aug 20, 2024

feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite operation #5462

feature: Support of ReturnConsumedCapacity in DynamoDBEnhancedClient's BatchWrite operation #5462

Conversation

prateek-vats commented Aug 3, 2024 • edited Loading

Motivation and Context

Modifications

Testing

Types of changes

Checklist

License

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zoewangg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prateek-vats commented Aug 16, 2024 • edited Loading

zoewangg commented Aug 16, 2024

prateek-vats commented Aug 16, 2024

sonarcloud bot commented Aug 16, 2024

Quality Gate passed

zoewangg commented Aug 20, 2024

allcontributors bot commented Aug 20, 2024

prateek-vats commented Aug 3, 2024 •

edited

Loading

prateek-vats commented Aug 16, 2024 •

edited

Loading