Add support for deprecating arguments to makeExtendSchemaPlugin

graphile · Feb 1, 2024 · e427272 · e427272
1 parent 941e280
commit e427272
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/graphile-build/graphile-utils/src/makeExtendSchemaPlugin.ts b/graphile-build/graphile-utils/src/makeExtendSchemaPlugin.ts
@@ -9,6 +9,7 @@ import type {
   EnumTypeDefinitionNode,
   EnumValueDefinitionNode,
   FieldDefinitionNode,
+  GraphQLArgumentConfig,
   GraphQLDirective,
   GraphQLEnumType,
   // Config:
@@ -1001,11 +1002,17 @@ export function makeExtendSchemaPlugin(
           if (arg.defaultValue) {
             defaultValue = getValue(arg.defaultValue, type);
           }
+          const argDirectives = getDirectives(arg.directives);
+          const deprecatedDirective = argDirectives.find(
+            (d) => d.directiveName === "deprecated",
+          );
+          const deprecationReason = deprecatedDirective?.args.reason;
           memo[name] = {
             type,
+            deprecationReason,
             ...(defaultValue != null ? { defaultValue } : null),
             ...(description ? { description } : null),
-          };
+          } as GraphQLArgumentConfig;
         } else {
           throw new Error(
             `Unexpected '${arg.kind}', we were expecting an 'InputValueDefinition'`,

diff --git a/postgraphile/postgraphile/graphile.config.ts b/postgraphile/postgraphile/graphile.config.ts
@@ -206,7 +206,9 @@ const preset: GraphileConfig.Preset = {
       return {
         typeDefs: gql`
           extend type Person {
-            greet(greeting: String! = "Hello"): String
+            greet(
+              greeting: String! = "Hello" @deprecated(reason: "TESTING")
+            ): String
             query: Query
           }
         `,