Small refactor and fixes in printSchemaWithDirectives and improvements in other packages (#2611)

ardatan · web-flow · commit 8f331aaa3c45 · 2021-02-18T10:24:25.000-05:00
* somework

* changeset
diff --git a/.changeset/heavy-peaches-search.md b/.changeset/heavy-peaches-search.md
@@ -0,0 +1,5 @@
+---
+'@graphql-tools/utils': patch
+---
+
+fix(utils): fix missing default value of input object type field
diff --git a/.changeset/sweet-humans-draw.md b/.changeset/sweet-humans-draw.md
@@ -0,0 +1,5 @@
+---
+'@graphql-tools/utils': minor
+---
+
+enhance(utils): Extract getDocumentNodeFromSchema from printSchemaWithDirectives
diff --git a/.changeset/young-chairs-float.md b/.changeset/young-chairs-float.md
@@ -0,0 +1,7 @@
+---
+'@graphql-tools/load': patch
+'@graphql-tools/module-loader': patch
+'@graphql-tools/merge': patch
+---
+
+enhance(load/module-loader/merge): use getDocumentNodeFromSchema instead of parse and printSchemaWithDirectives together
diff --git a/packages/load/package.json b/packages/load/package.json
@@ -26,7 +26,7 @@
     "graphql-type-json": "0.3.2"
   },
   "dependencies": {
-    "@graphql-tools/utils": "^7.0.0",
+    "@graphql-tools/utils": "^7.3.0",
     "@graphql-tools/merge": "^6.2.5",
     "globby": "11.0.2",
     "import-from": "3.0.0",
diff --git a/packages/load/src/load-typedefs/collect-sources.ts b/packages/load/src/load-typedefs/collect-sources.ts
@@ -1,5 +1,5 @@
-import { Source, isDocumentString, parseGraphQLSDL, asArray, printSchemaWithDirectives } from '@graphql-tools/utils';
-import { isSchema, Kind, parse } from 'graphql';
+import { Source, isDocumentString, parseGraphQLSDL, asArray, getDocumentNodeFromSchema } from '@graphql-tools/utils';
+import { isSchema, Kind } from 'graphql';
 import isGlob from 'is-glob';
 import { LoadTypedefsOptions } from '../load-typedefs';
 import { loadFile, loadFileSync } from './load-file';
@@ -296,7 +296,7 @@ function addResultOfCustomLoader({
       source: {
         location: pointer,
         schema: result,
-        document: parse(printSchemaWithDirectives(result)),
+        document: getDocumentNodeFromSchema(result),
       },
       pointer,
       noCache: true,
diff --git a/packages/loaders/module/package.json b/packages/loaders/module/package.json
@@ -20,7 +20,7 @@
     "graphql": "^14.0.0 || ^15.0.0"
   },
   "dependencies": {
-    "@graphql-tools/utils": "^7.0.0",
+    "@graphql-tools/utils": "^7.3.0",
     "tslib": "~2.1.0"
   },
   "publishConfig": {
diff --git a/packages/loaders/module/src/index.ts b/packages/loaders/module/src/index.ts
@@ -2,7 +2,7 @@ import { parse, isSchema } from 'graphql';
 import {
   UniversalLoader,
   fixSchemaAst,
-  printSchemaWithDirectives,
+  getDocumentNodeFromSchema,
   SingleFileOptions,
   Source,
 } from '@graphql-tools/utils';
@@ -86,7 +86,7 @@ export class ModuleLoader implements UniversalLoader {
       return {
         schema,
         get document() {
-          return parse(printSchemaWithDirectives(schema, options));
+          return getDocumentNodeFromSchema(schema);
         },
         location: pointer,
       };
diff --git a/packages/merge/package.json b/packages/merge/package.json
@@ -24,7 +24,7 @@
   },
   "dependencies": {
     "@graphql-tools/schema": "^7.0.0",
-    "@graphql-tools/utils": "^7.0.0",
+    "@graphql-tools/utils": "^7.3.0",
     "tslib": "~2.1.0"
   },
   "publishConfig": {
diff --git a/packages/merge/src/typedefs-mergers/merge-typedefs.ts b/packages/merge/src/typedefs-mergers/merge-typedefs.ts
@@ -2,7 +2,7 @@ import { DefinitionNode, DocumentNode, GraphQLSchema, parse, Source, Kind, isSch
 import { isSourceTypes, isStringTypes, isSchemaDefinition } from './utils';
 import { MergedResultMap, mergeGraphQLNodes } from './merge-nodes';
 import { resetComments, printWithComments } from './comments';
-import { createSchemaDefinition, printSchemaWithDirectives } from '@graphql-tools/utils';
+import { createSchemaDefinition, getDocumentNodeFromSchema } from '@graphql-tools/utils';
 
 type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
 type CompareFn<T> = (a: T, b: T) => number;
@@ -115,7 +115,7 @@ export function mergeGraphQLTypes(
         type = mergeTypeDefs(type);
       }
       if (isSchema(type)) {
-        return parse(printSchemaWithDirectives(type));
+        return getDocumentNodeFromSchema(type);
       } else if (isStringTypes(type) || isSourceTypes(type)) {
         return parse(type);
       }
diff --git a/packages/utils/src/isDocumentNode.ts b/packages/utils/src/isDocumentNode.ts
@@ -1,5 +1,5 @@
-import { ASTNode, DocumentNode } from 'graphql';
+import { DocumentNode, Kind } from 'graphql';
 
 export function isDocumentNode(object: any): object is DocumentNode {
-  return (object as ASTNode).kind !== undefined;
+  return object && typeof object === 'object' && 'kind' in object && object.kind === Kind.DOCUMENT;
 }
diff --git a/packages/utils/src/print-schema-with-directives.ts b/packages/utils/src/print-schema-with-directives.ts
@@ -45,25 +45,25 @@ import {
   GraphQLScalarType,
   ScalarTypeDefinitionNode,
   StringValueNode,
+  DefinitionNode,
+  DocumentNode,
 } from 'graphql';
-import { PrintSchemaWithDirectivesOptions } from './types';
+import { GetDocumentNodeFromSchemaOptions, PrintSchemaWithDirectivesOptions } from './types';
 
 import { astFromType } from './astFromType';
 import { getDirectivesInExtensions } from './get-directives';
 import { astFromValueUntyped } from './astFromValueUntyped';
 
-// this approach uses the default schema printer rather than a custom solution, so may be more backwards compatible
-// currently does not allow customization of printSchema options having to do with comments.
-export function printSchemaWithDirectives(
+export function getDocumentNodeFromSchema(
   schema: GraphQLSchema,
-  options: PrintSchemaWithDirectivesOptions = {}
-): string {
+  options: GetDocumentNodeFromSchemaOptions = {}
+): DocumentNode {
   const pathToDirectivesInExtensions = options.pathToDirectivesInExtensions;
 
   const typesMap = schema.getTypeMap();
 
   const schemaNode = astFromSchema(schema, pathToDirectivesInExtensions);
-  const result: Array<string> = schemaNode != null ? [print(schemaNode)] : [];
+  const definitions: Array<DefinitionNode> = schemaNode != null ? [schemaNode] : [];
 
   for (const typeName in typesMap) {
     const type = typesMap[typeName];
@@ -75,17 +75,17 @@ export function printSchemaWithDirectives(
     }
 
     if (isObjectType(type)) {
-      result.push(print(astFromObjectType(type, schema, pathToDirectivesInExtensions)));
+      definitions.push(astFromObjectType(type, schema, pathToDirectivesInExtensions));
     } else if (isInterfaceType(type)) {
-      result.push(print(astFromInterfaceType(type, schema, pathToDirectivesInExtensions)));
+      definitions.push(astFromInterfaceType(type, schema, pathToDirectivesInExtensions));
     } else if (isUnionType(type)) {
-      result.push(print(astFromUnionType(type, schema, pathToDirectivesInExtensions)));
+      definitions.push(astFromUnionType(type, schema, pathToDirectivesInExtensions));
     } else if (isInputObjectType(type)) {
-      result.push(print(astFromInputObjectType(type, schema, pathToDirectivesInExtensions)));
+      definitions.push(astFromInputObjectType(type, schema, pathToDirectivesInExtensions));
     } else if (isEnumType(type)) {
-      result.push(print(astFromEnumType(type, schema, pathToDirectivesInExtensions)));
+      definitions.push(astFromEnumType(type, schema, pathToDirectivesInExtensions));
     } else if (isScalarType(type)) {
-      result.push(print(astFromScalarType(type, schema, pathToDirectivesInExtensions)));
+      definitions.push(astFromScalarType(type, schema, pathToDirectivesInExtensions));
     } else {
       throw new Error(`Unknown type ${type}.`);
     }
@@ -97,10 +97,23 @@ export function printSchemaWithDirectives(
       continue;
     }
 
-    result.push(print(astFromDirective(directive, schema, pathToDirectivesInExtensions)));
+    definitions.push(astFromDirective(directive, schema, pathToDirectivesInExtensions));
   }
 
-  return result.join('\n');
+  return {
+    kind: Kind.DOCUMENT,
+    definitions,
+  };
+}
+
+// this approach uses the default schema printer rather than a custom solution, so may be more backwards compatible
+// currently does not allow customization of printSchema options having to do with comments.
+export function printSchemaWithDirectives(
+  schema: GraphQLSchema,
+  options: PrintSchemaWithDirectivesOptions = {}
+): string {
+  const documentNode = getDocumentNodeFromSchema(schema, options);
+  return print(documentNode);
 }
 
 export function astFromSchema(
@@ -431,7 +444,7 @@ export function astFromEnumType(
   };
 }
 
-function astFromScalarType(
+export function astFromScalarType(
   type: GraphQLScalarType,
   schema: GraphQLSchema,
   pathToDirectivesInExtensions: Array<string>
@@ -454,7 +467,7 @@ function astFromScalarType(
   };
 }
 
-function astFromField(
+export function astFromField(
   field: GraphQLField<any, any>,
   schema: GraphQLSchema,
   pathToDirectivesInExtensions: Array<string>
@@ -479,7 +492,7 @@ function astFromField(
   };
 }
 
-function astFromInputField(
+export function astFromInputField(
   field: GraphQLInputField,
   schema: GraphQLSchema,
   pathToDirectivesInExtensions: Array<string>
@@ -500,10 +513,11 @@ function astFromInputField(
     },
     type: astFromType(field.type),
     directives: getDeprecatableDirectiveNodes(field, schema, pathToDirectivesInExtensions),
+    defaultValue: astFromValue(field.defaultValue, field.type),
   };
 }
 
-function astFromEnumValue(
+export function astFromEnumValue(
   value: GraphQLEnumValue,
   schema: GraphQLSchema,
   pathToDirectivesInExtensions: Array<string>
diff --git a/packages/utils/src/types.ts b/packages/utils/src/types.ts
@@ -12,10 +12,12 @@ export interface SchemaPrintOptions {
   commentDescriptions?: boolean;
 }
 
-export interface PrintSchemaWithDirectivesOptions extends SchemaPrintOptions {
+export interface GetDocumentNodeFromSchemaOptions {
   pathToDirectivesInExtensions?: Array<string>;
 }
 
+export type PrintSchemaWithDirectivesOptions = SchemaPrintOptions & GetDocumentNodeFromSchemaOptions;
+
 export type Maybe<T> = null | undefined | T;
 
 export type Constructor<T> = new (...args: any[]) => T;
diff --git a/packages/utils/tests/print-schema-with-directives.spec.ts b/packages/utils/tests/print-schema-with-directives.spec.ts
@@ -319,6 +319,7 @@ describe('printSchemaWithDirectives', () => {
 
         input SomeInputType @INPUT_OBJECT {
           someInputField: String @INPUT_FIELD_DEFINITION
+          someOtherInputField: Int = 1
         }
     `;
     const schema = buildSchema(typeDefs);

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-tools/utils': patch
 +---
++
 +fix(utils): fix missing default value of input object type field
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`		`-import { ASTNode, DocumentNode } from 'graphql';`
	`1`	`+import { DocumentNode, Kind } from 'graphql';`
`2`	`2`
`3`	`3`	`export function isDocumentNode(object: any): object is DocumentNode {`
`4`		`- return (object as ASTNode).kind !== undefined;`
	`4`	`+ return object && typeof object === 'object' && 'kind' in object && object.kind === Kind.DOCUMENT;`
`5`	`5`	`}`