@envelop/validation-cache 5.1.3 → 5.1.4-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

@@ -1,6 +1,7 @@
 ## `@envelop/validation-cache`
 
-This plugins adds simple LRU caching to your `validate`, to improve performance by caching the validation result.
+This plugins adds simple LRU caching to your `validate`, to improve performance by caching the
+validation result.
 
 This plugins improves performance of validating by ~50% (based on benchmarks).
 
@@ -13,7 +14,7 @@ yarn add @envelop/validation-cache
 ## Usage Example
 
 ```ts
-import { parse, validate, specifiedRules, execute, subscribe } from 'graphql'
+import { execute, parse, specifiedRules, subscribe, validate } from 'graphql'
 import { envelop, useEngine } from '@envelop/core'
 import { useValidationCache } from '@envelop/validation-cache'
 
@@ -32,4 +33,5 @@ const getEnveloped = envelop({
 
 #### `cache`
 
-Set this to pass in a cache instance. By default a new LRU cache is created using default `max` and `ttl`.
+Set this to pass in a cache instance. By default a new LRU cache is created using default `max` and
+`ttl`.

package/cjs/index.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.useValidationCache = void 0;
 const tslib_1 = require("tslib");
 const graphql_1 = require("graphql");
-const lru_cache_1 = tslib_1.__importDefault(require("lru-cache"));
 const hash_it_1 = tslib_1.__importDefault(require("hash-it"));
+const lru_cache_1 = tslib_1.__importDefault(require("lru-cache"));
+const core_1 = require("@envelop/core");
 const DEFAULT_MAX = 1000;
 const DEFAULT_TTL = 3600000;
-const rawDocumentSymbol = Symbol('rawDocument');
 const schemaHashCache = new WeakMap();
 function getSchemaHash(schema) {
     let hash = schemaHashCache.get(schema);
@@ -27,10 +27,7 @@ const useValidationCache = (pluginOptions = {}) => {
             maxAge: DEFAULT_TTL,
         });
     return {
-        onParse({ params, extendContext }) {
-            extendContext({ [rawDocumentSymbol]: params.source.toString() });
-        },
-        onValidate({ params, context, setValidationFn, validateFn }) {
+        onValidate({ params, setValidationFn, validateFn }) {
             // 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) => {
@@ -42,7 +39,7 @@ const useValidationCache = (pluginOptions = {}) => {
                         ruleKey = ruleKey + rule.name;
                     }
                 }
-                const key = schemaHashKey + `|` + ruleKey + `|` + (context[rawDocumentSymbol] ?? (0, graphql_1.print)(params.documentAST));
+                const key = schemaHashKey + `|` + ruleKey + `|` + (0, core_1.getDocumentString)(params.documentAST, graphql_1.print);
                 const cachedResult = resultCache.get(key);
                 if (cachedResult !== undefined) {
                     return cachedResult;

package/esm/index.js

@@ -1,9 +1,9 @@
-import { print, introspectionFromSchema } from 'graphql';
-import LRU from 'lru-cache';
+import { introspectionFromSchema, print } from 'graphql';
 import hashIt from 'hash-it';
+import LRU from 'lru-cache';
+import { getDocumentString } from '@envelop/core';
 const DEFAULT_MAX = 1000;
 const DEFAULT_TTL = 3600000;
-const rawDocumentSymbol = Symbol('rawDocument');
 const schemaHashCache = new WeakMap();
 function getSchemaHash(schema) {
     let hash = schemaHashCache.get(schema);
@@ -23,10 +23,7 @@ export const useValidationCache = (pluginOptions = {}) => {
             maxAge: DEFAULT_TTL,
         });
     return {
-        onParse({ params, extendContext }) {
-            extendContext({ [rawDocumentSymbol]: params.source.toString() });
-        },
-        onValidate({ params, context, setValidationFn, validateFn }) {
+        onValidate({ params, setValidationFn, validateFn }) {
             // 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) => {
@@ -38,7 +35,7 @@ export const useValidationCache = (pluginOptions = {}) => {
                         ruleKey = ruleKey + rule.name;
                     }
                 }
-                const key = schemaHashKey + `|` + ruleKey + `|` + (context[rawDocumentSymbol] ?? print(params.documentAST));
+                const key = schemaHashKey + `|` + ruleKey + `|` + getDocumentString(params.documentAST, print);
                 const cachedResult = resultCache.get(key);
                 if (cachedResult !== undefined) {
                     return cachedResult;

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@envelop/validation-cache",
-  "version": "5.1.3",
+  "version": "5.1.4-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": {
+    "hash-it": "^6.0.0",
     "lru-cache": "^6.0.0",
-    "tslib": "^2.5.0",
-    "hash-it": "^6.0.0"
+    "tslib": "^2.5.0"
   },
   "repository": {
     "type": "git",

package/typings/index.d.cts

@@ -1,5 +1,5 @@
-import { Plugin } from '@envelop/core';
 import { GraphQLError } from 'graphql';
+import { type Plugin } from '@envelop/core';
 export interface ValidationCache {
     /**
      * Get a result from the validation cache.

package/typings/index.d.ts

@@ -1,5 +1,5 @@
-import { Plugin } from '@envelop/core';
 import { GraphQLError } from 'graphql';
+import { type Plugin } from '@envelop/core';
 export interface ValidationCache {
     /**
      * Get a result from the validation cache.