Allow skipping suggestions

Author: JoviDeCroock

src/execution/collectFields.ts

@@ -55,6 +55,7 @@ interface CollectFieldsContext {
   operation: OperationDefinitionNode;
   runtimeType: GraphQLObjectType;
   visitedFragmentNames: Set<string>;
+  shouldProvideSuggestions: boolean;
 }
 
 /**
@@ -66,12 +67,14 @@ interface CollectFieldsContext {
  *
  * @internal
  */
+// eslint-disable-next-line @typescript-eslint/max-params
 export function collectFields(
   schema: GraphQLSchema,
   fragments: ObjMap<FragmentDetails>,
   variableValues: VariableValues,
   runtimeType: GraphQLObjectType,
   operation: OperationDefinitionNode,
+  shouldProvideSuggestions: boolean,
 ): {
   groupedFieldSet: GroupedFieldSet;
   newDeferUsages: ReadonlyArray<DeferUsage>;
@@ -85,6 +88,7 @@ export function collectFields(
     runtimeType,
     operation,
     visitedFragmentNames: new Set(),
+    shouldProvideSuggestions,
   };
 
   collectFieldsImpl(
@@ -114,6 +118,7 @@ export function collectSubfields(
   operation: OperationDefinitionNode,
   returnType: GraphQLObjectType,
   fieldGroup: FieldGroup,
+  shouldProvideSuggestions: boolean,
 ): {
   groupedFieldSet: GroupedFieldSet;
   newDeferUsages: ReadonlyArray<DeferUsage>;
@@ -125,6 +130,7 @@ export function collectSubfields(
     runtimeType: returnType,
     operation,
     visitedFragmentNames: new Set(),
+    shouldProvideSuggestions,
   };
   const subGroupedFieldSet = new AccumulatorMap<string, FieldDetails>();
   const newDeferUsages: Array<DeferUsage> = [];
@@ -172,7 +178,12 @@ function collectFieldsImpl(
     switch (selection.kind) {
       case Kind.FIELD: {
         if (
-          !shouldIncludeNode(selection, variableValues, fragmentVariableValues)
+          !shouldIncludeNode(
+            selection,
+            variableValues,
+            fragmentVariableValues,
+            context.shouldProvideSuggestions,
+          )
         ) {
           continue;
         }
@@ -189,6 +200,7 @@ function collectFieldsImpl(
             selection,
             variableValues,
             fragmentVariableValues,
+            context.shouldProvideSuggestions,
           ) ||
           !doesFragmentConditionMatch(schema, selection, runtimeType)
         ) {
@@ -201,6 +213,7 @@ function collectFieldsImpl(
           fragmentVariableValues,
           selection,
           deferUsage,
+          context.shouldProvideSuggestions,
         );
 
         if (!newDeferUsage) {
@@ -235,6 +248,7 @@ function collectFieldsImpl(
           fragmentVariableValues,
           selection,
           deferUsage,
+          context.shouldProvideSuggestions,
         );
 
         if (
@@ -244,6 +258,7 @@ function collectFieldsImpl(
               selection,
               variableValues,
               fragmentVariableValues,
+              context.shouldProvideSuggestions,
             ))
         ) {
           continue;
@@ -264,6 +279,7 @@ function collectFieldsImpl(
             selection,
             fragmentVariableSignatures,
             variableValues,
+            context.shouldProvideSuggestions,
             fragmentVariableValues,
           );
         }
@@ -300,16 +316,19 @@ 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,
   );
@@ -341,10 +360,12 @@ function shouldIncludeNode(
   node: FragmentSpreadNode | FieldNode | InlineFragmentNode,
   variableValues: VariableValues,
   fragmentVariableValues: VariableValues | undefined,
+  shouldProvideSuggestions: boolean,
 ): boolean {
   const skip = getDirectiveValues(
     GraphQLSkipDirective,
     node,
+    shouldProvideSuggestions,
     variableValues,
     fragmentVariableValues,
   );
@@ -355,6 +376,7 @@ function shouldIncludeNode(
   const include = getDirectiveValues(
     GraphQLIncludeDirective,
     node,
+    shouldProvideSuggestions,
     variableValues,
     fragmentVariableValues,
   );

src/execution/execute.ts

@@ -98,15 +98,21 @@ const collectSubfields = memoize3(
     returnType: GraphQLObjectType,
     fieldGroup: FieldGroup,
   ) => {
-    const { schema, fragments, operation, variableValues } =
-      validatedExecutionArgs;
+    const {
+      schema,
+      fragments,
+      operation,
+      variableValues,
+      shouldProvideSuggestions,
+    } = validatedExecutionArgs;
     return _collectSubfields(
       schema,
       fragments,
       variableValues,
       operation,
       returnType,
       fieldGroup,
+      shouldProvideSuggestions,
     );
   },
 );
@@ -148,6 +154,7 @@ export interface ValidatedExecutionArgs {
   typeResolver: GraphQLTypeResolver<any, any>;
   subscribeFieldResolver: GraphQLFieldResolver<any, any>;
   enableEarlyExecution: boolean;
+  shouldProvideSuggestions: boolean;
 }
 
 export interface ExecutionContext {
@@ -172,6 +179,7 @@ export interface ExecutionArgs {
   typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
   subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
   enableEarlyExecution?: Maybe<boolean>;
+  shouldProvideSuggestions?: Maybe<boolean>;
 }
 
 export interface StreamUsage {
@@ -280,8 +288,14 @@ function executeOperation(
     cancellableStreams: undefined,
   };
   try {
-    const { schema, fragments, rootValue, operation, variableValues } =
-      validatedExecutionArgs;
+    const {
+      schema,
+      fragments,
+      rootValue,
+      operation,
+      variableValues,
+      shouldProvideSuggestions,
+    } = validatedExecutionArgs;
     const rootType = schema.getRootType(operation.operation);
     if (rootType == null) {
       throw new GraphQLError(
@@ -296,6 +310,7 @@ function executeOperation(
       variableValues,
       rootType,
       operation,
+      shouldProvideSuggestions,
     );
 
     const { groupedFieldSet, newDeferUsages } = collectedFields;
@@ -472,6 +487,7 @@ export function validateExecutionArgs(
     typeResolver,
     subscribeFieldResolver,
     enableEarlyExecution,
+    shouldProvideSuggestions,
   } = args;
 
   // If the schema used for execution is invalid, throw an error.
@@ -527,7 +543,10 @@ export function validateExecutionArgs(
     schema,
     variableDefinitions,
     rawVariableValues ?? {},
-    { maxErrors: 50 },
+    {
+      maxErrors: 50,
+      shouldProvideSuggestions: shouldProvideSuggestions ?? true,
+    },
   );
 
   if (variableValuesOrErrors.errors) {
@@ -545,6 +564,7 @@ export function validateExecutionArgs(
     typeResolver: typeResolver ?? defaultTypeResolver,
     subscribeFieldResolver: subscribeFieldResolver ?? defaultFieldResolver,
     enableEarlyExecution: enableEarlyExecution === true,
+    shouldProvideSuggestions: shouldProvideSuggestions ?? true,
   };
 }
 
@@ -728,7 +748,8 @@ function executeField(
   deferMap: ReadonlyMap<DeferUsage, DeferredFragmentRecord> | undefined,
 ): PromiseOrValue<GraphQLWrappedResult<unknown>> | undefined {
   const validatedExecutionArgs = exeContext.validatedExecutionArgs;
-  const { schema, contextValue, variableValues } = validatedExecutionArgs;
+  const { schema, contextValue, variableValues, shouldProvideSuggestions } =
+    validatedExecutionArgs;
   const fieldName = fieldGroup[0].node.name.value;
   const fieldDef = schema.getField(parentType, fieldName);
   if (!fieldDef) {
@@ -755,6 +776,7 @@ function executeField(
       fieldGroup[0].node,
       fieldDef.args,
       variableValues,
+      shouldProvideSuggestions,
       fieldGroup[0].fragmentVariableValues,
     );
 
@@ -1058,12 +1080,14 @@ function getStreamUsage(
       ._streamUsage;
   }
 
-  const { operation, variableValues } = validatedExecutionArgs;
+  const { operation, variableValues, shouldProvideSuggestions } =
+    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,
     fieldGroup[0].node,
+    shouldProvideSuggestions,
     variableValues,
     fieldGroup[0].fragmentVariableValues,
   );
@@ -2023,6 +2047,7 @@ function executeSubscription(
     contextValue,
     operation,
     variableValues,
+    shouldProvideSuggestions,
   } = validatedExecutionArgs;
 
   const rootType = schema.getSubscriptionType();
@@ -2039,6 +2064,7 @@ function executeSubscription(
     variableValues,
     rootType,
     operation,
+    shouldProvideSuggestions,
   );
 
   const firstRootField = groupedFieldSet.entries().next().value as [
@@ -2072,7 +2098,12 @@ function executeSubscription(
 
     // Build a JS object of arguments from the field.arguments AST, using the
     // variables scope to fulfill any variable references.
-    const args = getArgumentValues(fieldDef, fieldNodes[0], variableValues);
+    const args = getArgumentValues(
+      fieldDef,
+      fieldNodes[0],
+      validatedExecutionArgs.shouldProvideSuggestions,
+      variableValues,
+    );
 
     // Call the `subscribe()` resolver or the default resolver to produce an
     // AsyncIterable yielding raw payloads.