@envelop/response-cache 4.0.8 → 4.0.9-alpha-20230505095813-2dc6c6f3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Dotan Simha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,11 +4,14 @@
 - Customize cache entry time to live based on fields and types within the execution result.
 - Automatically invalidate the cache based on mutation selection sets.
 - Customize invalidation through the cache api (e.g. listen to a database write log).
-- Implement your own global cache (e.g. using another key/value store) by implementing the `Cache` interface.
+- Implement your own global cache (e.g. using another key/value store) by implementing the `Cache`
+  interface.
 
 [Check out the GraphQL Response Cache Guide for more information](https://envelop.dev/docs/guides/adding-a-graphql-response-cache)
 
-> Watch [Episode #34 of `graphql.wtf`](https://graphql.wtf/episodes/34-response-cache-plugin-with-envelop) for a quick introduction to using Response Cache plugin with Envelop:
+> Watch
+> [Episode #34 of `graphql.wtf`](https://graphql.wtf/episodes/34-response-cache-plugin-with-envelop)
+> for a quick introduction to using Response Cache plugin with Envelop:
 
 <iframe
   width="100%"
@@ -38,7 +41,7 @@ When configuring the `useResponseCache`, you can choose the type of cache:
 The in-memory LRU cache is used by default.
 
 ```ts
-import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
+import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
 import { envelop, useEngine } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -57,9 +60,9 @@ const getEnveloped = envelop({
 Or, you may create the in-memory LRU cache explicitly.
 
 ```ts
-import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
+import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
 import { envelop, useEngine } from '@envelop/core'
-import { useResponseCache, createInMemoryCache } from '@envelop/response-cache'
+import { createInMemoryCache, useResponseCache } from '@envelop/response-cache'
 
 const cache = createInMemoryCache()
 
@@ -75,12 +78,13 @@ const getEnveloped = envelop({
 })
 ```
 
-> Note: The in-memory LRU cache is not suitable for serverless deployments. Instead, consider the Redis cache provided by `@envelop/response-cache-redis`.
+> Note: The in-memory LRU cache is not suitable for serverless deployments. Instead, consider the
+> Redis cache provided by `@envelop/response-cache-redis`.
 
 ### Cache based on session/user
 
 ```ts
-import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
+import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
 import { envelop, useEngine } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -106,8 +110,11 @@ yarn add @envelop/response-cache-redis
 In order to use the Redis cache, you need to:
 
 - Create a Redis database
-- Collect the connection settings (or its connection string), e.g., `host`, `port`, `username`, `password`, `tls`, etc.
-- Create and configure a [Redis client](https://github.com/luin/ioredis) with your [connection settings](https://github.com/luin/ioredis/blob/master/API.md#Redis) and any [additional options](https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new)
+- Collect the connection settings (or its connection string), e.g., `host`, `port`, `username`,
+  `password`, `tls`, etc.
+- Create and configure a [Redis client](https://github.com/luin/ioredis) with your
+  [connection settings](https://github.com/luin/ioredis/blob/master/API.md#Redis) and any
+  [additional options](https://github.com/luin/ioredis/blob/master/API.md#new_Redis_new)
 - Create an instance of the Redis Cache and set to the `useResponseCache` plugin options
 
 ```ts
@@ -143,14 +150,15 @@ const getEnveloped = envelop({
 })
 ```
 
-> Note: In the Recipes below, be sure to provide your Redis `cache` instance with `useResponseCache({ cache })`.
+> Note: In the Recipes below, be sure to provide your Redis `cache` instance with
+> `useResponseCache({ cache })`.
 
 ## Recipes
 
 ### Cache with maximum TTL
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -169,12 +177,13 @@ const getEnveloped = envelop({
 })
 ```
 
-> Note: Setting `ttl: 0` will disable TTL for all types. You can use that if you wish to disable caching for all type, and then enable caching for specific types using `ttlPerType`.
+> Note: Setting `ttl: 0` will disable TTL for all types. You can use that if you wish to disable
+> caching for all type, and then enable caching for specific types using `ttlPerType`.
 
 ### Cache with custom TTL per object type
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -199,7 +208,7 @@ const getEnveloped = envelop({
 ### Cache with custom TTL per schema coordinate
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -224,7 +233,7 @@ const getEnveloped = envelop({
 ### Disable cache based on session/user
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -247,21 +256,22 @@ const getEnveloped = envelop({
 
 ### Customize if result should be cached
 
-You can define a custom function used to check if a query operation execution result should be cached.
+You can define a custom function used to check if a query operation execution result should be
+cached.
 
 ```ts
 type ShouldCacheResultFunction = (params: { result: ExecutionResult }) => boolean
 ```
 
-This is useful for advanced use-cases. E.g. if you want to
-cache results with certain error types.
+This is useful for advanced use-cases. E.g. if you want to cache results with certain error types.
 
-By default, the `defaultShouldCacheResult` function is used which never caches any query operation execution results that includes any errors (unexpected, EnvelopError, or GraphQLError).
+By default, the `defaultShouldCacheResult` function is used which never caches any query operation
+execution results that includes any errors (unexpected, EnvelopError, or GraphQLError).
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
-import { useResponseCache, ShouldCacheResultFunction } from '@envelop/response-cache'
+import { ShouldCacheResultFunction, useResponseCache } from '@envelop/response-cache'
 
 export const defaultShouldCacheResult: ShouldCacheResultFunction = (params): Boolean => {
   // cache any query operation execution result
@@ -286,12 +296,13 @@ const getEnveloped = envelop({
 
 ### Cache Introspection query operations
 
-By default introspection query operations are not cached. In case you want to cache them you can do so with the `ttlPerSchemaCoordinate` parameter.
+By default introspection query operations are not cached. In case you want to cache them you can do
+so with the `ttlPerSchemaCoordinate` parameter.
 
 **Infinite caching**
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -315,7 +326,7 @@ const getEnveloped = envelop({
 **TTL caching**
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -339,7 +350,7 @@ const getEnveloped = envelop({
 ### Cache with maximum TTL
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -361,7 +372,7 @@ const getEnveloped = envelop({
 ### Customize the fields that are used for building the cache ID
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -385,7 +396,7 @@ const getEnveloped = envelop({
 ### Disable automatic cache invalidation via mutations
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 import { useResponseCache } from '@envelop/response-cache'
 
@@ -409,9 +420,9 @@ const getEnveloped = envelop({
 ### Invalidate Cache based on custom logic
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
-import { useResponseCache, createInMemoryCache } from '@envelop/response-cache'
+import { createInMemoryCache, useResponseCache } from '@envelop/response-cache'
 import { emitter } from './eventEmitter'
 
 // we create our cache instance, which allows calling all methods on it
@@ -446,9 +457,9 @@ emitter.on('invalidate', resource => {
 ### Customize how cache ids are built
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
-import { useResponseCache, createInMemoryCache } from '@envelop/response-cache'
+import { createInMemoryCache, useResponseCache } from '@envelop/response-cache'
 import { emitter } from './eventEmitter'
 
 // we create our cache instance, which allows calling all methods on it
@@ -476,10 +487,11 @@ const getEnveloped = envelop({
 
 ### Expose cache metadata via extensions
 
-For debugging or monitoring it might be useful to know whether a response got served from the cache or not.
+For debugging or monitoring it might be useful to know whether a response got served from the cache
+or not.
 
 ```ts
-import { parse, validate, execute, subscribe } from 'graphql'
+import { execute, parse, subscribe, validate } from 'graphql'
 import { envelop } from '@envelop/core'
 
 const getEnveloped = envelop({
@@ -498,10 +510,12 @@ const getEnveloped = envelop({
 })
 ```
 
-This option will attach the following fields to the execution result if set to true (or `process.env["NODE_ENV"]` is `"development"`).
+This option will attach the following fields to the execution result if set to true (or
+`process.env["NODE_ENV"]` is `"development"`).
 
 - `extension.responseCache.hit` - Whether the result was served form the cache or not
-- `extension.responseCache.invalidatedEntities` - Entities that got invalidated by a mutation operation
+- `extension.responseCache.invalidatedEntities` - Entities that got invalidated by a mutation
+  operation
 
 #### Examples:
 

package/cjs/cache.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/plugin.js

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useResponseCache = exports.defaultShouldCacheResult = exports.defaultBuildResponseCacheKey = void 0;
+exports.useResponseCache = exports.defaultGetDocumentString = exports.defaultShouldCacheResult = exports.defaultBuildResponseCacheKey = void 0;
 const tslib_1 = require("tslib");
+const fast_json_stable_stringify_1 = tslib_1.__importDefault(require("fast-json-stable-stringify"));
+const graphql_1 = require("graphql");
 const core_1 = require("@envelop/core");
 const utils_1 = require("@graphql-tools/utils");
-const graphql_1 = require("graphql");
-const fast_json_stable_stringify_1 = tslib_1.__importDefault(require("fast-json-stable-stringify"));
-const in_memory_cache_js_1 = require("./in-memory-cache.js");
 const hash_sha256_js_1 = require("./hash-sha256.js");
-const cache_document_str_js_1 = require("./cache-document-str.js");
+const in_memory_cache_js_1 = require("./in-memory-cache.js");
 /**
  * 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.
@@ -37,55 +36,63 @@ const defaultShouldCacheResult = (params) => {
     return true;
 };
 exports.defaultShouldCacheResult = defaultShouldCacheResult;
-function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache)(), ttl: globalTtl = Infinity, session, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = exports.defaultBuildResponseCacheKey, getDocumentString = cache_document_str_js_1.defaultGetDocumentString, shouldCacheResult = exports.defaultShouldCacheResult, 
-// eslint-disable-next-line dot-notation
-includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, }) {
+function defaultGetDocumentString(executionArgs) {
+    return (0, core_1.getDocumentString)(executionArgs.document, graphql_1.print);
+}
+exports.defaultGetDocumentString = defaultGetDocumentString;
+const originalDocumentMap = new WeakMap();
+const addTypeNameToDocument = (0, utils_1.memoize1)(function addTypeNameToDocument(document) {
+    let documentChanged = false;
+    const newDocument = (0, graphql_1.visit)(document, {
+        SelectionSet(node) {
+            if (!node.selections.some(selection => selection.kind === graphql_1.Kind.FIELD && selection.name.value === '__typename')) {
+                documentChanged = true;
+                return {
+                    ...node,
+                    selections: [
+                        {
+                            kind: graphql_1.Kind.FIELD,
+                            name: {
+                                kind: graphql_1.Kind.NAME,
+                                value: '__typename',
+                            },
+                        },
+                        ...node.selections,
+                    ],
+                };
+            }
+            return node;
+        },
+    });
+    if (documentChanged) {
+        originalDocumentMap.set(newDocument, document);
+    }
+    return newDocument;
+});
+function useResponseCache({ cache = (0, in_memory_cache_js_1.createInMemoryCache)(), ttl: globalTtl = Infinity, session, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = exports.defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = exports.defaultShouldCacheResult, includeExtensionMetadata = typeof process !== 'undefined'
+    ? // eslint-disable-next-line dot-notation
+        process.env['NODE_ENV'] === 'development'
+    : false, }) {
     const ignoredTypesMap = new Set(ignoredTypes);
     // never cache Introspections
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
     return {
-        onPluginInit({ addPlugin }) {
-            if (getDocumentString === cache_document_str_js_1.defaultGetDocumentString) {
-                addPlugin((0, cache_document_str_js_1.useCacheDocumentString)());
-            }
+        onParse() {
+            return ({ result, replaceParseResult }) => {
+                if (result.kind === graphql_1.Kind.DOCUMENT) {
+                    const newDocument = addTypeNameToDocument(result);
+                    replaceParseResult(newDocument);
+                }
+            };
         },
         async onExecute(onExecuteParams) {
-            let documentChanged = false;
-            const newDocument = (0, graphql_1.visit)(onExecuteParams.args.document, {
-                SelectionSet(node) {
-                    if (!node.selections.some(selection => selection.kind === graphql_1.Kind.FIELD && selection.name.value === '__typename')) {
-                        documentChanged = true;
-                        return {
-                            ...node,
-                            selections: [
-                                {
-                                    kind: graphql_1.Kind.FIELD,
-                                    name: {
-                                        kind: graphql_1.Kind.NAME,
-                                        value: '__typename',
-                                    },
-                                },
-                                ...node.selections,
-                            ],
-                        };
-                    }
-                    return node;
-                },
-            });
-            if (documentChanged) {
-                onExecuteParams.setExecuteFn(function typeNameAddedExecute() {
-                    return onExecuteParams.executeFn({
-                        ...onExecuteParams.args,
-                        document: newDocument,
-                    });
-                });
-            }
             const identifier = new Map();
             const types = new Set();
             let currentTtl;
             let skip = false;
             const processResult = (result) => (0, utils_1.visitResult)(result, {
-                document: onExecuteParams.args.document,
+                document: originalDocumentMap.get(onExecuteParams.args.document) ??
+                    onExecuteParams.args.document,
                 variables: onExecuteParams.args.variableValues,
                 operationName: onExecuteParams.args.operationName ?? undefined,
                 rootValue: onExecuteParams.args.rootValue,
@@ -100,25 +107,23 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                             return val;
                         },
                         get(_, fieldName) {
-                            if (documentChanged) {
-                                if (fieldName === '__typename') {
-                                    typenameCalled++;
-                                }
-                                if (fieldName === '__leave' &&
-                                    /**
-                                     * The visitResult function is called for each field in the selection set.
-                                     * But visitResult function looks for __typename field visitor even if it is not there in the document
-                                     * So it calls __typename field visitor twice if it is also in the selection set.
-                                     * That's why we need to count the number of times it is called.
-                                     *
-                                     * Default call of __typename https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L277
-                                     * Call for the field node https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L272
-                                     */ typenameCalled < 2) {
-                                    return (root) => {
-                                        delete root.__typename;
-                                        return root;
-                                    };
-                                }
+                            if (fieldName === '__typename') {
+                                typenameCalled++;
+                            }
+                            if (fieldName === '__leave' &&
+                                /**
+                                 * The visitResult function is called for each field in the selection set.
+                                 * But visitResult function looks for __typename field visitor even if it is not there in the document
+                                 * So it calls __typename field visitor twice if it is also in the selection set.
+                                 * That's why we need to count the number of times it is called.
+                                 *
+                                 * Default call of __typename https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L277
+                                 * Call for the field node https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L272
+                                 */ typenameCalled < 2) {
+                                return (root) => {
+                                    delete root.__typename;
+                                    return root;
+                                };
                             }
                             if (ignoredTypesMap.has(typename)) {
                                 skip = true;
@@ -141,31 +146,33 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                     });
                 },
             }));
-            const operationAST = (0, graphql_1.getOperationAST)(onExecuteParams.args.document, onExecuteParams.args.operationName);
-            if (invalidateViaMutation !== false && operationAST?.operation === 'mutation') {
-                return {
-                    onExecuteDone({ result, setResult }) {
-                        if ((0, core_1.isAsyncIterable)(result)) {
-                            // eslint-disable-next-line no-console
-                            console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
-                            return;
-                        }
-                        const processedResult = processResult(result);
-                        cache.invalidate(identifier.values());
-                        if (includeExtensionMetadata) {
-                            setResult({
-                                ...processedResult,
-                                extensions: {
-                                    ...processedResult.extensions,
-                                    responseCache: {
-                                        ...processedResult.extensions?.responseCache,
-                                        invalidatedEntities: Array.from(identifier.values()),
+            if (invalidateViaMutation !== false) {
+                const operationAST = (0, graphql_1.getOperationAST)(onExecuteParams.args.document, onExecuteParams.args.operationName);
+                if (operationAST?.operation === 'mutation') {
+                    return {
+                        onExecuteDone({ result, setResult }) {
+                            if ((0, core_1.isAsyncIterable)(result)) {
+                                // eslint-disable-next-line no-console
+                                console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
+                                return;
+                            }
+                            const processedResult = processResult(result);
+                            cache.invalidate(identifier.values());
+                            if (includeExtensionMetadata) {
+                                setResult({
+                                    ...processedResult,
+                                    extensions: {
+                                        ...processedResult.extensions,
+                                        responseCache: {
+                                            ...processedResult.extensions?.responseCache,
+                                            invalidatedEntities: Array.from(identifier.values()),
+                                        },
                                     },
-                                },
-                            });
-                        }
-                    },
-                };
+                                });
+                            }
+                        },
+                    };
+                }
             }
             const cacheKey = await buildResponseCacheKey({
                 documentString: getDocumentString(onExecuteParams.args),

package/esm/cache.js

@@ -1 +0,0 @@
-export {};

package/esm/plugin.js

@@ -1,10 +1,9 @@
-import { isAsyncIterable } from '@envelop/core';
-import { visitResult } from '@graphql-tools/utils';
-import { visit, TypeInfo, visitWithTypeInfo, getOperationAST, Kind } from 'graphql';
 import jsonStableStringify from 'fast-json-stable-stringify';
-import { createInMemoryCache } from './in-memory-cache.js';
+import { getOperationAST, Kind, print, TypeInfo, visit, visitWithTypeInfo, } from 'graphql';
+import { getDocumentString, isAsyncIterable, } from '@envelop/core';
+import { memoize1, visitResult } from '@graphql-tools/utils';
 import { hashSHA256 } from './hash-sha256.js';
-import { defaultGetDocumentString, useCacheDocumentString } from './cache-document-str.js';
+import { createInMemoryCache } from './in-memory-cache.js';
 /**
  * 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.
@@ -31,55 +30,62 @@ export const defaultShouldCacheResult = (params) => {
     }
     return true;
 };
-export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session, 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, }) {
+export function defaultGetDocumentString(executionArgs) {
+    return getDocumentString(executionArgs.document, print);
+}
+const originalDocumentMap = new WeakMap();
+const addTypeNameToDocument = memoize1(function addTypeNameToDocument(document) {
+    let documentChanged = false;
+    const newDocument = visit(document, {
+        SelectionSet(node) {
+            if (!node.selections.some(selection => selection.kind === Kind.FIELD && selection.name.value === '__typename')) {
+                documentChanged = true;
+                return {
+                    ...node,
+                    selections: [
+                        {
+                            kind: Kind.FIELD,
+                            name: {
+                                kind: Kind.NAME,
+                                value: '__typename',
+                            },
+                        },
+                        ...node.selections,
+                    ],
+                };
+            }
+            return node;
+        },
+    });
+    if (documentChanged) {
+        originalDocumentMap.set(newDocument, document);
+    }
+    return newDocument;
+});
+export function useResponseCache({ cache = createInMemoryCache(), ttl: globalTtl = Infinity, session, enabled, ignoredTypes = [], ttlPerType = {}, ttlPerSchemaCoordinate = {}, idFields = ['id'], invalidateViaMutation = true, buildResponseCacheKey = defaultBuildResponseCacheKey, getDocumentString = defaultGetDocumentString, shouldCacheResult = defaultShouldCacheResult, includeExtensionMetadata = typeof process !== 'undefined'
+    ? // eslint-disable-next-line dot-notation
+        process.env['NODE_ENV'] === 'development'
+    : false, }) {
     const ignoredTypesMap = new Set(ignoredTypes);
     // never cache Introspections
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
     return {
-        onPluginInit({ addPlugin }) {
-            if (getDocumentString === defaultGetDocumentString) {
-                addPlugin(useCacheDocumentString());
-            }
+        onParse() {
+            return ({ result, replaceParseResult }) => {
+                if (result.kind === Kind.DOCUMENT) {
+                    const newDocument = addTypeNameToDocument(result);
+                    replaceParseResult(newDocument);
+                }
+            };
         },
         async onExecute(onExecuteParams) {
-            let documentChanged = false;
-            const newDocument = visit(onExecuteParams.args.document, {
-                SelectionSet(node) {
-                    if (!node.selections.some(selection => selection.kind === Kind.FIELD && selection.name.value === '__typename')) {
-                        documentChanged = true;
-                        return {
-                            ...node,
-                            selections: [
-                                {
-                                    kind: Kind.FIELD,
-                                    name: {
-                                        kind: Kind.NAME,
-                                        value: '__typename',
-                                    },
-                                },
-                                ...node.selections,
-                            ],
-                        };
-                    }
-                    return node;
-                },
-            });
-            if (documentChanged) {
-                onExecuteParams.setExecuteFn(function typeNameAddedExecute() {
-                    return onExecuteParams.executeFn({
-                        ...onExecuteParams.args,
-                        document: newDocument,
-                    });
-                });
-            }
             const identifier = new Map();
             const types = new Set();
             let currentTtl;
             let skip = false;
             const processResult = (result) => visitResult(result, {
-                document: onExecuteParams.args.document,
+                document: originalDocumentMap.get(onExecuteParams.args.document) ??
+                    onExecuteParams.args.document,
                 variables: onExecuteParams.args.variableValues,
                 operationName: onExecuteParams.args.operationName ?? undefined,
                 rootValue: onExecuteParams.args.rootValue,
@@ -94,25 +100,23 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                             return val;
                         },
                         get(_, fieldName) {
-                            if (documentChanged) {
-                                if (fieldName === '__typename') {
-                                    typenameCalled++;
-                                }
-                                if (fieldName === '__leave' &&
-                                    /**
-                                     * The visitResult function is called for each field in the selection set.
-                                     * But visitResult function looks for __typename field visitor even if it is not there in the document
-                                     * So it calls __typename field visitor twice if it is also in the selection set.
-                                     * That's why we need to count the number of times it is called.
-                                     *
-                                     * Default call of __typename https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L277
-                                     * Call for the field node https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L272
-                                     */ typenameCalled < 2) {
-                                    return (root) => {
-                                        delete root.__typename;
-                                        return root;
-                                    };
-                                }
+                            if (fieldName === '__typename') {
+                                typenameCalled++;
+                            }
+                            if (fieldName === '__leave' &&
+                                /**
+                                 * The visitResult function is called for each field in the selection set.
+                                 * But visitResult function looks for __typename field visitor even if it is not there in the document
+                                 * So it calls __typename field visitor twice if it is also in the selection set.
+                                 * That's why we need to count the number of times it is called.
+                                 *
+                                 * Default call of __typename https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L277
+                                 * Call for the field node https://github.com/ardatan/graphql-tools/blob/master/packages/utils/src/visitResult.ts#L272
+                                 */ typenameCalled < 2) {
+                                return (root) => {
+                                    delete root.__typename;
+                                    return root;
+                                };
                             }
                             if (ignoredTypesMap.has(typename)) {
                                 skip = true;
@@ -135,31 +139,33 @@ includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_EN
                     });
                 },
             }));
-            const operationAST = getOperationAST(onExecuteParams.args.document, onExecuteParams.args.operationName);
-            if (invalidateViaMutation !== false && operationAST?.operation === 'mutation') {
-                return {
-                    onExecuteDone({ result, setResult }) {
-                        if (isAsyncIterable(result)) {
-                            // eslint-disable-next-line no-console
-                            console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
-                            return;
-                        }
-                        const processedResult = processResult(result);
-                        cache.invalidate(identifier.values());
-                        if (includeExtensionMetadata) {
-                            setResult({
-                                ...processedResult,
-                                extensions: {
-                                    ...processedResult.extensions,
-                                    responseCache: {
-                                        ...processedResult.extensions?.responseCache,
-                                        invalidatedEntities: Array.from(identifier.values()),
+            if (invalidateViaMutation !== false) {
+                const operationAST = getOperationAST(onExecuteParams.args.document, onExecuteParams.args.operationName);
+                if (operationAST?.operation === 'mutation') {
+                    return {
+                        onExecuteDone({ result, setResult }) {
+                            if (isAsyncIterable(result)) {
+                                // eslint-disable-next-line no-console
+                                console.warn('[useResponseCache] AsyncIterable returned from execute is currently unsupported.');
+                                return;
+                            }
+                            const processedResult = processResult(result);
+                            cache.invalidate(identifier.values());
+                            if (includeExtensionMetadata) {
+                                setResult({
+                                    ...processedResult,
+                                    extensions: {
+                                        ...processedResult.extensions,
+                                        responseCache: {
+                                            ...processedResult.extensions?.responseCache,
+                                            invalidatedEntities: Array.from(identifier.values()),
+                                        },
                                     },
-                                },
-                            });
-                        }
-                    },
-                };
+                                });
+                            }
+                        },
+                    };
+                }
             }
             const cacheKey = await buildResponseCacheKey({
                 documentString: getDocumentString(onExecuteParams.args),

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@envelop/response-cache",
-  "version": "4.0.8",
+  "version": "4.0.9-alpha-20230505095813-2dc6c6f3",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^3.0.6",
+    "@envelop/core": "3.0.7-alpha-20230505095813-2dc6c6f3",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
     "@graphql-tools/utils": "^8.8.0",
     "@whatwg-node/fetch": "^0.8.0",
-    "lru-cache": "^6.0.0",
     "fast-json-stable-stringify": "^2.1.0",
+    "lru-cache": "^6.0.0",
     "tslib": "^2.5.0"
   },
   "repository": {

package/typings/cache.d.cts

@@ -1,5 +1,5 @@
-import type { Maybe, PromiseOrValue } from '@envelop/core';
 import type { ExecutionResult } from 'graphql';
+import type { Maybe, PromiseOrValue } from '@envelop/core';
 export declare type CacheEntityRecord = {
     typename: string;
     id?: number | string;

package/typings/cache.d.ts

@@ -1,5 +1,5 @@
-import type { Maybe, PromiseOrValue } from '@envelop/core';
 import type { ExecutionResult } from 'graphql';
+import type { Maybe, PromiseOrValue } from '@envelop/core';
 export declare type CacheEntityRecord = {
     typename: string;
     id?: number | string;

package/typings/plugin.d.cts

@@ -1,5 +1,5 @@
-import { Plugin, Maybe, ExecutionResult, ObjMap } from '@envelop/core';
 import { ExecutionArgs } from 'graphql';
+import { ExecutionResult, Maybe, ObjMap, Plugin } from '@envelop/core';
 import type { Cache } from './cache.cjs';
 /**
  * Function for building the response cache key based on the input parameters
@@ -120,6 +120,7 @@ export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction
  * By default, results with errors (unexpected, EnvelopError, or GraphQLError) are not cached.
  */
 export declare const defaultShouldCacheResult: ShouldCacheResultFunction;
+export declare function defaultGetDocumentString(executionArgs: ExecutionArgs): string;
 export declare type ResponseCacheExtensions = {
     hit: true;
 } | {

package/typings/plugin.d.ts

@@ -1,5 +1,5 @@
-import { Plugin, Maybe, ExecutionResult, ObjMap } from '@envelop/core';
 import { ExecutionArgs } from 'graphql';
+import { ExecutionResult, Maybe, ObjMap, Plugin } from '@envelop/core';
 import type { Cache } from './cache.js';
 /**
  * Function for building the response cache key based on the input parameters
@@ -120,6 +120,7 @@ export declare const defaultBuildResponseCacheKey: BuildResponseCacheKeyFunction
  * By default, results with errors (unexpected, EnvelopError, or GraphQLError) are not cached.
  */
 export declare const defaultShouldCacheResult: ShouldCacheResultFunction;
+export declare function defaultGetDocumentString(executionArgs: ExecutionArgs): string;
 export declare type ResponseCacheExtensions = {
     hit: true;
 } | {

package/cjs/cache-document-str.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultGetDocumentString = exports.useCacheDocumentString = void 0;
-const graphql_1 = require("graphql");
-const documentStringByDocument = new WeakMap();
-function useCacheDocumentString() {
-    return {
-        onParse({ params: { source } }) {
-            return function onParseEnd({ result }) {
-                if (result != null && !(result instanceof Error)) {
-                    documentStringByDocument.set(result, source.toString());
-                }
-            };
-        },
-    };
-}
-exports.useCacheDocumentString = useCacheDocumentString;
-function defaultGetDocumentString(executionArgs) {
-    let documentString = documentStringByDocument.get(executionArgs.document);
-    if (documentString == null) {
-        documentString = (0, graphql_1.print)(executionArgs.document);
-        documentStringByDocument.set(executionArgs.document, documentString);
-    }
-    return documentString;
-}
-exports.defaultGetDocumentString = defaultGetDocumentString;

package/esm/cache-document-str.js

@@ -1,21 +0,0 @@
-import { print } from 'graphql';
-const documentStringByDocument = new WeakMap();
-export function useCacheDocumentString() {
-    return {
-        onParse({ params: { source } }) {
-            return function onParseEnd({ result }) {
-                if (result != null && !(result instanceof Error)) {
-                    documentStringByDocument.set(result, source.toString());
-                }
-            };
-        },
-    };
-}
-export function defaultGetDocumentString(executionArgs) {
-    let documentString = documentStringByDocument.get(executionArgs.document);
-    if (documentString == null) {
-        documentString = print(executionArgs.document);
-        documentStringByDocument.set(executionArgs.document, documentString);
-    }
-    return documentString;
-}

package/typings/cache-document-str.d.cts

@@ -1,4 +0,0 @@
-import { ExecutionArgs } from 'graphql';
-import { Plugin } from '@envelop/core';
-export declare function useCacheDocumentString<PluginContext extends Record<string, any> = {}>(): Plugin<PluginContext>;
-export declare function defaultGetDocumentString(executionArgs: ExecutionArgs): string;

package/typings/cache-document-str.d.ts

@@ -1,4 +0,0 @@
-import { ExecutionArgs } from 'graphql';
-import { Plugin } from '@envelop/core';
-export declare function useCacheDocumentString<PluginContext extends Record<string, any> = {}>(): Plugin<PluginContext>;
-export declare function defaultGetDocumentString(executionArgs: ExecutionArgs): string;