fixes for createError

Author: ch-andrewrhyne

.gitignore

@@ -38,3 +38,6 @@ jspm_packages
 
 # Yarn
 yarn.lock
+
+# Direnv
+.envrc

dist/index.js

@@ -1,6 +1,6 @@
 {
   "name": "apollo-errors",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Machine-readable custom errors for Apollostack's GraphQL server",
   "main": "dist/index.js",
   "scripts": {

dist/index.js.map

@@ -1,5 +1,9 @@
+import assert from 'assert';
 import ExtendableError from 'es6-error';
 
+const isString = d => Object.prototype.toString.call(d) === '[object String]';
+const isObject = d => Object.prototype.toString.call(d) === '[object Object]';
+
 class ApolloError extends ExtendableError {
   constructor (name, {
     message,
@@ -41,8 +45,10 @@ class ApolloError extends ExtendableError {
 
 export const isInstance = e => e instanceof ApolloError;
 
-export const createError = (name, data = { message: 'An error has occurred', options }) => {
-  const e = ApolloError.bind(null, name, data);
+export const createError = (name, config) => {
+  assert(isObject(config), 'createError requires a config object as the second parameter');
+  assert(isString(config.message), 'createError requires a "message" property on the config object passed as the second parameter');
+  const e = ApolloError.bind(null, name, config);
   return e;
 };
 

package.json

@@ -3,39 +3,65 @@ import { expect } from 'chai';
 import { createError, formatError } from '../dist';
 
 describe('createError', () => {
-  it('returns an error that serializes properly', () => {
-    const FooError = createError('FooError', {
-      message: 'A foo error has occurred',
-      data: {
-        hello: 'world'
-      },
-      options: {
-        showLocations: false,
-        showPath: true,
-      },
-    });
+  context('when properly used', () => {
+    it('returns an error that serializes properly', () => {
+      const FooError = createError('FooError', {
+        message: 'A foo error has occurred',
+        data: {
+          hello: 'world'
+        },
+        options: {
+          showLocations: false,
+          showPath: true,
+        },
+      });
 
-    const iso = new Date().toISOString();
+      const iso = new Date().toISOString();
 
-    const e = new FooError({
-      message: 'A foo 2.0 error has occurred',
-      data: {
-        foo: 'bar'
-      },
-      options: {
-        showLocations: true,
-        showPath: false,
-      },
-    });
+      const e = new FooError({
+        message: 'A foo 2.0 error has occurred',
+        data: {
+          foo: 'bar'
+        },
+        options: {
+          showLocations: true,
+          showPath: false,
+        },
+      });
 
-    const { message, name, time_thrown, data } = e.serialize();
+      const { message, name, time_thrown, data } = e.serialize();
 
-    expect(message).to.equal('A foo 2.0 error has occurred');
-    expect(name).to.equal('FooError');
-    expect(time_thrown).to.equal(e.time_thrown);
-    expect(data).to.eql({
-      hello: 'world',
-      foo: 'bar'
+      expect(message).to.equal('A foo 2.0 error has occurred');
+      expect(name).to.equal('FooError');
+      expect(time_thrown).to.equal(e.time_thrown);
+      expect(data).to.eql({
+        hello: 'world',
+        foo: 'bar'
+      });
+    });
+  });
+  context('when missing a config as the second parameter', () => {
+    it('throws an assertion error with a useful message', () => {
+      try {
+        createError('FooError');
+        throw new Error('did not throw as expected');
+      } catch (err) {
+        expect(err.name).to.equal('AssertionError [ERR_ASSERTION]');
+        expect(err.message).to.equal('createError requires a config object as the second parameter');
+      }
+    });
+  });
+  context('when missing a message from the config object passed as the second parameter', () => {
+    it('throws an assertion error with a useful message', () => {
+      try {
+        createError('FooError', {
+          
+        });
+        throw new Error('did not throw as expected');
+      } catch (err) {
+        expect(err.name).to.equal('AssertionError [ERR_ASSERTION]');
+        expect(err.message).to.equal('createError requires a "message" property on the config object passed as the second parameter')
+      }
     });
   });
 });