chore: upgrade to latest envelop/response-cache

packages/plugins/response-cache/__tests__/response-cache.spec.ts

@@ -0,0 +1,122 @@
+import { createYoga } from 'graphql-yoga'
+import { useResponseCache } from '@graphql-yoga/plugin-response-cache'
+
+it('cache a query operation', async () => {
+  const yoga = createYoga({
+    plugins: [
+      useResponseCache({
+        session: () => null,
+        includeExtensionMetadata: true,
+      }),
+    ],
+  })
+  function fetch() {
+    return yoga.fetch('http://localhost:3000/graphql', {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json',
+      },
+      body: JSON.stringify({ query: '{__typename}' }),
+    })
+  }
+
+  let response = await fetch()
+
+  expect(response.status).toEqual(200)
+  let body = await response.json()
+  expect(body).toEqual({
+    data: {
+      __typename: 'Query',
+    },
+    extensions: {
+      responseCache: {
+        didCache: true,
+        hit: false,
+        ttl: null,
+      },
+    },
+  })
+
+  response = await fetch()
+  expect(response.status).toEqual(200)
+  body = await response.json()
+  expect(body).toEqual({
+    data: {
+      __typename: 'Query',
+    },
+    extensions: {
+      responseCache: {
+        hit: true,
+      },
+    },
+  })
+})
+
+it('cache a query operation per session', async () => {
+  const yoga = createYoga({
+    plugins: [
+      useResponseCache({
+        session: (_, request) => request.headers.get('x-session-id') ?? null,
+        includeExtensionMetadata: true,
+      }),
+    ],
+  })
+  function fetch(sessionId: string) {
+    return yoga.fetch('http://localhost:3000/graphql', {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json',
+        'x-session-id': sessionId,
+      },
+      body: JSON.stringify({ query: '{__typename}' }),
+    })
+  }
+
+  let response = await fetch('1')
+
+  expect(response.status).toEqual(200)
+  let body = await response.json()
+  expect(body).toEqual({
+    data: {
+      __typename: 'Query',
+    },
+    extensions: {
+      responseCache: {
+        didCache: true,
+        hit: false,
+        ttl: null,
+      },
+    },
+  })
+
+  response = await fetch('1')
+  expect(response.status).toEqual(200)
+  body = await response.json()
+  expect(body).toEqual({
+    data: {
+      __typename: 'Query',
+    },
+    extensions: {
+      responseCache: {
+        hit: true,
+      },
+    },
+  })
+
+  response = await fetch('2')
+
+  expect(response.status).toEqual(200)
+  body = await response.json()
+  expect(body).toEqual({
+    data: {
+      __typename: 'Query',
+    },
+    extensions: {
+      responseCache: {
+        didCache: true,
+        hit: false,
+        ttl: null,
+      },
+    },
+  })
+})

packages/plugins/response-cache/package.json

