adding unit tests and lint fix

Author: Guilherme Oenning

README.md

@@ -2,7 +2,7 @@
 
 Node.js implementation of Stack Exchange's MiniProfiler
 
-### This is working but not yet considered production ready. Use with caution.
+### This is working, but not yet considered production ready. Use with caution.
 
 # requirements
 
@@ -12,12 +12,17 @@ Currently requires express and connect to run, because it uses `res.on('header',
 
 Clone this repo into your project's node_modules directory. You can also install from npm, but the package may be outdated: https://www.npmjs.org/package/miniprofiler.
 
-Then see [connect_test.js](https://github.com/MiniProfiler/node/blob/master/connect_test.js) for example use.
+Then see [examples/express/server.js](/blob/master/examples/express/server.js) for example use.
 
 # Want to help?
 
-Things that need doing:
+Things to do:
 
 - remove dependency from express and connect
 - storing of client timings on first result postback (there's a todo in the `results` function about where to do this)
 - document more things
+- tests for everything
+- add examples for every frameworks
+- add examples for every provider
+- add more providers (mongodb, mysql, redis)
+- remove old ids from global storage

examples/express/server.js

@@ -1,30 +1,31 @@
-var miniprofiler = require('../../miniprofiler.js')
-var pg = require('pg')
+var miniprofiler = require('../../miniprofiler.js');
+var pg = require('pg');
 
-var express = require('express')
-var connString = 'postgres://postgres:postgres@localhost/async_demo'
+var express = require('express');
+var connString = 'postgres://postgres:postgres@localhost/async_demo';
 
-var app = express()
-app.use(miniprofiler.profile())
-app.use(miniprofiler.for.pg(pg))
+var app = express();
+app.use(miniprofiler.profile());
+app.use(miniprofiler.for.pg(pg));
 
-app.set('view engine', 'pug')
-app.set('views', './examples/views')
+app.set('view engine', 'pug');
+app.set('views', './examples/views');
 
 app.get('/', function (req, res) {
-	res.render('home')
-})
+	res.render('home');
+});
 
 app.get('/multi-query', function (req, res) {
 	pg.connect(connString, function (err, client, done) {
-	  client.query('SELECT pg_sleep(1)', [], function (err, result) {
-	    client.query('SELECT $1::int AS number', ['2'], function (err, result) {
-	      console.log(result)
-	      done()
-	      res.render('multi-query')
-		  })
-	  })
-	})
-})
+		client.query('SELECT pg_sleep(1)', [], function (err, result) {
+			console.log(result);
+			client.query('SELECT $1::int AS number', ['2'], function (err, result) {
+				console.log(result);
+				done();
+				res.render('multi-query');
+			});
+		});
+	});
+});
 
-app.listen(8080)
+app.listen(8080);

examples/http/server.js

@@ -0,0 +1,11 @@
+var http = require('http');
+var miniprofiler = require('../../miniprofiler.js');
+
+http.createServer(function (req, res) {
+  var profile = miniprofiler.profile();
+  profile(req, res, function(){
+    req.miniprofiler.step('a', function(){
+  	   res.end('home');
+    })
+  })
+}).listen(8080);

miniprofiler.js

@@ -1,10 +1,11 @@
 /*
- *  Miniprofiler implementation for node.js.
+ *  MiniProfiler implementation for node.js.
  *
  *  Apache License, Version 2.0
  *
- *  Kevin Montrose, 2013
- *  Matt Jibson, 2013
+ *  Kevin Montrose, 2013 @kevin-montrose
+ *  Matt Jibson, 2013 @mjibson
+ *  Guilherme Oenning, 2016 @goenning
  */
 
 var _ = require('./underscore-min.js');
@@ -24,7 +25,7 @@ exports.instrument = addProfilingInstrumentation;
 exports.profile = middleware;
 exports.for = {
 	pg: require('./providers/miniprofiler.pg.js')
-}
+};
 
 // GLOBALS
 var storage = function(id, json) {
@@ -48,6 +49,7 @@ var storage = function(id, json) {
 
 	return null;
 };
+
 var ignoredPaths = [];
 var trivialDurationThresholdMilliseconds = 2.5;
 var popupShowTimeWithChildren = false;
@@ -121,7 +123,6 @@ var includes = {
 };
 
 // FUNCTIONS
-
 if (typeof String.prototype.startsWith != 'function') {
 	String.prototype.startsWith = function (str){
 		return this.slice(0, str.length) == str;
@@ -151,8 +152,8 @@ function middleware(f) {
 		var id = startProfiling(req, enabled);
 
 		res.locals.miniprofiler = enabled ? req.miniprofiler : {
-			include: function() { return '' }
-		}
+			include: function() { return ''; }
+		};
 
 		if (enabled) {
 			res.on('finish', function() {
@@ -266,7 +267,7 @@ function startProfiling(request, enabled) {
 		}
 	};
 	currentRequestExtension.step = function(name, call) {
-		var args = Array.prototype.slice.call(arguments, enabled ? 0 : 2);
+		//var args = Array.prototype.slice.call(arguments, enabled ? 0 : 2);
 		if (enabled) {
 			step(name, request, call);
 		} else {
@@ -299,7 +300,7 @@ function stopProfiling(request){
 
 	// get those references gone, we can't assume much about GC here
 	// (is the above comment still true? is this line needed? - mjibson)
-	delete request.miniprofiler
+	delete request.miniprofiler;
 
 	var json = describePerformance(extension, request);
 	var ret = extension.id;

package.json

@@ -4,7 +4,8 @@
   "description": "A simple but effective mini-profiler.",
   "main": "miniprofiler.js",
   "scripts": {
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "test": "mocha tests/"
   },
   "repository": {
     "type": "git",
@@ -14,11 +15,13 @@
   "license": "Apache-2.0",
   "readmeFilename": "README.md",
   "devDependencies": {
+    "chai": "^3.5.0",
     "eslint": "^2.9.0",
     "express": "^4.13.4",
     "mocha": "^2.4.5",
     "pg": "^4.5.5",
     "pug": "^2.0.0-alpha6",
-    "redis": "^2.6.0-2"
+    "redis": "^2.6.0-2",
+    "request": "^2.72.0"
   }
 }

providers/miniprofiler.pg.js

@@ -1,13 +1,13 @@
 var pgQuery;
 
 module.exports = function (pg) {
-	pgQuery = pgQuery || pg.Client.prototype.query
+	pgQuery = pgQuery || pg.Client.prototype.query;
 	return function (req, res, next) {
     if (req.miniprofiler.enabled) {
       pg.Client.query = 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()
-	}
-}
+		next();
+	};
+};	

tests/basic.js

@@ -0,0 +1,15 @@
+var expect = require('chai').expect;
+var miniprofiler = require('../miniprofiler.js');
+var server = require('./demo-server.js');
+
+describe('MiniProfiler Tests', function() {
+  before(server.start);
+  after(server.stop);
+
+  it('Unprofiled route should not return Profiler ID', function(done) {
+    server.get('/unprofiled', (err, response, body) => {
+      expect(response.headers).to.not.include.keys('x-miniprofiler-ids');
+      done()
+    })
+  });
+});

tests/demo-server.js

@@ -0,0 +1,53 @@
+var miniprofiler = require('../miniprofiler.js');
+var express = require('express');
+var request = require('request');
+
+var app = express();
+var server;
+
+var enableMiniProfiler = (req, res) => {
+  return req.url != '/unprofiled'
+}
+
+app.use(miniprofiler.profile(enableMiniProfiler));
+
+app.get('/', (req, res) => {
+	res.send();
+});
+
+app.get('/step', (req, res) => {
+  req.miniprofiler.step('Step 1', () => {
+  	res.send();
+  });
+});
+
+app.get('/step-two', (req, res) => {
+  req.miniprofiler.step('Step 1', () => {
+    req.miniprofiler.step('Step 2', () => {
+    	res.send();
+    });
+  });
+});
+
+app.get('/unprofiled', (req, res) => {
+	res.send();
+});
+
+module.exports = {
+  start: () => {
+    server = app.listen(8080);
+  },
+  stop: () => {
+    server.close();
+  },
+  get: (path, cb) => {
+    request.get(`http://localhost:8080${path}`, (err, response, body) => {
+      cb(err, response, body);
+    });
+  },
+  post: (path, params, cb) => {
+    request.post({url: `http://localhost:8080${path}`, form: params }, (err, response, body) => {
+      cb(err, response, body);
+    });
+  }
+};

