introduce simple user provided caches for parse/validate

BREAKING CHANGE: parse/validate become potentially async when provided with a cache with an async getter,

Introduces parseSync/validateSync to throw when an async value is returned.

Updates all non-cache tests to use parseSync/validateSync.

Author: yaacovCR

src/__tests__/starWarsValidation-test.ts

@@ -1,10 +1,10 @@
 import { expect } from 'chai';
 import { describe, it } from 'mocha';
 
-import { parse } from '../language/parser.js';
+import { parseSync as parse } from '../language/parser.js';
 import { Source } from '../language/source.js';
 
-import { validate } from '../validation/validate.js';
+import { validateSync as validate } from '../validation/validate.js';
 
 import { StarWarsSchema } from './starWarsSchema.js';
 

src/error/__tests__/GraphQLError-test.ts

@@ -4,7 +4,7 @@ import { describe, it } from 'mocha';
 import { dedent } from '../../__testUtils__/dedent.js';
 
 import { Kind } from '../../language/kinds.js';
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 import { Source } from '../../language/source.js';
 
 import { GraphQLError } from '../GraphQLError.js';

src/execution/__tests__/abort-signal-test.ts

@@ -5,7 +5,7 @@ import { expectJSON } from '../../__testUtils__/expectJSON.js';
 import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick.js';
 
 import type { DocumentNode } from '../../language/ast.js';
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import { buildSchema } from '../../utilities/buildASTSchema.js';
 

src/execution/__tests__/abstract-test.ts

@@ -3,7 +3,7 @@ import { describe, it } from 'mocha';
 
 import { expectJSON } from '../../__testUtils__/expectJSON.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import {
   assertInterfaceType,

src/execution/__tests__/defer-test.ts

