@envelop/validation-cache 1.0.1

package/README.md

@@ -0,0 +1,37 @@
+## `@envelop/validation-cache`
+
+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).
+
+## Getting Started
+
+```
+yarn add @envelop/validation-cache
+```
+
+## Usage Example
+
+```ts
+import { envelop } from '@envelop/core';
+import { useValidationCache } from '@envelop/validation-cache';
+
+const getEnveloped = envelop({
+  plugins: [
+    // ... other plugins ...
+    useValidationCache({
+      // options goes here
+    }),
+  ],
+});
+```
+
+### API Reference
+
+#### `max`
+
+Set this to configure your maximum amount of items in the LRU cache. The default is `1000`.
+
+#### `ttl`
+
+Set this to configure the TTL (time to live) of items in the LRU cache. The default is `3600000`.

package/index.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from '@envelop/types';
+export declare type ValidationCacheOptions = {
+    max?: number;
+    ttl?: number;
+};
+export declare const useValidationCache: (pluginOptions?: ValidationCacheOptions) => Plugin;

package/index.js

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
+
+const graphql = require('graphql');
+const lru = _interopDefault(require('tiny-lru'));
+
+const DEFAULT_MAX = 1000;
+const DEFAULT_TTL = 3600000;
+const useValidationCache = (pluginOptions = {}) => {
+    const max = typeof pluginOptions.max === 'number' ? pluginOptions.max : DEFAULT_MAX;
+    const ttl = typeof pluginOptions.ttl === 'number' ? pluginOptions.ttl : DEFAULT_TTL;
+    const resultCache = lru(max, ttl);
+    return {
+        onSchemaChange() {
+            resultCache.clear();
+        },
+        onValidate({ params, setResult }) {
+            const key = graphql.print(params.documentAST);
+            const cachedResult = resultCache.get(key);
+            if (cachedResult !== undefined) {
+                setResult(cachedResult);
+            }
+            return ({ result }) => {
+                resultCache.set(key, result);
+            };
+        },
+    };
+};
+
+exports.useValidationCache = useValidationCache;

package/index.mjs

@@ -0,0 +1,27 @@
+import { print } from 'graphql';
+import lru from 'tiny-lru';
+
+const DEFAULT_MAX = 1000;
+const DEFAULT_TTL = 3600000;
+const useValidationCache = (pluginOptions = {}) => {
+    const max = typeof pluginOptions.max === 'number' ? pluginOptions.max : DEFAULT_MAX;
+    const ttl = typeof pluginOptions.ttl === 'number' ? pluginOptions.ttl : DEFAULT_TTL;
+    const resultCache = lru(max, ttl);
+    return {
+        onSchemaChange() {
+            resultCache.clear();
+        },
+        onValidate({ params, setResult }) {
+            const key = print(params.documentAST);
+            const cachedResult = resultCache.get(key);
+            if (cachedResult !== undefined) {
+                setResult(cachedResult);
+            }
+            return ({ result }) => {
+                resultCache.set(key, result);
+            };
+        },
+    };
+};
+
+export { useValidationCache };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@envelop/validation-cache",
+  "version": "1.0.1",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^14.0.0 || ^15.0.0"
+  },
+  "dependencies": {
+    "tiny-lru": "7.0.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dotansimha/envelop.git",
+    "directory": "packages/plugins/validation-cache"
+  },
+  "author": "Dotan Simha <dotansimha@gmail.com>",
+  "license": "MIT",
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "typescript": {
+    "definition": "index.d.ts"
+  },
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    },
+    "./*": {
+      "require": "./*.js",
+      "import": "./*.mjs"
+    }
+  }
+}