@envelop/response-cache 6.1.0 → 6.1.1-alpha-20231123130839-6a4e30b3

package/README.md

@@ -153,6 +153,60 @@ const getEnveloped = envelop({
 > Note: In the Recipes below, be sure to provide your Redis `cache` instance with
 > `useResponseCache({ cache })`.
 
+### Cloudflare KV Cache
+
+```bash
+yarn add @envelop/response-cache-cloudflare-kv
+```
+
+In order to use the Cloudflare KV cache, you need to:
+
+- Create a Cloudflare KV namespace
+- Add that namespace to your `wrangler.toml` in order to access it from your worker. Read the
+  [KV docs](https://developers.cloudflare.com/kv/get-started/) to get started.
+- Pass the KV namespace to the `createKvCache` function and set to the `useResponseCache` plugin
+  options. See the example below.
+
+The example below demonstrates how to use this with graphql-yoga within a Cloudflare Worker script.
+
+```ts
+import { createSchema, createYoga, YogaInitialContext } from 'graphql-yoga'
+import { useResponseCache } from '@envelop/response-cache'
+import { createKvCache } from '@envelop/response-cache-cloudflare-kv'
+import { resolvers } from './graphql-schema/resolvers.generated'
+import { typeDefs } from './graphql-schema/typeDefs.generated'
+
+export type Env = {
+  GRAPHQL_RESPONSE_CACHE: KVNamespace
+}
+export type GraphQLContext = YogaInitialContext & Env & ExecutionContext
+
+export default {
+  async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
+    const cache = createKvCache({
+      KV: env.GRAPHQL_RESPONSE_CACHE,
+      ctx,
+      keyPrefix: 'graphql' // optional
+    })
+
+    const graphqlServer = createYoga<GraphQLContext>({
+      schema: createSchema({ typeDefs, resolvers }),
+      plugins: [
+        useResponseCache({
+          cache,
+          session: () => null
+        })
+      ]
+    })
+
+    return graphqlServer.fetch(request, env, ctx)
+  }
+}
+```
+
+> Note: In the Recipes below, be sure to provide your Cloudflare KV `cache` instance with
+> `useResponseCache({ cache })`.
+
 ## Recipes
 
 ### Cache with maximum TTL

package/cjs/plugin.js

@@ -40,10 +40,9 @@ function defaultGetDocumentString(executionArgs) {
     return (0, core_1.getDocumentString)(executionArgs.document, graphql_1.print);
 }
 exports.defaultGetDocumentString = defaultGetDocumentString;
-const originalDocumentMap = new WeakMap();
 const addEntityInfosToDocument = (0, utils_1.memoize4)(function addTypeNameToDocument(document, addTypeNameToDocumentOpts, schema, idFieldByTypeName) {
     const typeInfo = new graphql_1.TypeInfo(schema);
-    const newDocument = (0, graphql_1.visit)(document, (0, graphql_1.visitWithTypeInfo)(typeInfo, {
+    return (0, graphql_1.visit)(document, (0, graphql_1.visitWithTypeInfo)(typeInfo, {
         OperationDefinition: {
             enter(node) {
                 if (!addTypeNameToDocumentOpts.invalidateViaMutation && node.operation === 'mutation') {
@@ -85,8 +84,6 @@ const addEntityInfosToDocument = (0, utils_1.memoize4)(function addTypeNameToDoc
             };
         },
     }));
-    originalDocumentMap.set(newDocument, document);
-    return newDocument;
 });
 function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache)(), ttl: globalTtl = Infinity, session, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, scopePerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = exports.defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = exports.defaultShouldCacheResult, includeExtensionMetadata = typeof process !== 'undefined'
     ? // eslint-disable-next-line dot-notation
@@ -94,7 +91,6 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
     : false, }) {
     const ignoredTypesMap = new Set(ignoredTypes);
     const typePerSchemaCoordinateMap = new Map();
-    enabled = enabled ? (0, utils_1.memoize1)(enabled) : enabled;
     // never cache Introspections
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
     const addTypeNameToDocumentOpts = { invalidateViaMutation };
@@ -107,17 +103,6 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
         return Object.keys(data).some(fieldName => scopePerSchemaCoordinate[`${typeName}.${fieldName}`] === 'PRIVATE');
     }
     return {
-        onParse() {
-            return ({ result, replaceParseResult, context }) => {
-                if (enabled && !enabled(context)) {
-                    return;
-                }
-                if (!originalDocumentMap.has(result) && result.kind === graphql_1.Kind.DOCUMENT) {
-                    const newDocument = addEntityInfosToDocument(result, addTypeNameToDocumentOpts, schema, idFieldByTypeName);
-                    replaceParseResult(newDocument);
-                }
-            };
-        },
         onSchemaChange({ schema: newSchema }) {
             if (schema === newSchema) {
                 return;
@@ -226,6 +211,10 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
             if (invalidateViaMutation !== false) {
                 const operationAST = (0, graphql_1.getOperationAST)(onExecuteParams.args.document, onExecuteParams.args.operationName);
                 if (operationAST?.operation === 'mutation') {
+                    onExecuteParams.setExecuteFn(args => onExecuteParams.executeFn({
+                        ...args,
+                        document: addEntityInfosToDocument(args.document, addTypeNameToDocumentOpts, args.schema, idFieldByTypeName),
+                    }));
                     return {
                         onExecuteDone({ result, setResult }) {
                             if ((0, core_1.isAsyncIterable)(result)) {
@@ -245,12 +234,14 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
             });
             const cachedResponse = (await cache.get(cacheKey));
             if (cachedResponse != null) {
-                if (includeExtensionMetadata) {
-                    onExecuteParams.setResultAndStopExecution(resultWithMetadata(cachedResponse, { hit: true }));
-                }
-                else {
-                    onExecuteParams.setResultAndStopExecution(cachedResponse);
-                }
+                onExecuteParams.setExecuteFn(() => {
+                    if (includeExtensionMetadata) {
+                        return resultWithMetadata(cachedResponse, { hit: true });
+                    }
+                    else {
+                        return cachedResponse;
+                    }
+                });
                 return;
             }
             if (ttlPerSchemaCoordinate) {
@@ -283,6 +274,12 @@ function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache
                     setResult(resultWithMetadata(result, { hit: false, didCache: true, ttl: finalTtl }));
                 }
             }
+            onExecuteParams.setExecuteFn(args => {
+                return onExecuteParams.executeFn({
+                    ...args,
+                    document: addEntityInfosToDocument(args.document, addTypeNameToDocumentOpts, args.schema, idFieldByTypeName),
+                });
+            });
             return {
                 onExecuteDone({ result, setResult }) {
                     if ((0, core_1.isAsyncIterable)(result)) {

package/esm/plugin.js

@@ -1,7 +1,7 @@
 import jsonStableStringify from 'fast-json-stable-stringify';
 import { getOperationAST, Kind, print, TypeInfo, visit, visitWithTypeInfo, } from 'graphql';
 import { getDocumentString, isAsyncIterable, } from '@envelop/core';
-import { getDirective, MapperKind, mapSchema, memoize1, memoize4, mergeIncrementalResult, } from '@graphql-tools/utils';
+import { getDirective, MapperKind, mapSchema, memoize4, mergeIncrementalResult, } from '@graphql-tools/utils';
 import { hashSHA256 } from './hash-sha256.js';
 import { createInMemoryCache } from './in-memory-cache.js';
 /**
@@ -33,10 +33,9 @@ export const defaultShouldCacheResult = (params) => {
 export function defaultGetDocumentString(executionArgs) {
     return getDocumentString(executionArgs.document, print);
 }
-const originalDocumentMap = new WeakMap();
 const addEntityInfosToDocument = memoize4(function addTypeNameToDocument(document, addTypeNameToDocumentOpts, schema, idFieldByTypeName) {
     const typeInfo = new TypeInfo(schema);
-    const newDocument = visit(document, visitWithTypeInfo(typeInfo, {
+    return visit(document, visitWithTypeInfo(typeInfo, {
         OperationDefinition: {
             enter(node) {
                 if (!addTypeNameToDocumentOpts.invalidateViaMutation && node.operation === 'mutation') {
@@ -78,8 +77,6 @@ const addEntityInfosToDocument = memoize4(function addTypeNameToDocument(documen
             };
         },
     }));
-    originalDocumentMap.set(newDocument, document);
-    return newDocument;
 });
 export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, scopePerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = defaultShouldCacheResult, includeExtensionMetadata = typeof process !== 'undefined'
     ? // eslint-disable-next-line dot-notation
@@ -87,7 +84,6 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
     : false, }) {
     const ignoredTypesMap = new Set(ignoredTypes);
     const typePerSchemaCoordinateMap = new Map();
-    enabled = enabled ? memoize1(enabled) : enabled;
     // never cache Introspections
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
     const addTypeNameToDocumentOpts = { invalidateViaMutation };
@@ -100,17 +96,6 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
         return Object.keys(data).some(fieldName => scopePerSchemaCoordinate[`${typeName}.${fieldName}`] === 'PRIVATE');
     }
     return {
-        onParse() {
-            return ({ result, replaceParseResult, context }) => {
-                if (enabled && !enabled(context)) {
-                    return;
-                }
-                if (!originalDocumentMap.has(result) && result.kind === Kind.DOCUMENT) {
-                    const newDocument = addEntityInfosToDocument(result, addTypeNameToDocumentOpts, schema, idFieldByTypeName);
-                    replaceParseResult(newDocument);
-                }
-            };
-        },
         onSchemaChange({ schema: newSchema }) {
             if (schema === newSchema) {
                 return;
@@ -219,6 +204,10 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
             if (invalidateViaMutation !== false) {
                 const operationAST = getOperationAST(onExecuteParams.args.document, onExecuteParams.args.operationName);
                 if (operationAST?.operation === 'mutation') {
+                    onExecuteParams.setExecuteFn(args => onExecuteParams.executeFn({
+                        ...args,
+                        document: addEntityInfosToDocument(args.document, addTypeNameToDocumentOpts, args.schema, idFieldByTypeName),
+                    }));
                     return {
                         onExecuteDone({ result, setResult }) {
                             if (isAsyncIterable(result)) {
@@ -238,12 +227,14 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
             });
             const cachedResponse = (await cache.get(cacheKey));
             if (cachedResponse != null) {
-                if (includeExtensionMetadata) {
-                    onExecuteParams.setResultAndStopExecution(resultWithMetadata(cachedResponse, { hit: true }));
-                }
-                else {
-                    onExecuteParams.setResultAndStopExecution(cachedResponse);
-                }
+                onExecuteParams.setExecuteFn(() => {
+                    if (includeExtensionMetadata) {
+                        return resultWithMetadata(cachedResponse, { hit: true });
+                    }
+                    else {
+                        return cachedResponse;
+                    }
+                });
                 return;
             }
             if (ttlPerSchemaCoordinate) {
@@ -276,6 +267,12 @@ export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl
                     setResult(resultWithMetadata(result, { hit: false, didCache: true, ttl: finalTtl }));
                 }
             }
+            onExecuteParams.setExecuteFn(args => {
+                return onExecuteParams.executeFn({
+                    ...args,
+                    document: addEntityInfosToDocument(args.document, addTypeNameToDocumentOpts, args.schema, idFieldByTypeName),
+                });
+            });
             return {
                 onExecuteDone({ result, setResult }) {
                     if (isAsyncIterable(result)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/response-cache",
-  "version": "6.1.0",
+  "version": "6.1.1-alpha-20231123130839-6a4e30b3",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^5.0.0",