Add Request Object Pattern for DynamoDB Document Model #4140

irina-herciu · 2025-11-18T09:59:40Z

Description

New Request Object Types

Introduced three new request classes under Amazon.DynamoDBv2.DocumentModel:

public class PutItemDocumentOperationRequest { ... }
public class UpdateItemDocumentOperationRequest { ... }
public class DeleteItemDocumentOperationRequest { ... }

Added new overloads to Table:

Task<Document> PutItemAsync(PutItemDocumentOperationRequest request, CancellationToken cancellationToken = default);
Task<Document> UpdateItemAsync(UpdateItemDocumentOperationRequest request, CancellationToken cancellationToken = default);
Task<Document> DeleteItemAsync(DeleteItemDocumentOperationRequest request, CancellationToken cancellationToken = default);

Motivation and Context

The existing Amazon.DynamoDBv2.DocumentModel.Table API relies heavily on method overloads for common operations such as PutItem, UpdateItem, and DeleteItem.
This design:

Obscures caller intent and reduces discoverability.

Makes it difficult to extend support for optional features like projections, and expressions.

Uses legacy constructs (Expected, AttributeUpdates, etc.) that are incompatible with expression-based syntax used in modern DynamoDB APIs.

To modernize this surface and align with other AWS SDKs, this PR introduces strongly-typed request objects for PutItem, UpdateItem, and DeleteItem operations in the Document Model layer.

Testing

Screenshots (if appropriate)

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist

My code follows the code style of this project
My change requires a change to the documentation
I have updated the documentation accordingly
I have read the README document
I have added tests to cover my changes
All new and existing tests passed

License

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

wip wip implement sync update method and unit tests PutItemOperationRequest integration tests

Copilot

Pull request overview

This PR introduces a Request Object Pattern for the DynamoDB Document Model API, modernizing the API surface by replacing overload-heavy methods with strongly-typed request objects. This change makes the API more extensible and aligns with modern SDK patterns by supporting expression-based syntax for operations like PutItem, UpdateItem, DeleteItem, GetItem, and Scan.

Key changes:

Adds new request classes (PutItemDocumentOperationRequest, UpdateItemDocumentOperationRequest, DeleteItemDocumentOperationRequest, GetItemDocumentOperationRequest, ScanDocumentOperationRequest)
Implements a pipeline architecture (DocumentOperationPipeline) for consistent request processing
Adds new method overloads accepting request objects to the Table class

Reviewed changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
DocumentOperationRequest.cs	Defines new request object classes for Get, Put, Update, Delete, and Scan operations
DocumentOperationPipeline.cs	Implements pipeline infrastructure for validating, mapping, and executing document operations
Table.cs	Adds internal helper methods to bridge request objects with the pipeline
Table.Sync.cs	Adds synchronous public API methods and interface definitions for request objects
Table.Async.cs	Adds asynchronous public API methods for request objects
Expression.cs	Adds new methods for applying conditional and update expressions separately
TableTests.cs	Comprehensive unit tests for the new request pattern
DocumentTests.cs	Integration tests validating end-to-end behavior
DataModelTests.cs	Unrelated test for TTL functionality
Util.cs	Minor whitespace fix

Copilot · 2025-11-22T00:10:23Z

sdk/src/Services/DynamoDBv2/Custom/DocumentModel/DocumentOperationPipeline.cs

+        public TResult ExecuteSync(THighLevelRequest request)
+        {
+            Validate(request);
+            var low = Map(request);
+            ApplyExpressions(request, low);
+            var resp = InvokeSync(low);
+            return PostProcess(request, resp);
+        }


The synchronous execution path is missing a call to Table.UpdateRequestUserAgentDetails(low, isAsync: false) before invoking the service. This call is present in the async path (line 58) and is consistently used throughout the existing codebase for telemetry tracking. Add Table.UpdateRequestUserAgentDetails(low, isAsync: false); after line 42.

sdk/src/Services/DynamoDBv2/Custom/DocumentModel/_bcl/Table.Sync.cs

sdk/src/Services/DynamoDBv2/Custom/DocumentModel/DocumentOperationPipeline.cs

Copilot · 2025-11-22T00:10:25Z

sdk/src/Services/DynamoDBv2/Custom/DocumentModel/_async/Table.Async.cs

+            /// <inheritdoc/>
+            public async Task<Document> DeleteItemAsync(IDictionary<string, DynamoDBEntry> key, DeleteItemOperationConfig config, CancellationToken cancellationToken = default(CancellationToken))
            {
-                return await DeleteHelperAsync(MakeKey(key), config, cancellationToken).ConfigureAwait(false);
+                var operationName = DynamoDBTelemetry.ExtractOperationName(nameof(Table), nameof(DeleteItemAsync));
+                using (DynamoDBTelemetry.CreateSpan(TracerProvider, operationName, spanKind: SpanKind.CLIENT))
+                {
+                    return await DeleteHelperAsync(MakeKey(key), config, cancellationToken).ConfigureAwait(false);
+                }
+            }


