fix: add tests

* test: add logger tests

* test: add tests for data source handling

* refactor: move tests to a separate directory

Jest was testing the fixtures, and moving things was faster than trying
to figure out why. :)

* fix: improve error handling

While writing tests, realized that there were uncaught Promise
rejections and that part of the error handling chain was apparently
unreachable. This fixes that.

* test: add Code Climate coverage reporting

* test: enable testing during CI

* refactor: make the gateway more testable

Express is hard to mock, so by splitting this into an app-specific and
server-specific set of files, we can bypass mocking Express altogether.

* refactor: update cleanup for easier testing

The cleanup process is now its own helper file. Made the cleanup
synchronous to simplify the program flow and make testing easier.
Removed some unused imports.

close #22

* refactor: map + filter -> filter

Author: jlengstorf

.travis.yml

@@ -26,4 +26,4 @@ branches:
   - "/^greenkeeper/.*$/"
 env:
   global:
-    - CC_TEST_REPORTER_ID=500f2daa890ec8bac5ffac26012bd3ff6e672ceb28ac53a1f254645d35168012
+    - CC_TEST_REPORTER_ID=94dc98db9b1d2264af57f5a2891f135593bd89f611050a8c711d8af4f69a2a63

bin/dev.js

@@ -3,13 +3,14 @@ import path from 'path';
 import yargs from 'yargs';
 import cleanup from 'node-cleanup';
 import { spawn } from 'cross-spawn';
-import startDefaultGateway from '../lib/gateway';
+import startDefaultGateway from '../gateway';
 import {
   loadDataSources,
   transpileDataSources,
   cleanUpTempDir,
 } from '../lib/data-sources';
-import { log, success, warn } from '../lib/logger';
+import cleanupOnExit from '../lib/cleanup-on-exit';
+import { warn } from '../lib/logger';
 
 const getDirPath = dir => path.resolve(process.cwd(), dir);
 
@@ -75,11 +76,9 @@ export const builder = yargs =>
       ['transpile', 'no-transpile'],
       'Choose whether to transpile data sources with Babel:',
     )
