node_modules.graphql.utilities.findDeprecatedUsages.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: 1.1.2

Show newest version

/* @flow */
/**
 *  Copyright (c) Facebook, Inc.
 *  All rights reserved.
 *
 *  This source code is licensed under the BSD-style license found in the
 *  LICENSE file in the root directory of this source tree. An additional grant
 *  of patent rights can be found in the PATENTS file in the same directory.
 */

import { GraphQLError } from '../error/GraphQLError';
import { visit, visitWithTypeInfo } from '../language/visitor';
import type { DocumentNode } from '../language/ast';
import { getNamedType } from '../type/definition';
import { GraphQLSchema } from '../type/schema';
import { TypeInfo } from './TypeInfo';

/**
 * A validation rule which reports deprecated usages.
 *
 * Returns a list of GraphQLError instances describing each deprecated use.
 */
export function findDeprecatedUsages(
  schema: GraphQLSchema,
  ast: DocumentNode,
): Array {
  const errors = [];
  const typeInfo = new TypeInfo(schema);

  visit(ast, visitWithTypeInfo(typeInfo, {
    Field(node) {
      const fieldDef = typeInfo.getFieldDef();
      if (fieldDef && fieldDef.isDeprecated) {
        const parentType = typeInfo.getParentType();
        if (parentType) {
          const reason = fieldDef.deprecationReason;
          errors.push(new GraphQLError(
            `The field ${parentType.name}.${fieldDef.name} is deprecated.` +
            (reason ? ' ' + reason : ''),
            [ node ]
          ));
        }
      }
    },
    EnumValue(node) {
      const enumVal = typeInfo.getEnumValue();
      if (enumVal && enumVal.isDeprecated) {
        const type = getNamedType(typeInfo.getInputType());
        if (type) {
          const reason = enumVal.deprecationReason;
          errors.push(new GraphQLError(
            `The enum value ${type.name}.${enumVal.name} is deprecated.` +
            (reason ? ' ' + reason : ''),
            [ node ]
          ));
        }
      }
    }
  }));

  return errors;
}