Merge 8ef8ef9 into f171c9b

README.md

@@ -26,7 +26,7 @@ defined in the [healthcheck draft RFC](https://tools.ietf.org/html/draft-inadare
 
 - [x] Express/Connect
 - [x] Koa
-- [ ] Pure Node, no frameworks
+- [x] Pure Node, no frameworks
 
 ### Open to Community Contributions
 
@@ -84,14 +84,39 @@ app.listen(3535);
 ```javascript
 const Koa = require('koa');
 const app = new Koa();
-const healthcheck = require("../");
-
+const Router = require('koa-router');
+const router = new Router();
+
+const healthcheck = require("maikai");
 const check = healthcheck();
 
-app.use(check.koa());
+router.get('/hello', (ctx, next) => {
+    ctx.body = 'Hello, World!';
+});
+
+app.use(check.koa())
+   .use(router.routes())
+   .use(router.allowedMethods());
+
 app.listen(3535);
 ```
 
+### Example for no-frameworks, pure Node implementation:
+
+```javascript
+const http = require('http');
+const healthcheck = require('maikai');
+
+http.createServer( (request, response) => {
+  const check = healthcheck();
+  const isHealthCheckCall = check.http(request, response);
+  if (isHealthCheckCall) return;
+
+  response.end("HELLO! This is pretty amaziiiiing");
+}).listen(3535);
+console.log('Server running on port 3535');
+```
+
 ## Kubernetes Liveness and Readiness Probes
 
 When implementing [Kubernetes Liveness and Readiness probes](https://cloudplatform.googleblog.com/2018/05/Kubernetes-best-practices-Setting-up-health-checks-with-readiness-and-liveness-probes.html) you may decide that each one of those

examples/serverJustHTTP.js

@@ -0,0 +1,11 @@
+const http = require('http');
+const healthcheck = require('../');
+
+http.createServer( (request, response) => {
+  const check = healthcheck();
+  const isHealthCheckCall = check.http(request, response);
+  if (isHealthCheckCall) return;
+
+  response.end("HELLO! This is pretty amaziiiiing");
+}).listen(3535);
+console.log('Server running on port 3535');

lib/health.js

@@ -48,17 +48,35 @@ class HealthCheck {
     };
   }  
 
+  http(request, response) {
+    const requestPath = request.url;
+    if (requestPath !== this.getHealthUri()) return false;
+
+    const self = this;
+
+    (async function () {
+      const responseContent = await self.healthResponse(self.opts);
+      const httpCode = (response.status === STATUS_ERR ) ? 503 : 200;
+
+      response.writeHead(httpCode, { 'Content-Type': 'application/health+json; charset=utf-8' });
+      response.end(JSON.stringify(responseContent));
+    })();
+
+    return true;
+  }
+
   addCheck (componentName, metricName, checkerPromise) {
     const key = `${componentName}:${metricName}`;
-    this.checks[key] = checkerPromise;
+    this.checks[key] = {};
+    this.checks[key].executor = checkerPromise;
   }
 
   async healthResponse(opts) {
     const response = {};
     let overallStatus = STATUS_OK;
     for (const prop in this.checks) {
       response.details = {};
-      const details = await this.checks[prop]();
+      const details = await this.checks[prop].executor();
 
       //require('metalogger')().info("details", details);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "maikai",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "RFC-compliant health check middleware for HTTP APIs and microservices written in Node",
   "author": "",
   "license": "MIT",
@@ -16,9 +16,11 @@
   "devDependencies": {
     "blue-tape": "^1.0.0",
     "coveralls": "^3.0.0",
-    "eslint": "^5.2.0",
+    "eslint": "^5.3.0",
     "express": "^4.11.0",
+    "fakepromise": "^1.0.5",
     "koa": "^2.5.2",
+    "koa-router": "^7.4.0",
     "metalogger": "^2.2.0",
     "node-fetch": "^2.2.0",
     "nyc": "^12.0",

test/acceptance/express-failing-check-basic-test.js

@@ -3,7 +3,7 @@ const nf = require('node-fetch');
 const log  = require('metalogger')();
 
 test('Failing Express Health Check', async t => {
-  const brokenserver = require('../support/failing-check-server').server;
+  const brokenserver = getServer();
   try {
     const util = require('../support/util');
     const baseuri = util.serverUri(brokenserver);
@@ -26,6 +26,33 @@ test('Failing Express Health Check', async t => {
   //t.end();  // async tests dont need t.end() because blue-tape.
 });
 
+function getServer() {
+  const express = require('express');
+  const app = express();
+  const healthcheck  = require('../../lib/health')();
+
+  healthcheck.addCheck('backend', 'something', async() => {
+    const status = {
+        status : 'fail',
+        unusualProp : false,
+        metricValue: 17,
+        metricUnit: "tps"
+    };
+
+    const fakepromise = require('fakepromise');
+    const delayedResponse = await fakepromise.promise(50, status);
+    return delayedResponse;
+  });
+  app.use(healthcheck.express());  
+
+  const server = app.listen(0, function () {
+    const port = server.address().port;
+    //log.info(`Test server listening at port ${port} \n`);
+  });
+
+  return server;
+}
+
   /*
       let res = await request('http://api.froyo.io/names?gender=f', {headers});
 

test/acceptance/express-unknown-response-status-test.js

@@ -33,11 +33,15 @@ function getServer() {
   const healthcheck  = require('../../lib/health')();
 
   healthcheck.addCheck('backend', 'something-malformed', async() => {
-    return {
+    const status = {
         status : 'nonexistent-status',
         metricValue: 17,
         metricUnit: "units"
     };
+
+    const fakepromise = require('fakepromise');
+    const delayedResponse = await fakepromise.promise(50, status);
+    return delayedResponse;
   });
   app.use(healthcheck.express());  
 

test/acceptance/express-warn-check-basic-test.js

@@ -0,0 +1,78 @@
+const test = require('blue-tape');
+const nf = require('node-fetch');
+const log  = require('metalogger')();
+const fakepromise = require('fakepromise');
+
+test('Failing Express Health Check', async t => {
+  const brokenserver = getServer();
+  try {
+    const util = require('../support/util');
+    const baseuri = util.serverUri(brokenserver);
+    const uri = `${baseuri}/health`;
+
+    const res = await nf(`${baseuri}/health`);  
+    t.equal(res.status, 200, 'correct http status code');   
+    const response = await res.json();
+
+    t.same(response.status, 'warn',
+    'correct status');
+    t.same(response.details["backend:something"].metricUnit, 'warnps',
+    'correct payload');   
+
+  } catch (err) {
+    t.fail(err);
+  }
+  brokenserver.close();
+
+  //t.end();  // async tests dont need t.end() because blue-tape.
+});
+
+function getServer() {
+  const express = require('express');
+  const app = express();
+  const healthcheck  = require('../../lib/health')();
+
+  healthcheck.addCheck('backend', 'healthy', async() => {
+
+    const status = {
+        status : 'pass',
+        metricValue: 'A++',
+        metricUnit: "grade"
+    };
+
+    const delayedResponse = await fakepromise.promise(50, status);
+    return delayedResponse;
+  });
+
+  healthcheck.addCheck('backend', 'something', async() => {
+    const status =  {
+        status : 'warn',
+        unusualProp : false,
+        metricValue: 17,
+        metricUnit: "warnps"
+    };
+
+    const delayedResponse = await fakepromise.promise(50, status);
+    return delayedResponse;
+  });
+  app.use(healthcheck.express());  
+
+  const server = app.listen(0, function () {
+    const port = server.address().port;
+    //log.info(`Test server listening at port ${port} \n`);
+  });
+
+  return server;
+}
+
+  /*
+      let res = await request('http://api.froyo.io/names?gender=f', {headers});
+
+    //console.log(res);
+    console.log(res.ok);
+    console.log(res.status);
+    console.log(res.statusText);
+    console.log(res.headers.raw());
+    console.log(res.headers.get('content-type'));
+    console.log(await res.json());
+    */

test/acceptance/http-basic-test.js

@@ -0,0 +1,70 @@
+const test = require('blue-tape');
+const nf = require('node-fetch');
+
+test('Basic Healthy No-Frameworks Health Check', async t => {
+
+  // avoid problems if this env var is already set from wherever test was run
+  process.env.NODE_HEALTH_ENDPOINT_PATH = "";
+
+  const server = getServer();
+  const util = require('../support/util');
+  const baseuri = util.serverUri(server);
+
+  try {
+    const res = await nf(`${baseuri}/`);
+    t.equal(res.status, 200, 'proper http status code for /');
+    t.same(await res.text(), 'Hello, World!',
+      'proper content for /');
+
+    const res2 = await nf(`${baseuri}/health`);  
+    t.equal(res2.status, 200, 'proper http status code for /health');
+    t.equal(res2.headers.get('content-type'), 
+            'application/health+json; charset=utf-8',
+            'proper content type for health endpoint');
+    const response = await res2.json();
+    t.same(response.status, 'pass',
+      'healthcheck endpoint status works');
+    t.same(response.details["backend:http-downstream"].metricUnit, 'pureseconds',
+      'healthcheck endpoint details work');
+
+  } catch (err) {
+    t.fail(err);
+  }
+
+  server.close();
+
+});
+
+function getServer() {
+  const http = require('http');
+  const healthcheck = require('../../');
+
+  const server = http.createServer( (request, response) => {
+    const check = healthcheck();
+
+    check.addCheck('backend', 'http-downstream', async() => {
+      const status = {
+          status : 'pass',
+          metricValue: 17,
+          metricUnit: "pureseconds"
+      };
+
+      const fakepromise = require('fakepromise');
+      const delayedResponse = await fakepromise.promise(50, status);
+      return delayedResponse;
+    });
+
+    const isHealthCheckCall = check.http(request, response);
+    if (isHealthCheckCall) return;
+
+    response.end("Hello, World!");
+  });
+
+  server.listen(0, function(err) {
+    if (err) console.error(err) && process.exit(1);
+    const port = server.address().port;
+    //console.log(`Test server listening at port ${port} \n`);
+  });
+
+  return server;
+}

test/acceptance/koa-basic-test.js

@@ -11,6 +11,11 @@ test('Basic Healthy Koa Health Check', async t => {
   const baseuri = util.serverUri(server);
 
   try {
+    const res = await nf(`${baseuri}/`);
+    t.equal(res.status, 200, 'proper http status code for /');
+    t.same(await res.text(), 'Hello, World!',
+      'proper content for /');
+
     const res2 = await nf(`${baseuri}/health`);  
     t.equal(res2.status, 200, 'proper http status code for /health');
     t.equal(res2.headers.get('content-type'), 
@@ -34,18 +39,31 @@ function getServer() {
   const http = require('http');
   const Koa = require('koa');
   const app = new Koa();
+  const Router = require('koa-router');
+  const router = new Router();
+
+  router.get('/', (ctx, next) => {
+    ctx.body = 'Hello, World!';
+  });
 
   const healthcheck  = require('../../lib/health')();
 
   healthcheck.addCheck('backend', 'koa-downstream', async() => {
-    return {
+    const status = {
         status : 'pass',
         metricValue: 17,
         metricUnit: "picoseconds"
     };
+
+    const fakepromise = require('fakepromise');
+    const delayedResponse = await fakepromise.promise(50, status);
+    return delayedResponse;
   });
 
-  app.use(healthcheck.koa());
+  app
+  .use(healthcheck.koa())
+  .use(router.routes())
+  .use(router.allowedMethods());  
 
   const server = http.createServer(app.callback());