feat(schema): unify generateFromMetadata and check schema synchronously

Author: MichalLytek

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features
 - **Breaking Change**: `AuthChecker` type is now "function or class" - update to `AuthCheckerFn` if the function form is needed in the code
 - **Breaking Change**: update `graphql-js` peer dependency to `^16.6.0`
+- **Breaking Change**: `buildSchemaSync` is now also checking the generated schema for errors
 - support class-based auth checker, which allows for dependency injection
 - allow defining directives for interface types and theirs fields, with inheritance for object types fields (#744)
 - allow deprecating input fields and args (#794)

src/schema/schema-generator.ts

@@ -9,7 +9,7 @@ import {
   GraphQLInputType,
   GraphQLInputFieldConfigMap,
   GraphQLInterfaceType,
-  graphql,
+  graphqlSync,
   getIntrospectionQuery,
   GraphQLEnumType,
   GraphQLEnumValueConfigMap,
@@ -108,18 +108,7 @@ export abstract class SchemaGenerator {
   private static unionTypesInfo: UnionTypeInfo[] = [];
   private static usedInterfaceTypes = new Set<Function>();
 
-  static async generateFromMetadata(options: SchemaGeneratorOptions): Promise<GraphQLSchema> {
-    const schema = this.generateFromMetadataSync(options);
-    if (!options.skipCheck) {
-      const { errors } = await graphql({ schema, source: getIntrospectionQuery() });
-      if (errors) {
-        throw new GeneratingSchemaError(errors);
-      }
-    }
-    return schema;
-  }
-
-  static generateFromMetadataSync(options: SchemaGeneratorOptions): GraphQLSchema {
+  static generateFromMetadata(options: SchemaGeneratorOptions): GraphQLSchema {
     this.checkForErrors(options);
     BuildContext.create(options);
     getMetadataStorage().build(options);
@@ -140,6 +129,14 @@ export abstract class SchemaGenerator {
 
     BuildContext.reset();
     this.usedInterfaceTypes = new Set<Function>();
+
+    if (!options.skipCheck) {
+      const { errors } = graphqlSync({ schema: finalSchema, source: getIntrospectionQuery() });
+      if (errors) {
+        throw new GeneratingSchemaError(errors);
+      }
+    }
+
     return finalSchema;
   }
 

src/utils/buildSchema.ts

@@ -27,7 +27,7 @@ export interface BuildSchemaOptions extends Omit<SchemaGeneratorOptions, "resolv
 
 export async function buildSchema(options: BuildSchemaOptions): Promise<GraphQLSchema> {
   const resolvers = loadResolvers(options);
-  const schema = await SchemaGenerator.generateFromMetadata({ ...options, resolvers });
+  const schema = SchemaGenerator.generateFromMetadata({ ...options, resolvers });
   if (options.emitSchemaFile) {
     const { schemaFileName, printSchemaOptions } = getEmitSchemaDefinitionFileOptions(options);
     await emitSchemaDefinitionFile(schemaFileName, schema, printSchemaOptions);
@@ -37,7 +37,7 @@ export async function buildSchema(options: BuildSchemaOptions): Promise<GraphQLS
 
 export function buildSchemaSync(options: BuildSchemaOptions): GraphQLSchema {
   const resolvers = loadResolvers(options);
-  const schema = SchemaGenerator.generateFromMetadataSync({ ...options, resolvers });
+  const schema = SchemaGenerator.generateFromMetadata({ ...options, resolvers });
   if (options.emitSchemaFile) {
     const { schemaFileName, printSchemaOptions } = getEmitSchemaDefinitionFileOptions(options);
     emitSchemaDefinitionFileSync(schemaFileName, schema, printSchemaOptions);