graphql 16.12.0 → 16.13.0

package/execution/execute.d.ts

@@ -55,7 +55,18 @@ export interface ExecutionContext {
   fieldResolver: GraphQLFieldResolver<any, any>;
   typeResolver: GraphQLTypeResolver<any, any>;
   subscribeFieldResolver: GraphQLFieldResolver<any, any>;
-  errors: Array<GraphQLError>;
+  collectedErrors: CollectedErrors;
+}
+/**
+ * @internal
+ */
+declare class CollectedErrors {
+  private _errorPositions;
+  private _errors;
+  constructor();
+  get errors(): ReadonlyArray<GraphQLError>;
+  add(error: GraphQLError, path: Path | undefined): void;
+  private _hasNulledPosition;
 }
 /**
  * The result of GraphQL execution.
@@ -121,6 +132,7 @@ export declare function executeSync(args: ExecutionArgs): ExecutionResult;
  * Essential assertions before executing to provide developer feedback for
  * improper use of the GraphQL library.
  *
+ * @deprecated will be removed in v17 in favor of assertValidSchema() and TS checks
  * @internal
  */
 export declare function assertValidExecutionArguments(
@@ -188,3 +200,4 @@ export declare function getFieldDef(
   parentType: GraphQLObjectType,
   fieldNode: FieldNode,
 ): Maybe<GraphQLField<unknown, unknown>>;
+export {};

package/execution/execute.js

@@ -91,6 +91,55 @@ const collectSubfields = (0, _memoize.memoize3)(
  * and the fragments defined in the query document
  */
 
+/**
+ * @internal
+ */
+class CollectedErrors {
+  constructor() {
+    this._errorPositions = new Set();
+    this._errors = [];
+  }
+
+  get errors() {
+    return this._errors;
+  }
+
+  add(error, path) {
+    // Do not modify errors list if the execution position for this error or
+    // any of its ancestors has already been nulled via error propagation.
+    // This check should be unnecessary for implementations able to implement
+    // actual cancellation.
+    if (this._hasNulledPosition(path)) {
+      return;
+    }
+
+    this._errorPositions.add(path);
+
+    this._errors.push(error);
+  }
+
+  _hasNulledPosition(startPath) {
+    let path = startPath;
+
+    while (path !== undefined) {
+      if (this._errorPositions.has(path)) {
+        return true;
+      }
+
+      path = path.prev;
+    }
+
+    return this._errorPositions.has(undefined);
+  }
+}
+/**
+ * The result of GraphQL execution.
+ *
+ *   - `errors` is included when any errors occurred as a non-empty array.
+ *   - `data` is the result of a successful execution of the query.
+ *   - `extensions` is reserved for adding non-standard properties.
+ */
+
 /**
  * Implements the "Executing requests" section of the GraphQL specification.
  *
@@ -137,18 +186,18 @@ function execute(args) {
 
     if ((0, _isPromise.isPromise)(result)) {
       return result.then(
-        (data) => buildResponse(data, exeContext.errors),
+        (data) => buildResponse(data, exeContext.collectedErrors.errors),
         (error) => {
-          exeContext.errors.push(error);
-          return buildResponse(null, exeContext.errors);
+          exeContext.collectedErrors.add(error, undefined);
+          return buildResponse(null, exeContext.collectedErrors.errors);
         },
       );
     }
 
-    return buildResponse(result, exeContext.errors);
+    return buildResponse(result, exeContext.collectedErrors.errors);
   } catch (error) {
-    exeContext.errors.push(error);
-    return buildResponse(null, exeContext.errors);
+    exeContext.collectedErrors.add(error, undefined);
+    return buildResponse(null, exeContext.collectedErrors.errors);
   }
 }
 /**
@@ -185,6 +234,7 @@ function buildResponse(data, errors) {
  * Essential assertions before executing to provide developer feedback for
  * improper use of the GraphQL library.
  *
+ * @deprecated will be removed in v17 in favor of assertValidSchema() and TS checks
  * @internal
  */
 
@@ -319,7 +369,7 @@ function buildExecutionContext(args) {
       subscribeFieldResolver !== null && subscribeFieldResolver !== void 0
         ? subscribeFieldResolver
         : defaultFieldResolver,
-    errors: [],
+    collectedErrors: new CollectedErrors(),
   };
 }
 /**
@@ -524,7 +574,7 @@ function executeField(exeContext, parentType, source, fieldNodes, path) {
           fieldNodes,
           (0, _Path.pathToArray)(path),
         );
-        return handleFieldError(error, returnType, exeContext);
+        return handleFieldError(error, returnType, path, exeContext);
       });
     }
 
@@ -535,7 +585,7 @@ function executeField(exeContext, parentType, source, fieldNodes, path) {
       fieldNodes,
       (0, _Path.pathToArray)(path),
     );
-    return handleFieldError(error, returnType, exeContext);
+    return handleFieldError(error, returnType, path, exeContext);
   }
 }
 /**
@@ -559,7 +609,7 @@ function buildResolveInfo(exeContext, fieldDef, fieldNodes, parentType, path) {
   };
 }
 
-function handleFieldError(error, returnType, exeContext) {
+function handleFieldError(error, returnType, path, exeContext) {
   // If the field type is non-nullable, then it is resolved without any
   // protection from errors, however it still properly locates the error.
   if ((0, _definition.isNonNullType)(returnType)) {
@@ -567,7 +617,7 @@ function handleFieldError(error, returnType, exeContext) {
   } // Otherwise, error protection is applied, logging the error and resolving
   // a null value for this field if one is encountered.
 
-  exeContext.errors.push(error);
+  exeContext.collectedErrors.add(error, path);
   return null;
 }
 /**
@@ -732,7 +782,7 @@ function completeListValue(
             fieldNodes,
             (0, _Path.pathToArray)(itemPath),
           );
-          return handleFieldError(error, itemType, exeContext);
+          return handleFieldError(error, itemType, itemPath, exeContext);
         });
       }
 
@@ -743,7 +793,7 @@ function completeListValue(
         fieldNodes,
         (0, _Path.pathToArray)(itemPath),
       );
-      return handleFieldError(error, itemType, exeContext);
+      return handleFieldError(error, itemType, itemPath, exeContext);
     }
   });
   return containsPromise ? Promise.all(completedResults) : completedResults;

package/execution/execute.mjs

@@ -72,6 +72,55 @@ const collectSubfields = memoize3((exeContext, returnType, fieldNodes) =>
  * and the fragments defined in the query document
  */
 
+/**
+ * @internal
+ */
+class CollectedErrors {
+  constructor() {
+    this._errorPositions = new Set();
+    this._errors = [];
+  }
+
+  get errors() {
+    return this._errors;
+  }
+
+  add(error, path) {
+    // Do not modify errors list if the execution position for this error or
+    // any of its ancestors has already been nulled via error propagation.
+    // This check should be unnecessary for implementations able to implement
+    // actual cancellation.
+    if (this._hasNulledPosition(path)) {
+      return;
+    }
+
+    this._errorPositions.add(path);
+
+    this._errors.push(error);
+  }
+
+  _hasNulledPosition(startPath) {
+    let path = startPath;
+
+    while (path !== undefined) {
+      if (this._errorPositions.has(path)) {
+        return true;
+      }
+
+      path = path.prev;
+    }
+
+    return this._errorPositions.has(undefined);
+  }
+}
+/**
+ * The result of GraphQL execution.
+ *
+ *   - `errors` is included when any errors occurred as a non-empty array.
+ *   - `data` is the result of a successful execution of the query.
+ *   - `extensions` is reserved for adding non-standard properties.
+ */
+
 /**
  * Implements the "Executing requests" section of the GraphQL specification.
  *
@@ -118,18 +167,18 @@ export function execute(args) {
 
     if (isPromise(result)) {
       return result.then(
-        (data) => buildResponse(data, exeContext.errors),
+        (data) => buildResponse(data, exeContext.collectedErrors.errors),
         (error) => {
-          exeContext.errors.push(error);
-          return buildResponse(null, exeContext.errors);
+          exeContext.collectedErrors.add(error, undefined);
+          return buildResponse(null, exeContext.collectedErrors.errors);
         },
       );
     }
 
-    return buildResponse(result, exeContext.errors);
+    return buildResponse(result, exeContext.collectedErrors.errors);
   } catch (error) {
-    exeContext.errors.push(error);
-    return buildResponse(null, exeContext.errors);
+    exeContext.collectedErrors.add(error, undefined);
+    return buildResponse(null, exeContext.collectedErrors.errors);
   }
 }
 /**
@@ -166,6 +215,7 @@ function buildResponse(data, errors) {
  * Essential assertions before executing to provide developer feedback for
  * improper use of the GraphQL library.
  *
+ * @deprecated will be removed in v17 in favor of assertValidSchema() and TS checks
  * @internal
  */
 
@@ -300,7 +350,7 @@ export function buildExecutionContext(args) {
       subscribeFieldResolver !== null && subscribeFieldResolver !== void 0
         ? subscribeFieldResolver
         : defaultFieldResolver,
-    errors: [],
+    collectedErrors: new CollectedErrors(),
   };
 }
 /**
@@ -501,14 +551,14 @@ function executeField(exeContext, parentType, source, fieldNodes, path) {
       // to take a second callback for the error case.
       return completed.then(undefined, (rawError) => {
         const error = locatedError(rawError, fieldNodes, pathToArray(path));
-        return handleFieldError(error, returnType, exeContext);
+        return handleFieldError(error, returnType, path, exeContext);
       });
     }
 
     return completed;
   } catch (rawError) {
     const error = locatedError(rawError, fieldNodes, pathToArray(path));
-    return handleFieldError(error, returnType, exeContext);
+    return handleFieldError(error, returnType, path, exeContext);
   }
 }
 /**
@@ -538,7 +588,7 @@ export function buildResolveInfo(
   };
 }
 
-function handleFieldError(error, returnType, exeContext) {
+function handleFieldError(error, returnType, path, exeContext) {
   // If the field type is non-nullable, then it is resolved without any
   // protection from errors, however it still properly locates the error.
   if (isNonNullType(returnType)) {
@@ -546,7 +596,7 @@ function handleFieldError(error, returnType, exeContext) {
   } // Otherwise, error protection is applied, logging the error and resolving
   // a null value for this field if one is encountered.
 
-  exeContext.errors.push(error);
+  exeContext.collectedErrors.add(error, path);
   return null;
 }
 /**
@@ -710,14 +760,14 @@ function completeListValue(
             fieldNodes,
             pathToArray(itemPath),
           );
-          return handleFieldError(error, itemType, exeContext);
+          return handleFieldError(error, itemType, itemPath, exeContext);
         });
       }
 
       return completedItem;
     } catch (rawError) {
       const error = locatedError(rawError, fieldNodes, pathToArray(itemPath));
-      return handleFieldError(error, itemType, exeContext);
+      return handleFieldError(error, itemType, itemPath, exeContext);
     }
   });
   return containsPromise ? Promise.all(completedResults) : completedResults;

package/execution/subscribe.js

@@ -125,6 +125,7 @@ async function createSourceEventStream(...rawArgs) {
   const args = toNormalizedArgs(rawArgs);
   const { schema, document, variableValues } = args; // If arguments are missing or incorrectly typed, this is an internal
   // developer mistake which should throw an early error.
+  // eslint-disable-next-line import/no-deprecated
 
   (0, _execute.assertValidExecutionArguments)(schema, document, variableValues); // If a valid execution context cannot be created due to incorrect arguments,
   // a "Response" with only errors is returned.

package/execution/subscribe.mjs

@@ -6,6 +6,7 @@ import { GraphQLError } from '../error/GraphQLError.mjs';
 import { locatedError } from '../error/locatedError.mjs';
 import { collectFields } from './collectFields.mjs';
 import {
+  // eslint-disable-next-line import/no-deprecated
   assertValidExecutionArguments,
   buildExecutionContext,
   buildResolveInfo,
@@ -111,6 +112,7 @@ export async function createSourceEventStream(...rawArgs) {
   const args = toNormalizedArgs(rawArgs);
   const { schema, document, variableValues } = args; // If arguments are missing or incorrectly typed, this is an internal
   // developer mistake which should throw an early error.
+  // eslint-disable-next-line import/no-deprecated
 
   assertValidExecutionArguments(schema, document, variableValues); // If a valid execution context cannot be created due to incorrect arguments,
   // a "Response" with only errors is returned.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql",
-  "version": "16.12.0",
+  "version": "16.13.0",
   "description": "A Query Language and Runtime which can target any service.",
   "license": "MIT",
   "main": "index",

package/validation/rules/ValuesOfCorrectTypeRule.js

@@ -132,6 +132,11 @@ function ValuesOfCorrectTypeRule(context) {
     EnumValue: (node) => isValidValueNode(context, node),
     IntValue: (node) => isValidValueNode(context, node),
     FloatValue: (node) => isValidValueNode(context, node),
+    // Descriptions are string values that would not validate according
+    // to the below logic, but since (per the specification) descriptions must
+    // not affect validation, they are ignored entirely when visiting the AST
+    // and do not require special handling.
+    // See https://spec.graphql.org/draft/#sec-Descriptions
     StringValue: (node) => isValidValueNode(context, node),
     BooleanValue: (node) => isValidValueNode(context, node),
   };

package/validation/rules/ValuesOfCorrectTypeRule.mjs

@@ -117,6 +117,11 @@ export function ValuesOfCorrectTypeRule(context) {
     EnumValue: (node) => isValidValueNode(context, node),
     IntValue: (node) => isValidValueNode(context, node),
     FloatValue: (node) => isValidValueNode(context, node),
+    // Descriptions are string values that would not validate according
+    // to the below logic, but since (per the specification) descriptions must
+    // not affect validation, they are ignored entirely when visiting the AST
+    // and do not require special handling.
+    // See https://spec.graphql.org/draft/#sec-Descriptions
     StringValue: (node) => isValidValueNode(context, node),
     BooleanValue: (node) => isValidValueNode(context, node),
   };

package/validation/validate.js

@@ -10,8 +10,12 @@ exports.validateSDL = validateSDL;
 
 var _devAssert = require('../jsutils/devAssert.js');
 
+var _mapValue = require('../jsutils/mapValue.js');
+
 var _GraphQLError = require('../error/GraphQLError.js');
 
+var _ast = require('../language/ast.js');
+
 var _visitor = require('../language/visitor.js');
 
 var _validate = require('../type/validate.js');
@@ -22,6 +26,12 @@ var _specifiedRules = require('./specifiedRules.js');
 
 var _ValidationContext = require('./ValidationContext.js');
 
+// Per the specification, descriptions must not affect validation.
+// See https://spec.graphql.org/draft/#sec-Descriptions
+const QueryDocumentKeysToValidate = (0, _mapValue.mapValue)(
+  _ast.QueryDocumentKeys,
+  (keys) => keys.filter((key) => key !== 'description'),
+);
 /**
  * Implements the "Validation" section of the spec.
  *
@@ -42,6 +52,7 @@ var _ValidationContext = require('./ValidationContext.js');
  * Optionally a custom TypeInfo instance may be provided. If not provided, one
  * will be created from the provided schema.
  */
