@envelop/response-cache 3.0.0-alpha-d0d0776.0 → 3.0.0-alpha-2869053.0

package/index.js

@@ -2,21 +2,19 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const LRU = require('lru-cache');
+function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
+
+const LRU = _interopDefault(require('lru-cache'));
 const core = require('@envelop/core');
 const utils = require('@graphql-tools/utils');
 const graphql = require('graphql');
-const jsonStableStringify = require('fast-json-stable-stringify');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-const LRU__default = /*#__PURE__*/_interopDefaultLegacy(LRU);
-const jsonStableStringify__default = /*#__PURE__*/_interopDefaultLegacy(jsonStableStringify);
+const jsonStableStringify = _interopDefault(require('fast-json-stable-stringify'));
 
 const createInMemoryCache = (params) => {
-    const buildEntityId = params?.buildEntityId ?? defaultBuildEntityId;
-    const cachedResponses = new LRU__default["default"]({
-        max: params?.max,
+    var _a;
+    const buildEntityId = (_a = params === null || params === void 0 ? void 0 : params.buildEntityId) !== null && _a !== void 0 ? _a : defaultBuildEntityId;
+    const cachedResponses = new LRU({
+        max: params === null || params === void 0 ? void 0 : params.max,
         stale: false,
         noDisposeOnSet: true,
         dispose(responseId) {
@@ -26,12 +24,13 @@ const createInMemoryCache = (params) => {
     const entityToResponseIds = new Map();
     const responseIdToEntityIds = new Map();
     function purgeResponse(responseId, shouldRemove = true) {
+        var _a;
         const entityIds = responseIdToEntityIds.get(responseId);
         // get entities related to the response
         if (entityIds !== undefined) {
             for (const entityId of entityIds) {
                 // remove the response mapping from the entity
-                entityToResponseIds.get(entityId)?.delete(responseId);
+                (_a = entityToResponseIds.get(entityId)) === null || _a === void 0 ? void 0 : _a.delete(responseId);
             }
             // remove all the entity mappings from the response
             responseIdToEntityIds.delete(responseId);
@@ -79,7 +78,8 @@ const createInMemoryCache = (params) => {
             }
         },
         get(responseId) {
-            return cachedResponses.get(responseId) ?? null;
+            var _a;
+            return (_a = cachedResponses.get(responseId)) !== null && _a !== void 0 ? _a : null;
         },
         invalidate(entitiesToRemove) {
             for (const { typename, id } of entitiesToRemove) {
@@ -154,17 +154,19 @@ const hashSHA256 = async (text) => {
 };
 
 const contextSymbol = Symbol('responseCache');
-const rawDocumentStringSymbol = Symbol('rawDocumentString');
 /**
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
  */
-const defaultBuildResponseCacheKey = params => hashSHA256([
-    params.documentString,
-    params.operationName ?? '',
-    jsonStableStringify__default["default"](params.variableValues ?? {}),
-    params.sessionId ?? '',
-].join('|'));
+const defaultBuildResponseCacheKey = params => {
+    var _a, _b, _c;
+    return hashSHA256([
+        params.documentString,
+        (_a = params.operationName) !== null && _a !== void 0 ? _a : '',
+        jsonStableStringify((_b = params.variableValues) !== null && _b !== void 0 ? _b : {}),
+        (_c = params.sessionId) !== null && _c !== void 0 ? _c : '',
+    ].join('|'));
+};
 /**
  * Default function used to check if the result should be cached.
  *
@@ -181,8 +183,16 @@ const defaultShouldCacheResult = (params) => {
     }
     return true;
 };
-const defaultGetDocumentStringFromContext = context => context[rawDocumentStringSymbol];
-function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentStringFromContext = defaultGetDocumentStringFromContext, shouldCacheResult = defaultShouldCacheResult, 
+const documentStringByDocument = new WeakMap();
+function defaultGetDocumentString(executionArgs) {
+    let documentString = documentStringByDocument.get(executionArgs.document);
+    if (!documentString) {
+        documentString = graphql.print(executionArgs.document);
+        documentStringByDocument.set(executionArgs.document, documentString);
+    }
+    return documentString;
+}
+function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = defaultShouldCacheResult, 
 // eslint-disable-next-line dot-notation
 includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, } = {}) {
     const appliedTransform = Symbol('responseCache.appliedTransform');
@@ -191,8 +201,9 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
     return {
         onSchemaChange({ schema, replaceSchema }) {
+            var _a;
             // @ts-expect-error See https://github.com/graphql/graphql-js/pull/3511 - remove this comments once merged
-            if (schema.extensions?.[appliedTransform] === true) {
+            if (((_a = schema.extensions) === null || _a === void 0 ? void 0 : _a[appliedTransform]) === true) {
                 return;
             }
             const patchedSchema = applyResponseCacheLogic(schema, idFields);
@@ -202,18 +213,15 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
             };
             replaceSchema(patchedSchema);
         },
-        onParse(parseCtx) {
-            return function onParseEnd(ctx) {
-                if (ctx.result && 'kind' in ctx.result) {
-                    const source = parseCtx.params.source;
-                    const rawDocumentString = typeof source === 'string' ? source : source.body;
-                    ctx.extendContext({
-                        [rawDocumentStringSymbol]: rawDocumentString,
-                    });
+        onParse({ params: { source } }) {
+            return function onParseEnd({ result }) {
+                if (result != null && !(result instanceof Error)) {
+                    documentStringByDocument.set(result, source.toString());
                 }
             };
         },
         async onExecute(ctx) {
+            var _a;
             const identifier = new Map();
             const types = new Set();
             const context = {
@@ -253,99 +261,97 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                     },
                 };
             }
-            const documentString = getDocumentStringFromContext(ctx.args.contextValue);
-            if (documentString != null) {
-                const operationId = await buildResponseCacheKey({
-                    documentString,
-                    variableValues: ctx.args.variableValues,
-                    operationName: ctx.args.operationName,
-                    sessionId: session(ctx.args.contextValue),
-                });
-                if ((enabled?.(ctx.args.contextValue) ?? true) === true) {
-                    const cachedResponse = await cache.get(operationId);
-                    if (cachedResponse != null) {
-                        if (includeExtensionMetadata) {
-                            ctx.setResultAndStopExecution({
-                                ...cachedResponse,
-                                extensions: {
-                                    responseCache: {
-                                        hit: true,
-                                    },
+            const documentString = getDocumentString(ctx.args);
+            const operationId = await buildResponseCacheKey({
+                documentString,
+                variableValues: ctx.args.variableValues,
+                operationName: ctx.args.operationName,
+                sessionId: session(ctx.args.contextValue),
+            });
+            if (((_a = enabled === null || enabled === void 0 ? void 0 : enabled(ctx.args.contextValue)) !== null && _a !== void 0 ? _a : true) === true) {
+                const cachedResponse = await cache.get(operationId);
+                if (cachedResponse != null) {
+                    if (includeExtensionMetadata) {
+                        ctx.setResultAndStopExecution({
+                            ...cachedResponse,
+                            extensions: {
+                                responseCache: {
+                                    hit: true,
                                 },
-                            });
-                        }
-                        else {
-                            ctx.setResultAndStopExecution(cachedResponse);
-                        }
-                        return;
+                            },
+                        });
                     }
+                    else {
+                        ctx.setResultAndStopExecution(cachedResponse);
+                    }
+                    return;
                 }
-                if (ttlPerSchemaCoordinate) {
-                    const typeInfo = new graphql.TypeInfo(ctx.args.schema);
-                    graphql.visit(ctx.args.document, graphql.visitWithTypeInfo(typeInfo, {
-                        Field(fieldNode) {
-                            const parentType = typeInfo.getParentType();
-                            if (parentType) {
-                                const schemaCoordinate = `${parentType.name}.${fieldNode.name.value}`;
-                                const maybeTtl = ttlPerSchemaCoordinate[schemaCoordinate];
-                                if (maybeTtl !== undefined) {
-                                    context.currentTtl = calculateTtl(maybeTtl, context.currentTtl);
-                                }
-                            }
-                        },
-                    }));
-                }
-                return {
-                    onExecuteDone({ result, setResult }) {
-                        if (core.isAsyncIterable(result)) {
-                            // eslint-disable-next-line no-console
-                            console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
-                            return;
-                        }
-                        if (!shouldCacheResult({ result })) {
-                            return;
-                        }
-                        // we only use the global ttl if no currentTtl has been determined.
-                        const finalTtl = context.currentTtl ?? globalTtl;
-                        if (finalTtl === 0) {
-                            if (includeExtensionMetadata) {
-                                setResult({
-                                    ...result,
-                                    extensions: {
-                                        responseCache: {
-                                            hit: false,
-                                            didCache: false,
-                                        },
-                                    },
-                                });
+            }
+            if (ttlPerSchemaCoordinate) {
+                const typeInfo = new graphql.TypeInfo(ctx.args.schema);
+                graphql.visit(ctx.args.document, graphql.visitWithTypeInfo(typeInfo, {
+                    Field(fieldNode) {
+                        const parentType = typeInfo.getParentType();
+                        if (parentType) {
+                            const schemaCoordinate = `${parentType.name}.${fieldNode.name.value}`;
+                            const maybeTtl = ttlPerSchemaCoordinate[schemaCoordinate];
+                            if (maybeTtl !== undefined) {
+                                context.currentTtl = calculateTtl(maybeTtl, context.currentTtl);
                             }
-                            return;
                         }
-                        cache.set(operationId, result, identifier.values(), finalTtl);
+                    },
+                }));
+            }
+            return {
+                onExecuteDone({ result, setResult }) {
+                    var _a;
+                    if (core.isAsyncIterable(result)) {
+                        // eslint-disable-next-line no-console
+                        console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
+                        return;
+                    }
+                    if (context.skip) {
+                        return;
+                    }
+                    if (!shouldCacheResult({ result })) {
+                        return;
+                    }
+                    // we only use the global ttl if no currentTtl has been determined.
+                    const finalTtl = (_a = context.currentTtl) !== null && _a !== void 0 ? _a : globalTtl;
+                    if (finalTtl === 0) {
                         if (includeExtensionMetadata) {
                             setResult({
                                 ...result,
                                 extensions: {
                                     responseCache: {
                                         hit: false,
-                                        didCache: true,
-                                        ttl: finalTtl,
+                                        didCache: false,
                                     },
                                 },
                             });
                         }
-                    },
-                };
-            }
-            // eslint-disable-next-line no-console
-            console.warn(`[useResponseCache] Failed extracting document string from the context. The response will not be cached or served from the cache. ` +
-                `If you are overriding the 'parse' behavior make sure to pass a custom 'getDocumentStringFromContext' function for getting the document string, which is required for building the response cache key.`);
-            return undefined;
+                        return;
+                    }
+                    cache.set(operationId, result, identifier.values(), finalTtl);
+                    if (includeExtensionMetadata) {
+                        setResult({
+                            ...result,
+                            extensions: {
+                                responseCache: {
+                                    hit: false,
+                                    didCache: true,
+                                    ttl: finalTtl,
+                                },
+                            },
+                        });
+                    }
+                },
+            };
         },
     };
 }
 function isOperationDefinition(node) {
-    return node?.kind === 'OperationDefinition';
+    return (node === null || node === void 0 ? void 0 : node.kind) === 'OperationDefinition';
 }
 function calculateTtl(typeTtl, currentTtl) {
     if (typeof currentTtl === 'number') {
@@ -371,7 +377,8 @@ function applyResponseCacheLogic(schema, idFieldNames) {
                 return {
                     ...fieldConfig,
                     resolve(src, args, context, info) {
-                        const result = (fieldConfig.resolve ?? graphql.defaultFieldResolver)(src, args, context, info);
+                        var _a;
+                        const result = ((_a = fieldConfig.resolve) !== null && _a !== void 0 ? _a : graphql.defaultFieldResolver)(src, args, context, info);
                         runWith(result, (id) => {
                             const ctx = context[contextSymbol];
                             if (ctx !== undefined) {
@@ -403,6 +410,6 @@ function applyResponseCacheLogic(schema, idFieldNames) {
 exports.createInMemoryCache = createInMemoryCache;
 exports.defaultBuildEntityId = defaultBuildEntityId;
 exports.defaultBuildResponseCacheKey = defaultBuildResponseCacheKey;
-exports.defaultGetDocumentStringFromContext = defaultGetDocumentStringFromContext;
+exports.defaultGetDocumentString = defaultGetDocumentString;
 exports.defaultShouldCacheResult = defaultShouldCacheResult;
 exports.useResponseCache = useResponseCache;

package/index.mjs

@@ -1,13 +1,14 @@
 import LRU from 'lru-cache';
 import { isAsyncIterable } from '@envelop/core';
 import { mapSchema, MapperKind } from '@graphql-tools/utils';
-import { defaultFieldResolver, TypeInfo, visit, visitWithTypeInfo } from 'graphql';
+import { print, defaultFieldResolver, TypeInfo, visit, visitWithTypeInfo } from 'graphql';
 import jsonStableStringify from 'fast-json-stable-stringify';
 
 const createInMemoryCache = (params) => {
-    const buildEntityId = params?.buildEntityId ?? defaultBuildEntityId;
+    var _a;
+    const buildEntityId = (_a = params === null || params === void 0 ? void 0 : params.buildEntityId) !== null && _a !== void 0 ? _a : defaultBuildEntityId;
     const cachedResponses = new LRU({
-        max: params?.max,
+        max: params === null || params === void 0 ? void 0 : params.max,
         stale: false,
         noDisposeOnSet: true,
         dispose(responseId) {
@@ -17,12 +18,13 @@ const createInMemoryCache = (params) => {
     const entityToResponseIds = new Map();
     const responseIdToEntityIds = new Map();
     function purgeResponse(responseId, shouldRemove = true) {
+        var _a;
         const entityIds = responseIdToEntityIds.get(responseId);
         // get entities related to the response
         if (entityIds !== undefined) {
             for (const entityId of entityIds) {
                 // remove the response mapping from the entity
-                entityToResponseIds.get(entityId)?.delete(responseId);
+                (_a = entityToResponseIds.get(entityId)) === null || _a === void 0 ? void 0 : _a.delete(responseId);
             }
             // remove all the entity mappings from the response
             responseIdToEntityIds.delete(responseId);
@@ -70,7 +72,8 @@ const createInMemoryCache = (params) => {
             }
         },
         get(responseId) {
-            return cachedResponses.get(responseId) ?? null;
+            var _a;
+            return (_a = cachedResponses.get(responseId)) !== null && _a !== void 0 ? _a : null;
         },
         invalidate(entitiesToRemove) {
             for (const { typename, id } of entitiesToRemove) {
@@ -145,17 +148,19 @@ const hashSHA256 = async (text) => {
 };
 
 const contextSymbol = Symbol('responseCache');
-const rawDocumentStringSymbol = Symbol('rawDocumentString');
 /**
  * Default function used for building the response cache key.
  * It is exported here for advanced use-cases. E.g. if you want to short circuit and serve responses from the cache on a global level in order to completely by-pass the GraphQL flow.
  */
-const defaultBuildResponseCacheKey = params => hashSHA256([
-    params.documentString,
-    params.operationName ?? '',
-    jsonStableStringify(params.variableValues ?? {}),
-    params.sessionId ?? '',
-].join('|'));
+const defaultBuildResponseCacheKey = params => {
+    var _a, _b, _c;
+    return hashSHA256([
+        params.documentString,
+        (_a = params.operationName) !== null && _a !== void 0 ? _a : '',
+        jsonStableStringify((_b = params.variableValues) !== null && _b !== void 0 ? _b : {}),
+        (_c = params.sessionId) !== null && _c !== void 0 ? _c : '',
+    ].join('|'));
+};
 /**
  * Default function used to check if the result should be cached.
  *
@@ -172,8 +177,16 @@ const defaultShouldCacheResult = (params) => {
     }
     return true;
 };
-const defaultGetDocumentStringFromContext = context => context[rawDocumentStringSymbol];
-function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentStringFromContext = defaultGetDocumentStringFromContext, shouldCacheResult = defaultShouldCacheResult, 
+const documentStringByDocument = new WeakMap();
+function defaultGetDocumentString(executionArgs) {
+    let documentString = documentStringByDocument.get(executionArgs.document);
+    if (!documentString) {
+        documentString = print(executionArgs.document);
+        documentStringByDocument.set(executionArgs.document, documentString);
+    }
+    return documentString;
+}
+function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session = () => null, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = defaultShouldCacheResult, 
 // eslint-disable-next-line dot-notation
 includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, } = {}) {
     const appliedTransform = Symbol('responseCache.appliedTransform');
@@ -182,8 +195,9 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
     return {
         onSchemaChange({ schema, replaceSchema }) {
+            var _a;
             // @ts-expect-error See https://github.com/graphql/graphql-js/pull/3511 - remove this comments once merged
-            if (schema.extensions?.[appliedTransform] === true) {
+            if (((_a = schema.extensions) === null || _a === void 0 ? void 0 : _a[appliedTransform]) === true) {
                 return;
             }
             const patchedSchema = applyResponseCacheLogic(schema, idFields);
@@ -193,18 +207,15 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
             };
             replaceSchema(patchedSchema);
         },
-        onParse(parseCtx) {
-            return function onParseEnd(ctx) {
-                if (ctx.result && 'kind' in ctx.result) {
-                    const source = parseCtx.params.source;
-                    const rawDocumentString = typeof source === 'string' ? source : source.body;
-                    ctx.extendContext({
-                        [rawDocumentStringSymbol]: rawDocumentString,
-                    });
+        onParse({ params: { source } }) {
+            return function onParseEnd({ result }) {
+                if (result != null && !(result instanceof Error)) {
+                    documentStringByDocument.set(result, source.toString());
                 }
             };
         },
         async onExecute(ctx) {
+            var _a;
             const identifier = new Map();
             const types = new Set();
             const context = {
@@ -244,99 +255,97 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                     },
                 };
             }
-            const documentString = getDocumentStringFromContext(ctx.args.contextValue);
-            if (documentString != null) {
-                const operationId = await buildResponseCacheKey({
-                    documentString,
-                    variableValues: ctx.args.variableValues,
-                    operationName: ctx.args.operationName,
-                    sessionId: session(ctx.args.contextValue),
-                });
-                if ((enabled?.(ctx.args.contextValue) ?? true) === true) {
-                    const cachedResponse = await cache.get(operationId);
-                    if (cachedResponse != null) {
-                        if (includeExtensionMetadata) {
-                            ctx.setResultAndStopExecution({
-                                ...cachedResponse,
-                                extensions: {
-                                    responseCache: {
-                                        hit: true,
-                                    },
+            const documentString = getDocumentString(ctx.args);
+            const operationId = await buildResponseCacheKey({
+                documentString,
+                variableValues: ctx.args.variableValues,
+                operationName: ctx.args.operationName,
+                sessionId: session(ctx.args.contextValue),
+            });
+            if (((_a = enabled === null || enabled === void 0 ? void 0 : enabled(ctx.args.contextValue)) !== null && _a !== void 0 ? _a : true) === true) {
+                const cachedResponse = await cache.get(operationId);
+                if (cachedResponse != null) {
+                    if (includeExtensionMetadata) {
+                        ctx.setResultAndStopExecution({
+                            ...cachedResponse,
+                            extensions: {
+                                responseCache: {
+                                    hit: true,
                                 },
-                            });
-                        }
-                        else {
-                            ctx.setResultAndStopExecution(cachedResponse);
-                        }
-                        return;
+                            },
+                        });
                     }
+                    else {
+                        ctx.setResultAndStopExecution(cachedResponse);
+                    }
+                    return;
                 }
-                if (ttlPerSchemaCoordinate) {
-                    const typeInfo = new TypeInfo(ctx.args.schema);
-                    visit(ctx.args.document, visitWithTypeInfo(typeInfo, {
-                        Field(fieldNode) {
-                            const parentType = typeInfo.getParentType();
-                            if (parentType) {
-                                const schemaCoordinate = `${parentType.name}.${fieldNode.name.value}`;
-                                const maybeTtl = ttlPerSchemaCoordinate[schemaCoordinate];
-                                if (maybeTtl !== undefined) {
-                                    context.currentTtl = calculateTtl(maybeTtl, context.currentTtl);
-                                }
-                            }
-                        },
-                    }));
-                }
-                return {
-                    onExecuteDone({ result, setResult }) {
-                        if (isAsyncIterable(result)) {
-                            // eslint-disable-next-line no-console
-                            console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
-                            return;
-                        }
-                        if (!shouldCacheResult({ result })) {
-                            return;
-                        }
-                        // we only use the global ttl if no currentTtl has been determined.
-                        const finalTtl = context.currentTtl ?? globalTtl;
-                        if (finalTtl === 0) {
-                            if (includeExtensionMetadata) {
-                                setResult({
-                                    ...result,
-                                    extensions: {
-                                        responseCache: {
-                                            hit: false,
-                                            didCache: false,
-                                        },
-                                    },
-                                });
+            }
+            if (ttlPerSchemaCoordinate) {
+                const typeInfo = new TypeInfo(ctx.args.schema);
+                visit(ctx.args.document, visitWithTypeInfo(typeInfo, {
+                    Field(fieldNode) {
+                        const parentType = typeInfo.getParentType();
+                        if (parentType) {
+                            const schemaCoordinate = `${parentType.name}.${fieldNode.name.value}`;
+                            const maybeTtl = ttlPerSchemaCoordinate[schemaCoordinate];
+                            if (maybeTtl !== undefined) {
+                                context.currentTtl = calculateTtl(maybeTtl, context.currentTtl);
                             }
-                            return;
                         }
-                        cache.set(operationId, result, identifier.values(), finalTtl);
+                    },
+                }));
+            }
+            return {
+                onExecuteDone({ result, setResult }) {
+                    var _a;
+                    if (isAsyncIterable(result)) {
+                        // eslint-disable-next-line no-console
+                        console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
+                        return;
+                    }
+                    if (context.skip) {
+                        return;
+                    }
+                    if (!shouldCacheResult({ result })) {
+                        return;
+                    }
+                    // we only use the global ttl if no currentTtl has been determined.
+                    const finalTtl = (_a = context.currentTtl) !== null && _a !== void 0 ? _a : globalTtl;
+                    if (finalTtl === 0) {
                         if (includeExtensionMetadata) {
                             setResult({
                                 ...result,
                                 extensions: {
                                     responseCache: {
                                         hit: false,
-                                        didCache: true,
-                                        ttl: finalTtl,
+                                        didCache: false,
                                     },
                                 },
                             });
                         }
-                    },
-                };
-            }
-            // eslint-disable-next-line no-console
-            console.warn(`[useResponseCache] Failed extracting document string from the context. The response will not be cached or served from the cache. ` +
-                `If you are overriding the 'parse' behavior make sure to pass a custom 'getDocumentStringFromContext' function for getting the document string, which is required for building the response cache key.`);
-            return undefined;
+                        return;
+                    }
+                    cache.set(operationId, result, identifier.values(), finalTtl);
+                    if (includeExtensionMetadata) {
+                        setResult({
+                            ...result,
+                            extensions: {
+                                responseCache: {
+                                    hit: false,
+                                    didCache: true,
+                                    ttl: finalTtl,
+                                },
+                            },
+                        });
+                    }
+                },
+            };
         },
     };
 }
 function isOperationDefinition(node) {
-    return node?.kind === 'OperationDefinition';
+    return (node === null || node === void 0 ? void 0 : node.kind) === 'OperationDefinition';
 }
 function calculateTtl(typeTtl, currentTtl) {
     if (typeof currentTtl === 'number') {
@@ -362,7 +371,8 @@ function applyResponseCacheLogic(schema, idFieldNames) {
                 return {
                     ...fieldConfig,
                     resolve(src, args, context, info) {
-                        const result = (fieldConfig.resolve ?? defaultFieldResolver)(src, args, context, info);
+                        var _a;
+                        const result = ((_a = fieldConfig.resolve) !== null && _a !== void 0 ? _a : defaultFieldResolver)(src, args, context, info);
                         runWith(result, (id) => {
                             const ctx = context[contextSymbol];
                             if (ctx !== undefined) {
@@ -391,4 +401,4 @@ function applyResponseCacheLogic(schema, idFieldNames) {
     });
 }
 
-export { createInMemoryCache, defaultBuildEntityId, defaultBuildResponseCacheKey, defaultGetDocumentStringFromContext, defaultShouldCacheResult, useResponseCache };
+export { createInMemoryCache, defaultBuildEntityId, defaultBuildResponseCacheKey, defaultGetDocumentString, defaultShouldCacheResult, useResponseCache };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/response-cache",
-  "version": "3.0.0-alpha-d0d0776.0",
+  "version": "3.0.0-alpha-2869053.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "3.0.0-alpha-d0d0776.0",
+    "@envelop/core": "^2.3.3",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
@@ -26,24 +26,12 @@
   },
   "exports": {
     ".": {
-      "require": {
-        "default": "./index.js",
-        "types": "./index.d.ts"
-      },
-      "import": {
-        "default": "./index.mjs",
-        "types": "./index.d.ts"
-      }
+      "require": "./index.js",
+      "import": "./index.mjs"
     },
     "./*": {
-      "require": {
-        "default": "./*.js",
-        "types": "./*.d.ts"
-      },
-      "import": {
-        "default": "./*.mjs",
-        "types": "./*.d.ts"
-      }
+      "require": "./*.js",
+      "import": "./*.mjs"
     },
     "./package.json": "./package.json"
   }

package/plugin.d.ts

@@ -1,4 +1,4 @@
-import { Plugin, Maybe, DefaultContext } from '@envelop/core';
+import { Plugin, Maybe } from '@envelop/core';
 import { ExecutionArgs, ExecutionResult } from 'graphql';
 import type { Cache } from './cache';
 /**
@@ -14,7 +14,7 @@ export declare type BuildResponseCacheKeyFunction = (params: {
     /** optional sessionId for make unique cache keys based on the session.  */
     sessionId?: Maybe<string>;
 }) => Promise<string>;
-export declare type GetDocumentStringFromContextFunction = (params: DefaultContext) => Maybe<string>;
+export declare type GetDocumentStringFunction = (executionArgs: ExecutionArgs) => string;
 export declare type ShouldCacheResultFunction = (params: {
     result: ExecutionResult;
 }) => Boolean;
@@ -72,12 +72,13 @@ export declare type UseResponseCacheParameter<C = any> = {
      */
     buildResponseCacheKey?: BuildResponseCacheKeyFunction;
     /**
-     * Function used for reading the document string that is used for building the response cache key from the context object.
-     * By default, the useResponseCache plugin hooks into onParse and writes the original operation string to the context.
+     * Function used for reading the document string that is used for building the response cache key from the execution arguments.
+     * By default, the useResponseCache plugin hooks into onParse and caches the original operation string in a WeakMap.
      * If you are hard overriding parse you need to set this function, otherwise responses will not be cached or served from the cache.
-     * Defaults to `defaultGetDocumentStringFromContext`
+     * Defaults to `defaultGetDocumentString`
+     *
      */
-    getDocumentStringFromContext?: GetDocumentStringFromContextFunction;
+    getDocumentString?: GetDocumentStringFunction;
     /**
      * Include extension values that provide useful information, such as whether the cache was hit or which resources a mutation invalidated.
      * Defaults to `true` if `process.env["NODE_ENV"]` is set to `"development"`, otherwise `false`.
@@ -104,5 +105,5 @@ export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction
  * By default, results with errors (unexpected, EnvelopError, or GraphQLError) are not cached.
  */
 export declare const defaultShouldCacheResult: ShouldCacheResultFunction;
-export declare const defaultGetDocumentStringFromContext: GetDocumentStringFromContextFunction;
-export declare function useResponseCache({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentStringFromContext, shouldCacheResult, includeExtensionMetadata, }?: UseResponseCacheParameter): Plugin;
+export declare function defaultGetDocumentString(executionArgs: ExecutionArgs): string;
+export declare function useResponseCache({ cache, ttl: globalTtl, session, enabled, ignoredTypes, ttlPerType, ttlPerSchemaCoordinate, idFields, invalidateViaMutation, buildResponseCacheKey, getDocumentString, shouldCacheResult, includeExtensionMetadata, }?: UseResponseCacheParameter): Plugin;