Merge branch 'christensenemc-master'

Author: leebyron

src/mutation/__tests__/mutation.js

@@ -31,6 +31,18 @@ const simpleMutation = mutationWithClientMutationId({
   mutateAndGetPayload: () => ({result: 1})
 });
 
+const simpleMutationWithDescription = mutationWithClientMutationId({
+  name: 'SimpleMutationWithDescription',
+  description: 'Simple Mutation Description',
+  inputFields: {},
+  outputFields: {
+    result: {
+      type: GraphQLInt
+    }
+  },
+  mutateAndGetPayload: () => ({result: 1})
+});
+
 const simpleMutationWithThunkFields = mutationWithClientMutationId({
   name: 'SimpleMutationWithThunkFields',
   inputFields: () => ({
@@ -79,6 +91,7 @@ const mutationType = new GraphQLObjectType({
   name: 'Mutation',
   fields: {
     simpleMutation,
+    simpleMutationWithDescription,
     simpleMutationWithThunkFields,
     simplePromiseMutation,
     simpleRootValueMutation,
@@ -322,6 +335,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: [
@@ -388,5 +421,49 @@ describe('mutationWithClientMutationId()', () => {
         }
       });
     });
+
+    it('contains correct descriptions', async () => {
+      const query = `{
+        __schema {
+          mutationType {
+            fields {
+              name
+              description
+            }
+          }
+        }
+      }`;
+
+      return expect(await graphql(schema, query)).to.deep.equal({
+        data: {
+          __schema: {
+            mutationType: {
+              fields: [
+                {
+                  name: 'simpleMutation',
+                  description: null
+                },
+                {
+                  name: 'simpleMutationWithDescription',
+                  description: 'Simple Mutation Description'
+                },
+                {
+                  name: 'simpleMutationWithThunkFields',
+                  description: null
+                },
+                {
+                  name: 'simplePromiseMutation',
+                  description: null
+                },
+                {
+                  name: 'simpleRootValueMutation',
+                  description: null
+                }
+              ]
+            }
+          }
+        }
+      });
+    });
   });
 });

src/mutation/mutation.js

@@ -49,6 +49,7 @@ function resolveMaybeThunk<T>(thingOrThunk: Thunk<T>): T {
  */
 type MutationConfig = {
   name: string,
+  description?: string,
   inputFields: Thunk<GraphQLInputFieldConfigMap>,
   outputFields: Thunk<GraphQLFieldConfigMap<*, *>>,
   mutateAndGetPayload: mutationFn,
@@ -61,7 +62,13 @@ type MutationConfig = {
 export function mutationWithClientMutationId(
   config: MutationConfig
 ): GraphQLFieldConfig<*, *> {
-  const { name, inputFields, outputFields, mutateAndGetPayload } = config;
+  const {
+    name,
+    description,
+    inputFields,
+    outputFields,
+    mutateAndGetPayload
+  } = config;
   const augmentedInputFields = () => ({
     ...resolveMaybeThunk(inputFields),
     clientMutationId: {
@@ -87,6 +94,7 @@ export function mutationWithClientMutationId(
 
   return {
     type: outputType,
+    description,
     args: {
       input: {type: new GraphQLNonNull(inputType)}
     },