@@ -8,7 +8,7 @@ import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick.js';
 import { promiseWithResolvers } from '../../jsutils/promiseWithResolvers.js';
 
 import type { DocumentNode } from '../../language/ast.js';
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import {
   GraphQLList,

src/execution/__tests__/directives-test.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { describe, it } from 'mocha';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import { GraphQLObjectType } from '../../type/definition.js';
 import { GraphQLString } from '../../type/scalars.js';

src/execution/__tests__/executor-test.ts

@@ -7,7 +7,7 @@ import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick.js';
 import { inspect } from '../../jsutils/inspect.js';
 
 import { Kind } from '../../language/kinds.js';
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import {
   GraphQLInterfaceType,

src/execution/__tests__/lists-test.ts

@@ -5,7 +5,7 @@ import { expectJSON } from '../../__testUtils__/expectJSON.js';
 
 import type { PromiseOrValue } from '../../jsutils/PromiseOrValue.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import type { GraphQLFieldResolver } from '../../type/definition.js';
 import {

src/execution/__tests__/mutations-test.ts

@@ -4,7 +4,7 @@ import { describe, it } from 'mocha';
 import { expectJSON } from '../../__testUtils__/expectJSON.js';
 import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import { GraphQLObjectType } from '../../type/definition.js';
 import { GraphQLInt } from '../../type/scalars.js';

src/execution/__tests__/nonnull-test.ts

@@ -6,7 +6,7 @@ import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick.js';
 
 import type { PromiseOrValue } from '../../jsutils/PromiseOrValue.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import { GraphQLNonNull, GraphQLObjectType } from '../../type/definition.js';
 import { GraphQLString } from '../../type/scalars.js';

src/execution/__tests__/oneof-test.ts

@@ -2,7 +2,7 @@ import { describe, it } from 'mocha';
 
 import { expectJSON } from '../../__testUtils__/expectJSON.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import { buildSchema } from '../../utilities/buildASTSchema.js';
 

src/execution/__tests__/resolve-test.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { describe, it } from 'mocha';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import type { GraphQLFieldConfig } from '../../type/definition.js';
 import { GraphQLObjectType } from '../../type/definition.js';

src/execution/__tests__/schema-test.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { describe, it } from 'mocha';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import {
   GraphQLList,

src/execution/__tests__/stream-test.ts

@@ -9,7 +9,7 @@ import type { PromiseOrValue } from '../../jsutils/PromiseOrValue.js';
 import { promiseWithResolvers } from '../../jsutils/promiseWithResolvers.js';
 
 import type { DocumentNode } from '../../language/ast.js';
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import {
   GraphQLList,

src/execution/__tests__/subscribe-test.ts

@@ -10,7 +10,7 @@ import { isAsyncIterable } from '../../jsutils/isAsyncIterable.js';
 import { isPromise } from '../../jsutils/isPromise.js';
 import type { PromiseOrValue } from '../../jsutils/PromiseOrValue.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import { GraphQLList, GraphQLObjectType } from '../../type/definition.js';
 import {

src/execution/__tests__/sync-test.ts

@@ -3,13 +3,13 @@ import { describe, it } from 'mocha';
 
 import { expectJSON } from '../../__testUtils__/expectJSON.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import { GraphQLObjectType } from '../../type/definition.js';
 import { GraphQLString } from '../../type/scalars.js';
 import { GraphQLSchema } from '../../type/schema.js';
 
-import { validate } from '../../validation/validate.js';
+import { validateSync as validate } from '../../validation/validate.js';
 
 import { graphqlSync } from '../../graphql.js';
 

src/execution/__tests__/union-interface-test.ts

@@ -3,7 +3,7 @@ import { describe, it } from 'mocha';
 
 import { expectJSON } from '../../__testUtils__/expectJSON.js';
 
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import {
   GraphQLInterfaceType,

src/execution/__tests__/variables-test.ts

@@ -9,7 +9,7 @@ import { GraphQLError } from '../../error/GraphQLError.js';
 
 import { DirectiveLocation } from '../../language/directiveLocation.js';
 import { Kind } from '../../language/kinds.js';
-import { parse } from '../../language/parser.js';
+import { parseSync as parse } from '../../language/parser.js';
 
 import type {
   GraphQLArgumentConfig,

src/graphql.ts

@@ -2,7 +2,7 @@ import { isPromise } from './jsutils/isPromise.js';
 import type { Maybe } from './jsutils/Maybe.js';
 import type { PromiseOrValue } from './jsutils/PromiseOrValue.js';
 
-import { parse } from './language/parser.js';
+import { parseSync as parse } from './language/parser.js';
 import type { Source } from './language/source.js';
 
 import type {
@@ -12,7 +12,7 @@ import type {
 import type { GraphQLSchema } from './type/schema.js';
 import { validateSchema } from './type/validate.js';
 
-import { validate } from './validation/validate.js';
+import { validateSync as validate } from './validation/validate.js';
 
 import { execute } from './execution/execute.js';
 import type { ExecutionResult } from './execution/types.js';

src/index.ts

@@ -220,6 +220,7 @@ export {
   TokenKind,
   // Parse
   parse,
+  parseSync,
   parseValue,
   parseConstValue,
   parseType,
@@ -247,6 +248,7 @@ export {
 
 export type {
   ParseOptions,
+  ParseCache,
   SourceLocation,
   // Visitor utilities
   ASTVisitor,
@@ -356,6 +358,7 @@ export type {
 // Validate GraphQL documents.
 export {
   validate,
+  validateSync,
   ValidationContext,
   // All validation rules in the GraphQL Specification.
   specifiedRules,
@@ -402,7 +405,11 @@ export {
   NoSchemaIntrospectionCustomRule,
 } from './validation/index.js';
 
-export type { ValidationRule } from './validation/index.js';
+export type {
+  ValidationRule,
+  ValidateOptions,
+  ValidateCache,
+} from './validation/index.js';
 
 // Create, format, and print GraphQL errors.
 export { GraphQLError, syntaxError, locatedError } from './error/index.js';

src/jsutils/__tests__/withCache-test.ts

@@ -0,0 +1,154 @@
+import { expect } from 'chai';
+import { describe, it } from 'mocha';
+
+import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick.js';
+
+import { isPromise } from '../isPromise.js';
+import { withCache } from '../withCache.js';
+
+describe('withCache', () => {
+  it('returns asynchronously using asynchronous cache', async () => {
+    let cached: string | undefined;
+    let getAttempts = 0;
+    let cacheHits = 0;
+    const customCache = {
+      set: async (result: string) => {
+        await resolveOnNextTick();
+        cached = result;
+      },
+      get: () => {
+        getAttempts++;
+        if (cached !== undefined) {
+          cacheHits++;
+        }
+        return Promise.resolve(cached);
+      },
+    };
+
+    const fnWithCache = withCache((arg: string) => arg, customCache);
+
+    const firstResultPromise = fnWithCache('arg');
+    expect(isPromise(firstResultPromise)).to.equal(true);
+    const firstResult = await firstResultPromise;
+
+    expect(firstResult).to.equal('arg');
+    expect(getAttempts).to.equal(1);
+    expect(cacheHits).to.equal(0);
+
+    const secondResultPromise = fnWithCache('arg');
+
+    expect(isPromise(secondResultPromise)).to.equal(true);
+
+    const secondResult = await secondResultPromise;
+    expect(secondResult).to.equal('arg');
+    expect(getAttempts).to.equal(2);
+    expect(cacheHits).to.equal(1);
+  });
+
+  it('returns synchronously using cache with sync getter and async setter', async () => {
+    let cached: string | undefined;
+    let getAttempts = 0;
+    let cacheHits = 0;
+    const customCache = {
+      set: async (result: string) => {
+        await resolveOnNextTick();
+        cached = result;
+      },
+      get: () => {
+        getAttempts++;
+        if (cached !== undefined) {
+          cacheHits++;
+        }
+        return cached;
+      },
+    };
+
+    const fnWithCache = withCache((arg: string) => arg, customCache);
+
+    const firstResult = fnWithCache('arg');
+    expect(firstResult).to.equal('arg');
+    expect(getAttempts).to.equal(1);
+    expect(cacheHits).to.equal(0);
+
+    await resolveOnNextTick();
+
+    const secondResult = fnWithCache('arg');
+
+    expect(secondResult).to.equal('arg');
+    expect(getAttempts).to.equal(2);
+    expect(cacheHits).to.equal(1);
+  });
+
+  it('returns asynchronously using cache with async getter and sync setter', async () => {
+    let cached: string | undefined;
+    let getAttempts = 0;
+    let cacheHits = 0;
+    const customCache = {
+      set: (result: string) => {
+        cached = result;
+      },
+      get: () => {
+        getAttempts++;
+        if (cached !== undefined) {
+          cacheHits++;
+        }
+        return Promise.resolve(cached);
+      },
+    };
+
+    const fnWithCache = withCache((arg: string) => arg, customCache);
+
+    const firstResultPromise = fnWithCache('arg');
+    expect(isPromise(firstResultPromise)).to.equal(true);
+    const firstResult = await firstResultPromise;
+
+    expect(firstResult).to.equal('arg');
+    expect(getAttempts).to.equal(1);
+    expect(cacheHits).to.equal(0);
+
+    const secondResultPromise = fnWithCache('arg');
+
+    expect(isPromise(secondResultPromise)).to.equal(true);
+
+    const secondResult = await secondResultPromise;
+    expect(secondResult).to.equal('arg');
+    expect(getAttempts).to.equal(2);
+    expect(cacheHits).to.equal(1);
+  });
+
+  it('ignores async setter errors', async () => {
+    let cached: string | undefined;
+    let getAttempts = 0;
+    let cacheHits = 0;
+    const customCache = {
+      set: () => Promise.reject(new Error('Oops')),
+      get: () => {
+        getAttempts++;
+        /* c8 ignore next 3 */
+        if (cached !== undefined) {
+          cacheHits++;
+        }
+        return Promise.resolve(cached);
+      },
+    };
+
+    const fnWithCache = withCache((arg: string) => arg, customCache);
+
+    const firstResultPromise = fnWithCache('arg');
+    expect(isPromise(firstResultPromise)).to.equal(true);
+    const firstResult = await firstResultPromise;
+
+    expect(firstResult).to.equal('arg');
+    expect(getAttempts).to.equal(1);
+    expect(cacheHits).to.equal(0);
+
+    const secondResultPromise = fnWithCache('arg');
+
+    expect(isPromise(secondResultPromise)).to.equal(true);
+
+    const secondResult = await secondResultPromise;
+    expect(secondResult).to.equal('arg');
+    expect(getAttempts).to.equal(2);
+    expect(cacheHits).to.equal(0);
+  });
+});