-    .options({
-      transpile: {
-        type: 'boolean',
-        default: true,
-      },
+    .option('transpile', {
+      type: 'boolean',
+      default: true,
     });
 
 export const handler = async ({
@@ -93,9 +92,16 @@ export const handler = async ({
   let dataSourcePaths = [];
   let loadedDataSources = [];
   if (dataSources.length) {
-    // Get an array of paths to the local data sources.
-    dataSourcePaths = await transpileDataSources(transpile, dataSources);
-    loadedDataSources = loadDataSources(dataSourcePaths);
+    try {
+      // Get an array of paths to the local data sources.
+      dataSourcePaths = await transpileDataSources(transpile, dataSources);
+      loadedDataSources = loadDataSources(dataSourcePaths);
+    } catch (error) {
+      // If something went wrong loading data sources, log it, tidy up, and die.
+      console.error(error);
+      await cleanUpTempDir();
+      process.exit(2); // eslint-disable-line no-process-exit
+    }
   }
 
   startGateway({
@@ -106,17 +112,4 @@ export const handler = async ({
   });
 };
 
-cleanup((exitCode, signal) => {
-  // Delete the temporary directory.
-  cleanUpTempDir().then(shouldPrintShutdownMessage => {
-    if (shouldPrintShutdownMessage) {
-      success('Successfully shut down. Thanks for using GrAMPS!');
-    }
-
-    process.kill(process.pid, signal);
-  });
-
-  // Uninstall the handler to prevent an infinite loop.
-  cleanup.uninstall();
-  return false;
-});
+cleanup(cleanupOnExit);

bin/gramps.js

@@ -1,4 +1,3 @@
-import { EOL } from 'os';
 import yargs from 'yargs';
 import dev from './dev';
 

gateway/configure-app.js

@@ -0,0 +1,16 @@
+import bodyParser from 'body-parser';
+import gramps from '@gramps/gramps';
+import { graphqlExpress } from 'apollo-server-express';
+import playground from 'graphql-playground-middleware-express';
+
+import { GRAPHQL_ENDPOINT, TESTING_ENDPOINT } from '.';
+
+export default function configureApp(app, config) {
+  const GraphQLOptions = gramps(config);
+
+  app.use(bodyParser.json());
+  app.use(GRAPHQL_ENDPOINT, graphqlExpress(GraphQLOptions));
+  app.use(TESTING_ENDPOINT, playground({ endpoint: GRAPHQL_ENDPOINT }));
+
+  return app;
+}

gateway/index.js

@@ -0,0 +1,13 @@
+import Express from 'express';
+
+import configureApp from './configure-app';
+import startServer from './start-server';
+
+export const GRAPHQL_ENDPOINT = '/graphql';
+export const TESTING_ENDPOINT = '/playground';
+export const DEFAULT_PORT = 8080;
+
+export default config => {
+  const app = configureApp(Express(), config);
+  startServer(app, config);
+};

gateway/start-server.js

@@ -0,0 +1,32 @@
+import getPort from 'get-port';
+
+import { success } from '../lib/logger';
+import { DEFAULT_PORT, GRAPHQL_ENDPOINT, TESTING_ENDPOINT } from '.';
+
+export default async function startServer(
+  app,
+  { enableMockData, dataSources = [] } = {},
+) {
+  const PORT = await getPort(DEFAULT_PORT);
+  app.listen(PORT, () => {
+    const mode = enableMockData ? 'mock' : 'live';
+    success([
+      '='.repeat(65),
+      '',
+      `  A GraphQL gateway has successfully started using ${mode} data.`,
+      ``,
+      `  The following GrAMPS data sources are running locally:`,
+      ...dataSources.map(src => `    - ${src.namespace}`),
+      ``,
+      `  For UI development, point your GraphQL client to:`,
+      `    http://localhost:${PORT}${GRAPHQL_ENDPOINT}`,
+      ``,
+      `  To test your data sources in the GraphQL Playground, visit:`,
+      `    http://localhost:${PORT}${TESTING_ENDPOINT}`,
+      ``,
+      '  To stop this gateway, press `control` + `C`.',
+      ``,
+      '='.repeat(65),
+    ]);
+  });
+}

lib/cleanup-on-exit.js

@@ -0,0 +1,19 @@
+import cleanup from 'node-cleanup';
+import { cleanUpTempDir } from './data-sources';
+import { success } from './logger';
+
+export default (_, signal) => {
+  // Uninstall the handler to prevent an infinite loop.
+  cleanup.uninstall();
+
+  // Delete the temporary directory.
+  const shouldPrintShutdownMessage = cleanUpTempDir();
+
+  if (shouldPrintShutdownMessage) {
+    success('Successfully shut down. Thanks for using GrAMPS!');
+  }
+
+  process.kill(process.pid, signal);
+
+  return false;
+};

lib/data-sources.js

@@ -9,7 +9,7 @@ import { error, log, warn } from './logger';
 
 const TEMP_DIR = path.resolve(__dirname, '..', '.tmp');
 
-const handleError = (err, msg, callback) => {
+export const handleError = (err, msg, callback) => {
   if (!err) {
     return;
   }
@@ -34,11 +34,12 @@ const getDirName = dir =>
 export const cleanUpTempDir = () => {
   if (fs.existsSync(TEMP_DIR)) {
     log(' -> cleaning up temporary files');
-    return del(TEMP_DIR, { force: true });
+    del.sync(TEMP_DIR, { force: true });
+    return true;
   }
 
   // If there’s no temp dir, return a resolved promise (basically a no-op).
-  return Promise.resolve(false);
+  return false;
 };
 
 const makeTempDir = tmpDir =>
@@ -52,14 +53,37 @@ const makeTempDir = tmpDir =>
 
 const makeParentTempDir = () =>
   new Promise((resolve, reject) => {
-    cleanUpTempDir().then(() => {
-      mkdirp(TEMP_DIR, err => {
-        handleError(err, `Could not create ${TEMP_DIR}`);
-        resolve(TEMP_DIR);
-      });
+    cleanUpTempDir();
+
+    mkdirp(TEMP_DIR, err => {
+      handleError(err, `Could not create ${TEMP_DIR}`);
+      resolve(TEMP_DIR);
     });
   });
 
+const hasRequiredProperties = (dataSource, dirPath) => {
+  const requiredKeys = ['namespace', 'resolvers', 'typeDefs'];
+  const missingKeys = requiredKeys.filter(k => !dataSource.hasOwnProperty(k));
+  const hasAllRequiredProperties = !missingKeys.length;
+
+  if (!hasAllRequiredProperties) {
+    const name = dataSource.namespace || `in ${getDirName(dirPath)}`;
+    error([
+      `${'='.repeat(36)} ERROR! ${'='.repeat(36)}`,
+      ``,
+      `  The data source ${name} is missing required properties:`,
+      ...missingKeys.map(str => `   - ${str}`),
+      `  `,
+      `  For details on data sources, see the docs at:`,
+      `  http://gramps.js.org/data-source/data-source-overview/`,
+      ``,
+      `=`.repeat(80),
+    ]);
+  }
+
+  return hasAllRequiredProperties;
+};
+
 const isValidDataSource = dataSourcePath => {
   if (!fs.existsSync(dataSourcePath)) {
     warn(`Could not load a data source from ${dataSourcePath}`);
@@ -74,18 +98,13 @@ const loadDataSourceFromPath = dataSourcePath => {
   const src = require(dataSourcePath);
   const dataSource = src.default || src;
 
-  if (!dataSource.namespace || !dataSource.context || !dataSource.typeDefs) {
-    error([
-      `Error: this data source is missing required properties:`,
-      dataSourcePath,
-    ]);
-
+  if (!hasRequiredProperties(dataSource, dataSourcePath)) {
     throw new Error('Invalid data source.');
   }
 
   log(` -> successfully loaded ${dataSource.namespace}`);
 
-  return src.default || src;
+  return dataSource;
 };
 
 export const loadDataSources = pathArr => {
@@ -152,7 +171,7 @@ const transpileDataSource = parentDir => dataSource =>
       .then(copyGraphQLFiles(dataSource))
       .then(symlinkNodeModules(dataSource))
       .then(resolve)
-      .catch(err => handleError(err, null, reject));
+      .catch(reject);
   });
 
 export const transpileDataSources = (shouldTranspile, dataSources) =>

lib/gateway.js

@@ -22,7 +22,7 @@
     "gramps": "bin/index.js",
     "prepush": "npm test",
     "lint": "eslint {bin,lib}/**/*.js",
-    "test": "npm run lint --silent",
+    "test": "npm run lint --silent && npm run test:unit",
     "test:unit": "cross-env NODE_ENV=test LOG4JS_LEVEL='OFF' jest --coverage",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post"
   },
@@ -40,7 +40,6 @@
     "get-port": "^3.2.0",
     "globby": "^7.1.1",
     "graphql-playground-middleware-express": "^1.3.8",
-    "inquirer": "^4.0.1",
     "mkdirp": "^0.5.1",
     "node-cleanup": "^2.1.2",
     "reify": "^0.13.5",
@@ -65,7 +64,6 @@
     "graphql-tools": "^2.14.1",
     "husky": "^0.14.3",
     "jest": "^22.0.0",
-    "nodemon": "^1.11.0",
     "prettier": "^1.5.3",
     "semantic-release": "^8.2.0"
   },
@@ -76,8 +74,8 @@
       "lcov"
     ],
     "collectCoverageFrom": [
-      "{src,bin}/**/*.js",
-      "!bin/gramps.js"
+      "{bin,lib,gateway}/**/*.js",
+      "!bin/index.js"
     ],
     "coverageThreshold": {
       "global": {