pg provider, back to the green field. refactor needed @ miniprofiler.js

Author: goenning

docker-compose.yml

@@ -1,11 +1,18 @@
 redis:
   image: redis
 
+postgres:
+  image: postgres
+  environment:
+    - POSTGRES_USER=docker
+    - POSTGRES_PASSWORD=docker
+
 test:
   image: node
   volumes:
     - .:/usr/src/miniprofiler
   links:
     - redis
+    - postgres:pg
   working_dir: /usr/src/miniprofiler
   command: npm run mocha

lib/middlewares/express.js

@@ -1,16 +1,22 @@
-module.exports = function(f, handleRequest) {
-	return function(req, res, next) {
-		var enabled = f(req, res);
+module.exports = {
+  instrument: function(provider) {
+    return function(req, res, next) {
+      provider(req, res, next);
+    };
+  },
+  middleware: function(f, handleRequest) {
+    return function(req, res, next) {
+      var enabled = f(req, res);
 
-		var respondWith = (res, result) => {
-			res.writeHead(result.status, { 'Content-Type': result.type });
-			res.end(result.body);
-		};
+      var respondWith = (res, result) => {
+        res.writeHead(result.status, { 'Content-Type': result.type });
+        res.end(result.body);
+      };
 
-		handleRequest(enabled, req, res, respondWith).then((handled) => {
-			if (!handled)
-				next();
-
-		}).catch(next);
-	};
+      handleRequest(enabled, req, res, respondWith).then((handled) => {
+        if (!handled)
+          next();
+      }).catch(next);
+    };
+  }
 };

lib/middlewares/hapi.js

@@ -11,18 +11,39 @@ var onHapiRequest = function(f, handleRequest, request, reply) {
 	});
 };
 
-module.exports = function(f, handleRequest) {
-	var plugin = {
-		register: (server, options, next) => {
-			server.ext('onRequest', onHapiRequest.bind(null, f, handleRequest));
-			next();
-		}
-	};
+module.exports = {
+  instrument: function(provider, name) {
+    var plugin = {
+      register: (server, options, next) => {
+        server.ext('onRequest', function(request, reply) {
+          provider(request.raw.req, request.raw.res, () => {
+            return reply.continue();
+          });
+        });
+        next();
+      }
+    };
 
-	plugin.register.attributes = {
-    name: 'miniprofiler-hapi',
-    version: require('../../package.json').version
-	};
+    plugin.register.attributes = {
+      name: `miniprofiler-hapi-${name}`,
+      version: require('../../package.json').version
+    };
 
-	return plugin;
-};
+    return plugin;
+  },
+  middleware: function(f, handleRequest) {
+    var plugin = {
+      register: (server, options, next) => {
+        server.ext('onRequest', onHapiRequest.bind(null, f, handleRequest));
+        next();
+      }
+    };
+
+    plugin.register.attributes = {
+      name: 'miniprofiler-hapi',
+      version: require('../../package.json').version
+    };
+
+    return plugin;
+  }
+};

lib/middlewares/koa.js

