@envelop/validation-cache 5.0.5 → 5.1.0-alpha-20221222121455-d169c23d

package/cjs/index.js

@@ -3,10 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useValidationCache = void 0;
 const tslib_1 = require("tslib");
 const graphql_1 = require("graphql");
+const fast_json_stable_stringify_1 = tslib_1.__importDefault(require("fast-json-stable-stringify"));
 const lru_cache_1 = tslib_1.__importDefault(require("lru-cache"));
+const js_sha1_1 = tslib_1.__importDefault(require("js-sha1"));
 const DEFAULT_MAX = 1000;
 const DEFAULT_TTL = 3600000;
 const rawDocumentSymbol = Symbol('rawDocument');
+const schemaHashCache = new WeakMap();
+function getSchemaHash(schema) {
+    let hash = schemaHashCache.get(schema);
+    if (hash) {
+        return hash;
+    }
+    const introspection = (0, graphql_1.introspectionFromSchema)(schema);
+    hash = (0, js_sha1_1.default)((0, fast_json_stable_stringify_1.default)(introspection.__schema));
+    schemaHashCache.set(schema, hash);
+    return hash;
+}
 const useValidationCache = (pluginOptions = {}) => {
     const resultCache = typeof pluginOptions.cache !== 'undefined'
         ? pluginOptions.cache
@@ -15,14 +28,6 @@ const useValidationCache = (pluginOptions = {}) => {
             maxAge: DEFAULT_TTL,
         });
     return {
-        onSchemaChange() {
-            if (resultCache.reset) {
-                resultCache.reset?.();
-            }
-            else if ('clear' in resultCache) {
-                resultCache.clear?.();
-            }
-        },
         onParse({ params, extendContext }) {
             extendContext({ [rawDocumentSymbol]: params.source.toString() });
         },
@@ -30,6 +35,7 @@ const useValidationCache = (pluginOptions = {}) => {
             // We use setValidateFn over accessing params.rules directly, as other plugins in the chain might add more rules.
             // This would cause an issue if we are constructing the cache key here already.
             setValidationFn((...args) => {
+                const schemaHashKey = getSchemaHash(args[0]);
                 let ruleKey = '';
                 if (Array.isArray(args[2])) {
                     // Note: We could also order them... but that might be too much
@@ -37,7 +43,7 @@ const useValidationCache = (pluginOptions = {}) => {
                         ruleKey = ruleKey + rule.name;
                     }
                 }
-                const key = ruleKey + (context[rawDocumentSymbol] ?? (0, graphql_1.print)(params.documentAST));
+                const key = schemaHashKey + `|` + ruleKey + `|` + (context[rawDocumentSymbol] ?? (0, graphql_1.print)(params.documentAST));
                 const cachedResult = resultCache.get(key);
                 if (cachedResult !== undefined) {
                     return cachedResult;

package/esm/index.js

@@ -1,8 +1,21 @@
-import { print } from 'graphql';
+import { print, introspectionFromSchema } from 'graphql';
+import jsonStableStringify from 'fast-json-stable-stringify';
 import LRU from 'lru-cache';
+import sha1 from 'js-sha1';
 const DEFAULT_MAX = 1000;
 const DEFAULT_TTL = 3600000;
 const rawDocumentSymbol = Symbol('rawDocument');
+const schemaHashCache = new WeakMap();
+function getSchemaHash(schema) {
+    let hash = schemaHashCache.get(schema);
+    if (hash) {
+        return hash;
+    }
+    const introspection = introspectionFromSchema(schema);
+    hash = sha1(jsonStableStringify(introspection.__schema));
+    schemaHashCache.set(schema, hash);
+    return hash;
+}
 export const useValidationCache = (pluginOptions = {}) => {
     const resultCache = typeof pluginOptions.cache !== 'undefined'
         ? pluginOptions.cache
@@ -11,14 +24,6 @@ export const useValidationCache = (pluginOptions = {}) => {
             maxAge: DEFAULT_TTL,
         });
     return {
-        onSchemaChange() {
-            if (resultCache.reset) {
-                resultCache.reset?.();
-            }
-            else if ('clear' in resultCache) {
-                resultCache.clear?.();
-            }
-        },
         onParse({ params, extendContext }) {
             extendContext({ [rawDocumentSymbol]: params.source.toString() });
         },
@@ -26,6 +31,7 @@ export const useValidationCache = (pluginOptions = {}) => {
             // We use setValidateFn over accessing params.rules directly, as other plugins in the chain might add more rules.
             // This would cause an issue if we are constructing the cache key here already.
             setValidationFn((...args) => {
+                const schemaHashKey = getSchemaHash(args[0]);
                 let ruleKey = '';
                 if (Array.isArray(args[2])) {
                     // Note: We could also order them... but that might be too much
@@ -33,7 +39,7 @@ export const useValidationCache = (pluginOptions = {}) => {
                         ruleKey = ruleKey + rule.name;
                     }
                 }
-                const key = ruleKey + (context[rawDocumentSymbol] ?? print(params.documentAST));
+                const key = schemaHashKey + `|` + ruleKey + `|` + (context[rawDocumentSymbol] ?? print(params.documentAST));
                 const cachedResult = resultCache.get(key);
                 if (cachedResult !== undefined) {
                     return cachedResult;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/validation-cache",
-  "version": "5.0.5",
+  "version": "5.1.0-alpha-20221222121455-d169c23d",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^3.0.4",
@@ -8,7 +8,9 @@
   },
   "dependencies": {
     "lru-cache": "^6.0.0",
-    "tslib": "^2.4.0"
+    "tslib": "^2.4.0",
+    "fast-json-stable-stringify": "^2.1.0",
+    "js-sha1": "^0.6.0"
   },
   "repository": {
     "type": "git",

package/typings/index.d.cts

@@ -9,14 +9,6 @@ export interface ValidationCache {
      * Set a result to the validation cache.
      */
     set(key: string, value: readonly GraphQLError[]): void;
-    /**
-     * @deprecated Provide a `reset` implementation instead.
-     */
-    clear?(): void;
-    /**
-     * Reset the cache by clearing all entries.
-     */
-    reset?(): void;
 }
 export declare type ValidationCacheOptions = {
     cache?: ValidationCache;

package/typings/index.d.ts

@@ -9,14 +9,6 @@ export interface ValidationCache {
      * Set a result to the validation cache.
      */
     set(key: string, value: readonly GraphQLError[]): void;
-    /**
-     * @deprecated Provide a `reset` implementation instead.
-     */
-    clear?(): void;
-    /**
-     * Reset the cache by clearing all entries.
-     */
-    reset?(): void;
 }
 export declare type ValidationCacheOptions = {
     cache?: ValidationCache;