+
 function validate(
   schema,
   documentAST,
@@ -91,6 +102,7 @@ function validate(
     (0, _visitor.visit)(
       documentAST,
       (0, _TypeInfo.visitWithTypeInfo)(typeInfo, visitor),
+      QueryDocumentKeysToValidate,
     );
   } catch (e) {
     if (e !== abortObj) {

package/validation/validate.mjs

@@ -1,5 +1,7 @@
 import { devAssert } from '../jsutils/devAssert.mjs';
+import { mapValue } from '../jsutils/mapValue.mjs';
 import { GraphQLError } from '../error/GraphQLError.mjs';
+import { QueryDocumentKeys } from '../language/ast.mjs';
 import { visit, visitInParallel } from '../language/visitor.mjs';
 import { assertValidSchema } from '../type/validate.mjs';
 import { TypeInfo, visitWithTypeInfo } from '../utilities/TypeInfo.mjs';
@@ -7,7 +9,12 @@ import { specifiedRules, specifiedSDLRules } from './specifiedRules.mjs';
 import {
   SDLValidationContext,
   ValidationContext,
-} from './ValidationContext.mjs';
+} from './ValidationContext.mjs'; // Per the specification, descriptions must not affect validation.
+// See https://spec.graphql.org/draft/#sec-Descriptions
+
+const QueryDocumentKeysToValidate = mapValue(QueryDocumentKeys, (keys) =>
+  keys.filter((key) => key !== 'description'),
+);
 /**
  * Implements the "Validation" section of the spec.
  *
@@ -73,7 +80,11 @@ export function validate(
   const visitor = visitInParallel(rules.map((rule) => rule(context))); // Visit the whole document with each instance of all provided rules.
 
   try {
-    visit(documentAST, visitWithTypeInfo(typeInfo, visitor));
+    visit(
+      documentAST,
+      visitWithTypeInfo(typeInfo, visitor),
+      QueryDocumentKeysToValidate,
+    );
   } catch (e) {
     if (e !== abortObj) {
       throw e;

package/version.js

@@ -10,7 +10,7 @@ exports.versionInfo = exports.version = void 0;
 /**
  * A string containing the version of the GraphQL.js library
  */
-const version = '16.12.0';
+const version = '16.13.0';
 /**
  * An object containing the components of the GraphQL.js version string
  */
@@ -18,7 +18,7 @@ const version = '16.12.0';
 exports.version = version;
 const versionInfo = Object.freeze({
   major: 16,
-  minor: 12,
+  minor: 13,
   patch: 0,
   preReleaseTag: null,
 });

package/version.mjs

@@ -4,14 +4,14 @@
 /**
  * A string containing the version of the GraphQL.js library
  */
-export const version = '16.12.0';
+export const version = '16.13.0';
 /**
  * An object containing the components of the GraphQL.js version string
  */
 
 export const versionInfo = Object.freeze({
   major: 16,
-  minor: 12,
+  minor: 13,
   patch: 0,
   preReleaseTag: null,
 });