Skip to content

Fix VersionedRecordExtension to sanitize attribute names in expression value keys #6538

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
zoewangg merged 2 commits into from
Nov 3, 2025
Merged

Fix VersionedRecordExtension to sanitize attribute names in expression value keys #6538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4dc11d
The DynamoDB Enhanced Client now correctly handles version attribute …
zoewangg Oct 31, 2025
602d1b9
Merge branch 'master' into zoewang/versionAttributeFix
zoewangg Nov 3, 2025
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/bugfix-DynamoDBEnhancedClient-2a54d62.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "DynamoDB Enhanced Client",
"contributor": "",
"description": "The DynamoDB Enhanced Client now properly sanitizes version attribute names when building conditional expressions for optimistic locking. Version attributes with special characters in their names will now work correctly. See [#3279](https://github.com/aws/aws-sdk-java-v2/issues/3279)"
}
4 changes: 3 additions & 1 deletion ...in/java/software/amazon/awssdk/enhanced/dynamodb/extensions/VersionedRecordExtension.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

package software.amazon.awssdk.enhanced.dynamodb.extensions;

import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.cleanAttributeName;
import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.isNullAttributeValue;
import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.keyRef;

Expand Down Expand Up @@ -58,7 +59,8 @@
@SdkPublicApi
@ThreadSafe
public final class VersionedRecordExtension implements DynamoDbEnhancedClientExtension {
private static final Function<String, String> VERSIONED_RECORD_EXPRESSION_VALUE_KEY_MAPPER = key -> ":old_" + key + "_value";
private static final Function<String, String> VERSIONED_RECORD_EXPRESSION_VALUE_KEY_MAPPER =
key -> ":old_" + cleanAttributeName(key) + "_value";
private static final String CUSTOM_METADATA_KEY = "VersionedRecordExtension:VersionAttribute";
private static final VersionAttribute VERSION_ATTRIBUTE = new VersionAttribute();

Expand Down
2 changes: 1 addition & 1 deletion ...on/awssdk/enhanced/dynamodb/functionaltests/VersionedRecordWithSpecialCharactersTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public int hashCode() {
.addAttribute(String.class, a -> a.name("_attribute")
.getter(Record::get_attribute)
.setter(Record::set_attribute))
.addAttribute(Integer.class, a -> a.name("_version")
.addAttribute(Integer.class, a -> a.name("_my-:.version")
.getter(Record::get_version)
.setter(Record::set_version)
.tags(versionAttribute()))
Expand Down
Loading