Add deprecated directive to arguments and input values

Author: smitt04

src/type/__tests__/introspection-test.js

@@ -325,7 +325,17 @@ describe('Introspection', () => {
                 },
                 {
                   name: 'inputFields',
-                  args: [],
+                  args: [
+                    {
+                      name: 'includeDeprecated',
+                      type: {
+                        kind: 'SCALAR',
+                        name: 'Boolean',
+                        ofType: null,
+                      },
+                      defaultValue: 'false',
+                    },
+                  ],
                   type: {
                     kind: 'LIST',
                     name: null,
@@ -441,7 +451,17 @@ describe('Introspection', () => {
                 },
                 {
                   name: 'args',
-                  args: [],
+                  args: [
+                    {
+                      name: 'includeDeprecated',
+                      type: {
+                        kind: 'SCALAR',
+                        name: 'Boolean',
+                        ofType: null,
+                      },
+                      defaultValue: 'false',
+                    },
+                  ],
                   type: {
                     kind: 'NON_NULL',
                     name: null,
@@ -565,6 +585,32 @@ describe('Introspection', () => {
                   isDeprecated: false,
                   deprecationReason: null,
                 },
+                {
+                  name: 'isDeprecated',
+                  args: [],
+                  type: {
+                    kind: 'NON_NULL',
+                    name: null,
+                    ofType: {
+                      kind: 'SCALAR',
+                      name: 'Boolean',
+                      ofType: null,
+                    },
+                  },
+                  isDeprecated: false,
+                  deprecationReason: null,
+                },
+                {
+                  name: 'deprecationReason',
+                  args: [],
+                  type: {
+                    kind: 'SCALAR',
+                    name: 'String',
+                    ofType: null,
+                  },
+                  isDeprecated: false,
+                  deprecationReason: null,
+                },
               ],
               inputFields: null,
               interfaces: [],
@@ -880,7 +926,12 @@ describe('Introspection', () => {
             {
               name: 'deprecated',
               isRepeatable: false,
-              locations: ['FIELD_DEFINITION', 'ENUM_VALUE'],
+              locations: [
+                'FIELD_DEFINITION',
+                'ENUM_VALUE',
+                'ARGUMENT_DEFINITION',
+                'INPUT_FIELD_DEFINITION',
+              ],
               args: [
                 {
                   defaultValue: '"No longer supported"',

src/type/definition.js

@@ -948,6 +948,8 @@ export type GraphQLArgumentConfig = {|
   type: GraphQLInputType,
   defaultValue?: mixed,
   extensions?: ?ReadOnlyObjMapLike<mixed>,
+  description?: ?string,
+  deprecationReason?: ?string,
   astNode?: ?InputValueDefinitionNode,
 |};
 
@@ -976,10 +978,13 @@ export type GraphQLArgument = {|
   name: string,
   description: ?string,
   type: GraphQLInputType,
-  defaultValue: mixed,
+  defaultValue?: mixed,
   extensions: ?ReadOnlyObjMap<mixed>,
-  astNode: ?InputValueDefinitionNode,
-|};
+  description?: ?string,
+  isDeprecated?: boolean,
+  deprecationReason?: ?string,
+  astNode?: ?InputValueDefinitionNode,
+};
 
 export function isRequiredArgument(arg: GraphQLArgument): boolean %checks {
   return isNonNullType(arg.type) && arg.defaultValue === undefined;
@@ -1522,7 +1527,15 @@ function defineInputFieldMap(
       `${config.name}.${fieldName} field has a resolve property, but Input Types cannot define resolvers.`,
     );
 
+    invariant(
+      !fieldConfig.hasOwnProperty('isDeprecated'),
+      `${config.name}.${fieldName} should provide "deprecationReason" ` +
+        'instead of "isDeprecated".',
+    );
+
     return {
+      ...fieldConfig,
+      isDeprecated: Boolean(fieldConfig.deprecationReason),
       name: fieldName,
       description: fieldConfig.description,
       type: fieldConfig.type,
@@ -1547,6 +1560,8 @@ export type GraphQLInputFieldConfig = {|
   type: GraphQLInputType,
   defaultValue?: mixed,
   extensions?: ?ReadOnlyObjMapLike<mixed>,
+  description?: ?string,
+  deprecationReason?: ?string,
   astNode?: ?InputValueDefinitionNode,
 |};
 
@@ -1556,10 +1571,13 @@ export type GraphQLInputField = {|
   name: string,
   description: ?string,
   type: GraphQLInputType,
-  defaultValue: mixed,
+  defaultValue?: mixed,
+  description?: ?string,
+  isDeprecated?: boolean,
+  deprecationReason?: ?string,
   extensions: ?ReadOnlyObjMap<mixed>,
-  astNode: ?InputValueDefinitionNode,
-|};
+  astNode?: ?InputValueDefinitionNode,
+};
 
 export function isRequiredInputField(
   field: GraphQLInputField,

src/type/directives.js

@@ -181,7 +181,12 @@ export const DEFAULT_DEPRECATION_REASON = 'No longer supported';
 export const GraphQLDeprecatedDirective = new GraphQLDirective({
   name: 'deprecated',
   description: 'Marks an element of a GraphQL schema as no longer supported.',
-  locations: [DirectiveLocation.FIELD_DEFINITION, DirectiveLocation.ENUM_VALUE],
+  locations: [
+    DirectiveLocation.FIELD_DEFINITION,
+    DirectiveLocation.ENUM_VALUE,
+    DirectiveLocation.ARGUMENT_DEFINITION,
+    DirectiveLocation.INPUT_FIELD_DEFINITION,
+  ],
   args: {
     reason: {
       type: GraphQLString,

src/type/introspection.js

@@ -233,6 +233,18 @@ export const __Type = new GraphQLObjectType({
       name: {
         type: GraphQLString,
         resolve: type => (type.name !== undefined ? type.name : undefined),
+    },
+    description: {
+      type: GraphQLString,
+      resolve: obj => obj.description,
+    },
+    fields: {
+      type: GraphQLList(GraphQLNonNull(__Field)),
+      args: {
+        includeDeprecated: {
+          type: GraphQLBoolean,
+          defaultValue: false,
+        },
       },
       description: {
         type: GraphQLString,
@@ -297,6 +309,23 @@ export const __Type = new GraphQLObjectType({
       ofType: {
         type: __Type,
         resolve: type => (type.ofType !== undefined ? type.ofType : undefined),
+    },
+    inputFields: {
+      type: GraphQLList(GraphQLNonNull(__InputValue)),
+      args: {
+        includeDeprecated: {
+          type: GraphQLBoolean,
+          defaultValue: false,
+        },
+      },
+      resolve(type, { includeDeprecated }) {
+        if (isInputObjectType(type)) {
+          let values = objectValues(type.getFields());
+          if (!includeDeprecated) {
+            values = values.filter(value => !value.deprecationReason);
+          }
+          return values;
+        }
       },
     }: GraphQLFieldConfigMap<GraphQLType, mixed>),
 });
@@ -317,7 +346,22 @@ export const __Field = new GraphQLObjectType({
       },
       args: {
         type: GraphQLNonNull(GraphQLList(GraphQLNonNull(__InputValue))),
-        resolve: field => field.args,
+        args: {
+          includeDeprecated: {
+            type: GraphQLBoolean,
+            defaultValue: false,
+          },
+        },
+        // resolve: field => field.args || [],
+        resolve(field, { includeDeprecated }) {
+          let args = field.args || [];
+  
+          if (!includeDeprecated) {
+            args = args.filter(arg => !arg.deprecationReason);
+          }
+  
+          return args;
+        }
       },
       type: {
         type: GraphQLNonNull(__Type),
@@ -362,6 +406,14 @@ export const __InputValue = new GraphQLObjectType({
           return valueAST ? print(valueAST) : null;
         },
       },
+      isDeprecated: {
+        type: GraphQLNonNull(GraphQLBoolean),
+        resolve: obj => obj.isDeprecated,
+      },
+      deprecationReason: {
+        type: GraphQLString,
+        resolve: obj => obj.deprecationReason,
+      },
     }: GraphQLFieldConfigMap<GraphQLInputField, mixed>),
 });