Add description field to mutationWithClientMutationId

Author: christensenemc

src/mutation/__tests__/mutation.js

@@ -31,6 +31,18 @@ var simpleMutation = mutationWithClientMutationId({
   mutateAndGetPayload: () => ({result: 1})
 });
 
+var simpleMutationWithDescription = mutationWithClientMutationId({
+  name: 'SimpleMutationWithDescription',
+  description: 'Simple Mutation Description',
+  inputFields: {},
+  outputFields: {
+    result: {
+      type: GraphQLInt
+    }
+  },
+  mutateAndGetPayload: () => ({result: 1})
+});
+
 var simpleMutationWithThunkFields = mutationWithClientMutationId({
   name: 'SimpleMutationWithThunkFields',
   inputFields: () => ({
@@ -61,6 +73,7 @@ var mutation = new GraphQLObjectType({
   name: 'Mutation',
   fields: {
     simpleMutation: simpleMutation,
+    simpleMutationWithDescription: simpleMutationWithDescription,
     simpleMutationWithThunkFields: simpleMutationWithThunkFields,
     simplePromiseMutation: simplePromiseMutation
   }
@@ -285,6 +298,26 @@ describe('mutationWithClientMutationId()', () => {
                   kind: 'OBJECT',
                 }
               },
+              {
+                name: 'simpleMutationWithDescription',
+                args: [
+                  {
+                    name: 'input',
+                    type: {
+                      name: null,
+                      kind: 'NON_NULL',
+                      ofType: {
+                        name: 'SimpleMutationWithDescriptionInput',
+                        kind: 'INPUT_OBJECT'
+                      }
+                    },
+                  }
+                ],
+                type: {
+                  name: 'SimpleMutationWithDescriptionPayload',
+                  kind: 'OBJECT',
+                }
+              },
               {
                 name: 'simpleMutationWithThunkFields',
                 args: [
@@ -332,5 +365,44 @@ describe('mutationWithClientMutationId()', () => {
 
       return expect(graphql(schema, query)).to.become({data: expected});
     });
+
+    it('contains correct descriptions', () => {
+      var query = `{
+        __schema {
+          mutationType {
+            fields {
+              name
+              description
+            }
+          }
+        }
+      }`;
+      var expected = {
+        __schema: {
+          mutationType: {
+            fields: [
+              {
+                name: 'simpleMutation',
+                description: ''
+              },
+              {
+                name: 'simpleMutationWithDescription',
+                description: 'Simple Mutation Description'
+              },
+              {
+                name: 'simpleMutationWithThunkFields',
+                description: ''
+              },
+              {
+                name: 'simplePromiseMutation',
+                description: ''
+              },
+            ]
+          }
+        }
+      };
+
+      return expect(graphql(schema, query)).to.become({data: expected});
+    });
   });
 });

src/mutation/mutation.js

@@ -45,6 +45,7 @@ function resolveMaybeThunk<T>(thingOrThunk: T | () => T): T {
  */
 type MutationConfig = {
   name: string,
+  description?: string,
   inputFields: InputObjectConfigFieldMap,
   outputFields: GraphQLFieldConfigMap,
   mutateAndGetPayload: mutationFn,
@@ -58,6 +59,7 @@ export function mutationWithClientMutationId(
   config: MutationConfig
 ): GraphQLFieldConfig {
   var {name, inputFields, outputFields, mutateAndGetPayload} = config;
+  var description = config.description != null ? config.description : '';
   var augmentedInputFields = () => ({
     ...resolveMaybeThunk(inputFields),
     clientMutationId: {
@@ -83,6 +85,7 @@ export function mutationWithClientMutationId(
 
   return {
     type: outputType,
+    description: description,
     args: {
       input: {type: new GraphQLNonNull(inputType)}
     },