feat: add default values handling to buildOperationNodeForField (#5269)

* feat: add default values handling to buildOperationNodeForField * Fix * Changeset * Fix v15 --------- Co-authored-by: Arda TANRIKULU <ardatanrikulu@gmail.com>

Author: uroslates

.changeset/gold-eggs-stick.md

@@ -0,0 +1,33 @@
+---
+'@graphql-tools/utils': minor
+---
+
+Add default values to the arguments
+
+When the schema is like following;
+
+```graphql
+type Query {
+ getAllPages(currentPage: Int = 0, pageSize: Int = 10, pageType: getAllPages_pageType = ContentPage, sort: String = "asc"): PagesList
+}
+
+enum getAllPages_pageType {
+ ContentPage
+ CategoryPage
+ CatalogPage
+}
+
+type PagesList {
+ ...
+}
+```
+
+The generated operation will be like following;
+
+```graphql
+query getAllPages_query($currentPage: Int = 0, $pageSize: Int = 10, $pageType: getAllPages_pageType = ContentPage, $sort: String = "asc") {
+ getAllPages(currentPage: $currentPage, pageSize: $pageSize, pageType: $pageType, sort: $sort) {
+ ...
+ }
+}
+```

packages/utils/src/build-operation-for-field.ts

@@ -1,5 +1,6 @@
 import {
  ArgumentNode,
+ astFromValue,
  getNamedType,
  GraphQLArgument,
  GraphQLField,
@@ -27,6 +28,7 @@ import {
  TypeNode,
  VariableDefinitionNode,
 } from 'graphql';
+import { astFromValueUntyped } from './astFromValueUntyped.js';
 import { getDefinedRootType, getRootTypeNames } from './rootTypes.js';
 
 let operationVariables: VariableDefinitionNode[] = [];
@@ -385,6 +387,22 @@ function resolveVariable(arg: GraphQLArgument, name?: string): VariableDefinitio
  };
  }
 
+ let defaultValue: any | undefined;
+ try {
+ const returnVal = astFromValue(arg.defaultValue, arg.type) as any;
+ if (returnVal == null) {
+ defaultValue = undefined;
+ } else {
+ defaultValue = returnVal;
+ }
+ } catch (e) {
+ const returnVal = astFromValueUntyped(arg.defaultValue) as any;
+ if (returnVal == null) {
+ defaultValue = undefined;
+ } else {
+ defaultValue = returnVal;
+ }
+ }
  return {
  kind: Kind.VARIABLE_DEFINITION,
  variable: {
@@ -395,6 +413,7 @@ function resolveVariable(arg: GraphQLArgument, name?: string): VariableDefinitio
  },
  },
  type: resolveVariableType(arg.type),
+ defaultValue,
  };
 }
 

packages/utils/tests/build-operation-node-for-field.spec.ts

@@ -664,3 +664,71 @@ test('should handle array field types used for alias field names', async () => {
  const source = parseGraphQLSDL(`${virtualFileName}.graphql`, rawSDL);
  expect(source).toBeDefined();
 });
+
+test('should work with query with default value arguments', async () => {
+ const document = buildOperationNodeForField({
+ schema: buildSchema(/* GraphQL */ `
+ input PageInfoInput {
+ offset: Int!
+ limit: Int!
+ }
+
+ type User {
+ id: ID
+ name: String
+ }
+
+ type Query {
+ # users(pageInfo: PageInfoInput!): [User]
+ usersSearch(query: String, offset: Int! = 0, limit: Int! = 10): [User]
+ }
+ `),
+ kind: 'query' as OperationTypeNode,
+ field: 'usersSearch',
+ models,
+ ignore: [],
+ })!;
+
+ expect(clean(document)).toEqual(
+ clean(/* GraphQL */ `
+ query usersSearch_query($query: String, $offset: Int! = 0, $limit: Int! = 10) {
+ usersSearch(query: $query, offset: $offset, limit: $limit) {
+ id
+ name
+ }
+ }
+ `),
+ );
+});
+
+test('should work with mutation with default value arguments', async () => {
+ const document = buildOperationNodeForField({
+ schema: buildSchema(/* GraphQL */ `
+ type User {
+ id: ID
+ name: String
+ active: Boolean!
+ }
+
+ type Mutation {
+ addUser(name: String!, active: Boolean = true): [User]
+ }
+ `),
+ kind: 'mutation' as OperationTypeNode,
+ field: 'addUser',
+ models,
+ ignore: [],
+ })!;
+
+ expect(clean(document)).toEqual(
+ clean(/* GraphQL */ `
+ mutation addUser_mutation($name: String!, $active: Boolean = true) {
+ addUser(name: $name, active: $active) {
+ id
+ name
+ active
+ }
+ }
+ `),
+ );
+});