tests/step.js

@@ -0,0 +1,64 @@
+var expect = require('chai').expect;
+var miniprofiler = require('../miniprofiler.js');
+var server = require('./demo-server.js');
+
+describe('MiniProfiler Step Tests', function() {
+  before(server.start);
+  after(server.stop);
+
+  it('Index route should not profile any step', function(done) {
+    server.get('/', (err, response, body) => {
+      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('/');
+        expect(result.Root.Children).to.be.empty;
+
+        done();
+      });
+    });
+  });
+
+  it('step route should profile one step', function(done) {
+    server.get('/step', (err, response, body) => {
+      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('/step');
+        expect(result.Root.Children).to.have.lengthOf(1);
+
+        expect(result.Root.Children[0].Name).to.equal('Step 1');
+        expect(result.Root.Children[0].Children).to.be.empty;
+
+        done();
+      });
+    });
+  });
+
+  it('step-two route should profile two nested step', function(done) {
+    server.get('/step-two', (err, response, body) => {
+      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('/step-two');
+        expect(result.Root.Children).to.have.lengthOf(1);
+
+        expect(result.Root.Children[0].Name).to.equal('Step 1');
+        expect(result.Root.Children[0].Children).to.have.lengthOf(1);
+
+        expect(result.Root.Children[0].Children[0].Name).to.equal('Step 2');
+        expect(result.Root.Children[0].Children[0].Children).to.be.empty;
+        done();
+      });
+    });
+  });
+});