Generalize defineArguments() (#3050)

Fields and Directives both define arguments according to identical logic. This generalizes that and shares the implementation across both constructions.
graphql · Apr 27, 2021 · 917befd · 917befd
1 parent 2d48fbb
commit 917befd
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 23 deletions.
diff --git a/src/type/definition.js b/src/type/definition.js
@@ -809,21 +809,11 @@ function defineFieldMap<TSource, TContext>(
       `${config.name}.${fieldName} args must be an object with argument names as keys.`,
     );
 
-    const args = Object.entries(argsConfig).map(([argName, argConfig]) => ({
-      name: argName,
-      description: argConfig.description,
-      type: argConfig.type,
-      defaultValue: argConfig.defaultValue,
-      deprecationReason: argConfig.deprecationReason,
-      extensions: argConfig.extensions && toObjMap(argConfig.extensions),
-      astNode: argConfig.astNode,
-    }));
-
     return {
       name: fieldName,
       description: fieldConfig.description,
       type: fieldConfig.type,
-      args,
+      args: defineArguments(argsConfig),
       resolve: fieldConfig.resolve,
       subscribe: fieldConfig.subscribe,
       deprecationReason: fieldConfig.deprecationReason,
@@ -833,6 +823,20 @@ function defineFieldMap<TSource, TContext>(
   });
 }
 
+export function defineArguments(
+  config: GraphQLFieldConfigArgumentMap,
+): $ReadOnlyArray<GraphQLArgument> {
+  return Object.entries(config).map(([argName, argConfig]) => ({
+    name: argName,
+    description: argConfig.description,
+    type: argConfig.type,
+    defaultValue: argConfig.defaultValue,
+    deprecationReason: argConfig.deprecationReason,
+    extensions: argConfig.extensions && toObjMap(argConfig.extensions),
+    astNode: argConfig.astNode,
+  }));
+}
+
 function isPlainObj(obj: mixed): boolean {
   return isObjectLike(obj) && !Array.isArray(obj);
 }

diff --git a/src/type/directives.js b/src/type/directives.js
@@ -14,7 +14,11 @@ import type {
   GraphQLFieldConfigArgumentMap,
 } from './definition';
 import { GraphQLString, GraphQLBoolean } from './scalars';
-import { argsToArgsConfig, GraphQLNonNull } from './definition';
+import {
+  defineArguments,
+  argsToArgsConfig,
+  GraphQLNonNull,
+} from './definition';
 
 /**
  * Test if the given value is a GraphQL directive.
@@ -44,7 +48,7 @@ export class GraphQLDirective {
   name: string;
   description: ?string;
   locations: Array<DirectiveLocationEnum>;
-  args: Array<GraphQLArgument>;
+  args: $ReadOnlyArray<GraphQLArgument>;
   isRepeatable: boolean;
   extensions: ?ReadOnlyObjMap<mixed>;
   astNode: ?DirectiveDefinitionNode;
@@ -69,15 +73,7 @@ export class GraphQLDirective {
       `@${config.name} args must be an object with argument names as keys.`,
     );
 
-    this.args = Object.entries(args).map(([argName, argConfig]) => ({
-      name: argName,
-      description: argConfig.description,
-      type: argConfig.type,
-      defaultValue: argConfig.defaultValue,
-      deprecationReason: argConfig.deprecationReason,
-      extensions: argConfig.extensions && toObjMap(argConfig.extensions),
-      astNode: argConfig.astNode,
-    }));
+    this.args = defineArguments(args);
   }
 
   toConfig(): GraphQLDirectiveNormalizedConfig {

diff --git a/src/utilities/printSchema.js b/src/utilities/printSchema.js
@@ -228,7 +228,7 @@ function printBlock(items: $ReadOnlyArray<string>): string {
 }
 
 function printArgs(
-  args: Array<GraphQLArgument>,
+  args: $ReadOnlyArray<GraphQLArgument>,
   indentation: string = '',
 ): string {
   if (args.length === 0) {