Add tests

Author: JoviDeCroock

src/execution/collectFields.ts

@@ -1,5 +1,6 @@
 import { AccumulatorMap } from '../jsutils/AccumulatorMap.js';
 import { invariant } from '../jsutils/invariant.js';
+import type { Maybe } from '../jsutils/Maybe.js';
 import type { ObjMap } from '../jsutils/ObjMap.js';
 
 import type {
@@ -55,7 +56,7 @@ interface CollectFieldsContext {
   operation: OperationDefinitionNode;
   runtimeType: GraphQLObjectType;
   visitedFragmentNames: Set<string>;
-  shouldProvideSuggestions: boolean;
+  maskSuggestions: boolean;
 }
 
 /**
@@ -74,7 +75,7 @@ export function collectFields(
   variableValues: VariableValues,
   runtimeType: GraphQLObjectType,
   operation: OperationDefinitionNode,
-  shouldProvideSuggestions: boolean,
+  maskSuggestions?: Maybe<boolean>,
 ): {
   groupedFieldSet: GroupedFieldSet;
   newDeferUsages: ReadonlyArray<DeferUsage>;
@@ -88,7 +89,7 @@ export function collectFields(
     runtimeType,
     operation,
     visitedFragmentNames: new Set(),
-    shouldProvideSuggestions,
+    maskSuggestions: maskSuggestions ?? false,
   };
 
   collectFieldsImpl(
@@ -118,7 +119,7 @@ export function collectSubfields(
   operation: OperationDefinitionNode,
   returnType: GraphQLObjectType,
   fieldDetailsList: FieldDetailsList,
-  shouldProvideSuggestions: boolean,
+  maskSuggestions?: Maybe<boolean>,
 ): {
   groupedFieldSet: GroupedFieldSet;
   newDeferUsages: ReadonlyArray<DeferUsage>;
@@ -130,7 +131,7 @@ export function collectSubfields(
     runtimeType: returnType,
     operation,
     visitedFragmentNames: new Set(),
-    shouldProvideSuggestions,
+    maskSuggestions: maskSuggestions ?? false,
   };
   const subGroupedFieldSet = new AccumulatorMap<string, FieldDetails>();
   const newDeferUsages: Array<DeferUsage> = [];
@@ -178,12 +179,7 @@ function collectFieldsImpl(
     switch (selection.kind) {
       case Kind.FIELD: {
         if (
-          !shouldIncludeNode(
-            selection,
-            variableValues,
-            fragmentVariableValues,
-            context.shouldProvideSuggestions,
-          )
+          !shouldIncludeNode(selection, variableValues, fragmentVariableValues)
         ) {
           continue;
         }
@@ -200,7 +196,6 @@ function collectFieldsImpl(
             selection,
             variableValues,
             fragmentVariableValues,
-            context.shouldProvideSuggestions,
           ) ||
           !doesFragmentConditionMatch(schema, selection, runtimeType)
         ) {
@@ -213,7 +208,6 @@ function collectFieldsImpl(
           fragmentVariableValues,
           selection,
           deferUsage,
-          context.shouldProvideSuggestions,
         );
 
         if (!newDeferUsage) {
@@ -248,7 +242,6 @@ function collectFieldsImpl(
           fragmentVariableValues,
           selection,
           deferUsage,
-          context.shouldProvideSuggestions,
         );
 
         if (
@@ -258,7 +251,6 @@ function collectFieldsImpl(
               selection,
               variableValues,
               fragmentVariableValues,
-              context.shouldProvideSuggestions,
             ))
         ) {
           continue;
@@ -279,8 +271,8 @@ function collectFieldsImpl(
             selection,
             fragmentVariableSignatures,
             variableValues,
-            context.shouldProvideSuggestions,
             fragmentVariableValues,
+            false,
           );
         }
 
@@ -316,19 +308,16 @@ function collectFieldsImpl(
  * deferred based on the experimental flag, defer directive present and
  * not disabled by the "if" argument.
  */
-// eslint-disable-next-line @typescript-eslint/max-params
 function getDeferUsage(
   operation: OperationDefinitionNode,
   variableValues: VariableValues,
   fragmentVariableValues: VariableValues | undefined,
   node: FragmentSpreadNode | InlineFragmentNode,
   parentDeferUsage: DeferUsage | undefined,
-  shouldProvideSuggestions: boolean,
 ): DeferUsage | undefined {
   const defer = getDirectiveValues(
     GraphQLDeferDirective,
     node,
-    shouldProvideSuggestions,
     variableValues,
     fragmentVariableValues,
   );
@@ -360,12 +349,10 @@ function shouldIncludeNode(
   node: FragmentSpreadNode | FieldNode | InlineFragmentNode,
   variableValues: VariableValues,
   fragmentVariableValues: VariableValues | undefined,
-  shouldProvideSuggestions: boolean,
 ): boolean {
   const skip = getDirectiveValues(
     GraphQLSkipDirective,
     node,
-    shouldProvideSuggestions,
     variableValues,
     fragmentVariableValues,
   );
@@ -376,7 +363,6 @@ function shouldIncludeNode(
   const include = getDirectiveValues(
     GraphQLIncludeDirective,
     node,
-    shouldProvideSuggestions,
     variableValues,
     fragmentVariableValues,
   );

src/execution/execute.ts

@@ -98,21 +98,16 @@ const collectSubfields = memoize3(
     returnType: GraphQLObjectType,
     fieldDetailsList: FieldDetailsList,
   ) => {
-    const {
-      schema,
-      fragments,
-      operation,
-      variableValues,
-      shouldProvideSuggestions,
-    } = validatedExecutionArgs;
+    const { schema, fragments, operation, variableValues, maskSuggestions } =
+      validatedExecutionArgs;
     return _collectSubfields(
       schema,
       fragments,
       variableValues,
       operation,
       returnType,
       fieldDetailsList,
-      shouldProvideSuggestions,
+      maskSuggestions,
     );
   },
 );
@@ -161,7 +156,7 @@ export interface ValidatedExecutionArgs {
     validatedExecutionArgs: ValidatedExecutionArgs,
   ) => PromiseOrValue<ExecutionResult>;
   enableEarlyExecution: boolean;
-  shouldProvideSuggestions: boolean;
+  maskSuggestions: boolean;
 }
 
 export interface ExecutionContext {
@@ -191,7 +186,7 @@ export interface ExecutionArgs {
     ) => PromiseOrValue<ExecutionResult>
   >;
   enableEarlyExecution?: Maybe<boolean>;
-  shouldProvideSuggestions?: Maybe<boolean>;
+  maskSuggestions?: Maybe<boolean>;
 }
 
 export interface StreamUsage {
@@ -322,7 +317,7 @@ export function experimentalExecuteQueryOrMutationOrSubscriptionEvent(
       rootValue,
       operation,
       variableValues,
-      shouldProvideSuggestions,
+      maskSuggestions,
     } = validatedExecutionArgs;
     const rootType = schema.getRootType(operation.operation);
     if (rootType == null) {
@@ -338,7 +333,7 @@ export function experimentalExecuteQueryOrMutationOrSubscriptionEvent(
       variableValues,
       rootType,
       operation,
-      shouldProvideSuggestions,
+      maskSuggestions,
     );
 
     const { groupedFieldSet, newDeferUsages } = collectedFields;
@@ -516,7 +511,6 @@ export function validateExecutionArgs(
     subscribeFieldResolver,
     perEventExecutor,
     enableEarlyExecution,
-    shouldProvideSuggestions,
   } = args;
 
   // If the schema used for execution is invalid, throw an error.
@@ -570,14 +564,15 @@ export function validateExecutionArgs(
   // FIXME: https://github.com/graphql/graphql-js/issues/2203
   /* c8 ignore next */
   const variableDefinitions = operation.variableDefinitions ?? [];
+  const maskSuggestions = args.maskSuggestions ?? false;
 
   const variableValuesOrErrors = getVariableValues(
     schema,
     variableDefinitions,
     rawVariableValues ?? {},
     {
       maxErrors: 50,
-      shouldProvideSuggestions: shouldProvideSuggestions ?? true,
+      maskSuggestions,
     },
   );
 
@@ -598,7 +593,7 @@ export function validateExecutionArgs(
     subscribeFieldResolver: subscribeFieldResolver ?? defaultFieldResolver,
     perEventExecutor: perEventExecutor ?? executeSubscriptionEvent,
     enableEarlyExecution: enableEarlyExecution === true,
-    shouldProvideSuggestions: shouldProvideSuggestions ?? true,
+    maskSuggestions,
   };
 }
 
@@ -782,7 +777,8 @@ function executeField(
   deferMap: ReadonlyMap<DeferUsage, DeferredFragmentRecord> | undefined,
 ): PromiseOrValue<GraphQLWrappedResult<unknown>> | undefined {
   const validatedExecutionArgs = exeContext.validatedExecutionArgs;
-  const { schema, contextValue, variableValues, shouldProvideSuggestions } = validatedExecutionArgs;
+  const { schema, contextValue, variableValues, maskSuggestions } =
+    validatedExecutionArgs;
   const fieldName = fieldDetailsList[0].node.name.value;
   const fieldDef = schema.getField(parentType, fieldName);
   if (!fieldDef) {
@@ -809,8 +805,8 @@ function executeField(
       fieldDetailsList[0].node,
       fieldDef.args,
       variableValues,
-      shouldProvideSuggestions,
       fieldDetailsList[0].fragmentVariableValues,
+      maskSuggestions,
     );
 
     // The resolve function's optional third argument is a context value that
@@ -1114,16 +1110,15 @@ function getStreamUsage(
       ._streamUsage;
   }
 
-  const { operation, variableValues, shouldProvideSuggestions } =
-    validatedExecutionArgs;
+  const { operation, variableValues, maskSuggestions } = validatedExecutionArgs;
   // validation only allows equivalent streams on multiple fields, so it is
   // safe to only check the first fieldNode for the stream directive
   const stream = getDirectiveValues(
     GraphQLStreamDirective,
     fieldDetailsList[0].node,
-    shouldProvideSuggestions,
     variableValues,
     fieldDetailsList[0].fragmentVariableValues,
+    maskSuggestions,
   );
 
   if (!stream) {
@@ -2088,7 +2083,7 @@ function executeSubscription(
     contextValue,
     operation,
     variableValues,
-    shouldProvideSuggestions,
+    maskSuggestions,
   } = validatedExecutionArgs;
 
   const rootType = schema.getSubscriptionType();
@@ -2105,7 +2100,7 @@ function executeSubscription(
     variableValues,
     rootType,
     operation,
-    shouldProvideSuggestions,
+    maskSuggestions,
   );
 
   const firstRootField = groupedFieldSet.entries().next().value as [
@@ -2142,8 +2137,8 @@ function executeSubscription(
     const args = getArgumentValues(
       fieldDef,
       fieldNodes[0],
-      validatedExecutionArgs.shouldProvideSuggestions,
       variableValues,
+      maskSuggestions,
     );
 
     // Call the `subscribe()` resolver or the default resolver to produce an