chore: switch to platform AbortController & Signal implementations after dropping Node.js 14 (#1308)

* backwards compatibility for waiter abortController

* rename variable, widen input interfaces

* update unit test

* comment preferred vs legacy control flow

---------

Co-authored-by: Trivikram Kamat <[email protected]>

Author: kuhe

.changeset/spotty-cars-do.md

@@ -0,0 +1,9 @@
+---
+"@smithy/fetch-http-handler": minor
+"@smithy/node-http-handler": minor
+"@smithy/abort-controller": minor
+"@smithy/util-waiter": minor
+"@smithy/types": minor
+---
+
+use platform AbortController|AbortSignal implementations

packages/abort-controller/src/AbortController.ts

@@ -1,16 +1,19 @@
-import { AbortController as IAbortController } from "@smithy/types";
+import { AbortController as DeprecatedAbortController } from "@smithy/types";
 
 import { AbortSignal } from "./AbortSignal";
 
-export { IAbortController };
+/**
+ * @public
+ */
+export { DeprecatedAbortController as IAbortController };
 
 /**
- * This implementation was added as Node.js didn't support AbortController prior to 15.x
+ * @deprecated This implementation was added as Node.js didn't support AbortController prior to 15.x
  * Use native implementation in browsers or Node.js \>=15.4.0.
  *
  * @public
  */
-export class AbortController implements IAbortController {
+export class AbortController implements DeprecatedAbortController {
   public readonly signal: AbortSignal = new AbortSignal();
 
   abort(): void {

packages/abort-controller/src/AbortSignal.ts

@@ -1,11 +1,14 @@
-import { AbortHandler, AbortSignal as IAbortSignal } from "@smithy/types";
+import { AbortHandler, AbortSignal as DeprecatedAbortSignal } from "@smithy/types";
 
-export { AbortHandler, IAbortSignal };
+/**
+ * @public
+ */
+export { AbortHandler, DeprecatedAbortSignal as IAbortSignal };
 
 /**
  * @public
  */
-export class AbortSignal implements IAbortSignal {
+export class AbortSignal implements DeprecatedAbortSignal {
   public onabort: AbortHandler | null = null;
   private _aborted = false;
 

packages/fetch-http-handler/src/fetch-http-handler.ts

@@ -164,11 +164,18 @@ export class FetchHttpHandler implements HttpHandler<FetchHttpHandlerConfig> {
     if (abortSignal) {
       raceOfPromises.push(
         new Promise<never>((resolve, reject) => {
-          abortSignal.onabort = () => {
+          const onAbort = () => {
             const abortError = new Error("Request aborted");
             abortError.name = "AbortError";
             reject(abortError);
           };
+          if (typeof (abortSignal as AbortSignal).addEventListener === "function") {
+            // preferred.
+            (abortSignal as AbortSignal).addEventListener("abort", onAbort);
+          } else {
+            // backwards compatibility
+            abortSignal.onabort = onAbort;
+          }
         })
       );
     }

packages/node-http-handler/src/node-http-handler.spec.ts

@@ -619,12 +619,12 @@ describe("NodeHttpHandler", () => {
       };
       mockHttpsServer.addListener("request", createResponseFunction(mockResponse));
       let httpRequest: http.ClientRequest;
-      let reqAbortSpy: any;
+      let reqDestroySpy: any;
       const spy = jest.spyOn(https, "request").mockImplementationOnce(() => {
         const calls = spy.mock.calls;
         const currentIndex = calls.length - 1;
         httpRequest = https.request(calls[currentIndex][0], calls[currentIndex][1]);
-        reqAbortSpy = jest.spyOn(httpRequest, "abort");
+        reqDestroySpy = jest.spyOn(httpRequest, "destroy");
         return httpRequest;
       });
       const nodeHttpHandler = new NodeHttpHandler();
@@ -650,7 +650,7 @@ describe("NodeHttpHandler", () => {
         )
       ).rejects.toHaveProperty("name", "AbortError");
 
-      expect(reqAbortSpy.mock.calls.length).toBe(1);
+      expect(reqDestroySpy.mock.calls.length).toBe(1);
     });
   });
 

packages/node-http-handler/src/node-http-handler.ts

@@ -243,13 +243,20 @@ or increase socketAcquisitionWarningTimeout=(millis) in the NodeHttpHandler conf
 
       // wire-up abort logic
       if (abortSignal) {
-        abortSignal.onabort = () => {
+        const onAbort = () => {
           // ensure request is destroyed
-          req.abort();
+          req.destroy();
           const abortError = new Error("Request aborted");
           abortError.name = "AbortError";
           reject(abortError);
         };
+        if (typeof (abortSignal as AbortSignal).addEventListener === "function") {
+          // preferred.
+          (abortSignal as AbortSignal).addEventListener("abort", onAbort);
+        } else {
+          // backwards compatibility
+          abortSignal.onabort = onAbort;
+        }
       }
 
       // Workaround for bug report in Node.js https://github.com/nodejs/node/issues/47137

packages/node-http-handler/src/node-http2-handler.ts

@@ -181,12 +181,19 @@ export class NodeHttp2Handler implements HttpHandler<NodeHttp2HandlerOptions> {
       }
 
       if (abortSignal) {
-        abortSignal.onabort = () => {
+        const onAbort = () => {
           req.close();
           const abortError = new Error("Request aborted");
           abortError.name = "AbortError";
           rejectWithDestroy(abortError);
         };
+        if (typeof (abortSignal as AbortSignal).addEventListener === "function") {
+          // preferred.
+          (abortSignal as AbortSignal).addEventListener("abort", onAbort);
+        } else {
+          // backwards compatibility
+          abortSignal.onabort = onAbort;
+        }
       }
 
       // Set up handlers for errors

packages/types/src/abort-handler.ts

@@ -0,0 +1,8 @@
+import type { AbortSignal as DeprecatedAbortSignal } from "./abort";
+
+/**
+ * @public
+ */
+export interface AbortHandler {
+  (this: AbortSignal | DeprecatedAbortSignal, ev: any): any;
+}

packages/types/src/abort.ts

@@ -1,12 +1,13 @@
+import type { AbortHandler } from "./abort-handler";
+
 /**
  * @public
  */
-export interface AbortHandler {
-  (this: AbortSignal, ev: any): any;
-}
+export { AbortHandler };
 
 /**
  * @public
+ * @deprecated use platform (global) type for AbortSignal.
  *
  * Holders of an AbortSignal object may query if the associated operation has
  * been aborted and register an onabort handler.
@@ -28,6 +29,7 @@ export interface AbortSignal {
 
 /**
  * @public
+ * @deprecated use platform (global) type for AbortController.
  *
  * The AWS SDK uses a Controller/Signal model to allow for cooperative
  * cancellation of asynchronous operations. When initiating such an operation,

packages/types/src/http.ts

@@ -1,4 +1,4 @@
-import { AbortSignal } from "./abort";
+import { AbortSignal as DeprecatedAbortSignal } from "./abort";
 import { URI } from "./uri";
 
 /**
@@ -106,7 +106,7 @@ export interface HttpMessage {
  * Represents the options that may be passed to an Http Handler.
  */
 export interface HttpHandlerOptions {
-  abortSignal?: AbortSignal;
+  abortSignal?: AbortSignal | DeprecatedAbortSignal;
 
   /**
    * The maximum time in milliseconds that the connection phase of a request