Add deprecated directive to arguments and input values

smitt04 · smitt04 · commit dfb204e4fdd8 · 2018-10-24T11:23:32.000-07:00
diff --git a/src/type/__tests__/introspection-test.js b/src/type/__tests__/introspection-test.js
@@ -307,7 +307,17 @@ describe('Introspection', () => {
                 },
                 {
                   name: 'inputFields',
-                  args: [],
+                  args: [
+                    {
+                      name: 'includeDeprecated',
+                      type: {
+                        kind: 'SCALAR',
+                        name: 'Boolean',
+                        ofType: null,
+                      },
+                      defaultValue: 'false',
+                    },
+                  ],
                   type: {
                     kind: 'LIST',
                     name: null,
@@ -432,7 +442,17 @@ describe('Introspection', () => {
                 },
                 {
                   name: 'args',
-                  args: [],
+                  args: [
+                    {
+                      name: 'includeDeprecated',
+                      type: {
+                        kind: 'SCALAR',
+                        name: 'Boolean',
+                        ofType: null,
+                      },
+                      defaultValue: 'false',
+                    },
+                  ],
                   type: {
                     kind: 'NON_NULL',
                     name: null,
@@ -556,6 +576,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: [],
@@ -853,7 +899,12 @@ describe('Introspection', () => {
             },
             {
               name: 'deprecated',
-              locations: ['FIELD_DEFINITION', 'ENUM_VALUE'],
+              locations: [
+                'FIELD_DEFINITION',
+                'ENUM_VALUE',
+                'ARGUMENT_DEFINITION',
+                'INPUT_FIELD_DEFINITION',
+              ],
               args: [
                 {
                   defaultValue: '"No longer supported"',
diff --git a/src/type/definition.js b/src/type/definition.js
@@ -827,6 +827,7 @@ export type GraphQLArgumentConfig = {|
   type: GraphQLInputType,
   defaultValue?: mixed,
   description?: ?string,
+  deprecationReason?: ?string,
   astNode?: ?InputValueDefinitionNode,
 |};
 
@@ -855,6 +856,8 @@ export type GraphQLArgument = {
   type: GraphQLInputType,
   defaultValue?: mixed,
   description?: ?string,
+  isDeprecated?: boolean,
+  deprecationReason?: ?string,
   astNode?: ?InputValueDefinitionNode,
 };
 
@@ -1238,8 +1241,15 @@ function defineInputFieldMap(
   );
   const resultFieldMap = Object.create(null);
   for (const fieldName of Object.keys(fieldMap)) {
+    const fieldConfig = fieldMap[fieldName];
+    invariant(
+      !fieldConfig.hasOwnProperty('isDeprecated'),
+      `${config.name}.${fieldName} should provide "deprecationReason" ` +
+        'instead of "isDeprecated".',
+    );
     const field = {
-      ...fieldMap[fieldName],
+      ...fieldConfig,
+      isDeprecated: Boolean(fieldConfig.deprecationReason),
       name: fieldName,
     };
     invariant(
@@ -1264,6 +1274,7 @@ export type GraphQLInputFieldConfig = {|
   type: GraphQLInputType,
   defaultValue?: mixed,
   description?: ?string,
+  deprecationReason?: ?string,
   astNode?: ?InputValueDefinitionNode,
 |};
 
@@ -1274,6 +1285,8 @@ export type GraphQLInputField = {
   type: GraphQLInputType,
   defaultValue?: mixed,
   description?: ?string,
+  isDeprecated?: boolean,
+  deprecationReason?: ?string,
   astNode?: ?InputValueDefinitionNode,
 };
 
diff --git a/src/type/directives.js b/src/type/directives.js
@@ -147,7 +147,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,
diff --git a/src/type/introspection.js b/src/type/introspection.js
@@ -232,7 +232,10 @@ export const __Type = new GraphQLObjectType({
     fields: {
       type: GraphQLList(GraphQLNonNull(__Field)),
       args: {
-        includeDeprecated: { type: GraphQLBoolean, defaultValue: false },
+        includeDeprecated: {
+          type: GraphQLBoolean,
+          defaultValue: false,
+        },
       },
       resolve(type, { includeDeprecated }) {
         if (isObjectType(type) || isInterfaceType(type)) {
@@ -264,7 +267,10 @@ export const __Type = new GraphQLObjectType({
     enumValues: {
       type: GraphQLList(GraphQLNonNull(__EnumValue)),
       args: {
-        includeDeprecated: { type: GraphQLBoolean, defaultValue: false },
+        includeDeprecated: {
+          type: GraphQLBoolean,
+          defaultValue: false,
+        },
       },
       resolve(type, { includeDeprecated }) {
         if (isEnumType(type)) {
@@ -278,9 +284,19 @@ export const __Type = new GraphQLObjectType({
     },
     inputFields: {
       type: GraphQLList(GraphQLNonNull(__InputValue)),
-      resolve(type) {
+      args: {
+        includeDeprecated: {
+          type: GraphQLBoolean,
+          defaultValue: false,
+        },
+      },
+      resolve(type, { includeDeprecated }) {
         if (isInputObjectType(type)) {
-          return objectValues(type.getFields());
+          let values = objectValues(type.getFields());
+          if (!includeDeprecated) {
+            values = values.filter(value => !value.deprecationReason);
+          }
+          return values;
         }
       },
     },
@@ -307,7 +323,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),
@@ -353,6 +384,14 @@ export const __InputValue = new GraphQLObjectType({
           ? null
           : print(astFromValue(inputVal.defaultValue, inputVal.type)),
     },
+    isDeprecated: {
+      type: GraphQLNonNull(GraphQLBoolean),
+      resolve: obj => obj.isDeprecated,
+    },
+    deprecationReason: {
+      type: GraphQLString,
+      resolve: obj => obj.deprecationReason,
+    },
   }),
 });
 
diff --git a/src/utilities/__tests__/schemaPrinter-test.js b/src/utilities/__tests__/schemaPrinter-test.js
@@ -635,7 +635,7 @@ describe('Type System Printer', () => {
         (as specified by [CommonMark](https://commonmark.org/).
         """
         reason: String = "No longer supported"
-      ) on FIELD_DEFINITION | ENUM_VALUE
+      ) on FIELD_DEFINITION | ENUM_VALUE | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION
 
       """
       A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
@@ -734,7 +734,7 @@ describe('Type System Printer', () => {
       type __Field {
         name: String!
         description: String
-        args: [__InputValue!]!
+        args(includeDeprecated: Boolean = false): [__InputValue!]!
         type: __Type!
         isDeprecated: Boolean!
         deprecationReason: String
@@ -754,6 +754,8 @@ describe('Type System Printer', () => {
         A GraphQL-formatted string representing the default value for this input value.
         """
         defaultValue: String
+        isDeprecated: Boolean!
+        deprecationReason: String
       }
 
       """
@@ -800,7 +802,7 @@ describe('Type System Printer', () => {
         interfaces: [__Type!]
         possibleTypes: [__Type!]
         enumValues(includeDeprecated: Boolean = false): [__EnumValue!]
-        inputFields: [__InputValue!]
+        inputFields(includeDeprecated: Boolean = false): [__InputValue!]
         ofType: __Type
       }
 
@@ -870,7 +872,7 @@ describe('Type System Printer', () => {
         # for how to access supported similar data. Formatted using the Markdown syntax
         # (as specified by [CommonMark](https://commonmark.org/).
         reason: String = "No longer supported"
-      ) on FIELD_DEFINITION | ENUM_VALUE
+      ) on FIELD_DEFINITION | ENUM_VALUE | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION
 
       # A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
       #
@@ -961,7 +963,7 @@ describe('Type System Printer', () => {
       type __Field {
         name: String!
         description: String
-        args: [__InputValue!]!
+        args(includeDeprecated: Boolean = false): [__InputValue!]!
         type: __Type!
         isDeprecated: Boolean!
         deprecationReason: String
@@ -977,6 +979,8 @@ describe('Type System Printer', () => {
 
         # A GraphQL-formatted string representing the default value for this input value.
         defaultValue: String
+        isDeprecated: Boolean!
+        deprecationReason: String
       }
 
       # A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all
@@ -1015,7 +1019,7 @@ describe('Type System Printer', () => {
         interfaces: [__Type!]
         possibleTypes: [__Type!]
         enumValues(includeDeprecated: Boolean = false): [__EnumValue!]
-        inputFields: [__InputValue!]
+        inputFields(includeDeprecated: Boolean = false): [__InputValue!]
         ofType: __Type
       }
 
diff --git a/src/utilities/buildASTSchema.js b/src/utilities/buildASTSchema.js
@@ -441,7 +441,10 @@ export class ASTDefinitionBuilder {
  * deprecation reason.
  */
 function getDeprecationReason(
-  node: EnumValueDefinitionNode | FieldDefinitionNode,
+  node:
+    | EnumValueDefinitionNode
+    | FieldDefinitionNode
+    | InputValueDefinitionNode,
 ): ?string {
   const deprecated = getDirectiveValues(GraphQLDeprecatedDirective, node);
   return deprecated && (deprecated.reason: any);
