upgrade hapi to v17, add Boom, add test for route validation (#22)

* upgrade hapi to v17, add Boom, add test for route validation

Author: pashariger

.eslintignore

@@ -1 +1 @@
-node_modules/*
+node_modules/*

.eslintrc.json

@@ -1,3 +1,6 @@
 {
-	"extends": "hapi"
+	"extends": "hapi",
+	"parserOptions": {
+		"ecmaVersion": 2017
+	}
 }

.travis.yml

@@ -1,3 +1,3 @@
 language: node_js
 node_js:
-  - "5.2"
+  - "8.9.0"

README.md

@@ -4,14 +4,14 @@
 
 Example Hapi-backed API Server with testing, CI, and Swagger documentation generator.
 
-Updated and tested with latest hapi packages as of 8/4/2016.
+Updated and tested with latest hapi packages as of 1/16/2018.
 
 ## How to run
-Requires Node v5.2.0+
+Requires Node v8.9.0+
 ```sh
-  npm install #install dependencies
-  npm start # start server
-  npm test # run tests
+  yarn install #install dependencies
+  yarn start # start server
+  yarn test # run tests
 ```
 
 ## Details
@@ -35,15 +35,13 @@ Requires Node v5.2.0+
   - Code Coverage
     - `lab` analyzes the code and returns the code coverage ratio when running the test. It also points out which lines of code are missing coverage. A nice reminder to write tests for any newly added functionality.
 - Documentation
-  - `hapi-swagger` is configured in `app.js` and generates a very nice html page with an interactive Swagger compatible API. 
+  - `hapi-swagger` is configured in `app.js` and generates a very nice html page with an interactive Swagger compatible API.
   - Once your server is running locally, visit [http://localhost:3000](http://localhost:3000) to check out the docs.
-  - My typical workflow is to write the documentation first (by setting up the hapi routing #2BirdsWith1Stone), then to write the functional tests, then a combination of code and unit tests ala [TDD](http://www.jamesshore.com/Blog/Red-Green-Refactor.html) until I'm satisfied with the results. 
+  - My typical workflow is to write the documentation first (by setting up the hapi routing #2BirdsWith1Stone), then to write the functional tests, then a combination of code and unit tests ala [TDD](http://www.jamesshore.com/Blog/Red-Green-Refactor.html) until I'm satisfied with the results.
 
 - CI
   - This repo also integrates [TravisCI](https://travis-ci.org/), which runs the tests defined above on every pull request, blocking a merge if the test does not pass. Not very useful for a one person project, but crucial when a team of developers is involved.
 
 ## TODO
   * add stubbing framework to imitate external service calls.
   * Figure out an easy way to test multiple hapi services together, in a microservice environment.
-  * Integrate `boom` for API error responses.
-  * Add example for testing hapi route validation (6/17/2017) 

app.js

@@ -8,25 +8,22 @@ const Pack        = require('./package.json');
 const Fs          = require('fs');
 const _           = require('lodash');
 
-const server = new Hapi.Server();
-server.connection({
+const server = new Hapi.Server({
     host: 'localhost',
-    port: process.env.PORT || 3000
+    port: process.env.PORT
 });
 
-// register server components. We use swagger to generate service documentation
-server.register([
-    Inert,
-    Vision,
-    {
-        'register': HapiSwagger,
-        'options': {
+(async () => {
+
+    const HapiSwaggerConfig = {
+        plugin: HapiSwagger,
+        options: {
             info: {
                 title: Pack.name,
                 description: Pack.description,
                 version: Pack.version
             },
-            enableDocumentation: true,
+            swaggerUI: true,
             basePath: '/',
             pathPrefixSize: 2,
             jsonPath: '/docs/swagger.json',
@@ -36,14 +33,16 @@ server.register([
                 { name: 'api' }
             ],
             documentationPath: '/',
-            securityDefinitions: []
+            securityDefinitions: {}
         }
-    }],
-(err) => {
+    };
 
-    if (err) {
-        throw err;
-    }
+    /* register plugins */
+    await server.register([
+        Inert,
+        Vision,
+        HapiSwaggerConfig
+    ]);
 
     // require routes
     Fs.readdirSync('routes').forEach((file) => {
@@ -54,14 +53,9 @@ server.register([
         });
     });
 
-    server.start((err) => {
-
-        if (err) {
-            console.log(err);
-        }
+    await server.start();
 
-        console.log('Server running at:', server.info.uri);
-    });
-});
+    console.log('Server running at:', server.info.uri);
+})();
 
 module.exports = server;

handlers/products.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const Promise = require('promise');
+const Boom = require('boom');
 const _ = require('lodash');
 
 // handlers are exported back for use in hapi routes
@@ -22,25 +22,27 @@ const ProductDatabase = [
 ];
 
 // a unit test-able function
