Support deprecation via introspection

This ensures deprecation information flows throughout introspection back through building client-side schema.

Author: leebyron

src/type/definition.js

@@ -838,11 +838,12 @@ function defineEnumValues(
       `${type}.${valueName} should provide "deprecationReason" instead ` +
       `of "isDeprecated".`
     );
-    value.name = valueName;
-    if (isNullish(value.value)) {
-      value.value = valueName;
-    }
-    return value;
+    return {
+      name: valueName,
+      description: value.description,
+      deprecationReason: value.deprecationReason,
+      value: isNullish(value.value) ? valueName : value.value,
+    };
   });
 }
 
@@ -858,15 +859,15 @@ export type GraphQLEnumValueConfigMap/* <T> */ = {
 
 export type GraphQLEnumValueConfig/* <T> */ = {
   value?: any/* T */;
-  deprecationReason?: string;
+  deprecationReason?: ?string;
   description?: ?string;
 }
 
 export type GraphQLEnumValueDefinition/* <T> */ = {
   name: string;
-  value?: any/* T */;
-  deprecationReason?: string;
-  description?: ?string;
+  description: ?string;
+  deprecationReason: ?string;
+  value: any/* T */;
 }
 
 

src/utilities/__tests__/buildClientSchema.js

@@ -371,21 +371,26 @@ describe('Type System: build schema from introspection', () => {
     // Client types do not get server-only values, so `value` mirrors `name`,
     // rather than using the integers defined in the "server" schema.
     expect(clientFoodEnum.getValues()).to.deep.equal([
-      { description: 'Foods that are vegetables.',
-        name: 'VEGETABLES',
-        value: 'VEGETABLES' },
-      { description: 'Foods that are fruits.',
-        name: 'FRUITS',
-        value: 'FRUITS' },
-      { description: 'Foods that are oils.',
-        name: 'OILS',
-        value: 'OILS' },
-      { description: 'Foods that are dairy.',
-        name: 'DAIRY',
-        value: 'DAIRY' },
-      { description: 'Foods that are meat.',
-        name: 'MEAT',
-        value: 'MEAT' },
+      { name: 'VEGETABLES',
+        value: 'VEGETABLES',
+        description: 'Foods that are vegetables.',
+        deprecationReason: null, },
+      { name: 'FRUITS',
+        value: 'FRUITS',
+        description: 'Foods that are fruits.',
+        deprecationReason: null, },
+      { name: 'OILS',
+        value: 'OILS',
+        description: 'Foods that are oils.',
+        deprecationReason: null, },
+      { name: 'DAIRY',
+        value: 'DAIRY',
+        description: 'Foods that are dairy.',
+        deprecationReason: null, },
+      { name: 'MEAT',
+        value: 'MEAT',
+        description: 'Foods that are meat.',
+        deprecationReason: null, },
     ]);
   });
 
@@ -503,6 +508,44 @@ describe('Type System: build schema from introspection', () => {
     await testSchema(schema);
   });
 
+
+  it('builds a schema aware of deprecation', async () => {
+
+    var schema = new GraphQLSchema({
+      query: new GraphQLObjectType({
+        name: 'Simple',
+        description: 'This is a simple type',
+        fields: {
+          shinyString: {
+            type: GraphQLString,
+            description: 'This is a shiny string field'
+          },
+          deprecatedString: {
+            type: GraphQLString,
+            description: 'This is a deprecated string field',
+            deprecationReason: 'Use shinyString',
+          },
+          color: {
+            type: new GraphQLEnumType({
+              name: 'Color',
+              values: {
+                RED: { description: 'So rosy' },
+                GREEN: { description: 'So grassy' },
+                BLUE: { description: 'So calming' },
+                MAUVE: {
+                  description: 'So sickening',
+                  deprecationReason: 'No longer in fashion'
+                },
+              }
+            })
+          }
+        }
+      })
+    });
+
+    await testSchema(schema);
+  });
+
   it('cannot use client schema for general execution', async () => {
     var customScalar = new GraphQLScalarType({
       name: 'CustomScalar',

src/utilities/buildClientSchema.js

@@ -260,6 +260,7 @@ export function buildClientSchema(
         valueIntrospection => valueIntrospection.name,
         valueIntrospection => ({
           description: valueIntrospection.description,
+          deprecationReason: valueIntrospection.deprecationReason,
         })
       )
     });
@@ -281,6 +282,7 @@ export function buildClientSchema(
       fieldIntrospection => fieldIntrospection.name,
       fieldIntrospection => ({
         description: fieldIntrospection.description,
+        deprecationReason: fieldIntrospection.deprecationReason,
         type: getOutputType(fieldIntrospection.type),
         args: buildInputValueDefMap(fieldIntrospection.args),
         resolve: () => {
@@ -322,8 +324,6 @@ export function buildClientSchema(
     });
   }
 
-  // TODO: deprecation
-
   // Iterate through all types, getting the type definition for each, ensuring
   // that any type not directly referenced by a field will get created.
   schemaIntrospection.types.forEach(

src/utilities/introspectionQuery.js

@@ -34,7 +34,7 @@ export var introspectionQuery = `
     kind
     name
     description
-    fields {
+    fields(includeDeprecated: true) {
       name
       description
       args {
@@ -52,7 +52,7 @@ export var introspectionQuery = `
     interfaces {
       ...TypeRef
     }
-    enumValues {
+    enumValues(includeDeprecated: true) {
       name
       description
       isDeprecated