Add deprecated directive to arguments and input values

smitt04 · modosc · commit 1d5850f9363d · 2020-02-26T12:10:39.000-08:00
diff --git a/src/type/__tests__/introspection-test.js b/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"',
diff --git a/src/type/definition.js b/src/type/definition.js
@@ -949,6 +949,7 @@ export type GraphQLArgumentConfig = {|
   type: GraphQLInputType,
   defaultValue?: mixed,
   extensions?: ?ReadOnlyObjMapLike<mixed>,
+  deprecationReason?: ?string,
   astNode?: ?InputValueDefinitionNode,
 |};
 
@@ -978,6 +979,8 @@ export type GraphQLArgument = {|
   description: ?string,
   type: GraphQLInputType,
   defaultValue: mixed,
+  isDeprecated?:boolean,
+  deprecationReason?: ? string,
   extensions: ?ReadOnlyObjMap<mixed>,
   astNode: ?InputValueDefinitionNode,
 |};
@@ -1517,13 +1520,20 @@ function defineInputFieldMap(
     isPlainObj(fieldMap),
     `${config.name} fields must be an object with field names as keys or a function which returns such an object.`,
   );
+
   return mapValue(fieldMap, (fieldConfig, fieldName) => {
     devAssert(
       !('resolve' in fieldConfig),
       `${config.name}.${fieldName} field has a resolve property, but Input Types cannot define resolvers.`,
     );
+    devAssert(
+      !fieldConfig.hasOwnProperty('isDeprecated'),
+      `${config.name}.${fieldName} should provide "deprecationReason" `+
+      'instead of "isDeprecated".',
+    );
 
     return {
+      isDeprecated: Boolean(fieldConfig.deprecationReason),
       name: fieldName,
       description: fieldConfig.description,
       type: fieldConfig.type,
@@ -1547,6 +1557,7 @@ export type GraphQLInputFieldConfig = {|
   description?: ?string,
   type: GraphQLInputType,
   defaultValue?: mixed,
+  deprecationReason?: ? string,
   extensions?: ?ReadOnlyObjMapLike<mixed>,
   astNode?: ?InputValueDefinitionNode,
 |};
@@ -1558,6 +1569,8 @@ export type GraphQLInputField = {|
   description: ?string,
   type: GraphQLInputType,
   defaultValue: mixed,
+  isDeprecated?:boolean,
+  deprecationReason?: ?string,
   extensions: ?ReadOnlyObjMap<mixed>,
   astNode: ?InputValueDefinitionNode,
 |};
diff --git a/src/type/directives.js b/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,
diff --git a/src/type/introspection.js b/src/type/introspection.js
@@ -288,9 +288,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;
           }
         },
       },
@@ -317,7 +327,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 +387,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>),
 });
 
diff --git a/src/utilities/__tests__/schemaPrinter-test.js b/src/utilities/__tests__/schemaPrinter-test.js
@@ -637,7 +637,7 @@ describe('Type System Printer', () => {
         Explains why this element was deprecated, usually also including a suggestion 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 GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
@@ -721,7 +721,7 @@ describe('Type System Printer', () => {
       type __Field {
         name: String!
         description: String
-        args: [__InputValue!]!
+        args(includeDeprecated: Boolean = false): [__InputValue!]!
         type: __Type!
         isDeprecated: Boolean!
         deprecationReason: String
@@ -739,6 +739,8 @@ describe('Type System Printer', () => {
         A GraphQL-formatted string representing the default value for this input value.
         """
         defaultValue: String
+        isDeprecated: Boolean!
+        deprecationReason: String
       }
 
       """
@@ -851,7 +853,7 @@ describe('Type System Printer', () => {
       directive @deprecated(
         # Explains why this element was deprecated, usually also including a suggestion 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 GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
       type __Schema {
@@ -933,6 +935,8 @@ describe('Type System Printer', () => {
 
         # A GraphQL-formatted string representing the default value for this input value.
         defaultValue: String
+        isDeprecated: Boolean!
+        deprecationReason: String
       }
 
       # One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
