enhance(delegate): use the native Promise.withResolvers when possib…

…le (#6312) * enhance(delegate): use the native `Promise.withResolvers` when possible * Fix test
ardatan · Jul 1, 2024 · 7b6f77a · 7b6f77a
1 parent 0081f3e
commit 7b6f77a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 31 deletions.
diff --git a/.changeset/lucky-bats-grab.md b/.changeset/lucky-bats-grab.md
@@ -0,0 +1,5 @@
+---
+'@graphql-tools/delegate': patch
+---
+
+Use native `Promise.withResolvers` when possible
diff --git a/packages/delegate/src/leftOver.ts b/packages/delegate/src/leftOver.ts
@@ -2,14 +2,14 @@ import { FieldNode } from 'graphql';
 import { Subschema } from './Subschema.js';
 import { DelegationPlanBuilder, ExternalObject } from './types.js';
 
-export interface Deferred<T = unknown> {
-  promise: Promise<T>;
-  resolve: (value: T) => void;
-  reject: (error: unknown) => void;
-}
+export type Deferred<T = unknown> = PromiseWithResolvers<T>;
 
+// TODO: Remove this after Node 22
 export function createDeferred<T>(): Deferred<T> {
-  let resolve: (value: T) => void;
+  if (Promise.withResolvers) {
+    return Promise.withResolvers();
+  }
+  let resolve: (value: T | PromiseLike<T>) => void;
   let reject: (error: unknown) => void;
   const promise = new Promise<T>((_resolve, _reject) => {
     resolve = _resolve;

diff --git a/packages/executor/src/execution/__tests__/abort-signal.test.ts b/packages/executor/src/execution/__tests__/abort-signal.test.ts
@@ -1,25 +1,11 @@
 import { parse } from 'graphql';
+import { createDeferred } from '@graphql-tools/delegate';
 import { makeExecutableSchema } from '@graphql-tools/schema';
 import { isAsyncIterable } from '@graphql-tools/utils';
 import { Repeater } from '@repeaterjs/repeater';
 import { assertAsyncIterable } from '../../../../loaders/url/tests/test-utils';
 import { normalizedExecutor } from '../normalizedExecutor';
 
-type Deferred<T = void> = {
-  resolve: (value: T) => void;
-  reject: (value: unknown) => void;
-  promise: Promise<T>;
-};
-
-function createDeferred<T = void>(): Deferred<T> {
-  const d = {} as Deferred<T>;
-  d.promise = new Promise<T>((resolve, reject) => {
-    d.resolve = resolve;
-    d.reject = reject;
-  });
-  return d;
-}
-
 describe('Abort Signal', () => {
   it('should stop the subscription', async () => {
     expect.assertions(2);
@@ -79,8 +65,8 @@ describe('Abort Signal', () => {
   });
   it('pending subscription execution is canceled', async () => {
     const controller = new AbortController();
-    const rootResolverGotInvokedD = createDeferred();
-    const requestGotCancelledD = createDeferred();
+    const rootResolverGotInvokedD = createDeferred<void>();
+    const requestGotCancelledD = createDeferred<void>();
     let aResolverGotInvoked = false;
 
     const schema = makeExecutableSchema({
@@ -238,7 +224,7 @@ describe('Abort Signal', () => {
   });
   it('stops pending stream execution for incremental delivery (@stream)', async () => {
     const controller = new AbortController();
-    const d = createDeferred();
+    const d = createDeferred<void>();
     let isReturnInvoked = false;
 
     const schema = makeExecutableSchema({
@@ -300,8 +286,8 @@ describe('Abort Signal', () => {
   });
   it('stops pending stream execution for parallel sources incremental delivery (@stream)', async () => {
     const controller = new AbortController();
-    const d1 = createDeferred();
-    const d2 = createDeferred();
+    const d1 = createDeferred<void>();
+    const d2 = createDeferred<void>();
 
     let isReturn1Invoked = false;
     let isReturn2Invoked = false;
@@ -381,8 +367,8 @@ describe('Abort Signal', () => {
     expect(isReturn2Invoked).toEqual(true);
   });
   it('stops pending stream execution for incremental delivery (@defer)', async () => {
-    const aResolverGotInvokedD = createDeferred();
-    const requestGotCancelledD = createDeferred();
+    const aResolverGotInvokedD = createDeferred<void>();
+    const requestGotCancelledD = createDeferred<void>();
     let bResolverGotInvoked = false;
 
     const schema = makeExecutableSchema({
@@ -458,7 +444,7 @@ describe('Abort Signal', () => {
   });
   it('stops promise execution', async () => {
     const controller = new AbortController();
-    const d = createDeferred();
+    const d = createDeferred<void>();
 
     const schema = makeExecutableSchema({
       typeDefs: /* GraphQL */ `

diff --git a/packages/stitch/tests/isolateComputedFieldsTransformer.test.ts b/packages/stitch/tests/isolateComputedFieldsTransformer.test.ts
@@ -431,7 +431,8 @@ describe('isolateComputedFieldsTransformer', () => {
           },
         },
       });
-      expect(printSchema(new Subschema(baseConfig).transformedSchema)).toMatchInlineSnapshot(`
+      expect(printSchema(new Subschema(baseConfig).transformedSchema).trim())
+        .toMatchInlineSnapshot(`
 "interface IProduct {
   base: String!
 }
@@ -448,7 +449,8 @@ type Mutation {
   addProduct(name: String!): Product!
 }"
 `);
-      expect(printSchema(new Subschema(computedConfig).transformedSchema)).toMatchInlineSnapshot(`
+      expect(printSchema(new Subschema(computedConfig).transformedSchema).trim())
+        .toMatchInlineSnapshot(`
 "interface IProduct {
   base: String!
   computeMe: String!