@envelop/response-cache 4.0.7 → 4.0.8-alpha-20230220175948-cdba6d9f

package/cjs/plugin.js

@@ -1,6 +1,6 @@
 "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 core_1 = require("@envelop/core");
 const utils_1 = require("@graphql-tools/utils");
@@ -8,7 +8,6 @@ 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");
 /**
  * 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,53 +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, 
+function defaultGetDocumentString(executionArgs) {
+    return (0, core_1.getDocumentString)(executionArgs.document, graphql_1.print);
+}
+exports.defaultGetDocumentString = defaultGetDocumentString;
+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) {
+        return newDocument;
+    }
+    return undefined;
+});
+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, 
 // eslint-disable-next-line dot-notation
 includeExtensionMetadata = typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false, }) {
     const ignoredTypesMap = new Set(ignoredTypes);
     // never cache Introspections
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
+    const documentChangedByContext = new WeakMap();
     return {
-        onPluginInit({ addPlugin }) {
-            if (getDocumentString === cache_document_str_js_1.defaultGetDocumentString) {
-                addPlugin((0, cache_document_str_js_1.useCacheDocumentString)());
-            }
+        onParse({ context }) {
+            return ({ result, replaceParseResult }) => {
+                if (result.kind === graphql_1.Kind.DOCUMENT) {
+                    const newDocument = addTypeNameToDocument(result);
+                    if (newDocument) {
+                        documentChangedByContext.set(context, true);
+                        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 documentChanged = documentChangedByContext.get(onExecuteParams.args.contextValue);
             const processResult = (result) => (0, utils_1.visitResult)(result, {
                 document: onExecuteParams.args.document,
                 variables: onExecuteParams.args.variableValues,

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 { isAsyncIterable, getDocumentString } from '@envelop/core';
+import { memoize1, visitResult } from '@graphql-tools/utils';
+import { visit, TypeInfo, visitWithTypeInfo, getOperationAST, Kind, print, } from 'graphql';
 import jsonStableStringify from 'fast-json-stable-stringify';
 import { createInMemoryCache } from './in-memory-cache.js';
 import { hashSHA256 } from './hash-sha256.js';
-import { defaultGetDocumentString, useCacheDocumentString } from './cache-document-str.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,53 +30,62 @@ export const defaultShouldCacheResult = (params) => {
     }
     return true;
 };
+export function defaultGetDocumentString(executionArgs) {
+    return getDocumentString(executionArgs.document, print);
+}
+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) {
+        return newDocument;
+    }
+    return undefined;
+});
 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, }) {
     const ignoredTypesMap = new Set(ignoredTypes);
     // never cache Introspections
     ttlPerSchemaCoordinate = { 'Query.__schema': 0, ...ttlPerSchemaCoordinate };
+    const documentChangedByContext = new WeakMap();
     return {
-        onPluginInit({ addPlugin }) {
-            if (getDocumentString === defaultGetDocumentString) {
-                addPlugin(useCacheDocumentString());
-            }
+        onParse({ context }) {
+            return ({ result, replaceParseResult }) => {
+                if (result.kind === Kind.DOCUMENT) {
+                    const newDocument = addTypeNameToDocument(result);
+                    if (newDocument) {
+                        documentChangedByContext.set(context, true);
+                        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 documentChanged = documentChangedByContext.get(onExecuteParams.args.contextValue);
             const processResult = (result) => visitResult(result, {
                 document: onExecuteParams.args.document,
                 variables: onExecuteParams.args.variableValues,

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/response-cache",
-  "version": "4.0.7",
+  "version": "4.0.8-alpha-20230220175948-cdba6d9f",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^3.0.6",
+    "@envelop/core": "3.0.7-alpha-20230220175948-cdba6d9f",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {

package/typings/plugin.d.cts

@@ -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

@@ -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;