graphql · yaacovCR · Oct 4, 2024 · Oct 7, 2024 · Oct 7, 2024 · Oct 8, 2024
diff --git a/src/execution/collectFields.ts b/src/execution/collectFields.ts
@@ -54,6 +54,7 @@ interface CollectFieldsContext {
   variableValues: VariableValues;
   operation: OperationDefinitionNode;
   runtimeType: GraphQLObjectType;
+  maskSuggestions: boolean;
   visitedFragmentNames: Set<string>;
 }
 
@@ -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,
+  maskSuggestions: boolean,
 ): {
   groupedFieldSet: GroupedFieldSet;
   newDeferUsages: ReadonlyArray<DeferUsage>;
@@ -84,6 +87,7 @@ export function collectFields(
     variableValues,
     runtimeType,
     operation,
+    maskSuggestions,
     visitedFragmentNames: new Set(),
   };
 
@@ -114,6 +118,7 @@ export function collectSubfields(
   operation: OperationDefinitionNode,
   returnType: GraphQLObjectType,
   fieldDetailsList: FieldDetailsList,
+  maskSuggestions: boolean,
 ): {
   groupedFieldSet: GroupedFieldSet;
   newDeferUsages: ReadonlyArray<DeferUsage>;
@@ -125,6 +130,7 @@ export function collectSubfields(
     runtimeType: returnType,
     operation,
     visitedFragmentNames: new Set(),
+    maskSuggestions,
   };
   const subGroupedFieldSet = new AccumulatorMap<string, FieldDetails>();
   const newDeferUsages: Array<DeferUsage> = [];
@@ -165,6 +171,7 @@ function collectFieldsImpl(
     variableValues,
     runtimeType,
     operation,
+    maskSuggestions,
     visitedFragmentNames,
   } = context;
 
@@ -263,6 +270,7 @@ function collectFieldsImpl(
           newFragmentVariableValues = getFragmentVariableValues(
             selection,
             fragmentVariableSignatures,
+            maskSuggestions,
             variableValues,
             fragmentVariableValues,
           );
@@ -310,6 +318,7 @@ function getDeferUsage(
   const defer = getDirectiveValues(
     GraphQLDeferDirective,
     node,
+    false,
     variableValues,
     fragmentVariableValues,
   );
@@ -345,6 +354,7 @@ function shouldIncludeNode(
   const skip = getDirectiveValues(
     GraphQLSkipDirective,
     node,
+    false,
     variableValues,
     fragmentVariableValues,
   );
@@ -355,6 +365,7 @@ function shouldIncludeNode(
   const include = getDirectiveValues(
     GraphQLIncludeDirective,
     node,
+    false,
     variableValues,
     fragmentVariableValues,
   );

diff --git a/src/execution/execute.ts b/src/execution/execute.ts
@@ -98,7 +98,7 @@ const collectSubfields = memoize3(
     returnType: GraphQLObjectType,
     fieldDetailsList: FieldDetailsList,
   ) => {
-    const { schema, fragments, operation, variableValues } =
+    const { schema, fragments, operation, variableValues, maskSuggestions } =
       validatedExecutionArgs;
     return _collectSubfields(
       schema,
@@ -107,6 +107,7 @@ const collectSubfields = memoize3(
       operation,
       returnType,
       fieldDetailsList,
+      maskSuggestions,
     );
   },
 );
@@ -155,6 +156,7 @@ export interface ValidatedExecutionArgs {
     validatedExecutionArgs: ValidatedExecutionArgs,
   ) => PromiseOrValue<ExecutionResult>;
   enableEarlyExecution: boolean;
+  maskSuggestions: boolean;
 }
 
 export interface ExecutionContext {
@@ -184,6 +186,7 @@ export interface ExecutionArgs {
     ) => PromiseOrValue<ExecutionResult>
   >;
   enableEarlyExecution?: Maybe<boolean>;
+  maskSuggestions?: Maybe<boolean>;
 }
 
 export interface StreamUsage {
@@ -308,8 +311,14 @@ export function experimentalExecuteQueryOrMutationOrSubscriptionEvent(
     cancellableStreams: undefined,
   };
   try {
-    const { schema, fragments, rootValue, operation, variableValues } =
-      validatedExecutionArgs;
+    const {
+      schema,
+      fragments,
+      rootValue,
+      operation,
+      variableValues,
+      maskSuggestions,
+    } = validatedExecutionArgs;
     const rootType = schema.getRootType(operation.operation);
     if (rootType == null) {
       throw new GraphQLError(
@@ -324,6 +333,7 @@ export function experimentalExecuteQueryOrMutationOrSubscriptionEvent(
       variableValues,
       rootType,
       operation,
+      maskSuggestions,
     );
 
     const { groupedFieldSet, newDeferUsages } = collectedFields;
@@ -554,12 +564,16 @@ 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 },
+    {
+      maxErrors: 50,
+      maskSuggestions,
+    },
   );
 
   if (variableValuesOrErrors.errors) {
@@ -579,6 +593,7 @@ export function validateExecutionArgs(
     subscribeFieldResolver: subscribeFieldResolver ?? defaultFieldResolver,
     perEventExecutor: perEventExecutor ?? executeSubscriptionEvent,
     enableEarlyExecution: enableEarlyExecution === true,
+    maskSuggestions,
   };
 }
 
@@ -762,7 +777,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, maskSuggestions } =
+    validatedExecutionArgs;
   const fieldName = fieldDetailsList[0].node.name.value;
   const fieldDef = schema.getField(parentType, fieldName);
   if (!fieldDef) {
@@ -788,6 +804,7 @@ function executeField(
     const args = experimentalGetArgumentValues(
       fieldDetailsList[0].node,
       fieldDef.args,
+      maskSuggestions,
       variableValues,
       fieldDetailsList[0].fragmentVariableValues,
     );
@@ -1099,6 +1116,7 @@ function getStreamUsage(
   const stream = getDirectiveValues(
     GraphQLStreamDirective,
     fieldDetailsList[0].node,
+    false,
     variableValues,
     fieldDetailsList[0].fragmentVariableValues,
   );
@@ -2065,6 +2083,7 @@ function executeSubscription(
     contextValue,
     operation,
     variableValues,
+    maskSuggestions,
   } = validatedExecutionArgs;
 
   const rootType = schema.getSubscriptionType();
@@ -2081,6 +2100,7 @@ function executeSubscription(
     variableValues,
     rootType,
     operation,
+    maskSuggestions,
   );
 
   const firstRootField = groupedFieldSet.entries().next().value as [
@@ -2114,7 +2134,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],
+      maskSuggestions,
+      variableValues,
+    );
 
     // Call the `subscribe()` resolver or the default resolver to produce an
     // AsyncIterable yielding raw payloads.

diff --git a/src/execution/values.ts b/src/execution/values.ts
@@ -55,10 +55,11 @@ export function getVariableValues(
   schema: GraphQLSchema,
   varDefNodes: ReadonlyArray<VariableDefinitionNode>,
   inputs: { readonly [variable: string]: unknown },
-  options?: { maxErrors?: number },
+  options?: { maxErrors?: number; maskSuggestions?: boolean },
 ): VariableValuesOrErrors {
   const errors: Array<GraphQLError> = [];
   const maxErrors = options?.maxErrors;
+  const maskSuggestions = options?.maskSuggestions;
   try {
     const variableValues = coerceVariableValues(
       schema,
@@ -72,6 +73,7 @@ export function getVariableValues(
         }
         errors.push(error);
       },
+      maskSuggestions,
     );
 
     if (errors.length === 0) {
@@ -89,6 +91,7 @@ function coerceVariableValues(
   varDefNodes: ReadonlyArray<VariableDefinitionNode>,
   inputs: { readonly [variable: string]: unknown },
   onError: (error: GraphQLError) => void,
+  maskSuggestions: boolean | undefined,
 ): VariableValues {
   const sources: ObjMap<VariableValueSource> = Object.create(null);
   const coerced: ObjMap<unknown> = Object.create(null);
@@ -105,7 +108,11 @@ function coerceVariableValues(
       const defaultValue = varSignature.defaultValue;
       if (defaultValue) {
         sources[varName] = { signature: varSignature };
-        coerced[varName] = coerceDefaultValue(defaultValue, varType);
+        coerced[varName] = coerceDefaultValue(
+          defaultValue,
+          varType,
+          maskSuggestions,
+        );
       } else if (isNonNullType(varType)) {
         const varTypeStr = inspect(varType);
         onError(
@@ -136,6 +143,7 @@ function coerceVariableValues(
     coerced[varName] = coerceInputValue(
       value,
       varType,
+      maskSuggestions,
       (path, invalidValue, error) => {
         let prefix =
           `Variable "$${varName}" got invalid value ` + inspect(invalidValue);
@@ -158,6 +166,7 @@ function coerceVariableValues(
 export function getFragmentVariableValues(
   fragmentSpreadNode: FragmentSpreadNode,
   fragmentSignatures: ReadOnlyObjMap<GraphQLVariableSignature>,
+  maskSuggestions: boolean,
   variableValues: VariableValues,
   fragmentVariableValues?: Maybe<VariableValues>,
 ): VariableValues {
@@ -176,6 +185,7 @@ export function getFragmentVariableValues(
   const coerced = experimentalGetArgumentValues(
     fragmentSpreadNode,
     varSignatures,
+    maskSuggestions,
     variableValues,
     fragmentVariableValues,
   );
@@ -194,15 +204,22 @@ export function getFragmentVariableValues(
 export function getArgumentValues(
   def: GraphQLField<unknown, unknown> | GraphQLDirective,
   node: FieldNode | DirectiveNode,
+  maskSuggestions?: boolean | undefined,
   variableValues?: Maybe<VariableValues>,
 ): { [argument: string]: unknown } {
-  return experimentalGetArgumentValues(node, def.args, variableValues);
+  return experimentalGetArgumentValues(
+    node,
+    def.args,
+    maskSuggestions,
+    variableValues,
+  );
 }
 
 export function experimentalGetArgumentValues(
   node: FieldNode | DirectiveNode | FragmentSpreadNode,
   argDefs: ReadonlyArray<GraphQLArgument | GraphQLVariableSignature>,
-  variableValues: Maybe<VariableValues>,
+  maskSuggestions?: boolean | undefined,
+  variableValues?: Maybe<VariableValues>,
   fragmentVariablesValues?: Maybe<VariableValues>,
 ): { [argument: string]: unknown } {
   const coercedValues: { [argument: string]: unknown } = {};
@@ -222,6 +239,7 @@ export function experimentalGetArgumentValues(
         coercedValues[name] = coerceDefaultValue(
           argDef.defaultValue,
           argDef.type,
+          maskSuggestions,
         );
       } else if (isNonNullType(argType)) {
         throw new GraphQLError(
@@ -251,6 +269,7 @@ export function experimentalGetArgumentValues(
           coercedValues[name] = coerceDefaultValue(
             argDef.defaultValue,
             argDef.type,
+            maskSuggestions,
           );
         } else if (isNonNullType(argType)) {
           throw new GraphQLError(
@@ -275,6 +294,7 @@ export function experimentalGetArgumentValues(
     const coercedValue = coerceInputLiteral(
       valueNode,
       argType,
+      maskSuggestions,
       variableValues,
       fragmentVariablesValues,
     );
@@ -308,6 +328,7 @@ export function experimentalGetArgumentValues(
 export function getDirectiveValues(
   directiveDef: GraphQLDirective,
   node: { readonly directives?: ReadonlyArray<DirectiveNode> | undefined },
+  maskSuggestions?: boolean | undefined,
   variableValues?: Maybe<VariableValues>,
   fragmentVariableValues?: Maybe<VariableValues>,
 ): undefined | { [argument: string]: unknown } {
@@ -319,6 +340,7 @@ export function getDirectiveValues(
     return experimentalGetArgumentValues(
       directiveNode,
       directiveDef.args,
+      maskSuggestions,
       variableValues,
       fragmentVariableValues,
     );

diff --git a/src/graphql.ts b/src/graphql.ts
@@ -67,6 +67,7 @@ export interface GraphQLArgs {
   operationName?: Maybe<string>;
   fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
   typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
+  maskSuggestions?: boolean;
 }
 
 export function graphql(args: GraphQLArgs): Promise<ExecutionResult> {
@@ -101,6 +102,7 @@ function graphqlImpl(args: GraphQLArgs): PromiseOrValue<ExecutionResult> {
     operationName,
     fieldResolver,
     typeResolver,
+    maskSuggestions,
   } = args;
 
   // Validate Schema
@@ -118,7 +120,9 @@ function graphqlImpl(args: GraphQLArgs): PromiseOrValue<ExecutionResult> {
   }
 
   // Validate
-  const validationErrors = validate(schema, document);
+  const validationErrors = validate(schema, document, undefined, {
+    maskSuggestions: maskSuggestions ?? false,
+  });
   if (validationErrors.length > 0) {
     return { errors: validationErrors };
   }
@@ -133,5 +137,6 @@ function graphqlImpl(args: GraphQLArgs): PromiseOrValue<ExecutionResult> {
     operationName,
     fieldResolver,
     typeResolver,
+    maskSuggestions,
   });
 }