Bump whatwg-node and improve types (#3384)

* Bump whatwg-node and improve types

* chore(dependencies): updated changesets for modified dependencies

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: ardatan

.changeset/graphql-yoga-3384-dependencies.md

@@ -0,0 +1,21 @@
+---
+'graphql-yoga': patch
+---
+dependencies updates:
+  - Updated dependency [`@envelop/core@^5.0.1`
+    ↗︎](https://www.npmjs.com/package/@envelop/core/v/5.0.1) (from `^5.0.0`, in `dependencies`)
+  - Updated dependency [`@graphql-tools/executor@^1.3.0`
+    ↗︎](https://www.npmjs.com/package/@graphql-tools/executor/v/1.3.0) (from `^1.2.5`, in
+    `dependencies`)
+  - Updated dependency [`@graphql-tools/schema@^10.0.4`
+    ↗︎](https://www.npmjs.com/package/@graphql-tools/schema/v/10.0.4) (from `^10.0.0`, in
+    `dependencies`)
+  - Updated dependency [`@graphql-tools/utils@^10.3.2`
+    ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/10.3.2) (from `^10.1.0`, in
+    `dependencies`)
+  - Updated dependency [`@whatwg-node/fetch@^0.9.18`
+    ↗︎](https://www.npmjs.com/package/@whatwg-node/fetch/v/0.9.18) (from `^0.9.17`, in
+    `dependencies`)
+  - Updated dependency [`@whatwg-node/server@^0.9.40`
+    ↗︎](https://www.npmjs.com/package/@whatwg-node/server/v/0.9.40) (from `^0.9.36`, in
+    `dependencies`)

packages/graphql-yoga/__tests__/error-masking.spec.ts

@@ -749,7 +749,7 @@ describe('error masking', () => {
       ],
     });
     // in the future this might change as we decide to within our graphql-tools/executor error handler treat DOMException similar to a normal Error
-    expect(error.mock.calls).toMatchObject([[{ message: 'Unexpected error value: {}' }]]);
+    expect(error.mock.calls).toMatchObject([[{ message: 'This operation was aborted' }]]);
     expect(debug.mock.calls).toEqual([
       ['Parsing request to extract GraphQL parameters'],
       ['Processing GraphQL Parameters'],

packages/graphql-yoga/package.json

@@ -49,14 +49,14 @@
     "graphql": "^15.2.0 || ^16.0.0"
   },
   "dependencies": {
-    "@envelop/core": "^5.0.0",
-    "@graphql-tools/executor": "^1.2.5",
-    "@graphql-tools/schema": "^10.0.0",
-    "@graphql-tools/utils": "^10.1.0",
+    "@envelop/core": "^5.0.1",
+    "@graphql-tools/executor": "^1.3.0",
+    "@graphql-tools/schema": "^10.0.4",
+    "@graphql-tools/utils": "^10.3.2",
     "@graphql-yoga/logger": "workspace:^",
     "@graphql-yoga/subscription": "workspace:^",
-    "@whatwg-node/fetch": "^0.9.17",
-    "@whatwg-node/server": "^0.9.36",
+    "@whatwg-node/fetch": "^0.9.18",
+    "@whatwg-node/server": "^0.9.40",
     "dset": "^3.1.1",
     "lru-cache": "^10.0.0",
     "tslib": "^2.5.2"

packages/graphql-yoga/src/plugins/types.ts

@@ -6,7 +6,7 @@ import {
   PromiseOrValue,
 } from '@envelop/core';
 import { ExecutionResult } from '@graphql-tools/utils';
-import { ServerAdapterPlugin } from '@whatwg-node/server';
+import { ServerAdapterInitialContext, ServerAdapterPlugin } from '@whatwg-node/server';
 import { YogaServer } from '../server.js';
 import {
   FetchAPI,
@@ -71,7 +71,7 @@ export type OnRequestHook<TServerContext> = (
 
 export interface OnRequestEventPayload<TServerContext> {
   request: Request;
-  serverContext: TServerContext | undefined;
+  serverContext: TServerContext & ServerAdapterInitialContext;
   fetchAPI: FetchAPI;
   endResponse(response: Response): void;
   url: URL;
@@ -89,7 +89,7 @@ export interface OnRequestParseEventPayload<TServerContext> {
   request: Request;
   url: URL;
   requestParser: RequestParser | undefined;
-  serverContext: TServerContext;
+  serverContext: TServerContext & ServerAdapterInitialContext;
   setRequestParser: (parser: RequestParser) => void;
 }
 
@@ -143,13 +143,3 @@ export interface OnResultProcessEventPayload {
   acceptableMediaTypes: string[];
   setResultProcessor(resultProcessor: ResultProcessor, acceptedMediaType: string): void;
 }
-
-export type OnResponseHook<TServerContext> = (
-  payload: OnResponseEventPayload<TServerContext>,
-) => PromiseOrValue<void>;
-
-export interface OnResponseEventPayload<TServerContext> {
-  request: Request;
-  serverContext: TServerContext | undefined;
-  response: Response;
-}

packages/graphql-yoga/src/server.ts

@@ -17,6 +17,7 @@ import {
   createServerAdapter,
   ServerAdapter,
   ServerAdapterBaseObject,
+  ServerAdapterInitialContext,
   ServerAdapterRequestHandler,
   useCORS,
   useErrorHandling,
@@ -454,10 +455,7 @@ export class YogaServer<
       request: Request;
       batched: boolean;
     },
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    ...args: {} extends TServerContext
-      ? [serverContext?: TServerContext | undefined]
-      : [serverContext: TServerContext]
+    serverContext: TServerContext,
   ) {
     try {
       let result: ExecutionResult | AsyncIterable<ExecutionResult> | undefined;
@@ -478,7 +476,7 @@ export class YogaServer<
 
       if (result == null) {
         const additionalContext =
-          args[0]?.request === request
+          serverContext.request === request
             ? {
                 params,
               }
@@ -487,9 +485,10 @@ export class YogaServer<
                 params,
               };
 
-        const initialContext = args[0]
-          ? Object.assign(batched ? Object.create(args[0]) : args[0], additionalContext)
-          : additionalContext;
+        const initialContext = Object.assign(
+          batched ? Object.create(serverContext) : serverContext,
+          additionalContext,
+        );
 
         const enveloped = this.getEnveloped(initialContext);
 
@@ -537,7 +536,7 @@ export class YogaServer<
 
   handle: ServerAdapterRequestHandler<TServerContext> = async (
     request: Request,
-    serverContext: TServerContext,
+    serverContext: TServerContext & ServerAdapterInitialContext,
   ) => {
     let url = new Proxy({} as URL, {
       get: (_target, prop, _receiver) => {
@@ -623,11 +622,12 @@ export type YogaServerInstance<
 export function createYoga<
   TServerContext extends Record<string, any> = {},
   TUserContext extends Record<string, any> = {},
->(options: YogaServerOptions<TServerContext, TUserContext>) {
+>(
+  options: YogaServerOptions<TServerContext, TUserContext>,
+): YogaServerInstance<TServerContext, TUserContext> {
   const server = new YogaServer<TServerContext, TUserContext>(options);
   return createServerAdapter<TServerContext, YogaServer<TServerContext, TUserContext>>(server, {
     fetchAPI: server.fetchAPI,
     plugins: server['plugins'],
-  }) as unknown as YogaServerInstance<TServerContext, TUserContext>;
-  // TODO: Fix in @whatwg-node/server later
+  });
 }

packages/nestjs/src/index.ts

@@ -135,7 +135,9 @@ export abstract class AbstractYogaDriver<
           : options.logging,
     });
 
-    this.yoga = yoga as YogaDriverServerInstance<Platform>;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - TODO: fix types
+    this.yoga = yoga;
 
     app.use(yoga.graphqlEndpoint, (req, res) => yoga(req, res, { req, res }));
   }
@@ -159,7 +161,9 @@ export abstract class AbstractYogaDriver<
       logging: options.logging == null ? false : options.logging ? app.log : options.logging,
     });
 
-    this.yoga = yoga as YogaDriverServerInstance<Platform>;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - TODO: fix types
+    this.yoga = yoga;
 
     app.all(yoga.graphqlEndpoint, async (req, reply) => {
       const response = await yoga.handleNodeRequestAndResponse(req, reply, {

packages/plugins/jwt/src/__tests__/jwt.spec.ts

@@ -498,7 +498,7 @@ describe('jwt plugin', () => {
         singingKeyProviders: [createInlineSigningKeyProvider(secret)],
         tokenLookupLocations: [extractFromCookie({ name: 'auth' })],
       },
-      [useCookies()],
+      [useCookies<any>()],
     );
     const token = buildJWT({ sub: '123' }, { key: secret }, '');
     const response = await test.queryWithCookieAuth(token);
@@ -550,7 +550,7 @@ describe('jwt plugin', () => {
           }),
         ],
       },
-      [useCookies()],
+      [useCookies<any>()],
     );
     const token = buildJWT({ sub: '123' }, { key: secret }, '');
 
@@ -571,7 +571,7 @@ describe('jwt plugin', () => {
 const createTestServer = (options: JwtPluginOptions, initPlugins: Plugin[] = []) => {
   const yoga = createYoga({
     schema,
-    logging: console,
+    logging: !!process.env.DEBUG,
     plugins: [...initPlugins, useJWT(options)],
   });