Support deprecated directive on enum values (#4351)

ardatan · Apr 1, 2022 · 904c084 · 904c084
1 parent 20fec9d
commit 904c084
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/.changeset/grumpy-dragons-cry.md b/.changeset/grumpy-dragons-cry.md
@@ -0,0 +1,5 @@
+---
+'@graphql-tools/utils': patch
+---
+
+Support deprecated directive on enum values
diff --git a/packages/utils/src/print-schema-with-directives.ts b/packages/utils/src/print-schema-with-directives.ts
@@ -256,7 +256,7 @@ export function getDirectiveNodes(
 }
 
 export function getDeprecatableDirectiveNodes(
-  entity: GraphQLArgument | GraphQLField<any, any> | GraphQLInputField,
+  entity: GraphQLArgument | GraphQLField<any, any> | GraphQLInputField | GraphQLEnumValue,
   schema?: GraphQLSchema,
   pathToDirectivesInExtensions?: Array<string>
 ): Array<DirectiveNode> {
@@ -574,7 +574,7 @@ export function astFromEnumValue(
       value: value.name,
     },
     // ConstXNode has been introduced in v16 but it is not compatible with XNode so we do `as any` for backwards compatibility
-    directives: getDirectiveNodes(value, schema, pathToDirectivesInExtensions) as any,
+    directives: getDeprecatableDirectiveNodes(value, schema, pathToDirectivesInExtensions) as any,
   };
 }
 

diff --git a/packages/utils/tests/print-schema-with-directives.spec.ts b/packages/utils/tests/print-schema-with-directives.spec.ts
@@ -4,6 +4,7 @@ import { stitchSchemas } from '@graphql-tools/stitch';
 import {
   buildSchema,
   GraphQLDirective,
+  GraphQLEnumType,
   printSchema,
   GraphQLSchema,
   specifiedDirectives,
@@ -249,6 +250,33 @@ describe('printSchemaWithDirectives', () => {
     expect(output).toContain('directive @dummy on QUERY');
   });
 
+  it(`Should print enum value deprecations correctly if they don't have astNode`, () => {
+    const schema = new GraphQLSchema({
+      query: new GraphQLObjectType({
+        name: 'Query',
+        fields: {},
+      }),
+      types: [
+        new GraphQLEnumType({
+          name: 'Color',
+          values: {
+            RED: {
+              value: 'RED',
+              deprecationReason: 'No longer supported',
+            },
+            BLUE: {
+              value: 'BLUE',
+            },
+          },
+        }),
+      ],
+    });
+
+    const output = printSchemaWithDirectives(schema);
+
+    expect(output).toContain('RED @deprecated(reason: "No longer supported")');
+  });
+
   it('should print comments', () => {
     const schema = makeExecutableSchema({
       typeDefs: /* GraphQL */ `