Skip to content

Implement support for ReturnValuesOnConditionCheckFailure #2688

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 5 commits into from
Sep 7, 2021
Merged

Implement support for ReturnValuesOnConditionCheckFailure #2688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ec5b871
Implement return values on TransactWriteItems
dagnir Aug 25, 2021
78124aa
Review comments
dagnir Sep 3, 2021
2ebee0b
Merge branch 'master' into ddb-enhanced-returnvalues
dagnir Sep 3, 2021
3874e42
Merge branch 'master' into ddb-enhanced-returnvalues
dagnir Sep 3, 2021
30393f1
Merge branch 'master' into ddb-enhanced-returnvalues
dagnir Sep 3, 2021
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
6 changes: 6 additions & 0 deletions .changes/next-release/feature-DynamoDBEnhancedClient-881a390.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "DynamoDB Enhanced Client",
"contributor": "",
"type": "feature",
"description": "Allow customers to specify `ReturnValuesOnConditionCheckFailure` for `TransactWriteItems`. Addresses [#2283](https://github.com/aws/aws-sdk-java-v2/issues/2283)."
}
52 changes: 37 additions & 15 deletions ...ava/software/amazon/awssdk/enhanced/dynamodb/internal/operations/DeleteItemOperation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,19 @@
package software.amazon.awssdk.enhanced.dynamodb.internal.operations;

import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClientExtension;
import software.amazon.awssdk.enhanced.dynamodb.Expression;
import software.amazon.awssdk.enhanced.dynamodb.Key;
import software.amazon.awssdk.enhanced.dynamodb.OperationContext;
import software.amazon.awssdk.enhanced.dynamodb.TableMetadata;
import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
import software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils;
import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.TransactDeleteItemEnhancedRequest;
import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
Expand All @@ -35,23 +39,32 @@
import software.amazon.awssdk.services.dynamodb.model.ReturnValue;
import software.amazon.awssdk.services.dynamodb.model.TransactWriteItem;
import software.amazon.awssdk.services.dynamodb.model.WriteRequest;
import software.amazon.awssdk.utils.Either;