Inconsistent indentation detected. Lines 587-595 have extra indentation compared to the rest of the file. This should align with the same indentation level as other methods in the class.

Copilot · 2025-11-22T00:10:25Z

sdk/test/Services/DynamoDBv2/IntegrationTests/DataModelTests.cs

+        [TestMethod]
+        [TestCategory("DynamoDBv2")]
+        public void TestContext_SaveItem_WithTTL()
+        {
+            TableCache.Clear();
+            CleanupTables();
+            TableCache.Clear();
+
+            // Create context and table if needed
+            CreateContext(DynamoDBEntryConversion.V2, true);
+
+            // Define TTL to be 2 minutes in the future
+            var ttlEpoch = DateTimeOffset.UtcNow.AddMinutes(2).ToUnixTimeSeconds();
+
+            var item = new TtlTestItem
+            {
+                Id = 1,
+                Data = "Test with TTL",
+                Ttl = ttlEpoch
+            };
+
+            Context.Save(item);
+
+            // Load immediately, should exist
+            var loaded = Context.Load<TtlTestItem>(item.Id);
+            Assert.IsNotNull(loaded);
+            Assert.AreEqual(item.Id, loaded.Id);
+            Assert.AreEqual(item.Data, loaded.Data);
+            Assert.AreEqual(item.Ttl, loaded.Ttl);
+
+            item.Ttl = DateTimeOffset.UtcNow.AddMinutes(3).ToUnixTimeSeconds();
+            Context.Save(item);
+            var loaded2 = Context.Load<TtlTestItem>(item.Id);
+            Assert.IsNotNull(loaded2);
+            Assert.AreEqual(item.Id, loaded2.Id);
+            Assert.AreEqual(item.Data, loaded2.Data);
+            Assert.AreEqual(item.Ttl, loaded2.Ttl);
+        }


This test appears to be unrelated to the PR's purpose of adding Request Object Pattern for DynamoDB Document Model. The test is about TTL functionality in the DataModel (not DocumentModel) and should likely be in a separate PR. According to the PR description, this PR should only contain changes related to introducing request objects for PutItem, UpdateItem, and DeleteItem operations in the Document Model layer.

generator/.DevConfigs/9490947f-209f-47e9-8c70-3698872df304.json

irina-herciu added 2 commits July 21, 2025 10:04

wip request objects

2a01164

Merge branch 'development' into features/atomicOperations

643e85d

anasatirbasa approved these changes Nov 18, 2025

View reviewed changes

irina-herciu changed the title ~~Add Request Object Pattern and Expression-Based Migration for DynamoDB Document Model~~ Add Request Object Pattern for DynamoDB Document Model Nov 19, 2025

DeleteItemDocumentOperationRequest implementation

fc6c71f

wip wip implement sync update method and unit tests PutItemOperationRequest integration tests

irina-herciu force-pushed the features/atomicOperations branch from 1965390 to fc6c71f Compare November 19, 2025 11:52

irina-herciu marked this pull request as ready for review November 19, 2025 11:54

irina-herciu added 2 commits November 21, 2025 09:20

merge from dev

986cdbf

implement DocumentOperationPipeline

da1adc3

ashishdhingra requested review from GarrettBeatty and normj November 21, 2025 18:31

GarrettBeatty requested a review from Copilot November 22, 2025 00:00

Copilot started reviewing on behalf of GarrettBeatty November 22, 2025 00:01 View session

Copilot finished reviewing on behalf of GarrettBeatty November 22, 2025 00:03

Copilot AI reviewed Nov 22, 2025

View reviewed changes

GarrettBeatty changed the base branch from main to development November 22, 2025 01:17

irina-herciu added 3 commits November 24, 2025 12:45

address feedback

e4f3710

increase test coverage

f7b919f

Merge branch 'development' into features/atomicOperations

5c9d403

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Request Object Pattern for DynamoDB Document Model #4140

Add Request Object Pattern for DynamoDB Document Model #4140

irina-herciu commented Nov 18, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 22, 2025

Uh oh!

Copilot AI Nov 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add Request Object Pattern for DynamoDB Document Model #4140

Are you sure you want to change the base?

Add Request Object Pattern for DynamoDB Document Model #4140

Conversation

irina-herciu commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

Testing

Screenshots (if appropriate)

Types of changes

Checklist

License

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

irina-herciu commented Nov 18, 2025 •

edited

Loading