fix: handle default and different types passed to abort method (graphql#4258)

Author: yaacovCR

src/execution/__tests__/abort-signal-test.ts

@@ -60,7 +60,104 @@ describe('Execute: Cancellation', () => {
       },
     });
 
-    abortController.abort('Aborted');
+    abortController.abort();
+
+    const result = await resultPromise;
+
+    expect(result.errors?.[0].originalError?.name).to.equal('AbortError');
+
+    expectJSON(result).toDeepEqual({
+      data: {
+        todo: null,
+      },
+      errors: [
+        {
+          message: 'This operation was aborted',
+          path: ['todo'],
+          locations: [{ line: 3, column: 9 }],
+        },
+      ],
+    });
+  });
+
+  it('should stop the execution when aborted during object field completion with a custom error', async () => {
+    const abortController = new AbortController();
+    const document = parse(`
+      query {
+        todo {
+          id
+          author {
+            id
+          }
+        }
+      }
+    `);
+
+    const resultPromise = execute({
+      document,
+      schema,
+      abortSignal: abortController.signal,
+      rootValue: {
+        todo: async () =>
+          Promise.resolve({
+            id: '1',
+            text: 'Hello, World!',
+            /* c8 ignore next */
+            author: () => expect.fail('Should not be called'),
+          }),
+      },
+    });
+
+    const customError = new Error('Custom abort error');
+    abortController.abort(customError);
+
+    const result = await resultPromise;
+
+    expect(result.errors?.[0].originalError).to.equal(customError);
+
+    expectJSON(result).toDeepEqual({
+      data: {
+        todo: null,
+      },
+      errors: [
+        {
+          message: 'Custom abort error',
+          path: ['todo'],
+          locations: [{ line: 3, column: 9 }],
+        },
+      ],
+    });
+  });
+
+  it('should stop the execution when aborted during object field completion with a custom string', async () => {
+    const abortController = new AbortController();
+    const document = parse(`
+      query {
+        todo {
+          id
+          author {
+            id
+          }
+        }
+      }
+    `);
+
+    const resultPromise = execute({
+      document,
+      schema,
+      abortSignal: abortController.signal,
+      rootValue: {
+        todo: async () =>
+          Promise.resolve({
+            id: '1',
+            text: 'Hello, World!',
+            /* c8 ignore next */
+            author: () => expect.fail('Should not be called'),
+          }),
+      },
+    });
+
+    abortController.abort('Custom abort error message');
 
     const result = await resultPromise;
 
@@ -70,7 +167,7 @@ describe('Execute: Cancellation', () => {
       },
       errors: [
         {
-          message: 'Aborted',
+          message: 'Unexpected error value: "Custom abort error message"',
           path: ['todo'],
           locations: [{ line: 3, column: 9 }],
         },
@@ -106,7 +203,7 @@ describe('Execute: Cancellation', () => {
       },
     });
 
-    abortController.abort('Aborted');
+    abortController.abort();
 
     const result = await resultPromise;
 
@@ -119,7 +216,7 @@ describe('Execute: Cancellation', () => {
       },
       errors: [
         {
-          message: 'Aborted',
+          message: 'This operation was aborted',
           path: ['todo', 'author'],
           locations: [{ line: 5, column: 11 }],
         },
@@ -158,7 +255,7 @@ describe('Execute: Cancellation', () => {
       abortSignal: abortController.signal,
     });
 
-    abortController.abort('Aborted');
+    abortController.abort();
 
     const result = await resultPromise;
 
@@ -168,7 +265,7 @@ describe('Execute: Cancellation', () => {
       },
       errors: [
         {
-          message: 'Aborted',
+          message: 'This operation was aborted',
           path: ['todo'],
           locations: [{ line: 3, column: 9 }],
         },
@@ -196,7 +293,7 @@ describe('Execute: Cancellation', () => {
       },
     });
 
-    abortController.abort('Aborted');
+    abortController.abort();
 
     const result = await resultPromise;
 
@@ -207,7 +304,7 @@ describe('Execute: Cancellation', () => {
       },
       errors: [
         {
-          message: 'Aborted',
+          message: 'This operation was aborted',
           path: ['bar'],
           locations: [{ line: 4, column: 9 }],
         },
@@ -227,7 +324,7 @@ describe('Execute: Cancellation', () => {
         }
       }
     `);
-    abortController.abort('Aborted');
+    abortController.abort();
     const result = await execute({
       document,
       schema,
@@ -241,7 +338,7 @@ describe('Execute: Cancellation', () => {
     expectJSON(result).toDeepEqual({
       errors: [
         {
-          message: 'Aborted',
+          message: 'This operation was aborted',
         },
       ],
     });

src/execution/execute.ts

@@ -344,7 +344,7 @@ export function validateExecutionArgs(
   } = args;
 
   if (abortSignal?.aborted) {
-    return [locatedError(new Error(abortSignal.reason), undefined)];
+    return [locatedError(abortSignal.reason, undefined)];
   }
 
   // If the schema used for execution is invalid, throw an error.
@@ -484,7 +484,7 @@ function executeFieldsSerially(
       const abortSignal = exeContext.validatedExecutionArgs.abortSignal;
       if (abortSignal?.aborted) {
         handleFieldError(
-          new Error(abortSignal.reason),
+          abortSignal.reason,
           exeContext,
           parentType,
           fieldDetailsList,
@@ -1268,7 +1268,7 @@ function completeObjectValue(
   const abortSignal = validatedExecutionArgs.abortSignal;
   if (abortSignal?.aborted) {
     throw locatedError(
-      new Error(abortSignal.reason),
+      abortSignal.reason,
       toNodes(fieldDetailsList),
       pathToArray(path),
     );