@SdkInternalApi
public class DeleteItemOperation<T>
implements TableOperation<T, DeleteItemRequest, DeleteItemResponse, T>,
TransactableWriteOperation<T>,
BatchableWriteOperation<T> {

private final DeleteItemEnhancedRequest request;
private final Either<DeleteItemEnhancedRequest, TransactDeleteItemEnhancedRequest> request;

private DeleteItemOperation(DeleteItemEnhancedRequest request) {
this.request = request;
this.request = Either.left(request);
}

private DeleteItemOperation(TransactDeleteItemEnhancedRequest request) {
this.request = Either.right(request);
}

public static <T> DeleteItemOperation<T> create(DeleteItemEnhancedRequest request) {
return new DeleteItemOperation<>(request);
}

public static <T> DeleteItemOperation<T> create(TransactDeleteItemEnhancedRequest request) {
return new DeleteItemOperation<>(request);
}

@Override
public DeleteItemRequest generateRequest(TableSchema<T> tableSchema,
OperationContext operationContext,
Expand All @@ -61,10 +74,12 @@ public DeleteItemRequest generateRequest(TableSchema<T> tableSchema,
throw new IllegalArgumentException("DeleteItem cannot be executed against a secondary index.");
}

Key key = request.map(DeleteItemEnhancedRequest::key, TransactDeleteItemEnhancedRequest::key);

DeleteItemRequest.Builder requestBuilder =
DeleteItemRequest.builder()
.tableName(operationContext.tableName())
.key(this.request.key().keyMap(tableSchema, operationContext.indexName()))
.key(key.keyMap(tableSchema, operationContext.indexName()))
.returnValues(ReturnValue.ALL_OLD);

requestBuilder = addExpressionsIfExist(requestBuilder);
Expand Down Expand Up @@ -109,24 +124,31 @@ public TransactWriteItem generateTransactWriteItem(TableSchema<T> tableSchema,
DynamoDbEnhancedClientExtension dynamoDbEnhancedClientExtension) {
DeleteItemRequest deleteItemRequest = generateRequest(tableSchema, operationContext, dynamoDbEnhancedClientExtension);

Delete delete = Delete.builder()
.key(deleteItemRequest.key())
.tableName(deleteItemRequest.tableName())
.conditionExpression(deleteItemRequest.conditionExpression())
.expressionAttributeValues(deleteItemRequest.expressionAttributeValues())
.expressionAttributeNames(deleteItemRequest.expressionAttributeNames())
.build();
Delete.Builder builder = Delete.builder()
.key(deleteItemRequest.key())
.tableName(deleteItemRequest.tableName())
.conditionExpression(deleteItemRequest.conditionExpression())
.expressionAttributeValues(deleteItemRequest.expressionAttributeValues())
.expressionAttributeNames(deleteItemRequest.expressionAttributeNames());

request.right()
.map(TransactDeleteItemEnhancedRequest::returnValuesOnConditionCheckFailureAsString)
.ifPresent(builder::returnValuesOnConditionCheckFailure);

return TransactWriteItem.builder()
.delete(delete)
.delete(builder.build())
.build();
}

private DeleteItemRequest.Builder addExpressionsIfExist(DeleteItemRequest.Builder requestBuilder) {
if (this.request.conditionExpression() != null) {
requestBuilder = requestBuilder.conditionExpression(this.request.conditionExpression().expression());
Map<String, String> expressionNames = this.request.conditionExpression().expressionNames();
Map<String, AttributeValue> expressionValues = this.request.conditionExpression().expressionValues();
Expression conditionExpression = request.map(r -> Optional.ofNullable(r.conditionExpression()),
r -> Optional.ofNullable(r.conditionExpression()))
.orElse(null);

if (conditionExpression != null) {
requestBuilder = requestBuilder.conditionExpression(conditionExpression.expression());
Map<String, String> expressionNames = conditionExpression.expressionNames();
Map<String, AttributeValue> expressionValues = conditionExpression.expressionValues();

// Avoiding adding empty collections that the low level SDK will propagate to DynamoDb where it causes error.
if (expressionNames != null && !expressionNames.isEmpty()) {
Expand Down
46 changes: 32 additions & 14 deletions ...n/java/software/amazon/awssdk/enhanced/dynamodb/internal/operations/PutItemOperation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package software.amazon.awssdk.enhanced.dynamodb.internal.operations;

import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import software.amazon.awssdk.annotations.SdkInternalApi;
Expand All @@ -27,6 +28,7 @@
import software.amazon.awssdk.enhanced.dynamodb.extensions.WriteModification;
import software.amazon.awssdk.enhanced.dynamodb.internal.extensions.DefaultDynamoDbExtensionContext;
import software.amazon.awssdk.enhanced.dynamodb.model.PutItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.TransactPutItemEnhancedRequest;
import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
Expand All @@ -36,23 +38,32 @@
import software.amazon.awssdk.services.dynamodb.model.PutRequest;
import software.amazon.awssdk.services.dynamodb.model.TransactWriteItem;
import software.amazon.awssdk.services.dynamodb.model.WriteRequest;
import software.amazon.awssdk.utils.Either;

@SdkInternalApi
public class PutItemOperation<T>
implements BatchableWriteOperation<T>,
TransactableWriteOperation<T>,
TableOperation<T, PutItemRequest, PutItemResponse, Void> {

private final PutItemEnhancedRequest<T> request;
private final Either<PutItemEnhancedRequest<T>, TransactPutItemEnhancedRequest<T>> request;

private PutItemOperation(PutItemEnhancedRequest<T> request) {
this.request = request;
this.request = Either.left(request);
}

private PutItemOperation(TransactPutItemEnhancedRequest<T> request) {
this.request = Either.right(request);
}

public static <T> PutItemOperation<T> create(PutItemEnhancedRequest<T> request) {
return new PutItemOperation<>(request);
}

public static <T> PutItemOperation<T> create(TransactPutItemEnhancedRequest<T> request) {
return new PutItemOperation<>(request);
}

@Override
public PutItemRequest generateRequest(TableSchema<T> tableSchema,
OperationContext operationContext,
Expand All @@ -68,7 +79,8 @@ public PutItemRequest generateRequest(TableSchema<T> tableSchema,
tableMetadata.primaryPartitionKey();

boolean alwaysIgnoreNulls = true;
Map<String, AttributeValue> itemMap = tableSchema.itemToMap(this.request.item(), alwaysIgnoreNulls);
T item = request.map(PutItemEnhancedRequest::item, TransactPutItemEnhancedRequest::item);
Map<String, AttributeValue> itemMap = tableSchema.itemToMap(item, alwaysIgnoreNulls);

WriteModification transformation =
extension != null ? extension.beforeWrite(
Expand Down Expand Up @@ -138,28 +150,35 @@ public TransactWriteItem generateTransactWriteItem(TableSchema<T> tableSchema,
DynamoDbEnhancedClientExtension dynamoDbEnhancedClientExtension) {
PutItemRequest putItemRequest = generateRequest(tableSchema, operationContext, dynamoDbEnhancedClientExtension);

Put put = Put.builder()
.item(putItemRequest.item())
.tableName(putItemRequest.tableName())
.conditionExpression(putItemRequest.conditionExpression())
.expressionAttributeValues(putItemRequest.expressionAttributeValues())
.expressionAttributeNames(putItemRequest.expressionAttributeNames())
.build();
Put.Builder builder = Put.builder()
.item(putItemRequest.item())
.tableName(putItemRequest.tableName())
.conditionExpression(putItemRequest.conditionExpression())
.expressionAttributeValues(putItemRequest.expressionAttributeValues())
.expressionAttributeNames(putItemRequest.expressionAttributeNames());

request.right()
.map(TransactPutItemEnhancedRequest::returnValuesOnConditionCheckFailureAsString)
.ifPresent(builder::returnValuesOnConditionCheckFailure);

return TransactWriteItem.builder()
.put(put)
.put(builder.build())
.build();
}

private PutItemRequest.Builder addExpressionsIfExist(PutItemRequest.Builder requestBuilder,
WriteModification transformation) {

Expression originalConditionExpression = request.map(r -> Optional.ofNullable(r.conditionExpression()),
r -> Optional.ofNullable(r.conditionExpression()))
.orElse(null);
Expression mergedConditionExpression;

if (transformation != null && transformation.additionalConditionalExpression() != null) {
mergedConditionExpression = Expression.join(this.request.conditionExpression(),
mergedConditionExpression = Expression.join(originalConditionExpression,
transformation.additionalConditionalExpression(), " AND ");
} else {
mergedConditionExpression = this.request.conditionExpression();
mergedConditionExpression = originalConditionExpression;
}

if (mergedConditionExpression != null) {
Expand All @@ -177,5 +196,4 @@ private PutItemRequest.Builder addExpressionsIfExist(PutItemRequest.Builder requ
}
return requestBuilder;
}

}
55 changes: 38 additions & 17 deletions ...ava/software/amazon/awssdk/enhanced/dynamodb/internal/operations/UpdateItemOperation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import java.util.stream.Collectors;
Expand All @@ -37,6 +38,7 @@
import software.amazon.awssdk.enhanced.dynamodb.internal.extensions.DefaultDynamoDbExtensionContext;
import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.UpdateBehaviorTag;
import software.amazon.awssdk.enhanced.dynamodb.mapper.UpdateBehavior;
import software.amazon.awssdk.enhanced.dynamodb.model.TransactUpdateItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest;
import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
Expand All @@ -46,6 +48,7 @@
import software.amazon.awssdk.services.dynamodb.model.Update;
import software.amazon.awssdk.services.dynamodb.model.UpdateItemRequest;
import software.amazon.awssdk.services.dynamodb.model.UpdateItemResponse;
import software.amazon.awssdk.utils.Either;

@SdkInternalApi
public class UpdateItemOperation<T>
Expand All @@ -62,16 +65,24 @@ public class UpdateItemOperation<T>
key -> "if_not_exists(" + EXPRESSION_KEY_MAPPER.apply(key) + ", " +
EXPRESSION_VALUE_KEY_MAPPER.apply(key) + ")";

private final UpdateItemEnhancedRequest<T> request;
private final Either<UpdateItemEnhancedRequest<T>, TransactUpdateItemEnhancedRequest<T>> request;

private UpdateItemOperation(UpdateItemEnhancedRequest<T> request) {
this.request = request;
this.request = Either.left(request);
}

private UpdateItemOperation(TransactUpdateItemEnhancedRequest<T> request) {
this.request = Either.right(request);
}

public static <T> UpdateItemOperation<T> create(UpdateItemEnhancedRequest<T> request) {
return new UpdateItemOperation<>(request);
}

public static <T> UpdateItemOperation<T> create(TransactUpdateItemEnhancedRequest<T> request) {
return new UpdateItemOperation<>(request);
}

@Override
public UpdateItemRequest generateRequest(TableSchema<T> tableSchema,
OperationContext operationContext,
Expand All @@ -80,8 +91,12 @@ public UpdateItemRequest generateRequest(TableSchema<T> tableSchema,
throw new IllegalArgumentException("UpdateItem cannot be executed against a secondary index.");
}

Map<String, AttributeValue> itemMap = tableSchema.itemToMap(this.request.item(),
Boolean.TRUE.equals(this.request.ignoreNulls()));
T item = request.map(UpdateItemEnhancedRequest::item, TransactUpdateItemEnhancedRequest::item);
Boolean ignoreNulls = request.map(r -> Optional.ofNullable(r.ignoreNulls()),
r -> Optional.ofNullable(r.ignoreNulls()))
.orElse(null);

Map<String, AttributeValue> itemMap = tableSchema.itemToMap(item, Boolean.TRUE.equals(ignoreNulls));
TableMetadata tableMetadata = tableSchema.tableMetadata();

WriteModification transformation =
Expand Down Expand Up @@ -149,17 +164,20 @@ public TransactWriteItem generateTransactWriteItem(TableSchema<T> tableSchema, O
DynamoDbEnhancedClientExtension dynamoDbEnhancedClientExtension) {
UpdateItemRequest updateItemRequest = generateRequest(tableSchema, operationContext, dynamoDbEnhancedClientExtension);

Update update = Update.builder()
.key(updateItemRequest.key())
.tableName(updateItemRequest.tableName())
.updateExpression(updateItemRequest.updateExpression())
.conditionExpression(updateItemRequest.conditionExpression())
.expressionAttributeValues(updateItemRequest.expressionAttributeValues())
.expressionAttributeNames(updateItemRequest.expressionAttributeNames())
.build();
Update.Builder builder = Update.builder()
.key(updateItemRequest.key())
.tableName(updateItemRequest.tableName())
.updateExpression(updateItemRequest.updateExpression())
.conditionExpression(updateItemRequest.conditionExpression())
.expressionAttributeValues(updateItemRequest.expressionAttributeValues())
.expressionAttributeNames(updateItemRequest.expressionAttributeNames());

request.right()
.map(TransactUpdateItemEnhancedRequest::returnValuesOnConditionCheckFailureAsString)
.ifPresent(builder::returnValuesOnConditionCheckFailure);

return TransactWriteItem.builder()
.update(update)
.update(builder.build())
.build();
}

Expand Down Expand Up @@ -251,11 +269,14 @@ private UpdateItemRequest.Builder addExpressionsIfExist(WriteModification transf
}

/* Merge in conditional expression from specified 'conditionExpression' if applicable */
if (this.request.conditionExpression() != null) {
expressionNames = Expression.joinNames(expressionNames, this.request.conditionExpression().expressionNames());
expressionValues = Expression.joinValues(expressionValues, this.request.conditionExpression().expressionValues());
Expression conditionExpression = request.map(r -> Optional.ofNullable(r.conditionExpression()),
r -> Optional.ofNullable(r.conditionExpression()))
.orElse(null);
if (conditionExpression != null) {
expressionNames = Expression.joinNames(expressionNames, conditionExpression.expressionNames());
expressionValues = Expression.joinValues(expressionValues, conditionExpression.expressionValues());
conditionExpressionString = Expression.joinExpressions(conditionExpressionString,
this.request.conditionExpression().expression(), " AND ");
conditionExpression.expression(), " AND ");
}

// Avoiding adding empty collections that the low level SDK will propagate to DynamoDb where it causes error.
Expand Down
Loading