Merge pull request #8 from Yoctol/pass-error-message

tw0517tw · web-flow · commit 4c882ebfb0d5 · 2018-06-11T12:49:09.000+08:00
always pass error message
diff --git a/__tests__/index.spec.js b/__tests__/index.spec.js
@@ -1,12 +1,13 @@
 /* eslint-disable no-shadow */
 import compose from 'koa-compose';
 import validate, { object, string } from 'koa-context-validator';
+import createError from 'http-errors';
 
 import finalHandler from '../';
 
 const middleware = finalHandler();
 
-const createContext = ({ status }) => ({
+const createContext = ({ status } = {}) => ({
   request: {
     method: 'GET',
     url: '/private',
@@ -36,6 +37,7 @@ const createContext = ({ status }) => ({
 const nodeEnv = process.env.NODE_ENV;
 
 beforeEach(() => {
+  console.error = jest.fn();
   jest.resetModules();
 });
 
@@ -74,9 +76,8 @@ describe('finalHandler', () => {
 
   it('call error if error happens', async () => {
     const error = new Error('my error');
-    const ctx = createContext({ status: 500 });
+    const ctx = createContext();
     const next = jest.fn(() => Promise.reject(error));
-    console.error = jest.fn();
 
     await middleware(ctx, next);
 
@@ -91,50 +92,73 @@ describe('finalHandler', () => {
     const middleware = finalHandler();
 
     const error = new Error('my error');
-    const ctx = createContext({ status: 500 });
+    const ctx = createContext();
     const next = jest.fn(() => Promise.reject(error));
-    console.error = jest.fn();
 
     await middleware(ctx, next);
 
-    expect(ctx.response.body).toEqual({ error });
+    expect(ctx.response.body).toEqual({
+      error,
+    });
   });
 
-  it('will not get error on response.body when NODE_ENV is `production`', async () => {
+  it('put status message to error message', async () => {
+    process.env.NODE_ENV = 'development';
+
+    const finalHandler = require('../');
+    const middleware = finalHandler();
+
+    const error = createError(401);
+    const ctx = createContext();
+    const next = jest.fn(() => Promise.reject(error));
+
+    await middleware(ctx, next);
+
+    expect(ctx.response.body).toEqual({
+      error: {
+        message: 'Unauthorized',
+      },
+    });
+  });
+
+  it('will not get error details on response.body when NODE_ENV is `production`', async () => {
     process.env.NODE_ENV = 'production';
 
     const finalHandler = require('../');
     const middleware = finalHandler();
 
     const error = new Error('my error');
-    const ctx = createContext({ status: 500 });
+    const ctx = createContext();
     const next = jest.fn(() => Promise.reject(error));
-    console.error = jest.fn();
 
     await middleware(ctx, next);
 
-    expect(ctx.response.body).toBeUndefined();
+    expect(ctx.response.body).toEqual({
+      error: {
+        message: 'Internal Server Error',
+      },
+    });
   });
-});
 
-it('should support Joi errors', async () => {
-  const composed = compose([
-    middleware,
-    validate({
-      body: object().keys({
-        username: string().required(),
+  it('should support Joi errors', async () => {
+    const composed = compose([
+      middleware,
+      validate({
+        body: object().keys({
+          username: string().required(),
+        }),
       }),
-    }),
-  ]);
+    ]);
 
-  const ctx = createContext({});
-  const next = jest.fn(() => Promise.resolve());
+    const ctx = createContext();
+    const next = jest.fn(() => Promise.resolve());
 
-  await composed(ctx, next);
+    await composed(ctx, next);
 
-  expect(ctx.response.status).toEqual(400);
-  expect(ctx.response.body).toHaveProperty(
-    'error.message',
-    '"username" is required'
-  );
+    expect(ctx.response.status).toEqual(400);
+    expect(ctx.response.body).toHaveProperty(
+      'error.message',
+      '"username" is required'
+    );
+  });
 });
diff --git a/index.js b/index.js
@@ -1,3 +1,5 @@
+const HTTP_STATUS = require('http-status');
+
 const { NODE_ENV } = process.env;
 
 const finalHandler = () => async (ctx, next) => {
@@ -25,6 +27,15 @@ const finalHandler = () => async (ctx, next) => {
         ctx.response.body = { error };
       }
     }
+
+    if (!ctx.response.body) {
+      ctx.response.body = {
+        error: {
+          message: HTTP_STATUS[ctx.response.status],
+        },
+      };
+    }
+
     ctx.app.emit('error', error, ctx);
   }
 };
diff --git a/package.json b/package.json
@@ -11,7 +11,9 @@
   "engines": {
     "node": ">=7.6"
   },
-  "files": ["index.js"],
+  "files": [
+    "index.js"
+  ],
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
@@ -31,6 +33,7 @@
     "eslint-config-yoctol-base": "^0.15.1",
     "eslint-plugin-import": "^2.11.0",
     "eslint-plugin-prettier": "^2.6.0",
+    "http-errors": "^1.6.3",
     "husky": "^0.14.3",
     "jest": "^22.4.3",
     "koa-compose": "^4.0.0",
@@ -39,20 +42,41 @@
     "prettier": "^1.12.1",
     "prettier-package-json": "^1.6.0"
   },
-  "keywords": ["final-handler", "handler", "koa", "middleware"],
+  "keywords": [
+    "final-handler",
+    "handler",
+    "koa",
+    "middleware"
+  ],
   "jest": {
-    "setupFiles": ["./test/configure-env.js"],
+    "setupFiles": [
+      "./test/configure-env.js"
+    ],
     "testEnvironment": "node",
-    "testPathIgnorePatterns": ["node_modules/"]
+    "testPathIgnorePatterns": [
+      "node_modules/"
+    ]
   },
   "lint-staged": {
-    "*.{json,md}": ["prettier --write", "git add"],
-    "*.js": ["eslint --fix", "git add"],
+    "*.{json,md}": [
+      "prettier --write",
+      "git add"
+    ],
+    "*.js": [
+      "eslint --fix",
+      "git add"
+    ],
     "package.json": [
       "prettier-package-json --write",
       "prettier --write",
       "git add"
     ],
-    ".babelrc": ["prettier --parser json --write", "git add"]
+    ".babelrc": [
+      "prettier --parser json --write",
+      "git add"
+    ]
+  },
+  "dependencies": {
+    "http-status": "^1.2.0"
   }
 }
diff --git a/yarn.lock b/yarn.lock
@@ -1337,6 +1337,10 @@ delegates@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/delegates/-/delegates-1.0.0.tgz#84c6e159b81904fdca59a0ef44cd870d31250f9a"
 
+depd@~1.1.2:
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9"
+
 detect-indent@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/detect-indent/-/detect-indent-4.0.0.tgz#f76d064352cdf43a1cb6ce619c4ee3a9475de208"
@@ -2060,6 +2064,15 @@ html-encoding-sniffer@^1.0.2:
   dependencies:
     whatwg-encoding "^1.0.1"
 
+http-errors@^1.6.3:
+  version "1.6.3"
+  resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-1.6.3.tgz#8b55680bb4be283a0b5bf4ea2e38580be1d9320d"
+  dependencies:
+    depd "~1.1.2"
+    inherits "2.0.3"
+    setprototypeof "1.1.0"
+    statuses ">= 1.4.0 < 2"
+
 http-signature@~1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/http-signature/-/http-signature-1.2.0.tgz#9aecd925114772f3d95b65a60abb8f7c18fbace1"
@@ -2068,6 +2081,10 @@ http-signature@~1.2.0:
     jsprim "^1.2.2"
     sshpk "^1.7.0"
 
+http-status@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/http-status/-/http-status-1.2.0.tgz#05f2a54c94f94d32d877b3a31ae08479772ba9f1"
+
 husky@^0.14.3:
   version "0.14.3"
   resolved "https://registry.yarnpkg.com/husky/-/husky-0.14.3.tgz#c69ed74e2d2779769a17ba8399b54ce0b63c12c3"
@@ -2130,7 +2147,7 @@ inflight@^1.0.4:
     once "^1.3.0"
     wrappy "1"
 
-inherits@2, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3:
+inherits@2, inherits@2.0.3, inherits@^2.0.1, inherits@^2.0.3, inherits@~2.0.3:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de"
 
@@ -4042,6 +4059,10 @@ set-value@^2.0.0:
     is-plain-object "^2.0.3"
     split-string "^3.0.1"
 
+setprototypeof@1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.1.0.tgz#d0bd85536887b6fe7c0d818cb962d9d91c54e656"
+
 shebang-command@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-1.2.0.tgz#44aac65b695b03398968c39f363fee5deafdf1ea"
@@ -4217,6 +4238,10 @@ static-extend@^0.1.1:
     define-property "^0.2.5"
     object-copy "^0.1.0"
 
+"statuses@>= 1.4.0 < 2":
+  version "1.5.0"
+  resolved "https://registry.yarnpkg.com/statuses/-/statuses-1.5.0.tgz#161c7dac177659fd9811f43771fa99381478628c"
+
 stealthy-require@^1.1.0:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/stealthy-require/-/stealthy-require-1.1.1.tgz#35b09875b4ff49f26a777e509b3090a3226bf24b"
