enhance: AbortSignal in GraphQLResolveInfo, and AbortSignal in …

…`ExecutionRequest`
ardatan · Dec 13, 2024 · 020b9e4 · 020b9e4
1 parent aeee7db
commit 020b9e4
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 17 deletions.
diff --git a/.changeset/selfish-mugs-promise.md b/.changeset/selfish-mugs-promise.md
@@ -0,0 +1,8 @@
+---
+'@graphql-tools/executor': patch
+'@graphql-tools/schema': patch
+'@graphql-tools/utils': patch
+'@graphql-tools/mock': patch
+---
+
+\`AbortSignal\` in \`GraphQLResolveInfo\`, and \`AbortSignal\` in \`ExecutionRequest\`
diff --git a/packages/executor/src/execution/__tests__/executor-test.ts b/packages/executor/src/execution/__tests__/executor-test.ts
@@ -206,6 +206,7 @@ describe('Execute: Handles basic execution tasks', () => {
       'rootValue',
       'operation',
       'variableValues',
+      'signal',
     ]);
 
     const operation = document.definitions[0];

diff --git a/packages/executor/src/execution/execute.ts b/packages/executor/src/execution/execute.ts
@@ -13,7 +13,6 @@ import {
   GraphQLList,
   GraphQLObjectType,
   GraphQLOutputType,
-  GraphQLResolveInfo,
   GraphQLSchema,
   GraphQLTypeResolver,
   isAbstractType,
@@ -38,6 +37,7 @@ import {
   fakePromise,
   getArgumentValues,
   getDefinedRootType,
+  GraphQLResolveInfo,
   GraphQLStreamDirective,
   inspect,
   isAsyncIterable,
@@ -758,6 +758,7 @@ export function buildResolveInfo(
     rootValue: exeContext.rootValue,
     operation: exeContext.operation,
     variableValues: exeContext.variableValues,
+    signal: exeContext.signal,
   };
 }
 
@@ -957,9 +958,13 @@ async function completeAsyncIteratorValue(
   iterator: AsyncIterator<unknown>,
   asyncPayloadRecord?: AsyncPayloadRecord,
 ): Promise<ReadonlyArray<unknown>> {
-  exeContext.signal?.addEventListener('abort', () => {
-    iterator.return?.();
-  });
+  exeContext.signal?.addEventListener(
+    'abort',
+    () => {
+      iterator.return?.();
+    },
+    { once: true },
+  );
   const errors = asyncPayloadRecord?.errors ?? exeContext.errors;
   const stream = getStreamValues(exeContext, fieldNodes, path);
   let containsPromise = false;
@@ -2080,10 +2085,14 @@ function yieldSubsequentPayloads(
   let isDone = false;
 
   const abortPromise = new Promise<void>((_, reject) => {
-    exeContext.signal?.addEventListener('abort', () => {
-      isDone = true;
-      reject(exeContext.signal?.reason);
-    });
+    exeContext.signal?.addEventListener(
+      'abort',
+      () => {
+        isDone = true;
+        reject(exeContext.signal?.reason);
+      },
+      { once: true },
+    );
   });
 
   async function next(): Promise<IteratorResult<SubsequentIncrementalExecutionResult, void>> {
@@ -2141,7 +2150,7 @@ function yieldSubsequentPayloads(
     async throw(error?: unknown): Promise<IteratorResult<never, void>> {
       await returnStreamIterators();
       isDone = true;
-      return Promise.reject(error);
+      throw error;
     },
     async [DisposableSymbols.asyncDispose]() {
       await returnStreamIterators();

diff --git a/packages/executor/src/execution/normalizedExecutor.ts b/packages/executor/src/execution/normalizedExecutor.ts
@@ -1,6 +1,13 @@
-import { getOperationAST } from 'graphql';
+import { getOperationAST, GraphQLSchema } from 'graphql';
 import { ValueOrPromise } from 'value-or-promise';
-import { ExecutionResult, MaybeAsyncIterable, MaybePromise } from '@graphql-tools/utils';
+import {
+  ExecutionRequest,
+  ExecutionResult,
+  Executor,
+  MaybeAsyncIterable,
+  MaybePromise,
+  memoize1,
+} from '@graphql-tools/utils';
 import { execute, ExecutionArgs, flattenIncrementalResults, subscribe } from './execute.js';
 
 export function normalizedExecutor<TData = any, TVariables = any, TContext = any>(
@@ -22,3 +29,19 @@ export function normalizedExecutor<TData = any, TVariables = any, TContext = any
     })
     .resolve()!;
 }
+
+export const executorFromSchema = memoize1(function executorFromSchema(
+  schema: GraphQLSchema,
+): Executor {
+  return function schemaExecutor(request: ExecutionRequest) {
+    return normalizedExecutor({
+      schema,
+      document: request.document,
+      variableValues: request.variables,
+      operationName: request.operationName,
+      rootValue: request.rootValue,
+      contextValue: request.context,
+      signal: request.signal || request.info?.signal,
+    });
+  };
+});
diff --git a/packages/mock/src/pagination.ts b/packages/mock/src/pagination.ts
@@ -1,5 +1,4 @@
-import { GraphQLResolveInfo } from 'graphql';
-import { IFieldResolver } from '@graphql-tools/utils';
+import { GraphQLResolveInfo, IFieldResolver } from '@graphql-tools/utils';
 import { IMockStore, Ref } from './types.js';
 import { isRootType, makeRef } from './utils.js';
 

diff --git a/packages/schema/src/chainResolvers.ts b/packages/schema/src/chainResolvers.ts
@@ -1,5 +1,5 @@
-import { defaultFieldResolver, GraphQLFieldResolver, GraphQLResolveInfo } from 'graphql';
-import { Maybe } from '@graphql-tools/utils';
+import { defaultFieldResolver, GraphQLFieldResolver } from 'graphql';
+import { GraphQLResolveInfo, Maybe } from '@graphql-tools/utils';
 
 export function chainResolvers<TArgs extends { [argName: string]: any }>(
   resolvers: Array<Maybe<GraphQLFieldResolver<any, any, TArgs>>>,

diff --git a/packages/utils/src/Interfaces.ts b/packages/utils/src/Interfaces.ts
@@ -24,7 +24,6 @@ import {
   GraphQLNamedType,
   GraphQLObjectType,
   GraphQLOutputType,
-  GraphQLResolveInfo,
   GraphQLScalarLiteralParser,
   GraphQLScalarSerializer,
   GraphQLScalarType,
@@ -40,6 +39,7 @@ import {
   ObjectTypeDefinitionNode,
   ObjectTypeExtensionNode,
   OperationTypeNode,
+  GraphQLResolveInfo as OrigGraphQLResolveInfo,
   ScalarTypeDefinitionNode,
   ScalarTypeExtensionNode,
   SelectionNode,
@@ -68,6 +68,10 @@ export interface ExecutionResult<TData = any, TExtensions = any> {
   items?: TData | null;
 }
 
+export interface GraphQLResolveInfo extends OrigGraphQLResolveInfo {
+  signal?: AbortSignal;
+}
+
 export interface ExecutionRequest<
   TVariables extends Record<string, any> = any,
   TContext = any,
@@ -86,6 +90,7 @@ export interface ExecutionRequest<
   // If the request originates within execution of a parent request, it may contain the parent context and info
   context?: TContext;
   info?: GraphQLResolveInfo;
+  signal?: AbortSignal;
 }
 
 // graphql-js non-exported typings

diff --git a/packages/utils/src/getResponseKeyFromInfo.ts b/packages/utils/src/getResponseKeyFromInfo.ts
@@ -1,4 +1,4 @@
-import { GraphQLResolveInfo } from 'graphql';
+import { GraphQLResolveInfo } from './Interfaces.js';
 
 /**
  * Get the key under which the result of this resolver will be placed in the response JSON. Basically, just