feat: support abort signals

package.json

@@ -30,18 +30,18 @@
     "@graphql-typed-document-node/core": "^3.1.0",
     "@types/aws4": "^1.5.1",
     "@types/jest": "^26.0.15",
-    "@types/node": "^14.14.10",
+    "@types/node": "^16.18.96",
     "@typescript-eslint/eslint-plugin": "^4.9.0",
     "@typescript-eslint/parser": "^4.9.0",
     "eslint": "^7.14.0",
     "eslint-config-airbnb-typescript": "^12.0.0",
     "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-prettier": "^3.1.4",
-    "jest": "^26.6.3",
+    "jest": "^29.7.0",
     "nock": "^13.0.5",
     "prettier": "^2.2.1",
-    "ts-jest": "^26.4.4",
+    "ts-jest": "^29.1.2",
     "typescript": "~4.1.2",
     "versiony-cli": "^1.3.0"
   },

src/AppsyncClient.ts

@@ -100,9 +100,11 @@ export default class AppsyncClient {
   public request<TData = any, TVariables = Record<string, any>>({
     query,
     variables,
+    signal,
   }: {
     query: TypedDocumentNode<TData, TVariables>;
     variables?: TVariables;
+    signal?: AbortSignal;
   }): Promise<TData> {
     const requestObject = createRequestObject({
       host: this.host,
@@ -118,7 +120,10 @@ export default class AppsyncClient {
       sessionToken: this.sessionToken,
     });
 
-    return httpsRequestPromisified(signedRequestObject) as Promise<TData>;
+    return httpsRequestPromisified({
+      ...signedRequestObject,
+      signal,
+    }) as Promise<TData>;
   }
 }
 

src/createRequestObject.ts

@@ -8,6 +8,7 @@ export type RequestObjectParams = {
   path: string;
   query: TypedDocumentNode;
   variables: any;
+  signal?: AbortSignal;
 };
 
 export type RequestObject = RequestOptions & {
@@ -23,6 +24,7 @@ export default function createRequestObject({
   path,
   query,
   variables,
+  signal,
 }: RequestObjectParams): RequestObject {
   // Covert the DocumentNode to a raw string query
   const rawQuery = print(query);
@@ -39,5 +41,6 @@ export default function createRequestObject({
       query: rawQuery,
       variables,
     }),
+    signal,
   };
 }

src/tests/AppsyncClient.test.ts

@@ -55,3 +55,20 @@ test("Graphql fake-tag works", () => {
   const res = gql`hi`;
   expect(res).toBe("hi");
 });
+
+// nock currently doesn’t support abort signals, see https://github.com/nock/nock/issues/2478
+// this test works but uses the real network, so it’s skipped by default
+test("abort signal is respected", async () => {
+  const realUrl = "https://example.com";
+  const aborted = new AbortController();
+  aborted.abort();
+  await expect(() =>
+    new AppsyncClient({ ...testParams, apiUrl: realUrl }).request({
+      query: GetTodoDocument,
+      variables: {
+        id: "id",
+      },
+      signal: aborted.signal,
+    })
+  ).rejects.toThrow("The operation was aborted");
+});