Add DynamoDBContext.SaveAsync(Type valueType, object value, ...)

[ericjpeters]

Describe the feature

The DynamoDBContext save a SaveAsync(T value, ...) method. There are scenarios where the type is not known at compile-time -- for example, when hooking into EF's ChangeTracker to record audit logs from EF into DynamoDB.

It would be helpful to expose the pre-existing non-generic functionality of DynamoDBContext so that SaveAsync(Type valueType, object value, ...) is possible, as an alternative but equivalent path to SaveAsync(T value, ...) when T is not known at compile-time.

Use Case

There are scenarios where the type is not known at compile-time -- for example, when hooking into EF's ChangeTracker to record audit logs from EF into DynamoDB.

Proposed Solution

I will provide a PR. It's quite trivial.

D:\src\OpenSource\aws-sdk-net [master ≡ +0 ~3 -0 !]> git st
On branch master
Your branch is up to date with 'origin/master'.

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   sdk/src/Services/DynamoDBv2/Custom/DataModel/Context.cs
        modified:   sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/Context.Async.cs
        modified:   sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs

no changes added to commit (use "git add" and/or "git commit -a")
D:\src\OpenSource\aws-sdk-net [master ≡ +0 ~3 -0 !]> git diff sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/Context.Async.cs
diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/Context.Async.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/Context.Async.cs
index ff9bb019e14..0527cc8e714 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/Context.Async.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/Context.Async.cs
@@ -14,14 +14,11 @@
  */
 #pragma warning disable 1574

+using Amazon.DynamoDBv2.DocumentModel;
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
-using Amazon.DynamoDBv2.DocumentModel;
-using Amazon.DynamoDBv2.Model;
-using Amazon.Runtime.Internal;

 namespace Amazon.DynamoDBv2.DataModel
 {
@@ -60,6 +57,33 @@ namespace Amazon.DynamoDBv2.DataModel
             return SaveHelperAsync(value, operationConfig, cancellationToken);
         }

+        /// <summary>
+        /// Initiates the asynchronous execution of the Save operation.
+        /// <seealso cref="Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save"/>
+        /// </summary>
+        /// <param name="valueType">Type of the Object to save.</param>
+        /// <param name="value">Object to save.</param>
+        /// <param name="cancellationToken">Token which can be used to cancel the task.</param>
+        /// <returns>A Task that can be used to poll or wait for results, or both.</returns>
+        public Task SaveAsync(Type valueType, object value, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            return SaveHelperAsync(valueType, value, null, cancellationToken);
+        }
+
+        /// <summary>
+        /// Initiates the asynchronous execution of the Save operation.
+        /// <seealso cref="Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save"/>
+        /// </summary>
+        /// <param name="valueType">Type of the Object to save.</param>
+        /// <param name="value">Object to save.</param>
+        /// <param name="operationConfig">Overriding configuration.</param>
+        /// <param name="cancellationToken">Token which can be used to cancel the task.</param>
+        /// <returns>A Task that can be used to poll or wait for results, or both.</returns>
+        public Task SaveAsync(Type valueType, object value, DynamoDBOperationConfig operationConfig, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            return SaveHelperAsync(valueType, value, operationConfig, cancellationToken);
+        }
+
         #endregion

         #region Load async
D:\src\OpenSource\aws-sdk-net [master ≡ +0 ~3 -0 !]> git diff sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs
diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs
index 97ef6d9c4d7..ab11c25394d 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs
@@ -14,12 +14,11 @@
  */
 #pragma warning disable 1574

+using Amazon.DynamoDBv2.DocumentModel;
 using System;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
