fix(lib-dynamodb): backwards compat for undefined columns (#5365)

Author: kuhe

lib/lib-dynamodb/src/commands/utils.ts

@@ -82,7 +82,10 @@ const processAllKeysInObj = (obj: any, processFunc: Function, keyNodes: KeyNodes
     return obj.map((item) => processObj(item, processFunc, keyNodes));
   }
   return Object.entries(obj).reduce((acc, [key, value]) => {
-    acc[key] = processObj(value, processFunc, keyNodes);
+    const processedValue = processObj(value, processFunc, keyNodes);
+    if (processedValue !== undefined) {
+      acc[key] = processedValue;
+    }
     return acc;
   }, {} as any);
 };

lib/lib-dynamodb/src/test/lib-dynamodb.e2e.spec.ts

@@ -54,6 +54,8 @@ describe(DynamoDBDocument.name, () => {
     create: null as null | CreateTableCommandOutput,
     write: {} as Record<string, PutCommandOutput>,
     read: {} as Record<string, GetCommandOutput>,
+    undefinedColumnWrite: null as null | PutCommandOutput,
+    undefinedColumnRead: null as null | GetCommandOutput,
     batchWrite: null as null | BatchWriteCommandOutput,
     batchRead: null as null | BatchGetCommandOutput,
     transactWrite: null as null | TransactWriteCommandOutput,
@@ -354,6 +356,30 @@ describe(DynamoDBDocument.name, () => {
       })
       .catch(passError);
 
+    log.undefinedColumnWrite = await doc
+      .put({
+        TableName,
+        Item: {
+          id: "undefinedColumns",
+          A: "A",
+          B: undefined,
+          C: "C",
+          D: undefined,
+          E: "E",
+        },
+      })
+      .catch(passError);
+
+    log.undefinedColumnRead = await doc
+      .get({
+        TableName,
+        Key: {
+          id: "undefinedColumns",
+        },
+        ConsistentRead: true,
+      })
+      .catch(passError);
+
     for (const [id, value] of [["1", data as any], ...Object.entries(data)]) {
       log.update[id] = await doc
         .update({
@@ -446,7 +472,7 @@ describe(DynamoDBDocument.name, () => {
     // to report the table name
   });
 
-  it("describes the test table tables", async () => {
+  it("describes the test table", async () => {
     if (log.describe) {
       expect(log.describe?.Table?.TableName).toEqual(TableName);
     }
@@ -462,6 +488,17 @@ describe(DynamoDBDocument.name, () => {
     }
   });
 
+  it("ignores undefined column values for backwards compatibility", async () => {
+    throwIfError(log.undefinedColumnWrite);
+
+    expect(log.undefinedColumnRead?.Item).toEqual({
+      id: "undefinedColumns",
+      A: "A",
+      C: "C",
+      E: "E",
+    });
+  });
+
   it("can batch write", async () => {
     throwIfError(log.batchWrite);
   });