skip empty schema files

skip empty document files

jest.config.js

@@ -2,4 +2,9 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   testPathIgnorePatterns: ['/node_modules/', '/test-assets'],
+  globals: {
+    'ts-jest': {
+      diagnostics: false,
+    }
+  }
 };

src/loaders/documents/documents-from-glob.ts

@@ -35,6 +35,12 @@ export class DocumentsFromGlob implements DocumentLoader {
       const fileContent = readFileSync(filePath, 'utf8');
       const fileExt = extname(filePath);
 
+      if (!fileContent || fileContent.trim() === '') {
+        console['warn'](`Empty file found: "${filePath}", skipping...`);
+
+        return null;
+      }
+
       if (graphQLExtensions.includes(fileExt)) {
         return parse(new Source(fileContent, filePath));
       }

src/loaders/schema/schema-from-typedefs.ts

@@ -5,7 +5,6 @@ import * as isValidPath from 'is-valid-path';
 import { DocumentNode, parse, Source } from 'graphql';
 import * as glob from 'glob';
 import { readFileSync } from 'fs';
-import { extname } from 'path';
 import { extractDocumentStringFromCodeFile } from '../../utils/extract-document-string-from-code-file';
 
 export const graphQLExtensions = ['.graphql', '.graphqls', '.gql'];
@@ -15,23 +14,27 @@ function isGraphQLFile(globPath: string): boolean {
 }
 
 function loadSchemaFile(filepath: string): string {
-  const content = readFileSync(filepath, {
-    encoding: 'utf-8',
-  });
+  const content = readFileSync(filepath, 'utf-8');
 
-  if (/^\# import /i.test(content.trimLeft())) {
-    const { importSchema } = require('graphql-import');
+  if (content && content.trim() !== '') {
+    if (/^\#.*import /i.test(content.trimLeft())) {
+      const { importSchema } = require('graphql-import');
 
-    return importSchema(filepath);
-  }
+      return importSchema(filepath);
+    }
+
+    const foundDoc = extractDocumentStringFromCodeFile(new Source(content, filepath));
 
-  const foundDoc = extractDocumentStringFromCodeFile(new Source(content, filepath));
+    if (foundDoc) {
+      return foundDoc;
+    }
 
-  if (foundDoc) {
-    return foundDoc;
+    return content;
+  } else {
+    console['warn'](`Empty schema file found: "${filepath}", skipping...`);
   }
 
-  return content;
+  return null;
 }
 
 export class SchemaFromTypedefs implements SchemaLoader {
@@ -46,27 +49,12 @@ export class SchemaFromTypedefs implements SchemaLoader {
       throw new Error(`Unable to find matching files for glob: ${globPath} in directory: ${process.cwd()}`);
     }
 
-    if (globFiles.length > 1) {
-      return mergeGraphQLSchemas(globFiles.map(filePath => this.loadFileContent(filePath)).filter(f => f));
-    } else {
-      return parse(loadSchemaFile(globFiles[0]));
-    }
-  }
-
-  loadFileContent(filePath: string): Source {
-    const fileContent = readFileSync(filePath, 'utf8');
-    const fileExt = extname(filePath);
-
-    if (graphQLExtensions.includes(fileExt)) {
-      return new Source(fileContent, filePath);
-    }
-
-    const foundDoc = extractDocumentStringFromCodeFile(new Source(fileContent, filePath));
+    const filesContent = globFiles.map(filePath => loadSchemaFile(filePath)).filter(f => f);
 
-    if (foundDoc) {
-      return new Source(foundDoc, filePath);
+    if (filesContent.length === 0) {
+      throw new Error(`All found files for glob expression "${globPath}" are not valid or empty, please check it and try again!`);
     }
 
-    return null;
+    return mergeGraphQLSchemas(filesContent);
   }
 }

tests/loaders/documents/documents-from-glob.spec.ts

@@ -0,0 +1,34 @@
+import { join } from 'path';
+import { DocumentsFromGlob } from '../../../src/loaders/documents/documents-from-glob';
+
+describe('documentsFromGlob', () => {
+  it('Should load one GraphQL document from glob expression', async () => {
+    const glob = join(__dirname, './test-files/', '*.query.graphql');
+    const handler = new DocumentsFromGlob();
+    const canHandle = handler.canHandle(glob);
+    expect(canHandle).toBeTruthy();
+    const result = await handler.handle(glob);
+    expect(result.length).toBe(1);
+    expect(result[0].content).toBeDefined();
+  });
+
+  it('Should load multiple GraphQL document from glob expression', async () => {
+    const glob = join(__dirname, './test-files/', '*.graphql');
+    const handler = new DocumentsFromGlob();
+    const canHandle = handler.canHandle(glob);
+    expect(canHandle).toBeTruthy();
+    const result = await handler.handle(glob);
+    expect(result.length).toBe(2);
+    expect(result[0].content).toBeDefined();
+    expect(result[1].content).toBeDefined();
+  });
+
+  it('Should ignore empty files', async () => {
+    const glob = join(__dirname, './test-files/', '*.empty.graphql');
+    const handler = new DocumentsFromGlob();
+    const canHandle = handler.canHandle(glob);
+    expect(canHandle).toBeTruthy();
+    const result = await handler.handle(glob);
+    expect(result.length).toBe(0);
+  });
+});

tests/loaders/documents/test-files/1.query.graphql

@@ -0,0 +1,3 @@
+query {
+  a
+}

tests/loaders/documents/test-files/2.graphql

@@ -0,0 +1,3 @@
+query {
+  b
+}

tests/loaders/schema/schema-from-typedefs.spec.ts

@@ -16,6 +16,16 @@ describe('schema from typedefs', () => {
     expect(schema.getTypeMap()['Query']).toBeDefined();
   });
 
+  it('should ignore empty files when using glob expressions', () => {
+    const glob = './tests/loaders/schema/test-files/schema-dir/*.empty.graphql';
+    const handler = new SchemaFromTypedefs();
+    const canHandle = handler.canHandle(glob);
+    expect(canHandle).toBeTruthy();
+    expect(() => {
+      handler.handle(glob);
+    }).toThrow(`All found files for glob expression "./tests/loaders/schema/test-files/schema-dir/*.empty.graphql" are not valid or empty, please check it and try again!`);
+  });
+
   it('should work with graphql-tag', () => {
     const schemaPath = './tests/loaders/schema/test-files/schema-dir/*.ts';
     const handler = new SchemaFromTypedefs();