node_modules.graphql.validation.rules.VariablesDefaultValueAllowed.js.flow Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apollo-client-maven-plugin Show documentation

Maven plugin for generating graphql clients

There is a newer version: 3.3.1

Show newest version

/**
 * Copyright (c) 2015-present, Facebook, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow strict
 */

import type ValidationContext from '../ValidationContext';
import { GraphQLError } from '../../error';
import type { ASTVisitor } from '../../language/visitor';
import { isNonNullType } from '../../type/definition';
import type { GraphQLType } from '../../type/definition';

export function defaultForRequiredVarMessage(
  varName: string,
  type: GraphQLType,
  guessType: GraphQLType,
): string {
  return (
    `Variable "$${varName}" of type "${String(type)}" is required and ` +
    'will not use the default value. ' +
    `Perhaps you meant to use type "${String(guessType)}".`
  );
}

/**
 * Variable's default value is allowed
 *
 * A GraphQL document is only valid if all variable default values are allowed
 * due to a variable not being required.
 */
export function VariablesDefaultValueAllowed(
  context: ValidationContext,
): ASTVisitor {
  return {
    VariableDefinition(node) {
      const name = node.variable.name.value;
      const defaultValue = node.defaultValue;
      const type = context.getInputType();
      if (isNonNullType(type) && defaultValue) {
        context.reportError(
          new GraphQLError(
            defaultForRequiredVarMessage(name, type, type.ofType),
            [defaultValue],
          ),
        );
      }
      return false; // Do not traverse further.
    },
    SelectionSet: () => false,
    FragmentDefinition: () => false,
  };
}