@@ -1,15 +1,25 @@
-module.exports = function(f, handleRequest) {
-	return function *(next) {
-		var enabled = f(this.req, this.res);
+module.exports = {
+  instrument: function(provider) {
+    return function *(next) {
+      yield new Promise((resolve, reject) => {
+        provider(this.req, this.res, resolve);
+      });
+      yield next;
+    };
+  },
+  middleware: function(f, handleRequest) {
+    return function *(next) {
+      var enabled = f(this.req, this.res);
 
-		var respondWith = (res, result) => {
-			this.status = result.status;
-			this.type = result.type;
-			this.body = result.body;
-		};
+      var respondWith = (res, result) => {
+        this.status = result.status;
+        this.type = result.type;
+        this.body = result.body;
+      };
 
-		var handled = yield handleRequest(enabled, this.req, this.res, respondWith);
-		if (!handled)
-      yield next;
-	};
+      var handled = yield handleRequest(enabled, this.req, this.res, respondWith);
+      if (!handled)
+        yield next;
+    };
+  }
 };

lib/miniprofiler.js

@@ -7,7 +7,6 @@
  *  Matt Jibson, 2013 @mjibsonF
  *  Guilherme Oenning, 2016 @goenning
  */
-
 var _ = require('underscore');
 var fs = require('fs');
 var os = require('os');
@@ -16,6 +15,7 @@ var qs = require('querystring');
 var url = require('url');
 var uuid = require('node-uuid');
 var debug = require('debug')('miniprofiler');
+require('generator-bind').polyfill();
 
 _.templateSettings = {
 	interpolate: /\{(.+?)\}/g
@@ -29,17 +29,25 @@ var popupRenderPosition = 'left';
 // EXPORTS
 exports.configure = configure;
 
-_(['express', 'hapi', 'koa', 'http']).each((framework) => {
+for (let framework of ['koa', 'express', 'hapi']) {
+  let func = require(`./middlewares/${framework}.js`);
+  func.name = framework;
   exports[framework] = function(f) {
 		if(!f) f = () => { return true; };
-    return require(`./middlewares/${framework}.js`)(f, handleRequest);
+    return func.middleware(f, handleRequest);
   };
-});
 
-exports.for = {
-	pg: require('./providers/miniprofiler.pg.js'),
-	redis: require('./providers/miniprofiler.redis.js')
-};
+  exports[framework].for = {
+    pg: function(pg) {
+      var provider = require('./providers/miniprofiler.pg.js')(pg);
+      return func.instrument(provider, 'pg');
+    },
+    redis: function(redis) {
+      var provider = require('./providers/miniprofiler.redis.js')(redis);
+      return func.instrument(provider, 'redis');
+    }
+  };
+}
 
 // GLOBALS
 var storage = function(id, json) {

lib/providers/miniprofiler.pg.js

@@ -1,15 +1,12 @@
-/*
 var pgQuery;
 
 module.exports = function(pg) {
+  pgQuery = pgQuery || pg.Client.prototype.query;
 	return function(req, res, next) {
-    pgQuery = pgQuery || pg.Client.prototype.query;
-
     pg.Client.prototype.query = !req.miniprofiler.enabled ? pgQuery : function(config, values, callback) {
-			req.miniprofiler.timeQuery('sql', config.toString(), pgQuery.bind(this), config, values, callback);
-		};
+      req.miniprofiler.timeQuery('sql', config.toString(), pgQuery.bind(this), config, values, callback);
+    };
 
 		next();
 	};
-};
-*/
+};

lib/providers/miniprofiler.redis.js

@@ -1,16 +1,19 @@
 var redisSendCommand;
 
+var blacklist = ['info'];
+
 module.exports = function(redis) {
-  redisSendCommand = redis.RedisClient.prototype.internal_send_command;
+  redisSendCommand = redisSendCommand || redis.RedisClient.prototype.internal_send_command;
 	return function(req, res, next) {
-
+    
     redis.RedisClient.prototype.internal_send_command = !req.miniprofiler.enabled ? redisSendCommand : function(command, args, callback) {
       var query = `${command} ${args.join(', ')}`.trim();
-      if (this.ready)
+      if (this.ready && blacklist.indexOf(command) == -1)
         req.miniprofiler.timeQuery('redis', query, redisSendCommand.bind(this), command, args, callback);
       else
         redisSendCommand.call(this, command, args, callback);
     };
+
 		next();
 	};
 };

package.json

@@ -32,6 +32,7 @@
   "readmeFilename": "README.md",
   "dependencies": {
     "debug": "^2.2.0",
+    "generator-bind": "^1.0.1",
     "node-uuid": "^1.4.7",
     "underscore": "^1.8.3"
   },

tests/provider-pg-test.js

@@ -0,0 +1,32 @@
+var expect = require('chai').expect;
+
+module.exports = function(server) {
+  describe('Postgres Tests', function() {
+    before(server.setUp.bind(null, 'default'));
+    after(server.tearDown);
+
+    it('Should profile postgres SELECT command', function(done) {
+      server.get('/pg-select', (err, response) => {
+        var ids = JSON.parse(response.headers['x-miniprofiler-ids']);
+        expect(ids).to.have.lengthOf(1);
+
+        server.post('/mini-profiler-resources/results/', { id: ids[0], popup: 1 }, (err, response, body) => {
+          var result = JSON.parse(body);
+
+          expect(result.Id).to.equal(ids[0]);
+          expect(result.Name).to.equal('/pg-select');
+          expect(result.Root.Children).to.be.empty;
+          expect(result.Root.CustomTimings).to.have.property('sql');
+          expect(result.Root.CustomTimings.sql).to.have.lengthOf(1);
+
+          expect(result.Root.CustomTimings.sql[0].ExecuteType).to.be.equal('sql');
+          expect(result.Root.CustomTimings.sql[0].CommandString).to.be.equal('SELECT $1::int AS number');
+          expect(result.Root.CustomTimings.sql[0].DurationMilliseconds).to.be.below(result.DurationMilliseconds);
+          done();
+        });
+      });
+
+    });
+
+  });
+};

tests/servers/express/default.js

@@ -1,12 +1,15 @@
 var miniprofiler = require('../../../lib/miniprofiler.js');
 var express = require('express');
 var redis = require('redis');
+var pg = require('pg');
+var connString = `postgres://docker:docker@${process.env.PG_PORT_5432_TCP_ADDR}/docker`;
 
 var app = express();
 var client = redis.createClient(6379, process.env.REDIS_PORT_6379_TCP_ADDR);
 
 app.use(miniprofiler.express());
-app.use(miniprofiler.for.redis(redis));
+app.use(miniprofiler.express.for.pg(pg));
+app.use(miniprofiler.express.for.redis(redis));
 
 app.get('/', (req, res) => {
 	res.send(req.miniprofiler.include());
@@ -46,4 +49,12 @@ app.get('/redis-set-get-key', function(req, res) {
   });
 });
 
+app.get('/pg-select', function(req, res) {
+  pg.connect(connString, function(err, pgClient, done) {
+    pgClient.query('SELECT $1::int AS number', ['1'], function(err, result) {
+      res.send(req.miniprofiler.include());
+    });
+  });
+});
+
 module.exports = app;