rename PromiseCanceller to AbortSignalListener

yaacovCR · Oct 31, 2024 · 3036d41 · 3036d41
1 parent 46643cd
commit 3036d41
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 35 deletions.
diff --git a/src/execution/PromiseCanceller.ts → src/execution/AbortSignalListener.ts b/src/execution/PromiseCanceller.ts → src/execution/AbortSignalListener.ts
@@ -1,12 +1,12 @@
 import { promiseWithResolvers } from '../jsutils/promiseWithResolvers.js';
 
 /**
- * A PromiseCanceller object can be used to cancel multiple promises
- * using a single AbortSignal.
+ * A AbortSignalListener object can be used to trigger multiple responses
+ * in response to an abort signal.
  *
  * @internal
  */
-export class PromiseCanceller {
+export class AbortSignalListener {
   abortSignal: AbortSignal;
   abort: () => void;
 
@@ -28,7 +28,7 @@ export class PromiseCanceller {
     this.abortSignal.removeEventListener('abort', this.abort);
   }
 
-  withCancellation<T>(originalPromise: Promise<T>): Promise<T> {
+  cancellablePromise<T>(originalPromise: Promise<T>): Promise<T> {
     if (this.abortSignal.aborted) {
       // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
       return Promise.reject(this.abortSignal.reason);

diff --git a/src/execution/IncrementalPublisher.ts b/src/execution/IncrementalPublisher.ts
@@ -4,8 +4,8 @@ import { pathToArray } from '../jsutils/Path.js';
 
 import type { GraphQLError } from '../error/GraphQLError.js';
 
+import type { AbortSignalListener } from './AbortSignalListener.js';
 import { IncrementalGraph } from './IncrementalGraph.js';
-import type { PromiseCanceller } from './PromiseCanceller.js';
 import type {
   CancellableStreamRecord,
   CompletedExecutionGroup,
@@ -44,7 +44,7 @@ export function buildIncrementalResponse(
 }
 
 interface IncrementalPublisherContext {
-  promiseCanceller: PromiseCanceller | undefined;
+  abortSignalListener: AbortSignalListener | undefined;
   cancellableStreams: Set<CancellableStreamRecord> | undefined;
 }
 
@@ -127,7 +127,7 @@ class IncrementalPublisher {
       IteratorResult<SubsequentIncrementalExecutionResult, void>
     > => {
       if (isDone) {
-        this._context.promiseCanceller?.disconnect();
+        this._context.abortSignalListener?.disconnect();
         await this._returnAsyncIteratorsIgnoringErrors();
         return { value: undefined, done: true };
       }
@@ -176,7 +176,7 @@ class IncrementalPublisher {
 
       // TODO: add test for this case
       /* c8 ignore next */
-      this._context.promiseCanceller?.disconnect();
+      this._context.abortSignalListener?.disconnect();
       await this._returnAsyncIteratorsIgnoringErrors();
       return { value: undefined, done: true };
     };

diff --git a/...cution/__tests__/PromiseCanceller-test.ts → ...ion/__tests__/AbortSignalListener-test.ts b/...cution/__tests__/PromiseCanceller-test.ts → ...ion/__tests__/AbortSignalListener-test.ts
@@ -2,39 +2,39 @@ import { describe, it } from 'mocha';
 
 import { expectPromise } from '../../__testUtils__/expectPromise.js';
 
-import { PromiseCanceller } from '../PromiseCanceller.js';
+import { AbortSignalListener } from '../AbortSignalListener.js';
 
-describe('PromiseCanceller', () => {
+describe('AbortSignalListener', () => {
   it('works to cancel an already resolved promise', async () => {
     const abortController = new AbortController();
     const abortSignal = abortController.signal;
 
-    const promiseCanceller = new PromiseCanceller(abortSignal);
+    const abortSignalListener = new AbortSignalListener(abortSignal);
 
     const promise = Promise.resolve(1);
 
-    const withCancellation = promiseCanceller.withCancellation(promise);
+    const cancellablePromise = abortSignalListener.cancellablePromise(promise);
 
     abortController.abort(new Error('Cancelled!'));
 
-    await expectPromise(withCancellation).toRejectWith('Cancelled!');
+    await expectPromise(cancellablePromise).toRejectWith('Cancelled!');
   });
 
   it('works to cancel a hanging promise', async () => {
     const abortController = new AbortController();
     const abortSignal = abortController.signal;
 
-    const promiseCanceller = new PromiseCanceller(abortSignal);
+    const abortSignalListener = new AbortSignalListener(abortSignal);
 
     const promise = new Promise(() => {
       /* never resolves */
     });
 
-    const withCancellation = promiseCanceller.withCancellation(promise);
+    const cancellablePromise = abortSignalListener.cancellablePromise(promise);
 
     abortController.abort(new Error('Cancelled!'));
 
-    await expectPromise(withCancellation).toRejectWith('Cancelled!');
+    await expectPromise(cancellablePromise).toRejectWith('Cancelled!');
   });
 
   it('works to cancel a hanging promise created after abort signal triggered', async () => {
@@ -43,14 +43,14 @@ describe('PromiseCanceller', () => {
 
     abortController.abort(new Error('Cancelled!'));
 
-    const promiseCanceller = new PromiseCanceller(abortSignal);
+    const abortSignalListener = new AbortSignalListener(abortSignal);
 
     const promise = new Promise(() => {
       /* never resolves */
     });
 
-    const withCancellation = promiseCanceller.withCancellation(promise);
+    const cancellablePromise = abortSignalListener.cancellablePromise(promise);
 
-    await expectPromise(withCancellation).toRejectWith('Cancelled!');
+    await expectPromise(cancellablePromise).toRejectWith('Cancelled!');
   });
 });
diff --git a/src/execution/execute.ts b/src/execution/execute.ts
@@ -48,6 +48,7 @@ import { GraphQLStreamDirective } from '../type/directives.js';
 import type { GraphQLSchema } from '../type/schema.js';
 import { assertValidSchema } from '../type/validate.js';
 
+import { AbortSignalListener } from './AbortSignalListener.js';
 import type { DeferUsageSet, ExecutionPlan } from './buildExecutionPlan.js';
 import { buildExecutionPlan } from './buildExecutionPlan.js';
 import type {
@@ -63,7 +64,6 @@ import {
 import { getVariableSignature } from './getVariableSignature.js';
 import { buildIncrementalResponse } from './IncrementalPublisher.js';
 import { mapAsyncIterable } from './mapAsyncIterable.js';
-import { PromiseCanceller } from './PromiseCanceller.js';
 import type {
   CancellableStreamRecord,
   CompletedExecutionGroup,
@@ -164,7 +164,7 @@ export interface ValidatedExecutionArgs {
 export interface ExecutionContext {
   validatedExecutionArgs: ValidatedExecutionArgs;
   errors: Array<GraphQLError> | undefined;
-  promiseCanceller: PromiseCanceller | undefined;
+  abortSignalListener: AbortSignalListener | undefined;
   completed: boolean;
   cancellableStreams: Set<CancellableStreamRecord> | undefined;
 }
@@ -318,8 +318,8 @@ export function experimentalExecuteQueryOrMutationOrSubscriptionEvent(
   const exeContext: ExecutionContext = {
     validatedExecutionArgs,
     errors: undefined,
-    promiseCanceller: abortSignal
-      ? new PromiseCanceller(abortSignal)
+    abortSignalListener: abortSignal
+      ? new AbortSignalListener(abortSignal)
       : undefined,
     completed: false,
     cancellableStreams: undefined,
@@ -378,7 +378,7 @@ export function experimentalExecuteQueryOrMutationOrSubscriptionEvent(
         },
         (error: unknown) => {
           exeContext.completed = true;
-          exeContext.promiseCanceller?.disconnect();
+          exeContext.abortSignalListener?.disconnect();
           return {
             data: null,
             errors: withError(exeContext.errors, error as GraphQLError),
@@ -392,7 +392,7 @@ export function experimentalExecuteQueryOrMutationOrSubscriptionEvent(
     exeContext.completed = true;
     // TODO: add test case for synchronous null bubbling to root with cancellation
     /* c8 ignore next */
-    exeContext.promiseCanceller?.disconnect();
+    exeContext.abortSignalListener?.disconnect();
     return { data: null, errors: withError(exeContext.errors, error) };
   }
 }
@@ -483,7 +483,7 @@ function buildDataResponse(
   const { rawResult: data, incrementalDataRecords } = graphqlWrappedResult;
   const errors = exeContext.errors;
   if (incrementalDataRecords === undefined) {
-    exeContext.promiseCanceller?.disconnect();
+    exeContext.abortSignalListener?.disconnect();
     return errors !== undefined ? { errors, data } : { data };
   }
 
@@ -834,7 +834,7 @@ function executeField(
   incrementalContext: IncrementalContext | undefined,
   deferMap: ReadonlyMap<DeferUsage, DeferredFragmentRecord> | undefined,
 ): PromiseOrValue<GraphQLWrappedResult<unknown>> | undefined {
-  const { validatedExecutionArgs, promiseCanceller } = exeContext;
+  const { validatedExecutionArgs, abortSignalListener } = exeContext;
   const { schema, contextValue, variableValues, hideSuggestions, abortSignal } =
     validatedExecutionArgs;
   const fieldName = fieldDetailsList[0].node.name.value;
@@ -879,7 +879,7 @@ function executeField(
         fieldDetailsList,
         info,
         path,
-        promiseCanceller?.withCancellation(result) ?? result,
+        abortSignalListener?.cancellablePromise(result) ?? result,
         incrementalContext,
         deferMap,
       );
@@ -1598,7 +1598,7 @@ async function completePromisedListItemValue(
   deferMap: ReadonlyMap<DeferUsage, DeferredFragmentRecord> | undefined,
 ): Promise<unknown> {
   try {
-    const resolved = await (exeContext.promiseCanceller?.withCancellation(
+    const resolved = await (exeContext.abortSignalListener?.cancellablePromise(
       item,
     ) ?? item);
     let completed = completeValue(
@@ -2220,19 +2220,19 @@ function executeSubscription(
     const result = resolveFn(rootValue, args, contextValue, info, abortSignal);
 
     if (isPromise(result)) {
-      const promiseCanceller = abortSignal
-        ? new PromiseCanceller(abortSignal)
+      const abortSignalListener = abortSignal
+        ? new AbortSignalListener(abortSignal)
         : undefined;
-      const promise = promiseCanceller?.withCancellation(result) ?? result;
+      const promise = abortSignalListener?.cancellablePromise(result) ?? result;
       return promise.then(assertEventStream).then(
         (resolved) => {
           // TODO: add test case
           /* c8 ignore next */
-          promiseCanceller?.disconnect();
+          abortSignalListener?.disconnect();
           return resolved;
         },
         (error: unknown) => {
-          promiseCanceller?.disconnect();
+          abortSignalListener?.disconnect();
           throw locatedError(error, fieldNodes, pathToArray(path));
         },
       );
@@ -2604,7 +2604,7 @@ function completeStreamItem(
       fieldDetailsList,
       info,
       itemPath,
-      exeContext.promiseCanceller?.withCancellation(item) ?? item,
+      exeContext.abortSignalListener?.cancellablePromise(item) ?? item,
       incrementalContext,
       new Map(),
     ).then(