fix wrap fetch

Author: enisdenjo

packages/plugins/prometheus/src/index.ts

@@ -1,12 +1,11 @@
-import { type GatewayPlugin } from '@graphql-hive/gateway-runtime';
+import type { GatewayPlugin, OnFetchHook } from '@graphql-hive/gateway-runtime';
 import type { Logger } from '@graphql-hive/logger';
 import type { OnSubgraphExecuteHook } from '@graphql-mesh/fusion-runtime';
 import type { TransportEntry } from '@graphql-mesh/transport-common';
 import type {
   ImportFn,
   MeshFetchRequestInit,
   MeshPlugin,
-  OnFetchHook,
 } from '@graphql-mesh/types';
 import {
   defaultImportFn,

packages/runtime/src/createGatewayRuntime.ts

@@ -23,11 +23,7 @@ import {
 import { useHmacUpstreamSignature } from '@graphql-mesh/hmac-upstream-signature';
 import useMeshResponseCache from '@graphql-mesh/plugin-response-cache';
 import { TransportContext } from '@graphql-mesh/transport-common';
-import type {
-  KeyValueCache,
-  OnDelegateHook,
-  OnFetchHook,
-} from '@graphql-mesh/types';
+import type { KeyValueCache, OnDelegateHook } from '@graphql-mesh/types';
 import {
   dispose,
   getHeadersObj,
@@ -113,6 +109,7 @@ import type {
   OnCacheDeleteHook,
   OnCacheGetHook,
   OnCacheSetHook,
+  OnFetchHook,
   UnifiedGraphConfig,
 } from './types';
 import {
@@ -156,6 +153,7 @@ export function createGatewayRuntime<
   const onCacheDeleteHooks: OnCacheDeleteHook[] = [];
   const wrappedFetchFn = wrapFetchWithHooks(
     onFetchHooks,
+    log,
     () => instrumentation,
   );
   const wrappedCache: KeyValueCache | undefined = config.cache

packages/runtime/src/plugins/useCustomAgent.ts

@@ -2,8 +2,11 @@
 import type { Agent as HttpAgent } from 'node:http';
 // eslint-disable-next-line import/no-nodejs-modules
 import type { Agent as HttpsAgent } from 'node:https';
-import type { OnFetchHookPayload } from '@graphql-mesh/types';
-import type { GatewayContext, GatewayPlugin } from '../types';
+import type {
+  GatewayContext,
+  GatewayPlugin,
+  OnFetchHookPayload,
+} from '../types';
 
 export type AgentFactory<TContext> = (
   payload: OnFetchHookPayload<

packages/runtime/src/plugins/usePropagateHeaders.ts

@@ -1,7 +1,6 @@
 import { subgraphNameByExecutionRequest } from '@graphql-mesh/fusion-runtime';
-import type { OnFetchHookDone } from '@graphql-mesh/types';
 import { handleMaybePromise } from '@whatwg-node/promise-helpers';
-import type { GatewayPlugin } from '../types';
+import type { GatewayPlugin, OnFetchHookDone } from '../types';
 
 interface FromClientToSubgraphsPayload {
   request: Request;

packages/runtime/src/types.ts

@@ -13,11 +13,12 @@ import type { ResponseCacheConfig } from '@graphql-mesh/plugin-response-cache';
 import type {
   KeyValueCache,
   MeshFetch,
-  OnFetchHook,
+  MeshFetchRequestInit,
 } from '@graphql-mesh/types';
 import type { FetchInstrumentation } from '@graphql-mesh/utils';
 import type { HTTPExecutorOptions } from '@graphql-tools/executor-http';
 import type {
+  ExecutionRequest,
   IResolvers,
   MaybePromise,
   TypeSource,
@@ -35,6 +36,7 @@ import type {
   Plugin as YogaPlugin,
   YogaServerOptions,
 } from 'graphql-yoga';
+import { GraphQLResolveInfo } from 'graphql/type';
 import type { UnifiedGraphConfig } from './handleUnifiedGraphConfig';
 import type { UseContentEncodingOpts } from './plugins/useContentEncoding';
 import type { AgentFactory } from './plugins/useCustomAgent';
@@ -96,7 +98,7 @@ export type GatewayPlugin<
   TContext extends Record<string, any> = Record<string, any>,
 > = YogaPlugin<Partial<TPluginContext> & GatewayContext & TContext> &
   UnifiedGraphPlugin<Partial<TPluginContext> & GatewayContext & TContext> & {
-    onFetch?: OnFetchHook<Partial<TPluginContext> & GatewayContext & TContext>;
+    onFetch?: OnFetchHook<Partial<TPluginContext> & TContext>;
     onCacheGet?: OnCacheGetHook;
     onCacheSet?: OnCacheSetHook;
     onCacheDelete?: OnCacheDeleteHook;
@@ -112,6 +114,38 @@ export type GatewayPlugin<
     >;
   };
 
+export interface OnFetchHookPayload<TContext> {
+  url: string;
+  setURL(url: URL | string): void;
+  options: MeshFetchRequestInit;
+  setOptions(options: MeshFetchRequestInit): void;
+  /**
+   * The context is not available in cases where "fetch" is done in
+   * order to pull a supergraph or do some internal work.
+   *
+   * The logger will be available in all cases.
+   */
+  context: (GatewayContext & TContext) | { log: Logger };
+  info: GraphQLResolveInfo;
+  fetchFn: MeshFetch;
+  setFetchFn: (fetchFn: MeshFetch) => void;
+  executionRequest?: ExecutionRequest;
+  endResponse: (response$: MaybePromise<Response>) => void;
+}
+
+export interface OnFetchHookDonePayload {
+  response: Response;
+  setResponse: (response: Response) => void;
+}
+
+export type OnFetchHookDone = (
+  payload: OnFetchHookDonePayload,
+) => MaybePromise<void>;
+
+export type OnFetchHook<TContext> = (
+  payload: OnFetchHookPayload<TContext>,
+) => MaybePromise<void | OnFetchHookDone>;
+
 export type OnCacheGetHook = (
   payload: OnCacheGetHookEventPayload,
 ) => MaybePromise<OnCacheGetHookResult | void>;

packages/runtime/src/wrapFetchWithHooks.ts

@@ -1,11 +1,9 @@
 import { getInstrumented } from '@envelop/instrumentation';
-import type {
-  MeshFetch,
-  OnFetchHook,
-  OnFetchHookDone,
-} from '@graphql-mesh/types';
-import { type ExecutionRequest, type MaybePromise } from '@graphql-tools/utils';
+import type { Logger } from '@graphql-hive/logger';
+import type { MeshFetch } from '@graphql-mesh/types';
+import type { ExecutionRequest, MaybePromise } from '@graphql-tools/utils';
 import { handleMaybePromise, iterateAsync } from '@whatwg-node/promise-helpers';
+import { OnFetchHook, OnFetchHookDone } from './types';
 
 export type FetchInstrumentation = {
   fetch?: (
@@ -15,7 +13,8 @@ export type FetchInstrumentation = {
 };
 
 export function wrapFetchWithHooks<TContext>(
-  // onFetchHooks: OnFetchHook<TContext>[], TODO: move over onfetchhook types with new signature
+  onFetchHooks: OnFetchHook<TContext>[],
+  log: Logger,
   instrumentation?: () => FetchInstrumentation | undefined,
 ): MeshFetch {
   let wrappedFetchFn = function wrappedFetchFn(url, options, context, info) {
@@ -41,7 +40,7 @@ export function wrapFetchWithHooks<TContext>(
               setOptions(newOptions) {
                 options = newOptions;
               },
-              context,
+              context: { log, ...context },
               // @ts-expect-error TODO: why?
               info,
               get executionRequest() {

packages/runtime/tests/contentEncoding.test.ts

@@ -1,5 +1,4 @@
 import { getUnifiedGraphGracefully } from '@graphql-mesh/fusion-composition';
-import type { OnFetchHookDonePayload } from '@graphql-mesh/types';
 import { getSupportedEncodings, useContentEncoding } from '@whatwg-node/server';
 import {
   createSchema,
@@ -8,7 +7,11 @@ import {
   type YogaInitialContext,
 } from 'graphql-yoga';
 import { afterEach, describe, expect, it, vi } from 'vitest';
-import { createGatewayRuntime, useCustomFetch } from '../src/index';
+import {
+  createGatewayRuntime,
+  OnFetchHookDonePayload,
+  useCustomFetch,
+} from '../src/index';
 
 describe('contentEncoding', () => {
   const fooResolver = vi.fn((_, __, _context: YogaInitialContext) => {

yarn.lock

@@ -3934,6 +3934,7 @@ __metadata:
     "@envelop/core": "npm:^5.2.3"
     "@envelop/disable-introspection": "npm:^7.0.0"
     "@envelop/generic-auth": "npm:^9.0.0"
+    "@envelop/instrumentation": "npm:^1.0.0"
     "@graphql-hive/core": "npm:^0.10.0"
     "@graphql-hive/logger": "workspace:^"
     "@graphql-hive/logger-json": "workspace:^"