-using Amazon.DynamoDBv2.DocumentModel;
-using Amazon.DynamoDBv2.Model;

 namespace Amazon.DynamoDBv2.DataModel
 {
@@ -52,6 +51,27 @@ namespace Amazon.DynamoDBv2.DataModel
         /// <returns>A Task that can be used to poll or wait for results, or both.</returns>
         Task SaveAsync<T>(T value, DynamoDBOperationConfig operationConfig, CancellationToken cancellationToken = default(CancellationToken));

+        /// <summary>
+        /// Initiates the asynchronous execution of the Save operation.
+        /// <seealso cref="Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save"/>
+        /// </summary>
+        /// <param name="valueType">Type of the Object to save.</param>
+        /// <param name="value">Object to save.</param>
+        /// <param name="cancellationToken">Token which can be used to cancel the task.</param>
+        /// <returns>A Task that can be used to poll or wait for results, or both.</returns>
+        Task SaveAsync(Type valueType, object value, CancellationToken cancellationToken = default(CancellationToken));
+
+        /// <summary>
+        /// Initiates the asynchronous execution of the Save operation.
+        /// <seealso cref="Amazon.DynamoDBv2.DataModel.DynamoDBContext.Save"/>
+        /// </summary>
+        /// <param name="valueType">Type of the Object to save.</param>
+        /// <param name="value">Object to save.</param>
+        /// <param name="operationConfig">Overriding configuration.</param>
+        /// <param name="cancellationToken">Token which can be used to cancel the task.</param>
+        /// <returns>A Task that can be used to poll or wait for results, or both.</returns>
+        Task SaveAsync(Type valueType, object value, DynamoDBOperationConfig operationConfig, CancellationToken cancellationToken = default(CancellationToken));
+
         #endregion

         #region Load async
D:\src\OpenSource\aws-sdk-net [master ≡ +0 ~3 -0 !]> git diff sdk/src/Services/DynamoDBv2/Custom/DataModel/Context.cs
diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/Context.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/Context.cs
index d44902ae66a..c69cf281d98 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/Context.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/Context.cs
@@ -19,7 +19,6 @@ using System.Threading;
 #if AWS_ASYNC_API
 using System.Threading.Tasks;
 #endif
-using Amazon.DynamoDBv2;
 using Amazon.DynamoDBv2.DocumentModel;

 namespace Amazon.DynamoDBv2.DataModel
@@ -297,6 +296,34 @@ namespace Amazon.DynamoDBv2.DataModel
                 PopulateInstance(storage, value, flatConfig);
             }
         }
+
+        private async Task SaveHelperAsync(Type valueType, object value, DynamoDBOperationConfig operationConfig, CancellationToken cancellationToken)
+        {
+            if (value == null) return;
+
+            DynamoDBFlatConfig flatConfig = new DynamoDBFlatConfig(operationConfig, this.Config);
+            ItemStorage storage = ObjectToItemStorage(value, valueType, false, flatConfig);
+            if (storage == null) return;
+
+            Table table = GetTargetTable(storage.Config, flatConfig);
+            if (
+                (flatConfig.SkipVersionCheck.HasValue && flatConfig.SkipVersionCheck.Value)
+                || !storage.Config.HasVersion)
+            {
+                await table.UpdateHelperAsync(storage.Document, table.MakeKey(storage.Document), null, cancellationToken).ConfigureAwait(false);
+            }
+            else
+            {
+                Document expectedDocument = CreateExpectedDocumentForVersion(storage);
+                SetNewVersion(storage);
+                await table.UpdateHelperAsync(
+                    storage.Document,
+                    table.MakeKey(storage.Document),
+                    new UpdateItemOperationConfig { Expected = expectedDocument, ReturnValues = ReturnValues.None },
+                    cancellationToken).ConfigureAwait(false);
+                PopulateInstance(storage, value, flatConfig);
+            }
+        }
 #endif

         /// <summary>

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS .NET SDK and/or Package version used

AWSSDK.DynamoDBv2 v3.7.101.10

Targeted .NET Platform

.NET 7

Operating System and version

Windows 11 22H2

[ashishdhingra]

Needs review with the team.

[ericjpeters]

@ashishdhingra - I'm happy to do more on the PR if somebody can point me to docs on how to get unit tests to build. I've pulled latest master branch in, but the unit tests project is failing to build, and I have not yet figured out what I'm doing wrong.

Let me know if there is anything else I can do to help with this, it's quite needed for my use-case.

[normj]

@ericjpeters What are the compiler errors you are seeing for the unit test projects?

[ericjpeters]

Windows 11, VS 2022 v17.4.4, clean checkout of Master from today, using AWSSDK.NetStandard.sln -- rebuild all on the solution results in 10 errors in UnitTests.NetStandard: <img width="1396" alt="image" src="https://user-images.githubusercontent.com/10065299/215191688-68b1d330-1e8e-49c7-890a-c353a9527dcd.png"> I’m pretty sure there’s something I’m not doing correctly, but I have not been able to find any documentation stating what that might be. -Eric. From: Norm Johanson ***@***.***> Sent: Friday, January 27, 2023 11:49 AM To: aws/aws-sdk-net ***@***.***> Cc: Eric J. Peters ***@***.***>; Mention ***@***.***> Subject: Re: [aws/aws-sdk-net] Add DynamoDBContext.SaveAsync(Type valueType, object value, ...) (Issue #2503) @ericjpeters<https://github.com/ericjpeters> What are the compiler errors you are seeing for the unit test projects? — Reply to this email directly, view it on GitHub<#2503 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACMZLEZDAWI4J5HXJX4C3JLWUQDCPANCNFSM6AAAAAATE52GEY>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

[ashishdhingra]

Corresponding PR #2506 was merged and released. Closing the issue.

[github-actions]

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.