feat(upload-abort-controller): add optional abortController param for…

… Upload (#3873)
aws · Sep 26, 2022 · 90c6b11 · 90c6b11
1 parent 351d3a0
commit 90c6b11
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/lib/lib-storage/src/Upload.spec.ts b/lib/lib-storage/src/Upload.spec.ts
@@ -68,6 +68,7 @@ import { CompleteMultipartUploadCommandOutput, S3, S3Client } from "@aws-sdk/cli
 import { createHash } from "crypto";
 
 import { Progress, Upload } from "./index";
+import { AbortController } from "@aws-sdk/abort-controller";
 
 const DEFAULT_PART_SIZE = 1024 * 1024 * 5;
 
@@ -638,4 +639,22 @@ describe(Upload.name, () => {
     expect(mockAddListener).toHaveBeenCalledWith("xhr.upload.progress", expect.any(Function));
     expect(mockRemoveListener).toHaveBeenCalledWith("xhr.upload.progress", expect.any(Function));
   });
+
+  it("should respect external abort signal", async () => {
+    const abortController = new AbortController();
+
+    try {
+      const upload = new Upload({
+        params,
+        client: new S3({}),
+        abortController,
+      });
+
+      abortController.abort();
+
+      await upload.done();
+    } catch (error) {
+      expect(error).toBeDefined();
+    }
+  });
 });
diff --git a/lib/lib-storage/src/Upload.ts b/lib/lib-storage/src/Upload.ts
@@ -83,7 +83,7 @@ export class Upload extends EventEmitter {
     // set progress defaults
     this.totalBytes = byteLength(this.params.Body);
     this.bytesUploadedSoFar = 0;
-    this.abortController = new AbortController();
+    this.abortController = options.abortController ?? new AbortController();
   }
 
   async abort(): Promise<void> {

diff --git a/lib/lib-storage/src/types.ts b/lib/lib-storage/src/types.ts
@@ -1,4 +1,5 @@
 import { PutObjectCommandInput, S3Client, Tag } from "@aws-sdk/client-s3";
+import { AbortController } from "@aws-sdk/abort-controller";
 
 export interface Progress {
   loaded?: number;
@@ -40,6 +41,11 @@ export interface Configuration {
    * The tags to apply to the object.
    */
   tags: Tag[];
+
+  /**
+   * Optional abort controller for controlling this upload's abort signal externally.
+   */
+  abortController?: AbortController;
 }
 
 export interface Options extends Partial<Configuration> {