@@ -49,8 +49,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@envelop/response-cache": "2.4.0",
-    "tslib": "^2.3.1"
+    "@envelop/response-cache": "^3.0.0"
   },
   "peerDependencies": {
     "graphql": "^15.2.0 || ^16.0.0",

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

@@ -2,34 +2,34 @@ import {
   BuildResponseCacheKeyFunction,
   createInMemoryCache,
   defaultBuildResponseCacheKey,
-  GetDocumentStringFromContextFunction,
   useResponseCache as useEnvelopResponseCache,
   UseResponseCacheParameter as UseEnvelopResponseCacheParameter,
 } from '@envelop/response-cache'
-import { GraphQLParams, Maybe, Plugin, YogaInitialContext } from 'graphql-yoga'
+import {
+  GraphQLParams,
+  Maybe,
+  Plugin,
+  PromiseOrValue,
+  YogaInitialContext,
+} from 'graphql-yoga'
 
 export type UseResponseCacheParameter = Omit<
   UseEnvelopResponseCacheParameter,
-  'getDocumentStringFromContext' | 'session'
+  'getDocumentString' | 'session'
 > & {
-  session: (params: GraphQLParams, request: Request) => Maybe<string>
+  session: (
+    params: GraphQLParams,
+    request: Request,
+  ) => PromiseOrValue<Maybe<string>>
   enabled?: (params: GraphQLParams, request: Request) => boolean
 }
 
-// Probably this is not used but somehow if Envelop plugin needs that
-const getDocumentStringFromContext: GetDocumentStringFromContextFunction = (
-  context,
-) => context.query as string
-
 const operationIdByRequest = new WeakMap<Request, string>()
 
 // We trick Envelop plugin by passing operationId as sessionId so we can take it from cache key builder we pass to Envelop
 function sessionFactoryForEnvelop({ request }: YogaInitialContext) {
   return operationIdByRequest.get(request)
 }
-const buildResponseCacheKeyForEnvelop: BuildResponseCacheKeyFunction = async ({
-  sessionId,
-}) => sessionId!
 
 export function useResponseCache(options: UseResponseCacheParameter): Plugin {
   const buildResponseCacheKey: BuildResponseCacheKeyFunction =
@@ -42,9 +42,7 @@ export function useResponseCache(options: UseResponseCacheParameter): Plugin {
         useEnvelopResponseCache({
           ...options,
           cache,
-          getDocumentStringFromContext,
           session: sessionFactoryForEnvelop,
-          buildResponseCacheKey: buildResponseCacheKeyForEnvelop,
         }),
       )
     },
@@ -56,7 +54,7 @@ export function useResponseCache(options: UseResponseCacheParameter): Plugin {
               documentString: params.query!,
               variableValues: params.variables,
               operationName: params.operationName,
-              sessionId: options.session(params, request),
+              sessionId: await options.session(params, request),
             })
             const cachedResponse = await cache.get(operationId)
             if (cachedResponse) {

yarn.lock

@@ -2918,10 +2918,10 @@
   dependencies:
     tiny-lru "7.0.6"
 
-"@envelop/response-cache@2.4.0":
-  version "2.4.0"
-  resolved "https://registry.yarnpkg.com/@envelop/response-cache/-/response-cache-2.4.0.tgz#0420afe2bea6bf636e607343e4b517b03ee3fa9c"
-  integrity sha512-flJYReUL+wyZ3x3TYGd6XgO+Em/b9BO+N3Ii915slSsvU7N60Xczo9hG+ewrne4dC4EDJ6NAWcybGvwe6qKd4Q==
+"@envelop/response-cache@^3.0.0":
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/@envelop/response-cache/-/response-cache-3.0.0.tgz#fd53523e00c66bd221c2e1200f6eb00b7529c206"
+  integrity sha512-sGlX5noloUqUG5oVfckbuXTuOaFsYLEqz5zTgrTE47eTE+j+s1mooKecr0fyr3M83DHf/plF0/xilOtHsrJxyQ==
   dependencies:
     "@graphql-tools/utils" "^8.8.0"
     fast-json-stable-stringify "^2.1.0"
@@ -10179,7 +10179,7 @@ esbuild-windows-arm64@0.14.50:
   resolved "https://registry.yarnpkg.com/esbuild-windows-arm64/-/esbuild-windows-arm64-0.14.50.tgz#e7ddde6a97194051a5a4ac05f4f5900e922a7ea5"
   integrity sha512-EMS4lQnsIe12ZyAinOINx7eq2mjpDdhGZZWDwPZE/yUTN9cnc2Ze/xUTYIAyaJqrqQda3LnDpADKpvLvol6ENQ==
 
-esbuild@0.14.47, esbuild@0.14.49, esbuild@0.14.50, esbuild@^0.14.25, esbuild@^0.14.47, esbuild@^0.14.48:
+esbuild@0.14.47, esbuild@0.14.50, esbuild@^0.14.25, esbuild@^0.14.47, esbuild@^0.14.48:
   version "0.14.50"
   resolved "https://registry.yarnpkg.com/esbuild/-/esbuild-0.14.50.tgz#7a665392c8df94bf6e1ae1e999966a5ee62c6cbc"
   integrity sha512-SbC3k35Ih2IC6trhbMYW7hYeGdjPKf9atTKwBUHqMCYFZZ9z8zhuvfnZihsnJypl74FjiAKjBRqFkBkAd0rS/w==