-Lib.getProducts = function getProducts(id) {
+Lib.getProducts = async (id) => {
 
-    return new Promise((resolve, reject) => {
+    if (id) {
+        const product = await _.find(ProductDatabase, (p) => {
 
-        // if id passed, fetch single item
-        if (id) {
-            return resolve(_.find(ProductDatabase, (p) => {
+            return p.id === id;
+        });
 
-                return p.id === id;
-            }));
+        if (!product) {
+            return null;
         }
-        // in other cases fetch all items
-        resolve(ProductDatabase);
-    });
+
+        return product;
+    }
+
+    return ProductDatabase;
 };
 
 // hapi route handler
 // only this function can call reply
-Handlers.get = function get(req, reply) {
+Handlers.get = async (req, reply) => {
     //
     // Perform req processing & conversions for input here.
     //
@@ -50,18 +52,16 @@ Handlers.get = function get(req, reply) {
         id = req.params.id;
     }
 
-    // call business function
-    Lib.getProducts(id).done((products) => {
-        // api success
-        reply({ result: products }).code(200);
-    }, (err) => {
-        // api error
-        reply(err).code(400);
-    });
+    const products = await Lib.getProducts(id);
+
+    if (!products) {
+        return Boom.notFound();
+    }
+
+    return { result: products };
 };
 
 module.exports = {
     handlers: Handlers,
-    // we only export lib for tests
-    lib:      (process.env.NODE_ENV === 'test') ? Lib : null
+    lib: Lib
 };

package.json

@@ -1,11 +1,11 @@
 {
   "name": "testing-hapi",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Example hapi-backed API serivce with testing and CI.",
   "main": "app.js",
   "scripts": {
     "start": "node app.js",
-    "test": "NODE_ENV=test node node_modules/lab/bin/lab -v -L -C -D -c -t 85",
+    "test": "NODE_ENV=test node node_modules/lab/bin/lab -v -L -C -c -t 85",
     "test-cov-html": "lab -r html -o coverage.html"
   },
   "repository": {
@@ -14,6 +14,7 @@
   },
   "keywords": [
     "hapi",
+    "hapi-v17",
     "tests",
     "lab",
     "ci",
@@ -26,15 +27,18 @@
   },
   "homepage": "https://github.com/pashariger/testing-hapi#readme",
   "dependencies": {
-    "hapi": "^14.1.0",
-    "hapi-swagger": "^6.2.1",
-    "inert": "^4.0.1",
-    "joi": "^9.0.4",
-    "promise": "^7.1.1",
-    "vision": "^4.1.0"
+    "boom": "^7.1.1",
+    "hapi": "^17.2.0",
+    "hapi-swagger": "^9.1.1",
+    "inert": "^5.1.0",
+    "joi": "^13.1.2",
+    "promise": "^8.0.1",
+    "vision": "^5.3.1"
   },
   "devDependencies": {
-    "code": "^3.0.1",
-    "lab": "^10.9.0"
+    "code": "^5.2.0",
+    "eslint-config-hapi": "^11.1.0",
+    "eslint-plugin-hapi": "^4.1.0",
+    "lab": "^15.2.2"
   }
 }

test/functional/products.js

@@ -17,58 +17,68 @@ const Server = require('../../app.js');
 // tests
 describe('functional tests - products', () => {
 
-    it('should get products', (done) => {
+    it('should get products', async () => {
 
         // make API call to self to test functionality end-to-end
-        Server.inject({
+        const response = await Server.inject({
             method: 'GET',
             url: '/api/products'
-        }, (response) => {
-
-            expect(response.statusCode).to.equal(200);
-            expect(response.result.result).to.have.length(2);
-            done();
         });
+
+        expect(response.statusCode).to.equal(200);
+        expect(response.result.result).to.have.length(2);
     });
 
-    it('should get single product', (done) => {
+    it('should get single product', async () => {
 
-        Server.inject({
+        const response = await Server.inject({
             method: 'GET',
             url: '/api/products/1'
-        }, (response) => {
+        });
+
+        expect(response.statusCode).to.equal(200);
+    });
+
+    it('should return error for invalid id', async () => {
 
-            expect(response.statusCode).to.equal(200);
-            done();
+        const response = await Server.inject({
+            method: 'GET',
+            url: '/api/products/5'
         });
+
+        expect(response.statusCode).to.equal(404);
     });
 
-    after((done) => {
+    it('should return error for invalid id format (validation test)', async () => {
 
+        const response = await Server.inject({
+            method: 'GET',
+            url: '/api/products/INVLAID_ID_FORMAT'
+        });
+
+        expect(response.statusCode).to.equal(400);
+    });
+
+    after(async () => {
         // placeholder to do something post tests
-        done();
     });
 });
 
 describe('functional tests - get documentation', () => {
 
-    it('should return documentation html', (done) => {
+    it('should return documentation html', async () => {
 
         // make API call to self to test functionality end-to-end
-        Server.inject({
+        const response = await Server.inject({
             method: 'GET',
             url: '/'
-        }, (response) => {
-
-            expect(response.statusCode).to.equal(200);
-            expect(response.result).to.be.a.string();
-            done();
         });
-    });
 
-    after((done) => {
+        expect(response.statusCode).to.equal(200);
+        expect(response.result).to.be.a.string();
+    });
 
+    after(async () => {
         // placeholder to do something post tests
-        done();
     });
 });

test/unit/products.js

@@ -15,30 +15,18 @@ const ProductHandlers = require('../../handlers/products');
 
 describe('unit tests - products', () => {
 
-    it('should return all products', (done) => {
+    it('should return all products', async () => {
 
         // test lib function
-        ProductHandlers.lib.getProducts().done((products) => {
+        const result = await ProductHandlers.lib.getProducts();
 
-            expect(products).to.be.an.array().and.have.length(2);
-
-            done();
-        }, (err) => {
-
-            done(err);
-        });
+        expect(result).to.be.an.array().and.have.length(2);
     });
 
-    it('should return single product', (done) => {
-
-        ProductHandlers.lib.getProducts(1).done((product) => {
-
-            expect(product).to.be.an.object();
+    it('should return single product', async () => {
 
-            done();
-        }, (err) => {
+        const result = await ProductHandlers.lib.getProducts(1);
 
-            done(err);
-        });
+        expect(result).to.be.an.object();
     });
 });