feat: pass context to inParams hook

dotansimha · Nov 7, 2024 · 1246771 · 1246771
1 parent 076d25c
commit 1246771
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 9 deletions.
diff --git a/packages/graphql-yoga/src/plugins/types.ts b/packages/graphql-yoga/src/plugins/types.ts
@@ -55,7 +55,7 @@ export type Plugin<
      * Use this hook with your own risk. It is still experimental and may change in the future.
      * @internal
      */
-    onParams?: OnParamsHook;
+    onParams?: OnParamsHook<TServerContext>;
     /**
      * Use this hook with your own risk. It is still experimental and may change in the future.
      * @internal
@@ -105,14 +105,17 @@ export interface OnRequestParseDoneEventPayload {
   setRequestParserResult: (params: GraphQLParams | GraphQLParams[]) => void;
 }
 
-export type OnParamsHook = (payload: OnParamsEventPayload) => PromiseOrValue<void>;
+export type OnParamsHook<TServerContext> = (
+  payload: OnParamsEventPayload<TServerContext>,
+) => PromiseOrValue<void>;
 
-export interface OnParamsEventPayload {
+export interface OnParamsEventPayload<TServerContext> {
   params: GraphQLParams;
   request: Request;
   setParams: (params: GraphQLParams) => void;
   setResult: (result: ExecutionResult | AsyncIterable<ExecutionResult>) => void;
   fetchAPI: FetchAPI;
+  context: TServerContext;
 }
 
 export type OnResultProcess<TServerContext> = (

diff --git a/packages/graphql-yoga/src/server.ts b/packages/graphql-yoga/src/server.ts
@@ -212,7 +212,7 @@ export class YogaServer<
     Plugin<TUserContext & TServerContext & YogaInitialContext, TServerContext, TUserContext>
   >;
   private onRequestParseHooks: OnRequestParseHook<TServerContext>[];
-  private onParamsHooks: OnParamsHook[];
+  private onParamsHooks: OnParamsHook<TServerContext>[];
   private onExecutionResultHooks: OnExecutionResultHook<TServerContext>[];
   private onResultProcessHooks: OnResultProcess<TServerContext>[];
   private maskedErrorsOpts: YogaMaskedErrorOpts | null;
@@ -471,7 +471,9 @@ export class YogaServer<
     serverContext: TServerContext,
   ) {
     let result: ExecutionResult | AsyncIterable<ExecutionResult> | undefined;
-    let context = serverContext as TServerContext & YogaInitialContext;
+    let context: TServerContext & YogaInitialContext =
+      batched === undefined ? serverContext : Object.create(serverContext);
+
     try {
       for (const onParamsHook of this.onParamsHooks) {
         await onParamsHook({
@@ -484,6 +486,7 @@ export class YogaServer<
             result = newResult;
           },
           fetchAPI: this.fetchAPI,
+          context,
         });
       }
 
@@ -498,10 +501,7 @@ export class YogaServer<
                 params,
               };
 
-        context = Object.assign(
-          batched ? Object.create(serverContext) : serverContext,
-          additionalContext,
-        );
+        context = Object.assign(context, additionalContext);
 
         const enveloped = this.getEnveloped(context);