starting refactor to split providers into it's own packages

Author: Guilherme Oenning

lib/middlewares/express.js

@@ -1,7 +1,7 @@
 module.exports = {
   buildMiddleware: function(provider) {
     return function(req, res, next) {
-      provider(req, res, next);
+      provider.handler(req, res, next);
     };
   },
   mainMiddleware: function(f, handleRequest) {

lib/middlewares/hapi.js

@@ -12,20 +12,19 @@ var onHapiRequest = function(f, handleRequest, request, reply) {
 };
 
 module.exports = {
-  buildMiddleware: function(provider, name) {
+  buildMiddleware: function(provider) {
     var plugin = {
       register: (server, options, next) => {
         server.ext('onRequest', function(request, reply) {
-          provider(request.raw.req, request.raw.res, () => {
+          provider.handler(request.raw.req, request.raw.res, () => {
             return reply.continue();
           });
         });
         next();
       }
     };
-
     plugin.register.attributes = {
-      name: `miniprofiler-hapi-${name}`,
+      name: `miniprofiler-hapi-${provider.name}`,
       version: require('../../package.json').version
     };
 

lib/middlewares/koa.js

@@ -2,7 +2,7 @@ module.exports = {
   buildMiddleware: function(provider) {
     return function *(next) {
       yield new Promise((resolve, reject) => {
-        provider(this.req, this.res, resolve);
+        provider.handler(this.req, this.res, resolve);
       });
       yield next;
     };

lib/miniprofiler.js

@@ -36,14 +36,7 @@ for (let framework of ['koa', 'express', 'hapi']) {
     return func.mainMiddleware(f, handleRequest);
   };
 
-  exports[framework].for = {
-    pg: (pg) => {
-      return func.buildMiddleware(require('./providers/miniprofiler.pg.js')(pg), 'pg');
-    },
-    redis: (redis) => {
-      return func.buildMiddleware(require('./providers/miniprofiler.redis.js')(redis), 'redis');
-    }
-  };
+  exports[framework].for = func.buildMiddleware;
 }
 
 // GLOBALS

lib/providers/miniprofiler.pg.js

@@ -2,11 +2,16 @@ var pgQuery;
 
 module.exports = function(pg) {
   pgQuery = pgQuery || pg.Client.prototype.query;
-	return function(req, res, next) {
-    pg.Client.prototype.query = !req.miniprofiler.enabled ? pgQuery : function(config, values, callback) {
-      req.miniprofiler.timeQuery('sql', config.toString(), pgQuery.bind(this), config, values, callback);
-    };
 
-		next();
-	};
+  return {
+    name: 'pg',
+    handler: function(req, res, next) {
+
+      pg.Client.prototype.query = !req.miniprofiler.enabled ? pgQuery : function(config, values, callback) {
+        req.miniprofiler.timeQuery('sql', config.toString(), pgQuery.bind(this), config, values, callback);
+      };
+
+      next();
+    }
+  };
 };

lib/providers/miniprofiler.redis.js

@@ -1,19 +1,22 @@
 var redisSendCommand;
-
 var blacklist = ['info'];
 
 module.exports = function(redis) {
   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 && blacklist.indexOf(command) == -1)
-        req.miniprofiler.timeQuery('redis', query, redisSendCommand.bind(this), command, args, callback);
-      else
-        redisSendCommand.call(this, command, args, callback);
-    };
 
-		next();
-	};
-};
+  return {
+    name: 'redis',
+    handler: 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 && blacklist.indexOf(command) == -1)
+          req.miniprofiler.timeQuery('redis', query, redisSendCommand.bind(this), command, args, callback);
+        else
+          redisSendCommand.call(this, command, args, callback);
+      };
+
+      next();
+    }
+  };
+};

tests/basic-test.js

@@ -1,5 +1,4 @@
 var expect = require('chai').expect;
-var eol = require('os').EOL;
 
 module.exports = function(server) {
   describe('Basic Tests', function() {
@@ -18,7 +17,7 @@ module.exports = function(server) {
         var ids = JSON.parse(response.headers['x-miniprofiler-ids']);
         expect(ids).to.have.lengthOf(1);
 
-        expect(body).to.be.equal(`<script async type="text/javascript" id="mini-profiler" src="/mini-profiler-resources/includes.js?v=" data-version="" data-path="/mini-profiler-resources/" data-current-id="${ids[0]}" data-ids="${ids[0]}" data-position="left" data-trivial="true" data-children="false" data-max-traces="15" data-controls="true" data-authorized="true" data-toggle-shortcut="" data-start-hidden="false" data-trivial-milliseconds="2.5"></script>` + eol);
+        expect(body.trim()).to.be.equal(`<script async type="text/javascript" id="mini-profiler" src="/mini-profiler-resources/includes.js?v=" data-version="" data-path="/mini-profiler-resources/" data-current-id="${ids[0]}" data-ids="${ids[0]}" data-position="left" data-trivial="true" data-children="false" data-max-traces="15" data-controls="true" data-authorized="true" data-toggle-shortcut="" data-start-hidden="false" data-trivial-milliseconds="2.5"></script>`);
         done();
       });
     });

tests/custom-config-test.js

@@ -1,5 +1,4 @@
 var expect = require('chai').expect;
-var eol = require('os').EOL;
 
 module.exports = function(server) {
   describe('Custom Configuration Tests', function() {
@@ -11,7 +10,7 @@ module.exports = function(server) {
         var ids = JSON.parse(response.headers['x-miniprofiler-ids']);
         expect(ids).to.have.lengthOf(1);
 
-        expect(body).to.be.equal(`<script async type="text/javascript" id="mini-profiler" src="/mini-profiler-resources/includes.js?v=" data-version="" data-path="/mini-profiler-resources/" data-current-id="${ids[0]}" data-ids="${ids[0]}" data-position="right" data-trivial="true" data-children="false" data-max-traces="15" data-controls="true" data-authorized="true" data-toggle-shortcut="" data-start-hidden="false" data-trivial-milliseconds="2.5"></script>` + eol);
+        expect(body.trim()).to.be.equal(`<script async type="text/javascript" id="mini-profiler" src="/mini-profiler-resources/includes.js?v=" data-version="" data-path="/mini-profiler-resources/" data-current-id="${ids[0]}" data-ids="${ids[0]}" data-position="right" data-trivial="true" data-children="false" data-max-traces="15" data-controls="true" data-authorized="true" data-toggle-shortcut="" data-start-hidden="false" data-trivial-milliseconds="2.5"></script>`);
         done();
       });
     });

tests/servers/express/default.js

@@ -8,8 +8,8 @@ var app = express();
 var client = redis.createClient(6379, process.env.REDIS_PORT_6379_TCP_ADDR);
 
 app.use(miniprofiler.express());
-app.use(miniprofiler.express.for.pg(pg));
-app.use(miniprofiler.express.for.redis(redis));
+app.use(miniprofiler.express.for(require('../../../lib/providers/miniprofiler.pg.js')(pg)));
+app.use(miniprofiler.express.for(require('../../../lib/providers/miniprofiler.redis.js')(redis)));
 
 app.get('/', (req, res) => {
 	res.send(req.miniprofiler.include());

tests/servers/hapi/default.js

@@ -13,10 +13,11 @@ server.connection({ port: 8083 });
 server.register(miniprofiler.hapi(), (err) => {
   if (err) throw err;
 });
-server.register(miniprofiler.hapi.for.pg(pg), (err) => {
+
+server.register(miniprofiler.hapi.for(require('../../../lib/providers/miniprofiler.pg.js')(pg)), (err) => {
   if (err) throw err;
 });
-server.register(miniprofiler.hapi.for.redis(redis), (err) => {
+server.register(miniprofiler.hapi.for(require('../../../lib/providers/miniprofiler.redis.js')(redis)), (err) => {
   if (err) throw err;
 });