create IAbortSignal, IAbortController types to use instead of globals

Author: igor.luckenkov

src/execution/__tests__/executor-test.ts

@@ -4,6 +4,7 @@ import { describe, it } from 'mocha';
 import { expectJSON } from '../../__testUtils__/expectJSON.js';
 import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick.js';
 
+import type { IAbortSignal, IEvent } from '../../jsutils/AbortController.js';
 import { inspect } from '../../jsutils/inspect.js';
 
 import { Kind } from '../../language/kinds.js';
@@ -1317,7 +1318,7 @@ describe('Execute: Handles basic execution tasks', () => {
 
   it('stops execution and throws an error when signal is aborted', async () => {
     // TODO: use real Event once we can finally drop node14 support
-    class MockAbortEvent implements Event {
+    class MockAbortEvent implements IEvent {
       cancelable = false;
       bubbles = false;
       composed = false;
@@ -1335,9 +1336,9 @@ describe('Execute: Handles basic execution tasks', () => {
       CAPTURING_PHASE = 0;
       NONE = 0;
 
-      target: AbortSignal;
+      target: IAbortSignal;
 
-      constructor(abortSignal: AbortSignal) {
+      constructor(abortSignal: IAbortSignal) {
         this.target = abortSignal;
       }
 
@@ -1362,9 +1363,9 @@ describe('Execute: Handles basic execution tasks', () => {
       };
     }
 
-    class MockAbortSignal implements AbortSignal {
+    class MockAbortSignal implements IAbortSignal {
       aborted: boolean = false;
-      onabort: ((ev: Event) => any) | null = null;
+      onabort: ((ev: IEvent) => any) | null = null;
       reason: unknown;
 
       throwIfAborted() {
@@ -1386,7 +1387,7 @@ describe('Execute: Handles basic execution tasks', () => {
         this.onabort = null;
       }
 
-      dispatchEvent(event: Event): boolean {
+      dispatchEvent(event: IEvent): boolean {
         expect(this.onabort).to.be.a('function');
         this.onabort?.(event);
         return true;

src/execution/execute.ts

@@ -1,3 +1,8 @@
+import type {
+  IAbortController,
+  IAbortSignal,
+  IEvent,
+} from '../jsutils/AbortController.js';
 import { inspect } from '../jsutils/inspect.js';
 import { invariant } from '../jsutils/invariant.js';
 import { isAsyncIterable } from '../jsutils/isAsyncIterable.js';
@@ -262,7 +267,7 @@ export interface ExecutionArgs {
   fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
   typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
   subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
-  signal?: AbortSignal | undefined;
+  signal?: IAbortSignal | undefined;
 }
 
 const UNEXPECTED_EXPERIMENTAL_DIRECTIVES =
@@ -523,16 +528,18 @@ class ExecutionController {
   /** For performance reason we can't use `signal.isAborted` so we cache it here */
   isAborted: boolean = false;
 
-  private readonly _passedInAbortSignal: AbortSignal | undefined;
-  private readonly _abortController: AbortController | undefined =
-    typeof AbortController !== 'undefined' ? new AbortController() : undefined;
+  private readonly _passedInAbortSignal: IAbortSignal | undefined;
+  private readonly _abortController: IAbortController | undefined =
+    typeof AbortController !== 'undefined'
+      ? (new AbortController() as IAbortController)
+      : undefined;
 
-  constructor(signal?: AbortSignal) {
+  constructor(signal?: IAbortSignal) {
     this._passedInAbortSignal = signal;
     this._passedInAbortSignal?.addEventListener('abort', this._abortCB);
   }
 
-  get signal(): AbortSignal | undefined {
+  get signal(): IAbortSignal | undefined {
     return this._abortController?.signal;
   }
 
@@ -542,7 +549,7 @@ class ExecutionController {
     this.isAborted = true;
   }
 
-  private readonly _abortCB = (event: Event) =>
+  private readonly _abortCB = (event: IEvent) =>
     this.abort(
       event.target && 'reason' in event.target
         ? event.target.reason

src/graphql.ts

@@ -1,3 +1,4 @@
+import type { IAbortSignal } from './jsutils/AbortController.js';
 import { isPromise } from './jsutils/isPromise.js';
 import type { Maybe } from './jsutils/Maybe.js';
 import type { PromiseOrValue } from './jsutils/PromiseOrValue.js';
@@ -70,7 +71,7 @@ export interface GraphQLArgs {
   operationName?: Maybe<string>;
   fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
   typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
-  signal?: AbortSignal;
+  signal?: IAbortSignal;
 }
 
 export function graphql(args: GraphQLArgs): Promise<ExecutionResult> {

src/jsutils/AbortController.ts

@@ -0,0 +1,19 @@
+export interface IAbortController {
+  abort: (reason?: unknown) => void;
+  signal: IAbortSignal;
+}
+
+export interface IEvent {
+  target: any;
+}
+
+type EventListener = (event: IEvent) => void;
+
+export interface IAbortSignal {
+  readonly aborted: boolean;
+  onabort: ((this: IAbortSignal, ev: IEvent) => any) | null;
+  readonly reason: any;
+  throwIfAborted: () => void;
+  addEventListener: (type: string, listener: EventListener) => void;
+  removeEventListener: (type: string, listener: EventListener) => void;
+}

src/type/definition.ts

@@ -1,3 +1,4 @@
+import type { IAbortSignal } from '../jsutils/AbortController.js';
 import { devAssert } from '../jsutils/devAssert.js';
 import { didYouMean } from '../jsutils/didYouMean.js';
 import { identityFunc } from '../jsutils/identityFunc.js';
@@ -904,7 +905,7 @@ export interface GraphQLResolveInfo {
    * Note: signal is undefined only if execution environment doesn't support
    * AbortController (e.g. node14 without polyfill).
    */
-  readonly signal: AbortSignal | undefined;
+  readonly signal: IAbortSignal | undefined;
 }
 
 /**