fix(lib-dynamodb): e2e scenarios WIP

aws · Oct 5, 2023 · 8fb23b2 · 8fb23b2
1 parent 7e23cfa
commit 8fb23b2
Show file tree

Hide file tree

Showing 8 changed files with 272 additions and 47 deletions.
diff --git a/lib/lib-dynamodb/src/test/lib-dynamodb.e2e.spec.ts b/lib/lib-dynamodb/src/test/lib-dynamodb.e2e.spec.ts
diff --git a/lib/lib-storage/example-code/file-upload.ts b/lib/lib-storage/example-code/file-upload.ts
@@ -1,7 +1,6 @@
-import { S3 } from "@aws-sdk/client-s3";
-import { Upload } from "@aws-sdk/lib-storage";
 import * as fs from "fs";
-
+import { Upload } from "@aws-sdk/lib-storage";
+import { S3 } from "@aws-sdk/client-s3";
 import { configuration } from "./config";
 
 const fileStream = fs.createReadStream(__dirname + "/big.file");

diff --git a/lib/lib-storage/example-code/upload-abort.ts b/lib/lib-storage/example-code/upload-abort.ts
@@ -1,8 +1,7 @@
 import { S3Client } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
-import { Readable } from "stream";
-
 import { configuration } from "./config";
+import { Readable } from "stream";
 
 const Bucket = configuration.Bucket;
 const region = "us-west-2";
@@ -24,7 +23,7 @@ const uploadIndeterminateLengthStreamNode = async () => {
   const streamOfUnknownlength = Readable.from(generateContents());
 
   const Key = configuration.Key;
-  const upload = new Upload({
+  let upload = new Upload({
     client: new S3Client({ region }),
     params: {
       Key,
@@ -39,7 +38,7 @@ const uploadIndeterminateLengthStreamNode = async () => {
 
   setTimeout(() => {
     console.log(" Aborting ....");
-    const res = upload.abort();
+    let res = upload.abort();
   }, 10 * 1000);
 
   const uploadResult = await upload.done();

diff --git a/lib/lib-storage/example-code/upload-string.ts b/lib/lib-storage/example-code/upload-string.ts
@@ -1,6 +1,5 @@
-import { S3 } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
-
+import { S3 } from "@aws-sdk/client-s3";
 import { configuration } from "./config";
 
 const Bucket = configuration.Bucket;

diff --git a/lib/lib-storage/example-code/upload-unknown-length-browser.ts b/lib/lib-storage/example-code/upload-unknown-length-browser.ts
@@ -1,6 +1,7 @@
+import { fromCognitoIdentityPool } from "@aws-sdk/credential-provider-cognito-identity";
 import { CognitoIdentityClient } from "@aws-sdk/client-cognito-identity";
+
 import { S3Client } from "@aws-sdk/client-s3";
-import { fromCognitoIdentityPool } from "@aws-sdk/credential-provider-cognito-identity";
 import { Upload } from "@aws-sdk/lib-storage";
 
 import { configuration } from "./config";
@@ -36,7 +37,7 @@ const uploadIndeterminateLengthStreamBrowser = async () => {
 
   const Key = configuration.Key;
 
-  const upload = new Upload({
+  let upload = new Upload({
     client,
     params: {
       Key,

diff --git a/lib/lib-storage/example-code/upload-unknown-length.ts b/lib/lib-storage/example-code/upload-unknown-length.ts
@@ -1,7 +1,7 @@
 import { S3Client } from "@aws-sdk/client-s3";
 import { Upload } from "@aws-sdk/lib-storage";
-import { Readable } from "stream";
 
+import { Readable } from "stream";
 import { configuration } from "./config";
 
 const Bucket = configuration.Bucket;
@@ -23,7 +23,7 @@ const fakeStreamOfUnknownlength = Readable.from(generateContents());
 
 const uploadIndeterminateLengthStreamNode = async () => {
   const Key = configuration.Key;
-  const upload = new Upload({
+  let upload = new Upload({
     client: new S3Client({ region }),
     params: {
       Key,

diff --git a/packages/util-dynamodb/src/marshall.ts b/packages/util-dynamodb/src/marshall.ts
@@ -22,6 +22,9 @@ export interface marshallOptions {
   /**
    * Whether to convert the top level container
    * if it is a map or list.
+   *
+   * Default is true when using the DynamoDBDocumentClient,
+   * but false if directly using the marshall function (backwards compatibility).
    */
   convertTopLevelContainer?: boolean;
 }

diff --git a/packages/util-dynamodb/src/unmarshall.ts b/packages/util-dynamodb/src/unmarshall.ts
@@ -16,7 +16,7 @@ export interface unmarshallOptions {
    * When true, skip wrapping the data in `{ M: data }` before converting.
    *
    * Default is true when using the DynamoDBDocumentClient,
-   * but false if only using the unmarshall function.
+   * but false if directly using the unmarshall function (backwards compatibility)..
    */
   convertWithoutMapWrapper?: boolean;
 }