feat(response-cache): accept serverContext as the 2nd param in enabled and session

.changeset/quiet-moles-nail.md

@@ -0,0 +1,5 @@
+---
+'graphql-yoga': patch
+---
+
+Now `onParams` hook's payload has `serverContext`

.changeset/twenty-birds-sin.md

@@ -0,0 +1,5 @@
+---
+'@graphql-yoga/plugin-response-cache': patch
+---
+
+Now `enabled` and `session` factory functions take a second parameter `ServerContext` that includes the server specific context object. But this object is not the one provided by the user. [Learn more about the difference between the server context and the user context](https://the-guild.dev/graphql/yoga-server/docs/features/context#advanced-context-life-cycle)

examples/bun-yoga-ws/package.json

@@ -10,7 +10,7 @@
     "bun-types": "^1.0.0",
     "graphql": "^16.6.0",
     "graphql-ws": "^5.14.1",
-    "graphql-yoga": "^4.0.5"
+    "graphql-yoga": "5.3.1"
   },
   "devDependencies": {
     "@whatwg-node/fetch": "^0.9.0"

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

@@ -49,7 +49,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
@@ -106,11 +106,14 @@ export interface OnRequestParseDoneEventPayload {
   setRequestParserResult: (params: GraphQLParams | GraphQLParams[]) => void;
 }
 
-export type OnParamsHook = (payload: OnParamsEventPayload) => PromiseOrValue<void>;
+export type OnParamsHook<TServerContext = unknown> = (
+  payload: OnParamsEventPayload<TServerContext>,
+) => PromiseOrValue<void>;
 
-export interface OnParamsEventPayload {
+export interface OnParamsEventPayload<TServerContext = unknown> {
   params: GraphQLParams;
   request: Request;
+  serverContext?: TServerContext;
   setParams: (params: GraphQLParams) => void;
   setResult: (result: ExecutionResult | AsyncIterable<ExecutionResult>) => void;
   fetchAPI: FetchAPI;

packages/graphql-yoga/src/server.ts

@@ -197,7 +197,7 @@ export class YogaServer<
     Plugin<TUserContext & TServerContext & YogaInitialContext, TServerContext>
   >;
   private onRequestParseHooks: OnRequestParseHook<TServerContext>[];
-  private onParamsHooks: OnParamsHook[];
+  private onParamsHooks: OnParamsHook<TServerContext>[];
   private onResultProcessHooks: OnResultProcess[];
   private maskedErrorsOpts: YogaMaskedErrorOpts | null;
   private id: string;
@@ -446,12 +446,14 @@ export class YogaServer<
       : [serverContext: TServerContext]
   ) {
     try {
+      const serverContext = args[0];
       let result: ExecutionResult | AsyncIterable<ExecutionResult> | undefined;
 
       for (const onParamsHook of this.onParamsHooks) {
         await onParamsHook({
           params,
           request,
+          serverContext,
           setParams(newParams) {
             params = newParams;
           },
@@ -464,7 +466,7 @@ export class YogaServer<
 
       if (result == null) {
         const additionalContext =
-          args[0]?.request === request
+          serverContext?.request === request
             ? {
                 params,
               }
@@ -473,8 +475,8 @@ export class YogaServer<
                 params,
               };
 
-        const initialContext = args[0]
-          ? Object.assign(batched ? Object.create(args[0]) : args[0], additionalContext)
+        const initialContext = serverContext
+          ? Object.assign(batched ? Object.create(serverContext) : serverContext, additionalContext)
           : additionalContext;
 
         const enveloped = this.getEnveloped(initialContext);

packages/plugins/response-cache/src/index.ts

@@ -20,13 +20,13 @@ export type BuildResponseCacheKeyFunction = (
   },
 ) => ReturnType<EnvelopBuildResponseCacheKeyFunction>;
 
-export type UseResponseCacheParameter = Omit<
+export type UseResponseCacheParameter<TServerContext> = Omit<
   UseEnvelopResponseCacheParameter,
   'getDocumentString' | 'session' | 'cache' | 'enabled' | 'buildResponseCacheKey'
 > & {
   cache?: Cache;
-  session: (request: Request) => PromiseOrValue<Maybe<string>>;
-  enabled?: (request: Request) => boolean;
+  session: (request: Request, serverContext?: TServerContext) => PromiseOrValue<Maybe<string>>;
+  enabled?: (request: Request, serverContext?: TServerContext) => boolean;
   buildResponseCacheKey?: BuildResponseCacheKeyFunction;
 };
 
@@ -82,7 +82,9 @@ export interface Cache extends EnvelopCache {
   >;
 }
 
-export function useResponseCache(options: UseResponseCacheParameter): Plugin {
+export function useResponseCache<TServerContext extends Record<string, unknown>>(
+  options: UseResponseCacheParameter<TServerContext>,
+): Plugin<TServerContext, TServerContext> {
   const buildResponseCacheKey: BuildResponseCacheKeyFunction =
     options?.buildResponseCacheKey || defaultBuildResponseCacheKey;
   const cache = options.cache ?? createInMemoryCache();
@@ -94,10 +96,10 @@ export function useResponseCache(options: UseResponseCacheParameter): Plugin {
     },
     onPluginInit({ addPlugin }) {
       addPlugin(
-        useEnvelopResponseCache({
+        useEnvelopResponseCache<YogaInitialContext & TServerContext>({
           ...options,
-          enabled({ request }) {
-            return enabled(request);
+          enabled(ctx: YogaInitialContext & TServerContext) {
+            return enabled(ctx.request, ctx);
           },
           cache,
           getDocumentString: getDocumentStringForEnvelop,
@@ -129,8 +131,8 @@ export function useResponseCache(options: UseResponseCacheParameter): Plugin {
         }),
       );
     },
-    async onRequest({ request, fetchAPI, endResponse }) {
-      if (enabled(request)) {
+    async onRequest({ request, serverContext, fetchAPI, endResponse }) {
+      if (enabled(request, serverContext)) {
         const operationId = request.headers.get('If-None-Match');
         if (operationId) {
           const cachedResponse = await cache.get(operationId);
@@ -158,8 +160,8 @@ export function useResponseCache(options: UseResponseCacheParameter): Plugin {
         }
       }
     },
-    async onParams({ params, request, setResult }) {
-      const sessionId = await options.session(request);
+    async onParams({ params, request, serverContext, setResult }) {
+      const sessionId = await options.session(request, serverContext);
       const operationId = await buildResponseCacheKey({
         documentString: params.query || '',
         variableValues: params.variables,
@@ -169,7 +171,7 @@ export function useResponseCache(options: UseResponseCacheParameter): Plugin {
       });
       operationIdByRequest.set(request, operationId);
       sessionByRequest.set(request, sessionId);
-      if (enabled(request)) {
+      if (enabled(request, serverContext)) {
         const cachedResponse = await cache.get(operationId);
         if (cachedResponse) {
           const responseWithSymbol = {