Allow for parse to return a Promise

Author: JoviDeCroock

src/language/__tests__/parser-test.ts

@@ -11,7 +11,13 @@ import { kitchenSinkQuery } from '../../__testUtils__/kitchenSinkQuery.js';
 import { inspect } from '../../jsutils/inspect.js';
 
 import { Kind } from '../kinds.js';
-import { parse, parseConstValue, parseType, parseValue } from '../parser.js';
+import {
+  parse,
+  parseConstValue,
+  parseSync,
+  parseType,
+  parseValue,
+} from '../parser.js';
 import { Source } from '../source.js';
 import { TokenKind } from '../tokenKind.js';
 
@@ -20,10 +26,10 @@ function expectSyntaxError(text: string) {
 }
 
 describe('Parser', () => {
-  it('parse provides useful errors', () => {
+  it('parse provides useful errors', async () => {
     let caughtError;
     try {
-      parse('{');
+      await parse('{');
     } catch (error) {
       caughtError = error;
     }
@@ -71,10 +77,10 @@ describe('Parser', () => {
     });
   });
 
-  it('parse provides useful error when using source', () => {
+  it('parse provides useful error when using source', async () => {
     let caughtError;
     try {
-      parse(new Source('query', 'MyQuery.graphql'));
+      await parse(new Source('query', 'MyQuery.graphql'));
     } catch (error) {
       caughtError = error;
     }
@@ -100,9 +106,10 @@ describe('Parser', () => {
     );
   });
 
-  it('exposes the tokenCount', () => {
-    expect(parse('{ foo }').tokenCount).to.equal(3);
-    expect(parse('{ foo(bar: "baz") }').tokenCount).to.equal(8);
+  it('exposes the tokenCount', async () => {
+    expect(parseSync('{ foo }').tokenCount).to.equal(3);
+    expect((await parse('{ foo }')).tokenCount).to.equal(3);
+    expect((await parse('{ foo(bar: "baz") }')).tokenCount).to.equal(8);
   });
 
   it('parses variable inline values', () => {
@@ -431,8 +438,8 @@ describe('Parser', () => {
     expect(() => parse(document)).to.throw();
   });
 
-  it('contains location that can be Object.toStringified, JSON.stringified, or jsutils.inspected', () => {
-    const { loc } = parse('{ id }');
+  it('contains location that can be Object.toStringified, JSON.stringified, or jsutils.inspected', async () => {
+    const { loc } = await parse('{ id }');
 
     expect(Object.prototype.toString.call(loc)).to.equal('[object Location]');
     expect(JSON.stringify(loc)).to.equal('{"start":0,"end":6}');

src/language/parser.ts

@@ -1,3 +1,4 @@
+import { isPromise } from '../jsutils/isPromise.js';
 import type { Maybe } from '../jsutils/Maybe.js';
 
 import type { GraphQLError } from '../error/GraphQLError.js';
@@ -117,7 +118,7 @@ export interface ParseOptions {
 export function parse(
   source: string | Source,
   options?: ParseOptions | undefined,
-): DocumentNode {
+): Promise<DocumentNode> | DocumentNode {
   const parser = new Parser(source, options);
   const document = parser.parseDocument();
   Object.defineProperty(document, 'tokenCount', {
@@ -127,6 +128,17 @@ export function parse(
   return document;
 }
 
+export function parseSync(
+  source: string | Source,
+  options?: ParseOptions | undefined,
+): DocumentNode {
+  const result = parse(source, options);
+  if (isPromise(result)) {
+    throw new Error('GraphQL parsing failed to complete synchronously.');
+  }
+  return result;
+}
+
 /**
  * Given a string containing a GraphQL value (ex. `[42]`), parse the AST for
  * that value.